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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
//! Intrinsics that represent helpers that enable Future integration
use std::fmt::Write;
use crate::intrinsics::component::ComponentIntrinsic;
use crate::intrinsics::{Intrinsic, RenderIntrinsicsArgs};
use crate::source::Source;
use crate::uwriteln;
use super::async_task::AsyncTaskIntrinsic;
/// This enum contains intrinsics that enable Futures
#[derive(Debug, Copy, Clone, Ord, PartialOrd, Eq, PartialEq)]
pub enum AsyncFutureIntrinsic {
/// Global that stores futures
///
/// ```ts
/// type i32 = number;
/// type FutureEnd = FutureWritableEndClass | FutureReadableEndClass;
/// type GlobalFutureMap<T> = Map<i32, FutureEnd>;
/// ```
GlobalFutureMap,
/// Symbol that is used to delineate futures that are nested
NestedFutureSymbol,
/// Map of future tables to component indices
GlobalFutureTableMap,
/// The definition of the `FutureWritableEnd` JS class
///
/// This class serves as a shared implementation used by writable and readable ends
FutureEndClass,
/// The definition of the `HostFuture` JS class
///
/// This class serves as an implementation for top level host-managed futures,
/// internal to the bindgen generated logic.
///
/// External code is no expected to work in terms of `HostFuture`, but rather deal with `Future`s
///
HostFutureClass,
/// An internal future class that coordinates boht writable and readable ends
InternalFutureClass,
/// The definition of the `FutureWritableEnd` JS class
FutureWritableEndClass,
/// The definition of the `FutureReadableEnd` JS class
FutureReadableEndClass,
/// Create a new future
///
/// See: https://github.com/WebAssembly/component-model/blob/main/design/mvp/CanonicalABI.md#-canon-streamfuturenew
///
/// # Intrinsic implementation function
///
/// The function that implements this intrinsic has the following definition:
///
/// ```ts
/// type u32 = number; // >= 0
/// type u64 = bigint; // >= 0
/// function futureNew(typeRep: u32): u64;
/// ```
FutureNew,
/// Create a new future during a lift (`Instruction::FutureLift`).
///
/// This is distinct from plain future creation, because we are provided more information,
/// particularly the relevant types to teh future and lift/lower fns for the future.
///
/// ```ts
/// type Ctx = {
/// componentIdx: number,
/// futureTableIdx: number,
/// elemMeta: object,
/// }
/// function futureNewFromLift(ctx: Ctx);
/// ```
///
FutureNewFromLift,
/// Read from a future
///
/// See: https://github.com/WebAssembly/component-model/blob/main/design/mvp/CanonicalABI.md#-canon-futurefuturereadwrite
///
/// # Intrinsic implementation function
///
/// The function that implements this intrinsic has the following definition:
///
/// ```ts
/// type i32 = number;
/// type u32 = number; // >=0
/// type i64 = bigint;
/// type StringEncoding = 'utf8' | 'utf16' | 'compact-utf16'; // see wasmtime_environ::StringEncoding
///
/// function futureRead(
/// componentIdx: i32,
/// memory: i32,
/// realloc: i32,
/// encoding: StringEncoding,
/// isAsync: bool,
/// typeRep: u32,
/// futureRep: u32,
/// ptr: u32,
/// count:u322
/// ): i64;
/// ```
FutureRead,
/// Write to a future
///
/// See: https://github.com/WebAssembly/component-model/blob/main/design/mvp/CanonicalABI.md#-canon-streamfuturereadwrite
///
/// # Intrinsic implementation function
///
/// The function that implements this intrinsic has the following definition:
///
/// ```ts
/// type i32 = number;
/// type u32 = number; // >=0
/// type i64 = bigint;
/// type StringEncoding = 'utf8' | 'utf16' | 'compact-utf16'; // see wasmtime_environ::StringEncoding
///
/// function futureWrite(
/// componentIdx: i32,
/// memory: i32,
/// realloc: i32,
/// encoding: StringEncoding,
/// isAsync: bool,
/// typeRep: u32,
/// futureRep: u32,
/// ptr: u32,
/// count:u322
/// ): i64;
/// ```
FutureWrite,
/// Cancel a read to a future
///
/// See: https://github.com/WebAssembly/component-model/blob/main/design/mvp/CanonicalABI.md#-canon-streamfuturecancel-readread
///
/// # Intrinsic implementation function
///
/// The function that implements this intrinsic has the following definition:
///
/// ```ts
/// type u32 = number; // >=0
/// type u64 = bigint; // >=0
///
/// function futureCancelRead(futureRep: u32, isAsync: boolean, readerRep: u32): u64;
/// ```
FutureCancelRead,
/// Cancel a write to a future
///
/// See: https://github.com/WebAssembly/component-model/blob/main/design/mvp/CanonicalABI.md#-canon-streamfuturecancel-writewrite
///
/// # Intrinsic implementation function
///
/// The function that implements this intrinsic has the following definition:
///
/// ```ts
/// type u32 = number; // >=0
/// type u64 = bigint; // >= 0
///
/// function futureCancelWrite(futureRep: u32, isAsync: boolean, writerRep: u32): u64;
/// ```
FutureCancelWrite,
/// Drop a the readable end of a Future
///
/// See: https://github.com/WebAssembly/component-model/blob/main/design/mvp/CanonicalABI.md#-canon-streamfuturedrop-readablewritable
///
/// # Intrinsic implementation function
///
/// The function that implements this intrinsic has the following definition:
///
/// ```ts
/// type u32 = number; // >=0
///
/// function futureDropReadable(futureRep: u32, readerRep: u32): bool;
/// ```
FutureDropReadable,
/// Drop a the writable end of a Future
///
/// See: https://github.com/WebAssembly/component-model/blob/main/design/mvp/CanonicalABI.md#-canon-streamfuturedrop-readablewritable
///
/// # Intrinsic implementation function
///
/// The function that implements this intrinsic has the following definition:
///
/// ```ts
/// type u32 = number; // >=0
///
/// function futureDropWritable(futureRep: u32, writerRep: u32): bool;
/// ```
FutureDropWritable,
/// Instruction emitted by FACT modules that enables the transfer of a future
///
/// See [`Trampoline::FutureTransfer`]
FutureTransfer,
/// Function that generates a host injection function for external futures
///
/// This is usually used when lowering external `Promise<T>`s into components, creating
/// readable ends as necessary.
///
/// The generated host injection function is generally called right when a component
/// attempts to read (in doing so, "injecting" a write before the component read).
GenFutureHostInjectFn,
/// Function to check whether a JS object can be used as a stream
IsFutureLowerableObject,
}
impl AsyncFutureIntrinsic {
/// Retrieve dependencies for this intrinsic
pub fn deps() -> &'static [&'static Intrinsic] {
&[]
}
/// Retrieve global names for this intrinsic
pub fn get_global_names() -> impl IntoIterator<Item = &'static str> {
[
Self::FutureCancelRead.name(),
Self::FutureCancelWrite.name(),
Self::FutureDropReadable.name(),
Self::FutureDropWritable.name(),
Self::FutureEndClass.name(),
Self::FutureNew.name(),
Self::FutureNewFromLift.name(),
Self::FutureRead.name(),
Self::FutureReadableEndClass.name(),
Self::FutureTransfer.name(),
Self::FutureWritableEndClass.name(),
Self::FutureWrite.name(),
Self::GlobalFutureMap.name(),
Self::GlobalFutureTableMap.name(),
Self::InternalFutureClass.name(),
Self::GenFutureHostInjectFn.name(),
Self::IsFutureLowerableObject.name(),
Self::NestedFutureSymbol.name(),
]
}
/// Get the name for the intrinsic
pub fn name(&self) -> &'static str {
match self {
Self::FutureCancelRead => "futureCancelRead",
Self::FutureCancelWrite => "futureCancelWrite",
Self::FutureDropReadable => "futureDropReadable",
Self::FutureDropWritable => "futureDropWritable",
Self::FutureEndClass => "FutureEnd",
Self::FutureNew => "futureNew",
Self::FutureNewFromLift => "futureNewFromLift",
Self::FutureRead => "futureRead",
Self::FutureReadableEndClass => "FutureReadableEnd",
Self::FutureTransfer => "futureTransfer",
Self::FutureWritableEndClass => "FutureWritableEnd",
Self::FutureWrite => "futureWrite",
Self::GlobalFutureMap => "FUTURES",
Self::NestedFutureSymbol => "NESTED_FUTURE_SYMBOL",
Self::GlobalFutureTableMap => "FUTURE_TABLES",
Self::HostFutureClass => "HostFuture",
Self::InternalFutureClass => "InternalFuture",
Self::GenFutureHostInjectFn => "_genFutureHostInjectFn",
Self::IsFutureLowerableObject => "_isFutureLowerableObject",
}
}
/// Render an intrinsic to a string
pub fn render(&self, output: &mut Source, _render_args: &RenderIntrinsicsArgs<'_>) {
match self {
Self::GlobalFutureMap => {
let global_future_map = Self::GlobalFutureMap.name();
let rep_table_class = Intrinsic::RepTableClass.name();
output.push_str(&format!(
r#"
const {global_future_map} = new {rep_table_class}({{ target: 'global future map' }});
"#
));
}
Self::NestedFutureSymbol => {
let nested_future_symbol = self.name();
output.push_str(&format!(
r#"
const {nested_future_symbol} = Symbol.for('nested-future');
"#
));
}
Self::GlobalFutureTableMap => {
let global_future_table_map = Self::GlobalFutureTableMap.name();
output.push_str(&format!(
r#"
const {global_future_table_map} = {{}};
"#
));
}
// The host future class is used exclusively *inside* the host implementation,
// to represent future that have been lifted (or originated) external to a given
// component.
//
// For example, after a component-internal future is lifted from a component (normally
// by way of returning it from a function), that future will have been made into a host
// future, and *may* give actual end users access via the `createUserFuture()` function.
//
// At present since futures can only give away the read-end, this usually means that the
// host future will be used to often give away the *read* end.
//
Self::HostFutureClass => {
let debug_log_fn = Intrinsic::DebugLog.name();
let host_future_class_name = self.name();
let get_or_create_async_state_fn =
Intrinsic::Component(ComponentIntrinsic::GetOrCreateAsyncState).name();
output.push_str(&format!(
r#"
class {host_future_class_name} {{
#componentIdx;
#futureEndWaitableIdx;
#futureTableIdx;
#payloadLiftFn;
#payloadLowerFn;
#userFuture;
#rep = null;
constructor(args) {{
{debug_log_fn}('[{host_future_class_name}#constructor()] args', args);
if (args.componentIdx === undefined) {{ throw new TypeError("missing component idx"); }}
this.#componentIdx = args.componentIdx;
if (!args.payloadLiftFn) {{ throw new TypeError("missing payload lift fn"); }}
this.#payloadLiftFn = args.payloadLiftFn;
if (!args.payloadLowerFn) {{ throw new TypeError("missing payload lower fn"); }}
this.#payloadLowerFn = args.payloadLowerFn;
if (args.futureEndWaitableIdx === undefined) {{ throw new Error("missing future idx"); }}
if (args.futureTableIdx === undefined) {{ throw new Error("missing future table idx"); }}
this.#futureEndWaitableIdx = args.futureEndWaitableIdx;
this.#futureTableIdx = args.futureTableIdx;
}}
setRep(rep) {{ this.#rep = rep; }}
getFutureEndWaitableIdx() {{ return this.#futureEndWaitableIdx; }}
createUserFuture() {{
if (this.#userFuture) {{ return this.#userFuture; }}
if (this.#rep === null) {{ throw new Error("unexpectedly missing rep for host future"); }}
const cstate = {get_or_create_async_state_fn}(this.#componentIdx);
if (!cstate) {{ throw new Error(`missing async state for component [${{this.#componentIdx}}]`); }}
const futureEnd = cstate.getFutureEnd({{
tableIdx: this.#futureTableIdx,
futureEndWaitableIdx: this.#futureEndWaitableIdx
}});
if (!futureEnd) {{
throw new Error(`missing future [${{this.#futureEndWaitableIdx}}] (table [${{this.#futureTableIdx}}], component [${{this.#componentIdx}}]`);
}}
return futureEnd.promise();
}}
}}
"#
));
}
Self::FutureEndClass => {
let debug_log_fn = Intrinsic::DebugLog.name();
let future_end_class = Self::FutureEndClass.name();
uwriteln!(
output,
r#"
class {future_end_class} {{
static CopyResult = {{
COMPLETED: 0,
DROPPED: 1,
CANCELLED: 2,
}};
static CopyState = {{
IDLE: 1,
SYNC_COPYING: 2,
ASYNC_COPYING: 3,
CANCELLING_COPY: 4,
DONE: 5,
}};
#pendingBufferMeta;
#waitable;
#copyState = {future_end_class}.CopyState.IDLE;
#dropped = false;
constructor(args) {{
{debug_log_fn}('[{future_end_class}#constructor()] args', args);
if (!args.pendingBufferMeta) {{ throw new Error("missing pending buffer"); }}
this.#pendingBufferMeta = args.pendingBufferMeta;
if (!args.waitable) {{ throw new Error("missing pending buffer"); }}
this.#waitable = args.waitable;
}}
getWaitable() {{ return this.#waitable; }}
setWaitable(w) {{ this.#waitable = w; }}
setCopyState(state) {{ this.#copyState = state; }}
getCopyState() {{ return this.#copyState; }}
isDoneState() {{ return this.getCopyState() === {future_end_class}.CopyState.DONE; }}
isCancelledState() {{ return this.getCopyState() === {future_end_class}.CopyState.CANCELLED; }}
isIdleState() {{ return this.getCopyState() === {future_end_class}.CopyState.IDLE; }}
isCopying() {{
switch (this.#copyState) {{
case {future_end_class}.CopyState.IDLE:
case {future_end_class}.CopyState.DONE:
return false;
break;
case {future_end_class}.CopyState.SYNC_COPYING:
case {future_end_class}.CopyState.ASYNC_COPYING:
case {future_end_class}.CopyState.CANCELLING_COPY:
return true;
break;
default:
throw new Error('invalid/unknown copying state');
}}
}}
setPendingBufferMeta(args) {{
const {{ componentIdx, buffer, onCopyDoneFn }} = args;
this.#pendingBufferMeta.componentIdx = componentIdx;
this.#pendingBufferMeta.buffer = buffer;
this.#pendingBufferMeta.onCopyDoneFn = onCopyDoneFn;
}}
resetPendingBufferMeta() {{
this.setPendingBufferMeta({{ componentIdx: null, buffer: null, onCopyDoneFn: null }});
}}
getPendingBufferMeta() {{ return this.#pendingBufferMeta; }}
resetAndNotifyPending(result) {{
const f = this.#pendingBufferMeta.onCopyDoneFn;
this.resetPendingBufferMeta();
if (f) {{ f(result); }}
}}
setPendingEvent(fn) {{
if (!this.#waitable) {{ throw new Error('missing/invalid waitable'); }}
{debug_log_fn}('[{future_end_class}#setPendingEvent()]', {{
waitable: this.#waitable,
waitableinSet: this.#waitable.isInSet(),
componentIdx: this.#waitable.componentIdx(),
}});
this.#waitable.setPendingEvent(fn);
}}
hasPendingEvent() {{
if (!this.#waitable) {{ throw new Error('missing/invalid waitable'); }}
return this.#waitable.hasPendingEvent();
}}
getPendingEvent() {{
if (!this.#waitable) {{ throw new Error('missing/invalid waitable'); }}
{debug_log_fn}('[{future_end_class}#getPendingEvent()]', {{
waitable: this.#waitable,
waitableinSet: this.#waitable.isInSet(),
componentIdx: this.#waitable.componentIdx(),
}});
const event = this.#waitable.getPendingEvent();
return event;
}}
isDropped() {{ return this.#dropped; }}
drop() {{
if (this.#dropped) {{ throw new Error('future already dropped'); }}
if (this.#pendingBufferMeta.buffer) {{
if (!pendingBufferMeta.buffer.isWritable()) {{
throw new Error('non-writable pending buffer during drop (reader blocked)');
}}
this.resetAndNotifyPending({future_end_class}.CopyResult.DROPPED);
}}
this.#dropped = true;
}}
}}
"#
);
}
Self::FutureReadableEndClass | Self::FutureWritableEndClass => {
let debug_log_fn = Intrinsic::DebugLog.name();
let (class_name, _future_var_name, _js_future_var_type) = match self {
Self::FutureReadableEndClass => (self.name(), "promise", "Promise"),
Self::FutureWritableEndClass => (self.name(), "resolve", "Function"),
_ => unreachable!(),
};
let future_end_class = Self::FutureEndClass.name();
let global_buffer_mgr = Intrinsic::GlobalBufferManager.name();
let async_event_code_enum = Intrinsic::AsyncEventCodeEnum.name();
// Generate the inner read/write logic necessary for eitther kind of write end
// this will be called internally (usually during guest reads), via places like
// `Instruction::FutureRead`/`Instruction::FutureWrite`
let (_inner_rw_fn_name, inner_rw_fn) = match self {
Self::FutureReadableEndClass => (
"_read",
format!(
r#"
async _read(args) {{
const {{ buffer, onCopyDoneFn, componentIdx }} = args;
if (!buffer) {{ throw new Error('missing buffer for future read'); }}
if (this.isDropped()) {{ throw new Error('cannot read from dropped future'); }}
if (buffer.remaining() !== 1) {{
throw new Error(`invalid remaining values in buffer (expecetd one, received [${{buffer.remaining()}}]`);
}}
const meta = this.getPendingBufferMeta();
if (!meta) {{ throw new Error("missing pending buffer metadata"); }}
if (!meta.buffer) {{
this.setPendingBufferMeta({{
buffer,
componentIdx,
onCopyDoneFn,
}});
return;
}}
if (componentIdx === meta.componentIdx && componentIdx !== -1 && !this.#elemMeta.isNoneOrNumberType) {{
throw new Error('same-component future reads not allowed for non-numeric types');
}}
buffer.write(meta.buffer.read(1));
this.resetAndNotifyPending({future_end_class}.CopyResult.COMPLETED);
onCopyDoneFn({future_end_class}.CopyResult.COMPLETED);
}}
"#,
),
),
Self::FutureWritableEndClass => (
"_write",
format!(
r#"
async _write(args) {{
const {{ buffer, onCopyDoneFn, componentIdx }} = args;
if (!buffer) {{ throw new Error('missing buffer for future write'); }}
if (buffer.remaining() !== 1) {{
throw new Error("invalid remaining capacity for pending buffer");
}}
if (this.isDropped()) {{
onCopyDoneFn({future_end_class}.CopyResult.DROPPED);
return;
}}
const meta = this.getPendingBufferMeta();
if (!meta) {{ throw new Error("missing pending buffer metadata"); }}
if (!meta.buffer) {{
this.setPendingBufferMeta({{
buffer,
onCopyDoneFn,
}});
return;
}}
if (componentIdx === meta.componentIdx && componentIdx !== -1 && !this.#elemMeta.isNoneOrNumberType) {{
throw new Error('same-component future writes not allowed for non-numeric types');
}}
meta.buffer.write(buffer.read(1));
this.resetAndNotifyPending({future_end_class}.CopyResult.COMPLETED);
onCopyDoneFn({future_end_class}.CopyResult.COMPLETED);
}}
"#
),
),
_ => unreachable!(),
};
// Read/Write function that is called when a component (guest) is performing the read/write
let (_guest_rw_fn_name, guest_rw_fn) = match self {
Self::FutureReadableEndClass => (
"guestRead",
format!(
r#"
// TODO: rename, guestRead also handles host reads (when data is present)...
async guestRead(args) {{
{debug_log_fn}('[{class_name}#guestRead()] args', args);
const {{
componentIdx,
stringEncoding,
memory,
realloc,
ptr,
data,
}} = args;
if (this.#elemMeta.stringEncoding === undefined && stringEncoding) {{
this.#elemMeta.stringEncoding = stringEncoding;
}}
if (args.getReallocFn && this.#elemMeta.getReallocFn === undefined) {{
this.#elemMeta.getReallocFn = args.getReallocFn;
}}
const elemMeta = this.#elemMeta;
if (this.#elemMeta.isBorrowed) {{
throw new Error('cannot call future.read on a borrow');
}}
let buffer = args.buffer;
if (!buffer) {{
const createBufferRes = {global_buffer_mgr}.createBuffer({{
componentIdx,
memory,
realloc,
start: ptr,
data,
count: 1,
isReadable: this.isWritable(),
isWritable: this.isReadable(),
elemMeta: this.#elemMeta,
}});
buffer = createBufferRes.buffer;
}}
const futureEvent = (res) => {{
if (buffer.remaining() === 0) {{
if (res !== {future_end_class}.CopyResult.COMPLETED) {{
throw new Error('invalid buffer state, expected zero remaining post-completion');
}}
}} else {{
if (res === {future_end_class}.CopyResult.COMPLETED) {{
throw new Error('invalid buffer state, expected 1 remaining post-completion');
}}
}}
if (res === {future_end_class}.CopyResult.DROPPED || res === {future_end_class}.CopyResult.COMPLETED) {{
this.setCopyState({future_end_class}.CopyState.DONE);
}} else {{
this.setCopyState({future_end_class}.CopyState.IDLE);
}}
return {{ code: {async_event_code_enum}.FUTURE_READ, payload0: this.waitableIdx(), payload1: res }};
}};
const isReadableEnd = this.isReadable();
const onCopyDoneFn = (res) => {{
if (res === {future_end_class}.CopyResult.DROPPED && isReadableEnd) {{
throw new Error('cannot read from a dropped future');
}}
this.setPendingEvent(() => futureEvent(res));
}};
// Before performing this read, if we're dealing with a host-controlled
// future, then we should inject a write, but we can't wait for it to complete
// as we must do the rendesvous read below for the write to complete.
let injectedWritePromise;
if (this.#hostInjectFn) {{
injectedWritePromise = this.#hostInjectFn({{ count: 1 }});
}}
await this._read({{
buffer,
onCopyDoneFn,
componentIdx,
}});
if (injectedWritePromise) {{
const cleanupFn = await injectedWritePromise;
cleanupFn();
}}
return {{ buffer }};
}}
"#
),
),
Self::FutureWritableEndClass => (
"guestWrite",
format!(
r#"
async guestWrite(args) {{
{debug_log_fn}('[{class_name}#guestWrite()] args', args);
const {{
componentIdx,
stringEncoding,
getReallocFn,
isAsync,
memory,
realloc,
ptr,
data,
}} = args;
if (this.#elemMeta.stringEncoding === undefined && stringEncoding) {{
this.#elemMeta.stringEncoding = stringEncoding;
}}
if (args.getReallocFn && this.#elemMeta.getReallocFn === undefined) {{
this.#elemMeta.getReallocFn = getReallocFn;
}}
const elemMeta = this.#elemMeta;
if (this.#elemMeta.isBorrowed) {{
throw new Error('cannot call future.read on a borrow');
}}
let buffer = args.buffer;
if (!buffer) {{
const createBufferRes = {global_buffer_mgr}.createBuffer({{
componentIdx,
memory,
realloc,
start: ptr,
data,
count: 1,
isReadable: this.isWritable(),
isWritable: this.isReadable(),
elemMeta: this.#elemMeta,
}});
buffer = createBufferRes.buffer;
}}
const futureEvent = (res) => {{
if (buffer.remaining() === 0) {{
if (res !== {future_end_class}.CopyResult.COMPLETED) {{
throw new Error('invalid buffer state, expected zero remaining post-completion');
}}
}} else {{
if (res === {future_end_class}.CopyResult.COMPLETED) {{
throw new Error('invalid buffer state, expected 1 remaining post-completion');
}}
}}
if (res === {future_end_class}.CopyResult.DROPPED || res === {future_end_class}.CopyResult.COMPLETED) {{
this.setCopyState({future_end_class}.CopyState.DONE);
}} else {{
this.setCopyState({future_end_class}.CopyState.IDLE);
}}
return {{ code: {async_event_code_enum}.FUTURE_WRITE, payload0: this.waitableIdx(), payload1: res }};
}};
const onCopyDoneFn = (res) => {{
this.setPendingEvent(() => futureEvent(res));
}};
await this._write({{
buffer,
onCopyDoneFn,
componentIdx,
}});
return {{ buffer }};
}}
"#
),
),
_ => unreachable!(),
};
// Read/Write function that is called when the host is performing the read/write
let (_host_rw_fn_name, host_rw_fn) = match self {
Self::FutureReadableEndClass => (
"hostRead",
format!(
r#"
async hostRead(args) {{
const {{ stringEncoding }} = args;
const {{ buffer }} = await this.guestRead({{
stringEncoding,
isAsync: true,
data: [],
componentIdx: -1,
}});
if (!this.hasPendingEvent()) {{
this.setCopyState({future_end_class}.CopyState.ASYNC_COPYING);
// Wait for the write to complete
await new Promise((resolve) => {{
let waitInterval = setInterval(() => {{
if (!this.hasPendingEvent()) {{ return; }}
clearInterval(waitInterval);
resolve();
}});
}});
// Perform another write, reusing the buffer
const {{ buffer }} = await this.guestRead({{
buffer,
stringEncoding,
isAsync: true,
}});
if (!this.hasPendingEvent()) {{
throw new Error("missing pending event after blocked future read");
}}
}}
const {{ code, payload0: index, payload1: payload }} = this.getPendingEvent();
if (code !== {async_event_code_enum}.FUTURE_READ) {{
throw new Error(`mismatched event code [${{code}}] for host future read`);
}}
if (index !== this.waitableIdx()) {{ throw new Error('mismatched future end index'); }}
const vs = buffer.read(1);
if (vs.length !== 1) {{ throw new Error('multiple results from future'); }}
return vs[0];
}}
"#
),
),
Self::FutureWritableEndClass => (
"hostWrite",
format!(
r#"
async hostWrite(args) {{
const {{ stringEncoding, value, getReallocFn }} = args;
const {{ buffer }} = await this.guestWrite({{
stringEncoding,
getReallocFn,
// TODO: support sync host writes
isAsync: true,
data: [value],
componentIdx: -1,
componentIdx: -1,
}});
if (!this.hasPendingEvent()) {{
this.setCopyState({future_end_class}.CopyState.ASYNC_COPYING);
// Wait for the write to complete
await new Promise((resolve) => {{
let waitInterval = setInterval(() => {{
if (!this.hasPendingEvent()) {{ return; }}
clearInterval(waitInterval);
resolve();
}});
}});
// Perform another write, reusing the buffer
const {{ buffer }} = await this.guestWrite({{
buffer,
stringEncoding,
isAsync: true,
}});
if (!this.hasPendingEvent()) {{
throw new Error("missing pending event after blocked future write");
}}
}}
const {{ code, payload0: index, payload1: payload }} = this.getPendingEvent();
if (code !== {async_event_code_enum}.FUTURE_WRITE) {{
throw new Error(`mismatched event code [${{code}}] for host future write`);
}}
if (index !== this.waitableIdx()) {{ throw new Error('mismatched future end index'); }}
}}
"#
),
),
_ => unreachable!(),
};
let type_getters = match self {
Self::FutureWritableEndClass => "
isReadable() { return false; }
isWritable() { return true; }
"
.to_string(),
Self::FutureReadableEndClass => "
isReadable() { return true; }
isWritable() { return false; }
"
.to_string(),
_ => unreachable!(),
};
let drop_check = match self {
Self::FutureReadableEndClass => "",
Self::FutureWritableEndClass => {
r#"
if (this.isWritable() && !this.isDoneState()) {{
throw new Error('trap: futures must not be dropped before being completed');
}}
"#
}
_ => unreachable!(),
};
uwriteln!(
output,
r#"
class {class_name} extends {future_end_class} {{
#globalFutureMapRep;
#futureTableIdx;
#isHostOwned;
#hostInjectFn;
#elemMeta;
#handle;
#promise;
target;
constructor(args) {{
{debug_log_fn}('[{class_name}#constructor()] args', args);
super(args);
if (!args.elemMeta) {{ throw new Error('missing/invalid element meta'); }}
this.#elemMeta = args.elemMeta;
if (args.tableIdx === undefined) {{ throw new Error('missing index for future table idx'); }}
this.#futureTableIdx = args.tableIdx;
this.#hostInjectFn = args.hostInjectFn;
this.#isHostOwned = args.hostOwned;
}}
{type_getters}
setTarget(tgt) {{ this.target = tgt; }}
getElemMeta() {{ return {{...this.#elemMeta}}; }}
futureTableIdx() {{ return this.#futureTableIdx; }}
globalFutureMapRep() {{ return this.#globalFutureMapRep; }}
setGlobalFutureMapRep(rep) {{ this.#globalFutureMapRep = rep; }}
waitableIdx() {{ return this.getWaitable().idx(); }}
setWaitableIdx(idx) {{
const w = this.getWaitable();
w.setIdx(idx);
w.setTarget(`waitable for {class_name} (waitable [${{idx}}])`);
}}
handle() {{ return this.#handle; }}
setHandle(h) {{ this.#handle = h; }}
setHostInjectFn(f) {{
if (this.#hostInjectFn) {{ throw new Error('host injection fn is already set'); }}
this.#hostInjectFn = f;
}}
promise() {{
if (this.#promise) {{ return this.#promise; }}
// NOTE: we return a "thenable" here to ensure that simply lifting the future does
// not trigger a host read.
let readPromise = null;
this.#promise = {{
then: (resolve, reject) => {{
if (readPromise) {{
readPromise.then(resolve, reject);
return;
}}
readPromise = this.hostRead({{ stringEncoding: 'utf8' }});
readPromise.then(resolve, reject);
}}
}};
return this.#promise;
}}
cancel() {{
{debug_log_fn}('[{future_end_class}#cancel()]');
this.resetAndNotifyPending({future_end_class}.CopyResult.CANCELLED);
}}
{inner_rw_fn}
{guest_rw_fn}
{host_rw_fn}
drop() {{
{drop_check}
super.drop();
}}
}}
"#
);
}
Self::InternalFutureClass => {
let debug_log_fn = Intrinsic::DebugLog.name();
let internal_future_class = Self::InternalFutureClass.name();
let write_end_class = Self::FutureWritableEndClass.name();
let read_end_class = Self::FutureReadableEndClass.name();
uwriteln!(
output,
r#"
class {internal_future_class} {{
#globalFutureMapRep;
#pendingBufferMeta = {{}}; // Shared between read and write ends
#elemMeta;
#readEnd;
#writeEnd;
constructor(args) {{
{debug_log_fn}('[{internal_future_class}#constructor()] args', args);
if (!args.elemMeta) {{ throw new Error('missing/invalid future element metadata'); }}
if (args.tableIdx === undefined) {{ throw new Error('missing/invalid future table idx'); }}
if (!args.readWaitable) {{ throw new Error('missing/invalid read waitable'); }}
if (!args.writeWaitable) {{ throw new Error('missing/invalid write waitable'); }}
const {{
tableIdx,
elemMeta,
readWaitable,
writeWaitable,
}} = args;
this.#elemMeta = args.elemMeta;
let dropped = false;
const setDroppedFn = () => {{ dropped = true }};
const isDroppedFn = () => dropped;
this.#readEnd = new {read_end_class}({{
tableIdx,
elemMeta: this.#elemMeta,
pendingBufferMeta: this.#pendingBufferMeta,
target: "future read end (@ init)",
waitable: readWaitable,
// Only in-component read-ends need the host inject fn if provided,
// as that function will *inject* a write when the future is checked
// from inside the guest.
hostInjectFn: args.hostInjectFn,
setDroppedFn,
isDroppedFn,
}});
this.#writeEnd = new {write_end_class}({{
tableIdx,
elemMeta: this.#elemMeta,
pendingBufferMeta: this.#pendingBufferMeta,
target: "future write end (@ init)",
waitable: writeWaitable,
hostOwned: true,
setDroppedFn,
isDroppedFn,
}});
}}
elemMeta() {{ return this.#elemMeta; }}
readEnd() {{ return this.#readEnd; }}
writeEnd() {{ return this.#writeEnd; }}
globalFutureMapRep() {{ return this.#globalFutureMapRep; }}
setGlobalFutureMapRep(rep) {{
this.#globalFutureMapRep = rep;
this.#readEnd.setGlobalFutureMapRep(rep);
this.#writeEnd.setGlobalFutureMapRep(rep);
}}
}}
"#
);
}
Self::FutureNew => {
let debug_log_fn = Intrinsic::DebugLog.name();
let future_new_fn = Self::FutureNew.name();
let current_task_get_fn =
Intrinsic::AsyncTask(AsyncTaskIntrinsic::GetCurrentTask).name();
let get_or_create_async_state_fn =
Intrinsic::Component(ComponentIntrinsic::GetOrCreateAsyncState).name();
uwriteln!(
output,
r#"
function {future_new_fn}(ctx) {{
{debug_log_fn}('[{future_new_fn}()] args', {{ ctx }});
const {{ componentIdx, futureTableIdx, elemMeta }} = ctx;
const taskMeta = {current_task_get_fn}(componentIdx);
if (!taskMeta) {{ throw new Error('invalid/missing async task meta'); }}
const task = taskMeta.task;
if (!task) {{ throw new Error('invalid/missing async task'); }}
const cstate = {get_or_create_async_state_fn}(componentIdx);
if (!cstate.mayLeave) {{ throw new Error('component instance is not marked as may leave'); }}
const {{ readEnd, writeEnd }} = cstate.createFuture({{
tableIdx: futureTableIdx,
elemMeta,
}});
let writeEndWaitableIdx = writeEnd.waitableIdx();
let readEndWaitableIdx = readEnd.waitableIdx();
return BigInt(writeEndWaitableIdx) << 32n | BigInt(readEndWaitableIdx);
}}
"#
);
}
Self::FutureNewFromLift => {
let debug_log_fn = Intrinsic::DebugLog.name();
let future_new_from_lift_fn = self.name();
let global_future_map =
Intrinsic::AsyncFuture(AsyncFutureIntrinsic::GlobalFutureMap).name();
let host_future_class =
Intrinsic::AsyncFuture(AsyncFutureIntrinsic::HostFutureClass).name();
output.push_str(&format!(
r#"
function {future_new_from_lift_fn}(ctx) {{
{debug_log_fn}('[{future_new_from_lift_fn}()] args', {{ ctx }});
const {{
componentIdx,
futureEndWaitableIdx,
futureTableIdx,
payloadLiftFn,
payloadTypeSize32,
payloadLowerFn,
}} = ctx;
const future = new {host_future_class}({{
componentIdx,
futureEndWaitableIdx,
futureTableIdx,
payloadLiftFn: payloadLiftFn,
payloadLowerFn: payloadLowerFn,
}});
const rep = {global_future_map}.insert(future);
future.setRep(rep);
return future.createUserFuture();
}}
"#
));
}
Self::FutureWrite | Self::FutureRead => {
let debug_log_fn = Intrinsic::DebugLog.name();
let get_or_create_async_state_fn =
Intrinsic::Component(ComponentIntrinsic::GetOrCreateAsyncState).name();
let current_task_get_fn =
Intrinsic::AsyncTask(AsyncTaskIntrinsic::GetCurrentTask).name();
let event_code_enum = Intrinsic::AsyncEventCodeEnum.name();
let async_blocked_const =
Intrinsic::AsyncTask(AsyncTaskIntrinsic::AsyncBlockedConstant).name();
let future_op_fn = self.name();
let (guest_op_fn, future_end_class) = match self {
Self::FutureWrite => ("guestWrite", Self::FutureWritableEndClass.name()),
Self::FutureRead => ("guestRead", Self::FutureReadableEndClass.name()),
_ => unreachable!(),
};
let future_end_base_class = Self::FutureEndClass.name();
let event_code = match self {
Self::FutureWrite => format!("{event_code_enum}.FUTURE_WRITE"),
Self::FutureRead => format!("{event_code_enum}.FUTURE_READ"),
_ => unreachable!(),
};
uwriteln!(
output,
r#"
async function {future_op_fn}(
ctx,
futureEndWaitableIdx,
ptr,
) {{
{debug_log_fn}('[{future_op_fn}()] args', {{
ctx,
futureEndWaitableIdx,
ptr,
}});
const {{
componentIdx,
futureTableIdx,
memoryIdx,
getMemoryFn,
reallocIdx,
getReallocFn,
stringEncoding,
isAsync,
}} = ctx;
const taskMeta = {current_task_get_fn}(componentIdx);
if (!taskMeta) {{ throw new Error('missing task metadata during future operation'); }}
const task = taskMeta.task;
if (!task) {{ throw new Error('missing task in metadata during future operation'); }}
const cstate = {get_or_create_async_state_fn}(componentIdx);
if (!cstate.mayLeave) {{ throw new Error('component instance is not marked as may leave'); }}
if (!task.mayBlock() && !isAsync) {{
throw new Error('only tasks that may block may call future.{future_op_fn}');
}}
const futureEnd = cstate.getFutureEnd({{ tableIdx: futureTableIdx, futureEndWaitableIdx }});
if (!futureEnd) {{
throw new Error(`missing future with waitable idx [${{futureEndWaitableIdx}}] (component [${{componentIdx}}])`);
}}
if (!(futureEnd instanceof {future_end_class})) {{
throw new Error('invalid future end, expected [{future_end_class}]');
}}
if (!futureEnd.isIdleState()) {{
throw new Error('future state must be idle before {future_op_fn}');
}}
await futureEnd.{guest_op_fn}({{
componentIdx,
stringEncoding,
memory: getMemoryFn(),
realloc: getReallocFn?.(),
getReallocFn,
ptr,
}});
if (!futureEnd.hasPendingEvent()) {{
if (isAsync) {{
futureEnd.setCopyState({future_end_base_class}.CopyState.ASYNC_COPYING);
return {async_blocked_const};
}} else {{
futureEnd.setCopyState({future_end_base_class}.CopyState.SYNC_COPYING);
await task.suspendUntil({{
readyFn: () => futureEnd.hasPendingEvent(),
}});
}}
}}
const {{ code, payload0: index, payload1: payload }} = futureEnd.getPendingEvent();
if (code !== {event_code}) {{
throw new Error(`mismatched event code [${{code}}] (expected {event_code})`);
}}
if (index !== futureEnd.waitableIdx()) {{ throw new Error('mismatched future end index'); }}
return payload;
}}
"#
);
}
Self::FutureCancelRead | Self::FutureCancelWrite => {
let debug_log_fn = Intrinsic::DebugLog.name();
let is_cancel_write = matches!(self, Self::FutureCancelWrite);
let future_end_class = if is_cancel_write {
Self::FutureWritableEndClass.name()
} else {
Self::FutureReadableEndClass.name()
};
let future_cancel_fn = self.name();
let get_or_create_async_state_fn =
Intrinsic::Component(ComponentIntrinsic::GetOrCreateAsyncState).name();
let async_blocked_const =
Intrinsic::AsyncTask(AsyncTaskIntrinsic::AsyncBlockedConstant).name();
let async_event_code_enum = Intrinsic::AsyncEventCodeEnum.name();
output.push_str(&format!(r#"
async function {future_cancel_fn}(
ctx,
futureEndIdx,
) {{
{debug_log_fn}('[{future_cancel_fn}()] args', {{
ctx,
futureEndWaitableIdx,
}});
const {{ componentIdx, futureTableIdx, isAsync }} = ctx;
const cstate = {get_or_create_async_state_fn}(componentIdx);
if (!cstate.mayLeave) {{ throw new Error('component instance is not marked as may leave'); }}
let futureEnd = cstate.getFutureEnd({{ tableIdx: futureTableIdx, futureEndWaitableIdx }});
if (!futureEnd) {{ throw new Error(`missing future end with idx [${{futureEndWaitableIdx}}]`); }}
if (!(futureEnd instanceof {future_end_class})) {{
throw new Error('invalid future end, expected value of type [{future_end_class}]');
}}
futureEnd = cstate.removeFutureEndFromTable({{
tableIdx: futureTableIdx,
futureWaitableIdx: futureEndWaitableIdx,
}});
if (!futureEnd) {{ throw new Error(`missing future with idx [${{futureEndWaitableIdx}}]`); }}
if (!futureEnd.isCopying()) {{ throw new Error('future end is not copying, cannot cancel'); }}
if (!futureEnd.hasPendingEvent()) {{
// TODO: cancel the shared thing (waitable?)
if (!futureEnd.hasPendingEvent()) {{
if (!isAsync) {{
// TODO: repalce with what task.blockOn used to do
// await task.blockOn({{ promise: futureEnd.waitable, isAsync: false }});
throw new Error('not implemented');
}} else {{
return {async_blocked_const};
}}
}}
}}
const {{ code, payload0: index, payload1: payload }} = futureEnd.getPendingEvent();
if (futureEnd.isCopying()) {{ throw new Error('future end is still in copying state'); }}
if (code !== {async_event_code_enum}) {{ throw new Error('unexpected event code [' + code + '], expected [' + {async_event_code_enum} + ']'); }}
if (index !== futureEndIdx) {{ throw new Error('index does not match future end'); }}
return payload;
}}
"#));
}
Self::FutureDropReadable | Self::FutureDropWritable => {
let debug_log_fn = Intrinsic::DebugLog.name();
let future_drop_fn = self.name();
let is_writable = matches!(self, Self::FutureDropWritable);
let future_end_class = if is_writable {
Self::FutureWritableEndClass.name()
} else {
Self::FutureReadableEndClass.name()
};
let get_or_create_async_state_fn =
Intrinsic::Component(ComponentIntrinsic::GetOrCreateAsyncState).name();
output.push_str(&format!(r#"
function {future_drop_fn}(ctx, futureEndWaitableIdx) {{
{debug_log_fn}('[{future_drop_fn}()] args', {{ ctx }});
const {{ componentIdx, futureTableIdx }} = ctx;
const cstate = {get_or_create_async_state_fn}(componentIdx);
if (!cstate.mayLeave) {{ throw new Error('component instance is not marked as may leave'); }}
const futureEnd = cstate.removeFutureEndFromTable({{
tableIdx: futureTableIdx,
futureWaitableIdx: futureEndWaitableIdx
}});
if (!(futureEnd instanceof {future_end_class})) {{
throw new Error('invalid future end, expected [{future_end_class}]');
}}
futureEnd.drop();
}}
"#));
}
Self::FutureTransfer => {
let debug_log_fn = Intrinsic::DebugLog.name();
let future_transfer_fn = self.name();
output.push_str(&format!(
r#"
function {future_transfer_fn}(ctx) {{
const params = [...arguments];
{debug_log_fn}('[{future_transfer_fn}()] args', {{
ctx,
params,
}});
}}
"#
));
}
Self::GenFutureHostInjectFn => {
let debug_log_fn = Intrinsic::DebugLog.name();
let gen_host_inject_fn = self.name();
let nested_future_symbol = Self::NestedFutureSymbol.name();
uwriteln!(
output,
r#"
function {gen_host_inject_fn}(genArgs) {{
const {{ promise, hostWriteEnd, stringEncoding, getReallocFn }} = genArgs;
let done;
return async function generateFutureHostInject(args) {{
let {{ count }} = args;
if (count !== 1) {{ throw new Error('invalid count'); }}
// Futures should only be completed once
if (done) {{
return () => {{ throw new Error('cannot inject write: future already completed'); }}
}}
// The host *must* write something to this channel before closing it
if (hostWriteEnd.isDoneState()) {{
return () => {{ throw new Error('cannot inject write: host must write to future before closing'); }}
}}
try {{
const value = await promise;
// If we've read a nested promise from the outside,
// we must convert the value that we get back into a future,
// because we are not at the lowest level yet.
if (value && typeof value === 'object' && value[{nested_future_symbol}]) {{
value = Promise.resolve(value);
}}
await hostWriteEnd.hostWrite({{ stringEncoding, value, getReallocFn }});
}} catch (err) {{
{debug_log_fn}("failed to inject host write", err);
throw new Error("cannot inject write: promise failed");
}}
hostWriteEnd.getPendingEvent();
hostWriteEnd.drop();
return () => {{
// After the write is finished, we consume the event that was generated
// by the just-in-time write (and the subsequent read), if one was generated
if (hostWriteEnd.hasPendingEvent()) {{ hostWriteEnd.getPendingEvent(); }}
}};
}};
}}
"#
);
}
Self::IsFutureLowerableObject => {
let is_future_lowerable_object = self.name();
output.push_str(&format!(
r#"
function {is_future_lowerable_object}(obj) {{
if (typeof obj !== 'object') {{ return false; }}
return obj instanceof Promise
|| 'then' in obj && typeof obj.then === 'function';
}}
"#
));
}
}
}
}