Skip to content

Commit f05c744

Browse files
inexorabletashzolkis
inexorabletash
authored and
zolkis
committed
Ensure object creation specifies the realm (webmachinelearning#810)
* Ensure object creation specifies the realm "Realm" is an ECMAScript concept best explained in https://html.spec.whatwg.org/multipage/webappapis.html#realms-and-their-counterparts Newly created JS objects must be associated with a Realm; while older specs didn't do this explicitly, best practice is to be explicit about this, especially for steps running "in parallel", or in algorithms separate from method steps. Do so! This also adds lint tests to try and catch future violations. Note that dictionaries (e.g. MLOperatorDescriptor) are Infra "ordered maps" it the body of spec algorithms, not JS objects, so they don't have a realm. Conversion to a JS object when returning a dictionary to script is handled by WebIDL bindings logic. Also note that DOMExceptions, either thrown or as promise rejection values, are not given a realm. This is a known issue across all web specs and is tracked in whatwg/webidl#135. Resolves webmachinelearning#793. * Don't double-init realm; and don't need realm for dicts * Variable name improvement from @fdwr
1 parent 9ccd423 commit f05c744

File tree

2 files changed

+54
-32
lines changed

2 files changed

+54
-32
lines changed

‎index.bs

+36-30
Original file line numberDiff line numberDiff line change
@@ -825,14 +825,14 @@ The <dfn dfn-for=MLContextOptions dfn-type=dict-member>powerPreference</dfn> opt
825825
<summary>
826826
To <dfn>create a context</dfn> given [=realm=] |realm| and |options| (a {{GPUDevice}} or {{MLContextOptions}}), run these steps:
827827
</summary>
828-
1. Let |context| be a new {{MLContext}} object with |realm|.
828+
1. Let |context| be a new {{MLContext}} in |realm|.
829829
1. If |options| is a {{GPUDevice}} object:
830830
1. Set |context|.{{MLContext/[[contextType]]}} to "[=context type/webgpu=]".
831831
1. Set |context|.{{MLContext/[[deviceType]]}} to {{MLDeviceType/"gpu"}}.
832832
1. Set |context|.{{MLContext/[[powerPreference]]}} to {{MLPowerPreference/"default"}}.
833833
1. Otherwise:
834834
1. Set |context|.{{MLContext/[[contextType]]}} to "[=context type/default=]".
835-
1. Set |context|.{{MLContext/[[lost]]}} to [=a new promise=].
835+
1. Set |context|.{{MLContext/[[lost]]}} to [=a new promise=] in |realm|.
836836
1. If |options|["{{MLContextOptions/deviceType}}"] [=map/exists=], then set |context|.{{MLContext/[[deviceType]]}} to |options|["{{MLContextOptions/deviceType}}"].
837837
1. Otherwise, set |context|.{{MLContext/[[deviceType]]}} to {{MLDeviceType/"cpu"}}.
838838
1. If |options|["{{MLContextOptions/powerPreference}}"] [=map/exists=], then set |context|.{{MLContext/[[powerPreference]]}} to |options|["{{MLContextOptions/powerPreference}}"].
@@ -846,9 +846,9 @@ The <dfn dfn-for=MLContextOptions dfn-type=dict-member>powerPreference</dfn> opt
846846
The <dfn method for=ML>createContext(|options|)</dfn> steps are:
847847
</summary>
848848
1. Let |global| be [=this=]'s [=relevant global object=].
849-
1. If |global|'s [=associated Document=] is not [=allowed to use=] the [=webnn-feature|webnn=] feature, return [=a new promise=] [=rejected=] with a "{{SecurityError}}" {{DOMException}}.
850849
1. Let |realm| be [=this=]'s [=relevant realm=].
851-
1. Let |promise| be [=a new promise=].
850+
1. If |global|'s [=associated Document=] is not [=allowed to use=] the [=webnn-feature|webnn=] feature, return [=a new promise=] in |realm| [=rejected=] with a "{{SecurityError}}" {{DOMException}}.
851+
1. Let |promise| be [=a new promise=] in |realm|.
852852
1. Run the following steps [=in parallel=].
853853
1. Let |context| be the result of [=creating a context=] given |realm| and |options|. If that returns failure, then [=queue an ML task=] with |global| to [=reject=] |promise| with a "{{NotSupportedError}}" {{DOMException}} and abort these steps.
854854
1. [=Queue an ML task=] with |global| to [=resolve=] |promise| with |context|.
@@ -860,9 +860,9 @@ The <dfn dfn-for=MLContextOptions dfn-type=dict-member>powerPreference</dfn> opt
860860
The <dfn method for=ML>createContext(|gpuDevice|)</dfn> method steps are:
861861
</summary>
862862
1. Let |global| be [=this=]'s [=relevant global object=].
863-
1. If |global|'s [=associated Document=] is not [=allowed to use=] the [=webnn-feature|webnn=] feature, return [=a new promise=] [=rejected=] with a "{{SecurityError}}" {{DOMException}}.
864863
1. Let |realm| be [=this=]'s [=relevant realm=].
865-
1. Let |promise| be [=a new promise=].
864+
1. If |global|'s [=associated Document=] is not [=allowed to use=] the [=webnn-feature|webnn=] feature, return [=a new promise=] in |realm| [=rejected=] with a "{{SecurityError}}" {{DOMException}}.
865+
1. Let |promise| be [=a new promise=] in |realm|.
866866
1. Run the following steps [=in parallel=].
867867
1. Let |context| be the result of [=creating a context=] given |realm| and |gpuDevice|. If that returns failure, then [=queue an ML task=] with |global| to [=reject=] |promise| with a "{{NotSupportedError}}" {{DOMException}} and abort these steps.
868868
1. [=Queue an ML task=] with |global| to [=resolve=] |promise| with |context|.
@@ -1044,7 +1044,7 @@ Note: `dispatch()` itself provides no signal that graph execution has completed.
10441044
'C': outputTensorC
10451045
};
10461046
context.dispatch(graph, inputs, outputs);
1047-
1047+
10481048
// 6. Read back the computed result.
10491049
const result = await context.readTensor(outputTensorC);
10501050
console.log('Output value:', new Float32Array(result)); // [1, 1, 1, 1]
@@ -1068,9 +1068,10 @@ Creates an {{MLTensor}} associated with this {{MLContext}}.
10681068
The <dfn method for=MLContext>createTensor(|descriptor|)</dfn> method steps are:
10691069
</summary>
10701070
1. Let |global| be [=this=]'s [=relevant global object=].
1071-
1. If [=this=] [=MLContext/is lost=], then return [=a new promise=] [=rejected=] with an "{{InvalidStateError}}" {{DOMException}}.
1071+
1. Let |realm| be [=this=]'s [=relevant realm=].
1072+
1. If [=this=] [=MLContext/is lost=], then return [=a new promise=] in |realm| [=rejected=] with an "{{InvalidStateError}}" {{DOMException}}.
10721073
1. Let |tensor| be the result of [=creating an MLTensor=] given [=this=], and |descriptor|.
1073-
1. Let |promise| be [=a new promise=].
1074+
1. Let |promise| be [=a new promise=] in |realm|.
10741075
1. Enqueue the following steps to [=this=].{{MLContext/[[timeline]]}}:
10751076
1. Run these steps, but [=/abort when=] [=this=] [=MLContext/is lost=]:
10761077
1. Create |tensor|.{{MLTensor/[[data]]}} given |descriptor| and initialize all bytes to zeros.
@@ -1097,10 +1098,10 @@ Reads back the {{MLTensor/[[data]]}} of an {{MLTensor}} from the {{MLContext}}.{
10971098
</summary>
10981099
1. Let |global| be [=this=]'s [=relevant global object=].
10991100
1. Let |realm| be [=this=]'s [=relevant realm=].
1100-
1. If |tensor|.{{MLTensor/[[context]]}} is not [=this=], then return [=a new promise=] [=rejected=] with a {{TypeError}}.
1101-
1. If |tensor|.{{MLTensor/[[isDestroyed]]}} is true, then return [=a new promise=] [=rejected=] with a {{TypeError}}.
1102-
1. If |tensor|.{{MLTensor/[[descriptor]]}}.{{MLTensorDescriptor/readable}} is false, then return [=a new promise=] [=rejected=] with a {{TypeError}}.
1103-
1. Let |promise| be [=a new promise=].
1101+
1. If |tensor|.{{MLTensor/[[context]]}} is not [=this=], then return [=a new promise=] in |realm| [=rejected=] with a {{TypeError}}.
1102+
1. If |tensor|.{{MLTensor/[[isDestroyed]]}} is true, then return [=a new promise=] in |realm| [=rejected=] with a {{TypeError}}.
1103+
1. If |tensor|.{{MLTensor/[[descriptor]]}}.{{MLTensorDescriptor/readable}} is false, then return [=a new promise=] in |realm| [=rejected=] with a {{TypeError}}.
1104+
1. Let |promise| be [=a new promise=] in |realm|.
11041105
1. Enqueue the following steps to |tensor|.{{MLTensor/[[context]]}}.{{MLContext/[[timeline]]}}:
11051106
1. Run these steps, but [=/abort when=] [=this=] [=MLContext/is lost=]:
11061107
1. Let |bytes| be a [=/byte sequence=] containing a copy of |tensor|.{{MLTensor/[[data]]}}.
@@ -1127,11 +1128,12 @@ Bring-your-own-buffer variant of {{MLContext/readTensor(tensor)}}. Reads back th
11271128
The <dfn method for=MLContext>readTensor(|tensor|, |outputData|)</dfn> method steps are:
11281129
</summary>
11291130
1. Let |global| be [=this=]'s [=relevant global object=].
1130-
1. If |tensor|.{{MLTensor/[[context]]}} is not [=this=], then return [=a new promise=] [=rejected=] with a {{TypeError}}.
1131-
1. If |tensor|.{{MLTensor/[[isDestroyed]]}} is true, then return [=a new promise=] [=rejected=] with a {{TypeError}}.
1132-
1. If |tensor|.{{MLTensor/[[descriptor]]}}.{{MLTensorDescriptor/readable}} is false, then return [=a new promise=] [=rejected=] with a {{TypeError}}.
1133-
1. If [=validating buffer with descriptor=] given |outputData| and |tensor|.{{MLTensor/[[descriptor]]}} returns false, then return [=a new promise=] [=rejected=] with a {{TypeError}}.
1134-
1. Let |promise| be [=a new promise=].
1131+
1. Let |realm| be [=this=]'s [=relevant realm=].
1132+
1. If |tensor|.{{MLTensor/[[context]]}} is not [=this=], then return [=a new promise=] in |realm| [=rejected=] with a {{TypeError}}.
1133+
1. If |tensor|.{{MLTensor/[[isDestroyed]]}} is true, then return [=a new promise=] in |realm| [=rejected=] with a {{TypeError}}.
1134+
1. If |tensor|.{{MLTensor/[[descriptor]]}}.{{MLTensorDescriptor/readable}} is false, then return [=a new promise=] in |realm| [=rejected=] with a {{TypeError}}.
1135+
1. If [=validating buffer with descriptor=] given |outputData| and |tensor|.{{MLTensor/[[descriptor]]}} returns false, then return [=a new promise=] in |realm| [=rejected=] with a {{TypeError}}.
1136+
1. Let |promise| be [=a new promise=] in |realm|.
11351137
1. Enqueue the following steps to |tensor|.{{MLTensor/[[context]]}}.{{MLContext/[[timeline]]}}:
11361138
1. Run these steps, but [=/abort when=] [=this=] [=MLContext/is lost=]:
11371139
1. Let |bytes| be a [=/byte sequence=] containing a copy of |tensor|.{{MLTensor/[[data]]}}.
@@ -1498,7 +1500,8 @@ The {{MLOperand}} objects are created by the methods of {{MLGraphBuilder}}, inte
14981500
<summary>
14991501
To <dfn>create an MLOperand</dfn> given {{MLGraphBuilder}} |builder| and {{MLOperandDescriptor}} |desc|, run the following steps:
15001502
</summary>
1501-
1. Let |operand| be a new {{MLOperand}}.
1503+
1. Let |realm| be |builder|'s [=relevant realm=].
1504+
1. Let |operand| be a new {{MLOperand}} in |realm|.
15021505
1. Set |operand|.{{MLOperand/[[builder]]}} to |builder|.
15031506
1. Set |operand|.{{MLOperand/[[descriptor]]}} to |desc|.
15041507
1. Return |operand|.
@@ -1508,8 +1511,10 @@ The {{MLOperand}} objects are created by the methods of {{MLGraphBuilder}}, inte
15081511
<summary>
15091512
To <dfn>copy an MLOperand</dfn> given {{MLOperand}} |operand|, run the following steps:
15101513
</summary>
1511-
1. Let |result| be a new {{MLOperand}}.
1512-
1. Set |result|.{{MLOperand/[[builder]]}} to |operand|.{{MLOperand/[[builder]]}}.
1514+
1. Let |builder| be |operand|.{{MLOperand/[[builder]]}}.
1515+
1. Let |realm| be |builder|'s [=relevant realm=].
1516+
1. Let |result| be a new {{MLOperand}} in |realm|.
1517+
1. Set |result|.{{MLOperand/[[builder]]}} to |builder|.
15131518
1. Set |result|.{{MLOperand/[[descriptor]]}} to |operand|.{{MLOperand/[[descriptor]]}}.
15141519
1. If |operand|.{{MLOperand/[[name]]}} [=map/exists=], then set |result|.{{MLOperand/[[name]]}} to |operand|.{{MLOperand/[[name]]}}.
15151520
1. Return |result|.
@@ -1607,7 +1612,8 @@ An {{MLTensor}} is created by its associated {{MLContext}}.
16071612
<summary>
16081613
To <dfn>create an MLTensor</dfn> given {{MLContext}} |context| and {{MLTensorDescriptor}} |descriptor|, run the following steps:
16091614
</summary>
1610-
1. Let |tensor| be a new {{MLTensor}}.
1615+
1. Let |realm| be |context|'s [=relevant realm=].
1616+
1. Let |tensor| be a new {{MLTensor}} in |realm|.
16111617
1. Set |tensor|.{{MLTensor/[[context]]}} to |context|.
16121618
1. Set |tensor|.{{MLTensor/[[descriptor]]}} to |descriptor|.
16131619
1. Set |tensor|.{{MLTensor/[[isDestroyed]]}} to false.
@@ -1796,12 +1802,13 @@ Build a composed graph up to a given output operand into a computational graph a
17961802
<summary>
17971803
The <dfn method for=MLGraphBuilder>build(|outputs|)</dfn> method steps are:
17981804
</summary>
1799-
1. If [=this=] [=MLGraphBuilder/can not build=], then return [=a new promise=] [=rejected=] with an "{{InvalidStateError}}" {{DOMException}}.
1800-
1. If |outputs| is empty, then return [=a new promise=] [=rejected=] with a {{TypeError}}.
1805+
1. Let |realm| be [=this=]'s [=relevant realm=].
1806+
1. If [=this=] [=MLGraphBuilder/can not build=], then return [=a new promise=] in |realm| [=rejected=] with an "{{InvalidStateError}}" {{DOMException}}.
1807+
1. If |outputs| is empty, then return [=a new promise=] in |realm| [=rejected=] with a {{TypeError}}.
18011808
1. [=map/For each=] |name| → |operand| of |outputs|:
1802-
1. If |name| is empty, then return [=a new promise=] [=rejected=] with a {{TypeError}}.
1803-
1. If [=MLGraphBuilder/validating operand=] given [=this=] and |operand| returns false, then return [=a new promise=] [=rejected=] with a {{TypeError}}.
1804-
1. If |operand| is in [=this=]'s [=MLGraphBuilder/graph=]'s [=computational graph/inputs=] or [=computational graph/constants=], then return [=a new promise=] [=rejected=] with a {{TypeError}}.
1809+
1. If |name| is empty, then return [=a new promise=] in |realm| [=rejected=] with a {{TypeError}}.
1810+
1. If [=MLGraphBuilder/validating operand=] given [=this=] and |operand| returns false, then return [=a new promise=] in |realm| [=rejected=] with a {{TypeError}}.
1811+
1. If |operand| is in [=this=]'s [=MLGraphBuilder/graph=]'s [=computational graph/inputs=] or [=computational graph/constants=], then return [=a new promise=] in |realm| [=rejected=] with a {{TypeError}}.
18051812
1. Let |operands| be a new empty [=/set=].
18061813
1. Let |operators| be a new empty [=/set=].
18071814
1. Let |inputs| be a new empty [=/set=].
@@ -1814,16 +1821,15 @@ Build a composed graph up to a given output operand into a computational graph a
18141821
1. [=list/For each=] |input| of |operand|.{{MLOperand/[[operator]]}}'s [=operator/inputs=]:
18151822
1. [=queue/Enqueue=] |input| to |queue|.
18161823
1. Let |global| be [=this=]'s [=relevant global object=].
1817-
1. Let |realm| be [=this=]'s [=relevant realm=].
1818-
1. Let |graph| be a new {{MLGraph}} with |realm|.
1824+
1. Let |graph| be a new {{MLGraph}} in |realm|.
18191825
1. Set |graph|.{{MLGraph/[[context]]}} to [=this=].{{MLGraphBuilder/[[context]]}}.
18201826
1. Set |graph|.{{MLGraph/[[isDestroyed]]}} to false.
18211827
1. [=set/For each=] |operand| in |inputs|:
18221828
1. Set |graph|.{{MLGraph/[[inputDescriptors]]}}[|operand|.{{MLOperand/[[name]]}}] to |operand|.{{MLOperand/[[descriptor]]}}.
18231829
1. [=map/For each=] |name| → |operand| of |outputs|:
18241830
1. Set |graph|.{{MLGraph/[[outputDescriptors]]}}[|name|] to |operand|.{{MLOperand/[[descriptor]]}}.
18251831
1. Set [=this=].{{MLGraphBuilder/[[hasBuilt]]}} to true.
1826-
1. Let |promise| be [=a new promise=].
1832+
1. Let |promise| be [=a new promise=] in |realm|.
18271833
1. Run the following steps [=in parallel=]:
18281834
1. Run these steps, but [=/abort when=] |graph|.{{MLGraph/[[context]]}} [=MLContext/is lost=]:
18291835
1. Let |graphImpl| be the result of converting [=this=]'s [=MLGraphBuilder/graph=] with |operands|, |operators|, |inputs|, and |outputs|'s [=map/values=] into an [=implementation-defined=] format which can be interpreted by the underlying platform.

‎tools/lint.mjs

+18-2
Original file line numberDiff line numberDiff line change
@@ -83,8 +83,9 @@ const root = parse(file, {
8383
});
8484

8585
log('simplifying DOM...');
86-
// Remove script and style elements from consideration
87-
for (const element of root.querySelectorAll('script, style')) {
86+
// Remove script and style elements from consideration. Remove generated indexes
87+
// too, since they can lead to duplicate false-positive matches for lint rules.
88+
for (const element of root.querySelectorAll('script, style, .index')) {
8889
element.remove();
8990
}
9091

@@ -350,4 +351,19 @@ for (const match of source.matchAll(/\|(\w+)\|\.{{(\w+)\/.*?}}/g)) {
350351
});
351352
}
352353

354+
// TODO: Generate this from the IDL itself.
355+
const dictionaryTypes = ['MLOperandDescriptor', 'MLContextLostInfo'];
356+
357+
// Ensure JS objects are created with explicit realm
358+
for (const match of text.matchAll(/ a new promise\b(?! in realm)/g)) {
359+
error(`Promise creation must specify realm: ${format(match)}`);
360+
}
361+
for (const match of text.matchAll(/ be a new ([A-Z]\w+)\b(?! in realm)/g)) {
362+
const type = match[1];
363+
// Dictionaries are just maps, so they don't need a realm.
364+
if (dictionaryTypes.includes(type))
365+
continue;
366+
error(`Object creation must specify realm: ${format(match)}`);
367+
}
368+
353369
globalThis.process.exit(exitCode);

0 commit comments

Comments
 (0)