Lazily decode cached bytecode
[WebKit-https.git] / Source / JavaScriptCore / runtime / CachedTypes.h
1 /*
2  * Copyright (C) 2018-2019 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "JSCast.h"
29 #include "VariableEnvironment.h"
30 #include <wtf/HashMap.h>
31 #include <wtf/MallocPtr.h>
32
33 namespace JSC {
34
35 class CachedBytecode;
36 class SourceCodeKey;
37 class UnlinkedCodeBlock;
38 class UnlinkedFunctionCodeBlock;
39
40 class Decoder : public RefCounted<Decoder> {
41     WTF_MAKE_NONCOPYABLE(Decoder);
42
43 public:
44     static Ref<Decoder> create(VM&, const void*, size_t);
45
46     ~Decoder();
47
48     VM& vm() { return m_vm; }
49
50     ptrdiff_t offsetOf(const void*);
51     void cacheOffset(ptrdiff_t, void*);
52     WTF::Optional<void*> cachedPtrForOffset(ptrdiff_t);
53     const void* ptrForOffsetFromBase(ptrdiff_t);
54     CompactVariableMap::Handle handleForEnvironment(CompactVariableEnvironment*) const;
55     void setHandleForEnvironment(CompactVariableEnvironment*, const CompactVariableMap::Handle&);
56
57     template<typename Functor>
58     void addFinalizer(const Functor&);
59
60 private:
61     Decoder(VM&, const void*, size_t);
62
63     VM& m_vm;
64     const uint8_t* m_baseAddress;
65 #ifndef NDEBUG
66     size_t m_size;
67 #endif
68     HashMap<ptrdiff_t, void*> m_offsetToPtrMap;
69     Vector<std::function<void()>> m_finalizers;
70     HashMap<CompactVariableEnvironment*, CompactVariableMap::Handle> m_environmentToHandleMap;
71 };
72
73 enum class SourceCodeType;
74
75 std::pair<MallocPtr<uint8_t>, size_t> encodeCodeBlock(VM&, const SourceCodeKey&, const UnlinkedCodeBlock*);
76
77 UnlinkedCodeBlock* decodeCodeBlockImpl(VM&, const SourceCodeKey&, const void*, size_t);
78
79 void decodeFunctionCodeBlock(Decoder&, int32_t cachedFunctionCodeBlockOffset, WriteBarrier<UnlinkedFunctionCodeBlock>&, const JSCell*);
80
81 template<typename UnlinkedCodeBlockType>
82 UnlinkedCodeBlockType* decodeCodeBlock(VM& vm, const SourceCodeKey& key, const void* buffer, size_t size)
83 {
84     return jsCast<UnlinkedCodeBlockType*>(decodeCodeBlockImpl(vm, key, buffer, size));
85 }
86
87 bool isCachedBytecodeStillValid(VM&, const CachedBytecode&, const SourceCodeKey&, SourceCodeType);
88
89 } // namespace JSC