WebAssembly: implement the elements section
[WebKit-https.git] / Source / JavaScriptCore / wasm / WasmFormat.h
1 /*
2  * Copyright (C) 2015 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 <memory>
40 #include <wtf/FastMalloc.h>
41 #include <wtf/Optional.h>
42 #include <wtf/Vector.h>
43
44 namespace JSC {
45
46 class JSFunction;
47
48 namespace Wasm {
49
50 inline bool isValueType(Type type)
51 {
52     switch (type) {
53     case I32:
54     case I64:
55     case F32:
56     case F64:
57         return true;
58     default:
59         break;
60     }
61     return false;
62 }
63     
64 struct External {
65     enum Kind : 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     template<typename Int>
73     static bool isValid(Int val)
74     {
75         switch (val) {
76         case Function:
77         case Table:
78         case Memory:
79         case Global:
80             return true;
81         default:
82             return false;
83         }
84     }
85     
86     static_assert(Function == 0, "Wasm needs Function to have the value 0");
87     static_assert(Table    == 1, "Wasm needs Table to have the value 1");
88     static_assert(Memory   == 2, "Wasm needs Memory to have the value 2");
89     static_assert(Global   == 3, "Wasm needs Global to have the value 3");
90 };
91
92 struct Signature {
93     Type returnType;
94     Vector<Type> arguments;
95 };
96     
97 struct Import {
98     Identifier module;
99     Identifier field;
100     External::Kind kind;
101     unsigned kindIndex; // Index in the vector of the corresponding kind.
102 };
103
104 struct Export {
105     Identifier field;
106     External::Kind kind;
107     union {
108         uint32_t functionIndex;
109         // FIXME implement Table https://bugs.webkit.org/show_bug.cgi?id=165782
110         // FIXME implement Memory https://bugs.webkit.org/show_bug.cgi?id=165671
111         // FIXME implement Global https://bugs.webkit.org/show_bug.cgi?id=164133
112     };
113 };
114
115 struct FunctionLocationInBinary {
116     size_t start;
117     size_t end;
118 };
119
120 struct Segment {
121     uint32_t offset;
122     uint32_t sizeInBytes;
123     // Bytes are allocated at the end.
124     static Segment* make(uint32_t offset, uint32_t sizeInBytes)
125     {
126         auto allocated = tryFastCalloc(sizeof(Segment) + sizeInBytes, 1);
127         Segment* segment;
128         if (!allocated.getValue(segment))
129             return nullptr;
130         segment->offset = offset;
131         segment->sizeInBytes = sizeInBytes;
132         return segment;
133     }
134     static void destroy(Segment *segment)
135     {
136         fastFree(segment);
137     }
138     uint8_t& byte(uint32_t pos)
139     {
140         ASSERT(pos < sizeInBytes);
141         return *reinterpret_cast<uint8_t*>(reinterpret_cast<char*>(this) + sizeof(offset) + sizeof(sizeInBytes) + pos);
142     }
143     typedef std::unique_ptr<Segment, decltype(&Segment::destroy)> Ptr;
144     static Ptr makePtr(Segment* segment)
145     {
146         return Ptr(segment, &Segment::destroy);
147     }
148 };
149
150 struct Element {
151     uint32_t offset;
152     Vector<uint32_t> functionIndices;
153 };
154
155 class TableInformation {
156 public:
157     TableInformation()
158     {
159         ASSERT(!*this);
160     }
161
162     TableInformation(uint32_t initial, std::optional<uint32_t> maximum, bool isImport)
163         : m_initial(initial)
164         , m_maximum(maximum)
165         , m_isImport(isImport)
166         , m_isValid(true)
167     {
168         ASSERT(*this);
169     }
170
171     explicit operator bool() const { return m_isValid; }
172     bool isImport() const { return m_isImport; }
173     uint32_t initial() const { return m_initial; }
174     std::optional<uint32_t> maximum() const { return m_maximum; }
175
176 private:
177     uint32_t m_initial;
178     std::optional<uint32_t> m_maximum;
179     bool m_isImport { false };
180     bool m_isValid { false };
181 };
182
183 struct ModuleInformation {
184     Vector<Signature> signatures;
185     Vector<Import> imports;
186     Vector<Signature*> importFunctions;
187     // FIXME implement import Global https://bugs.webkit.org/show_bug.cgi?id=164133
188     Vector<Signature*> internalFunctionSignatures;
189     MemoryInformation memory;
190     Vector<Export> exports;
191     std::optional<uint32_t> startFunctionIndexSpace;
192     Vector<Segment::Ptr> data;
193     Vector<Element> elements;
194     TableInformation tableInformation;
195
196     ~ModuleInformation();
197 };
198
199 struct UnlinkedWasmToWasmCall {
200     CodeLocationCall callLocation;
201     size_t functionIndex;
202 };
203
204 struct Entrypoint {
205     std::unique_ptr<B3::Compilation> compilation;
206     RegisterAtOffsetList calleeSaveRegisters;
207 };
208
209 struct WasmInternalFunction {
210     CodeLocationDataLabelPtr wasmCalleeMoveLocation;
211     CodeLocationDataLabelPtr jsToWasmCalleeMoveLocation;
212
213     Entrypoint wasmEntrypoint;
214     Entrypoint jsToWasmEntrypoint;
215 };
216
217 typedef MacroAssemblerCodeRef WasmToJSStub;
218
219 // WebAssembly direct calls and call_indirect use indices into "function index space". This space starts with all imports, and then all internal functions.
220 // CallableFunction and FunctionIndexSpace are only meant as fast lookup tables for these opcodes, and do not own code.
221 struct CallableFunction {
222     CallableFunction() = default;
223
224     CallableFunction(Signature* signature, void* code = nullptr)
225         : signature(signature)
226         , code(code)
227     {
228     }
229
230     // FIXME pack this inside a (uniqued) integer (for correctness the parser should unique Signatures),
231     // and then pack that integer into the code pointer. https://bugs.webkit.org/show_bug.cgi?id=165511
232     Signature* signature { nullptr }; 
233     void* code { nullptr };
234 };
235 typedef Vector<CallableFunction> FunctionIndexSpace;
236
237
238 struct ImmutableFunctionIndexSpace {
239     MallocPtr<CallableFunction> buffer;
240     size_t size;
241 };
242
243 } } // namespace JSC::Wasm
244
245 #endif // ENABLE(WEBASSEMBLY)