@@ -23,7 +23,8 @@ JavaScript runtimes. For a more user-focussed explanation, take a look at the
23
23
* [ Canonical definitions] ( #canonical-definitions )
24
24
* [ Canonical ABI] ( #canonical-built-ins )
25
25
* [ Canonical built-ins] ( #canonical-built-ins )
26
- * [ Start definitions] ( #-start-definitions )
26
+ * [ Value definitions] ( #value-definitions )
27
+ * [ Start definitions] ( #start-definitions )
27
28
* [ Import and export definitions] ( #import-and-export-definitions )
28
29
* [ Component invariants] ( #component-invariants )
29
30
* [ JavaScript embedding] ( #JavaScript-embedding )
@@ -87,6 +88,7 @@ definition ::= core-prefix(<core:module>)
87
88
| <start> 🪺
88
89
| <import>
89
90
| <export>
91
+ | <value>
90
92
91
93
where core-prefix(X) parses '(' 'core' Y ')' when X parses '(' Y ')'
92
94
```
@@ -296,7 +298,7 @@ contain any valid UTF-8 string).
296
298
297
299
🪙 The ` value ` sort refers to a value that is provided and consumed during
298
300
instantiation. How this works is described in the
299
- [ start definitions] ( #start -definitions ) section.
301
+ [ value definitions] ( #value -definitions ) section.
300
302
301
303
To see a non-trivial example of component instantiation, we'll first need to
302
304
introduce a few other definitions below that allow components to import, define
@@ -564,10 +566,12 @@ externdesc ::= (<sort> (type <u32>) )
564
566
| <functype>
565
567
| <componenttype>
566
568
| <instancetype>
567
- | (value <valtype >) 🪙
569
+ | (value <valuebound >) 🪙
568
570
| (type <typebound>)
569
571
typebound ::= (eq <typeidx>)
570
572
| (sub resource)
573
+ valuebound ::= (eq <valueidx>)
574
+ | <valtype>
571
575
572
576
where bind-id(X) parses '(' sort <id>? Y ')' when X parses '(' sort Y ')'
573
577
```
@@ -1341,22 +1345,110 @@ number of threads that can be expected to execute concurrently.
1341
1345
See the [ CanonicalABI.md] ( CanonicalABI.md#canonical-definitions ) for detailed
1342
1346
definitions of each of these built-ins and their interactions.
1343
1347
1348
+ ### 🪙 Value Definitions
1344
1349
1345
- ### 🪙 Start Definitions
1350
+ Value definitions (in the value index space) are like immutable ` global ` definitions
1351
+ in Core WebAssembly except that validation requires them to be consumed exactly
1352
+ once at instantiation-time (i.e., they are [ linear] ).
1353
+
1354
+ Components may define values in the value index space using following syntax:
1346
1355
1347
- Like modules, components can have start functions that are called during
1348
- instantiation. Unlike modules, components can call start functions at multiple
1349
- points during instantiation with each such call having parameters and results.
1350
- Thus, ` start ` definitions in components look like function calls:
1351
1356
``` ebnf
1352
- start ::= (start <funcidx> (value <valueidx>)* (result (value <id>?))*)
1357
+ value ::= (value <id>? <valtype> <val>)
1358
+ val ::= false | true
1359
+ | <core:u8>
1360
+ | <core:s8>
1361
+ | <core:s16>
1362
+ | <core:u16>
1363
+ | <core:s32>
1364
+ | <core:u32>
1365
+ | <core:s64>
1366
+ | <core:u64>
1367
+ | <core:f32>
1368
+ | <core:f64>
1369
+ | '<core:char>'
1370
+ | "<core:name>"
1371
+ | (record <val>+)
1372
+ | (variant "<label>" <val>?)
1373
+ | (list <val>*)
1374
+ | (tuple <val>+)
1375
+ | (flags "<label>"*)
1376
+ | (enum "<label>")
1377
+ | none | (some <val>)
1378
+ | ok | (ok <val>) | error | (error <val>)
1379
+ ```
1380
+
1381
+ Where ` val ` definition must match the ` valtype ` specified as defined in [ Binary.md] ( Binary.md ) .
1382
+
1383
+ For example:
1384
+ ``` wasm
1385
+ (component
1386
+ (value $a bool true)
1387
+ (value $b u8 1)
1388
+ (value $c u16 2)
1389
+ (value $d u32 3)
1390
+ (value $e u64 4)
1391
+ (value $f u8 5)
1392
+ (value $g u16 6)
1393
+ (value $h u32 7)
1394
+ (value $i u64 8)
1395
+ (value $j f32 9.1)
1396
+ (value $k f64 9.2)
1397
+ (value $l char 'a')
1398
+ (value $m string "hello")
1399
+ (value $n (record (field "a" bool) (field "b" u8)) (record true 1))
1400
+ (value $o (variant (case "a" bool) (case "b" u8)) (variant "b" 1))
1401
+ (value $p (list (result (option u8)))
1402
+ (list
1403
+ error
1404
+ (ok (some 1))
1405
+ (ok none)
1406
+ error
1407
+ (ok (some 2))
1408
+ )
1409
+ )
1410
+ (value $q (tuple u8 u16 u32) (tuple 1 2 3))
1411
+
1412
+ (type $abc (flags "a" "b" "c"))
1413
+ (value $r $abc (flags "a" "c"))
1414
+
1415
+ (value $s (enum "a" "b" "c") (enum "b"))
1416
+
1417
+ (type $complex
1418
+ (tuple
1419
+ (record
1420
+ (field "a" (option string))
1421
+ (field "b" (tuple (option u8) string))
1422
+ )
1423
+ (list char)
1424
+ $abc
1425
+ string
1426
+ )
1427
+ )
1428
+ (value $complex1 $complex
1429
+ (tuple
1430
+ (record
1431
+ none
1432
+ (tuple none "empty")
1433
+ )
1434
+ (list)
1435
+ (flags)
1436
+ ""
1437
+ )
1438
+ )
1439
+ (value $complex2 $complex
1440
+ (tuple
1441
+ (record
1442
+ (some "example")
1443
+ (tuple (some 42) "hello")
1444
+ )
1445
+ (list 'a' 'b' 'c')
1446
+ (flags "b" "a")
1447
+ "hi"
1448
+ )
1449
+ )
1450
+ )
1353
1451
```
1354
- The ` (value <valueidx>)* ` list specifies the arguments passed to ` funcidx ` by
1355
- indexing into the * value index space* . Value definitions (in the value index
1356
- space) are like immutable ` global ` definitions in Core WebAssembly except that
1357
- validation requires them to be consumed exactly once at instantiation-time
1358
- (i.e., they are [ linear] ). The arity and types of the two value lists are
1359
- validated to match the signature of ` funcidx ` .
1360
1452
1361
1453
As with all definition sorts, values may be imported and exported by
1362
1454
components. As an example value import:
@@ -1366,6 +1458,28 @@ components. As an example value import:
1366
1458
As this example suggests, value imports can serve as generalized [ environment
1367
1459
variables] , allowing not just ` string ` , but the full range of ` valtype ` .
1368
1460
1461
+ Example of a value export:
1462
+ ``` wasm
1463
+ (value $default_url string "https://example.com")
1464
+ (export "default-url" (value $default_url))
1465
+ ;; `default-url` value export will infer `(eq $default_url)` value bound in the component type,
1466
+ ;; include a type ascription to explicitly set type to `string`:
1467
+ (export "default-url-string" (value $default_url) (value string))
1468
+ ```
1469
+
1470
+ ### 🪙 Start Definitions
1471
+
1472
+ Like modules, components can have start functions that are called during
1473
+ instantiation. Unlike modules, components can call start functions at multiple
1474
+ points during instantiation with each such call having parameters and results.
1475
+ Thus, ` start ` definitions in components look like function calls:
1476
+ ``` ebnf
1477
+ start ::= (start <funcidx> (value <valueidx>)* (result (value <id>?))*)
1478
+ ```
1479
+ The ` (value <valueidx>)* ` list specifies the arguments passed to ` funcidx ` by
1480
+ indexing into the * value index space* . The arity and types of the two value lists are
1481
+ validated to match the signature of ` funcidx ` .
1482
+
1369
1483
With this, we can define a component that imports a string and computes a new
1370
1484
exported string at instantiation time:
1371
1485
``` wasm
@@ -1927,6 +2041,17 @@ and will be added over the coming months to complete the MVP proposal:
1927
2041
[ Index Space ] : https://webassembly.github.io/spec/core/syntax/modules.html#indices
1928
2042
[ Abbreviations ] : https://webassembly.github.io/spec/core/text/conventions.html#abbreviations
1929
2043
2044
+ [ `core:s8` ] : https://webassembly.github.io/spec/core/syntax/values.html#integers
2045
+ [ `core:u8` ] : https://webassembly.github.io/spec/core/syntax/values.html#integers
2046
+ [ `core:s16` ] : https://webassembly.github.io/spec/core/syntax/values.html#integers
2047
+ [ `core:u16` ] : https://webassembly.github.io/spec/core/syntax/values.html#integers
2048
+ [ `core:s32` ] : https://webassembly.github.io/spec/core/syntax/values.html#integers
2049
+ [ `core:u32` ] : https://webassembly.github.io/spec/core/syntax/values.html#integers
2050
+ [ `core:s64` ] : https://webassembly.github.io/spec/core/syntax/values.html#integers
2051
+ [ `core:u64` ] : https://webassembly.github.io/spec/core/syntax/values.html#integers
2052
+ [ `core:f32` ] : https://webassembly.github.io/spec/core/syntax/values.html#floating-point
2053
+ [ `core:f64` ] : https://webassembly.github.io/spec/core/syntax/values.html#floating-point
2054
+ [ `core:char` ] : https://webassembly.github.io/spec/core/syntax/values.html#syntax-name
1930
2055
[ `core:name` ] : https://webassembly.github.io/spec/core/syntax/values.html#syntax-name
1931
2056
[ `core:module` ] : https://webassembly.github.io/spec/core/text/modules.html#text-module
1932
2057
[ `core:type` ] : https://webassembly.github.io/spec/core/text/modules.html#types
0 commit comments