witnext 0.10.0-beta3

witx parser for the witx-codegen webassembly code generator
Documentation
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
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
//! Definition of the ABI of witx functions
//!
//! This module is intended to assist with code generators which are binding or
//! implementing APIs defined by `*.witx` files. THis module contains all
//! details necessary to implement the actual ABI of these functions so wasm
//! modules and hosts can communicate with one another.
//!
//! Each interface types function (a function defined in `*.witx`) currently has
//! a well-known wasm signature associated with it. There's then also a standard
//! way to convert from interface-types values (whose representation is defined
//! per-language) into this wasm API. This module is intended to assist with
//! this definition.
//!
//! Contained within are two primary functions, [`Function::call_wasm`] and
//! [`Function::call_interface`]. These functions implement the two ways to
//! interact with an interface types function, namely calling the raw wasm
//! version and calling the high-level version with interface types. These two
//! functions are fed a structure that implements [`Bindgen`]. An instance of
//! [`Bindgen`] receives instructions which are low-level implementation details
//! of how to convert to and from wasm types and interface types. Code
//! generators will need to implement the various instructions to support APIs.

use crate::{
    Buffer, BuiltinType, Function, Id, IntRepr, NamedType, Param, RecordDatatype, Type, TypeRef,
    Variant,
};
use std::mem;

/// A raw WebAssembly signature with params and results.
#[derive(Debug)]
pub struct WasmSignature {
    /// The WebAssembly parameters of this function.
    pub params: Vec<WasmType>,
    /// The WebAssembly results of this function.
    pub results: Vec<WasmType>,
    /// The raw types, if needed, returned through return pointer located in
    /// `params`.
    pub retptr: Option<Vec<WasmType>>,
}

/// Enumerates wasm types used by interface types when lowering/lifting.
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum WasmType {
    I32,
    I64,
    F32,
    F64,
    // NOTE: we don't lower interface types to any other Wasm type,
    // e.g. externref, so we don't need to define them here.
}

impl From<IntRepr> for WasmType {
    fn from(i: IntRepr) -> WasmType {
        match i {
            IntRepr::U8 | IntRepr::U16 | IntRepr::U32 => WasmType::I32,
            IntRepr::U64 => WasmType::I64,
        }
    }
}

/// Possible ABIs for interface functions to have.
///
/// Note that this is a stopgap until we have more of interface types. Interface
/// types functions do not have ABIs, they have APIs. For the meantime, however,
/// we mandate ABIs to ensure we can all talk to each other.
#[derive(Debug, Copy, Clone, PartialEq, Eq, Hash)]
pub enum Abi {
    /// Only stable ABI currently, and is the historical WASI ABI since it was
    /// first created.
    ///
    /// Note that this ABI is limited notably in its return values where it can
    /// only return 0 results or one `Result<T, enum>` lookalike.
    Preview1,

    /// TODO
    Next,
}

