Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Commit 2e95550

Browse filesBrowse files
devsnekaddaleax
devsnek
authored and
addaleax
committed
wasi: add reactor support
PR-URL: #34046 Reviewed-By: Guy Bedford <guybedford@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
1 parent c6ea3d6 commit 2e95550
Copy full SHA for 2e95550

File tree

Expand file treeCollapse file tree

4 files changed

+278
-33
lines changed
Open diff view settings
Filter options
Expand file treeCollapse file tree

4 files changed

+278
-33
lines changed
Open diff view settings
Collapse file

‎doc/api/wasi.md‎

Copy file name to clipboardExpand all lines: doc/api/wasi.md
+17Lines changed: 17 additions & 0 deletions
  • Display the source diff
  • Display the rich diff
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,23 @@ Attempt to begin execution of `instance` as a WASI command by invoking its
126126

127127
If `start()` is called more than once, an exception is thrown.
128128

129+
### `wasi.initialize(instance)`
130+
<!-- YAML
131+
added:
132+
- REPLACEME
133+
-->
134+
135+
* `instance` {WebAssembly.Instance}
136+
137+
Attempt to initialize `instance` as a WASI reactor by invoking its
138+
`_initialize()` export, if it is present. If `instance` contains a `_start()`
139+
export, then an exception is thrown.
140+
141+
`initialize()` requires that `instance` exports a [`WebAssembly.Memory`][] named
142+
`memory`. If `instance` does not have a `memory` export an exception is thrown.
143+
144+
If `initialize()` is called more than once, an exception is thrown.
145+
129146
### `wasi.wasiImport`
130147
<!-- YAML
131148
added: v12.16.0
Collapse file

‎lib/wasi.js‎

Copy file name to clipboardExpand all lines: lib/wasi.js
+59-31Lines changed: 59 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -19,13 +19,36 @@ const {
1919
validateObject,
2020
} = require('internal/validators');
2121
const { WASI: _WASI } = internalBinding('wasi');
22-
const kExitCode = Symbol('exitCode');
23-
const kSetMemory = Symbol('setMemory');
24-
const kStarted = Symbol('started');
22+
const kExitCode = Symbol('kExitCode');
23+
const kSetMemory = Symbol('kSetMemory');
24+
const kStarted = Symbol('kStarted');
25+
const kInstance = Symbol('kInstance');
2526

2627
emitExperimentalWarning('WASI');
2728

2829

