WebAssembly: perform stack checks
[WebKit-https.git] / Source / JavaScriptCore / wasm / js / JSWebAssemblyInstance.h
1 /*
2  * Copyright (C) 2016-2017 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 "JSDestructibleObject.h"
31 #include "JSObject.h"
32 #include "JSWebAssemblyCodeBlock.h"
33 #include "JSWebAssemblyMemory.h"
34 #include "JSWebAssemblyTable.h"
35
36 namespace JSC {
37
38 class JSModuleNamespaceObject;
39 class JSWebAssemblyModule;
40 class WebAssemblyToJSCallee;
41
42 class JSWebAssemblyInstance : public JSDestructibleObject {
43 public:
44     typedef JSDestructibleObject Base;
45
46     static JSWebAssemblyInstance* create(VM&, ExecState*, JSWebAssemblyModule*, JSObject* importObject, Structure*);
47     static Structure* createStructure(VM&, JSGlobalObject*, JSValue);
48
49     DECLARE_EXPORT_INFO;
50
51     JSWebAssemblyCodeBlock* codeBlock() const { return m_codeBlock.get(); }
52     void finalizeCreation(VM&, ExecState*, Ref<Wasm::CodeBlock>&&);
53
54     JSWebAssemblyModule* module() const { return m_module.get(); }
55
56     JSObject* importFunction(unsigned idx) { RELEASE_ASSERT(idx < m_numImportFunctions); return importFunctions()[idx].get(); }
57
58     JSWebAssemblyMemory* memory() { return m_memory.get(); }
59     void setMemory(VM& vm, JSWebAssemblyMemory* value) { ASSERT(!memory()); m_memory.set(vm, this, value); }
60     Wasm::MemoryMode memoryMode() { return memory()->memory().mode(); }
61
62     JSWebAssemblyTable* table() { return m_table.get(); }
63
64     int32_t loadI32Global(unsigned i) const { return m_globals.get()[i]; }
65     int64_t loadI64Global(unsigned i) const { return m_globals.get()[i]; }
66     float loadF32Global(unsigned i) const { return bitwise_cast<float>(loadI32Global(i)); }
67     double loadF64Global(unsigned i) const { return bitwise_cast<double>(loadI64Global(i)); }
68     void setGlobal(unsigned i, int64_t bits) { m_globals.get()[i] = bits; }
69
70     static ptrdiff_t offsetOfMemory() { return OBJECT_OFFSETOF(JSWebAssemblyInstance, m_memory); }
71     static ptrdiff_t offsetOfTable() { return OBJECT_OFFSETOF(JSWebAssemblyInstance, m_table); }
72     static ptrdiff_t offsetOfCallee() { return OBJECT_OFFSETOF(JSWebAssemblyInstance, m_callee); }
73     static ptrdiff_t offsetOfGlobals() { return OBJECT_OFFSETOF(JSWebAssemblyInstance, m_globals); }
74     static ptrdiff_t offsetOfVM() { return OBJECT_OFFSETOF(JSWebAssemblyInstance, m_vm); }
75     static ptrdiff_t offsetOfCodeBlock() { return OBJECT_OFFSETOF(JSWebAssemblyInstance, m_codeBlock); }
76     static ptrdiff_t offsetOfCachedStackLimit() { return OBJECT_OFFSETOF(JSWebAssemblyInstance, m_cachedStackLimit); }
77     static size_t offsetOfImportFunctions() { return WTF::roundUpToMultipleOf<sizeof(WriteBarrier<JSCell>)>(sizeof(JSWebAssemblyInstance)); }
78     static size_t offsetOfImportFunction(size_t importFunctionNum) { return offsetOfImportFunctions() + importFunctionNum * sizeof(sizeof(WriteBarrier<JSCell>)); }
79
80     WebAssemblyToJSCallee* webAssemblyToJSCallee() { return m_callee.get(); }
81
82     void* cachedStackLimit() const { return m_cachedStackLimit; }
83     void setCachedStackLimit(void* limit) { m_cachedStackLimit = limit; }
84
85 protected:
86     JSWebAssemblyInstance(VM&, Structure*, unsigned numImportFunctions);
87     void finishCreation(VM&, JSWebAssemblyModule*, JSModuleNamespaceObject*);
88     static void destroy(JSCell*);
89     static void visitChildren(JSCell*, SlotVisitor&);
90
91     static size_t allocationSize(Checked<size_t> numImportFunctions)
92     {
93         return (offsetOfImportFunctions() + sizeof(WriteBarrier<JSCell>) * numImportFunctions).unsafeGet();
94     }
95
96 private:
97     VM* m_vm;
98     WriteBarrier<JSObject>* importFunctions() { return bitwise_cast<WriteBarrier<JSObject>*>(bitwise_cast<char*>(this) + offsetOfImportFunctions()); }
99     size_t globalMemoryByteSize() const;
100
101     WriteBarrier<JSWebAssemblyModule> m_module;
102     WriteBarrier<JSWebAssemblyCodeBlock> m_codeBlock;
103     WriteBarrier<JSModuleNamespaceObject> m_moduleNamespaceObject;
104     WriteBarrier<JSWebAssemblyMemory> m_memory;
105     WriteBarrier<JSWebAssemblyTable> m_table;
106     WriteBarrier<WebAssemblyToJSCallee> m_callee;
107     MallocPtr<uint64_t> m_globals;
108     void* m_cachedStackLimit { bitwise_cast<void*>(std::numeric_limits<uintptr_t>::max()) };
109     unsigned m_numImportFunctions;
110 };
111
112 } // namespace JSC
113
114 #endif // ENABLE(WEBASSEMBLY)