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
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Coroutines in LLVM — LLVM 13 documentation</title>
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/llvm-theme.css" type="text/css" />
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
<script src="_static/jquery.js"></script>
<script src="_static/underscore.js"></script>
<script src="_static/doctools.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="Dependence Graphs in LLVM" href="DependenceGraphs/index.html" />
<link rel="prev" title="llvm-profgen - LLVM SPGO profile generation tool" href="CommandGuide/llvm-profgen.html" />
<style type="text/css">
table.right { float: right; margin-left: 20px; }
table.right td { border: 1px solid #ccc; }
</style>
</head><body>
<div class="logo">
<a href="index.html">
<img src="_static/logo.png"
alt="LLVM Logo" width="250" height="88"/></a>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="DependenceGraphs/index.html" title="Dependence Graphs in LLVM"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="CommandGuide/llvm-profgen.html" title="llvm-profgen - LLVM SPGO profile generation tool"
accesskey="P">previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="index.html">Documentation</a>»</li>
<li class="nav-item nav-item-1"><a href="Reference.html" accesskey="U">Reference</a> »</li>
<li class="nav-item nav-item-this"><a href="">Coroutines in LLVM</a></li>
</ul>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3>Documentation</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/GettingStartedTutorials.html">Getting Started/Tutorials</a></li>
<li><a href="https://llvm.org/docs/UserGuides.html">User Guides</a></li>
<li><a href="https://llvm.org/docs/Reference.html">Reference</a></li>
</ul>
<h3>Getting Involved</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/Contributing.html">Contributing to LLVM</a></li>
<li><a href="https://llvm.org/docs/HowToSubmitABug.html">Submitting Bug Reports</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#mailing-lists">Mailing Lists</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#irc">IRC</a></li>
<li><a href="https://llvm.org/docs/GettingInvolved.html#meetups-and-social-events">Meetups and Social Events</a></li>
</ul>
<h3>Additional Links</h3>
<ul class="want-points">
<li><a href="https://llvm.org/docs/FAQ.html">FAQ</a></li>
<li><a href="https://llvm.org/docs/Lexicon.html">Glossary</a></li>
<li><a href="https://llvm.org/pubs">Publications</a></li>
<li><a href="https://github.com/llvm/llvm-project//">Github Repository</a></li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/Coroutines.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" />
<input type="submit" value="Go" />
</form>
</div>
</div>
<script>$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="coroutines-in-llvm">
<h1>Coroutines in LLVM<a class="headerlink" href="#coroutines-in-llvm" title="Permalink to this headline">¶</a></h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#introduction" id="id65">Introduction</a></p>
<ul>
<li><p><a class="reference internal" href="#switched-resume-lowering" id="id66">Switched-Resume Lowering</a></p></li>
<li><p><a class="reference internal" href="#returned-continuation-lowering" id="id67">Returned-Continuation Lowering</a></p></li>
<li><p><a class="reference internal" href="#async-lowering" id="id68">Async Lowering</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#coroutines-by-example" id="id69">Coroutines by Example</a></p>
<ul>
<li><p><a class="reference internal" href="#coroutine-representation" id="id70">Coroutine Representation</a></p></li>
<li><p><a class="reference internal" href="#coroutine-transformation" id="id71">Coroutine Transformation</a></p></li>
<li><p><a class="reference internal" href="#avoiding-heap-allocations" id="id72">Avoiding Heap Allocations</a></p></li>
<li><p><a class="reference internal" href="#multiple-suspend-points" id="id73">Multiple Suspend Points</a></p></li>
<li><p><a class="reference internal" href="#distinct-save-and-suspend" id="id74">Distinct Save and Suspend</a></p></li>
<li><p><a class="reference internal" href="#coroutine-promise" id="id75">Coroutine Promise</a></p></li>
<li><p><a class="reference internal" href="#final-suspend" id="id76">Final Suspend</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#intrinsics" id="id77">Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#coroutine-manipulation-intrinsics" id="id78">Coroutine Manipulation Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-coro-destroy-intrinsic" id="id79">‘llvm.coro.destroy’ Intrinsic</a></p></li>
<li><p><a class="reference internal" href="#llvm-coro-resume-intrinsic" id="id80">‘llvm.coro.resume’ Intrinsic</a></p></li>
<li><p><a class="reference internal" href="#llvm-coro-done-intrinsic" id="id81">‘llvm.coro.done’ Intrinsic</a></p></li>
<li><p><a class="reference internal" href="#llvm-coro-promise-intrinsic" id="id82">‘llvm.coro.promise’ Intrinsic</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#coroutine-structure-intrinsics" id="id83">Coroutine Structure Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-coro-size-intrinsic" id="id84">‘llvm.coro.size’ Intrinsic</a></p></li>
<li><p><a class="reference internal" href="#llvm-coro-begin-intrinsic" id="id85">‘llvm.coro.begin’ Intrinsic</a></p></li>
<li><p><a class="reference internal" href="#llvm-coro-free-intrinsic" id="id86">‘llvm.coro.free’ Intrinsic</a></p></li>
<li><p><a class="reference internal" href="#llvm-coro-alloc-intrinsic" id="id87">‘llvm.coro.alloc’ Intrinsic</a></p></li>
<li><p><a class="reference internal" href="#llvm-coro-noop-intrinsic" id="id88">‘llvm.coro.noop’ Intrinsic</a></p></li>
<li><p><a class="reference internal" href="#llvm-coro-frame-intrinsic" id="id89">‘llvm.coro.frame’ Intrinsic</a></p></li>
<li><p><a class="reference internal" href="#llvm-coro-id-intrinsic" id="id90">‘llvm.coro.id’ Intrinsic</a></p></li>
<li><p><a class="reference internal" href="#llvm-coro-id-async-intrinsic" id="id91">‘llvm.coro.id.async’ Intrinsic</a></p></li>
<li><p><a class="reference internal" href="#llvm-coro-id-retcon-intrinsic" id="id92">‘llvm.coro.id.retcon’ Intrinsic</a></p></li>
<li><p><a class="reference internal" href="#llvm-coro-id-retcon-once-intrinsic" id="id93">‘llvm.coro.id.retcon.once’ Intrinsic</a></p></li>
<li><p><a class="reference internal" href="#llvm-coro-end-intrinsic" id="id94">‘llvm.coro.end’ Intrinsic</a></p></li>
<li><p><a class="reference internal" href="#llvm-coro-end-async-intrinsic" id="id95">‘llvm.coro.end.async’ Intrinsic</a></p></li>
<li><p><a class="reference internal" href="#llvm-coro-suspend-intrinsic" id="id96">‘llvm.coro.suspend’ Intrinsic</a></p></li>
<li><p><a class="reference internal" href="#llvm-coro-save-intrinsic" id="id97">‘llvm.coro.save’ Intrinsic</a></p></li>
<li><p><a class="reference internal" href="#llvm-coro-suspend-async-intrinsic" id="id98">‘llvm.coro.suspend.async’ Intrinsic</a></p></li>
<li><p><a class="reference internal" href="#llvm-coro-prepare-async-intrinsic" id="id99">‘llvm.coro.prepare.async’ Intrinsic</a></p></li>
<li><p><a class="reference internal" href="#llvm-coro-suspend-retcon-intrinsic" id="id100">‘llvm.coro.suspend.retcon’ Intrinsic</a></p></li>
<li><p><a class="reference internal" href="#llvm-coro-param-intrinsic" id="id101">‘llvm.coro.param’ Intrinsic</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#coroutine-transformation-passes" id="id102">Coroutine Transformation Passes</a></p>
<ul>
<li><p><a class="reference internal" href="#coroearly" id="id103">CoroEarly</a></p></li>
<li><p><a class="reference internal" href="#corosplit" id="id104">CoroSplit</a></p></li>
<li><p><a class="reference internal" href="#coroelide" id="id105">CoroElide</a></p></li>
<li><p><a class="reference internal" href="#corocleanup" id="id106">CoroCleanup</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#areas-requiring-attention" id="id107">Areas Requiring Attention</a></p></li>
</ul>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is a work in progress. Compatibility across LLVM releases is not
guaranteed.</p>
</div>
<div class="section" id="introduction">
<h2><a class="toc-backref" href="#id65">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
<p id="coroutine-handle">LLVM coroutines are functions that have one or more <a class="reference internal" href="#suspend-points">suspend points</a>.
When a suspend point is reached, the execution of a coroutine is suspended and
control is returned back to its caller. A suspended coroutine can be resumed
to continue execution from the last suspend point or it can be destroyed.</p>
<p>In the following example, we call function <cite>f</cite> (which may or may not be a
coroutine itself) that returns a handle to a suspended coroutine
(<strong>coroutine handle</strong>) that is used by <cite>main</cite> to resume the coroutine twice and
then destroy it:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="k">i32</span> <span class="vg">@main</span><span class="p">()</span> <span class="p">{</span>
<span class="nl">entry:</span>
<span class="nv">%hdl</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@f</span><span class="p">(</span><span class="k">i32</span> <span class="m">4</span><span class="p">)</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@llvm.coro.resume</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">)</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@llvm.coro.resume</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">)</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@llvm.coro.destroy</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">)</span>
<span class="k">ret</span> <span class="k">i32</span> <span class="m">0</span>
<span class="p">}</span>
</pre></div>
</div>
<p id="coroutine-frame">In addition to the function stack frame which exists when a coroutine is
executing, there is an additional region of storage that contains objects that
keep the coroutine state when a coroutine is suspended. This region of storage
is called the <strong>coroutine frame</strong>. It is created when a coroutine is called
and destroyed when a coroutine either runs to completion or is destroyed
while suspended.</p>
<p>LLVM currently supports two styles of coroutine lowering. These styles
support substantially different sets of features, have substantially
different ABIs, and expect substantially different patterns of frontend
code generation. However, the styles also have a great deal in common.</p>
<p>In all cases, an LLVM coroutine is initially represented as an ordinary LLVM
function that has calls to <a class="reference internal" href="#coroutine-intrinsics">coroutine intrinsics</a> defining the structure of
the coroutine. The coroutine function is then, in the most general case,
rewritten by the coroutine lowering passes to become the “ramp function”,
the initial entrypoint of the coroutine, which executes until a suspend point
is first reached. The remainder of the original coroutine function is split
out into some number of “resume functions”. Any state which must persist
across suspensions is stored in the coroutine frame. The resume functions
must somehow be able to handle either a “normal” resumption, which continues
the normal execution of the coroutine, or an “abnormal” resumption, which
must unwind the coroutine without attempting to suspend it.</p>
<div class="section" id="switched-resume-lowering">
<h3><a class="toc-backref" href="#id66">Switched-Resume Lowering</a><a class="headerlink" href="#switched-resume-lowering" title="Permalink to this headline">¶</a></h3>
<p>In LLVM’s standard switched-resume lowering, signaled by the use of
<cite>llvm.coro.id</cite>, the coroutine frame is stored as part of a “coroutine
object” which represents a handle to a particular invocation of the
coroutine. All coroutine objects support a common ABI allowing certain
features to be used without knowing anything about the coroutine’s
implementation:</p>
<ul class="simple">
<li><p>A coroutine object can be queried to see if it has reached completion
with <cite>llvm.coro.done</cite>.</p></li>
<li><p>A coroutine object can be resumed normally if it has not already reached
completion with <cite>llvm.coro.resume</cite>.</p></li>
<li><p>A coroutine object can be destroyed, invalidating the coroutine object,
with <cite>llvm.coro.destroy</cite>. This must be done separately even if the
coroutine has reached completion normally.</p></li>
<li><p>“Promise” storage, which is known to have a certain size and alignment,
can be projected out of the coroutine object with <cite>llvm.coro.promise</cite>.
The coroutine implementation must have been compiled to define a promise
of the same size and alignment.</p></li>
</ul>
<p>In general, interacting with a coroutine object in any of these ways while
it is running has undefined behavior.</p>
<p>The coroutine function is split into three functions, representing three
different ways that control can enter the coroutine:</p>
<ol class="arabic simple">
<li><p>the ramp function that is initially invoked, which takes arbitrary
arguments and returns a pointer to the coroutine object;</p></li>
<li><p>a coroutine resume function that is invoked when the coroutine is resumed,
which takes a pointer to the coroutine object and returns <cite>void</cite>;</p></li>
<li><p>a coroutine destroy function that is invoked when the coroutine is
destroyed, which takes a pointer to the coroutine object and returns
<cite>void</cite>.</p></li>
</ol>
<p>Because the resume and destroy functions are shared across all suspend
points, suspend points must store the index of the active suspend in
the coroutine object, and the resume/destroy functions must switch over
that index to get back to the correct point. Hence the name of this
lowering.</p>
<p>Pointers to the resume and destroy functions are stored in the coroutine
object at known offsets which are fixed for all coroutines. A completed
coroutine is represented with a null resume function.</p>
<p>There is a somewhat complex protocol of intrinsics for allocating and
deallocating the coroutine object. It is complex in order to allow the
allocation to be elided due to inlining. This protocol is discussed
in further detail below.</p>
<p>The frontend may generate code to call the coroutine function directly;
this will become a call to the ramp function and will return a pointer
to the coroutine object. The frontend should always resume or destroy
the coroutine using the corresponding intrinsics.</p>
</div>
<div class="section" id="returned-continuation-lowering">
<h3><a class="toc-backref" href="#id67">Returned-Continuation Lowering</a><a class="headerlink" href="#returned-continuation-lowering" title="Permalink to this headline">¶</a></h3>
<p>In returned-continuation lowering, signaled by the use of
<cite>llvm.coro.id.retcon</cite> or <cite>llvm.coro.id.retcon.once</cite>, some aspects of
the ABI must be handled more explicitly by the frontend.</p>
<p>In this lowering, every suspend point takes a list of “yielded values”
which are returned back to the caller along with a function pointer,
called the continuation function. The coroutine is resumed by simply
calling this continuation function pointer. The original coroutine
is divided into the ramp function and then an arbitrary number of
these continuation functions, one for each suspend point.</p>
<p>LLVM actually supports two closely-related returned-continuation
lowerings:</p>
<ul>
<li><p>In normal returned-continuation lowering, the coroutine may suspend
itself multiple times. This means that a continuation function
itself returns another continuation pointer, as well as a list of
yielded values.</p>
<p>The coroutine indicates that it has run to completion by returning
a null continuation pointer. Any yielded values will be <cite>undef</cite>
should be ignored.</p>
</li>
<li><p>In yield-once returned-continuation lowering, the coroutine must
suspend itself exactly once (or throw an exception). The ramp
function returns a continuation function pointer and yielded
values, but the continuation function simply returns <cite>void</cite>
when the coroutine has run to completion.</p></li>
</ul>
<p>The coroutine frame is maintained in a fixed-size buffer that is
passed to the <cite>coro.id</cite> intrinsic, which guarantees a certain size
and alignment statically. The same buffer must be passed to the
continuation function(s). The coroutine will allocate memory if the
buffer is insufficient, in which case it will need to store at
least that pointer in the buffer; therefore the buffer must always
be at least pointer-sized. How the coroutine uses the buffer may
vary between suspend points.</p>
<p>In addition to the buffer pointer, continuation functions take an
argument indicating whether the coroutine is being resumed normally
(zero) or abnormally (non-zero).</p>
<p>LLVM is currently ineffective at statically eliminating allocations
after fully inlining returned-continuation coroutines into a caller.
This may be acceptable if LLVM’s coroutine support is primarily being
used for low-level lowering and inlining is expected to be applied
earlier in the pipeline.</p>
</div>
<div class="section" id="async-lowering">
<h3><a class="toc-backref" href="#id68">Async Lowering</a><a class="headerlink" href="#async-lowering" title="Permalink to this headline">¶</a></h3>
<p>In async-continuation lowering, signaled by the use of <cite>llvm.coro.id.async</cite>,
handling of control-flow must be handled explicitly by the frontend.</p>
<p>In this lowering, a coroutine is assumed to take the current <cite>async context</cite> as
one of its arguments (the argument position is determined by
<cite>llvm.coro.id.async</cite>). It is used to marshal arguments and return values of the
coroutine. Therefore an async coroutine returns <cite>void</cite>.</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="k">swiftcc</span> <span class="k">void</span> <span class="vg">@async_coroutine</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%async.ctxt</span><span class="p">,</span> <span class="k">i8</span><span class="p">*,</span> <span class="k">i8</span><span class="p">*)</span> <span class="p">{</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Values live across a suspend point need to be stored in the coroutine frame to
be available in the continuation function. This frame is stored as a tail to the
<cite>async context</cite>.</p>
<p>Every suspend point takes an <cite>context projection function</cite> argument which
describes how-to obtain the continuations <cite>async context</cite> and every suspend
point has an associated <cite>resume function</cite> denoted by the
<cite>llvm.coro.async.resume</cite> intrinsic. The coroutine is resumed by calling this
<cite>resume function</cite> passing the <cite>async context</cite> as the one of its arguments
argument. The <cite>resume function</cite> can restore its (the caller’s) <cite>async context</cite>
by applying a <cite>context projection function</cite> that is provided by the frontend as
a parameter to the <cite>llvm.coro.suspend.async</cite> intrinsic.</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="c1">// For example:</span>
<span class="k">struct</span> <span class="nc">async_context</span> <span class="p">{</span>
<span class="k">struct</span> <span class="nc">async_context</span> <span class="o">*</span><span class="n">caller_context</span><span class="p">;</span>
<span class="p">...</span>
<span class="p">}</span>
<span class="kt">char</span> <span class="o">*</span><span class="n">context_projection_function</span><span class="p">(</span><span class="k">struct</span> <span class="nc">async_context</span> <span class="o">*</span><span class="n">callee_ctxt</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="n">callee_ctxt</span><span class="o">-></span><span class="n">caller_context</span><span class="p">;</span>
<span class="p">}</span>
</pre></div>
</div>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%resume_func_ptr</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@llvm.coro.async.resume</span><span class="p">()</span>
<span class="k">call</span> <span class="p">{</span><span class="k">i8</span><span class="p">*,</span> <span class="k">i8</span><span class="p">*,</span> <span class="k">i8</span><span class="p">*}</span> <span class="p">(</span><span class="k">i8</span><span class="p">*,</span> <span class="k">i8</span><span class="p">*,</span> <span class="p">...)</span> <span class="vg">@llvm.coro.suspend.async</span><span class="p">(</span>
<span class="k">i8</span><span class="p">*</span> <span class="nv">%resume_func_ptr</span><span class="p">,</span>
<span class="k">i8</span><span class="p">*</span> <span class="nv">%context_projection_function</span>
</pre></div>
</div>
<p>The frontend should provide a <cite>async function pointer</cite> struct associated with
each async coroutine by <cite>llvm.coro.id.async</cite>’s argument. The initial size and
alignment of the <cite>async context</cite> must be provided as arguments to the
<cite>llvm.coro.id.async</cite> intrinsic. Lowering will update the size entry with the
coroutine frame requirements. The frontend is responsible for allocating the
memory for the <cite>async context</cite> but can use the <cite>async function pointer</cite> struct
to obtain the required size.</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="k">struct</span> <span class="nc">async_function_pointer</span> <span class="p">{</span>
<span class="kt">uint32_t</span> <span class="n">relative_function_pointer_to_async_impl</span><span class="p">;</span>
<span class="kt">uint32_t</span> <span class="n">context_size</span><span class="p">;</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Lowering will split an async coroutine into a ramp function and one resume
function per suspend point.</p>
<p>How control-flow is passed between caller, suspension point, and back to
resume function is left up to the frontend.</p>
<p>The suspend point takes a function and its arguments. The function is intended
to model the transfer to the callee function. It will be tail called by
lowering and therefore must have the same signature and calling convention as
the async coroutine.</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">call</span> <span class="p">{</span><span class="k">i8</span><span class="p">*,</span> <span class="k">i8</span><span class="p">*,</span> <span class="k">i8</span><span class="p">*}</span> <span class="p">(</span><span class="k">i8</span><span class="p">*,</span> <span class="k">i8</span><span class="p">*,</span> <span class="p">...)</span> <span class="vg">@llvm.coro.suspend.async</span><span class="p">(</span>
<span class="k">i8</span><span class="p">*</span> <span class="nv">%resume_func_ptr</span><span class="p">,</span>
<span class="k">i8</span><span class="p">*</span> <span class="nv">%context_projection_function</span><span class="p">,</span>
<span class="k">i8</span><span class="p">*</span> <span class="p">(</span><span class="k">bitcast</span> <span class="k">void</span> <span class="p">(</span><span class="k">i8</span><span class="p">*,</span> <span class="k">i8</span><span class="p">*,</span> <span class="k">i8</span><span class="p">*)*</span> <span class="k">to</span> <span class="k">i8</span><span class="p">*)</span> <span class="nv">%suspend_function</span><span class="p">,</span>
<span class="k">i8</span><span class="p">*</span> <span class="nv">%arg1</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%arg2</span><span class="p">,</span> <span class="k">i8</span> <span class="nv">%arg3</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="coroutines-by-example">
<h2><a class="toc-backref" href="#id69">Coroutines by Example</a><a class="headerlink" href="#coroutines-by-example" title="Permalink to this headline">¶</a></h2>
<p>The examples below are all of switched-resume coroutines.</p>
<div class="section" id="coroutine-representation">
<h3><a class="toc-backref" href="#id70">Coroutine Representation</a><a class="headerlink" href="#coroutine-representation" title="Permalink to this headline">¶</a></h3>
<p>Let’s look at an example of an LLVM coroutine with the behavior sketched
by the following pseudo-code.</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="kt">void</span> <span class="o">*</span><span class="nf">f</span><span class="p">(</span><span class="kt">int</span> <span class="n">n</span><span class="p">)</span> <span class="p">{</span>
<span class="k">for</span><span class="p">(;;)</span> <span class="p">{</span>
<span class="n">print</span><span class="p">(</span><span class="n">n</span><span class="o">++</span><span class="p">);</span>
<span class="o"><</span><span class="n">suspend</span><span class="o">></span> <span class="c1">// returns a coroutine handle on first suspend</span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p>This coroutine calls some function <cite>print</cite> with value <cite>n</cite> as an argument and
suspends execution. Every time this coroutine resumes, it calls <cite>print</cite> again with an argument one bigger than the last time. This coroutine never completes by itself and must be destroyed explicitly. If we use this coroutine with
a <cite>main</cite> shown in the previous section. It will call <cite>print</cite> with values 4, 5
and 6 after which the coroutine will be destroyed.</p>
<p>The LLVM IR for this coroutine looks like this:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@f</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%n</span><span class="p">)</span> <span class="p">{</span>
<span class="nl">entry:</span>
<span class="nv">%id</span> <span class="p">=</span> <span class="k">call</span> <span class="k">token</span> <span class="vg">@llvm.coro.id</span><span class="p">(</span><span class="k">i32</span> <span class="m">0</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="k">null</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="k">null</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="k">null</span><span class="p">)</span>
<span class="nv">%size</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@llvm.coro.size.i32</span><span class="p">()</span>
<span class="nv">%alloc</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@malloc</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%size</span><span class="p">)</span>
<span class="nv">%hdl</span> <span class="p">=</span> <span class="k">call</span> <span class="k">noalias</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@llvm.coro.begin</span><span class="p">(</span><span class="k">token</span> <span class="nv">%id</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%alloc</span><span class="p">)</span>
<span class="k">br</span> <span class="k">label</span> <span class="nv">%loop</span>
<span class="nl">loop:</span>
<span class="nv">%n.val</span> <span class="p">=</span> <span class="k">phi</span> <span class="k">i32</span> <span class="p">[</span> <span class="nv">%n</span><span class="p">,</span> <span class="nv">%entry</span> <span class="p">],</span> <span class="p">[</span> <span class="nv">%inc</span><span class="p">,</span> <span class="nv">%loop</span> <span class="p">]</span>
<span class="nv">%inc</span> <span class="p">=</span> <span class="k">add</span> <span class="k">nsw</span> <span class="k">i32</span> <span class="nv">%n.val</span><span class="p">,</span> <span class="m">1</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@print</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%n.val</span><span class="p">)</span>
<span class="nv nv-Anonymous">%0</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span> <span class="vg">@llvm.coro.suspend</span><span class="p">(</span><span class="k">token</span> <span class="k">none</span><span class="p">,</span> <span class="k">i1</span> <span class="k">false</span><span class="p">)</span>
<span class="k">switch</span> <span class="k">i8</span> <span class="nv nv-Anonymous">%0</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%suspend</span> <span class="p">[</span><span class="k">i8</span> <span class="m">0</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%loop</span>
<span class="k">i8</span> <span class="m">1</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%cleanup</span><span class="p">]</span>
<span class="nl">cleanup:</span>
<span class="nv">%mem</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@llvm.coro.free</span><span class="p">(</span><span class="k">token</span> <span class="nv">%id</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">)</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@free</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%mem</span><span class="p">)</span>
<span class="k">br</span> <span class="k">label</span> <span class="nv">%suspend</span>
<span class="nl">suspend:</span>
<span class="nv">%unused</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i1</span> <span class="vg">@llvm.coro.end</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">,</span> <span class="k">i1</span> <span class="k">false</span><span class="p">)</span>
<span class="k">ret</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span>
<span class="p">}</span>
</pre></div>
</div>
<p>The <cite>entry</cite> block establishes the coroutine frame. The <a class="reference internal" href="#coro-size">coro.size</a> intrinsic is
lowered to a constant representing the size required for the coroutine frame.
The <a class="reference internal" href="#coro-begin">coro.begin</a> intrinsic initializes the coroutine frame and returns the
coroutine handle. The second parameter of <cite>coro.begin</cite> is given a block of memory
to be used if the coroutine frame needs to be allocated dynamically.
The <a class="reference internal" href="#coro-id">coro.id</a> intrinsic serves as coroutine identity useful in cases when the
<a class="reference internal" href="#coro-begin">coro.begin</a> intrinsic get duplicated by optimization passes such as
jump-threading.</p>
<p>The <cite>cleanup</cite> block destroys the coroutine frame. The <a class="reference internal" href="#coro-free">coro.free</a> intrinsic,
given the coroutine handle, returns a pointer of the memory block to be freed or
<cite>null</cite> if the coroutine frame was not allocated dynamically. The <cite>cleanup</cite>
block is entered when coroutine runs to completion by itself or destroyed via
call to the <a class="reference internal" href="#coro-destroy">coro.destroy</a> intrinsic.</p>
<p>The <cite>suspend</cite> block contains code to be executed when coroutine runs to
completion or suspended. The <a class="reference internal" href="#coro-end">coro.end</a> intrinsic marks the point where
a coroutine needs to return control back to the caller if it is not an initial
invocation of the coroutine.</p>
<p>The <cite>loop</cite> blocks represents the body of the coroutine. The <a class="reference internal" href="#coro-suspend">coro.suspend</a>
intrinsic in combination with the following switch indicates what happens to
control flow when a coroutine is suspended (default case), resumed (case 0) or
destroyed (case 1).</p>
</div>
<div class="section" id="coroutine-transformation">
<h3><a class="toc-backref" href="#id71">Coroutine Transformation</a><a class="headerlink" href="#coroutine-transformation" title="Permalink to this headline">¶</a></h3>
<p>One of the steps of coroutine lowering is building the coroutine frame. The
def-use chains are analyzed to determine which objects need be kept alive across
suspend points. In the coroutine shown in the previous section, use of virtual register
<cite>%inc</cite> is separated from the definition by a suspend point, therefore, it
cannot reside on the stack frame since the latter goes away once the coroutine
is suspended and control is returned back to the caller. An i32 slot is
allocated in the coroutine frame and <cite>%inc</cite> is spilled and reloaded from that
slot as needed.</p>
<p>We also store addresses of the resume and destroy functions so that the
<cite>coro.resume</cite> and <cite>coro.destroy</cite> intrinsics can resume and destroy the coroutine
when its identity cannot be determined statically at compile time. For our
example, the coroutine frame will be:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%f.frame</span> <span class="p">=</span> <span class="k">type</span> <span class="p">{</span> <span class="k">void</span> <span class="p">(</span><span class="nv">%f.frame</span><span class="p">*)*,</span> <span class="k">void</span> <span class="p">(</span><span class="nv">%f.frame</span><span class="p">*)*,</span> <span class="k">i32</span> <span class="p">}</span>
</pre></div>
</div>
<p>After resume and destroy parts are outlined, function <cite>f</cite> will contain only the
code responsible for creation and initialization of the coroutine frame and
execution of the coroutine until a suspend point is reached:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@f</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%n</span><span class="p">)</span> <span class="p">{</span>
<span class="nl">entry:</span>
<span class="nv">%id</span> <span class="p">=</span> <span class="k">call</span> <span class="k">token</span> <span class="vg">@llvm.coro.id</span><span class="p">(</span><span class="k">i32</span> <span class="m">0</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="k">null</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="k">null</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="k">null</span><span class="p">)</span>
<span class="nv">%alloc</span> <span class="p">=</span> <span class="k">call</span> <span class="k">noalias</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@malloc</span><span class="p">(</span><span class="k">i32</span> <span class="m">24</span><span class="p">)</span>
<span class="nv nv-Anonymous">%0</span> <span class="p">=</span> <span class="k">call</span> <span class="k">noalias</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@llvm.coro.begin</span><span class="p">(</span><span class="k">token</span> <span class="nv">%id</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%alloc</span><span class="p">)</span>
<span class="nv">%frame</span> <span class="p">=</span> <span class="k">bitcast</span> <span class="k">i8</span><span class="p">*</span> <span class="nv nv-Anonymous">%0</span> <span class="k">to</span> <span class="nv">%f.frame</span><span class="p">*</span>
<span class="nv nv-Anonymous">%1</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="nv">%f.frame</span><span class="p">,</span> <span class="nv">%f.frame</span><span class="p">*</span> <span class="nv">%frame</span><span class="p">,</span> <span class="k">i32</span> <span class="m">0</span><span class="p">,</span> <span class="k">i32</span> <span class="m">0</span>
<span class="k">store</span> <span class="k">void</span> <span class="p">(</span><span class="nv">%f.frame</span><span class="p">*)*</span> <span class="vg">@f.resume</span><span class="p">,</span> <span class="k">void</span> <span class="p">(</span><span class="nv">%f.frame</span><span class="p">*)**</span> <span class="nv nv-Anonymous">%1</span>
<span class="nv nv-Anonymous">%2</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="nv">%f.frame</span><span class="p">,</span> <span class="nv">%f.frame</span><span class="p">*</span> <span class="nv">%frame</span><span class="p">,</span> <span class="k">i32</span> <span class="m">0</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span>
<span class="k">store</span> <span class="k">void</span> <span class="p">(</span><span class="nv">%f.frame</span><span class="p">*)*</span> <span class="vg">@f.destroy</span><span class="p">,</span> <span class="k">void</span> <span class="p">(</span><span class="nv">%f.frame</span><span class="p">*)**</span> <span class="nv nv-Anonymous">%2</span>
<span class="nv">%inc</span> <span class="p">=</span> <span class="k">add</span> <span class="k">nsw</span> <span class="k">i32</span> <span class="nv">%n</span><span class="p">,</span> <span class="m">1</span>
<span class="nv">%inc.spill.addr</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="k">inbounds</span> <span class="nv">%f.Frame</span><span class="p">,</span> <span class="nv">%f.Frame</span><span class="p">*</span> <span class="nv">%FramePtr</span><span class="p">,</span> <span class="k">i32</span> <span class="m">0</span><span class="p">,</span> <span class="k">i32</span> <span class="m">2</span>
<span class="k">store</span> <span class="k">i32</span> <span class="nv">%inc</span><span class="p">,</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%inc.spill.addr</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@print</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%n</span><span class="p">)</span>
<span class="k">ret</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%frame</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Outlined resume part of the coroutine will reside in function <cite>f.resume</cite>:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="k">internal</span> <span class="k">fastcc</span> <span class="k">void</span> <span class="vg">@f.resume</span><span class="p">(</span><span class="nv">%f.frame</span><span class="p">*</span> <span class="nv">%frame.ptr.resume</span><span class="p">)</span> <span class="p">{</span>
<span class="nl">entry:</span>
<span class="nv">%inc.spill.addr</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="nv">%f.frame</span><span class="p">,</span> <span class="nv">%f.frame</span><span class="p">*</span> <span class="nv">%frame.ptr.resume</span><span class="p">,</span> <span class="k">i64</span> <span class="m">0</span><span class="p">,</span> <span class="k">i32</span> <span class="m">2</span>
<span class="nv">%inc.spill</span> <span class="p">=</span> <span class="k">load</span> <span class="k">i32</span><span class="p">,</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%inc.spill.addr</span><span class="p">,</span> <span class="k">align</span> <span class="m">4</span>
<span class="nv">%inc</span> <span class="p">=</span> <span class="k">add</span> <span class="k">i32</span> <span class="nv">%n.val</span><span class="p">,</span> <span class="m">1</span>
<span class="k">store</span> <span class="k">i32</span> <span class="nv">%inc</span><span class="p">,</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%inc.spill.addr</span><span class="p">,</span> <span class="k">align</span> <span class="m">4</span>
<span class="k">tail</span> <span class="k">call</span> <span class="k">void</span> <span class="vg">@print</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%inc</span><span class="p">)</span>
<span class="k">ret</span> <span class="k">void</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Whereas function <cite>f.destroy</cite> will contain the cleanup code for the coroutine:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="k">internal</span> <span class="k">fastcc</span> <span class="k">void</span> <span class="vg">@f.destroy</span><span class="p">(</span><span class="nv">%f.frame</span><span class="p">*</span> <span class="nv">%frame.ptr.destroy</span><span class="p">)</span> <span class="p">{</span>
<span class="nl">entry:</span>
<span class="nv nv-Anonymous">%0</span> <span class="p">=</span> <span class="k">bitcast</span> <span class="nv">%f.frame</span><span class="p">*</span> <span class="nv">%frame.ptr.destroy</span> <span class="k">to</span> <span class="k">i8</span><span class="p">*</span>
<span class="k">tail</span> <span class="k">call</span> <span class="k">void</span> <span class="vg">@free</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv nv-Anonymous">%0</span><span class="p">)</span>
<span class="k">ret</span> <span class="k">void</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="avoiding-heap-allocations">
<h3><a class="toc-backref" href="#id72">Avoiding Heap Allocations</a><a class="headerlink" href="#avoiding-heap-allocations" title="Permalink to this headline">¶</a></h3>
<p>A particular coroutine usage pattern, which is illustrated by the <cite>main</cite>
function in the overview section, where a coroutine is created, manipulated and
destroyed by the same calling function, is common for coroutines implementing
RAII idiom and is suitable for allocation elision optimization which avoid
dynamic allocation by storing the coroutine frame as a static <cite>alloca</cite> in its
caller.</p>
<p>In the entry block, we will call <a class="reference internal" href="#coro-alloc">coro.alloc</a> intrinsic that will return <cite>true</cite>
when dynamic allocation is required, and <cite>false</cite> if dynamic allocation is
elided.</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nl">entry:</span>
<span class="nv">%id</span> <span class="p">=</span> <span class="k">call</span> <span class="k">token</span> <span class="vg">@llvm.coro.id</span><span class="p">(</span><span class="k">i32</span> <span class="m">0</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="k">null</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="k">null</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="k">null</span><span class="p">)</span>
<span class="nv">%need.dyn.alloc</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i1</span> <span class="vg">@llvm.coro.alloc</span><span class="p">(</span><span class="k">token</span> <span class="nv">%id</span><span class="p">)</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%need.dyn.alloc</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%dyn.alloc</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%coro.begin</span>
<span class="nl">dyn.alloc:</span>
<span class="nv">%size</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@llvm.coro.size.i32</span><span class="p">()</span>
<span class="nv">%alloc</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@CustomAlloc</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%size</span><span class="p">)</span>
<span class="k">br</span> <span class="k">label</span> <span class="nv">%coro.begin</span>
<span class="nl">coro.begin:</span>
<span class="nv">%phi</span> <span class="p">=</span> <span class="k">phi</span> <span class="k">i8</span><span class="p">*</span> <span class="p">[</span> <span class="k">null</span><span class="p">,</span> <span class="nv">%entry</span> <span class="p">],</span> <span class="p">[</span> <span class="nv">%alloc</span><span class="p">,</span> <span class="nv">%dyn.alloc</span> <span class="p">]</span>
<span class="nv">%hdl</span> <span class="p">=</span> <span class="k">call</span> <span class="k">noalias</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@llvm.coro.begin</span><span class="p">(</span><span class="k">token</span> <span class="nv">%id</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%phi</span><span class="p">)</span>
</pre></div>
</div>
<p>In the cleanup block, we will make freeing the coroutine frame conditional on
<a class="reference internal" href="#coro-free">coro.free</a> intrinsic. If allocation is elided, <a class="reference internal" href="#coro-free">coro.free</a> returns <cite>null</cite>
thus skipping the deallocation code:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nl">cleanup:</span>
<span class="nv">%mem</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@llvm.coro.free</span><span class="p">(</span><span class="k">token</span> <span class="nv">%id</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">)</span>
<span class="nv">%need.dyn.free</span> <span class="p">=</span> <span class="k">icmp</span> <span class="k">ne</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%mem</span><span class="p">,</span> <span class="k">null</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%need.dyn.free</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%dyn.free</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%if.end</span>
<span class="nl">dyn.free:</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@CustomFree</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%mem</span><span class="p">)</span>
<span class="k">br</span> <span class="k">label</span> <span class="nv">%if.end</span>
<span class="nl">if.end:</span>
<span class="p">...</span>
</pre></div>
</div>
<p>With allocations and deallocations represented as described as above, after
coroutine heap allocation elision optimization, the resulting main will be:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="k">i32</span> <span class="vg">@main</span><span class="p">()</span> <span class="p">{</span>
<span class="nl">entry:</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@print</span><span class="p">(</span><span class="k">i32</span> <span class="m">4</span><span class="p">)</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@print</span><span class="p">(</span><span class="k">i32</span> <span class="m">5</span><span class="p">)</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@print</span><span class="p">(</span><span class="k">i32</span> <span class="m">6</span><span class="p">)</span>
<span class="k">ret</span> <span class="k">i32</span> <span class="m">0</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="multiple-suspend-points">
<h3><a class="toc-backref" href="#id73">Multiple Suspend Points</a><a class="headerlink" href="#multiple-suspend-points" title="Permalink to this headline">¶</a></h3>
<p>Let’s consider the coroutine that has more than one suspend point:</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="kt">void</span> <span class="o">*</span><span class="nf">f</span><span class="p">(</span><span class="kt">int</span> <span class="n">n</span><span class="p">)</span> <span class="p">{</span>
<span class="k">for</span><span class="p">(;;)</span> <span class="p">{</span>
<span class="n">print</span><span class="p">(</span><span class="n">n</span><span class="o">++</span><span class="p">);</span>
<span class="o"><</span><span class="n">suspend</span><span class="o">></span>
<span class="n">print</span><span class="p">(</span><span class="o">-</span><span class="n">n</span><span class="p">);</span>
<span class="o"><</span><span class="n">suspend</span><span class="o">></span>
<span class="p">}</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Matching LLVM code would look like (with the rest of the code remaining the same
as the code in the previous section):</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nl">loop:</span>
<span class="nv">%n.addr</span> <span class="p">=</span> <span class="k">phi</span> <span class="k">i32</span> <span class="p">[</span> <span class="nv">%n</span><span class="p">,</span> <span class="nv">%entry</span> <span class="p">],</span> <span class="p">[</span> <span class="nv">%inc</span><span class="p">,</span> <span class="nv">%loop.resume</span> <span class="p">]</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@print</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%n.addr</span><span class="p">)</span> <span class="vg">#4</span>
<span class="nv nv-Anonymous">%2</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span> <span class="vg">@llvm.coro.suspend</span><span class="p">(</span><span class="k">token</span> <span class="k">none</span><span class="p">,</span> <span class="k">i1</span> <span class="k">false</span><span class="p">)</span>
<span class="k">switch</span> <span class="k">i8</span> <span class="nv nv-Anonymous">%2</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%suspend</span> <span class="p">[</span><span class="k">i8</span> <span class="m">0</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%loop.resume</span>
<span class="k">i8</span> <span class="m">1</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%cleanup</span><span class="p">]</span>
<span class="nl">loop.resume:</span>
<span class="nv">%inc</span> <span class="p">=</span> <span class="k">add</span> <span class="k">nsw</span> <span class="k">i32</span> <span class="nv">%n.addr</span><span class="p">,</span> <span class="m">1</span>
<span class="nv">%sub</span> <span class="p">=</span> <span class="k">xor</span> <span class="k">i32</span> <span class="nv">%n.addr</span><span class="p">,</span> <span class="m">-1</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@print</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%sub</span><span class="p">)</span>
<span class="nv nv-Anonymous">%3</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span> <span class="vg">@llvm.coro.suspend</span><span class="p">(</span><span class="k">token</span> <span class="k">none</span><span class="p">,</span> <span class="k">i1</span> <span class="k">false</span><span class="p">)</span>
<span class="k">switch</span> <span class="k">i8</span> <span class="nv nv-Anonymous">%3</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%suspend</span> <span class="p">[</span><span class="k">i8</span> <span class="m">0</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%loop</span>
<span class="k">i8</span> <span class="m">1</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%cleanup</span><span class="p">]</span>
</pre></div>
</div>
<p>In this case, the coroutine frame would include a suspend index that will
indicate at which suspend point the coroutine needs to resume. The resume
function will use an index to jump to an appropriate basic block and will look
as follows:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="k">internal</span> <span class="k">fastcc</span> <span class="k">void</span> <span class="vg">@f.Resume</span><span class="p">(</span><span class="nv">%f.Frame</span><span class="p">*</span> <span class="nv">%FramePtr</span><span class="p">)</span> <span class="p">{</span>
<span class="nl">entry.Resume:</span>
<span class="nv">%index.addr</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="k">inbounds</span> <span class="nv">%f.Frame</span><span class="p">,</span> <span class="nv">%f.Frame</span><span class="p">*</span> <span class="nv">%FramePtr</span><span class="p">,</span> <span class="k">i64</span> <span class="m">0</span><span class="p">,</span> <span class="k">i32</span> <span class="m">2</span>
<span class="nv">%index</span> <span class="p">=</span> <span class="k">load</span> <span class="k">i8</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%index.addr</span><span class="p">,</span> <span class="k">align</span> <span class="m">1</span>
<span class="nv">%switch</span> <span class="p">=</span> <span class="k">icmp</span> <span class="k">eq</span> <span class="k">i8</span> <span class="nv">%index</span><span class="p">,</span> <span class="m">0</span>
<span class="nv">%n.addr</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="k">inbounds</span> <span class="nv">%f.Frame</span><span class="p">,</span> <span class="nv">%f.Frame</span><span class="p">*</span> <span class="nv">%FramePtr</span><span class="p">,</span> <span class="k">i64</span> <span class="m">0</span><span class="p">,</span> <span class="k">i32</span> <span class="m">3</span>
<span class="nv">%n</span> <span class="p">=</span> <span class="k">load</span> <span class="k">i32</span><span class="p">,</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%n.addr</span><span class="p">,</span> <span class="k">align</span> <span class="m">4</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%switch</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%loop.resume</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%loop</span>
<span class="nl">loop.resume:</span>
<span class="nv">%sub</span> <span class="p">=</span> <span class="k">xor</span> <span class="k">i32</span> <span class="nv">%n</span><span class="p">,</span> <span class="m">-1</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@print</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%sub</span><span class="p">)</span>
<span class="k">br</span> <span class="k">label</span> <span class="nv">%suspend</span>
<span class="nl">loop:</span>
<span class="nv">%inc</span> <span class="p">=</span> <span class="k">add</span> <span class="k">nsw</span> <span class="k">i32</span> <span class="nv">%n</span><span class="p">,</span> <span class="m">1</span>
<span class="k">store</span> <span class="k">i32</span> <span class="nv">%inc</span><span class="p">,</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%n.addr</span><span class="p">,</span> <span class="k">align</span> <span class="m">4</span>
<span class="k">tail</span> <span class="k">call</span> <span class="k">void</span> <span class="vg">@print</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%inc</span><span class="p">)</span>
<span class="k">br</span> <span class="k">label</span> <span class="nv">%suspend</span>
<span class="nl">suspend:</span>
<span class="nv">%storemerge</span> <span class="p">=</span> <span class="k">phi</span> <span class="k">i8</span> <span class="p">[</span> <span class="m">0</span><span class="p">,</span> <span class="nv">%loop</span> <span class="p">],</span> <span class="p">[</span> <span class="m">1</span><span class="p">,</span> <span class="nv">%loop.resume</span> <span class="p">]</span>
<span class="k">store</span> <span class="k">i8</span> <span class="nv">%storemerge</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%index.addr</span><span class="p">,</span> <span class="k">align</span> <span class="m">1</span>
<span class="k">ret</span> <span class="k">void</span>
<span class="p">}</span>
</pre></div>
</div>
<p>If different cleanup code needs to get executed for different suspend points,
a similar switch will be in the <cite>f.destroy</cite> function.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Using suspend index in a coroutine state and having a switch in <cite>f.resume</cite> and
<cite>f.destroy</cite> is one of the possible implementation strategies. We explored
another option where a distinct <cite>f.resume1</cite>, <cite>f.resume2</cite>, etc. are created for
every suspend point, and instead of storing an index, the resume and destroy
function pointers are updated at every suspend. Early testing showed that the
current approach is easier on the optimizer than the latter so it is a
lowering strategy implemented at the moment.</p>
</div>
</div>
<div class="section" id="distinct-save-and-suspend">
<h3><a class="toc-backref" href="#id74">Distinct Save and Suspend</a><a class="headerlink" href="#distinct-save-and-suspend" title="Permalink to this headline">¶</a></h3>
<p>In the previous example, setting a resume index (or some other state change that
needs to happen to prepare a coroutine for resumption) happens at the same time as
a suspension of a coroutine. However, in certain cases, it is necessary to control
when coroutine is prepared for resumption and when it is suspended.</p>
<p>In the following example, a coroutine represents some activity that is driven
by completions of asynchronous operations <cite>async_op1</cite> and <cite>async_op2</cite> which get
a coroutine handle as a parameter and resume the coroutine once async
operation is finished.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>void g() {
for (;;)
if (cond()) {
async_op1(<coroutine-handle>); // will resume once async_op1 completes
<suspend>
do_one();
}
else {
async_op2(<coroutine-handle>); // will resume once async_op2 completes
<suspend>
do_two();
}
}
}
</pre></div>
</div>
<p>In this case, coroutine should be ready for resumption prior to a call to
<cite>async_op1</cite> and <cite>async_op2</cite>. The <a class="reference internal" href="#coro-save">coro.save</a> intrinsic is used to indicate a
point when coroutine should be ready for resumption (namely, when a resume index
should be stored in the coroutine frame, so that it can be resumed at the
correct resume point):</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nl">if.true:</span>
<span class="nv">%save1</span> <span class="p">=</span> <span class="k">call</span> <span class="k">token</span> <span class="vg">@llvm.coro.save</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">)</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@async_op1</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">)</span>
<span class="nv">%suspend1</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i1</span> <span class="vg">@llvm.coro.suspend</span><span class="p">(</span><span class="k">token</span> <span class="nv">%save1</span><span class="p">,</span> <span class="k">i1</span> <span class="k">false</span><span class="p">)</span>
<span class="k">switch</span> <span class="k">i8</span> <span class="nv">%suspend1</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%suspend</span> <span class="p">[</span><span class="k">i8</span> <span class="m">0</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%resume1</span>
<span class="k">i8</span> <span class="m">1</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%cleanup</span><span class="p">]</span>
<span class="nl">if.false:</span>
<span class="nv">%save2</span> <span class="p">=</span> <span class="k">call</span> <span class="k">token</span> <span class="vg">@llvm.coro.save</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">)</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@async_op2</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">)</span>
<span class="nv">%suspend2</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i1</span> <span class="vg">@llvm.coro.suspend</span><span class="p">(</span><span class="k">token</span> <span class="nv">%save2</span><span class="p">,</span> <span class="k">i1</span> <span class="k">false</span><span class="p">)</span>
<span class="k">switch</span> <span class="k">i8</span> <span class="nv">%suspend1</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%suspend</span> <span class="p">[</span><span class="k">i8</span> <span class="m">0</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%resume2</span>
<span class="k">i8</span> <span class="m">1</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%cleanup</span><span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="coroutine-promise">
<span id="id1"></span><h3><a class="toc-backref" href="#id75">Coroutine Promise</a><a class="headerlink" href="#coroutine-promise" title="Permalink to this headline">¶</a></h3>
<p>A coroutine author or a frontend may designate a distinguished <cite>alloca</cite> that can
be used to communicate with the coroutine. This distinguished alloca is called
<strong>coroutine promise</strong> and is provided as the second parameter to the
<a class="reference internal" href="#coro-id">coro.id</a> intrinsic.</p>
<p>The following coroutine designates a 32 bit integer <cite>promise</cite> and uses it to
store the current value produced by a coroutine.</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@f</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%n</span><span class="p">)</span> <span class="p">{</span>
<span class="nl">entry:</span>
<span class="nv">%promise</span> <span class="p">=</span> <span class="k">alloca</span> <span class="k">i32</span>
<span class="nv">%pv</span> <span class="p">=</span> <span class="k">bitcast</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%promise</span> <span class="k">to</span> <span class="k">i8</span><span class="p">*</span>
<span class="nv">%id</span> <span class="p">=</span> <span class="k">call</span> <span class="k">token</span> <span class="vg">@llvm.coro.id</span><span class="p">(</span><span class="k">i32</span> <span class="m">0</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%pv</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="k">null</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="k">null</span><span class="p">)</span>
<span class="nv">%need.dyn.alloc</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i1</span> <span class="vg">@llvm.coro.alloc</span><span class="p">(</span><span class="k">token</span> <span class="nv">%id</span><span class="p">)</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%need.dyn.alloc</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%dyn.alloc</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%coro.begin</span>
<span class="nl">dyn.alloc:</span>
<span class="nv">%size</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@llvm.coro.size.i32</span><span class="p">()</span>
<span class="nv">%alloc</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@malloc</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%size</span><span class="p">)</span>
<span class="k">br</span> <span class="k">label</span> <span class="nv">%coro.begin</span>
<span class="nl">coro.begin:</span>
<span class="nv">%phi</span> <span class="p">=</span> <span class="k">phi</span> <span class="k">i8</span><span class="p">*</span> <span class="p">[</span> <span class="k">null</span><span class="p">,</span> <span class="nv">%entry</span> <span class="p">],</span> <span class="p">[</span> <span class="nv">%alloc</span><span class="p">,</span> <span class="nv">%dyn.alloc</span> <span class="p">]</span>
<span class="nv">%hdl</span> <span class="p">=</span> <span class="k">call</span> <span class="k">noalias</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@llvm.coro.begin</span><span class="p">(</span><span class="k">token</span> <span class="nv">%id</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%phi</span><span class="p">)</span>
<span class="k">br</span> <span class="k">label</span> <span class="nv">%loop</span>
<span class="nl">loop:</span>
<span class="nv">%n.val</span> <span class="p">=</span> <span class="k">phi</span> <span class="k">i32</span> <span class="p">[</span> <span class="nv">%n</span><span class="p">,</span> <span class="nv">%coro.begin</span> <span class="p">],</span> <span class="p">[</span> <span class="nv">%inc</span><span class="p">,</span> <span class="nv">%loop</span> <span class="p">]</span>
<span class="nv">%inc</span> <span class="p">=</span> <span class="k">add</span> <span class="k">nsw</span> <span class="k">i32</span> <span class="nv">%n.val</span><span class="p">,</span> <span class="m">1</span>
<span class="k">store</span> <span class="k">i32</span> <span class="nv">%n.val</span><span class="p">,</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%promise</span>
<span class="nv nv-Anonymous">%0</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span> <span class="vg">@llvm.coro.suspend</span><span class="p">(</span><span class="k">token</span> <span class="k">none</span><span class="p">,</span> <span class="k">i1</span> <span class="k">false</span><span class="p">)</span>
<span class="k">switch</span> <span class="k">i8</span> <span class="nv nv-Anonymous">%0</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%suspend</span> <span class="p">[</span><span class="k">i8</span> <span class="m">0</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%loop</span>
<span class="k">i8</span> <span class="m">1</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%cleanup</span><span class="p">]</span>
<span class="nl">cleanup:</span>
<span class="nv">%mem</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@llvm.coro.free</span><span class="p">(</span><span class="k">token</span> <span class="nv">%id</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">)</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@free</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%mem</span><span class="p">)</span>
<span class="k">br</span> <span class="k">label</span> <span class="nv">%suspend</span>
<span class="nl">suspend:</span>
<span class="nv">%unused</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i1</span> <span class="vg">@llvm.coro.end</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">,</span> <span class="k">i1</span> <span class="k">false</span><span class="p">)</span>
<span class="k">ret</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span>
<span class="p">}</span>
</pre></div>
</div>
<p>A coroutine consumer can rely on the <a class="reference internal" href="#coro-promise">coro.promise</a> intrinsic to access the
coroutine promise.</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="k">i32</span> <span class="vg">@main</span><span class="p">()</span> <span class="p">{</span>
<span class="nl">entry:</span>
<span class="nv">%hdl</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@f</span><span class="p">(</span><span class="k">i32</span> <span class="m">4</span><span class="p">)</span>
<span class="nv">%promise.addr.raw</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@llvm.coro.promise</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">,</span> <span class="k">i32</span> <span class="m">4</span><span class="p">,</span> <span class="k">i1</span> <span class="k">false</span><span class="p">)</span>
<span class="nv">%promise.addr</span> <span class="p">=</span> <span class="k">bitcast</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%promise.addr.raw</span> <span class="k">to</span> <span class="k">i32</span><span class="p">*</span>
<span class="nv">%val0</span> <span class="p">=</span> <span class="k">load</span> <span class="k">i32</span><span class="p">,</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%promise.addr</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@print</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%val0</span><span class="p">)</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@llvm.coro.resume</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">)</span>
<span class="nv">%val1</span> <span class="p">=</span> <span class="k">load</span> <span class="k">i32</span><span class="p">,</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%promise.addr</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@print</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%val1</span><span class="p">)</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@llvm.coro.resume</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">)</span>
<span class="nv">%val2</span> <span class="p">=</span> <span class="k">load</span> <span class="k">i32</span><span class="p">,</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%promise.addr</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@print</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%val2</span><span class="p">)</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@llvm.coro.destroy</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">)</span>
<span class="k">ret</span> <span class="k">i32</span> <span class="m">0</span>
<span class="p">}</span>
</pre></div>
</div>
<p>After example in this section is compiled, result of the compilation will be:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="k">i32</span> <span class="vg">@main</span><span class="p">()</span> <span class="p">{</span>
<span class="nl">entry:</span>
<span class="k">tail</span> <span class="k">call</span> <span class="k">void</span> <span class="vg">@print</span><span class="p">(</span><span class="k">i32</span> <span class="m">4</span><span class="p">)</span>
<span class="k">tail</span> <span class="k">call</span> <span class="k">void</span> <span class="vg">@print</span><span class="p">(</span><span class="k">i32</span> <span class="m">5</span><span class="p">)</span>
<span class="k">tail</span> <span class="k">call</span> <span class="k">void</span> <span class="vg">@print</span><span class="p">(</span><span class="k">i32</span> <span class="m">6</span><span class="p">)</span>
<span class="k">ret</span> <span class="k">i32</span> <span class="m">0</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="final-suspend">
<span id="final"></span><span id="id2"></span><h3><a class="toc-backref" href="#id76">Final Suspend</a><a class="headerlink" href="#final-suspend" title="Permalink to this headline">¶</a></h3>
<p>A coroutine author or a frontend may designate a particular suspend to be final,
by setting the second argument of the <a class="reference internal" href="#coro-suspend">coro.suspend</a> intrinsic to <cite>true</cite>.
Such a suspend point has two properties:</p>
<ul class="simple">
<li><p>it is possible to check whether a suspended coroutine is at the final suspend
point via <a class="reference internal" href="#coro-done">coro.done</a> intrinsic;</p></li>
<li><p>a resumption of a coroutine stopped at the final suspend point leads to
undefined behavior. The only possible action for a coroutine at a final
suspend point is destroying it via <a class="reference internal" href="#coro-destroy">coro.destroy</a> intrinsic.</p></li>
</ul>
<p>From the user perspective, the final suspend point represents an idea of a
coroutine reaching the end. From the compiler perspective, it is an optimization
opportunity for reducing number of resume points (and therefore switch cases) in
the resume function.</p>
<p>The following is an example of a function that keeps resuming the coroutine
until the final suspend point is reached after which point the coroutine is
destroyed:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="k">i32</span> <span class="vg">@main</span><span class="p">()</span> <span class="p">{</span>
<span class="nl">entry:</span>
<span class="nv">%hdl</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@f</span><span class="p">(</span><span class="k">i32</span> <span class="m">4</span><span class="p">)</span>
<span class="k">br</span> <span class="k">label</span> <span class="nv">%while</span>
<span class="nl">while:</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@llvm.coro.resume</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">)</span>
<span class="nv">%done</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i1</span> <span class="vg">@llvm.coro.done</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">)</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%done</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%end</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%while</span>
<span class="nl">end:</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@llvm.coro.destroy</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">)</span>
<span class="k">ret</span> <span class="k">i32</span> <span class="m">0</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Usually, final suspend point is a frontend injected suspend point that does not
correspond to any explicitly authored suspend point of the high level language.
For example, for a Python generator that has only one suspend point:</p>
<div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="k">def</span> <span class="nf">coroutine</span><span class="p">(</span><span class="n">n</span><span class="p">):</span>
<span class="k">for</span> <span class="n">i</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="n">n</span><span class="p">):</span>
<span class="k">yield</span> <span class="n">i</span>
</pre></div>
</div>
<p>Python frontend would inject two more suspend points, so that the actual code
looks like this:</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="kt">void</span><span class="o">*</span> <span class="nf">coroutine</span><span class="p">(</span><span class="kt">int</span> <span class="n">n</span><span class="p">)</span> <span class="p">{</span>
<span class="kt">int</span> <span class="n">current_value</span><span class="p">;</span>
<span class="o"><</span><span class="n">designate</span> <span class="n">current_value</span> <span class="n">to</span> <span class="n">be</span> <span class="n">coroutine</span> <span class="n">promise</span><span class="o">></span>
<span class="o"><</span><span class="n">SUSPEND</span><span class="o">></span> <span class="c1">// injected suspend point, so that the coroutine starts suspended</span>
<span class="k">for</span> <span class="p">(</span><span class="kt">int</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="n">i</span> <span class="o"><</span> <span class="n">n</span><span class="p">;</span> <span class="o">++</span><span class="n">i</span><span class="p">)</span> <span class="p">{</span>
<span class="n">current_value</span> <span class="o">=</span> <span class="n">i</span><span class="p">;</span> <span class="o"><</span><span class="n">SUSPEND</span><span class="o">></span><span class="p">;</span> <span class="c1">// corresponds to "yield i"</span>
<span class="p">}</span>
<span class="o"><</span><span class="n">SUSPEND</span> <span class="n">final</span><span class="o">=</span><span class="nb">true</span><span class="o">></span> <span class="c1">// injected final suspend point</span>
<span class="p">}</span>
</pre></div>
</div>
<p>and python iterator <cite>__next__</cite> would look like:</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="kt">int</span> <span class="nf">__next__</span><span class="p">(</span><span class="kt">void</span><span class="o">*</span> <span class="n">hdl</span><span class="p">)</span> <span class="p">{</span>
<span class="n">coro</span><span class="p">.</span><span class="n">resume</span><span class="p">(</span><span class="n">hdl</span><span class="p">);</span>
<span class="k">if</span> <span class="p">(</span><span class="n">coro</span><span class="p">.</span><span class="n">done</span><span class="p">(</span><span class="n">hdl</span><span class="p">))</span> <span class="k">throw</span> <span class="n">StopIteration</span><span class="p">();</span>
<span class="k">return</span> <span class="o">*</span><span class="p">(</span><span class="kt">int</span><span class="o">*</span><span class="p">)</span><span class="n">coro</span><span class="p">.</span><span class="n">promise</span><span class="p">(</span><span class="n">hdl</span><span class="p">,</span> <span class="mi">4</span><span class="p">,</span> <span class="nb">false</span><span class="p">);</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="intrinsics">
<h2><a class="toc-backref" href="#id77">Intrinsics</a><a class="headerlink" href="#intrinsics" title="Permalink to this headline">¶</a></h2>
<div class="section" id="coroutine-manipulation-intrinsics">
<h3><a class="toc-backref" href="#id78">Coroutine Manipulation Intrinsics</a><a class="headerlink" href="#coroutine-manipulation-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>Intrinsics described in this section are used to manipulate an existing
coroutine. They can be used in any function which happen to have a pointer
to a <a class="reference internal" href="#coroutine-frame">coroutine frame</a> or a pointer to a <a class="reference internal" href="#coroutine-promise">coroutine promise</a>.</p>
<div class="section" id="llvm-coro-destroy-intrinsic">
<span id="coro-destroy"></span><h4><a class="toc-backref" href="#id79">‘llvm.coro.destroy’ Intrinsic</a><a class="headerlink" href="#llvm-coro-destroy-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="syntax">
<h5>Syntax:<a class="headerlink" href="#syntax" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">void</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">destroy</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">handle</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="overview">
<h5>Overview:<a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.destroy</span></code>’ intrinsic destroys a suspended
switched-resume coroutine.</p>
</div>
<div class="section" id="arguments">
<h5>Arguments:<a class="headerlink" href="#arguments" title="Permalink to this headline">¶</a></h5>
<p>The argument is a coroutine handle to a suspended coroutine.</p>
</div>
<div class="section" id="semantics">
<h5>Semantics:<a class="headerlink" href="#semantics" title="Permalink to this headline">¶</a></h5>
<p>When possible, the <cite>coro.destroy</cite> intrinsic is replaced with a direct call to
the coroutine destroy function. Otherwise it is replaced with an indirect call
based on the function pointer for the destroy function stored in the coroutine
frame. Destroying a coroutine that is not suspended leads to undefined behavior.</p>
</div>
</div>
<div class="section" id="llvm-coro-resume-intrinsic">
<span id="coro-resume"></span><h4><a class="toc-backref" href="#id80">‘llvm.coro.resume’ Intrinsic</a><a class="headerlink" href="#llvm-coro-resume-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">void</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">resume</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">handle</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="id3">
<h5>Overview:<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.resume</span></code>’ intrinsic resumes a suspended switched-resume coroutine.</p>
</div>
<div class="section" id="id4">
<h5>Arguments:<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h5>
<p>The argument is a handle to a suspended coroutine.</p>
</div>
<div class="section" id="id5">
<h5>Semantics:<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h5>
<p>When possible, the <cite>coro.resume</cite> intrinsic is replaced with a direct call to the
coroutine resume function. Otherwise it is replaced with an indirect call based
on the function pointer for the resume function stored in the coroutine frame.
Resuming a coroutine that is not suspended leads to undefined behavior.</p>
</div>
</div>
<div class="section" id="llvm-coro-done-intrinsic">
<span id="coro-done"></span><h4><a class="toc-backref" href="#id81">‘llvm.coro.done’ Intrinsic</a><a class="headerlink" href="#llvm-coro-done-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i1</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">done</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">handle</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="id6">
<h5>Overview:<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.done</span></code>’ intrinsic checks whether a suspended
switched-resume coroutine is at the final suspend point or not.</p>
</div>
<div class="section" id="id7">
<h5>Arguments:<a class="headerlink" href="#id7" title="Permalink to this headline">¶</a></h5>
<p>The argument is a handle to a suspended coroutine.</p>
</div>
<div class="section" id="id8">
<h5>Semantics:<a class="headerlink" href="#id8" title="Permalink to this headline">¶</a></h5>
<p>Using this intrinsic on a coroutine that does not have a <a class="reference internal" href="#final-suspend">final suspend</a> point
or on a coroutine that is not suspended leads to undefined behavior.</p>
</div>
</div>
<div class="section" id="llvm-coro-promise-intrinsic">
<span id="coro-promise"></span><h4><a class="toc-backref" href="#id82">‘llvm.coro.promise’ Intrinsic</a><a class="headerlink" href="#llvm-coro-promise-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">promise</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">ptr</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">alignment</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">from</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="id9">
<h5>Overview:<a class="headerlink" href="#id9" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.promise</span></code>’ intrinsic obtains a pointer to a
<a class="reference internal" href="#coroutine-promise">coroutine promise</a> given a switched-resume coroutine handle and vice versa.</p>
</div>
<div class="section" id="id10">
<h5>Arguments:<a class="headerlink" href="#id10" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a handle to a coroutine if <cite>from</cite> is false. Otherwise,
it is a pointer to a coroutine promise.</p>
<p>The second argument is an alignment requirements of the promise.
If a frontend designated <cite>%promise = alloca i32</cite> as a promise, the alignment
argument to <cite>coro.promise</cite> should be the alignment of <cite>i32</cite> on the target
platform. If a frontend designated <cite>%promise = alloca i32, align 16</cite> as a
promise, the alignment argument should be 16.
This argument only accepts constants.</p>
<p>The third argument is a boolean indicating a direction of the transformation.
If <cite>from</cite> is true, the intrinsic returns a coroutine handle given a pointer
to a promise. If <cite>from</cite> is false, the intrinsics return a pointer to a promise
from a coroutine handle. This argument only accepts constants.</p>
</div>
<div class="section" id="id11">
<h5>Semantics:<a class="headerlink" href="#id11" title="Permalink to this headline">¶</a></h5>
<p>Using this intrinsic on a coroutine that does not have a coroutine promise
leads to undefined behavior. It is possible to read and modify coroutine
promise of the coroutine which is currently executing. The coroutine author and
a coroutine user are responsible to makes sure there is no data races.</p>
</div>
<div class="section" id="example">
<h5>Example:<a class="headerlink" href="#example" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@f</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%n</span><span class="p">)</span> <span class="p">{</span>
<span class="nl">entry:</span>
<span class="nv">%promise</span> <span class="p">=</span> <span class="k">alloca</span> <span class="k">i32</span>
<span class="nv">%pv</span> <span class="p">=</span> <span class="k">bitcast</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%promise</span> <span class="k">to</span> <span class="k">i8</span><span class="p">*</span>
<span class="c">; the second argument to coro.id points to the coroutine promise.</span>
<span class="nv">%id</span> <span class="p">=</span> <span class="k">call</span> <span class="k">token</span> <span class="vg">@llvm.coro.id</span><span class="p">(</span><span class="k">i32</span> <span class="m">0</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%pv</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="k">null</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="k">null</span><span class="p">)</span>
<span class="p">...</span>
<span class="nv">%hdl</span> <span class="p">=</span> <span class="k">call</span> <span class="k">noalias</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@llvm.coro.begin</span><span class="p">(</span><span class="k">token</span> <span class="nv">%id</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%alloc</span><span class="p">)</span>
<span class="p">...</span>
<span class="k">store</span> <span class="k">i32</span> <span class="m">42</span><span class="p">,</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%promise</span> <span class="c">; store something into the promise</span>
<span class="p">...</span>
<span class="k">ret</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span>
<span class="p">}</span>
<span class="k">define</span> <span class="k">i32</span> <span class="vg">@main</span><span class="p">()</span> <span class="p">{</span>
<span class="nl">entry:</span>
<span class="nv">%hdl</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@f</span><span class="p">(</span><span class="k">i32</span> <span class="m">4</span><span class="p">)</span> <span class="c">; starts the coroutine and returns its handle</span>
<span class="nv">%promise.addr.raw</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@llvm.coro.promise</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">,</span> <span class="k">i32</span> <span class="m">4</span><span class="p">,</span> <span class="k">i1</span> <span class="k">false</span><span class="p">)</span>
<span class="nv">%promise.addr</span> <span class="p">=</span> <span class="k">bitcast</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%promise.addr.raw</span> <span class="k">to</span> <span class="k">i32</span><span class="p">*</span>
<span class="nv">%val</span> <span class="p">=</span> <span class="k">load</span> <span class="k">i32</span><span class="p">,</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%promise.addr</span> <span class="c">; load a value from the promise</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@print</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%val</span><span class="p">)</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@llvm.coro.destroy</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">)</span>
<span class="k">ret</span> <span class="k">i32</span> <span class="m">0</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="coroutine-structure-intrinsics">
<span id="coroutine-intrinsics"></span><h3><a class="toc-backref" href="#id83">Coroutine Structure Intrinsics</a><a class="headerlink" href="#coroutine-structure-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>Intrinsics described in this section are used within a coroutine to describe
the coroutine structure. They should not be used outside of a coroutine.</p>
<div class="section" id="llvm-coro-size-intrinsic">
<span id="coro-size"></span><h4><a class="toc-backref" href="#id84">‘llvm.coro.size’ Intrinsic</a><a class="headerlink" href="#llvm-coro-size-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">size</span><span class="o">.</span><span class="n">i32</span><span class="p">()</span>
<span class="n">declare</span> <span class="n">i64</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">size</span><span class="o">.</span><span class="n">i64</span><span class="p">()</span>
</pre></div>
</div>
<div class="section" id="id12">
<h5>Overview:<a class="headerlink" href="#id12" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.size</span></code>’ intrinsic returns the number of bytes
required to store a <a class="reference internal" href="#coroutine-frame">coroutine frame</a>. This is only supported for
switched-resume coroutines.</p>
</div>
<div class="section" id="id13">
<h5>Arguments:<a class="headerlink" href="#id13" title="Permalink to this headline">¶</a></h5>
<p>None</p>
</div>
<div class="section" id="id14">
<h5>Semantics:<a class="headerlink" href="#id14" title="Permalink to this headline">¶</a></h5>
<p>The <cite>coro.size</cite> intrinsic is lowered to a constant representing the size of
the coroutine frame.</p>
</div>
</div>
<div class="section" id="llvm-coro-begin-intrinsic">
<span id="coro-begin"></span><h4><a class="toc-backref" href="#id85">‘llvm.coro.begin’ Intrinsic</a><a class="headerlink" href="#llvm-coro-begin-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">begin</span><span class="p">(</span><span class="n">token</span> <span class="o"><</span><span class="nb">id</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">mem</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="id15">
<h5>Overview:<a class="headerlink" href="#id15" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.begin</span></code>’ intrinsic returns an address of the coroutine frame.</p>
</div>
<div class="section" id="id16">
<h5>Arguments:<a class="headerlink" href="#id16" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a token returned by a call to ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.id</span></code>’
identifying the coroutine.</p>
<p>The second argument is a pointer to a block of memory where coroutine frame
will be stored if it is allocated dynamically. This pointer is ignored
for returned-continuation coroutines.</p>
</div>
<div class="section" id="id17">
<h5>Semantics:<a class="headerlink" href="#id17" title="Permalink to this headline">¶</a></h5>
<p>Depending on the alignment requirements of the objects in the coroutine frame
and/or on the codegen compactness reasons the pointer returned from <cite>coro.begin</cite>
may be at offset to the <cite>%mem</cite> argument. (This could be beneficial if
instructions that express relative access to data can be more compactly encoded
with small positive and negative offsets).</p>
<p>A frontend should emit exactly one <cite>coro.begin</cite> intrinsic per coroutine.</p>
</div>
</div>
<div class="section" id="llvm-coro-free-intrinsic">
<span id="coro-free"></span><h4><a class="toc-backref" href="#id86">‘llvm.coro.free’ Intrinsic</a><a class="headerlink" href="#llvm-coro-free-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">free</span><span class="p">(</span><span class="n">token</span> <span class="o">%</span><span class="nb">id</span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">frame</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="id18">
<h5>Overview:<a class="headerlink" href="#id18" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.free</span></code>’ intrinsic returns a pointer to a block of memory where
coroutine frame is stored or <cite>null</cite> if this instance of a coroutine did not use
dynamically allocated memory for its coroutine frame. This intrinsic is not
supported for returned-continuation coroutines.</p>
</div>
<div class="section" id="id19">
<h5>Arguments:<a class="headerlink" href="#id19" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a token returned by a call to ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.id</span></code>’
identifying the coroutine.</p>
<p>The second argument is a pointer to the coroutine frame. This should be the same
pointer that was returned by prior <cite>coro.begin</cite> call.</p>
</div>
<div class="section" id="example-custom-deallocation-function">
<h5>Example (custom deallocation function):<a class="headerlink" href="#example-custom-deallocation-function" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nl">cleanup:</span>
<span class="nv">%mem</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@llvm.coro.free</span><span class="p">(</span><span class="k">token</span> <span class="nv">%id</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%frame</span><span class="p">)</span>
<span class="nv">%mem_not_null</span> <span class="p">=</span> <span class="k">icmp</span> <span class="k">ne</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%mem</span><span class="p">,</span> <span class="k">null</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%mem_not_null</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%if.then</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%if.end</span>
<span class="nl">if.then:</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@CustomFree</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%mem</span><span class="p">)</span>
<span class="k">br</span> <span class="k">label</span> <span class="nv">%if.end</span>
<span class="nl">if.end:</span>
<span class="k">ret</span> <span class="k">void</span>
</pre></div>
</div>
</div>
<div class="section" id="example-standard-deallocation-functions">
<h5>Example (standard deallocation functions):<a class="headerlink" href="#example-standard-deallocation-functions" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nl">cleanup:</span>
<span class="nv">%mem</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@llvm.coro.free</span><span class="p">(</span><span class="k">token</span> <span class="nv">%id</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%frame</span><span class="p">)</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@free</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%mem</span><span class="p">)</span>
<span class="k">ret</span> <span class="k">void</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-coro-alloc-intrinsic">
<span id="coro-alloc"></span><h4><a class="toc-backref" href="#id87">‘llvm.coro.alloc’ Intrinsic</a><a class="headerlink" href="#llvm-coro-alloc-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i1</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">alloc</span><span class="p">(</span><span class="n">token</span> <span class="o"><</span><span class="nb">id</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="id20">
<h5>Overview:<a class="headerlink" href="#id20" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.alloc</span></code>’ intrinsic returns <cite>true</cite> if dynamic allocation is
required to obtain a memory for the coroutine frame and <cite>false</cite> otherwise.
This is not supported for returned-continuation coroutines.</p>
</div>
<div class="section" id="id21">
<h5>Arguments:<a class="headerlink" href="#id21" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a token returned by a call to ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.id</span></code>’
identifying the coroutine.</p>
</div>
<div class="section" id="id22">
<h5>Semantics:<a class="headerlink" href="#id22" title="Permalink to this headline">¶</a></h5>
<p>A frontend should emit at most one <cite>coro.alloc</cite> intrinsic per coroutine.
The intrinsic is used to suppress dynamic allocation of the coroutine frame
when possible.</p>
</div>
<div class="section" id="id23">
<h5>Example:<a class="headerlink" href="#id23" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nl">entry:</span>
<span class="nv">%id</span> <span class="p">=</span> <span class="k">call</span> <span class="k">token</span> <span class="vg">@llvm.coro.id</span><span class="p">(</span><span class="k">i32</span> <span class="m">0</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="k">null</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="k">null</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="k">null</span><span class="p">)</span>
<span class="nv">%dyn.alloc.required</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i1</span> <span class="vg">@llvm.coro.alloc</span><span class="p">(</span><span class="k">token</span> <span class="nv">%id</span><span class="p">)</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%dyn.alloc.required</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%coro.alloc</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%coro.begin</span>
<span class="nl">coro.alloc:</span>
<span class="nv">%frame.size</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@llvm.coro.size</span><span class="p">()</span>
<span class="nv">%alloc</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@MyAlloc</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%frame.size</span><span class="p">)</span>
<span class="k">br</span> <span class="k">label</span> <span class="nv">%coro.begin</span>
<span class="nl">coro.begin:</span>
<span class="nv">%phi</span> <span class="p">=</span> <span class="k">phi</span> <span class="k">i8</span><span class="p">*</span> <span class="p">[</span> <span class="k">null</span><span class="p">,</span> <span class="nv">%entry</span> <span class="p">],</span> <span class="p">[</span> <span class="nv">%alloc</span><span class="p">,</span> <span class="nv">%coro.alloc</span> <span class="p">]</span>
<span class="nv">%frame</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@llvm.coro.begin</span><span class="p">(</span><span class="k">token</span> <span class="nv">%id</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%phi</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-coro-noop-intrinsic">
<span id="coro-noop"></span><h4><a class="toc-backref" href="#id88">‘llvm.coro.noop’ Intrinsic</a><a class="headerlink" href="#llvm-coro-noop-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">noop</span><span class="p">()</span>
</pre></div>
</div>
<div class="section" id="id24">
<h5>Overview:<a class="headerlink" href="#id24" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.noop</span></code>’ intrinsic returns an address of the coroutine frame of
a coroutine that does nothing when resumed or destroyed.</p>
</div>
<div class="section" id="id25">
<h5>Arguments:<a class="headerlink" href="#id25" title="Permalink to this headline">¶</a></h5>
<p>None</p>
</div>
<div class="section" id="id26">
<h5>Semantics:<a class="headerlink" href="#id26" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic is lowered to refer to a private constant coroutine frame. The
resume and destroy handlers for this frame are empty functions that do nothing.
Note that in different translation units llvm.coro.noop may return different pointers.</p>
</div>
</div>
<div class="section" id="llvm-coro-frame-intrinsic">
<span id="coro-frame"></span><h4><a class="toc-backref" href="#id89">‘llvm.coro.frame’ Intrinsic</a><a class="headerlink" href="#llvm-coro-frame-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">frame</span><span class="p">()</span>
</pre></div>
</div>
<div class="section" id="id27">
<h5>Overview:<a class="headerlink" href="#id27" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.frame</span></code>’ intrinsic returns an address of the coroutine frame of
the enclosing coroutine.</p>
</div>
<div class="section" id="id28">
<h5>Arguments:<a class="headerlink" href="#id28" title="Permalink to this headline">¶</a></h5>
<p>None</p>
</div>
<div class="section" id="id29">
<h5>Semantics:<a class="headerlink" href="#id29" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic is lowered to refer to the <a class="reference internal" href="#coro-begin">coro.begin</a> instruction. This is
a frontend convenience intrinsic that makes it easier to refer to the
coroutine frame.</p>
</div>
</div>
<div class="section" id="llvm-coro-id-intrinsic">
<span id="coro-id"></span><h4><a class="toc-backref" href="#id90">‘llvm.coro.id’ Intrinsic</a><a class="headerlink" href="#llvm-coro-id-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">token</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">id</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">align</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">promise</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">coroaddr</span><span class="o">></span><span class="p">,</span>
<span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">fnaddrs</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="id30">
<h5>Overview:<a class="headerlink" href="#id30" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.id</span></code>’ intrinsic returns a token identifying a
switched-resume coroutine.</p>
</div>
<div class="section" id="id31">
<h5>Arguments:<a class="headerlink" href="#id31" title="Permalink to this headline">¶</a></h5>
<p>The first argument provides information on the alignment of the memory returned
by the allocation function and given to <cite>coro.begin</cite> by the first argument. If
this argument is 0, the memory is assumed to be aligned to 2 * sizeof(i8*).
This argument only accepts constants.</p>
<p>The second argument, if not <cite>null</cite>, designates a particular alloca instruction
to be a <a class="reference internal" href="#coroutine-promise">coroutine promise</a>.</p>
<p>The third argument is <cite>null</cite> coming out of the frontend. The CoroEarly pass sets
this argument to point to the function this coro.id belongs to.</p>
<p>The fourth argument is <cite>null</cite> before coroutine is split, and later is replaced
to point to a private global constant array containing function pointers to
outlined resume and destroy parts of the coroutine.</p>
</div>
<div class="section" id="id32">
<h5>Semantics:<a class="headerlink" href="#id32" title="Permalink to this headline">¶</a></h5>
<p>The purpose of this intrinsic is to tie together <cite>coro.id</cite>, <cite>coro.alloc</cite> and
<cite>coro.begin</cite> belonging to the same coroutine to prevent optimization passes from
duplicating any of these instructions unless entire body of the coroutine is
duplicated.</p>
<p>A frontend should emit exactly one <cite>coro.id</cite> intrinsic per coroutine.</p>
</div>
</div>
<div class="section" id="llvm-coro-id-async-intrinsic">
<span id="coro-id-async"></span><h4><a class="toc-backref" href="#id91">‘llvm.coro.id.async’ Intrinsic</a><a class="headerlink" href="#llvm-coro-id-async-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">token</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">id</span><span class="o">.</span><span class="k">async</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">context</span> <span class="n">size</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">align</span><span class="o">></span><span class="p">,</span>
<span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">context</span> <span class="n">arg</span><span class="o">></span><span class="p">,</span>
<span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="k">async</span> <span class="n">function</span> <span class="n">pointer</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="id33">
<h5>Overview:<a class="headerlink" href="#id33" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.id.async</span></code>’ intrinsic returns a token identifying an async coroutine.</p>
</div>
<div class="section" id="id34">
<h5>Arguments:<a class="headerlink" href="#id34" title="Permalink to this headline">¶</a></h5>
<p>The first argument provides the initial size of the <cite>async context</cite> as required
from the frontend. Lowering will add to this size the size required by the frame
storage and store that value to the <cite>async function pointer</cite>.</p>
<p>The second argument, is the alignment guarantee of the memory of the
<cite>async context</cite>. The frontend guarantees that the memory will be aligned by this
value.</p>
<p>The third argument is the <cite>async context</cite> argument in the current coroutine.</p>
<p>The fourth argument is the address of the <cite>async function pointer</cite> struct.
Lowering will update the context size requirement in this struct by adding the
coroutine frame size requirement to the initial size requirement as specified by
the first argument of this intrinsic.</p>
</div>
<div class="section" id="id35">
<h5>Semantics:<a class="headerlink" href="#id35" title="Permalink to this headline">¶</a></h5>
<p>A frontend should emit exactly one <cite>coro.id.async</cite> intrinsic per coroutine.</p>
</div>
</div>
<div class="section" id="llvm-coro-id-retcon-intrinsic">
<span id="coro-id-retcon"></span><h4><a class="toc-backref" href="#id92">‘llvm.coro.id.retcon’ Intrinsic</a><a class="headerlink" href="#llvm-coro-id-retcon-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">token</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">id</span><span class="o">.</span><span class="n">retcon</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">size</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">align</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">buffer</span><span class="o">></span><span class="p">,</span>
<span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">continuation</span> <span class="n">prototype</span><span class="o">></span><span class="p">,</span>
<span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">alloc</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">dealloc</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="id36">
<h5>Overview:<a class="headerlink" href="#id36" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.id.retcon</span></code>’ intrinsic returns a token identifying a
multiple-suspend returned-continuation coroutine.</p>
<p>The ‘result-type sequence’ of the coroutine is defined as follows:</p>
<ul class="simple">
<li><p>if the return type of the coroutine function is <code class="docutils literal notranslate"><span class="pre">void</span></code>, it is the
empty sequence;</p></li>
<li><p>if the return type of the coroutine function is a <code class="docutils literal notranslate"><span class="pre">struct</span></code>, it is the
element types of that <code class="docutils literal notranslate"><span class="pre">struct</span></code> in order;</p></li>
<li><p>otherwise, it is just the return type of the coroutine function.</p></li>
</ul>
<p>The first element of the result-type sequence must be a pointer type;
continuation functions will be coerced to this type. The rest of
the sequence are the ‘yield types’, and any suspends in the coroutine
must take arguments of these types.</p>
</div>
<div class="section" id="id37">
<h5>Arguments:<a class="headerlink" href="#id37" title="Permalink to this headline">¶</a></h5>
<p>The first and second arguments are the expected size and alignment of
the buffer provided as the third argument. They must be constant.</p>
<p>The fourth argument must be a reference to a global function, called
the ‘continuation prototype function’. The type, calling convention,
and attributes of any continuation functions will be taken from this
declaration. The return type of the prototype function must match the
return type of the current function. The first parameter type must be
a pointer type. The second parameter type must be an integer type;
it will be used only as a boolean flag.</p>
<p>The fifth argument must be a reference to a global function that will
be used to allocate memory. It may not fail, either by returning null
or throwing an exception. It must take an integer and return a pointer.</p>
<p>The sixth argument must be a reference to a global function that will
be used to deallocate memory. It must take a pointer and return <code class="docutils literal notranslate"><span class="pre">void</span></code>.</p>
</div>
</div>
<div class="section" id="llvm-coro-id-retcon-once-intrinsic">
<h4><a class="toc-backref" href="#id93">‘llvm.coro.id.retcon.once’ Intrinsic</a><a class="headerlink" href="#llvm-coro-id-retcon-once-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">token</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">id</span><span class="o">.</span><span class="n">retcon</span><span class="o">.</span><span class="n">once</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">size</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">align</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">buffer</span><span class="o">></span><span class="p">,</span>
<span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">prototype</span><span class="o">></span><span class="p">,</span>
<span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">alloc</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">dealloc</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="id38">
<h5>Overview:<a class="headerlink" href="#id38" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.id.retcon.once</span></code>’ intrinsic returns a token identifying a
unique-suspend returned-continuation coroutine.</p>
</div>
<div class="section" id="id39">
<h5>Arguments:<a class="headerlink" href="#id39" title="Permalink to this headline">¶</a></h5>
<p>As for <code class="docutils literal notranslate"><span class="pre">llvm.core.id.retcon</span></code>, except that the return type of the
continuation prototype must be <cite>void</cite> instead of matching the
coroutine’s return type.</p>
</div>
</div>
<div class="section" id="llvm-coro-end-intrinsic">
<span id="coro-end"></span><h4><a class="toc-backref" href="#id94">‘llvm.coro.end’ Intrinsic</a><a class="headerlink" href="#llvm-coro-end-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i1</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">end</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">handle</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">unwind</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="id40">
<h5>Overview:<a class="headerlink" href="#id40" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.end</span></code>’ marks the point where execution of the resume part of
the coroutine should end and control should return to the caller.</p>
</div>
<div class="section" id="id41">
<h5>Arguments:<a class="headerlink" href="#id41" title="Permalink to this headline">¶</a></h5>
<p>The first argument should refer to the coroutine handle of the enclosing
coroutine. A frontend is allowed to supply null as the first parameter, in this
case <cite>coro-early</cite> pass will replace the null with an appropriate coroutine
handle value.</p>
<p>The second argument should be <cite>true</cite> if this coro.end is in the block that is
part of the unwind sequence leaving the coroutine body due to an exception and
<cite>false</cite> otherwise.</p>
</div>
<div class="section" id="id42">
<h5>Semantics:<a class="headerlink" href="#id42" title="Permalink to this headline">¶</a></h5>
<p>The purpose of this intrinsic is to allow frontends to mark the cleanup and
other code that is only relevant during the initial invocation of the coroutine
and should not be present in resume and destroy parts.</p>
<p>In returned-continuation lowering, <code class="docutils literal notranslate"><span class="pre">llvm.coro.end</span></code> fully destroys the
coroutine frame. If the second argument is <cite>false</cite>, it also returns from
the coroutine with a null continuation pointer, and the next instruction
will be unreachable. If the second argument is <cite>true</cite>, it falls through
so that the following logic can resume unwinding. In a yield-once
coroutine, reaching a non-unwind <code class="docutils literal notranslate"><span class="pre">llvm.coro.end</span></code> without having first
reached a <code class="docutils literal notranslate"><span class="pre">llvm.coro.suspend.retcon</span></code> has undefined behavior.</p>
<p>The remainder of this section describes the behavior under switched-resume
lowering.</p>
<p>This intrinsic is lowered when a coroutine is split into
the start, resume and destroy parts. In the start part, it is a no-op,
in resume and destroy parts, it is replaced with <cite>ret void</cite> instruction and
the rest of the block containing <cite>coro.end</cite> instruction is discarded.
In landing pads it is replaced with an appropriate instruction to unwind to
caller. The handling of coro.end differs depending on whether the target is
using landingpad or WinEH exception model.</p>
<p>For landingpad based exception model, it is expected that frontend uses the
<a class="reference internal" href="#coro-end">coro.end</a> intrinsic as follows:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nl">ehcleanup:</span>
<span class="nv">%InResumePart</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i1</span> <span class="vg">@llvm.coro.end</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="k">null</span><span class="p">,</span> <span class="k">i1</span> <span class="k">true</span><span class="p">)</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%InResumePart</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%eh.resume</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%cleanup.cont</span>
<span class="nl">cleanup.cont:</span>
<span class="c">; rest of the cleanup</span>
<span class="nl">eh.resume:</span>
<span class="nv">%exn</span> <span class="p">=</span> <span class="k">load</span> <span class="k">i8</span><span class="p">*,</span> <span class="k">i8</span><span class="p">**</span> <span class="nv">%exn.slot</span><span class="p">,</span> <span class="k">align</span> <span class="m">8</span>
<span class="nv">%sel</span> <span class="p">=</span> <span class="k">load</span> <span class="k">i32</span><span class="p">,</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%ehselector.slot</span><span class="p">,</span> <span class="k">align</span> <span class="m">4</span>
<span class="nv">%lpad.val</span> <span class="p">=</span> <span class="k">insertvalue</span> <span class="p">{</span> <span class="k">i8</span><span class="p">*,</span> <span class="k">i32</span> <span class="p">}</span> <span class="k">undef</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%exn</span><span class="p">,</span> <span class="m">0</span>
<span class="nv">%lpad.val29</span> <span class="p">=</span> <span class="k">insertvalue</span> <span class="p">{</span> <span class="k">i8</span><span class="p">*,</span> <span class="k">i32</span> <span class="p">}</span> <span class="nv">%lpad.val</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%sel</span><span class="p">,</span> <span class="m">1</span>
<span class="k">resume</span> <span class="p">{</span> <span class="k">i8</span><span class="p">*,</span> <span class="k">i32</span> <span class="p">}</span> <span class="nv">%lpad.val29</span>
</pre></div>
</div>
<p>The <cite>CoroSpit</cite> pass replaces <cite>coro.end</cite> with <code class="docutils literal notranslate"><span class="pre">True</span></code> in the resume functions,
thus leading to immediate unwind to the caller, whereas in start function it
is replaced with <code class="docutils literal notranslate"><span class="pre">False</span></code>, thus allowing to proceed to the rest of the cleanup
code that is only needed during initial invocation of the coroutine.</p>
<p>For Windows Exception handling model, a frontend should attach a funclet bundle
referring to an enclosing cleanuppad as follows:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nl">ehcleanup:</span>
<span class="nv">%tok</span> <span class="p">=</span> <span class="k">cleanuppad</span> <span class="k">within</span> <span class="k">none</span> <span class="p">[]</span>
<span class="nv">%unused</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i1</span> <span class="vg">@llvm.coro.end</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="k">null</span><span class="p">,</span> <span class="k">i1</span> <span class="k">true</span><span class="p">)</span> <span class="p">[</span> <span class="s">"funclet"</span><span class="p">(</span><span class="k">token</span> <span class="nv">%tok</span><span class="p">)</span> <span class="p">]</span>
<span class="k">cleanupret</span> <span class="k">from</span> <span class="nv">%tok</span> <span class="k">unwind</span> <span class="k">label</span> <span class="nv">%RestOfTheCleanup</span>
</pre></div>
</div>
<p>The <cite>CoroSplit</cite> pass, if the funclet bundle is present, will insert
<code class="docutils literal notranslate"><span class="pre">cleanupret</span> <span class="pre">from</span> <span class="pre">%tok</span> <span class="pre">unwind</span> <span class="pre">to</span> <span class="pre">caller</span></code> before
the <a class="reference internal" href="#coro-end">coro.end</a> intrinsic and will remove the rest of the block.</p>
<p>The following table summarizes the handling of <a class="reference internal" href="#coro-end">coro.end</a> intrinsic.</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 16%" />
<col style="width: 17%" />
<col style="width: 25%" />
<col style="width: 41%" />
</colgroup>
<tbody>
<tr class="row-odd"><td colspan="2"></td>
<td><p>In Start Function</p></td>
<td><p>In Resume/Destroy Functions</p></td>
</tr>
<tr class="row-even"><td colspan="2"><p>unwind=false</p></td>
<td><p>nothing</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">ret</span> <span class="pre">void</span></code></p></td>
</tr>
<tr class="row-odd"><td rowspan="2"><p>unwind=true</p></td>
<td><p>WinEH</p></td>
<td><p>nothing</p></td>
<td><p><code class="docutils literal notranslate"><span class="pre">cleanupret</span> <span class="pre">unwind</span> <span class="pre">to</span> <span class="pre">caller</span></code></p></td>
</tr>
<tr class="row-even"><td><p>Landingpad</p></td>
<td><p>nothing</p></td>
<td><p>nothing</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="llvm-coro-end-async-intrinsic">
<h4><a class="toc-backref" href="#id95">‘llvm.coro.end.async’ Intrinsic</a><a class="headerlink" href="#llvm-coro-end-async-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i1</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">end</span><span class="o">.</span><span class="k">async</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">handle</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">unwind</span><span class="o">></span><span class="p">,</span> <span class="o">...</span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="id43">
<h5>Overview:<a class="headerlink" href="#id43" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.end.async</span></code>’ marks the point where execution of the resume part
of the coroutine should end and control should return to the caller. As part of
its variable tail arguments this instruction allows to specify a function and
the function’s arguments that are to be tail called as the last action before
returning.</p>
</div>
<div class="section" id="id44">
<h5>Arguments:<a class="headerlink" href="#id44" title="Permalink to this headline">¶</a></h5>
<p>The first argument should refer to the coroutine handle of the enclosing
coroutine. A frontend is allowed to supply null as the first parameter, in this
case <cite>coro-early</cite> pass will replace the null with an appropriate coroutine
handle value.</p>
<p>The second argument should be <cite>true</cite> if this coro.end is in the block that is
part of the unwind sequence leaving the coroutine body due to an exception and
<cite>false</cite> otherwise.</p>
<p>The third argument if present should specify a function to be called.</p>
<p>If the third argument is present, the remaining arguments are the arguments to
the function call.</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">call</span> <span class="k">i1</span> <span class="p">(</span><span class="k">i8</span><span class="p">*,</span> <span class="k">i1</span><span class="p">,</span> <span class="p">...)</span> <span class="vg">@llvm.coro.end.async</span><span class="p">(</span>
<span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">,</span> <span class="k">i1</span> <span class="m">0</span><span class="p">,</span>
<span class="k">void</span> <span class="p">(</span><span class="k">i8</span><span class="p">*,</span> <span class="nv">%async.task</span><span class="p">*,</span> <span class="nv">%async.actor</span><span class="p">*)*</span> <span class="vg">@must_tail_call_return</span><span class="p">,</span>
<span class="k">i8</span><span class="p">*</span> <span class="nv">%ctxt</span><span class="p">,</span> <span class="nv">%async.task</span><span class="p">*</span> <span class="nv">%task</span><span class="p">,</span> <span class="nv">%async.actor</span><span class="p">*</span> <span class="nv">%actor</span><span class="p">)</span>
<span class="k">unreachable</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-coro-suspend-intrinsic">
<span id="suspend-points"></span><span id="coro-suspend"></span><h4><a class="toc-backref" href="#id96">‘llvm.coro.suspend’ Intrinsic</a><a class="headerlink" href="#llvm-coro-suspend-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i8</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">suspend</span><span class="p">(</span><span class="n">token</span> <span class="o"><</span><span class="n">save</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">final</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="id45">
<h5>Overview:<a class="headerlink" href="#id45" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.suspend</span></code>’ marks the point where execution of a
switched-resume coroutine is suspended and control is returned back
to the caller. Conditional branches consuming the result of this
intrinsic lead to basic blocks where coroutine should proceed when
suspended (-1), resumed (0) or destroyed (1).</p>
</div>
<div class="section" id="id46">
<h5>Arguments:<a class="headerlink" href="#id46" title="Permalink to this headline">¶</a></h5>
<p>The first argument refers to a token of <cite>coro.save</cite> intrinsic that marks the
point when coroutine state is prepared for suspension. If <cite>none</cite> token is passed,
the intrinsic behaves as if there were a <cite>coro.save</cite> immediately preceding
the <cite>coro.suspend</cite> intrinsic.</p>
<p>The second argument indicates whether this suspension point is <a class="reference internal" href="#final">final</a>.
The second argument only accepts constants. If more than one suspend point is
designated as final, the resume and destroy branches should lead to the same
basic blocks.</p>
</div>
<div class="section" id="example-normal-suspend-point">
<h5>Example (normal suspend point):<a class="headerlink" href="#example-normal-suspend-point" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv nv-Anonymous">%0</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span> <span class="vg">@llvm.coro.suspend</span><span class="p">(</span><span class="k">token</span> <span class="k">none</span><span class="p">,</span> <span class="k">i1</span> <span class="k">false</span><span class="p">)</span>
<span class="k">switch</span> <span class="k">i8</span> <span class="nv nv-Anonymous">%0</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%suspend</span> <span class="p">[</span><span class="k">i8</span> <span class="m">0</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%resume</span>
<span class="k">i8</span> <span class="m">1</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%cleanup</span><span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="example-final-suspend-point">
<h5>Example (final suspend point):<a class="headerlink" href="#example-final-suspend-point" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nl">while.end:</span>
<span class="nv">%s.final</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span> <span class="vg">@llvm.coro.suspend</span><span class="p">(</span><span class="k">token</span> <span class="k">none</span><span class="p">,</span> <span class="k">i1</span> <span class="k">true</span><span class="p">)</span>
<span class="k">switch</span> <span class="k">i8</span> <span class="nv">%s.final</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%suspend</span> <span class="p">[</span><span class="k">i8</span> <span class="m">0</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%trap</span>
<span class="k">i8</span> <span class="m">1</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%cleanup</span><span class="p">]</span>
<span class="nl">trap:</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@llvm.trap</span><span class="p">()</span>
<span class="k">unreachable</span>
</pre></div>
</div>
</div>
<div class="section" id="id47">
<h5>Semantics:<a class="headerlink" href="#id47" title="Permalink to this headline">¶</a></h5>
<p>If a coroutine that was suspended at the suspend point marked by this intrinsic
is resumed via <a class="reference internal" href="#coro-resume">coro.resume</a> the control will transfer to the basic block
of the 0-case. If it is resumed via <a class="reference internal" href="#coro-destroy">coro.destroy</a>, it will proceed to the
basic block indicated by the 1-case. To suspend, coroutine proceed to the
default label.</p>
<p>If suspend intrinsic is marked as final, it can consider the <cite>true</cite> branch
unreachable and can perform optimizations that can take advantage of that fact.</p>
</div>
</div>
<div class="section" id="llvm-coro-save-intrinsic">
<span id="coro-save"></span><h4><a class="toc-backref" href="#id97">‘llvm.coro.save’ Intrinsic</a><a class="headerlink" href="#llvm-coro-save-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">token</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">save</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">handle</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="id48">
<h5>Overview:<a class="headerlink" href="#id48" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.save</span></code>’ marks the point where a coroutine need to update its
state to prepare for resumption to be considered suspended (and thus eligible
for resumption).</p>
</div>
<div class="section" id="id49">
<h5>Arguments:<a class="headerlink" href="#id49" title="Permalink to this headline">¶</a></h5>
<p>The first argument points to a coroutine handle of the enclosing coroutine.</p>
</div>
<div class="section" id="id50">
<h5>Semantics:<a class="headerlink" href="#id50" title="Permalink to this headline">¶</a></h5>
<p>Whatever coroutine state changes are required to enable resumption of
the coroutine from the corresponding suspend point should be done at the point
of <cite>coro.save</cite> intrinsic.</p>
</div>
<div class="section" id="id51">
<h5>Example:<a class="headerlink" href="#id51" title="Permalink to this headline">¶</a></h5>
<p>Separate save and suspend points are necessary when a coroutine is used to
represent an asynchronous control flow driven by callbacks representing
completions of asynchronous operations.</p>
<p>In such a case, a coroutine should be ready for resumption prior to a call to
<cite>async_op</cite> function that may trigger resumption of a coroutine from the same or
a different thread possibly prior to <cite>async_op</cite> call returning control back
to the coroutine:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%save1</span> <span class="p">=</span> <span class="k">call</span> <span class="k">token</span> <span class="vg">@llvm.coro.save</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">)</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@async_op1</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%hdl</span><span class="p">)</span>
<span class="nv">%suspend1</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i1</span> <span class="vg">@llvm.coro.suspend</span><span class="p">(</span><span class="k">token</span> <span class="nv">%save1</span><span class="p">,</span> <span class="k">i1</span> <span class="k">false</span><span class="p">)</span>
<span class="k">switch</span> <span class="k">i8</span> <span class="nv">%suspend1</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%suspend</span> <span class="p">[</span><span class="k">i8</span> <span class="m">0</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%resume1</span>
<span class="k">i8</span> <span class="m">1</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%cleanup</span><span class="p">]</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-coro-suspend-async-intrinsic">
<span id="coro-suspend-async"></span><h4><a class="toc-backref" href="#id98">‘llvm.coro.suspend.async’ Intrinsic</a><a class="headerlink" href="#llvm-coro-suspend-async-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="p">{</span><span class="n">i8</span><span class="o">*</span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">suspend</span><span class="o">.</span><span class="k">async</span><span class="p">(</span>
<span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">resume</span> <span class="n">function</span><span class="o">></span><span class="p">,</span>
<span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">context</span> <span class="n">projection</span> <span class="n">function</span><span class="o">></span><span class="p">,</span>
<span class="o">...</span> <span class="o"><</span><span class="n">function</span> <span class="n">to</span> <span class="n">call</span><span class="o">></span>
<span class="o">...</span> <span class="o"><</span><span class="n">arguments</span> <span class="n">to</span> <span class="n">function</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="id52">
<h5>Overview:<a class="headerlink" href="#id52" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.suspend.async</span></code>’ intrinsic marks the point where
execution of a async coroutine is suspended and control is passed to a callee.</p>
</div>
<div class="section" id="id53">
<h5>Arguments:<a class="headerlink" href="#id53" title="Permalink to this headline">¶</a></h5>
<p>The first argument should be the result of the <cite>llvm.coro.async.resume</cite> intrinsic.
Lowering will replace this intrinsic with the resume function for this suspend
point.</p>
<p>The second argument is the <cite>context projection function</cite>. It should describe
how-to restore the <cite>async context</cite> in the continuation function from the first
argument of the continuation function. Its type is <cite>i8* (i8*)</cite>.</p>
<p>The third argument is the function that models transfer to the callee at the
suspend point. It should take 3 arguments. Lowering will <cite>musttail</cite> call this
function.</p>
<p>The fourth to six argument are the arguments for the third argument.</p>
</div>
<div class="section" id="id54">
<h5>Semantics:<a class="headerlink" href="#id54" title="Permalink to this headline">¶</a></h5>
<p>The result of the intrinsic are mapped to the arguments of the resume function.
Execution is suspended at this intrinsic and resumed when the resume function is
called.</p>
</div>
</div>
<div class="section" id="llvm-coro-prepare-async-intrinsic">
<span id="coro-prepare-async"></span><h4><a class="toc-backref" href="#id99">‘llvm.coro.prepare.async’ Intrinsic</a><a class="headerlink" href="#llvm-coro-prepare-async-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">prepare</span><span class="o">.</span><span class="k">async</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">coroutine</span> <span class="n">function</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="id55">
<h5>Overview:<a class="headerlink" href="#id55" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.prepare.async</span></code>’ intrinsic is used to block inlining of the
async coroutine until after coroutine splitting.</p>
</div>
<div class="section" id="id56">
<h5>Arguments:<a class="headerlink" href="#id56" title="Permalink to this headline">¶</a></h5>
<p>The first argument should be an async coroutine of type <cite>void (i8*, i8*, i8*)</cite>.
Lowering will replace this intrinsic with its coroutine function argument.</p>
</div>
</div>
<div class="section" id="llvm-coro-suspend-retcon-intrinsic">
<span id="coro-suspend-retcon"></span><h4><a class="toc-backref" href="#id100">‘llvm.coro.suspend.retcon’ Intrinsic</a><a class="headerlink" href="#llvm-coro-suspend-retcon-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i1</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">suspend</span><span class="o">.</span><span class="n">retcon</span><span class="p">(</span><span class="o">...</span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="id57">
<h5>Overview:<a class="headerlink" href="#id57" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.suspend.retcon</span></code>’ intrinsic marks the point where
execution of a returned-continuation coroutine is suspended and control
is returned back to the caller.</p>
<p><cite>llvm.coro.suspend.retcon`</cite> does not support separate save points;
they are not useful when the continuation function is not locally
accessible. That would be a more appropriate feature for a <code class="docutils literal notranslate"><span class="pre">passcon</span></code>
lowering that is not yet implemented.</p>
</div>
<div class="section" id="id58">
<h5>Arguments:<a class="headerlink" href="#id58" title="Permalink to this headline">¶</a></h5>
<p>The types of the arguments must exactly match the yielded-types sequence
of the coroutine. They will be turned into return values from the ramp
and continuation functions, along with the next continuation function.</p>
</div>
<div class="section" id="id59">
<h5>Semantics:<a class="headerlink" href="#id59" title="Permalink to this headline">¶</a></h5>
<p>The result of the intrinsic indicates whether the coroutine should resume
abnormally (non-zero).</p>
<p>In a normal coroutine, it is undefined behavior if the coroutine executes
a call to <code class="docutils literal notranslate"><span class="pre">llvm.coro.suspend.retcon</span></code> after resuming abnormally.</p>
<p>In a yield-once coroutine, it is undefined behavior if the coroutine
executes a call to <code class="docutils literal notranslate"><span class="pre">llvm.coro.suspend.retcon</span></code> after resuming in any way.</p>
</div>
</div>
<div class="section" id="llvm-coro-param-intrinsic">
<span id="coro-param"></span><h4><a class="toc-backref" href="#id101">‘llvm.coro.param’ Intrinsic</a><a class="headerlink" href="#llvm-coro-param-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i1</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">coro</span><span class="o">.</span><span class="n">param</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">original</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">copy</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<div class="section" id="id60">
<h5>Overview:<a class="headerlink" href="#id60" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.coro.param</span></code>’ is used by a frontend to mark up the code used to
construct and destruct copies of the parameters. If the optimizer discovers that
a particular parameter copy is not used after any suspends, it can remove the
construction and destruction of the copy by replacing corresponding coro.param
with <cite>i1 false</cite> and replacing any use of the <cite>copy</cite> with the <cite>original</cite>.</p>
</div>
<div class="section" id="id61">
<h5>Arguments:<a class="headerlink" href="#id61" title="Permalink to this headline">¶</a></h5>
<p>The first argument points to an <cite>alloca</cite> storing the value of a parameter to a
coroutine.</p>
<p>The second argument points to an <cite>alloca</cite> storing the value of the copy of that
parameter.</p>
</div>
<div class="section" id="id62">
<h5>Semantics:<a class="headerlink" href="#id62" title="Permalink to this headline">¶</a></h5>
<p>The optimizer is free to always replace this intrinsic with <cite>i1 true</cite>.</p>
<p>The optimizer is also allowed to replace it with <cite>i1 false</cite> provided that the
parameter copy is only used prior to control flow reaching any of the suspend
points. The code that would be DCE’d if the <cite>coro.param</cite> is replaced with
<cite>i1 false</cite> is not considered to be a use of the parameter copy.</p>
<p>The frontend can emit this intrinsic if its language rules allow for this
optimization.</p>
</div>
<div class="section" id="id63">
<h5>Example:<a class="headerlink" href="#id63" title="Permalink to this headline">¶</a></h5>
<p>Consider the following example. A coroutine takes two parameters <cite>a</cite> and <cite>b</cite>
that has a destructor and a move constructor.</p>
<div class="highlight-c++ notranslate"><div class="highlight"><pre><span></span><span class="k">struct</span> <span class="nc">A</span> <span class="p">{</span> <span class="o">~</span><span class="n">A</span><span class="p">();</span> <span class="n">A</span><span class="p">(</span><span class="n">A</span><span class="o">&&</span><span class="p">);</span> <span class="kt">bool</span> <span class="nf">foo</span><span class="p">();</span> <span class="kt">void</span> <span class="nf">bar</span><span class="p">();</span> <span class="p">};</span>
<span class="n">task</span><span class="o"><</span><span class="kt">int</span><span class="o">></span> <span class="n">f</span><span class="p">(</span><span class="n">A</span> <span class="n">a</span><span class="p">,</span> <span class="n">A</span> <span class="n">b</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="n">a</span><span class="p">.</span><span class="n">foo</span><span class="p">())</span>
<span class="k">return</span> <span class="mi">42</span><span class="p">;</span>
<span class="n">a</span><span class="p">.</span><span class="n">bar</span><span class="p">();</span>
<span class="k">co_await</span> <span class="nf">read_async</span><span class="p">();</span> <span class="c1">// introduces suspend point</span>
<span class="n">b</span><span class="p">.</span><span class="n">bar</span><span class="p">();</span>
<span class="p">}</span>
</pre></div>
</div>
<p>Note that, uses of <cite>b</cite> is used after a suspend point and thus must be copied
into a coroutine frame, whereas <cite>a</cite> does not have to, since it never used
after suspend.</p>
<p>A frontend can create parameter copies for <cite>a</cite> and <cite>b</cite> as follows:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>task<int> f(A a', A b') {
a = alloca A;
b = alloca A;
// move parameters to its copies
if (coro.param(a', a)) A::A(a, A&& a');
if (coro.param(b', b)) A::A(b, A&& b');
...
// destroy parameters copies
if (coro.param(a', a)) A::~A(a);
if (coro.param(b', b)) A::~A(b);
}
</pre></div>
</div>
<p>The optimizer can replace coro.param(a’,a) with <cite>i1 false</cite> and replace all uses
of <cite>a</cite> with <cite>a’</cite>, since it is not used after suspend.</p>
<p>The optimizer must replace coro.param(b’, b) with <cite>i1 true</cite>, since <cite>b</cite> is used
after suspend and therefore, it has to reside in the coroutine frame.</p>
</div>
</div>
</div>
</div>
<div class="section" id="coroutine-transformation-passes">
<h2><a class="toc-backref" href="#id102">Coroutine Transformation Passes</a><a class="headerlink" href="#coroutine-transformation-passes" title="Permalink to this headline">¶</a></h2>
<div class="section" id="coroearly">
<h3><a class="toc-backref" href="#id103">CoroEarly</a><a class="headerlink" href="#coroearly" title="Permalink to this headline">¶</a></h3>
<p>The pass CoroEarly lowers coroutine intrinsics that hide the details of the
structure of the coroutine frame, but, otherwise not needed to be preserved to
help later coroutine passes. This pass lowers <a class="reference internal" href="#coro-frame">coro.frame</a>, <a class="reference internal" href="#coro-done">coro.done</a>,
and <a class="reference internal" href="#coro-promise">coro.promise</a> intrinsics.</p>
</div>
<div class="section" id="corosplit">
<span id="id64"></span><h3><a class="toc-backref" href="#id104">CoroSplit</a><a class="headerlink" href="#corosplit" title="Permalink to this headline">¶</a></h3>
<p>The pass CoroSplit buides coroutine frame and outlines resume and destroy parts
into separate functions.</p>
</div>
<div class="section" id="coroelide">
<h3><a class="toc-backref" href="#id105">CoroElide</a><a class="headerlink" href="#coroelide" title="Permalink to this headline">¶</a></h3>
<p>The pass CoroElide examines if the inlined coroutine is eligible for heap
allocation elision optimization. If so, it replaces
<cite>coro.begin</cite> intrinsic with an address of a coroutine frame placed on its caller
and replaces <cite>coro.alloc</cite> and <cite>coro.free</cite> intrinsics with <cite>false</cite> and <cite>null</cite>
respectively to remove the deallocation code.
This pass also replaces <cite>coro.resume</cite> and <cite>coro.destroy</cite> intrinsics with direct
calls to resume and destroy functions for a particular coroutine where possible.</p>
</div>
<div class="section" id="corocleanup">
<h3><a class="toc-backref" href="#id106">CoroCleanup</a><a class="headerlink" href="#corocleanup" title="Permalink to this headline">¶</a></h3>
<p>This pass runs late to lower all coroutine related intrinsics not replaced by
earlier passes.</p>
</div>
</div>
<div class="section" id="areas-requiring-attention">
<h2><a class="toc-backref" href="#id107">Areas Requiring Attention</a><a class="headerlink" href="#areas-requiring-attention" title="Permalink to this headline">¶</a></h2>
<ol class="arabic simple">
<li><p>When coro.suspend returns -1, the coroutine is suspended, and it’s possible
that the coroutine has already been destroyed (hence the frame has been freed).
We cannot access anything on the frame on the suspend path.
However there is nothing that prevents the compiler from moving instructions
along that path (e.g. LICM), which can lead to use-after-free. At the moment
we disabled LICM for loops that have coro.suspend, but the general problem still
exists and requires a general solution.</p></li>
<li><p>Take advantage of the lifetime intrinsics for the data that goes into the
coroutine frame. Leave lifetime intrinsics as is for the data that stays in
allocas.</p></li>
<li><p>The CoroElide optimization pass relies on coroutine ramp function to be
inlined. It would be beneficial to split the ramp function further to
increase the chance that it will get inlined into its caller.</p></li>
<li><p>Design a convention that would make it possible to apply coroutine heap
elision optimization across ABI boundaries.</p></li>
<li><p>Cannot handle coroutines with <cite>inalloca</cite> parameters (used in x86 on Windows).</p></li>
<li><p>Alignment is ignored by coro.begin and coro.free intrinsics.</p></li>
<li><p>Make required changes to make sure that coroutine optimizations work with
LTO.</p></li>
<li><p>More tests, more tests, more tests</p></li>
</ol>
</div>
</div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="DependenceGraphs/index.html" title="Dependence Graphs in LLVM"
>next</a> |</li>
<li class="right" >
<a href="CommandGuide/llvm-profgen.html" title="llvm-profgen - LLVM SPGO profile generation tool"
>previous</a> |</li>
<li><a href="https://llvm.org/">LLVM Home</a> | </li>
<li><a href="index.html">Documentation</a>»</li>
<li class="nav-item nav-item-1"><a href="Reference.html" >Reference</a> »</li>
<li class="nav-item nav-item-this"><a href="">Coroutines in LLVM</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2003-2021, LLVM Project.
Last updated on 2021-09-18.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 3.5.4.
</div>
</body>
</html>
|
