WebAssembly: unique function signatures
[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 struct Segment {
142     uint32_t offset;
143     uint32_t sizeInBytes;
144     // Bytes are allocated at the end.
145     uint8_t& byte(uint32_t pos)
146     {
147         ASSERT(pos < sizeInBytes);
148         return *reinterpret_cast<uint8_t*>(reinterpret_cast<char*>(this) + sizeof(offset) + sizeof(sizeInBytes) + pos);
149     }
150     static Segment* create(uint32_t, uint32_t);
151     static void destroy(Segment*);
152     typedef std::unique_ptr<Segment, decltype(&Segment::destroy)> Ptr;
153     static Ptr adoptPtr(Segment*);
154 };
155
156 struct Element {
157     uint32_t offset;
158     Vector<uint32_t> functionIndices;
159 };
160
161 class TableInformation {
162 public:
163     TableInformation()
164     {
165         ASSERT(!*this);
166     }
167
168     TableInformation(uint32_t initial, std::optional<uint32_t> maximum, bool isImport)
169         : m_initial(initial)
170         , m_maximum(maximum)
171         , m_isImport(isImport)
172         , m_isValid(true)
173     {
174         ASSERT(*this);
175     }
176
177     explicit operator bool() const { return m_isValid; }
178     bool isImport() const { return m_isImport; }
179     uint32_t initial() const { return m_initial; }
180     std::optional<uint32_t> maximum() const { return m_maximum; }
181
182 private:
183     uint32_t m_initial;
184     std::optional<uint32_t> m_maximum;
185     bool m_isImport { false };
186     bool m_isValid { false };
187 };
188
189 struct ModuleInformation {
190     Vector<SignatureIndex> signatureIndices;
191     Vector<Import> imports;
192     Vector<SignatureIndex> importFunctionSignatureIndices;
193     Vector<SignatureIndex> internalFunctionSignatureIndices;
194     MemoryInformation memory;
195     Vector<Export> exports;
196     std::optional<uint32_t> startFunctionIndexSpace;
197     Vector<Segment::Ptr> data;
198     Vector<Element> elements;
199     TableInformation tableInformation;
200     Vector<Global> globals;
201     unsigned firstInternalGlobal { 0 };
202
203     ~ModuleInformation();
204 };
205
206 struct UnlinkedWasmToWasmCall {
207     CodeLocationCall callLocation;
208     size_t functionIndex;
209 };
210
211 struct Entrypoint {
212     std::unique_ptr<B3::Compilation> compilation;
213     RegisterAtOffsetList calleeSaveRegisters;
214 };
215
216 struct WasmInternalFunction {
217     CodeLocationDataLabelPtr wasmCalleeMoveLocation;
218     CodeLocationDataLabelPtr jsToWasmCalleeMoveLocation;
219
220     Entrypoint wasmEntrypoint;
221     Entrypoint jsToWasmEntrypoint;
222 };
223
224 typedef MacroAssemblerCodeRef WasmToJSStub;
225
226 // WebAssembly direct calls and call_indirect use indices into "function index space". This space starts with all imports, and then all internal functions.
227 // CallableFunction and FunctionIndexSpace are only meant as fast lookup tables for these opcodes, and do not own code.
228 struct CallableFunction {
229     CallableFunction() = default;
230
231     CallableFunction(SignatureIndex signatureIndex, void* code = nullptr)
232         : signatureIndex(signatureIndex)
233         , code(code)
234     {
235     }
236
237     // FIXME pack the SignatureIndex and the code pointer into one 64-bit value. https://bugs.webkit.org/show_bug.cgi?id=165511
238     SignatureIndex signatureIndex { Signature::invalidIndex };
239     void* code { nullptr };
240 };
241 typedef Vector<CallableFunction> FunctionIndexSpace;
242
243
244 struct ImmutableFunctionIndexSpace {
245     MallocPtr<CallableFunction> buffer;
246     size_t size;
247 };
248
249 } } // namespace JSC::Wasm
250
251 #endif // ENABLE(WEBASSEMBLY)