[js-api] The type confusion in builtin section
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 5/5
- Estimated time
- Over a week
- Newbie friendliness
- 35/100
- Issue type
- Refactor
- Clarity
- Mostly clear
- Activity status
- Active
- Domain
- documentation
Research direction
Read the JS API Builtins section and compare its create a builtin function steps with run a host function and the Core Spec's ToJSValue and ToWebAssemblyValue conversions. The issue proposes defining argument and result conversion, trap handling, store handling, and unsigned i32 interpretation across the builtins; work out the array handling details it identifies. Done means the builtin algorithms use one consistent convention and resolve the cited type mismatches.
Written by the indexing model from the issue text.
Description
In the Core Spec and the rest of the JS API, a numeric WebAssembly value such as (i32.cosnt n) is a term,
and its actual value is compared only after it is taken out of one, with its signedness spelled out.
In the Core Spec, i32.lt_u and i32.lt_s take the payloads c1 and c2 out of two i32.const values and compare them with ilt: unsigned is c1 < c2, and signed is signed_32(c1) < signed_32(c2).
The JS API does the same when it tries to read a value:
ToJSValue matches i32.const u32 and uses signed_32(u32).
The Builtins section however, has no such convention.
create a builtin function only says the host function "executes steps when called",
so nothing says what the steps receive or return,
and the steps mix WebAssembly values, JavaScript values and plain numbers:
i32parameters are used both as numbers and as WebAssembly values.
fromCodePointchecksv > 0x10ffffand then callsToJSValue(v);
charCodeAt/codePointAt(index) andsubstring(start,end) do the same.- Conversions are written in some places only.
FromCharCodeandCharCodeAtassertis of type i32and callToJSValue,
butexternrefparameters are used as if they are already JavaScript values (If v is not a String),
and results are returned unconverted (Return 0.,Return -1., a JavaScript String). - Values of the wrong kind are passed on.
intoCharCodeArraypasses its loop counter, a number, toCharCodeAt, which asserts ani32.
fromCharCodeArraypasses a packedi16array element toFromCharCode, which asserts the same.
AndintoCharCodeArraystores ani32.constvalue into thati16array.
Why it matters
These implicit conversions brings ambiguity. For instance, substring(string, start, end) can have different interpretations:
1. Let string be ? UnwrapString(string).
1. Let length be the length of string.
1. If start > end or start > length,
1. Return the empty string.
1. Return ! Call(String.prototype.substring, string, « ToJSValue(start), ToJSValue(end) »).
For substring("hello", 1, -1):
- If
endstays a WebAssembly value and only>implicitly reads it as a number:- read as signed:
1 > -1, so the result is"". - read as unsigned: the check passes, then
ToJSValueturnsendback into-1,
andString.prototype.substring("hello", 1, -1)gives"h".
- read as signed:
- If
endis already implicitly a number or JSValue when the steps start (which makes the last step'sToJSValueredundant):- converted as signed (
-1):"". (This is what JavaScriptCore returns.) - converted as unsigned (
4294967295):"ello". (This is what V8 and SpiderMonkey return, and likely be the intention.)
- converted as signed (
Suggestion
The proposal's Overview does have a single convention, and V8 and SpiderMonkey follow it.
Builtins "have the same semantics as following create a host function",
so "Calling a function builtin from Wasm will have the Wasm parameters converted to JS values,
and JS results converted back to Wasm values", and each builtin then reinterprets its i32 parameters as unsigned:
// NOTE: `index` is interpreted as a signed 32-bit integer when converted to
// a JS value using standard conversions. Reinterpret as unsigned here.
index >>>= 0;
I would suggest writing the section in that convention:
-
create a builtin function's host function explicitly converts its arguments withToJSValueand the result withToWebAssemblyValue, asrun a host functiondoes, and maps a throw to a trap, perhaps something like:1. Let func parameters → results be the expansion of funcType. 1. Let hostfunc be a host function which performs the following steps when called with store store and arguments arguments: 1. Set the surrounding agent's associated store to store. 1. Let jsArguments be « ». 1. For each arg of arguments, append ToJSValue(arg) to jsArguments. 1. Let result be the result of running steps with jsArguments. 1. Let store be the surrounding agent's associated store. 1. If result is an abrupt completion, return (store, trap). 1. Return (store, « ! ToWebAssemblyValue(result.[[Value]], results[0]) »). 1. ... -
Each builtin starts by reinterpreting its
i32parameters with
ToUint32, and compares them withℝ(...). For example,substring:1. Let string be ? UnwrapString(string). 1. Let start be ! ToUint32(start). 1. Let end be ! ToUint32(end). 1. Let length be the length of string. 1. If ℝ(start) > ℝ(end) or ℝ(start) > length, 1. Return the empty string. 1. Return ! Call(String.prototype.substring, string, « start, end »).(Alternatively, the host function could pass
i32arguments as unsigned Numbers (𝔽(u32)) in the first place, instead ofToJSValue. That saves repeatingToUint32in every builtin) -
Results the steps return as plain numbers
(Return 0.,Return -1.,Return stringLength.,Return the length of string.)
become Numbers (+0𝔽,-1𝔽,𝔽(stringLength)),
so thatToWebAssemblyValuecan convert them like any other JavaScript result. -
The host function explicitly takes and returns the store, as #2326 does for
create a host function.
Some details would still need working out.
For example, with ToJSValue an array parameter arrives as an Exported GC Object,
so fromCharCodeArray and intoCharCodeArray would have to reach the array through its address.
I would work these out in the PR.
Does that direction sound right? If so, I can open a PR for it.
- Dominant language
- WebAssembly
- Stars
- 3.5k
- Forks
- 545
- Avg merge
- 1d 4h
- Merged PRs (30d)
- 25
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from WebAssembly/spec
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
WebAssembly/spec#2321 · 2 comments ·
Maintainers usually reply within 1 day
-
Difficulty 5/5 Over a week Newbie friendliness 25/100
WebAssembly/spec#2333 · 1 comment · 1 reaction ·
Maintainers usually reply within 1 day
-
Difficulty 3/5 1-2 days Newbie friendliness 66/100
WebAssembly/spec#2302 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 53/100
WebAssembly/spec#2301 · 9 comments ·
Maintainers usually reply within 1 day
-
Difficulty 4/5 3-5 days Newbie friendliness 25/100
WebAssembly/spec#2279 · 6 comments ·
Maintainers usually reply within 1 day
All issues in WebAssembly/spec
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 78/100
firefly-iii/firefly-iii#13259 · 3 comments ·
Maintainers usually reply within 1 day
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
molgenis/molgenis-emx2#7059 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
[DOCS/SMU] Correct the 1 GiB window bullet and the coverage-target sentence in the SMU datasheetOpenDOCS SMU
Difficulty 2/5 1-3 hours Newbie friendliness 77/100
tenstorrent/tt-oca-harness#3931 ·
Maintainers usually reply within 1 day
-
[Sync EN] Document the getLastErrors() return value change in the PHP 8.2 migration guide (#6107)Opensync-en
Difficulty 1/5 Under an hour Newbie friendliness 78/100
Maintainers usually reply within 1 day