-
Notifications
You must be signed in to change notification settings - Fork 266
Expand file tree
/
Copy pathabi.rs
More file actions
2506 lines (2267 loc) · 97.3 KB
/
abi.rs
File metadata and controls
2506 lines (2267 loc) · 97.3 KB
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
use std::fmt;
use std::iter;
pub use wit_parser::abi::{AbiVariant, FlatTypes, WasmSignature, WasmType};
use wit_parser::{
align_to_arch, Alignment, ArchitectureSize, ElementInfo, Enum, Flags, FlagsRepr, Function,
Handle, Int, Record, Resolve, Result_, SizeAlign, Tuple, Type, TypeDefKind, TypeId, Variant,
};
// Helper macro for defining instructions without having to have tons of
// exhaustive `match` statements to update
macro_rules! def_instruction {
(
$( #[$enum_attr:meta] )*
pub enum $name:ident<'a> {
$(
$( #[$attr:meta] )*
$variant:ident $( {
$($field:ident : $field_ty:ty $(,)* )*
} )?
:
[$num_popped:expr] => [$num_pushed:expr],
)*
}
) => {
$( #[$enum_attr] )*
pub enum $name<'a> {
$(
$( #[$attr] )*
$variant $( {
$(
$field : $field_ty,
)*
} )? ,
)*
}
impl $name<'_> {
/// How many operands does this instruction pop from the stack?
#[allow(unused_variables)]
pub fn operands_len(&self) -> usize {
match self {
$(
Self::$variant $( {
$(
$field,
)*
} )? => $num_popped,
)*
}
}
/// How many results does this instruction push onto the stack?
#[allow(unused_variables)]
pub fn results_len(&self) -> usize {
match self {
$(
Self::$variant $( {
$(
$field,
)*
} )? => $num_pushed,
)*
}
}
}
};
}
def_instruction! {
#[derive(Debug)]
pub enum Instruction<'a> {
/// Acquires the specified parameter and places it on the stack.
/// Depending on the context this may refer to wasm parameters or
/// interface types parameters.
GetArg { nth: usize } : [0] => [1],
// Integer const/manipulation instructions
/// Pushes the constant `val` onto the stack.
I32Const { val: i32 } : [0] => [1],
/// Casts the top N items on the stack using the `Bitcast` enum
/// provided. Consumes the same number of operands that this produces.
Bitcasts { casts: &'a [Bitcast] } : [casts.len()] => [casts.len()],
/// Pushes a number of constant zeros for each wasm type on the stack.
ConstZero { tys: &'a [WasmType] } : [0] => [tys.len()],
// Memory load/store instructions
/// Pops a pointer from the stack and loads a little-endian `i32` from
/// it, using the specified constant offset.
I32Load { offset: ArchitectureSize } : [1] => [1],
/// Pops a pointer from the stack and loads a little-endian `i8` from
/// it, using the specified constant offset. The value loaded is the
/// zero-extended to 32-bits
I32Load8U { offset: ArchitectureSize } : [1] => [1],
/// Pops a pointer from the stack and loads a little-endian `i8` from
/// it, using the specified constant offset. The value loaded is the
/// sign-extended to 32-bits
I32Load8S { offset: ArchitectureSize } : [1] => [1],
/// Pops a pointer from the stack and loads a little-endian `i16` from
/// it, using the specified constant offset. The value loaded is the
/// zero-extended to 32-bits
I32Load16U { offset: ArchitectureSize } : [1] => [1],
/// Pops a pointer from the stack and loads a little-endian `i16` from
/// it, using the specified constant offset. The value loaded is the
/// sign-extended to 32-bits
I32Load16S { offset: ArchitectureSize } : [1] => [1],
/// Pops a pointer from the stack and loads a little-endian `i64` from
/// it, using the specified constant offset.
I64Load { offset: ArchitectureSize } : [1] => [1],
/// Pops a pointer from the stack and loads a little-endian `f32` from
/// it, using the specified constant offset.
F32Load { offset: ArchitectureSize } : [1] => [1],
/// Pops a pointer from the stack and loads a little-endian `f64` from
/// it, using the specified constant offset.
F64Load { offset: ArchitectureSize } : [1] => [1],
/// Like `I32Load` or `I64Load`, but for loading pointer values.
PointerLoad { offset: ArchitectureSize } : [1] => [1],
/// Like `I32Load` or `I64Load`, but for loading array length values.
LengthLoad { offset: ArchitectureSize } : [1] => [1],
/// Pops a pointer from the stack and then an `i32` value.
/// Stores the value in little-endian at the pointer specified plus the
/// constant `offset`.
I32Store { offset: ArchitectureSize } : [2] => [0],
/// Pops a pointer from the stack and then an `i32` value.
/// Stores the low 8 bits of the value in little-endian at the pointer
/// specified plus the constant `offset`.
I32Store8 { offset: ArchitectureSize } : [2] => [0],
/// Pops a pointer from the stack and then an `i32` value.
/// Stores the low 16 bits of the value in little-endian at the pointer
/// specified plus the constant `offset`.
I32Store16 { offset: ArchitectureSize } : [2] => [0],
/// Pops a pointer from the stack and then an `i64` value.
/// Stores the value in little-endian at the pointer specified plus the
/// constant `offset`.
I64Store { offset: ArchitectureSize } : [2] => [0],
/// Pops a pointer from the stack and then an `f32` value.
/// Stores the value in little-endian at the pointer specified plus the
/// constant `offset`.
F32Store { offset: ArchitectureSize } : [2] => [0],
/// Pops a pointer from the stack and then an `f64` value.
/// Stores the value in little-endian at the pointer specified plus the
/// constant `offset`.
F64Store { offset: ArchitectureSize } : [2] => [0],
/// Like `I32Store` or `I64Store`, but for storing pointer values.
PointerStore { offset: ArchitectureSize } : [2] => [0],
/// Like `I32Store` or `I64Store`, but for storing array length values.
LengthStore { offset: ArchitectureSize } : [2] => [0],
// Scalar lifting/lowering
/// Converts an interface type `char` value to a 32-bit integer
/// representing the unicode scalar value.
I32FromChar : [1] => [1],
/// Converts an interface type `u64` value to a wasm `i64`.
I64FromU64 : [1] => [1],
/// Converts an interface type `s64` value to a wasm `i64`.
I64FromS64 : [1] => [1],
/// Converts an interface type `u32` value to a wasm `i32`.
I32FromU32 : [1] => [1],
/// Converts an interface type `s32` value to a wasm `i32`.
I32FromS32 : [1] => [1],
/// Converts an interface type `u16` value to a wasm `i32`.
I32FromU16 : [1] => [1],
/// Converts an interface type `s16` value to a wasm `i32`.
I32FromS16 : [1] => [1],
/// Converts an interface type `u8` value to a wasm `i32`.
I32FromU8 : [1] => [1],
/// Converts an interface type `s8` value to a wasm `i32`.
I32FromS8 : [1] => [1],
/// Conversion an interface type `f32` value to a wasm `f32`.
///
/// This may be a noop for some implementations, but it's here in case the
/// native language representation of `f32` is different than the wasm
/// representation of `f32`.
CoreF32FromF32 : [1] => [1],
/// Conversion an interface type `f64` value to a wasm `f64`.
///
/// This may be a noop for some implementations, but it's here in case the
/// native language representation of `f64` is different than the wasm
/// representation of `f64`.
CoreF64FromF64 : [1] => [1],
/// Converts a native wasm `i32` to an interface type `s8`.
///
/// This will truncate the upper bits of the `i32`.
S8FromI32 : [1] => [1],
/// Converts a native wasm `i32` to an interface type `u8`.
///
/// This will truncate the upper bits of the `i32`.
U8FromI32 : [1] => [1],
/// Converts a native wasm `i32` to an interface type `s16`.
///
/// This will truncate the upper bits of the `i32`.
S16FromI32 : [1] => [1],
/// Converts a native wasm `i32` to an interface type `u16`.
///
/// This will truncate the upper bits of the `i32`.
U16FromI32 : [1] => [1],
/// Converts a native wasm `i32` to an interface type `s32`.
S32FromI32 : [1] => [1],
/// Converts a native wasm `i32` to an interface type `u32`.
U32FromI32 : [1] => [1],
/// Converts a native wasm `i64` to an interface type `s64`.
S64FromI64 : [1] => [1],
/// Converts a native wasm `i64` to an interface type `u64`.
U64FromI64 : [1] => [1],
/// Converts a native wasm `i32` to an interface type `char`.
///
/// It's safe to assume that the `i32` is indeed a valid unicode code point.
CharFromI32 : [1] => [1],
/// Converts a native wasm `f32` to an interface type `f32`.
F32FromCoreF32 : [1] => [1],
/// Converts a native wasm `f64` to an interface type `f64`.
F64FromCoreF64 : [1] => [1],
/// Creates a `bool` from an `i32` input, trapping if the `i32` isn't
/// zero or one.
BoolFromI32 : [1] => [1],
/// Creates an `i32` from a `bool` input, must return 0 or 1.
I32FromBool : [1] => [1],
// lists
/// Lowers a list where the element's layout in the native language is
/// expected to match the canonical ABI definition of interface types.
///
/// Pops a list value from the stack and pushes the pointer/length onto
/// the stack. If `realloc` is set to `Some` then this is expected to
/// *consume* the list which means that the data needs to be copied. An
/// allocation/copy is expected when:
///
/// * A host is calling a wasm export with a list (it needs to copy the
/// list in to the callee's module, allocating space with `realloc`)
/// * A wasm export is returning a list (it's expected to use `realloc`
/// to give ownership of the list to the caller.
/// * A host is returning a list in a import definition, meaning that
/// space needs to be allocated in the caller with `realloc`).
///
/// A copy does not happen (e.g. `realloc` is `None`) when:
///
/// * A wasm module calls an import with the list. In this situation
/// it's expected the caller will know how to access this module's
/// memory (e.g. the host has raw access or wasm-to-wasm communication
/// would copy the list).
///
/// If `realloc` is `Some` then the adapter is not responsible for
/// cleaning up this list because the other end is receiving the
/// allocation. If `realloc` is `None` then the adapter is responsible
/// for cleaning up any temporary allocation it created, if any.
ListCanonLower {
element: &'a Type,
realloc: Option<&'a str>,
} : [1] => [2],
/// Same as `ListCanonLower`, but used for strings
StringLower {
realloc: Option<&'a str>,
} : [1] => [2],
/// Lowers a list where the element's layout in the native language is
/// not expected to match the canonical ABI definition of interface
/// types.
///
/// Pops a list value from the stack and pushes the pointer/length onto
/// the stack. This operation also pops a block from the block stack
/// which is used as the iteration body of writing each element of the
/// list consumed.
///
/// The `realloc` field here behaves the same way as `ListCanonLower`.
/// It's only set to `None` when a wasm module calls a declared import.
/// Otherwise lowering in other contexts requires allocating memory for
/// the receiver to own.
ListLower {
element: &'a Type,
realloc: Option<&'a str>,
} : [1] => [2],
/// Lifts a list which has a canonical representation into an interface
/// types value.
///
/// The term "canonical" representation here means that the
/// representation of the interface types value in the native language
/// exactly matches the canonical ABI definition of the type.
///
/// This will consume two `i32` values from the stack, a pointer and a
/// length, and then produces an interface value list.
ListCanonLift {
element: &'a Type,
ty: TypeId,
} : [2] => [1],
/// Same as `ListCanonLift`, but used for strings
StringLift : [2] => [1],
/// Lifts a list which into an interface types value.
///
/// This will consume two `i32` values from the stack, a pointer and a
/// length, and then produces an interface value list.
///
/// This will also pop a block from the block stack which is how to
/// read each individual element from the list.
ListLift {
element: &'a Type,
ty: TypeId,
} : [2] => [1],
/// Pushes an operand onto the stack representing the list item from
/// each iteration of the list.
///
/// This is only used inside of blocks related to lowering lists.
IterElem { element: &'a Type } : [0] => [1],
/// Pushes an operand onto the stack representing the base pointer of
/// the next element in a list.
///
/// This is used for both lifting and lowering lists.
IterBasePointer : [0] => [1],
// records and tuples
/// Pops a record value off the stack, decomposes the record to all of
/// its fields, and then pushes the fields onto the stack.
RecordLower {
record: &'a Record,
name: &'a str,
ty: TypeId,
} : [1] => [record.fields.len()],
/// Pops all fields for a record off the stack and then composes them
/// into a record.
RecordLift {
record: &'a Record,
name: &'a str,
ty: TypeId,
} : [record.fields.len()] => [1],
/// Create an `i32` from a handle.
HandleLower {
handle: &'a Handle,
name: &'a str,
ty: TypeId,
} : [1] => [1],
/// Create a handle from an `i32`.
HandleLift {
handle: &'a Handle,
name: &'a str,
ty: TypeId,
} : [1] => [1],
/// Create an `i32` from a future.
FutureLower {
payload: &'a Option<Type>,
ty: TypeId,
} : [1] => [1],
/// Create a future from an `i32`.
FutureLift {
payload: &'a Option<Type>,
ty: TypeId,
} : [1] => [1],
/// Create an `i32` from a stream.
StreamLower {
payload: &'a Option<Type>,
ty: TypeId,
} : [1] => [1],
/// Create a stream from an `i32`.
StreamLift {
payload: &'a Option<Type>,
ty: TypeId,
} : [1] => [1],
/// Create an `i32` from an error-context.
ErrorContextLower : [1] => [1],
/// Create a error-context from an `i32`.
ErrorContextLift : [1] => [1],
/// Pops a tuple value off the stack, decomposes the tuple to all of
/// its fields, and then pushes the fields onto the stack.
TupleLower {
tuple: &'a Tuple,
ty: TypeId,
} : [1] => [tuple.types.len()],
/// Pops all fields for a tuple off the stack and then composes them
/// into a tuple.
TupleLift {
tuple: &'a Tuple,
ty: TypeId,
} : [tuple.types.len()] => [1],
/// Converts a language-specific record-of-bools to a list of `i32`.
FlagsLower {
flags: &'a Flags,
name: &'a str,
ty: TypeId,
} : [1] => [flags.repr().count()],
/// Converts a list of native wasm `i32` to a language-specific
/// record-of-bools.
FlagsLift {
flags: &'a Flags,
name: &'a str,
ty: TypeId,
} : [flags.repr().count()] => [1],
// variants
/// This is a special instruction used for `VariantLower`
/// instruction to determine the name of the payload, if present, to use
/// within each block.
///
/// Each sub-block will have this be the first instruction, and if it
/// lowers a payload it will expect something bound to this name.
VariantPayloadName : [0] => [1],
/// Pops a variant off the stack as well as `ty.cases.len()` blocks
/// from the code generator. Uses each of those blocks and the value
/// from the stack to produce `nresults` of items.
VariantLower {
variant: &'a Variant,
name: &'a str,
ty: TypeId,
results: &'a [WasmType],
} : [1] => [results.len()],
/// Pops an `i32` off the stack as well as `ty.cases.len()` blocks
/// from the code generator. Uses each of those blocks and the value
/// from the stack to produce a final variant.
VariantLift {
variant: &'a Variant,
name: &'a str,
ty: TypeId,
} : [1] => [1],
/// Pops an enum off the stack and pushes the `i32` representation.
EnumLower {
enum_: &'a Enum,
name: &'a str,
ty: TypeId,
} : [1] => [1],
/// Pops an `i32` off the stack and lifts it into the `enum` specified.
EnumLift {
enum_: &'a Enum,
name: &'a str,
ty: TypeId,
} : [1] => [1],
/// Specialization of `VariantLower` for specifically `option<T>` types,
/// otherwise behaves the same as `VariantLower` (e.g. two blocks for
/// the two cases.
OptionLower {
payload: &'a Type,
ty: TypeId,
results: &'a [WasmType],
} : [1] => [results.len()],
/// Specialization of `VariantLift` for specifically the `option<T>`
/// type. Otherwise behaves the same as the `VariantLift` instruction
/// with two blocks for the lift.
OptionLift {
payload: &'a Type,
ty: TypeId,
} : [1] => [1],
/// Specialization of `VariantLower` for specifically `result<T, E>`
/// types, otherwise behaves the same as `VariantLower` (e.g. two blocks
/// for the two cases.
ResultLower {
result: &'a Result_
ty: TypeId,
results: &'a [WasmType],
} : [1] => [results.len()],
/// Specialization of `VariantLift` for specifically the `result<T,
/// E>` type. Otherwise behaves the same as the `VariantLift`
/// instruction with two blocks for the lift.
ResultLift {
result: &'a Result_,
ty: TypeId,
} : [1] => [1],
// calling/control flow
/// Represents a call to a raw WebAssembly API. The module/name are
/// provided inline as well as the types if necessary.
CallWasm {
name: &'a str,
sig: &'a WasmSignature,
} : [sig.params.len()] => [sig.results.len()],
/// Same as `CallWasm`, except the dual where an interface is being
/// called rather than a raw wasm function.
///
/// Note that this will be used for async functions, and `async_`
/// indicates whether the function should be invoked in an async
/// fashion.
CallInterface {
func: &'a Function,
async_: bool,
} : [func.params.len()] => [usize::from(func.result.is_some())],
/// Returns `amt` values on the stack. This is always the last
/// instruction.
Return { amt: usize, func: &'a Function } : [*amt] => [0],
/// Calls the `realloc` function specified in a malloc-like fashion
/// allocating `size` bytes with alignment `align`.
///
/// Pushes the returned pointer onto the stack.
Malloc {
realloc: &'static str,
size: ArchitectureSize,
align: Alignment,
} : [0] => [1],
/// Used exclusively for guest-code generation this indicates that
/// the standard memory deallocation function needs to be invoked with
/// the specified parameters.
///
/// This will pop a pointer from the stack and push nothing.
GuestDeallocate {
size: ArchitectureSize,
align: Alignment,
} : [1] => [0],
/// Used exclusively for guest-code generation this indicates that
/// a string is being deallocated. The ptr/length are on the stack and
/// are poppped off and used to deallocate the string.
GuestDeallocateString : [2] => [0],
/// Used exclusively for guest-code generation this indicates that
/// a list is being deallocated. The ptr/length are on the stack and
/// are poppped off and used to deallocate the list.
///
/// This variant also pops a block off the block stack to be used as the
/// body of the deallocation loop.
GuestDeallocateList {
element: &'a Type,
} : [2] => [0],
/// Used exclusively for guest-code generation this indicates that
/// a variant is being deallocated. The integer discriminant is popped
/// off the stack as well as `blocks` number of blocks popped from the
/// blocks stack. The variant is used to select, at runtime, which of
/// the blocks is executed to deallocate the variant.
GuestDeallocateVariant {
blocks: usize,
} : [1] => [0],
/// Deallocates the language-specific handle representation on the top
/// of the stack. Used for async imports.
DropHandle { ty: &'a Type } : [1] => [0],
/// Call `task.return` for an async-lifted export.
///
/// This will call core wasm import `name` which will be mapped to
/// `task.return` later on. The function given has `params` as its
/// parameters and it will return no results. This is used to pass the
/// lowered representation of a function's results to `task.return`.
AsyncTaskReturn { name: &'a str, params: &'a [WasmType] } : [params.len()] => [0],
/// Force the evaluation of the specified number of expressions and push
/// the results to the stack.
///
/// This is useful prior to disposing of temporary variables and/or
/// allocations which are referenced by one or more not-yet-evaluated
/// expressions.
Flush { amt: usize } : [*amt] => [*amt],
}
}
#[derive(Debug, PartialEq)]
pub enum Bitcast {
// Upcasts
F32ToI32,
F64ToI64,
I32ToI64,
F32ToI64,
// Downcasts
I32ToF32,
I64ToF64,
I64ToI32,
I64ToF32,
// PointerOrI64 conversions. These preserve provenance when the source
// or destination is a pointer value.
//
// These are used when pointer values are being stored in
// (ToP64) and loaded out of (P64To) PointerOrI64 values, so they
// always have to preserve provenance when the value being loaded or
// stored is a pointer.
P64ToI64,
I64ToP64,
P64ToP,
PToP64,
// Pointer<->number conversions. These do not preserve provenance.
//
// These are used when integer or floating-point values are being stored in
// (I32ToP/etc.) and loaded out of (PToI32/etc.) pointer values, so they
// never have any provenance to preserve.
I32ToP,
PToI32,
PToL,
LToP,
// Number<->Number conversions.
I32ToL,
LToI32,
I64ToL,
LToI64,
// Multiple conversions in sequence.
Sequence(Box<[Bitcast; 2]>),
None,
}
/// Whether the glue code surrounding a call is lifting arguments and lowering
/// results or vice versa.
#[derive(Clone, Copy, PartialEq, Eq)]
pub enum LiftLower {
/// When the glue code lifts arguments and lowers results.
///
/// ```text
/// Wasm --lift-args--> SourceLanguage; call; SourceLanguage --lower-results--> Wasm
/// ```
LiftArgsLowerResults,
/// When the glue code lowers arguments and lifts results.
///
/// ```text
/// SourceLanguage --lower-args--> Wasm; call; Wasm --lift-results--> SourceLanguage
/// ```
LowerArgsLiftResults,
}
/// Trait for language implementors to use to generate glue code between native
/// WebAssembly signatures and interface types signatures.
///
/// This is used as an implementation detail in interpreting the ABI between
/// interface types and wasm types. Eventually this will be driven by interface
/// types adapters themselves, but for now the ABI of a function dictates what
/// instructions are fed in.
///
/// Types implementing `Bindgen` are incrementally fed `Instruction` values to
/// generate code for. Instructions operate like a stack machine where each
/// instruction has a list of inputs and a list of outputs (provided by the
/// `emit` function).
pub trait Bindgen {
/// The intermediate type for fragments of code for this type.
///
/// For most languages `String` is a suitable intermediate type.
type Operand: Clone + fmt::Debug;
/// Emit code to implement the given instruction.
///
/// Each operand is given in `operands` and can be popped off if ownership
/// is required. It's guaranteed that `operands` has the appropriate length
/// for the `inst` given, as specified with [`Instruction`].
///
/// Each result variable should be pushed onto `results`. This function must
/// push the appropriate number of results or binding generation will panic.
fn emit(
&mut self,
resolve: &Resolve,
inst: &Instruction<'_>,
operands: &mut Vec<Self::Operand>,
results: &mut Vec<Self::Operand>,
);
/// Gets a operand reference to the return pointer area.
///
/// The provided size and alignment is for the function's return type.
fn return_pointer(&mut self, size: ArchitectureSize, align: Alignment) -> Self::Operand;
/// Enters a new block of code to generate code for.
///
/// This is currently exclusively used for constructing variants. When a
/// variant is constructed a block here will be pushed for each case of a
/// variant, generating the code necessary to translate a variant case.
///
/// Blocks are completed with `finish_block` below. It's expected that `emit`
/// will always push code (if necessary) into the "current block", which is
/// updated by calling this method and `finish_block` below.
fn push_block(&mut self);
/// Indicates to the code generator that a block is completed, and the
/// `operand` specified was the resulting value of the block.
///
/// This method will be used to compute the value of each arm of lifting a
/// variant. The `operand` will be `None` if the variant case didn't
/// actually have any type associated with it. Otherwise it will be `Some`
/// as the last value remaining on the stack representing the value
/// associated with a variant's `case`.
///
/// It's expected that this will resume code generation in the previous
/// block before `push_block` was called. This must also save the results
/// of the current block internally for instructions like `ResultLift` to
/// use later.
fn finish_block(&mut self, operand: &mut Vec<Self::Operand>);
/// Returns size information that was previously calculated for all types.
fn sizes(&self) -> &SizeAlign;
/// Returns whether or not the specified element type is represented in a
/// "canonical" form for lists. This dictates whether the `ListCanonLower`
/// and `ListCanonLift` instructions are used or not.
fn is_list_canonical(&self, resolve: &Resolve, element: &Type) -> bool;
}
/// Generates an abstract sequence of instructions which represents this
/// function being adapted as an imported function.
///
/// The instructions here, when executed, will emulate a language with
/// interface types calling the concrete wasm implementation. The parameters
/// for the returned instruction sequence are the language's own
/// interface-types parameters. One instruction in the instruction stream
/// will be a `Call` which represents calling the actual raw wasm function
/// signature.
///
/// This function is useful, for example, if you're building a language
/// generator for WASI bindings. This will document how to translate
/// language-specific values into the wasm types to call a WASI function,
/// and it will also automatically convert the results of the WASI function
/// back to a language-specific value.
pub fn call(
resolve: &Resolve,
variant: AbiVariant,
lift_lower: LiftLower,
func: &Function,
bindgen: &mut impl Bindgen,
async_: bool,
) {
Generator::new(resolve, bindgen).call(func, variant, lift_lower, async_);
}
pub fn lower_to_memory<B: Bindgen>(
resolve: &Resolve,
bindgen: &mut B,
address: B::Operand,
value: B::Operand,
ty: &Type,
) {
let mut generator = Generator::new(resolve, bindgen);
// TODO: make this configurable? Right now this function is only called for
// future/stream callbacks so it's appropriate to skip realloc here as it's
// all "lower for wasm import", but this might get reused for something else
// in the future.
generator.realloc = Some(Realloc::Export("cabi_realloc"));
generator.stack.push(value);
generator.write_to_memory(ty, address, Default::default());
}
pub fn lower_flat<B: Bindgen>(
resolve: &Resolve,
bindgen: &mut B,
value: B::Operand,
ty: &Type,
) -> Vec<B::Operand> {
let mut generator = Generator::new(resolve, bindgen);
generator.stack.push(value);
generator.realloc = Some(Realloc::Export("cabi_realloc"));
generator.lower(ty);
generator.stack
}
pub fn lift_from_memory<B: Bindgen>(
resolve: &Resolve,
bindgen: &mut B,
address: B::Operand,
ty: &Type,
) -> B::Operand {
let mut generator = Generator::new(resolve, bindgen);
generator.read_from_memory(ty, address, Default::default());
generator.stack.pop().unwrap()
}
/// Used in a similar manner as the `Interface::call` function except is
/// used to generate the `post-return` callback for `func`.
///
/// This is only intended to be used in guest generators for exported
/// functions and will primarily generate `GuestDeallocate*` instructions,
/// plus others used as input to those instructions.
pub fn post_return(resolve: &Resolve, func: &Function, bindgen: &mut impl Bindgen) {
Generator::new(resolve, bindgen).post_return(func);
}
/// Returns whether the `Function` specified needs a post-return function to
/// be generated in guest code.
///
/// This is used when the return value contains a memory allocation such as
/// a list or a string primarily.
pub fn guest_export_needs_post_return(resolve: &Resolve, func: &Function) -> bool {
func.result
.map(|t| needs_deallocate(resolve, &t, Deallocate::Lists))
.unwrap_or(false)
}
fn needs_deallocate(resolve: &Resolve, ty: &Type, what: Deallocate) -> bool {
match ty {
Type::String => true,
Type::ErrorContext => true,
Type::Id(id) => match &resolve.types[*id].kind {
TypeDefKind::List(_) => true,
TypeDefKind::Type(t) => needs_deallocate(resolve, t, what),
TypeDefKind::Handle(Handle::Own(_)) => what.handles(),
TypeDefKind::Handle(Handle::Borrow(_)) => false,
TypeDefKind::Resource => false,
TypeDefKind::Record(r) => r
.fields
.iter()
.any(|f| needs_deallocate(resolve, &f.ty, what)),
TypeDefKind::Tuple(t) => t.types.iter().any(|t| needs_deallocate(resolve, t, what)),
TypeDefKind::Variant(t) => t
.cases
.iter()
.filter_map(|t| t.ty.as_ref())
.any(|t| needs_deallocate(resolve, t, what)),
TypeDefKind::Option(t) => needs_deallocate(resolve, t, what),
TypeDefKind::Result(t) => [&t.ok, &t.err]
.iter()
.filter_map(|t| t.as_ref())
.any(|t| needs_deallocate(resolve, t, what)),
TypeDefKind::Flags(_) | TypeDefKind::Enum(_) => false,
TypeDefKind::Future(_) | TypeDefKind::Stream(_) => what.handles(),
TypeDefKind::Unknown => unreachable!(),
TypeDefKind::FixedSizeList(..) => todo!(),
},
Type::Bool
| Type::U8
| Type::S8
| Type::U16
| Type::S16
| Type::U32
| Type::S32
| Type::U64
| Type::S64
| Type::F32
| Type::F64
| Type::Char => false,
}
}
/// Generate instructions in `bindgen` to deallocate all lists in `ptr` where
/// that's a pointer to a sequence of `types` stored in linear memory.
pub fn deallocate_lists_in_types<B: Bindgen>(
resolve: &Resolve,
types: &[Type],
operands: &[B::Operand],
indirect: bool,
bindgen: &mut B,
) {
Generator::new(resolve, bindgen).deallocate_in_types(
types,
operands,
indirect,
Deallocate::Lists,
);
}
/// Generate instructions in `bindgen` to deallocate all lists in `ptr` where
/// that's a pointer to a sequence of `types` stored in linear memory.
pub fn deallocate_lists_and_own_in_types<B: Bindgen>(
resolve: &Resolve,
types: &[Type],
operands: &[B::Operand],
indirect: bool,
bindgen: &mut B,
) {
Generator::new(resolve, bindgen).deallocate_in_types(
types,
operands,
indirect,
Deallocate::ListsAndOwn,
);
}
#[derive(Copy, Clone)]
pub enum Realloc {
None,
Export(&'static str),
}
/// What to deallocate in various `deallocate_*` methods.
#[derive(Copy, Clone)]
enum Deallocate {
/// Only deallocate lists.
Lists,
/// Deallocate lists and owned resources such as `own<T>` and
/// futures/streams.
ListsAndOwn,
}
impl Deallocate {
fn handles(&self) -> bool {
match self {
Deallocate::Lists => false,
Deallocate::ListsAndOwn => true,
}
}
}
struct Generator<'a, B: Bindgen> {
bindgen: &'a mut B,
resolve: &'a Resolve,
operands: Vec<B::Operand>,
results: Vec<B::Operand>,
stack: Vec<B::Operand>,
return_pointer: Option<B::Operand>,
realloc: Option<Realloc>,
}
const MAX_FLAT_PARAMS: usize = 16;
const MAX_FLAT_ASYNC_PARAMS: usize = 4;
impl<'a, B: Bindgen> Generator<'a, B> {
fn new(resolve: &'a Resolve, bindgen: &'a mut B) -> Generator<'a, B> {
Generator {
resolve,
bindgen,
operands: Vec::new(),
results: Vec::new(),
stack: Vec::new(),
return_pointer: None,
realloc: None,
}
}
fn call(&mut self, func: &Function, variant: AbiVariant, lift_lower: LiftLower, async_: bool) {
let sig = self.resolve.wasm_signature(variant, func);
// Lowering parameters calling a wasm import _or_ returning a result
// from an async-lifted wasm export means we don't need to pass
// ownership, but we pass ownership in all other cases.
let realloc = match (variant, lift_lower, async_) {
(AbiVariant::GuestImport, LiftLower::LowerArgsLiftResults, _)
| (
AbiVariant::GuestExport
| AbiVariant::GuestExportAsync
| AbiVariant::GuestExportAsyncStackful,
LiftLower::LiftArgsLowerResults,
true,
) => Realloc::None,
_ => Realloc::Export("cabi_realloc"),
};
assert!(self.realloc.is_none());
match lift_lower {
LiftLower::LowerArgsLiftResults => {
assert!(!async_, "generators should not be using this for async");
self.realloc = Some(realloc);
if let (AbiVariant::GuestExport, true) = (variant, async_) {
unimplemented!("host-side code generation for async lift/lower not supported");
}
let lower_to_memory = |self_: &mut Self, ptr: B::Operand| {
let mut offset = ArchitectureSize::default();
for (nth, (_, ty)) in func.params.iter().enumerate() {
self_.emit(&Instruction::GetArg { nth });
offset = align_to_arch(offset, self_.bindgen.sizes().align(ty));
self_.write_to_memory(ty, ptr.clone(), offset);
offset += self_.bindgen.sizes().size(ty);
}
self_.stack.push(ptr);
};
if !sig.indirect_params {
// If the parameters for this function aren't indirect
// (there aren't too many) then we simply do a normal lower
// operation for them all.
for (nth, (_, ty)) in func.params.iter().enumerate() {
self.emit(&Instruction::GetArg { nth });
self.lower(ty);
}
} else {
// ... otherwise if parameters are indirect space is
// allocated for them and each argument is lowered
// individually into memory.
let ElementInfo { size, align } = self
.bindgen
.sizes()
.record(func.params.iter().map(|t| &t.1));
let ptr = match variant {
// When a wasm module calls an import it will provide
// space that isn't explicitly deallocated.
AbiVariant::GuestImport => self.bindgen.return_pointer(size, align),
// When calling a wasm module from the outside, though,