1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
* vim: set ts=8 sts=2 et sw=2 tw=80:
*
* Copyright 2015 Mozilla Foundation
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef wasm_module_h
#define wasm_module_h
#include "js/BuildId.h"
#include "wasm/WasmCode.h"
#include "wasm/WasmTable.h"
namespace js {
namespace wasm {
struct CompileArgs;
// In the context of wasm, the OptimizedEncodingListener specifically is
// listening for the completion of tier-2.
typedef RefPtr<JS::OptimizedEncodingListener> Tier2Listener;
// Module represents a compiled wasm module and primarily provides three
// operations: instantiation, tiered compilation, serialization. A Module can be
// instantiated any number of times to produce new Instance objects. A Module
// can have a single tier-2 task initiated to augment a Module's code with a
// higher tier. A Module can have its optimized code serialized at any point
// where the LinkData is also available, which is primarily (1) at the end of
// module generation, (2) at the end of tier-2 compilation.
//
// Fully linked-and-instantiated code (represented by Code and its owned
// ModuleSegment) can be shared between instances, provided none of those
// instances are being debugged. If patchable code is needed then each instance
// must have its own Code. Module eagerly creates a new Code and gives it to the
// first instance; it then instantiates new Code objects from a copy of the
// unlinked code that it keeps around for that purpose.
class Module : public JS::WasmModule {
const SharedCode code_;
const ImportVector imports_;
const ExportVector exports_;
const DataSegmentVector dataSegments_;
const ElemSegmentVector elemSegments_;
const CustomSectionVector customSections_;
// These fields are only meaningful when code_->metadata().debugEnabled.
// `debugCodeClaimed_` is set to false initially and then to true when
// `code_` is already being used for an instance and can't be shared because
// it may be patched by the debugger. Subsequent instances must then create
// copies by linking the `debugUnlinkedCode_` using `debugLinkData_`.
// This could all be removed if debugging didn't need to perform
// per-instance code patching.
mutable Atomic<bool> debugCodeClaimed_;
const UniqueConstBytes debugUnlinkedCode_;
const UniqueLinkData debugLinkData_;
const SharedBytes debugBytecode_;
// This field is set during tier-2 compilation and cleared on success or
// failure. These happen on different threads and are serialized by the
// control flow of helper tasks.
mutable Tier2Listener tier2Listener_;
// This flag is only used for testing purposes and is cleared on success or
// failure. The field is racily polled from various threads.
mutable Atomic<bool> testingTier2Active_;
bool instantiateFunctions(JSContext* cx,
Handle<FunctionVector> funcImports) const;
bool instantiateMemory(JSContext* cx,
MutableHandleWasmMemoryObject memory) const;
bool instantiateImportedTable(JSContext* cx, const TableDesc& td,
Handle<WasmTableObject*> table,
WasmTableObjectVector* tableObjs,
SharedTableVector* tables) const;
bool instantiateLocalTable(JSContext* cx, const TableDesc& td,
WasmTableObjectVector* tableObjs,
SharedTableVector* tables) const;
bool instantiateTables(JSContext* cx, WasmTableObjectVector& tableImports,
MutableHandle<WasmTableObjectVector> tableObjs,
SharedTableVector* tables) const;
bool instantiateGlobals(JSContext* cx, HandleValVector globalImportValues,
WasmGlobalObjectVector& globalObjs) const;
bool initSegments(JSContext* cx, HandleWasmInstanceObject instance,
Handle<FunctionVector> funcImports,
HandleWasmMemoryObject memory,
HandleValVector globalImportValues) const;
SharedCode getDebugEnabledCode() const;
bool makeStructTypeDescrs(
JSContext* cx,
MutableHandle<StructTypeDescrVector> structTypeDescrs) const;
class Tier2GeneratorTaskImpl;
public:
Module(const Code& code, ImportVector&& imports, ExportVector&& exports,
DataSegmentVector&& dataSegments, ElemSegmentVector&& elemSegments,
CustomSectionVector&& customSections,
UniqueConstBytes debugUnlinkedCode = nullptr,
UniqueLinkData debugLinkData = nullptr,
const ShareableBytes* debugBytecode = nullptr)
: code_(&code),
imports_(std::move(imports)),
exports_(std::move(exports)),
dataSegments_(std::move(dataSegments)),
elemSegments_(std::move(elemSegments)),
customSections_(std::move(customSections)),
debugCodeClaimed_(false),
debugUnlinkedCode_(std::move(debugUnlinkedCode)),
debugLinkData_(std::move(debugLinkData)),
debugBytecode_(debugBytecode),
testingTier2Active_(false) {
MOZ_ASSERT_IF(metadata().debugEnabled,
debugUnlinkedCode_ && debugLinkData_);
}
~Module() override;
const Code& code() const { return *code_; }
const ModuleSegment& moduleSegment(Tier t) const { return code_->segment(t); }
const Metadata& metadata() const { return code_->metadata(); }
const MetadataTier& metadata(Tier t) const { return code_->metadata(t); }
const ImportVector& imports() const { return imports_; }
const ExportVector& exports() const { return exports_; }
const CustomSectionVector& customSections() const { return customSections_; }
const Bytes& debugBytecode() const { return debugBytecode_->bytes; }
uint32_t codeLength(Tier t) const { return code_->segment(t).length(); }
const StructTypeVector& structTypes() const { return code_->structTypes(); }
// Instantiate this module with the given imports:
bool instantiate(JSContext* cx, Handle<FunctionVector> funcImports,
WasmTableObjectVector& tableImport,
HandleWasmMemoryObject memoryImport,
HandleValVector globalImportValues,
WasmGlobalObjectVector& globalObjs,
HandleObject instanceProto,
MutableHandleWasmInstanceObject instanceObj) const;
// Tier-2 compilation may be initiated after the Module is constructed at
// most once. When tier-2 compilation completes, ModuleGenerator calls
// finishTier2() from a helper thread, passing tier-variant data which will
// be installed and made visible.
void startTier2(const CompileArgs& args, const ShareableBytes& bytecode,
JS::OptimizedEncodingListener* listener);
bool finishTier2(const LinkData& linkData2, UniqueCodeTier code2) const;
void testingBlockOnTier2Complete() const;
bool testingTier2Active() const { return testingTier2Active_; }
// Code caching support.
size_t serializedSize(const LinkData& linkData) const;
void serialize(const LinkData& linkData, uint8_t* begin, size_t size) const;
void serialize(const LinkData& linkData,
JS::OptimizedEncodingListener& listener) const;
static RefPtr<Module> deserialize(const uint8_t* begin, size_t size,
Metadata* maybeMetadata = nullptr);
// JS API and JS::WasmModule implementation:
JSObject* createObject(JSContext* cx) override;
// about:memory reporting:
void addSizeOfMisc(MallocSizeOf mallocSizeOf, Metadata::SeenSet* seenMetadata,
ShareableBytes::SeenSet* seenBytes,
Code::SeenSet* seenCode, size_t* code, size_t* data) const;
// Generated code analysis support:
bool extractCode(JSContext* cx, Tier tier, MutableHandleValue vp) const;
};
typedef RefPtr<Module> MutableModule;
typedef RefPtr<const Module> SharedModule;
// JS API implementations:
MOZ_MUST_USE bool GetOptimizedEncodingBuildId(JS::BuildIdCharVector* buildId);
RefPtr<JS::WasmModule> DeserializeModule(PRFileDesc* bytecode,
UniqueChars filename, unsigned line);
} // namespace wasm
} // namespace js
#endif // wasm_module_h