// 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 an `i32` from the stack and loads a little-endian `i32` from
        /// it, using the specified constant offset.
        I32Load { offset: i32 } : [1] => [1],
        /// Pops an `i32` 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: i32 } : [1] => [1],
        /// Pops an `i32` 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: i32 } : [1] => [1],
        /// Pops an `i32` 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: i32 } : [1] => [1],
        /// Pops an `i32` 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: i32 } : [1] => [1],
        /// Pops an `i32` from the stack and loads a little-endian `i64` from
        /// it, using the specified constant offset.
        I64Load { offset: i32 } : [1] => [1],
        /// Pops an `i32` from the stack and loads a little-endian `f32` from
        /// it, using the specified constant offset.
        F32Load { offset: i32 } : [1] => [1],
        /// Pops an `i32` from the stack and loads a little-endian `f64` from
        /// it, using the specified constant offset.
        F64Load { offset: i32 } : [1] => [1],

        /// Pops an `i32` address from the stack and then an `i32` value.
        /// Stores the value in little-endian at the pointer specified plus the
        /// constant `offset`.
        I32Store { offset: i32 } : [2] => [0],
        /// Pops an `i32` address 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: i32 } : [2] => [0],
        /// Pops an `i32` address 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: i32 } : [2] => [0],
        /// Pops an `i32` address from the stack and then an `i64` value.
        /// Stores the value in little-endian at the pointer specified plus the
        /// constant `offset`.
        I64Store { offset: i32 } : [2] => [0],
        /// Pops an `i32` address from the stack and then an `f32` value.
        /// Stores the value in little-endian at the pointer specified plus the
        /// constant `offset`.
        F32Store { offset: i32 } : [2] => [0],
        /// Pops an `i32` address from the stack and then an `f64` value.
        /// Stores the value in little-endian at the pointer specified plus the
        /// constant `offset`.
        F64Store { offset: i32 } : [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],
        /// Converts a language-specific `usize` value to a wasm `i32`.
        I32FromUsize : [1] => [1],
        /// Converts a language-specific C `char` value to a wasm `i32`.
        I32FromChar8 : [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`.
        F32FromIf32 : [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`.
        F64FromIf64 : [1] => [1],

        /// Converts a core wasm `i32` to an interface type `s8`.
        ///
        /// This will truncate the upper bits of the `i32`.
        S8FromI32 : [1] => [1],
        /// Converts a core wasm `i32` to an interface type `u8`.
        ///
        /// This will truncate the upper bits of the `i32`.
        U8FromI32 : [1] => [1],
        /// Converts a core wasm `i32` to an interface type `s16`.
        ///
        /// This will truncate the upper bits of the `i32`.
        S16FromI32 : [1] => [1],
        /// Converts a core wasm `i32` to an interface type `u16`.
        ///
        /// This will truncate the upper bits of the `i32`.
        U16FromI32 : [1] => [1],
        /// Converts a core wasm `i32` to an interface type `s32`.
        S32FromI32 : [1] => [1],
        /// Converts a core wasm `i32` to an interface type `u32`.
        U32FromI32 : [1] => [1],
        /// Converts a core wasm `i64` to an interface type `s64`.
        S64FromI64 : [1] => [1],
        /// Converts a core wasm `i64` to an interface type `u64`.
        U64FromI64 : [1] => [1],
        /// Converts a core 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 core wasm `f32` to an interface type `f32`.
        If32FromF32 : [1] => [1],
        /// Converts a core wasm `f64` to an interface type `f64`.
        If64FromF64 : [1] => [1],
        /// Converts a core wasm `i32` to a language-specific C `char`.
        ///
        /// This will truncate the upper bits of the `i32`.
        Char8FromI32 : [1] => [1],
        /// Converts a core wasm `i32` to a language-specific `usize`.
        UsizeFromI32 : [1] => [1],

        // Handles

        /// Converts a "borrowed" handle into a wasm `i32` value.
        ///
        /// A "borrowed" handle in this case means one where ownership is not
        /// being relinquished. This is only used for lowering interface types
        /// parameters.
        ///
        /// Situations that this is used are:
        ///
        /// * A wasm exported function receives, as a parameter, handles defined
        ///   by the wasm module itself. This is effectively proof of ownership
        ///   by an external caller (be it host or wasm module) and the
        ///   ownership of the handle still lies with the caller. The wasm
        ///   module is only receiving a reference to the resource.
        ///
        /// * A wasm module is calling an import with a handle defined by the
        ///   import's module. Sort of the converse of the previous case this
        ///   means that the wasm module is handing out a reference to a
        ///   resource that it owns. The type in the wasm module, for example,
        ///   needs to reflect this.
        ///
        /// This instruction is not used for return values in either
        /// export/import positions.
        I32FromBorrowedHandle { ty: &'a NamedType } : [1] => [1],

        /// Converts an "owned" handle into a wasm `i32` value.
        ///
        /// This conversion is used for handle values which are crossing a
        /// module boundary for perhaps the first time. Some example cases of
        /// when this conversion is used are:
        ///
        /// * When a host defines a function to be imported, returned handles
        ///   use this instruction. Handles being returned to wasm a granting a
        ///   capability, which means that this new capability is typically
        ///   wrapped up in a new integer descriptor.
        ///
        /// * When a wasm module calls an imported function with a type defined
        ///   by itself, then it's granting a capability to the callee. This
        ///   means that the wasm module's type is being granted for the first
        ///   time, possibly, so it needs to be an owned value that's consumed.
        ///   Note that this doesn't actually happen with `*.witx` today due to
        ///   the lack of handle type imports.
        ///
        /// * When a wasm module export returns a handle defined within the
        ///   module, then it's similar to calling an imported function with
        ///   that handle. The capability is being granted to the caller of the
        ///   export, so the owned value is wrapped up in an `i32`.
        ///
        /// * When a host is calling a wasm module with a capability defined by
        ///   the host, its' similar to the host import returning a capability.
        ///   This would be granting the wasm module with the capability so an
        ///   owned version with a fresh handle is passed to the wasm module.
        ///   Note that this doesn't happen today with `*.witx` due to the lack
        ///   of handle type imports.
        ///
        /// Basically this instruction is used for handle->wasm conversions
        /// depending on the calling context and where the handle type in
        /// question was defined.
        I32FromOwnedHandle { ty: &'a NamedType } : [1] => [1],

        /// Converts a core wasm `i32` into an owned handle value.
        ///
        /// This is the converse of `I32FromOwnedHandle` and is used in similar
        /// situations:
        ///
        /// * A host definition of an import receives a handle defined in the
        ///   module itself.
        /// * A wasm module calling an import receives a handle defined by the
        ///   import.
        /// * A wasm module's export receives a handle defined by an external
        ///   module.
        /// * A host calling a wasm export receives a handle defined in the
        ///   module.
        ///
        /// Note that like `I32FromOwnedHandle` the first and third bullets
        /// above don't happen today because witx can't express type imports
        /// just yet.
        HandleOwnedFromI32 { ty: &'a NamedType } : [1] => [1],

        /// Converts a core wasm `i32` into a borrowedhandle value.
        ///
        /// This is the converse of `I32FromBorrowedHandle` and is used in similar
        /// situations:
        ///
        /// * An exported wasm function receives, as a parameter, a handle that
        ///   is defined by the wasm module.
        /// * An host-defined imported function is receiving a handle, as a
        ///   parameter, that is defined by the host itself.
        HandleBorrowedFromI32 { ty: &'a NamedType } : [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 `malloc` 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 `malloc`)
        /// * A wasm export is returning a list (it's expected to use `malloc`
        ///   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 `malloc`).
        ///
        /// A copy does not happen (e.g. `malloc` 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 `malloc` is `Some` then the adapter is not responsible for
        /// cleaning up this list because the other end is receiving the
        /// allocation. If `malloc` is `None` then the adapter is responsible
        /// for cleaning up any temporary allocation it created, if any.
        ListCanonLower {
            element: &'a TypeRef,
            malloc: 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 `malloc` 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 TypeRef,
            malloc: 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. If the `free`
        /// field is set to `Some` then the pointer/length should be considered
        /// an owned allocation and need to be deallocated by the receiver. If
        /// it is set to `None` then a view is provided but it does not need to
        /// be deallocated.
        ///
        /// The `free` field is set to `Some` in similar situations as described
        /// by `ListCanonLower`. If `free` is `Some` then the memory must be
        /// deallocated after the lifted list is done being consumed. If it is
        /// `None` then the receiver of the lifted list does not own the memory
        /// and must leave the memory as-is.
        ListCanonLift {
            element: &'a TypeRef,
            free: Option<&'a str>,
        } : [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. Note that the
        /// pointer/length popped are **owned** and need to be deallocated with
        /// the wasm `free` function when the list is no longer needed.
        ///
        /// This will also pop a block from the block stack which is how to
        /// read each individual element from the list.
        ListLift {
            element: &'a TypeRef,
            free: Option<&'a str>,
        } : [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 : [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],

        // buffers

        /// Pops a buffer value, pushes the pointer/length of where it points
        /// to in memory.
        BufferLowerPtrLen { buffer: &'a Buffer } : [1] => [2],
        /// Pops a buffer value, pushes an integer handle for the buffer.
        BufferLowerHandle { buffer: &'a Buffer } : [1] => [1],
        /// Pops a ptr/len, pushes a buffer wrapping that ptr/len of the memory
        /// from the origin module.
        BufferLiftPtrLen { buffer: &'a Buffer } : [2] => [1],
        /// Pops an i32, pushes a buffer wrapping that i32 handle.
        BufferLiftHandle { buffer: &'a Buffer } : [1] => [1],

        // records

        /// Pops a record value off the stack, decomposes the record to all of
        /// its fields, and then pushes the fields onto the stack.
        RecordLower {
            ty: &'a RecordDatatype,
            name: Option<&'a NamedType>,
        } : [1] => [ty.members.len()],

        /// Pops all fields for a record off the stack and then composes them
        /// into a record.
        RecordLift {
            ty: &'a RecordDatatype,
            name: Option<&'a NamedType>,
        } : [ty.members.len()] => [1],

        /// Converts a language-specific record-of-bools to the packed
        /// representation as an `i32`.
        I32FromBitflags {
            ty: &'a RecordDatatype,
            name: &'a NamedType,
        } : [1] => [1],
        /// Converts a language-specific record-of-bools to the packed
        /// representation as an `i64`.
        I64FromBitflags {
            ty: &'a RecordDatatype,
            name: &'a NamedType,
        } : [1] => [1],
        /// Converts a core wasm `i32` to a language-specific record-of-bools.
        BitflagsFromI32 {
            repr: IntRepr,
            ty: &'a RecordDatatype,
            name: &'a NamedType,
        } : [1] => [1],
        /// Converts a core wasm `i64` to a language-specific record-of-bools.
        BitflagsFromI64 {
            repr: IntRepr,
            ty: &'a RecordDatatype,
            name: &'a NamedType,
        } : [1] => [1],

        // variants

        /// This is a special instruction used at the entry of blocks used as
        /// part of `ResultLower`, representing that the payload of that variant
        /// being matched on should be pushed onto the stack.
        VariantPayload : [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 {
            ty: &'a Variant,
            name: Option<&'a NamedType>,
            nresults: usize,
        } : [1] => [*nresults],

        /// 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 {
            ty: &'a Variant,
            name: Option<&'a NamedType>,
        } : [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 {
            module: &'a str,
            name: &'a str,
            params: &'a [WasmType],
            results: &'a [WasmType],
        } : [params.len()] => [results.len()],

        /// Same as `CallWasm`, except the dual where an interface is being
        /// called rather than a raw wasm function.
        CallInterface {
            module: &'a str,
            func: &'a Function,
        } : [func.params.len()] => [func.results.len()],

        /// Returns `amt` values on the stack. This is always the last
        /// instruction.
        Return { amt: usize } : [*amt] => [0],

        // ...

        /// An instruction from an extended instruction set that's specific to
        /// `*.witx` and the "Preview1" ABI.
        Witx {
            instr: &'a WitxInstruction<'a>,
        } : [instr.operands_len()] => [instr.results_len()],
    }
}

#[derive(Debug, PartialEq)]
pub enum Bitcast {
    // Upcasts
    F32ToF64,
    F32ToI32,
    F64ToI64,
    I32ToI64,
    F32ToI64,

    // Downcasts
    F64ToF32,
    I32ToF32,
    I64ToF64,
    I64ToI32,
    I64ToF32,

    None,
}

def_instruction! {
    #[derive(Debug)]
    pub enum WitxInstruction<'a> {
        /// Takes the value off the top of the stack and writes it into linear
        /// memory. Pushes the address in linear memory as an `i32`.
        AddrOf : [1] => [1],

        /// Converts a language-specific pointer value to a wasm `i32`.
        I32FromPointer : [1] => [1],
        /// Converts a language-specific pointer value to a wasm `i32`.
        I32FromConstPointer : [1] => [1],
        /// Converts a core wasm `i32` to a language-specific pointer.
        PointerFromI32 { ty: &'a TypeRef }: [1] => [1],
        /// Converts a core wasm `i32` to a language-specific pointer.
        ConstPointerFromI32 { ty: &'a TypeRef } : [1] => [1],

        /// This is a special instruction specifically for the original ABI of
        /// WASI.  The raw return `i32` of a function is re-pushed onto the
        /// stack for reuse.
        ReuseReturn : [0] => [1],
    }
}

impl Abi {
    /// Validates the parameters/results are representable in this ABI.
    ///
    /// Returns an error string if they're not representable or returns `Ok` if
    /// they're indeed representable.
    pub fn validate(&self, params: &[Param], results: &[Param]) -> Result<(), String> {
        for ty in params.iter() {
            self.validate_ty(ty.tref.type_(), true)?;
        }
        for ty in results.iter() {
            self.validate_ty(ty.tref.type_(), false)?;
        }
        match self {
            Abi::Preview1 => {
                // validated below...
            }
            Abi::Next => return Ok(()),
        }
        assert_eq!(*self, Abi::Preview1);
        match results.len() {
            0 => {}
            1 => match &**results[0].tref.type_() {
                Type::Handle(_) | Type::Builtin(_) | Type::ConstPointer(_) | Type::Pointer(_) => {}
                Type::Variant(v) => {
                    let (ok, err) = match v.as_expected() {
                        Some(pair) => pair,
                        None => return Err("invalid return type".to_string()),
                    };
                    if let Some(ty) = ok {
                        match &**ty.type_() {
                            Type::Record(r) if r.is_tuple() => {
                                for member in r.members.iter() {
                                    if !member.tref.named() {
                                        return Err(
                                            "only named types are allowed in results".to_string()
                                        );
                                    }
                                }
                            }
                            _ => {
                                if !ty.named() {
                                    return Err(
                                        "only named types are allowed in results".to_string()
                                    );
                                }
                            }
                        }
                    }
                    if let Some(ty) = err {
                        if !ty.named() {
                            return Err("only named types are allowed in results".to_string());
                        }
                        if let Type::Variant(v) = &**ty.type_() {
                            if v.is_enum() {
                                return Ok(());
                            }
                        }
                    }
                }
                Type::Record(r) if r.bitflags_repr().is_some() => {}
                Type::Record(_) | Type::List(_) | Type::Buffer(_) => {
                    return Err("invalid return type".to_string())
                }
            },
            _ => return Err("more than one result".to_string()),
        }
        Ok(())
    }

    fn validate_ty(&self, ty: &Type, param: bool) -> Result<(), String> {
        match ty {
            Type::Record(r) => {
                for r in r.members.iter() {
                    self.validate_ty(r.tref.type_(), param)?;
                }
                Ok(())
            }
            Type::Variant(v) => {
                for case in v.cases.iter() {
                    if let Some(ty) = &case.tref {
                        self.validate_ty(ty.type_(), param)?;
                    }
                }
                Ok(())
            }
            Type::Handle(_) => Ok(()),
            Type::List(t) => self.validate_ty(t.type_(), param),
            Type::Pointer(t) => {
                if let Abi::Next = self {
                    return Err("cannot use `(@witx pointer)` in this ABI".to_string());
                }
                self.validate_ty(t.type_(), param)
            }
            Type::ConstPointer(t) => {
                if let Abi::Next = self {
                    return Err("cannot use `(@witx const_pointer)` in this ABI".to_string());
                }
                self.validate_ty(t.type_(), param)
            }
            Type::Builtin(BuiltinType::U8 { lang_c_char: true }) => {
                if let Abi::Next = self {
                    return Err("cannot use `(@witx char8)` in this ABI".to_string());
                }
                Ok(())
            }
            Type::Builtin(BuiltinType::U32 {
                lang_ptr_size: true,
            }) => {
                if let Abi::Next = self {
                    return Err("cannot use `(@witx usize)` in this ABI".to_string());
                }
                Ok(())
            }
            Type::Buffer(t) => {
                if !param {
                    return Err("cannot use buffers in the result position".to_string());
                }
                // If this is an output buffer then validate `t` as if it were a
                // result because the callee can't give us buffers back.
                self.validate_ty(t.tref.type_(), param && !t.out)
            }
            Type::Builtin(_) => Ok(()),
        }
    }
}

/// 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;

    /// 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,
        inst: &Instruction<'_>,
        operands: &mut Vec<Self::Operand>,
        results: &mut Vec<Self::Operand>,
    );

    /// Allocates temporary space in linear memory for the type `ty`.
    ///
    /// This is called when calling some wasm functions where a return pointer
    /// is needed. Only used for the `Abi::Preview1` ABI.
    ///
    /// Returns an `Operand` which has type `i32` and is the base of the typed
    /// allocation in memory.
    fn allocate_typed_space(&mut self, ty: &NamedType) -> Self::Operand;

    /// Allocates temporary space in linear memory for a fixed number of `i64`
    /// values.
    ///
    /// This is only called in the `Abi::Next` ABI for when a function would
    /// otherwise have multiple results.
    ///
    /// Returns an `Operand` which has type `i32` and points to the base of the
    /// fixed-size-array allocation.
    fn allocate_i64_array(&mut self, amt: usize) -> 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>);
}

impl Function {
    /// Get the WebAssembly type signature for this interface function
    ///
    /// The first entry returned is the list of parameters and the second entry
    /// is the list of results for the wasm function signature.
    pub fn wasm_signature(&self, mode: CallMode) -> WasmSignature {
        let mut params = Vec::new();
        let mut results = Vec::new();
        for param in self.params.iter() {
            match &**param.tref.type_() {
                Type::Builtin(_)
                | Type::Pointer(_)
                | Type::ConstPointer(_)
                | Type::Handle(_)
                | Type::List(_)
                | Type::Buffer(_) => {
                    push_wasm(mode, param.tref.type_(), &mut params);
                }
                ty @ Type::Variant(_) => match self.abi {
                    Abi::Preview1 => params.push(WasmType::I32),
                    Abi::Next => push_wasm(mode, ty, &mut params),
                },
                Type::Record(r) => match self.abi {
                    Abi::Preview1 => match r.bitflags_repr() {
                        Some(repr) => params.push(WasmType::from(repr)),
                        None => params.push(WasmType::I32),
                    },
                    Abi::Next => push_wasm(mode, param.tref.type_(), &mut params),
                },
            }
        }

        for param in self.results.iter() {
            match &**param.tref.type_() {
                Type::List(_)
                | Type::Builtin(_)
                | Type::Pointer(_)
                | Type::ConstPointer(_)
                | Type::Record(_)
                | Type::Handle(_)
                | Type::Buffer(_) => {
                    push_wasm(mode, param.tref.type_(), &mut results);
                }

                Type::Variant(v) => {
                    match self.abi {
                        Abi::Preview1 => {} // handled below
                        Abi::Next => {
                            push_wasm(mode, param.tref.type_(), &mut results);
                            continue;
                        }
                    }
                    results.push(match v.tag_repr {
                        IntRepr::U64 => WasmType::I64,
                        IntRepr::U32 | IntRepr::U16 | IntRepr::U8 => WasmType::I32,
                    });
                    if v.is_enum() {
                        continue;
                    }
                    // return pointer
                    if let Some(ty) = &v.cases[0].tref {
                        match &**ty.type_() {
                            Type::Record(r) if r.is_tuple() => {
                                for _ in 0..r.members.len() {
                                    params.push(WasmType::I32);
                                }
                            }
                            _ => params.push(WasmType::I32),
                        }
                    }
                }
            }
        }

        // Rust/C don't support multi-value well right now, so if a function
        // would have multiple results then instead truncate it to have 0
        // results and instead insert a return pointer.
        let mut retptr = None;
        if results.len() > 1 {
            params.push(WasmType::I32);
            retptr = Some(mem::take(&mut results));
        }

        WasmSignature {
            params,
            results,
            retptr,
        }
    }

    /// 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(&self, module: &Id, mode: CallMode, bindgen: &mut impl Bindgen) {
        if Abi::Preview1 == self.abi {
            match mode {
                // The Preview1 ABI only works with WASI which is only intended
                // for use with these modes.
                CallMode::DefinedImport | CallMode::DeclaredImport => {}
                _ => {
                    panic!("the preview1 ABI only supports import modes");
                }
            }
        }
        Generator::new(self.abi, mode, bindgen).call(module, self);
    }
}

/// Modes of calling a WebAssembly or host function.
///
/// Each mode may have a slightly different codegen for some types, so
/// [`Function::call`] takes this as a parameter to know in what context
/// the invocation is happening within.
#[derive(Copy, Clone, Debug, PartialEq)]
pub enum CallMode {
    /// A defined export is being called.
    ///
    /// This typically means that a code generator is generating a shim function
    /// to get exported from a WebAssembly module and the shim is calling a
    /// native language function defined within the wasm module. In this mode
    /// arguments are being lifted from wasm types to interface types, and
    /// results are being lowered.
    DefinedExport,

    /// A declared export is being called.
    ///
    /// This typically means that a code generator is generating calls to a
    /// WebAssembly module, for example a JS host calling a WebAssembly
    /// instance. In this mode the native language's arguments are being lowered
    /// to wasm values and the results of the function are lifted back into the
    /// native language.
    DeclaredExport,

    /// A defined import is being called.
    ///
    /// This is typically used for code generators that are creating bindings in
    /// a host for a function imported by WebAssembly. In this mode a function
    /// with a wasm signature is generated and that function's wasm arguments
    /// are lifted into the native language's arguments. The results are then
    /// lowered back into wasm arguments to return.
    DefinedImport,

    /// A declared import is being called
    ///
    /// This is typically used for code generators that are calling an imported
    /// function from within a wasm module. In this mode native language
    /// arguments are lowered to wasm values, and the results of the import are
    /// lifted back into the native language.
    DeclaredImport,
}

impl CallMode {
    pub fn export(&self) -> bool {
        match self {
            CallMode::DefinedExport | CallMode::DeclaredExport => true,
            CallMode::DefinedImport | CallMode::DeclaredImport => false,
        }
    }

    pub fn defined(&self) -> bool {
        match self {
            CallMode::DefinedExport | CallMode::DefinedImport => true,
            CallMode::DeclaredExport | CallMode::DeclaredImport => false,
        }
    }
}

struct Generator<'a, B: Bindgen> {
    abi: Abi,
    mode: CallMode,
    bindgen: &'a mut B,
    operands: Vec<B::Operand>,
    results: Vec<B::Operand>,
    stack: Vec<B::Operand>,
    return_pointers: Vec<B::Operand>,
}

impl<'a, B: Bindgen> Generator<'a, B> {
    fn new(abi: Abi, mode: CallMode, bindgen: &'a mut B) -> Generator<'a, B> {
        Generator {
            abi,
            mode,
            bindgen,
            operands: Vec::new(),
            results: Vec::new(),
            stack: Vec::new(),
            return_pointers: Vec::new(),
        }
    }

    fn call(&mut self, module: &Id, func: &Function) {
        let sig = func.wasm_signature(self.mode);

        match self.mode {
            CallMode::DeclaredExport | CallMode::DeclaredImport => {
                // Push all parameters for this function onto the stack, and
                // then batch-lower everything all at once.
                for nth in 0..func.params.len() {
                    self.emit(&Instruction::GetArg { nth });
                }
                self.lower_all(&func.params, None);

                // If necessary we may need to prepare a return pointer for this
                // ABI. The `Preview1` ABI has most return values returned
                // through pointers, and the `Next` ABI returns more-than-one
                // values through a return pointer.
                self.prep_return_pointer(&sig, &func.results);

                // Now that all the wasm args are prepared we can call the
                // actual wasm function.
                assert_eq!(self.stack.len(), sig.params.len());
                self.emit(&Instruction::CallWasm {
                    module: module.as_str(),
                    name: func.name.as_str(),
                    params: &sig.params,
                    results: &sig.results,
                });

                // In the `Next` ABI we model multiple return values by going
                // through memory. Remove that indirection here by loading
                // everything to simulate the function having many return values
                // in our stack discipline.
                if let Some(actual) = &sig.retptr {
                    self.load_retptr(actual);
                }

                // Batch-lift all result values now that all the function's return
                // values are on the stack.
                self.lift_all(&func.results);

                self.emit(&Instruction::Return {
                    amt: func.results.len(),
                });
            }

            CallMode::DefinedExport | CallMode::DefinedImport => {
                // Use `GetArg` to push all relevant arguments onto the stack.
                // Note that we can't use the signature of this function
                // directly due to various conversions and return pointers, so
                // we need to somewhat manually calculate all the arguments
                // which are converted as interface types arguments below.
                let sig = func.wasm_signature(self.mode);
                let nargs = match self.abi {
                    Abi::Preview1 => {
                        func.params.len()
                            + func
                                .params
                                .iter()
                                .filter(|t| match &**t.tref.type_() {
                                    Type::List(_) => true,
                                    _ => false,
                                })
                                .count()
                    }
                    Abi::Next => sig.params.len() - sig.retptr.is_some() as usize,
                };
                for nth in 0..nargs {
                    self.emit(&Instruction::GetArg { nth });
                }

                // Once everything is on the stack we can lift all arguments
                // one-by-one into their interface-types equivalent.
                self.lift_all(&func.params);

                // ... and that allows us to call the interface types function
                self.emit(&Instruction::CallInterface {
                    module: module.as_str(),
                    func,
                });

                // ... and at the end we lower everything back into return
                // values.
                self.lower_all(&func.results, Some(nargs));

                // Our ABI dictates that a list of returned types are returned
                // through memories, so after we've got all the values on the
                // stack perform all of the stores here.
                if let Some(tys) = &sig.retptr {
                    self.store_retptr(tys, sig.params.len() - 1);
                }

                self.emit(&Instruction::Return {
                    amt: sig.results.len(),
                });
            }
        }

        assert!(
            self.stack.is_empty(),
            "stack has {} items remaining",
            self.stack.len()
        );
    }

    fn load_retptr(&mut self, types: &[WasmType]) {
        assert_eq!(self.return_pointers.len(), 1);
        for (i, ty) in types.iter().enumerate() {
            self.stack.push(self.return_pointers[0].clone());
            let offset = (i * 8) as i32;
            match ty {
                WasmType::I32 => self.emit(&Instruction::I32Load { offset }),
                WasmType::I64 => self.emit(&Instruction::I64Load { offset }),
                WasmType::F32 => self.emit(&Instruction::F32Load { offset }),
                WasmType::F64 => self.emit(&Instruction::F64Load { offset }),
            }
        }
    }

    /// Assumes that the wasm values to create `tys` are all located on the
    /// stack.
    ///
    /// Inserts instructions necesesary to lift those types into their
    /// interface types equivalent.
    fn lift_all(&mut self, tys: &[Param]) {
        let mut temp = Vec::new();
        let operands = tys
            .iter()
            .rev()
            .map(|ty| {
                let ntys = match self.abi {
                    Abi::Preview1 => match &**ty.tref.type_() {
                        Type::List(_) => 2,
                        _ => 1,
                    },
                    Abi::Next => {
                        temp.truncate(0);
                        push_wasm(self.mode, ty.tref.type_(), &mut temp);
                        temp.len()
                    }
                };
                self.stack
                    .drain(self.stack.len() - ntys..)
                    .collect::<Vec<_>>()
            })
            .collect::<Vec<_>>();
        for (operands, ty) in operands.into_iter().rev().zip(tys) {
            self.stack.extend(operands);
            self.lift(&ty.tref);
        }
    }

    /// Assumes that the value for `tys` is already on the stack, and then
    /// converts all of those values into their wasm types by lowering each
    /// argument in-order.
    fn lower_all(&mut self, tys: &[Param], mut nargs: Option<usize>) {
        let operands = self
            .stack
            .drain(self.stack.len() - tys.len()..)
            .collect::<Vec<_>>();
        for (operand, ty) in operands.into_iter().zip(tys) {
            self.stack.push(operand);
            self.lower(&ty.tref, nargs.as_mut());
        }
    }

    /// Assumes `types.len()` values are on the stack and stores them all into
    /// the return pointer of this function, specified in the last argument.
    ///
    /// This is only used with `Abi::Next`.
    fn store_retptr(&mut self, types: &[WasmType], retptr_arg: usize) {
        self.emit(&Instruction::GetArg { nth: retptr_arg });
        let retptr = self.stack.pop().unwrap();
        for (i, ty) in types.iter().enumerate().rev() {
            self.stack.push(retptr.clone());
            let offset = (i * 8) as i32;
            match ty {
                WasmType::I32 => self.emit(&Instruction::I32Store { offset }),
                WasmType::I64 => self.emit(&Instruction::I64Store { offset }),
                WasmType::F32 => self.emit(&Instruction::F32Store { offset }),
                WasmType::F64 => self.emit(&Instruction::F64Store { offset }),
            }
        }
    }

    fn witx(&mut self, instr: &WitxInstruction<'_>) {
        self.emit(&Instruction::Witx { instr });
    }

    fn emit(&mut self, inst: &Instruction<'_>) {
        self.operands.clear();
        self.results.clear();

        let operands_len = inst.operands_len();
        assert!(
            self.stack.len() >= operands_len,
            "not enough operands on stack for {:?}",
            inst
        );
        self.operands
            .extend(self.stack.drain((self.stack.len() - operands_len)..));
        self.results.reserve(inst.results_len());

        self.bindgen
            .emit(inst, &mut self.operands, &mut self.results);

        assert_eq!(
            self.results.len(),
            inst.results_len(),
            "{:?} expected {} results, got {}",
            inst,
            inst.results_len(),
            self.results.len()
        );
        self.stack.extend(self.results.drain(..));
    }

    fn push_block(&mut self) {
        self.bindgen.push_block();
    }

    fn finish_block(&mut self, size: usize) {
        self.operands.clear();
        assert!(
            size <= self.stack.len(),
            "not enough operands on stack for finishing block",
        );
        self.operands
            .extend(self.stack.drain((self.stack.len() - size)..));
        self.bindgen.finish_block(&mut self.operands);
    }

    fn lower(&mut self, ty: &TypeRef, retptr: Option<&mut usize>) {
        use Instruction::*;
        use WitxInstruction::*;

        match &**ty.type_() {
            Type::Builtin(BuiltinType::S8) => self.emit(&I32FromS8),
            Type::Builtin(BuiltinType::U8 { lang_c_char: true }) => self.emit(&I32FromChar8),
            Type::Builtin(BuiltinType::U8 { lang_c_char: false }) => self.emit(&I32FromU8),
            Type::Builtin(BuiltinType::S16) => self.emit(&I32FromS16),
            Type::Builtin(BuiltinType::U16) => self.emit(&I32FromU16),
            Type::Builtin(BuiltinType::S32) => self.emit(&I32FromS32),
            Type::Builtin(BuiltinType::U32 {
                lang_ptr_size: true,
            }) => self.emit(&I32FromUsize),
            Type::Builtin(BuiltinType::U32 {
                lang_ptr_size: false,
            }) => self.emit(&I32FromU32),
            Type::Builtin(BuiltinType::S64) => self.emit(&I64FromS64),
            Type::Builtin(BuiltinType::U64) => self.emit(&I64FromU64),
            Type::Builtin(BuiltinType::Char) => self.emit(&I32FromChar),
            Type::Builtin(BuiltinType::F32) => self.emit(&F32FromIf32),
            Type::Builtin(BuiltinType::F64) => self.emit(&F64FromIf64),
            Type::Pointer(_) => self.witx(&I32FromPointer),
            Type::ConstPointer(_) => self.witx(&I32FromConstPointer),
            Type::Handle(_) => {
                let ty = ty.name().unwrap();
                let borrowed = match self.mode {
                    // There's one of three possible situations we're in:
                    //
                    // * The handle is defined by the wasm module itself. This
                    //   is the only actual possible scenario today due to how
                    //   witx is defined. In this situation the handle is owned
                    //   by the host and "proof of ownership" is being offered
                    //   and there's no need to relinquish ownership.
                    //
                    // * The handle is defined by the host, and it's passing it
                    //   to a wasm module. This should use an owned conversion.
                    //   This isn't expressible in today's `*.witx` format.
                    //
                    // * The handle is defined by neither the host or the wasm
                    //   mdoule. This means that the host is passing a
                    //   capability from another wasm module into this one,
                    //   meaning it's doing so by reference since the host is
                    //   retaining access to its own
                    //
                    // Note, again, only the first bullet here is possible
                    // today, hence the hardcoded `true` value. We'll need to
                    // refactor `witx` to expose the other possibilities.
                    CallMode::DeclaredExport => true,

                    // Like above there's one of three possibilities. This means
                    // a wasm module is calling an imported function with a
                    // handle, and the handle is owned by either the wasm
                    // module, the imported function we're calling, or neither.
                    //
                    // An owned value is only used when the wasm module passes
                    // its own handle to the import. Otherwise a borrowed value
                    // is always used because the wasm module retains ownership
                    // of the original handle since it's a reference to
                    // something owned elsewhere.
                    //
                    // Today the only expressible case is that an imported
                    // function receives a handle that it itself defined, so
                    // it's always borrowed.
                    CallMode::DeclaredImport => true,

                    // This means that a return value is being lowered, which is
                    // never borrowed.
                    CallMode::DefinedExport | CallMode::DefinedImport => false,
                };
                if borrowed {
                    self.emit(&I32FromBorrowedHandle { ty });
                } else {
                    self.emit(&I32FromOwnedHandle { ty });
                }
            }
            Type::List(element) => match self.abi {
                Abi::Preview1 => self.emit(&ListCanonLower {
                    element,
                    malloc: None,
                }),
                Abi::Next => {
                    // Lowering parameters calling a declared import means we
                    // don't need to pass ownership, but we pass ownership in
                    // all other cases.
                    let malloc = match self.mode {
                        CallMode::DeclaredImport => None,
                        _ => Some("witx_malloc"),
                    };
                    if element.type_().all_bits_valid() || is_char(element) {
                        self.emit(&ListCanonLower { element, malloc });
                    } else {
                        self.push_block();
                        self.emit(&IterElem);
                        self.emit(&IterBasePointer);
                        let addr = self.stack.pop().unwrap();
                        self.write_to_memory(element, addr, 0);
                        self.finish_block(0);
                        self.emit(&ListLower { element, malloc });
                    }
                }
            },
            Type::Buffer(buffer) => {
                self.translate_buffer(buffer);
                match self.mode {
                    // When calling an imported function we're passing a raw view
                    // into memory, and the adapter will convert it into something
                    // else if necessary.
                    CallMode::DeclaredImport => self.emit(&BufferLowerPtrLen { buffer }),

                    // When calling an exported function we're passing a handle to
                    // the caller's memory, and this part of the adapter is
                    // responsible for converting it into something that's a handle.
                    CallMode::DeclaredExport => self.emit(&BufferLowerHandle { buffer }),

                    // Buffers are only used in the parameter position, which means
                    // lowering a buffer should never happen in these contexts.
                    CallMode::DefinedImport | CallMode::DefinedExport => unreachable!(),
                }
            }
            Type::Record(r) => {
                if let Some(repr) = r.bitflags_repr() {
                    let name = ty.name().unwrap();
                    match repr {
                        IntRepr::U64 => return self.emit(&I64FromBitflags { ty: r, name }),
                        _ => return self.emit(&I32FromBitflags { ty: r, name }),
                    }
                }
                match self.abi {
                    Abi::Preview1 => self.witx(&AddrOf),
                    Abi::Next => {
                        self.emit(&RecordLower {
                            ty: r,
                            name: ty.name(),
                        });
                        let fields = self
                            .stack
                            .drain(self.stack.len() - r.members.len()..)
                            .collect::<Vec<_>>();
                        for (member, field) in r.members.iter().zip(fields) {
                            self.stack.push(field);
                            self.lower(&member.tref, None);
                        }
                    }
                }
            }

            // Variants in the return position of an import must be a Result in
            // the preview1 ABI and they're a bit special about where all the
            // pieces are.
            Type::Variant(v)
                if self.abi == Abi::Preview1
                    && self.mode == CallMode::DefinedImport
                    && !v.is_enum() =>
            {
                let retptr = retptr.unwrap();
                let (ok, err) = v.as_expected().unwrap();
                self.push_block();
                if let Some(ok) = ok {
                    self.emit(&VariantPayload);
                    let store = |me: &mut Self, ty: &TypeRef, n| {
                        me.emit(&GetArg { nth: *retptr + n });
                        let addr = me.stack.pop().unwrap();
                        me.write_to_memory(ty, addr, 0);
                    };
                    match &**ok.type_() {
                        Type::Record(r) if r.is_tuple() => {
                            self.emit(&RecordLower {
                                ty: r,
                                name: ty.name(),
                            });
                            // Note that `rev()` is used here due to the order
                            // that tuples are pushed onto the stack and how we
                            // consume the last item first from the stack.
                            for (i, member) in r.members.iter().enumerate().rev() {
                                store(self, &member.tref, i);
                            }
                        }
                        _ => store(self, ok, 0),
                    }
                };
                self.emit(&I32Const { val: 0 });
                self.finish_block(1);

                self.push_block();
                if let Some(ty) = err {
                    self.emit(&VariantPayload);
                    self.lower(ty, None);
                }
                self.finish_block(1);

                self.emit(&VariantLower {
                    ty: v,
                    name: ty.name(),
                    nresults: 1,
                });
            }

            // Variant arguments in the Preview1 ABI are all passed by pointer
            Type::Variant(v)
                if self.abi == Abi::Preview1
                    && self.mode == CallMode::DeclaredImport
                    && !v.is_enum() =>
            {
                self.witx(&AddrOf)
            }

            Type::Variant(v) => {
                let mut results = Vec::new();
                let mut temp = Vec::new();
                let mut casts = Vec::new();
                push_wasm(self.mode, ty.type_(), &mut results);
                for (i, case) in v.cases.iter().enumerate() {
                    self.push_block();
                    self.emit(&I32Const { val: i as i32 });
                    let mut pushed = 1;
                    if let Some(ty) = &case.tref {
                        // Using the payload of this block we lower the type to
                        // raw wasm values.
                        self.emit(&VariantPayload);
                        self.lower(ty, None);

                        // Determine the types of all the wasm values we just
                        // pushed, and record how many. If we pushed too few
                        // then we'll need to push some zeros after this.
                        temp.truncate(0);
                        push_wasm(self.mode, ty.type_(), &mut temp);
                        pushed += temp.len();

                        // For all the types pushed we may need to insert some
                        // bitcasts. This will go through and cast everything
                        // to the right type to ensure all blocks produce the
                        // same set of results.
                        casts.truncate(0);
                        for (actual, expected) in temp.iter().zip(&results[1..]) {
                            casts.push(cast(*actual, *expected));
                        }
                        if casts.iter().any(|c| *c != Bitcast::None) {
                            self.emit(&Bitcasts { casts: &casts });
                        }
                    }

                    // If we haven't pushed enough items in this block to match
                    // what other variants are pushing then we need to push
                    // some zeros.
                    if pushed < results.len() {
                        self.emit(&ConstZero {
                            tys: &results[pushed..],
                        });
                    }
                    self.finish_block(results.len());
                }
                self.emit(&VariantLower {
                    ty: v,
                    nresults: results.len(),
                    name: ty.name(),
                });
            }
        }
    }

    fn prep_return_pointer(&mut self, sig: &WasmSignature, results: &[Param]) {
        match self.abi {
            Abi::Preview1 => {
                assert!(results.len() < 2);
                let ty = match results.get(0) {
                    Some(ty) => ty.tref.type_(),
                    None => return,
                };
                // Return pointers are only needed for `Result<T, _>`...
                let variant = match &**ty {
                    Type::Variant(v) => v,
                    _ => return,
                };
                // ... and only if `T` is actually present in `Result<T, _>`
                let ok = match &variant.cases[0].tref {
                    Some(t) => t,
                    None => return,
                };

                // Tuples have each individual item in a separate return pointer while
                // all other types go through a singular return pointer.
                let mut prep = |ty: &TypeRef| {
                    let ptr = self.bindgen.allocate_typed_space(ty.name().unwrap());
                    self.return_pointers.push(ptr.clone());
                    self.stack.push(ptr);
                };
                match &**ok.type_() {
                    Type::Record(r) if r.is_tuple() => {
                        for member in r.members.iter() {
                            prep(&member.tref);
                        }
                    }
                    _ => prep(ok),
                }
            }
            // If a return pointer was automatically injected into this function
            // then we need to allocate a proper amount of space for it and then
            // add it to the stack to get passed to the callee.
            Abi::Next => {
                if let Some(results) = &sig.retptr {
                    let ptr = self.bindgen.allocate_i64_array(results.len());
                    self.return_pointers.push(ptr.clone());
                    self.stack.push(ptr.clone());
                }
            }
        }
    }

    // Note that in general everything in this function is the opposite of the
    // `lower` function above. This is intentional and should be kept this way!
    fn lift(&mut self, ty: &TypeRef) {
        use Instruction::*;
        use WitxInstruction::*;

        match &**ty.type_() {
            Type::Builtin(BuiltinType::S8) => self.emit(&S8FromI32),
            Type::Builtin(BuiltinType::U8 { lang_c_char: true }) => self.emit(&Char8FromI32),
            Type::Builtin(BuiltinType::U8 { lang_c_char: false }) => self.emit(&U8FromI32),
            Type::Builtin(BuiltinType::S16) => self.emit(&S16FromI32),
            Type::Builtin(BuiltinType::U16) => self.emit(&U16FromI32),
            Type::Builtin(BuiltinType::S32) => self.emit(&S32FromI32),
            Type::Builtin(BuiltinType::U32 {
                lang_ptr_size: true,
            }) => self.emit(&UsizeFromI32),
            Type::Builtin(BuiltinType::U32 {
                lang_ptr_size: false,
            }) => self.emit(&U32FromI32),
            Type::Builtin(BuiltinType::S64) => self.emit(&S64FromI64),
            Type::Builtin(BuiltinType::U64) => self.emit(&U64FromI64),
            Type::Builtin(BuiltinType::Char) => self.emit(&CharFromI32),
            Type::Builtin(BuiltinType::F32) => self.emit(&If32FromF32),
            Type::Builtin(BuiltinType::F64) => self.emit(&If64FromF64),
            Type::Pointer(ty) => self.witx(&PointerFromI32 { ty }),
            Type::ConstPointer(ty) => self.witx(&ConstPointerFromI32 { ty }),
            Type::Handle(_) => {
                let ty = ty.name().unwrap();
                // For more information on these values see the comments in
                // `lower` above.
                let borrowed = match self.mode {
                    CallMode::DefinedExport | CallMode::DefinedImport => true,
                    CallMode::DeclaredExport | CallMode::DeclaredImport => false,
                };
                if borrowed {
                    self.emit(&HandleBorrowedFromI32 { ty });
                } else {
                    self.emit(&HandleOwnedFromI32 { ty });
                }
            }
            Type::List(element) => match self.abi {
                Abi::Preview1 => self.emit(&ListCanonLift {
                    element,
                    free: None,
                }),
                Abi::Next => {
                    // Lifting the arguments of a defined import means that, if
                    // possible, the caller still retains ownership and we don't
                    // free anything.
                    let free = match self.mode {
                        CallMode::DefinedImport => None,
                        _ => Some("witx_free"),
                    };
                    if element.type_().all_bits_valid() || is_char(element) {
                        self.emit(&ListCanonLift { element, free });
                    } else {
                        self.push_block();
                        self.emit(&IterBasePointer);
                        let addr = self.stack.pop().unwrap();
                        self.read_from_memory(element, addr, 0);
                        self.finish_block(1);
                        self.emit(&ListLift { element, free });
                    }
                }
            },
            Type::Buffer(buffer) => {
                self.translate_buffer(buffer);
                match self.mode {
                    // When calling a defined imported function then we're coming
                    // from a pointer/length, and the embedding context will figure
                    // out what to do with that pointer/length.
                    CallMode::DefinedImport => self.emit(&BufferLiftPtrLen { buffer }),

                    // When calling an exported function we're given a handle to the
                    // buffer, which is then interpreted in the calling context.
                    CallMode::DefinedExport => self.emit(&BufferLiftHandle { buffer }),

                    // Buffers are only used in the parameter position, which means
                    // lifting a buffer should never happen in these contexts.
                    CallMode::DeclaredImport | CallMode::DeclaredExport => unreachable!(),
                }
            }
            Type::Record(r) => {
                if let Some(repr) = r.bitflags_repr() {
                    let name = ty.name().unwrap();
                    match repr {
                        IntRepr::U64 => return self.emit(&BitflagsFromI64 { repr, ty: r, name }),
                        _ => return self.emit(&BitflagsFromI32 { repr, ty: r, name }),
                    }
                }
                match self.abi {
                    Abi::Preview1 => {
                        let addr = self.stack.pop().unwrap();
                        self.read_from_memory(ty, addr, 0);
                    }
                    Abi::Next => {
                        let mut temp = Vec::new();
                        push_wasm(self.mode, ty.type_(), &mut temp);
                        let mut args = self
                            .stack
                            .drain(self.stack.len() - temp.len()..)
                            .collect::<Vec<_>>();
                        for member in r.members.iter() {
                            temp.truncate(0);
                            push_wasm(self.mode, member.tref.type_(), &mut temp);
                            self.stack.extend(args.drain(..temp.len()));
                            self.lift(&member.tref);
                        }
                        self.emit(&RecordLift {
                            ty: r,
                            name: ty.name(),
                        });
                    }
                }
            }

            // Variants in the return position of an import must be a Result in
            // the preview1 ABI and they're a bit special about where all the
            // pieces are.
            Type::Variant(v)
                if self.abi == Abi::Preview1
                    && self.mode == CallMode::DeclaredImport
                    && !v.is_enum() =>
            {
                let (ok, err) = v.as_expected().unwrap();
                self.push_block();
                if let Some(ok) = ok {
                    let mut n = 0;
                    let mut load = |ty: &TypeRef| {
                        self.read_from_memory(ty, self.return_pointers[n].clone(), 0);
                        n += 1;
                    };
                    match &**ok.type_() {
                        Type::Record(r) if r.is_tuple() => {
                            for member in r.members.iter() {
                                load(&member.tref);
                            }
                            self.emit(&RecordLift {
                                ty: r,
                                name: ok.name(),
                            });
                        }
                        _ => load(ok),
                    }
                }
                self.finish_block(ok.is_some() as usize);

                self.push_block();
                if let Some(ty) = err {
                    self.witx(&ReuseReturn);
                    self.lift(ty);
                }
                self.finish_block(err.is_some() as usize);

                self.emit(&VariantLift {
                    ty: v,
                    name: ty.name(),
                });
            }

            // Variant arguments in the Preview1 ABI are all passed by pointer,
            // so we read them here.
            Type::Variant(v)
                if self.abi == Abi::Preview1
                    && self.mode == CallMode::DefinedImport
                    && !v.is_enum() =>
            {
                let addr = self.stack.pop().unwrap();
                self.read_from_memory(ty, addr, 0)
            }

            Type::Variant(v) => {
                let mut params = Vec::new();
                let mut temp = Vec::new();
                let mut casts = Vec::new();
                push_wasm(self.mode, ty.type_(), &mut params);
                let block_inputs = self
                    .stack
                    .drain(self.stack.len() + 1 - params.len()..)
                    .collect::<Vec<_>>();
                for case in v.cases.iter() {
                    self.push_block();
                    if let Some(ty) = &case.tref {
                        // Push only the values we need for this variant onto
                        // the stack.
                        temp.truncate(0);
                        push_wasm(self.mode, ty.type_(), &mut temp);
                        self.stack
                            .extend(block_inputs[..temp.len()].iter().cloned());

                        // Cast all the types we have on the stack to the actual
                        // types needed for this variant, if necessary.
                        casts.truncate(0);
                        for (actual, expected) in temp.iter().zip(&params[1..]) {
                            casts.push(cast(*expected, *actual));
                        }
                        if casts.iter().any(|c| *c != Bitcast::None) {
                            self.emit(&Bitcasts { casts: &casts });
                        }

                        // Then recursively lift this variant's payload.
                        self.lift(ty);
                    }
                    self.finish_block(case.tref.is_some() as usize);
                }
                self.emit(&VariantLift {
                    ty: v,
                    name: ty.name(),
                });
            }
        }
    }

    fn write_to_memory(&mut self, ty: &TypeRef, addr: B::Operand, offset: i32) {
        use Instruction::*;

        match &**ty.type_() {
            // Builtin types need different flavors of storage instructions
            // depending on the size of the value written.
            Type::Builtin(b) => {
                self.lower(ty, None);
                self.stack.push(addr);
                match b {
                    BuiltinType::S8 | BuiltinType::U8 { .. } => self.emit(&I32Store8 { offset }),
                    BuiltinType::S16 | BuiltinType::U16 => self.emit(&I32Store16 { offset }),
                    BuiltinType::S32 | BuiltinType::U32 { .. } | BuiltinType::Char => {
                        self.emit(&I32Store { offset })
                    }
                    BuiltinType::S64 | BuiltinType::U64 => self.emit(&I64Store { offset }),
                    BuiltinType::F32 => self.emit(&F32Store { offset }),
                    BuiltinType::F64 => self.emit(&F64Store { offset }),
                }
            }

            // Lowering all these types produces an `i32` which we can easily
            // store into memory.
            Type::Pointer(_) | Type::ConstPointer(_) | Type::Handle(_) => {
                self.lower(ty, None);
                self.stack.push(addr);
                self.emit(&I32Store { offset })
            }

            // After lowering the list there's two i32 values on the stack
            // which we write into memory, writing the pointer into the low address
            // and the length into the high address.
            Type::List(_) => {
                self.lower(ty, None);
                self.stack.push(addr.clone());
                self.emit(&I32Store { offset: offset + 4 });
                self.stack.push(addr);
                self.emit(&I32Store { offset });
            }

            // Lower the buffer to its raw values, and then write the values
            // into memory, which may be more than one value depending on our
            // call mode.
            Type::Buffer(_) => {
                self.lower(ty, None);
                if let CallMode::DeclaredImport = self.mode {
                    self.stack.push(addr.clone());
                    self.emit(&I32Store { offset: offset + 4 });
                }
                self.stack.push(addr);
                self.emit(&I32Store { offset });
            }

            Type::Record(r) => match r.bitflags_repr() {
                // Bitflags just have their appropriate width written into
                // memory.
                Some(repr) => {
                    let name = ty.name().unwrap();
                    self.emit(&match repr {
                        IntRepr::U64 => I64FromBitflags { ty: r, name },
                        _ => I32FromBitflags { ty: r, name },
                    });
                    self.stack.push(addr);
                    self.store_intrepr(offset, repr);
                }

                // Decompose the record into its components and then write all
                // the components into memory one-by-one.
                None => {
                    self.emit(&RecordLower {
                        ty: r,
                        name: ty.name(),
                    });
                    let fields = self
                        .stack
                        .drain(self.stack.len() - r.members.len()..)
                        .collect::<Vec<_>>();
                    for (layout, field) in r.member_layout(self.mode.export()).iter().zip(fields) {
                        self.stack.push(field);
                        self.write_to_memory(
                            &layout.member.tref,
                            addr.clone(),
                            offset + (layout.offset as i32),
                        );
                    }
                }
            },

            // Each case will get its own block, and the first item in each
            // case is writing the discriminant. After that if we have a
            // payload we write the payload after the discriminant, aligned up
            // to the type's alignment.
            Type::Variant(v) => {
                let payload_offset = offset + (v.payload_offset(self.mode.export()) as i32);
                for (i, case) in v.cases.iter().enumerate() {
                    self.push_block();
                    self.emit(&I32Const { val: i as i32 });
                    self.stack.push(addr.clone());
                    self.store_intrepr(offset, v.tag_repr);
                    if let Some(ty) = &case.tref {
                        self.emit(&VariantPayload);
                        self.write_to_memory(ty, addr.clone(), payload_offset);
                    }
                    self.finish_block(0);
                }
                self.emit(&VariantLower {
                    ty: v,
                    nresults: 0,
                    name: ty.name(),
                });
            }
        }
    }

    fn read_from_memory(&mut self, ty: &TypeRef, addr: B::Operand, offset: i32) {
        use Instruction::*;

        match &**ty.type_() {
            // Builtin types need different flavors of load instructions
            // depending on the size of the value written, but then they're all
            // lifted the same way.
            Type::Builtin(b) => {
                self.stack.push(addr);
                match b {
                    BuiltinType::S8 => self.emit(&I32Load8S { offset }),
                    BuiltinType::U8 { .. } => self.emit(&I32Load8U { offset }),
                    BuiltinType::S16 => self.emit(&I32Load16S { offset }),
                    BuiltinType::U16 => self.emit(&I32Load16U { offset }),
                    BuiltinType::S32 | BuiltinType::U32 { .. } | BuiltinType::Char => {
                        self.emit(&I32Load { offset })
                    }
                    BuiltinType::S64 | BuiltinType::U64 => self.emit(&I64Load { offset }),
                    BuiltinType::F32 => self.emit(&F32Load { offset }),
                    BuiltinType::F64 => self.emit(&F64Load { offset }),
                }
                self.lift(ty);
            }

            // These types are all easily lifted from an `i32`
            Type::Pointer(_) | Type::ConstPointer(_) | Type::Handle(_) => {
                self.stack.push(addr);
                self.emit(&I32Load { offset });
                self.lift(ty);
            }

            // Read the pointer/len and then perform the standard lifting
            // proceses.
            Type::List(_) => {
                self.stack.push(addr.clone());
                self.emit(&I32Load { offset });
                self.stack.push(addr);
                self.emit(&I32Load { offset: offset + 4 });
                self.lift(ty);
            }

            // Read the requisite number of values from memory and then lift as
            // appropriate.
            Type::Buffer(_) => {
                self.stack.push(addr.clone());
                self.emit(&I32Load { offset });
                if let CallMode::DefinedImport = self.mode {
                    self.stack.push(addr);
                    self.emit(&I32Load { offset: offset + 4 });
                }
                self.lift(ty);
            }

            Type::Record(r) => match r.bitflags_repr() {
                // Bitflags just have their appropriate size read from
                // memory.
                Some(repr) => {
                    let name = ty.name().unwrap();
                    self.stack.push(addr);
                    self.load_intrepr(offset, repr);
                    self.emit(&match repr {
                        IntRepr::U64 => BitflagsFromI64 { repr, ty: r, name },
                        _ => BitflagsFromI32 { repr, ty: r, name },
                    });
                }
                // Read and lift each field individually, adjusting the offset
                // as we go along, then aggregate all the fields into the
                // record.
                None => {
                    for layout in r.member_layout(self.mode.export()) {
                        self.read_from_memory(
                            &layout.member.tref,
                            addr.clone(),
                            offset + (layout.offset as i32),
                        );
                    }
                    self.emit(&RecordLift {
                        ty: r,
                        name: ty.name(),
                    });
                }
            },

            // Each case will get its own block, and we'll dispatch to the
            // right block based on the `i32.load` we initially perform. Each
            // individual block is pretty simple and just reads the payload type
            // from the corresponding offset if one is available.
            Type::Variant(v) => {
                self.stack.push(addr.clone());
                self.load_intrepr(offset, v.tag_repr);
                let payload_offset = offset + (v.payload_offset(self.mode.export()) as i32);
                for case in v.cases.iter() {
                    self.push_block();
                    if let Some(ty) = &case.tref {
                        self.read_from_memory(ty, addr.clone(), payload_offset);
                    }
                    self.finish_block(case.tref.is_some() as usize);
                }
                self.emit(&VariantLift {
                    ty: v,
                    name: ty.name(),
                });
            }
        }
    }

    fn load_intrepr(&mut self, offset: i32, repr: IntRepr) {
        self.emit(&match repr {
            IntRepr::U64 => Instruction::I64Load { offset },
            IntRepr::U32 => Instruction::I32Load { offset },
            IntRepr::U16 => Instruction::I32Load16U { offset },
            IntRepr::U8 => Instruction::I32Load8U { offset },
        });
    }

    fn store_intrepr(&mut self, offset: i32, repr: IntRepr) {
        self.emit(&match repr {
            IntRepr::U64 => Instruction::I64Store { offset },
            IntRepr::U32 => Instruction::I32Store { offset },
            IntRepr::U16 => Instruction::I32Store16 { offset },
            IntRepr::U8 => Instruction::I32Store8 { offset },
        });
    }

    fn translate_buffer(&mut self, buffer: &Buffer) {
        let do_write = match self.mode {
            // For declared items, input/output is defined in the context of
            // what the callee will do. The callee will read input buffers,
            // meaning we write to them, and write to ouptut buffers, meaning
            // we'll read from them.
            CallMode::DeclaredImport | CallMode::DeclaredExport => !buffer.out,

            // Defined item mirror declared imports because buffers are
            // defined from the caller's perspective, so we don't invert the
            // `out` setting like above.
            CallMode::DefinedImport | CallMode::DefinedExport => buffer.out,
        };
        self.emit(&Instruction::IterBasePointer);
        let addr = self.stack.pop().unwrap();
        if do_write {
            self.push_block();
            self.emit(&Instruction::VariantPayload);
            self.write_to_memory(&buffer.tref, addr, 0);
            self.finish_block(0);
        } else {
            self.push_block();
            self.read_from_memory(&buffer.tref, addr, 0);
            self.finish_block(1);
        }
    }
}

fn push_wasm(mode: CallMode, ty: &Type, result: &mut Vec<WasmType>) {
    match ty {
        Type::Builtin(BuiltinType::S8)
        | Type::Builtin(BuiltinType::U8 { .. })
        | Type::Builtin(BuiltinType::S16)
        | Type::Builtin(BuiltinType::U16)
        | Type::Builtin(BuiltinType::S32)
        | Type::Builtin(BuiltinType::U32 { .. })
        | Type::Builtin(BuiltinType::Char)
        | Type::Pointer(_)
        | Type::ConstPointer(_)
        | Type::Handle(_) => result.push(WasmType::I32),

        Type::Builtin(BuiltinType::U64) | Type::Builtin(BuiltinType::S64) => {
            result.push(WasmType::I64)
        }
        Type::Builtin(BuiltinType::F32) => result.push(WasmType::F32),
        Type::Builtin(BuiltinType::F64) => result.push(WasmType::F64),

        Type::Record(r) => match r.bitflags_repr() {
            Some(repr) => result.push(repr.into()),
            None => {
                for member in r.members.iter() {
                    push_wasm(mode, member.tref.type_(), result);
                }
            }
        },

        Type::List(_) => {
            result.push(WasmType::I32);
            result.push(WasmType::I32);
        }

        Type::Buffer(_) => {
            result.push(WasmType::I32);
            match mode {
                CallMode::DefinedExport | CallMode::DeclaredExport => {}
                CallMode::DefinedImport | CallMode::DeclaredImport => result.push(WasmType::I32),
            }
        }

        Type::Variant(v) => {
            result.push(v.tag_repr.into());
            let start = result.len();
            let mut temp = Vec::new();

            // Push each case's type onto a temporary vector, and then merge
            // that vector into our final list starting at `start`. Note
            // that this requires some degree of "unification" so we can
            // handle things like `Result<i32, f32>` where that turns into
            // `[i32 i32]` where the second `i32` might be the `f32`
            // bitcasted.
            for case in v.cases.iter() {
                let ty = match &case.tref {
                    Some(ty) => ty,
                    None => continue,
                };
                push_wasm(mode, ty.type_(), &mut temp);

                for (i, ty) in temp.drain(..).enumerate() {
                    match result.get_mut(start + i) {
                        Some(prev) => *prev = unify(*prev, ty),
                        None => result.push(ty),
                    }
                }
            }
        }
    }
}

fn unify(a: WasmType, b: WasmType) -> WasmType {
    use WasmType::*;

    match (a, b) {
        (I64, _) | (_, I64) | (I32, F64) | (F64, I32) => I64,

        (I32, I32) | (I32, F32) | (F32, I32) => I32,

        (F32, F32) => F32,
        (F64, F64) | (F32, F64) | (F64, F32) => F64,
    }
}

fn cast(from: WasmType, to: WasmType) -> Bitcast {
    use WasmType::*;

    match (from, to) {
        (I32, I32) | (I64, I64) | (F32, F32) | (F64, F64) => Bitcast::None,

        (I32, I64) => Bitcast::I32ToI64,
        (F32, F64) => Bitcast::F32ToF64,
        (F32, I32) => Bitcast::F32ToI32,
        (F64, I64) => Bitcast::F64ToI64,

        (I64, I32) => Bitcast::I64ToI32,
        (F64, F32) => Bitcast::F64ToF32,
        (I32, F32) => Bitcast::I32ToF32,
        (I64, F64) => Bitcast::I64ToF64,

        (F32, I64) => Bitcast::F32ToI64,
        (I64, F32) => Bitcast::I64ToF32,
        (F64, I32) | (I32, F64) => unreachable!(),
    }
}

fn is_char(ty: &TypeRef) -> bool {
    match &**ty.type_() {
        Type::Builtin(BuiltinType::Char) => true,
        _ => false,
    }
}