30+
function setupInstance(self, instance) {
31+
validateObject(instance, 'instance');
32+
validateObject(instance.exports, 'instance.exports');
33+
34+
// WASI::_SetMemory() in src/node_wasi.cc only expects that |memory| is
35+
// an object. It will try to look up the .buffer property when needed
36+
// and fail with UVWASI_EINVAL when the property is missing or is not
37+
// an ArrayBuffer. Long story short, we don't need much validation here
38+
// but we type-check anyway because it helps catch bugs in the user's
39+
// code early.
40+
validateObject(instance.exports.memory, 'instance.exports.memory');
41+
if (!isArrayBuffer(instance.exports.memory.buffer)) {
42+
throw new ERR_INVALID_ARG_TYPE(
43+
'instance.exports.memory.buffer',
44+
['WebAssembly.Memory'],
45+
instance.exports.memory.buffer);
46+
}
47+
48+
self[kInstance] = instance;
49+
self[kSetMemory](instance.exports.memory);
50+
}
51+
2952
class WASI {
3053
constructor(options = {}) {
3154
validateObject(options, 'options');
@@ -74,58 +97,63 @@ class WASI {
7497
this.wasiImport = wrap;
7598
this[kStarted] = false;
7699
this[kExitCode] = 0;
100+
this[kInstance] = undefined;
77101
}
78102

103+
// Must not export _initialize, must export _start
79104
start(instance) {
80-
validateObject(instance, 'instance');
81-
82-
const exports = instance.exports;
105+
if (this[kStarted]) {
106+
throw new ERR_WASI_ALREADY_STARTED();
107+
}
108+
this[kStarted] = true;
83109

84-
validateObject(exports, 'instance.exports');
110+
setupInstance(this, instance);
85111

86-
const { _initialize, _start, memory } = exports;
112+
const { _start, _initialize } = this[kInstance].exports;
87113

88114
if (typeof _start !== 'function') {
89115
throw new ERR_INVALID_ARG_TYPE(
90116
'instance.exports._start', 'function', _start);
91117
}
92-
93118
if (_initialize !== undefined) {
94119
throw new ERR_INVALID_ARG_TYPE(
95120
'instance.exports._initialize', 'undefined', _initialize);
96121
}
97122

98-
// WASI::_SetMemory() in src/node_wasi.cc only expects that |memory| is
99-
// an object. It will try to look up the .buffer property when needed
100-
// and fail with UVWASI_EINVAL when the property is missing or is not
101-
// an ArrayBuffer. Long story short, we don't need much validation here
102-
// but we type-check anyway because it helps catch bugs in the user's
103-
// code early.
104-
validateObject(memory, 'instance.exports.memory');
105-
106-
if (!isArrayBuffer(memory.buffer)) {
107-
throw new ERR_INVALID_ARG_TYPE(
108-
'instance.exports.memory.buffer',
109-
['WebAssembly.Memory'],
110-
memory.buffer);
123+
try {
124+
_start();
125+
} catch (err) {
126+
if (err !== kExitCode) {
127+
throw err;
128+
}
111129
}
112130

131+
return this[kExitCode];
132+
}
133+
134+
// Must not export _start, may optionally export _initialize
135+
initialize(instance) {
113136
if (this[kStarted]) {
114137
throw new ERR_WASI_ALREADY_STARTED();
115138
}
116-
117139
this[kStarted] = true;
118-
this[kSetMemory](memory);
119140

120-
try {
121-
exports._start();
122-
} catch (err) {
123-
if (err !== kExitCode) {
124-
throw err;
125-
}
141+
setupInstance(this, instance);
142+
143+
const { _start, _initialize } = this[kInstance].exports;
144+
145+
if (typeof _initialize !== 'function' && _initialize !== undefined) {
146+
throw new ERR_INVALID_ARG_TYPE(
147+
'instance.exports._initialize', 'function', _initialize);
148+
}
149+
if (_start !== undefined) {
150+
throw new ERR_INVALID_ARG_TYPE(
151+
'instance.exports._start', 'undefined', _initialize);
126152
}
127153

128-
return this[kExitCode];
154+
if (_initialize !== undefined) {
155+
_initialize();
156+
}
129157
}
130158
}
131159

Collapse file

‎test/wasi/test-wasi-initialize-validation.js‎

Copy file name to clipboard
+195Lines changed: 195 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,195 @@
1+
// Flags: --experimental-wasi-unstable-preview1
2+
'use strict';
3+
4+
const common = require('../common');
5+
const assert = require('assert');
6+
const vm = require('vm');
7+
const { WASI } = require('wasi');
8+
9+
const fixtures = require('../common/fixtures');
10+
const bufferSource = fixtures.readSync('simple.wasm');
11+
12+
(async () => {
13+
{
14+
// Verify that a WebAssembly.Instance is passed in.
15+
const wasi = new WASI();
16+
17+
assert.throws(
18+
() => { wasi.initialize(); },
19+
{
20+
code: 'ERR_INVALID_ARG_TYPE',
21+
message: /"instance" argument must be of type object/
22+
}
23+
);
24+
}
25+
26+
{
27+
// Verify that the passed instance has an exports objects.
28+
const wasi = new WASI({});
29+
const wasm = await WebAssembly.compile(bufferSource);
30+
const instance = await WebAssembly.instantiate(wasm);
31+
32+
Object.defineProperty(instance, 'exports', { get() { return null; } });
33+
assert.throws(
34+
() => { wasi.initialize(instance); },
35+
{
36+
code: 'ERR_INVALID_ARG_TYPE',
37+
message: /"instance\.exports" property must be of type object/
38+
}
39+
);
40+
}
41+
42+
{
43+
// Verify that a _initialize() export was passed.
44+
const wasi = new WASI({});
45+
const wasm = await WebAssembly.compile(bufferSource);
46+
const instance = await WebAssembly.instantiate(wasm);
47+
48+
Object.defineProperty(instance, 'exports', {
49+
get() {
50+
return { _initialize: 5, memory: new Uint8Array() };
51+
},
52+
});
53+
assert.throws(
54+
() => { wasi.initialize(instance); },
55+
{
56+
code: 'ERR_INVALID_ARG_TYPE',
57+
message: /"instance\.exports\._initialize" property must be of type function/
58+
}
59+
);
60+
}
61+
62+
{
63+
// Verify that a _start export was not passed.
64+
const wasi = new WASI({});
65+
const wasm = await WebAssembly.compile(bufferSource);
66+
const instance = await WebAssembly.instantiate(wasm);
67+
68+
Object.defineProperty(instance, 'exports', {
69+
get() {
70+
return {
71+
_start() {},
72+
_initialize() {},
73+
memory: new Uint8Array(),
74+
};
75+
}
76+
});
77+
assert.throws(
78+
() => { wasi.initialize(instance); },
79+
{
80+
code: 'ERR_INVALID_ARG_TYPE',
81+
message: /"instance\.exports\._start" property must be undefined/
82+
}
83+
);
84+
}
85+
86+
{
87+
// Verify that a memory export was passed.
88+
const wasi = new WASI({});
89+
const wasm = await WebAssembly.compile(bufferSource);
90+
const instance = await WebAssembly.instantiate(wasm);
91+
92+
Object.defineProperty(instance, 'exports', {
93+
get() { return { _initialize() {} }; }
94+
});
95+
assert.throws(
96+
() => { wasi.initialize(instance); },
97+
{
98+
code: 'ERR_INVALID_ARG_TYPE',
99+
message: /"instance\.exports\.memory" property must be of type object/
100+
}
101+
);
102+
}
103+
104+
{
105+
// Verify that a non-ArrayBuffer memory.buffer is rejected.
106+
const wasi = new WASI({});
107+
const wasm = await WebAssembly.compile(bufferSource);
108+
const instance = await WebAssembly.instantiate(wasm);
109+
110+
Object.defineProperty(instance, 'exports', {
111+
get() {
112+
return {
113+
_initialize() {},
114+
memory: {},
115+
};
116+
}
117+
});
118+
// The error message is a little white lie because any object
119+
// with a .buffer property of type ArrayBuffer is accepted,
120+
// but 99% of the time a WebAssembly.Memory object is used.
121+
assert.throws(
122+
() => { wasi.initialize(instance); },
123+
{
124+
code: 'ERR_INVALID_ARG_TYPE',
125+
message: /"instance\.exports\.memory\.buffer" property must be an WebAssembly\.Memory/
126+
}
127+
);
128+
}
129+
130+
{
131+
// Verify that an argument that duck-types as a WebAssembly.Instance
132+
// is accepted.
133+
const wasi = new WASI({});
134+
const wasm = await WebAssembly.compile(bufferSource);
135+
const instance = await WebAssembly.instantiate(wasm);
136+
137+
Object.defineProperty(instance, 'exports', {
138+
get() {
139+
return {
140+
_initialize() {},
141+
memory: { buffer: new ArrayBuffer(0) },
142+
};
143+
}
144+
});
145+
wasi.initialize(instance);
146+
}
147+
148+
{
149+
// Verify that a WebAssembly.Instance from another VM context is accepted.
150+
const wasi = new WASI({});
151+
const instance = await vm.runInNewContext(`
152+
(async () => {
153+
const wasm = await WebAssembly.compile(bufferSource);
154+
const instance = await WebAssembly.instantiate(wasm);
155+
156+
Object.defineProperty(instance, 'exports', {
157+
get() {
158+
return {
159+
_initialize() {},
160+
memory: new WebAssembly.Memory({ initial: 1 })
161+
};
162+
}
163+
});
164+
165+
return instance;
166+
})()
167+
`, { bufferSource });
168+
169+
wasi.initialize(instance);
170+
}
171+
172+
{
173+
// Verify that initialize() can only be called once.
174+
const wasi = new WASI({});
175+
const wasm = await WebAssembly.compile(bufferSource);
176+
const instance = await WebAssembly.instantiate(wasm);
177+
178+
Object.defineProperty(instance, 'exports', {
179+
get() {
180+
return {
181+
_initialize() {},
182+
memory: new WebAssembly.Memory({ initial: 1 })
183+
};
184+
}
185+
});
186+
wasi.initialize(instance);
187+
assert.throws(
188+
() => { wasi.initialize(instance); },
189+
{
190+
code: 'ERR_WASI_ALREADY_STARTED',
191+
message: /^WASI instance has already started$/
192+
}
193+
);
194+
}
195+
})().then(common.mustCall());
Collapse file

‎test/wasi/test-wasi-start-validation.js‎

Copy file name to clipboardExpand all lines: test/wasi/test-wasi-start-validation.js
+7-2Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,11 @@ const bufferSource = fixtures.readSync('simple.wasm');
4545
const wasm = await WebAssembly.compile(bufferSource);
4646
const instance = await WebAssembly.instantiate(wasm);
4747

48-
Object.defineProperty(instance, 'exports', { get() { return {}; } });
48+
Object.defineProperty(instance, 'exports', {
49+
get() {
50+
return { memory: new Uint8Array() };
51+
},
52+
});
4953
assert.throws(
5054
() => { wasi.start(instance); },
5155
{
@@ -65,7 +69,8 @@ const bufferSource = fixtures.readSync('simple.wasm');
6569
get() {
6670
return {
6771
_start() {},
68-
_initialize() {}
72+
_initialize() {},
73+
memory: new Uint8Array(),
6974
};
7075
}
7176
});

0 commit comments

Comments
0 (0)
Morty Proxy This is a proxified and sanitized view of the page, visit original site.