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