WebAssembly JS API: add Module.sections
[WebKit-https.git] / Source / JavaScriptCore / wasm / WasmFormat.h
1 /*
2  * Copyright (C) 2015-2016 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 "B3Compilation.h"
31 #include "B3Type.h"
32 #include "CodeLocation.h"
33 #include "Identifier.h"
34 #include "MacroAssemblerCodeRef.h"
35 #include "RegisterAtOffsetList.h"
36 #include "WasmMemoryInformation.h"
37 #include "WasmOps.h"
38 #include "WasmPageCount.h"
39 #include "WasmSignature.h"
40 #include <limits>
41 #include <memory>
42 #include <wtf/Optional.h>
43 #include <wtf/Vector.h>
44
45 namespace JSC {
46
47 class JSFunction;
48
49 namespace Wasm {
50
51 inline bool isValueType(Type type)
52 {
53     switch (type) {
54     case I32:
55     case I64:
56     case F32:
57     case F64:
58         return true;
59     default:
60         break;
61     }
62     return false;
63 }
64     
65 enum class ExternalKind : uint8_t {
66     // FIXME auto-generate this. https://bugs.webkit.org/show_bug.cgi?id=165231
67     Function = 0,
68     Table = 1,
69     Memory = 2,
70     Global = 3,
71 };
72
73 template<typename Int>
74 static bool isValidExternalKind(Int val)
75 {
76     switch (val) {
77     case static_cast<Int>(ExternalKind::Function):
78     case static_cast<Int>(ExternalKind::Table):
79     case static_cast<Int>(ExternalKind::Memory):
80     case static_cast<Int>(ExternalKind::Global):
81         return true;
82     default:
83         return false;
84     }
85 }
86
87 static_assert(static_cast<int>(ExternalKind::Function) == 0, "Wasm needs Function to have the value 0");
88 static_assert(static_cast<int>(ExternalKind::Table)    == 1, "Wasm needs Table to have the value 1");
89 static_assert(static_cast<int>(ExternalKind::Memory)   == 2, "Wasm needs Memory to have the value 2");
90 static_assert(static_cast<int>(ExternalKind::Global)   == 3, "Wasm needs Global to have the value 3");
91
92 static inline const char* makeString(ExternalKind kind)
93 {
94     switch (kind) {
95     case ExternalKind::Function: return "Function";
96     case ExternalKind::Table: return "Table";
97     case ExternalKind::Memory: return "Memory";
98     case ExternalKind::Global: return "Global";
99     }
100     RELEASE_ASSERT_NOT_REACHED();
101     return "?";
102 }
103
104 struct Import {
105     Identifier module;
106     Identifier field;
107     ExternalKind kind;
108     unsigned kindIndex; // Index in the vector of the corresponding kind.
109 };
110
111 struct Export {
112     Identifier field;
113     ExternalKind kind;
114     unsigned kindIndex; // Index in the vector of the corresponding kind.
115 };
116
117 struct Global {
118     enum Mutability : uint8_t {
119         // FIXME auto-generate this. https://bugs.webkit.org/show_bug.cgi?id=165231
120         Mutable = 1,
121         Immutable = 0
122     };
123
124     enum InitializationType {
125         IsImport,
126         FromGlobalImport,
127         FromExpression
128     };
129
130     Mutability mutability;
131     Type type;
132     InitializationType initializationType { IsImport };
133     uint64_t initialBitsOrImportNumber { 0 };
134 };
135
136 struct FunctionLocationInBinary {
137     size_t start;
138     size_t end;
139 };
140
141 class I32InitExpr {
142     enum Type : uint8_t {
143         Global,
144         Const
145     };
146
147     I32InitExpr(Type type, uint32_t bits)
148         : m_bits(bits)
149         , m_type(type)
150     { }
151
152 public:
153     I32InitExpr() = delete;
154
155     static I32InitExpr globalImport(uint32_t globalImportNumber) { return I32InitExpr(Global, globalImportNumber); }
156     static I32InitExpr constValue(uint32_t constValue) { return I32InitExpr(Const, constValue); }
157
158     bool isConst() const { return m_type == Const; }
159     bool isGlobalImport() const { return m_type == Global; }
160     uint32_t constValue() const
161     {
162         RELEASE_ASSERT(isConst());
163         return m_bits;
164     }
165     uint32_t globalImportIndex() const
166     {
167         RELEASE_ASSERT(isGlobalImport());
168         return m_bits;
169     }
170
171 private:
172     uint32_t m_bits;
173     Type m_type;
174 };
175
176 struct Segment {
177     uint32_t sizeInBytes;
178     I32InitExpr offset;
179     // Bytes are allocated at the end.
180     uint8_t& byte(uint32_t pos)
181     {
182         ASSERT(pos < sizeInBytes);
183         return *reinterpret_cast<uint8_t*>(reinterpret_cast<char*>(this) + sizeof(Segment) + pos);
184     }
185     static Segment* create(I32InitExpr, uint32_t);
186     static void destroy(Segment*);
187     typedef std::unique_ptr<Segment, decltype(&Segment::destroy)> Ptr;
188     static Ptr adoptPtr(Segment*);
189 };
190
191 struct Element {
192     uint32_t offset;
193     Vector<uint32_t> functionIndices;
194 };
195
196 class TableInformation {
197 public:
198     TableInformation()
199     {
200         ASSERT(!*this);
201     }
202
203     TableInformation(uint32_t initial, std::optional<uint32_t> maximum, bool isImport)
204         : m_initial(initial)
205         , m_maximum(maximum)
206         , m_isImport(isImport)
207         , m_isValid(true)
208     {
209         ASSERT(*this);
210     }
211
212     explicit operator bool() const { return m_isValid; }
213     bool isImport() const { return m_isImport; }
214     uint32_t initial() const { return m_initial; }
215     std::optional<uint32_t> maximum() const { return m_maximum; }
216
217 private:
218     uint32_t m_initial;
219     std::optional<uint32_t> m_maximum;
220     bool m_isImport { false };
221     bool m_isValid { false };
222 };
223     
224 struct CustomSection {
225     String name;
226     Vector<uint8_t> payload;
227 };
228
229 struct ModuleInformation {
230     Vector<Import> imports;
231     Vector<SignatureIndex> importFunctionSignatureIndices;
232     Vector<SignatureIndex> internalFunctionSignatureIndices;
233
234     MemoryInformation memory;
235
236     Vector<Export> exports;
237     std::optional<uint32_t> startFunctionIndexSpace;
238     Vector<Segment::Ptr> data;
239     Vector<Element> elements;
240     TableInformation tableInformation;
241     Vector<Global> globals;
242     unsigned firstInternalGlobal { 0 };
243     Vector<CustomSection> customSections;
244
245     size_t functionIndexSpaceSize() const { return importFunctionSignatureIndices.size() + internalFunctionSignatureIndices.size(); }
246     bool isImportedFunctionFromFunctionIndexSpace(size_t functionIndex) const
247     {
248         ASSERT(functionIndex < functionIndexSpaceSize());
249         return functionIndex < importFunctionSignatureIndices.size();
250     }
251     SignatureIndex signatureIndexFromFunctionIndexSpace(size_t functionIndex) const
252     {
253         return isImportedFunctionFromFunctionIndexSpace(functionIndex)
254             ? importFunctionSignatureIndices[functionIndex]
255             : internalFunctionSignatureIndices[functionIndex - importFunctionSignatureIndices.size()];
256     }
257
258     uint32_t importFunctionCount() const { return importFunctionSignatureIndices.size(); }
259     bool hasMemory() const { return !!memory; }
260
261     ~ModuleInformation();
262 };
263
264 struct UnlinkedWasmToWasmCall {
265     CodeLocationCall callLocation;
266     size_t functionIndex;
267     enum class Target : uint8_t {
268         ToJs,
269         ToWasm,
270     } target;
271 };
272
273 struct Entrypoint {
274     std::unique_ptr<B3::Compilation> compilation;
275     RegisterAtOffsetList calleeSaveRegisters;
276 };
277
278 struct WasmInternalFunction {
279     CodeLocationDataLabelPtr wasmCalleeMoveLocation;
280     CodeLocationDataLabelPtr jsToWasmCalleeMoveLocation;
281
282     Entrypoint wasmEntrypoint;
283     Entrypoint jsToWasmEntrypoint;
284 };
285
286 struct WasmExitStubs {
287     MacroAssemblerCodeRef wasmToJs;
288     MacroAssemblerCodeRef wasmToWasm;
289 };
290
291 // WebAssembly direct calls and call_indirect use indices into "function index space". This space starts with all imports, and then all internal functions.
292 // CallableFunction and FunctionIndexSpace are only meant as fast lookup tables for these opcodes, and do not own code.
293 struct CallableFunction {
294     CallableFunction() = default;
295
296     CallableFunction(SignatureIndex signatureIndex, void* code = nullptr)
297         : signatureIndex(signatureIndex)
298         , code(code)
299     {
300     }
301
302     // FIXME pack the SignatureIndex and the code pointer into one 64-bit value. https://bugs.webkit.org/show_bug.cgi?id=165511
303     SignatureIndex signatureIndex { Signature::invalidIndex };
304     void* code { nullptr };
305 };
306 typedef Vector<CallableFunction> FunctionIndexSpace;
307
308 } } // namespace JSC::Wasm
309
310 #endif // ENABLE(WEBASSEMBLY)