Apply poisoning to more pointers in JSC.
[WebKit-https.git] / Source / JavaScriptCore / wasm / js / JSWebAssemblyCodeBlock.h
1 /*
2  * Copyright (C) 2017-2018 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 #if ENABLE(WEBASSEMBLY)
29
30 #include "CallLinkInfo.h"
31 #include "JSCPoison.h"
32 #include "JSCell.h"
33 #include "PromiseDeferredTimer.h"
34 #include "Structure.h"
35 #include "UnconditionalFinalizer.h"
36 #include "WasmCallee.h"
37 #include "WasmFormat.h"
38 #include "WasmModule.h"
39 #include <wtf/Bag.h>
40 #include <wtf/PoisonedUniquePtr.h>
41 #include <wtf/Ref.h>
42 #include <wtf/Vector.h>
43
44 namespace JSC {
45
46 class JSWebAssemblyMemory;
47
48 namespace Wasm {
49 class Plan;
50 }
51
52 class JSWebAssemblyCodeBlock final : public JSCell {
53 public:
54     typedef JSCell Base;
55     static const unsigned StructureFlags = Base::StructureFlags | StructureIsImmortal;
56
57     static JSWebAssemblyCodeBlock* create(VM&, Ref<Wasm::CodeBlock>, const Wasm::ModuleInformation&);
58     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
59     {
60         return Structure::create(vm, globalObject, prototype, TypeInfo(CellType, StructureFlags), info());
61     }
62
63     template<typename CellType>
64     static CompleteSubspace* subspaceFor(VM& vm)
65     {
66         return &vm.webAssemblyCodeBlockSpace;
67     }
68
69     Wasm::CodeBlock& codeBlock() { return m_codeBlock.get(); }
70     
71     void* wasmToEmbedderStubExecutableAddress(size_t importFunctionNum) { return m_wasmToJSExitStubs[importFunctionNum].code().executableAddress(); }
72
73     void finishCreation(VM&);
74
75     void clearJSCallICs(VM&);
76
77     bool runnable() const { return !m_errorMessage; }
78
79     String errorMessage()
80     {
81         ASSERT(!runnable());
82         return m_errorMessage;
83     }
84
85 private:
86     JSWebAssemblyCodeBlock(VM&, Ref<Wasm::CodeBlock>&&, const Wasm::ModuleInformation&);
87     DECLARE_EXPORT_INFO;
88     static const bool needsDestruction = true;
89     static void destroy(JSCell*);
90     static void visitChildren(JSCell*, SlotVisitor&);
91
92     struct UnconditionalFinalizer : public JSC::UnconditionalFinalizer {
93         UnconditionalFinalizer(JSWebAssemblyCodeBlock& codeBlock)
94             : codeBlock(codeBlock)
95         { }
96         void finalizeUnconditionally() override;
97         JSWebAssemblyCodeBlock& codeBlock;
98     };
99
100     PoisonedRef<JSWebAssemblyCodeBlockPoison, Wasm::CodeBlock> m_codeBlock;
101     Vector<MacroAssemblerCodeRef> m_wasmToJSExitStubs;
102     PoisonedUniquePtr<JSWebAssemblyCodeBlockPoison, UnconditionalFinalizer> m_unconditionalFinalizer;
103     Bag<CallLinkInfo> m_callLinkInfos;
104     String m_errorMessage;
105 };
106
107 } // namespace JSC
108
109 #endif // ENABLE(WEBASSEMBLY)