1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416
2417
2418
2419
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231
3232
3233
3234
3235
3236
3237
3238
3239
3240
3241
3242
3243
3244
3245
3246
3247
3248
3249
3250
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265
3266
3267
3268
3269
3270
3271
3272
3273
3274
3275
3276
3277
3278
3279
3280
3281
3282
3283
3284
3285
3286
3287
3288
3289
3290
3291
3292
3293
3294
3295
3296
3297
3298
3299
3300
3301
3302
3303
3304
3305
3306
3307
3308
3309
3310
3311
3312
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333
3334
3335
3336
3337
3338
3339
3340
3341
3342
3343
3344
3345
3346
3347
3348
3349
3350
3351
3352
3353
3354
3355
3356
3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
3409
3410
3411
3412
3413
3414
3415
3416
3417
3418
3419
3420
3421
3422
3423
3424
3425
3426
3427
3428
3429
3430
3431
3432
3433
3434
3435
3436
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
3484
3485
3486
3487
3488
3489
3490
3491
3492
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516
3517
3518
3519
3520
3521
3522
3523
3524
3525
3526
3527
3528
3529
3530
3531
3532
3533
3534
3535
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545
3546
3547
3548
3549
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578
3579
3580
3581
3582
3583
3584
3585
3586
3587
3588
3589
3590
3591
3592
3593
3594
3595
3596
3597
3598
3599
3600
3601
3602
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
3801
3802
3803
3804
3805
3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
3816
3817
3818
3819
3820
3821
3822
3823
3824
3825
3826
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838
3839
3840
3841
3842
3843
3844
3845
3846
3847
3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
3884
3885
3886
3887
3888
3889
3890
3891
3892
3893
3894
3895
3896
3897
3898
3899
3900
3901
3902
3903
3904
3905
3906
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
3950
3951
3952
3953
3954
3955
3956
3957
3958
3959
3960
3961
3962
3963
3964
3965
3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
3977
3978
3979
3980
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992
3993
3994
3995
3996
3997
3998
3999
4000
4001
4002
4003
4004
4005
4006
4007
4008
4009
4010
4011
4012
4013
4014
4015
4016
4017
4018
4019
4020
4021
4022
4023
4024
4025
4026
4027
4028
4029
4030
4031
4032
4033
4034
4035
4036
4037
4038
4039
4040
4041
4042
4043
4044
4045
4046
4047
4048
4049
4050
4051
4052
4053
4054
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066
4067
4068
4069
4070
4071
4072
4073
4074
4075
4076
4077
4078
4079
4080
4081
4082
4083
4084
4085
4086
4087
4088
4089
4090
4091
4092
4093
4094
4095
4096
4097
4098
4099
4100
4101
4102
4103
4104
4105
4106
4107
4108
4109
4110
4111
4112
4113
4114
4115
4116
4117
4118
4119
4120
4121
4122
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134
4135
4136
4137
4138
4139
4140
4141
4142
4143
4144
4145
4146
4147
4148
4149
4150
4151
4152
4153
4154
4155
4156
4157
4158
4159
4160
4161
4162
4163
4164
4165
4166
4167
4168
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185
4186
4187
4188
4189
4190
4191
4192
4193
4194
4195
4196
4197
4198
4199
4200
4201
4202
4203
4204
4205
4206
4207
4208
4209
4210
4211
4212
4213
4214
4215
4216
4217
4218
4219
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236
4237
4238
4239
4240
4241
4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
4254
4255
4256
4257
4258
4259
4260
4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
4273
4274
4275
4276
4277
4278
4279
4280
4281
4282
4283
4284
4285
4286
4287
4288
4289
4290
4291
4292
4293
4294
4295
4296
4297
4298
4299
4300
4301
4302
4303
4304
4305
4306
4307
4308
4309
4310
4311
4312
4313
4314
4315
4316
4317
4318
4319
4320
4321
4322
4323
4324
4325
4326
4327
4328
4329
4330
4331
4332
4333
4334
4335
4336
4337
4338
4339
4340
4341
4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
4352
4353
4354
4355
4356
4357
4358
4359
4360
4361
4362
4363
4364
4365
4366
4367
4368
4369
4370
4371
4372
4373
4374
4375
4376
4377
4378
4379
4380
4381
4382
4383
4384
4385
4386
4387
4388
4389
4390
4391
4392
4393
4394
4395
4396
4397
4398
4399
4400
4401
4402
4403
4404
4405
4406
4407
4408
4409
4410
4411
4412
4413
4414
4415
4416
4417
4418
4419
4420
4421
4422
4423
4424
4425
4426
4427
4428
4429
4430
4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
4441
4442
4443
4444
4445
4446
4447
4448
4449
4450
4451
4452
4453
4454
4455
4456
4457
4458
4459
4460
4461
4462
4463
4464
4465
4466
4467
4468
4469
4470
4471
4472
4473
4474
4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
4486
4487
4488
4489
4490
4491
4492
4493
4494
4495
4496
4497
4498
4499
4500
4501
4502
4503
4504
4505
4506
4507
4508
4509
4510
4511
4512
4513
4514
4515
4516
4517
4518
4519
4520
4521
4522
4523
4524
4525
4526
4527
4528
4529
4530
4531
4532
4533
4534
4535
4536
4537
4538
4539
4540
4541
4542
4543
4544
4545
4546
4547
4548
4549
4550
4551
4552
4553
4554
4555
4556
4557
4558
4559
4560
4561
4562
4563
4564
4565
4566
4567
4568
4569
4570
4571
4572
4573
4574
4575
4576
4577
4578
4579
4580
4581
4582
4583
4584
4585
4586
4587
4588
4589
4590
4591
4592
4593
4594
4595
4596
4597
4598
4599
4600
4601
4602
4603
4604
4605
4606
4607
4608
4609
4610
4611
4612
4613
4614
4615
4616
4617
4618
4619
4620
4621
4622
4623
4624
4625
4626
4627
4628
4629
4630
4631
4632
4633
4634
4635
4636
4637
4638
4639
4640
4641
4642
4643
4644
4645
4646
4647
4648
4649
4650
4651
4652
4653
4654
4655
4656
4657
4658
4659
4660
4661
4662
4663
4664
4665
4666
4667
4668
4669
4670
4671
4672
4673
4674
4675
4676
4677
4678
4679
4680
4681
4682
4683
4684
4685
4686
4687
4688
4689
4690
4691
4692
4693
4694
4695
4696
4697
4698
4699
4700
4701
4702
4703
4704
4705
4706
4707
4708
4709
4710
4711
4712
4713
4714
4715
4716
4717
4718
4719
4720
4721
4722
4723
4724
4725
4726
4727
4728
4729
4730
4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
4767
4768
4769
4770
4771
4772
4773
4774
4775
4776
4777
4778
4779
4780
4781
4782
4783
4784
4785
4786
4787
4788
4789
4790
4791
4792
4793
4794
4795
4796
4797
4798
4799
4800
4801
4802
4803
4804
4805
4806
4807
4808
4809
4810
4811
4812
4813
4814
4815
4816
4817
4818
4819
4820
4821
4822
4823
4824
4825
4826
4827
4828
4829
4830
4831
4832
4833
4834
4835
4836
4837
4838
4839
4840
4841
4842
4843
4844
4845
4846
4847
4848
4849
4850
4851
4852
4853
4854
4855
4856
4857
4858
4859
4860
4861
4862
4863
4864
4865
4866
4867
4868
4869
4870
4871
4872
4873
4874
4875
4876
4877
4878
4879
4880
4881
4882
4883
4884
4885
4886
4887
4888
4889
4890
4891
4892
4893
4894
4895
4896
4897
4898
4899
4900
4901
4902
4903
4904
4905
4906
4907
4908
4909
4910
4911
4912
4913
4914
4915
4916
4917
4918
4919
4920
4921
4922
4923
4924
4925
4926
4927
4928
4929
4930
4931
4932
4933
4934
4935
4936
4937
4938
4939
4940
4941
4942
4943
4944
4945
4946
4947
4948
4949
4950
4951
4952
4953
4954
4955
4956
4957
4958
4959
4960
4961
4962
4963
4964
4965
4966
4967
4968
4969
4970
4971
4972
4973
4974
4975
4976
4977
4978
4979
4980
4981
4982
4983
4984
4985
4986
4987
4988
4989
4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
5000
5001
5002
5003
5004
5005
5006
5007
5008
5009
5010
5011
5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
5029
5030
5031
5032
5033
5034
5035
5036
5037
5038
5039
5040
5041
5042
5043
5044
5045
5046
5047
5048
5049
5050
5051
5052
5053
5054
5055
5056
5057
5058
5059
5060
5061
5062
5063
5064
5065
5066
5067
5068
5069
5070
5071
5072
5073
5074
5075
5076
5077
5078
5079
5080
5081
5082
5083
5084
5085
5086
5087
5088
5089
5090
5091
5092
5093
5094
5095
5096
5097
5098
5099
5100
5101
5102
5103
5104
5105
5106
5107
5108
5109
5110
5111
5112
5113
5114
5115
5116
5117
5118
5119
5120
5121
5122
5123
5124
5125
5126
5127
5128
5129
5130
5131
5132
5133
5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
5150
5151
5152
5153
5154
5155
5156
5157
5158
5159
5160
5161
5162
5163
5164
5165
5166
5167
5168
5169
5170
5171
5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
5189
5190
5191
5192
5193
5194
5195
5196
5197
5198
5199
5200
5201
5202
5203
5204
5205
5206
5207
5208
5209
5210
5211
5212
5213
5214
5215
5216
5217
5218
5219
5220
5221
5222
5223
5224
5225
5226
5227
5228
5229
5230
5231
5232
5233
5234
5235
5236
5237
5238
5239
5240
5241
5242
5243
5244
5245
5246
5247
5248
5249
5250
5251
5252
5253
5254
5255
5256
5257
5258
5259
5260
5261
5262
5263
5264
5265
5266
5267
5268
5269
5270
5271
5272
5273
5274
5275
5276
5277
5278
5279
5280
5281
5282
5283
5284
5285
5286
5287
5288
5289
5290
5291
5292
5293
5294
5295
5296
5297
5298
5299
5300
5301
5302
5303
5304
5305
5306
5307
5308
5309
5310
5311
5312
5313
5314
5315
5316
5317
5318
5319
5320
5321
5322
5323
5324
5325
5326
5327
5328
5329
5330
5331
5332
5333
5334
5335
5336
5337
5338
5339
5340
5341
5342
5343
5344
5345
5346
5347
5348
5349
5350
5351
5352
5353
5354
5355
5356
5357
5358
5359
5360
5361
5362
5363
5364
5365
5366
5367
5368
5369
5370
5371
5372
5373
5374
5375
5376
5377
5378
5379
5380
5381
5382
5383
5384
5385
5386
5387
5388
5389
5390
5391
5392
5393
5394
5395
5396
5397
5398
5399
5400
5401
5402
5403
5404
5405
5406
5407
5408
5409
5410
5411
5412
5413
5414
5415
5416
5417
5418
5419
5420
5421
5422
5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
5434
5435
5436
5437
5438
5439
5440
5441
5442
5443
5444
5445
5446
5447
5448
5449
5450
5451
5452
5453
5454
5455
5456
5457
5458
5459
5460
5461
5462
5463
5464
5465
5466
5467
5468
5469
5470
5471
5472
5473
5474
5475
5476
5477
5478
5479
5480
5481
5482
5483
5484
5485
5486
5487
5488
5489
5490
5491
5492
5493
5494
5495
5496
5497
5498
5499
5500
5501
5502
5503
5504
5505
5506
5507
5508
5509
5510
5511
5512
5513
5514
5515
5516
5517
5518
5519
5520
5521
5522
5523
5524
5525
5526
5527
5528
5529
5530
5531
5532
5533
5534
5535
5536
5537
5538
5539
5540
5541
5542
5543
5544
5545
5546
5547
5548
5549
5550
5551
5552
5553
5554
5555
5556
5557
5558
5559
5560
5561
5562
5563
5564
5565
5566
5567
5568
5569
5570
5571
5572
5573
5574
5575
5576
5577
5578
5579
5580
5581
5582
5583
5584
5585
5586
5587
5588
5589
5590
5591
5592
5593
5594
5595
5596
5597
5598
5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
5624
5625
5626
5627
5628
5629
5630
5631
5632
5633
5634
5635
5636
5637
5638
5639
5640
5641
5642
5643
5644
5645
5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
5714
5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
5729
5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
5743
5744
5745
5746
5747
5748
5749
5750
5751
5752
5753
5754
5755
5756
5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
5775
5776
5777
5778
5779
5780
5781
5782
5783
5784
5785
5786
5787
5788
5789
5790
5791
5792
5793
5794
5795
5796
5797
5798
5799
5800
5801
5802
5803
5804
5805
5806
5807
5808
5809
5810
5811
5812
5813
5814
5815
5816
5817
5818
5819
5820
5821
5822
5823
5824
5825
5826
5827
5828
5829
5830
5831
5832
5833
5834
5835
5836
5837
5838
5839
5840
5841
5842
5843
5844
5845
5846
5847
5848
5849
5850
5851
5852
5853
5854
5855
5856
5857
5858
5859
5860
5861
5862
5863
5864
5865
5866
5867
5868
5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
5885
5886
5887
5888
5889
5890
5891
5892
5893
5894
5895
5896
5897
5898
5899
5900
5901
5902
5903
5904
5905
5906
5907
5908
5909
5910
5911
5912
5913
5914
5915
5916
5917
5918
5919
5920
5921
5922
5923
5924
5925
5926
5927
5928
5929
5930
5931
5932
5933
5934
5935
5936
5937
5938
5939
5940
5941
5942
5943
5944
5945
5946
5947
5948
5949
5950
5951
5952
5953
5954
5955
5956
5957
5958
5959
5960
5961
5962
5963
5964
5965
5966
5967
5968
5969
5970
5971
5972
5973
5974
5975
5976
5977
5978
5979
5980
5981
5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
6004
6005
6006
6007
6008
6009
6010
6011
6012
6013
6014
6015
6016
6017
6018
6019
6020
6021
6022
6023
6024
6025
6026
6027
6028
6029
6030
6031
6032
6033
6034
6035
6036
6037
6038
6039
6040
6041
6042
6043
6044
6045
6046
6047
6048
6049
6050
6051
6052
6053
6054
6055
6056
6057
6058
6059
6060
6061
6062
6063
6064
6065
6066
6067
6068
6069
6070
6071
6072
6073
6074
6075
6076
6077
6078
6079
6080
6081
6082
6083
6084
6085
6086
6087
6088
6089
6090
6091
6092
6093
6094
6095
6096
6097
6098
6099
6100
6101
6102
6103
6104
6105
6106
6107
6108
6109
6110
6111
6112
6113
6114
6115
6116
6117
6118
6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
6151
6152
6153
6154
6155
6156
6157
6158
6159
6160
6161
6162
6163
6164
6165
6166
6167
6168
6169
6170
6171
6172
6173
6174
6175
6176
6177
6178
6179
6180
6181
6182
6183
6184
6185
6186
6187
6188
6189
6190
6191
6192
6193
6194
6195
6196
6197
6198
6199
6200
6201
6202
6203
6204
6205
6206
6207
6208
6209
6210
6211
6212
6213
6214
6215
6216
6217
6218
6219
6220
6221
6222
6223
6224
6225
6226
6227
6228
6229
6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
6249
6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
6271
6272
6273
6274
6275
6276
6277
6278
6279
6280
6281
6282
6283
6284
6285
6286
6287
6288
6289
6290
6291
6292
6293
6294
6295
6296
6297
6298
6299
6300
6301
6302
6303
6304
6305
6306
6307
6308
6309
6310
6311
6312
6313
6314
6315
6316
6317
6318
6319
6320
6321
6322
6323
6324
6325
6326
6327
6328
6329
6330
6331
6332
6333
6334
6335
6336
6337
6338
6339
6340
6341
6342
6343
6344
6345
6346
6347
6348
6349
6350
6351
6352
6353
6354
6355
6356
6357
6358
6359
6360
6361
6362
6363
6364
6365
6366
6367
6368
6369
6370
6371
6372
6373
6374
6375
6376
6377
6378
6379
6380
6381
6382
6383
6384
6385
6386
6387
6388
6389
6390
6391
6392
6393
6394
6395
6396
6397
6398
6399
6400
6401
6402
6403
6404
6405
6406
6407
6408
6409
6410
6411
6412
6413
6414
6415
6416
6417
6418
6419
6420
6421
6422
6423
6424
6425
6426
6427
6428
6429
6430
6431
6432
6433
6434
6435
6436
6437
6438
6439
6440
6441
6442
6443
6444
6445
6446
6447
6448
6449
6450
6451
6452
6453
6454
6455
6456
6457
6458
6459
6460
6461
6462
6463
6464
6465
6466
6467
6468
6469
6470
6471
6472
6473
6474
6475
6476
6477
6478
6479
6480
6481
6482
6483
6484
6485
6486
6487
6488
6489
6490
6491
6492
6493
6494
6495
6496
6497
6498
6499
6500
6501
6502
6503
6504
6505
6506
6507
6508
6509
6510
6511
6512
6513
6514
6515
6516
6517
6518
6519
6520
6521
6522
6523
6524
6525
6526
6527
6528
6529
6530
6531
6532
6533
6534
6535
6536
6537
6538
6539
6540
6541
6542
6543
6544
6545
6546
6547
6548
6549
6550
6551
6552
6553
6554
6555
6556
6557
6558
6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
6584
6585
6586
6587
6588
6589
6590
6591
6592
6593
6594
6595
6596
6597
6598
6599
6600
6601
6602
6603
6604
6605
6606
6607
6608
6609
6610
6611
6612
6613
6614
6615
6616
6617
6618
6619
6620
6621
6622
6623
6624
6625
6626
6627
6628
6629
6630
6631
6632
6633
6634
6635
6636
6637
6638
6639
6640
6641
6642
6643
6644
6645
6646
6647
6648
6649
6650
6651
6652
6653
6654
6655
6656
6657
6658
6659
6660
6661
6662
6663
6664
6665
6666
6667
6668
6669
6670
6671
6672
6673
6674
6675
6676
6677
6678
6679
6680
6681
6682
6683
6684
6685
6686
6687
6688
6689
6690
6691
6692
6693
6694
6695
6696
6697
6698
6699
6700
6701
6702
6703
6704
6705
6706
6707
6708
6709
6710
6711
6712
6713
6714
6715
6716
6717
6718
6719
6720
6721
6722
6723
6724
6725
6726
6727
6728
6729
6730
6731
6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
6743
6744
6745
6746
6747
6748
6749
6750
6751
6752
6753
6754
6755
6756
6757
6758
6759
6760
6761
6762
6763
6764
6765
6766
6767
6768
6769
6770
6771
6772
6773
6774
6775
6776
6777
6778
6779
6780
6781
6782
6783
6784
6785
6786
6787
6788
6789
6790
6791
6792
6793
6794
6795
6796
6797
6798
6799
6800
6801
6802
6803
6804
6805
6806
6807
6808
6809
6810
6811
6812
6813
6814
6815
6816
6817
6818
6819
6820
6821
6822
6823
6824
6825
6826
6827
6828
6829
6830
6831
6832
6833
6834
6835
6836
6837
6838
6839
6840
6841
6842
6843
6844
6845
6846
6847
6848
6849
6850
6851
6852
6853
6854
6855
6856
6857
6858
6859
6860
6861
6862
6863
6864
6865
6866
6867
6868
6869
6870
6871
6872
6873
6874
6875
6876
6877
6878
6879
6880
6881
6882
6883
6884
6885
6886
6887
6888
6889
6890
6891
6892
6893
6894
6895
6896
6897
6898
6899
6900
6901
6902
6903
6904
6905
6906
6907
6908
6909
6910
6911
6912
6913
6914
6915
6916
6917
6918
6919
6920
6921
6922
6923
6924
6925
6926
6927
6928
6929
6930
6931
6932
6933
6934
6935
6936
6937
6938
6939
6940
6941
6942
6943
6944
6945
6946
6947
6948
6949
6950
6951
6952
6953
6954
6955
6956
6957
6958
6959
6960
6961
6962
6963
6964
6965
6966
6967
6968
6969
6970
6971
6972
6973
6974
6975
6976
6977
6978
6979
6980
6981
6982
6983
6984
6985
6986
6987
6988
6989
6990
6991
6992
6993
6994
6995
6996
6997
6998
6999
7000
7001
7002
7003
7004
7005
7006
7007
7008
7009
7010
7011
7012
7013
7014
7015
7016
7017
7018
7019
7020
7021
7022
7023
7024
7025
7026
7027
7028
7029
7030
7031
7032
7033
7034
7035
7036
7037
7038
7039
7040
7041
7042
7043
7044
7045
7046
7047
7048
7049
7050
7051
7052
7053
7054
7055
7056
7057
7058
7059
7060
7061
7062
7063
7064
7065
7066
7067
7068
7069
7070
7071
7072
7073
7074
7075
7076
7077
7078
7079
7080
7081
7082
7083
7084
7085
7086
7087
7088
7089
7090
7091
7092
7093
7094
7095
7096
7097
7098
7099
7100
7101
7102
7103
7104
7105
7106
7107
7108
7109
7110
7111
7112
7113
7114
7115
7116
7117
7118
7119
7120
7121
7122
7123
7124
7125
7126
7127
7128
7129
7130
7131
7132
7133
7134
7135
7136
7137
7138
7139
7140
7141
7142
7143
7144
7145
7146
7147
7148
7149
7150
7151
7152
7153
7154
7155
7156
7157
7158
7159
7160
7161
7162
7163
7164
7165
7166
7167
7168
7169
7170
7171
7172
7173
7174
7175
7176
7177
7178
7179
7180
7181
7182
7183
7184
7185
7186
7187
7188
7189
7190
7191
7192
7193
7194
7195
7196
7197
7198
7199
7200
7201
7202
7203
7204
7205
7206
7207
7208
7209
7210
7211
7212
7213
7214
7215
7216
7217
7218
7219
7220
7221
7222
7223
7224
7225
7226
7227
7228
7229
7230
7231
7232
7233
7234
7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
7249
7250
7251
7252
7253
7254
7255
7256
7257
7258
7259
7260
7261
7262
7263
7264
7265
7266
7267
7268
7269
7270
7271
7272
7273
7274
7275
7276
7277
7278
7279
7280
7281
7282
7283
7284
7285
7286
7287
7288
7289
7290
7291
7292
7293
7294
7295
7296
7297
7298
7299
7300
7301
7302
7303
7304
7305
7306
7307
7308
7309
7310
7311
7312
7313
7314
7315
7316
7317
7318
7319
7320
7321
7322
7323
7324
7325
7326
7327
7328
7329
7330
7331
7332
7333
7334
7335
7336
7337
7338
7339
7340
7341
7342
7343
7344
7345
7346
7347
7348
7349
7350
7351
7352
7353
7354
7355
7356
7357
7358
7359
7360
7361
7362
7363
7364
7365
7366
7367
7368
7369
7370
7371
7372
7373
7374
7375
7376
7377
7378
7379
7380
7381
7382
7383
7384
7385
7386
7387
7388
7389
7390
7391
7392
7393
7394
7395
7396
7397
7398
7399
7400
7401
7402
7403
7404
7405
7406
7407
7408
7409
7410
7411
7412
7413
7414
7415
7416
7417
7418
7419
7420
7421
7422
7423
7424
7425
7426
7427
7428
7429
7430
7431
7432
7433
7434
7435
7436
7437
7438
7439
7440
7441
7442
7443
7444
7445
7446
7447
7448
7449
7450
7451
7452
7453
7454
7455
7456
7457
7458
7459
7460
7461
7462
7463
7464
7465
7466
7467
7468
7469
7470
7471
7472
7473
7474
7475
7476
7477
7478
7479
7480
7481
7482
7483
7484
7485
7486
7487
7488
7489
7490
7491
7492
7493
7494
7495
7496
7497
7498
7499
7500
7501
7502
7503
7504
7505
7506
7507
7508
7509
7510
7511
7512
7513
7514
7515
7516
7517
7518
7519
7520
7521
7522
7523
7524
7525
7526
7527
7528
7529
7530
7531
7532
7533
7534
7535
7536
7537
7538
7539
7540
7541
7542
7543
7544
7545
7546
7547
7548
7549
7550
7551
7552
7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
7587
7588
7589
7590
7591
7592
7593
7594
7595
7596
7597
7598
7599
7600
7601
7602
7603
7604
7605
7606
7607
7608
7609
7610
7611
7612
7613
7614
7615
7616
7617
7618
7619
7620
7621
7622
7623
7624
7625
7626
7627
7628
7629
7630
7631
7632
7633
7634
7635
7636
7637
7638
7639
7640
7641
7642
7643
7644
7645
7646
7647
7648
7649
7650
7651
7652
7653
7654
7655
7656
7657
7658
7659
7660
7661
7662
7663
7664
7665
7666
7667
7668
7669
7670
7671
7672
7673
7674
7675
7676
7677
7678
7679
7680
7681
7682
7683
7684
7685
7686
7687
7688
7689
7690
7691
7692
7693
7694
7695
7696
7697
7698
7699
7700
7701
7702
7703
7704
7705
7706
7707
7708
7709
7710
7711
7712
7713
7714
7715
7716
7717
7718
7719
7720
7721
7722
7723
7724
7725
7726
7727
7728
7729
7730
7731
7732
7733
7734
7735
7736
7737
7738
7739
7740
7741
7742
7743
7744
7745
7746
7747
7748
7749
7750
7751
7752
7753
7754
7755
7756
7757
7758
7759
7760
7761
7762
7763
7764
7765
7766
7767
7768
7769
7770
7771
7772
7773
7774
7775
7776
7777
7778
7779
7780
7781
7782
7783
7784
7785
7786
7787
7788
7789
7790
7791
7792
7793
7794
7795
7796
7797
7798
7799
7800
7801
7802
7803
7804
7805
7806
7807
7808
7809
7810
7811
7812
7813
7814
7815
7816
7817
7818
7819
7820
7821
7822
7823
7824
7825
7826
7827
7828
7829
7830
7831
7832
7833
7834
7835
7836
7837
7838
7839
7840
7841
7842
7843
7844
7845
7846
7847
7848
7849
7850
7851
7852
7853
7854
7855
7856
7857
7858
7859
7860
7861
7862
7863
7864
7865
7866
7867
7868
7869
7870
7871
7872
7873
7874
7875
7876
7877
7878
7879
7880
7881
7882
7883
7884
7885
7886
7887
7888
7889
7890
7891
7892
7893
7894
7895
7896
7897
7898
7899
7900
7901
7902
7903
7904
7905
7906
7907
7908
7909
7910
7911
7912
7913
7914
7915
7916
7917
7918
7919
7920
7921
7922
7923
7924
7925
7926
7927
7928
7929
7930
7931
7932
7933
7934
7935
7936
7937
7938
7939
7940
7941
7942
7943
7944
7945
7946
7947
7948
7949
7950
7951
7952
7953
7954
7955
7956
7957
7958
7959
7960
7961
7962
7963
7964
7965
7966
7967
7968
7969
7970
7971
7972
7973
7974
7975
7976
7977
7978
7979
7980
7981
7982
7983
7984
7985
7986
7987
7988
7989
7990
7991
7992
7993
7994
7995
7996
7997
7998
7999
8000
8001
8002
8003
8004
8005
8006
8007
8008
8009
8010
8011
8012
8013
8014
8015
8016
8017
8018
8019
8020
8021
8022
8023
8024
8025
8026
8027
8028
8029
8030
8031
8032
8033
8034
8035
8036
8037
8038
8039
8040
8041
8042
8043
8044
8045
8046
8047
8048
8049
8050
8051
8052
8053
8054
8055
8056
8057
8058
8059
8060
8061
8062
8063
8064
8065
8066
8067
8068
8069
8070
8071
8072
8073
8074
8075
8076
8077
8078
8079
8080
8081
8082
8083
8084
8085
8086
8087
8088
8089
8090
8091
8092
8093
8094
8095
8096
8097
8098
8099
8100
8101
8102
8103
8104
8105
8106
8107
8108
8109
8110
8111
8112
8113
8114
8115
8116
8117
8118
8119
8120
8121
8122
8123
8124
8125
8126
8127
8128
8129
8130
8131
8132
8133
8134
8135
8136
8137
8138
8139
8140
8141
8142
8143
8144
8145
8146
8147
8148
8149
8150
8151
8152
8153
8154
8155
8156
8157
8158
8159
8160
8161
8162
8163
8164
8165
8166
8167
8168
8169
8170
8171
8172
8173
8174
8175
8176
8177
8178
8179
8180
8181
8182
8183
8184
8185
8186
8187
8188
8189
8190
8191
8192
8193
8194
8195
8196
8197
8198
8199
8200
8201
8202
8203
8204
8205
8206
8207
8208
8209
8210
8211
8212
8213
8214
8215
8216
8217
8218
8219
8220
8221
8222
8223
8224
8225
8226
8227
8228
8229
8230
8231
8232
8233
8234
8235
8236
8237
8238
8239
8240
8241
8242
8243
8244
8245
8246
8247
8248
8249
8250
8251
8252
8253
8254
8255
8256
8257
8258
8259
8260
8261
8262
8263
8264
8265
8266
8267
8268
8269
8270
8271
8272
8273
8274
8275
8276
8277
8278
8279
8280
8281
8282
8283
8284
8285
8286
8287
8288
8289
8290
8291
8292
8293
8294
8295
8296
8297
8298
8299
8300
8301
8302
8303
8304
8305
8306
8307
8308
8309
8310
8311
8312
8313
8314
8315
8316
8317
8318
8319
8320
8321
8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
8333
8334
8335
8336
8337
8338
8339
8340
8341
8342
8343
8344
8345
8346
8347
8348
8349
8350
8351
8352
8353
8354
8355
8356
8357
8358
8359
8360
8361
8362
8363
8364
8365
8366
8367
8368
8369
8370
8371
8372
8373
8374
8375
8376
8377
8378
8379
8380
8381
8382
8383
8384
8385
8386
8387
8388
8389
8390
8391
8392
8393
8394
8395
8396
8397
8398
8399
8400
8401
8402
8403
8404
8405
8406
8407
8408
8409
8410
8411
8412
8413
8414
8415
8416
8417
8418
8419
8420
8421
8422
8423
8424
8425
8426
8427
8428
8429
8430
8431
8432
8433
8434
8435
8436
8437
8438
8439
8440
8441
8442
8443
8444
8445
8446
8447
8448
8449
8450
8451
8452
8453
8454
8455
8456
8457
8458
8459
8460
8461
8462
8463
8464
8465
8466
8467
8468
8469
8470
8471
8472
8473
8474
8475
8476
8477
8478
8479
8480
8481
8482
8483
8484
8485
8486
8487
8488
8489
8490
8491
8492
8493
8494
8495
8496
8497
8498
8499
8500
8501
8502
8503
8504
8505
8506
8507
8508
8509
8510
8511
8512
8513
8514
8515
8516
8517
8518
8519
8520
8521
8522
8523
8524
8525
8526
8527
8528
8529
8530
8531
8532
8533
8534
8535
8536
8537
8538
8539
8540
8541
8542
8543
8544
8545
8546
8547
8548
8549
8550
8551
8552
8553
8554
8555
8556
8557
8558
8559
8560
8561
8562
8563
8564
8565
8566
8567
8568
8569
8570
8571
8572
8573
8574
8575
8576
8577
8578
8579
8580
8581
8582
8583
8584
8585
8586
8587
8588
8589
8590
8591
8592
8593
8594
8595
8596
8597
8598
8599
8600
8601
8602
8603
8604
8605
8606
8607
8608
8609
8610
8611
8612
8613
8614
8615
8616
8617
8618
8619
8620
8621
8622
8623
8624
8625
8626
8627
8628
8629
8630
8631
8632
8633
8634
8635
8636
8637
8638
8639
8640
8641
8642
8643
8644
8645
8646
8647
8648
8649
8650
8651
8652
8653
8654
8655
8656
8657
8658
8659
8660
8661
8662
8663
8664
8665
8666
8667
8668
8669
8670
8671
8672
8673
8674
8675
8676
8677
8678
8679
8680
8681
8682
8683
8684
8685
8686
8687
8688
8689
8690
8691
8692
8693
8694
8695
8696
8697
8698
8699
8700
8701
8702
8703
8704
8705
8706
8707
8708
8709
8710
8711
8712
8713
8714
8715
8716
8717
8718
8719
8720
8721
8722
8723
8724
8725
8726
8727
8728
8729
8730
8731
8732
8733
8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
8746
8747
8748
8749
8750
8751
8752
8753
8754
8755
8756
8757
8758
8759
8760
8761
8762
8763
8764
8765
8766
8767
8768
8769
8770
8771
8772
8773
8774
8775
8776
8777
8778
8779
8780
8781
8782
8783
8784
8785
8786
8787
8788
8789
8790
8791
8792
8793
8794
8795
8796
8797
8798
8799
8800
8801
8802
8803
8804
8805
8806
8807
8808
8809
8810
8811
8812
8813
8814
8815
8816
8817
8818
8819
8820
8821
8822
8823
8824
8825
8826
8827
8828
8829
8830
8831
8832
8833
8834
8835
8836
8837
8838
8839
8840
8841
8842
8843
8844
8845
8846
8847
8848
8849
8850
8851
8852
8853
8854
8855
8856
8857
8858
8859
8860
8861
8862
8863
8864
8865
8866
8867
8868
8869
8870
8871
8872
8873
8874
8875
8876
8877
8878
8879
8880
8881
8882
8883
8884
8885
8886
8887
8888
8889
8890
8891
8892
8893
8894
8895
8896
8897
8898
8899
8900
8901
8902
8903
8904
8905
8906
8907
8908
8909
8910
8911
8912
8913
8914
8915
8916
8917
8918
8919
8920
8921
8922
8923
8924
8925
8926
8927
8928
8929
8930
8931
8932
8933
8934
8935
8936
8937
8938
8939
8940
8941
8942
8943
8944
8945
8946
8947
8948
8949
8950
8951
8952
8953
8954
8955
8956
8957
8958
8959
8960
8961
8962
8963
8964
8965
8966
8967
8968
8969
8970
8971
8972
8973
8974
8975
8976
8977
8978
8979
8980
8981
8982
8983
8984
8985
8986
8987
8988
8989
8990
8991
8992
8993
8994
8995
8996
8997
8998
8999
9000
9001
9002
9003
9004
9005
9006
9007
9008
9009
9010
9011
9012
9013
9014
9015
9016
9017
9018
9019
9020
9021
9022
9023
9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
9034
9035
9036
9037
9038
9039
9040
9041
9042
9043
9044
9045
9046
9047
9048
9049
9050
9051
9052
9053
9054
9055
9056
9057
9058
9059
9060
9061
9062
9063
9064
9065
9066
9067
9068
9069
9070
9071
9072
9073
9074
9075
9076
9077
9078
9079
9080
9081
9082
9083
9084
9085
9086
9087
9088
9089
9090
9091
9092
9093
9094
9095
9096
9097
9098
9099
9100
9101
9102
9103
9104
9105
9106
9107
9108
9109
9110
9111
9112
9113
9114
9115
9116
9117
9118
9119
9120
9121
9122
9123
9124
9125
9126
9127
9128
9129
9130
9131
9132
9133
9134
9135
9136
9137
9138
9139
9140
9141
9142
9143
9144
9145
9146
9147
9148
9149
9150
9151
9152
9153
9154
9155
9156
9157
9158
9159
9160
9161
9162
9163
9164
9165
9166
9167
9168
9169
9170
9171
9172
9173
9174
9175
9176
9177
9178
9179
9180
9181
9182
9183
9184
9185
9186
9187
9188
9189
9190
9191
9192
9193
9194
9195
9196
9197
9198
9199
9200
9201
9202
9203
9204
9205
9206
9207
9208
9209
9210
9211
9212
9213
9214
9215
9216
9217
9218
9219
9220
9221
9222
9223
9224
9225
9226
9227
9228
9229
9230
9231
9232
9233
9234
9235
9236
9237
9238
9239
9240
9241
9242
9243
9244
9245
9246
9247
9248
9249
9250
9251
9252
9253
9254
9255
9256
9257
9258
9259
9260
9261
9262
9263
9264
9265
9266
9267
9268
9269
9270
9271
9272
9273
9274
9275
9276
9277
9278
9279
9280
9281
9282
9283
9284
9285
9286
9287
9288
9289
9290
9291
9292
9293
9294
9295
9296
9297
9298
9299
9300
9301
9302
9303
9304
9305
9306
9307
9308
9309
9310
9311
9312
9313
9314
9315
9316
9317
9318
9319
9320
9321
9322
9323
9324
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
9388
9389
9390
9391
9392
9393
9394
9395
9396
9397
9398
9399
9400
9401
9402
9403
9404
9405
9406
9407
9408
9409
9410
9411
9412
9413
9414
9415
9416
9417
9418
9419
9420
9421
9422
9423
9424
9425
9426
9427
9428
9429
9430
9431
9432
9433
9434
9435
9436
9437
9438
9439
9440
9441
9442
9443
9444
9445
9446
9447
9448
9449
9450
9451
9452
9453
9454
9455
9456
9457
9458
9459
9460
9461
9462
9463
9464
9465
9466
9467
9468
9469
9470
9471
9472
9473
9474
9475
9476
9477
9478
9479
9480
9481
9482
9483
9484
9485
9486
9487
9488
9489
9490
9491
9492
9493
9494
9495
9496
9497
9498
9499
9500
9501
9502
9503
9504
9505
9506
9507
9508
9509
9510
9511
9512
9513
9514
9515
9516
9517
9518
9519
9520
9521
9522
9523
9524
9525
9526
9527
9528
9529
9530
9531
9532
9533
9534
9535
9536
9537
9538
9539
9540
9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
9559
9560
9561
9562
9563
9564
9565
9566
9567
9568
9569
9570
9571
9572
9573
9574
9575
9576
9577
9578
9579
9580
9581
9582
9583
9584
9585
9586
9587
9588
9589
9590
9591
9592
9593
9594
9595
9596
9597
9598
9599
9600
9601
9602
9603
9604
9605
9606
9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
9619
9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
9634
9635
9636
9637
9638
9639
9640
9641
9642
9643
9644
9645
9646
9647
9648
9649
9650
9651
9652
9653
9654
9655
9656
9657
9658
9659
9660
9661
9662
9663
9664
9665
9666
9667
9668
9669
9670
9671
9672
9673
9674
9675
9676
9677
9678
9679
9680
9681
9682
9683
9684
9685
9686
9687
9688
9689
9690
9691
9692
9693
9694
9695
9696
9697
9698
9699
9700
9701
9702
9703
9704
9705
9706
9707
9708
9709
9710
9711
9712
9713
9714
9715
9716
9717
9718
9719
9720
9721
9722
9723
9724
9725
9726
9727
9728
9729
9730
9731
9732
9733
9734
9735
9736
9737
9738
9739
9740
9741
9742
9743
9744
9745
9746
9747
9748
9749
9750
9751
9752
9753
9754
9755
9756
9757
9758
9759
9760
9761
9762
9763
9764
9765
9766
9767
9768
9769
9770
9771
9772
9773
9774
9775
9776
9777
9778
9779
9780
9781
9782
9783
9784
9785
9786
9787
9788
9789
9790
9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
9809
9810
9811
9812
9813
9814
9815
9816
9817
9818
9819
9820
9821
9822
9823
9824
9825
9826
9827
9828
9829
9830
9831
9832
9833
9834
9835
9836
9837
9838
9839
9840
9841
9842
9843
9844
9845
9846
9847
9848
9849
9850
9851
9852
9853
9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
9866
9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
9881
9882
9883
9884
9885
9886
9887
9888
9889
9890
9891
9892
9893
9894
9895
9896
9897
9898
9899
9900
9901
9902
9903
9904
9905
9906
9907
9908
9909
9910
9911
9912
9913
9914
9915
9916
9917
9918
9919
9920
9921
9922
9923
9924
9925
9926
9927
9928
9929
9930
9931
9932
9933
9934
9935
9936
9937
9938
9939
9940
9941
9942
9943
9944
9945
9946
9947
9948
9949
9950
9951
9952
9953
9954
9955
9956
9957
9958
9959
9960
9961
9962
9963
9964
9965
9966
9967
9968
9969
9970
9971
9972
9973
9974
9975
9976
9977
9978
9979
9980
9981
9982
9983
9984
9985
9986
9987
9988
9989
9990
9991
9992
9993
9994
9995
9996
9997
9998
9999
10000
10001
10002
10003
10004
10005
10006
10007
10008
10009
10010
10011
10012
10013
10014
10015
10016
10017
10018
10019
10020
10021
10022
10023
10024
10025
10026
10027
10028
10029
10030
10031
10032
10033
10034
10035
10036
10037
10038
10039
10040
10041
10042
10043
10044
10045
10046
10047
10048
10049
10050
10051
10052
10053
10054
10055
10056
10057
10058
10059
10060
10061
10062
10063
10064
10065
10066
10067
10068
10069
10070
10071
10072
10073
10074
10075
10076
10077
10078
10079
10080
10081
10082
10083
10084
10085
10086
10087
10088
10089
10090
10091
10092
10093
10094
10095
10096
10097
10098
10099
10100
10101
10102
10103
10104
10105
10106
10107
10108
10109
10110
10111
10112
10113
10114
10115
10116
10117
10118
10119
10120
10121
10122
10123
10124
10125
10126
10127
10128
10129
10130
10131
10132
10133
10134
10135
10136
10137
10138
10139
10140
10141
10142
10143
10144
10145
10146
10147
10148
10149
10150
10151
10152
10153
10154
10155
10156
10157
10158
10159
10160
10161
10162
10163
10164
10165
10166
10167
10168
10169
10170
10171
10172
10173
10174
10175
10176
10177
10178
10179
10180
10181
10182
10183
10184
10185
10186
10187
10188
10189
10190
10191
10192
10193
10194
10195
10196
10197
10198
10199
10200
10201
10202
10203
10204
10205
10206
10207
10208
10209
10210
10211
10212
10213
10214
10215
10216
10217
10218
10219
10220
10221
10222
10223
10224
10225
10226
10227
10228
10229
10230
10231
10232
10233
10234
10235
10236
10237
10238
10239
10240
10241
10242
10243
10244
10245
10246
10247
10248
10249
10250
10251
10252
10253
10254
10255
10256
10257
10258
10259
10260
10261
10262
10263
10264
10265
10266
10267
10268
10269
10270
10271
10272
10273
10274
10275
10276
10277
10278
10279
10280
10281
10282
10283
10284
10285
10286
10287
10288
10289
10290
10291
10292
10293
10294
10295
10296
10297
10298
10299
10300
10301
10302
10303
10304
10305
10306
10307
10308
10309
10310
10311
10312
10313
10314
10315
10316
10317
10318
10319
10320
10321
10322
10323
10324
10325
10326
10327
10328
10329
10330
10331
10332
10333
10334
10335
10336
10337
10338
10339
10340
10341
10342
10343
10344
10345
10346
10347
10348
10349
10350
10351
10352
10353
10354
10355
10356
10357
10358
10359
10360
10361
10362
10363
10364
10365
10366
10367
10368
10369
10370
10371
10372
10373
10374
10375
10376
10377
10378
10379
10380
10381
10382
10383
10384
10385
10386
10387
10388
10389
10390
10391
10392
10393
10394
10395
10396
10397
10398
10399
10400
10401
10402
10403
10404
10405
10406
10407
10408
10409
10410
10411
10412
10413
10414
10415
10416
10417
10418
10419
10420
10421
10422
10423
10424
10425
10426
10427
10428
10429
10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
10470
10471
10472
10473
10474
10475
10476
10477
10478
10479
10480
10481
10482
10483
10484
10485
10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
10504
10505
10506
10507
10508
10509
10510
10511
10512
10513
10514
10515
10516
10517
10518
10519
10520
10521
10522
10523
10524
10525
10526
10527
10528
10529
10530
10531
10532
10533
10534
10535
10536
10537
10538
10539
10540
10541
10542
10543
10544
10545
10546
10547
10548
10549
10550
10551
10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
10564
10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
10579
10580
10581
10582
10583
10584
10585
10586
10587
10588
10589
10590
10591
10592
10593
10594
10595
10596
10597
10598
10599
10600
10601
10602
10603
10604
10605
10606
10607
10608
10609
10610
10611
10612
10613
10614
10615
10616
10617
10618
10619
10620
10621
10622
10623
10624
10625
10626
10627
10628
10629
10630
10631
10632
10633
10634
10635
10636
10637
10638
10639
10640
10641
10642
10643
10644
10645
10646
10647
10648
10649
10650
10651
10652
10653
10654
10655
10656
10657
10658
10659
10660
10661
10662
10663
10664
10665
10666
10667
10668
10669
10670
10671
10672
10673
10674
10675
10676
10677
10678
10679
10680
10681
10682
10683
10684
10685
10686
10687
10688
10689
10690
10691
10692
10693
10694
10695
10696
10697
10698
10699
10700
10701
10702
10703
10704
10705
10706
10707
10708
10709
10710
10711
10712
10713
10714
10715
10716
10717
10718
10719
10720
10721
10722
10723
10724
10725
10726
10727
10728
10729
10730
10731
10732
10733
10734
10735
10736
10737
10738
10739
10740
10741
10742
10743
10744
10745
10746
10747
10748
10749
10750
10751
10752
10753
10754
10755
10756
10757
10758
10759
10760
10761
10762
10763
10764
10765
10766
10767
10768
10769
10770
10771
10772
10773
10774
10775
10776
10777
10778
10779
10780
10781
10782
10783
10784
10785
10786
10787
10788
10789
10790
10791
10792
10793
10794
10795
10796
10797
10798
10799
10800
10801
10802
10803
10804
10805
10806
10807
10808
10809
10810
10811
10812
10813
10814
10815
10816
10817
10818
10819
10820
10821
10822
10823
10824
10825
10826
10827
10828
10829
10830
10831
10832
10833
10834
10835
10836
10837
10838
10839
10840
10841
10842
10843
10844
10845
10846
10847
10848
10849
10850
10851
10852
10853
10854
10855
10856
10857
10858
10859
10860
10861
10862
10863
10864
10865
10866
10867
10868
10869
10870
10871
10872
10873
10874
10875
10876
10877
10878
10879
10880
10881
10882
10883
10884
10885
10886
10887
10888
10889
10890
10891
10892
10893
10894
10895
10896
10897
10898
10899
10900
10901
10902
10903
10904
10905
10906
10907
10908
10909
10910
10911
10912
10913
10914
10915
10916
10917
10918
10919
10920
10921
10922
10923
10924
10925
10926
10927
10928
10929
10930
10931
10932
10933
10934
10935
10936
10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
10988
10989
10990
10991
10992
10993
10994
10995
10996
10997
10998
10999
11000
11001
11002
11003
11004
11005
11006
11007
11008
11009
11010
11011
11012
11013
11014
11015
11016
11017
11018
11019
11020
11021
11022
11023
11024
11025
11026
11027
11028
11029
11030
11031
11032
11033
11034
11035
11036
11037
11038
11039
11040
11041
11042
11043
11044
11045
11046
11047
11048
11049
11050
11051
11052
11053
11054
11055
11056
11057
11058
11059
11060
11061
11062
11063
11064
11065
11066
11067
11068
11069
11070
11071
11072
11073
11074
11075
11076
11077
11078
11079
11080
11081
11082
11083
11084
11085
11086
11087
11088
11089
11090
11091
11092
11093
11094
11095
11096
11097
11098
11099
11100
11101
11102
11103
11104
11105
11106
11107
11108
11109
11110
11111
11112
11113
11114
11115
11116
11117
11118
11119
11120
11121
11122
11123
11124
11125
11126
11127
11128
11129
11130
11131
11132
11133
11134
11135
11136
11137
11138
11139
11140
11141
11142
11143
11144
11145
11146
11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
11158
11159
11160
11161
11162
11163
11164
11165
11166
11167
11168
11169
11170
11171
11172
11173
11174
11175
11176
11177
11178
11179
11180
11181
11182
11183
11184
11185
11186
11187
11188
11189
11190
11191
11192
11193
11194
11195
11196
11197
11198
11199
11200
11201
11202
11203
11204
11205
11206
11207
11208
11209
11210
11211
11212
11213
11214
11215
11216
11217
11218
11219
11220
11221
11222
11223
11224
11225
11226
11227
11228
11229
11230
11231
11232
11233
11234
11235
11236
11237
11238
11239
11240
11241
11242
11243
11244
11245
11246
11247
11248
11249
11250
11251
11252
11253
11254
11255
11256
11257
11258
11259
11260
11261
11262
11263
11264
11265
11266
11267
11268
11269
11270
11271
11272
11273
11274
11275
11276
11277
11278
11279
11280
11281
11282
11283
11284
11285
11286
11287
11288
11289
11290
11291
11292
11293
11294
11295
11296
11297
11298
11299
11300
11301
11302
11303
11304
11305
11306
11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
11349
11350
11351
11352
11353
11354
11355
11356
11357
11358
11359
11360
11361
11362
11363
11364
11365
11366
11367
11368
11369
11370
11371
11372
11373
11374
11375
11376
11377
11378
11379
11380
11381
11382
11383
11384
11385
11386
11387
11388
11389
11390
11391
11392
11393
11394
11395
11396
11397
11398
11399
11400
11401
11402
11403
11404
11405
11406
11407
11408
11409
11410
11411
11412
11413
11414
11415
11416
11417
11418
11419
11420
11421
11422
11423
11424
11425
11426
11427
11428
11429
11430
11431
11432
11433
11434
11435
11436
11437
11438
11439
11440
11441
11442
11443
11444
11445
11446
11447
11448
11449
11450
11451
11452
11453
11454
11455
11456
11457
11458
11459
11460
11461
11462
11463
11464
11465
11466
11467
11468
11469
11470
11471
11472
11473
11474
11475
11476
11477
11478
11479
11480
11481
11482
11483
11484
11485
11486
11487
11488
11489
11490
11491
11492
11493
11494
11495
11496
11497
11498
11499
11500
11501
11502
11503
11504
11505
11506
11507
11508
11509
11510
11511
11512
11513
11514
11515
11516
11517
11518
11519
11520
11521
11522
11523
11524
11525
11526
11527
11528
11529
11530
11531
11532
11533
11534
11535
11536
11537
11538
11539
11540
11541
11542
11543
11544
11545
11546
11547
11548
11549
11550
11551
11552
11553
11554
11555
11556
11557
11558
11559
11560
11561
11562
11563
11564
11565
11566
11567
11568
11569
11570
11571
11572
11573
11574
11575
11576
11577
11578
11579
11580
11581
11582
11583
11584
11585
11586
11587
11588
11589
11590
11591
11592
11593
11594
11595
11596
11597
11598
11599
11600
11601
11602
11603
11604
11605
11606
11607
11608
11609
11610
11611
11612
11613
11614
11615
11616
11617
11618
11619
11620
11621
11622
11623
11624
11625
11626
11627
11628
11629
11630
11631
11632
11633
11634
11635
11636
11637
11638
11639
11640
11641
11642
11643
11644
11645
11646
11647
11648
11649
11650
11651
11652
11653
11654
11655
11656
11657
11658
11659
11660
11661
11662
11663
11664
11665
11666
11667
11668
11669
11670
11671
11672
11673
11674
11675
11676
11677
11678
11679
11680
11681
11682
11683
11684
11685
11686
11687
11688
11689
11690
11691
11692
11693
11694
11695
11696
11697
11698
11699
11700
11701
11702
11703
11704
11705
11706
11707
11708
11709
11710
11711
11712
11713
11714
11715
11716
11717
11718
11719
11720
11721
11722
11723
11724
11725
11726
11727
11728
11729
11730
11731
11732
11733
11734
11735
11736
11737
11738
11739
11740
11741
11742
11743
11744
11745
11746
11747
11748
11749
11750
11751
11752
11753
11754
11755
11756
11757
11758
11759
11760
11761
11762
11763
11764
11765
11766
11767
11768
11769
11770
11771
11772
11773
11774
11775
11776
11777
11778
11779
11780
11781
11782
11783
11784
11785
11786
11787
11788
11789
11790
11791
11792
11793
11794
11795
11796
11797
11798
11799
11800
11801
11802
11803
11804
11805
11806
11807
11808
11809
11810
11811
11812
11813
11814
11815
11816
11817
11818
11819
11820
11821
11822
11823
11824
11825
11826
11827
11828
11829
11830
11831
11832
11833
11834
11835
11836
11837
11838
11839
11840
11841
11842
11843
11844
11845
11846
11847
11848
11849
11850
11851
11852
11853
11854
11855
11856
11857
11858
11859
11860
11861
11862
11863
11864
11865
11866
11867
11868
11869
11870
11871
11872
11873
11874
11875
11876
11877
11878
11879
11880
11881
11882
11883
11884
11885
11886
11887
11888
11889
11890
11891
11892
11893
11894
11895
11896
11897
11898
11899
11900
11901
11902
11903
11904
11905
11906
11907
11908
11909
11910
11911
11912
11913
11914
11915
11916
11917
11918
11919
11920
11921
11922
11923
11924
11925
11926
11927
11928
11929
11930
11931
11932
11933
11934
11935
11936
11937
11938
11939
11940
11941
11942
11943
11944
11945
11946
11947
11948
11949
11950
11951
11952
11953
11954
11955
11956
11957
11958
11959
11960
11961
11962
11963
11964
11965
11966
11967
11968
11969
11970
11971
11972
11973
11974
11975
11976
11977
11978
11979
11980
11981
11982
11983
11984
11985
11986
11987
11988
11989
11990
11991
11992
11993
11994
11995
11996
11997
11998
11999
12000
12001
12002
12003
12004
12005
12006
12007
12008
12009
12010
12011
12012
12013
12014
12015
12016
12017
12018
12019
12020
12021
12022
12023
12024
12025
12026
12027
12028
12029
12030
12031
12032
12033
12034
12035
12036
12037
12038
12039
12040
12041
12042
12043
12044
12045
12046
12047
12048
12049
12050
12051
12052
12053
12054
12055
12056
12057
12058
12059
12060
12061
12062
12063
12064
12065
12066
12067
12068
12069
12070
12071
12072
12073
12074
12075
12076
12077
12078
12079
12080
12081
12082
12083
12084
12085
12086
12087
12088
12089
12090
12091
12092
12093
12094
12095
12096
12097
12098
12099
12100
12101
12102
12103
12104
12105
12106
12107
12108
12109
12110
12111
12112
12113
12114
12115
12116
12117
12118
12119
12120
12121
12122
12123
12124
12125
12126
12127
12128
12129
12130
12131
12132
12133
12134
12135
12136
12137
12138
12139
12140
12141
12142
12143
12144
12145
12146
12147
12148
12149
12150
12151
12152
12153
12154
12155
12156
12157
12158
12159
12160
12161
12162
12163
12164
12165
12166
12167
12168
12169
12170
12171
12172
12173
12174
12175
12176
12177
12178
12179
12180
12181
12182
12183
12184
12185
12186
12187
12188
12189
12190
12191
12192
12193
12194
12195
12196
12197
12198
12199
12200
12201
12202
12203
12204
12205
12206
12207
12208
12209
12210
12211
12212
12213
12214
12215
12216
12217
12218
12219
12220
12221
12222
12223
12224
12225
12226
12227
12228
12229
12230
12231
12232
12233
12234
12235
12236
12237
12238
12239
12240
12241
12242
12243
12244
12245
12246
12247
12248
12249
12250
12251
12252
12253
12254
12255
12256
12257
12258
12259
12260
12261
12262
12263
12264
12265
12266
12267
12268
12269
12270
12271
12272
12273
12274
12275
12276
12277
12278
12279
12280
12281
12282
12283
12284
12285
12286
12287
12288
12289
12290
12291
12292
12293
12294
12295
12296
12297
12298
12299
12300
12301
12302
12303
12304
12305
12306
12307
12308
12309
12310
12311
12312
12313
12314
12315
12316
12317
12318
12319
12320
12321
12322
12323
12324
12325
12326
12327
12328
12329
12330
12331
12332
12333
12334
12335
12336
12337
12338
12339
12340
12341
12342
12343
12344
12345
12346
12347
12348
12349
12350
12351
12352
12353
12354
12355
12356
12357
12358
12359
12360
12361
12362
12363
12364
12365
12366
12367
12368
12369
12370
12371
12372
12373
12374
12375
12376
12377
12378
12379
12380
12381
12382
12383
12384
12385
12386
12387
12388
12389
12390
12391
12392
12393
12394
12395
12396
12397
12398
12399
12400
12401
12402
12403
12404
12405
12406
12407
12408
12409
12410
12411
12412
12413
12414
12415
12416
12417
12418
12419
12420
12421
12422
12423
12424
12425
12426
12427
12428
12429
12430
12431
12432
12433
12434
12435
12436
12437
12438
12439
12440
12441
12442
12443
12444
12445
12446
12447
12448
12449
12450
12451
12452
12453
12454
12455
12456
12457
12458
12459
12460
12461
12462
12463
12464
12465
12466
12467
12468
12469
12470
12471
12472
12473
12474
12475
12476
12477
12478
12479
12480
12481
12482
12483
12484
12485
12486
12487
12488
12489
12490
12491
12492
12493
12494
12495
12496
12497
12498
12499
12500
12501
12502
12503
12504
12505
12506
12507
12508
12509
12510
12511
12512
12513
12514
12515
12516
12517
12518
12519
12520
12521
12522
12523
12524
12525
12526
12527
12528
12529
12530
12531
12532
12533
12534
12535
12536
12537
12538
12539
12540
12541
12542
12543
12544
12545
12546
12547
12548
12549
12550
12551
12552
12553
12554
12555
12556
12557
12558
12559
12560
12561
12562
12563
12564
12565
12566
12567
12568
12569
12570
12571
12572
12573
12574
12575
12576
12577
12578
12579
12580
12581
12582
12583
12584
12585
12586
12587
12588
12589
12590
12591
12592
12593
12594
12595
12596
12597
12598
12599
12600
12601
12602
12603
12604
12605
12606
12607
12608
12609
12610
12611
12612
12613
12614
12615
12616
12617
12618
12619
12620
12621
12622
12623
12624
12625
12626
12627
12628
12629
12630
12631
12632
12633
12634
12635
12636
12637
12638
12639
12640
12641
12642
12643
12644
12645
12646
12647
12648
12649
12650
12651
12652
12653
12654
12655
12656
12657
12658
12659
12660
12661
12662
12663
12664
12665
12666
12667
12668
12669
12670
12671
12672
12673
12674
12675
12676
12677
12678
12679
12680
12681
12682
12683
12684
12685
12686
12687
12688
12689
12690
12691
12692
12693
12694
12695
12696
12697
12698
12699
12700
12701
12702
12703
12704
12705
12706
12707
12708
12709
12710
12711
12712
12713
12714
12715
12716
12717
12718
12719
12720
12721
12722
12723
12724
12725
12726
12727
12728
12729
12730
12731
12732
12733
12734
12735
12736
12737
12738
12739
12740
12741
12742
12743
12744
12745
12746
12747
12748
12749
12750
12751
12752
12753
12754
12755
12756
12757
12758
12759
12760
12761
12762
12763
12764
12765
12766
12767
12768
12769
12770
12771
12772
12773
12774
12775
12776
12777
12778
12779
12780
12781
12782
12783
12784
12785
12786
12787
12788
12789
12790
12791
12792
12793
12794
12795
12796
12797
12798
12799
12800
12801
12802
12803
12804
12805
12806
12807
12808
12809
12810
12811
12812
12813
12814
12815
12816
12817
12818
12819
12820
12821
12822
12823
12824
12825
12826
12827
12828
12829
12830
12831
12832
12833
12834
12835
12836
12837
12838
12839
12840
12841
12842
12843
12844
12845
12846
12847
12848
12849
12850
12851
12852
12853
12854
12855
12856
12857
12858
12859
12860
12861
12862
12863
12864
12865
12866
12867
12868
12869
12870
12871
12872
12873
12874
12875
12876
12877
12878
12879
12880
12881
12882
12883
12884
12885
12886
12887
12888
12889
12890
12891
12892
12893
12894
12895
12896
12897
12898
12899
12900
12901
12902
12903
12904
12905
12906
12907
12908
12909
12910
12911
12912
12913
12914
12915
12916
12917
12918
12919
12920
12921
12922
12923
12924
12925
12926
12927
12928
12929
12930
12931
12932
12933
12934
12935
12936
12937
12938
12939
12940
12941
12942
12943
12944
12945
12946
12947
12948
12949
12950
12951
12952
12953
12954
12955
12956
12957
12958
12959
12960
12961
12962
12963
12964
12965
12966
12967
12968
12969
12970
12971
12972
12973
12974
12975
12976
12977
12978
12979
12980
12981
12982
12983
12984
12985
12986
12987
12988
12989
12990
12991
12992
12993
12994
12995
12996
12997
12998
12999
13000
13001
13002
13003
13004
13005
13006
13007
13008
13009
13010
13011
13012
13013
13014
13015
13016
13017
13018
13019
13020
13021
13022
13023
13024
13025
13026
13027
13028
13029
13030
13031
13032
13033
13034
13035
13036
13037
13038
13039
13040
13041
13042
13043
13044
13045
13046
13047
13048
13049
13050
13051
13052
13053
13054
13055
13056
13057
13058
13059
13060
13061
13062
13063
13064
13065
13066
13067
13068
13069
13070
13071
13072
13073
13074
13075
13076
13077
13078
13079
13080
13081
13082
13083
13084
13085
13086
13087
13088
13089
13090
13091
13092
13093
13094
13095
13096
13097
13098
13099
13100
13101
13102
13103
13104
13105
13106
13107
13108
13109
13110
13111
13112
13113
13114
13115
13116
13117
13118
13119
13120
13121
13122
13123
13124
13125
13126
13127
13128
13129
13130
13131
13132
13133
13134
13135
13136
13137
13138
13139
13140
13141
13142
13143
13144
13145
13146
13147
13148
13149
13150
13151
13152
13153
13154
13155
13156
13157
13158
13159
13160
13161
13162
13163
13164
13165
13166
13167
13168
13169
13170
13171
13172
13173
13174
13175
13176
13177
13178
13179
13180
13181
13182
13183
13184
13185
13186
13187
13188
13189
13190
13191
13192
13193
13194
13195
13196
13197
13198
13199
13200
13201
13202
13203
13204
13205
13206
13207
13208
13209
13210
13211
13212
13213
13214
13215
13216
13217
13218
13219
13220
13221
13222
13223
13224
13225
13226
13227
13228
13229
13230
13231
13232
13233
13234
13235
13236
13237
13238
13239
13240
13241
13242
13243
13244
13245
13246
13247
13248
13249
13250
13251
13252
13253
13254
13255
13256
13257
13258
13259
13260
13261
13262
13263
13264
13265
13266
13267
13268
13269
13270
13271
13272
13273
13274
13275
13276
13277
13278
13279
13280
13281
13282
13283
13284
13285
13286
13287
13288
13289
13290
13291
13292
13293
13294
13295
13296
13297
13298
13299
13300
13301
13302
13303
13304
13305
13306
13307
13308
13309
13310
13311
13312
13313
13314
13315
13316
13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
13339
13340
13341
13342
13343
13344
13345
13346
13347
13348
13349
13350
13351
13352
13353
13354
13355
13356
13357
13358
13359
13360
13361
13362
13363
13364
13365
13366
13367
13368
13369
13370
13371
13372
13373
13374
13375
13376
13377
13378
13379
13380
13381
13382
13383
13384
13385
13386
13387
13388
13389
13390
13391
13392
13393
13394
13395
13396
13397
13398
13399
13400
13401
13402
13403
13404
13405
13406
13407
13408
13409
13410
13411
13412
13413
13414
13415
13416
13417
13418
13419
13420
13421
13422
13423
13424
13425
13426
13427
13428
13429
13430
13431
13432
13433
13434
13435
13436
13437
13438
13439
13440
13441
13442
13443
13444
13445
13446
13447
13448
13449
13450
13451
13452
13453
13454
13455
13456
13457
13458
13459
13460
13461
13462
13463
13464
13465
13466
13467
13468
13469
13470
13471
13472
13473
13474
13475
13476
13477
13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
13502
13503
13504
13505
13506
13507
13508
13509
13510
13511
13512
13513
13514
13515
13516
13517
13518
13519
13520
13521
13522
13523
13524
13525
13526
13527
13528
13529
13530
13531
13532
13533
13534
13535
13536
13537
13538
13539
13540
13541
13542
13543
13544
13545
13546
13547
13548
13549
13550
13551
13552
13553
13554
13555
13556
13557
13558
13559
13560
13561
13562
13563
13564
13565
13566
13567
13568
13569
13570
13571
13572
13573
13574
13575
13576
13577
13578
13579
13580
13581
13582
13583
13584
13585
13586
13587
13588
13589
13590
13591
13592
13593
13594
13595
13596
13597
13598
13599
13600
13601
13602
13603
13604
13605
13606
13607
13608
13609
13610
13611
13612
13613
13614
13615
13616
13617
13618
13619
13620
13621
13622
13623
13624
13625
13626
13627
13628
13629
13630
13631
13632
13633
13634
13635
13636
13637
13638
13639
13640
13641
13642
13643
13644
13645
13646
13647
13648
13649
13650
13651
13652
13653
13654
13655
13656
13657
13658
13659
13660
13661
13662
13663
13664
13665
13666
13667
13668
13669
13670
13671
13672
13673
13674
13675
13676
13677
13678
13679
13680
13681
13682
13683
13684
13685
13686
13687
13688
13689
13690
13691
13692
13693
13694
13695
13696
13697
13698
13699
13700
13701
13702
13703
13704
13705
13706
13707
13708
13709
13710
13711
13712
13713
13714
13715
13716
13717
13718
13719
13720
13721
13722
13723
13724
13725
13726
13727
13728
13729
13730
13731
13732
13733
13734
13735
13736
13737
13738
13739
13740
13741
13742
13743
13744
13745
13746
13747
13748
13749
13750
13751
13752
13753
13754
13755
13756
13757
13758
13759
13760
13761
13762
13763
13764
13765
13766
13767
13768
13769
13770
13771
13772
13773
13774
13775
13776
13777
13778
13779
13780
13781
13782
13783
13784
13785
13786
13787
13788
13789
13790
13791
13792
13793
13794
13795
13796
13797
13798
13799
13800
13801
13802
13803
13804
13805
13806
13807
13808
13809
13810
13811
13812
13813
13814
13815
13816
13817
13818
13819
13820
13821
13822
13823
13824
13825
13826
13827
13828
13829
13830
13831
13832
13833
13834
13835
13836
13837
13838
13839
13840
13841
13842
13843
13844
13845
13846
13847
13848
13849
13850
13851
13852
13853
13854
13855
13856
13857
13858
13859
13860
13861
13862
13863
13864
13865
13866
13867
13868
13869
13870
13871
13872
13873
13874
13875
13876
13877
13878
13879
13880
13881
13882
13883
13884
13885
13886
13887
13888
13889
13890
13891
13892
13893
13894
13895
13896
13897
13898
13899
13900
13901
13902
13903
13904
13905
13906
13907
13908
13909
13910
13911
13912
13913
13914
13915
13916
13917
13918
13919
13920
13921
13922
13923
13924
13925
13926
13927
13928
13929
13930
13931
13932
13933
13934
13935
13936
13937
13938
13939
13940
13941
13942
13943
13944
13945
13946
13947
13948
13949
13950
13951
13952
13953
13954
13955
13956
13957
13958
13959
13960
13961
13962
13963
13964
13965
13966
13967
13968
13969
13970
13971
13972
13973
13974
13975
13976
13977
13978
13979
13980
13981
13982
13983
13984
13985
13986
13987
13988
13989
13990
13991
13992
13993
13994
13995
13996
13997
13998
13999
14000
14001
14002
14003
14004
14005
14006
14007
14008
14009
14010
14011
14012
14013
14014
14015
14016
14017
14018
14019
14020
14021
14022
14023
14024
14025
14026
14027
14028
14029
14030
14031
14032
14033
14034
14035
14036
14037
14038
14039
14040
14041
14042
14043
14044
14045
14046
14047
14048
14049
14050
14051
14052
14053
14054
14055
14056
14057
14058
14059
14060
14061
14062
14063
14064
14065
14066
14067
14068
14069
14070
14071
14072
14073
14074
14075
14076
14077
14078
14079
14080
14081
14082
14083
14084
14085
14086
14087
14088
14089
14090
14091
14092
14093
14094
14095
14096
14097
14098
14099
14100
14101
14102
14103
14104
14105
14106
14107
14108
14109
14110
14111
14112
14113
14114
14115
14116
14117
14118
14119
14120
14121
14122
14123
14124
14125
14126
14127
14128
14129
14130
14131
14132
14133
14134
14135
14136
14137
14138
14139
14140
14141
14142
14143
14144
14145
14146
14147
14148
14149
14150
14151
14152
14153
14154
14155
14156
14157
14158
14159
14160
14161
14162
14163
14164
14165
14166
14167
14168
14169
14170
14171
14172
14173
14174
14175
14176
14177
14178
14179
14180
14181
14182
14183
14184
14185
14186
14187
14188
14189
14190
14191
14192
14193
14194
14195
14196
14197
14198
14199
14200
14201
14202
14203
14204
14205
14206
14207
14208
14209
14210
14211
14212
14213
14214
14215
14216
14217
14218
14219
14220
14221
14222
14223
14224
14225
14226
14227
14228
14229
14230
14231
14232
14233
14234
14235
14236
14237
14238
14239
14240
14241
14242
14243
14244
14245
14246
14247
14248
14249
14250
14251
14252
14253
14254
14255
14256
14257
14258
14259
14260
14261
14262
14263
14264
14265
14266
14267
14268
14269
14270
14271
14272
14273
14274
14275
14276
14277
14278
14279
14280
14281
14282
14283
14284
14285
14286
14287
14288
14289
14290
14291
14292
14293
14294
14295
14296
14297
14298
14299
14300
14301
14302
14303
14304
14305
14306
14307
14308
14309
14310
14311
14312
14313
14314
14315
14316
14317
14318
14319
14320
14321
14322
14323
14324
14325
14326
14327
14328
14329
14330
14331
14332
14333
14334
14335
14336
14337
14338
14339
14340
14341
14342
14343
14344
14345
14346
14347
14348
14349
14350
14351
14352
14353
14354
14355
14356
14357
14358
14359
14360
14361
14362
14363
14364
14365
14366
14367
14368
14369
14370
14371
14372
14373
14374
14375
14376
14377
14378
14379
14380
14381
14382
14383
14384
14385
14386
14387
14388
14389
14390
14391
14392
14393
14394
14395
14396
14397
14398
14399
14400
14401
14402
14403
14404
14405
14406
14407
14408
14409
14410
14411
14412
14413
14414
14415
14416
14417
14418
14419
14420
14421
14422
14423
14424
14425
14426
14427
14428
14429
14430
14431
14432
14433
14434
14435
14436
14437
14438
14439
14440
14441
14442
14443
14444
14445
14446
14447
14448
14449
14450
14451
14452
14453
14454
14455
14456
14457
14458
14459
14460
14461
14462
14463
14464
14465
14466
14467
14468
14469
14470
14471
14472
14473
14474
14475
14476
14477
14478
14479
14480
14481
14482
14483
14484
14485
14486
14487
14488
14489
14490
14491
14492
14493
14494
14495
14496
14497
14498
14499
14500
14501
14502
14503
14504
14505
14506
14507
14508
14509
14510
14511
14512
14513
14514
14515
14516
14517
14518
14519
14520
14521
14522
14523
14524
14525
14526
14527
14528
14529
14530
14531
14532
14533
14534
14535
14536
14537
14538
14539
14540
14541
14542
14543
14544
14545
14546
14547
14548
14549
14550
14551
14552
14553
14554
14555
14556
14557
14558
14559
14560
14561
14562
14563
14564
14565
14566
14567
14568
14569
14570
14571
14572
14573
14574
14575
14576
14577
14578
14579
14580
14581
14582
14583
14584
14585
14586
14587
14588
14589
14590
14591
14592
14593
14594
14595
14596
14597
14598
14599
14600
14601
14602
14603
14604
14605
14606
14607
14608
14609
14610
14611
14612
14613
14614
14615
14616
14617
14618
14619
14620
14621
14622
14623
14624
14625
14626
14627
14628
14629
14630
14631
14632
14633
14634
14635
14636
14637
14638
14639
14640
14641
14642
14643
14644
14645
14646
14647
14648
14649
14650
14651
14652
14653
14654
14655
14656
14657
14658
14659
14660
14661
14662
14663
14664
14665
14666
14667
14668
14669
14670
14671
14672
14673
14674
14675
14676
14677
14678
14679
14680
14681
14682
14683
14684
14685
14686
14687
14688
14689
14690
14691
14692
14693
14694
14695
14696
14697
14698
14699
14700
14701
14702
14703
14704
14705
14706
14707
14708
14709
14710
14711
14712
14713
14714
14715
14716
14717
14718
14719
14720
14721
14722
14723
14724
14725
14726
14727
14728
14729
14730
14731
14732
14733
14734
14735
14736
14737
14738
14739
14740
14741
14742
14743
14744
14745
14746
14747
14748
14749
14750
14751
14752
14753
14754
14755
14756
14757
14758
14759
14760
14761
14762
14763
14764
14765
14766
14767
14768
14769
14770
14771
14772
14773
14774
14775
14776
14777
14778
14779
14780
14781
14782
14783
14784
14785
14786
14787
14788
14789
14790
14791
14792
14793
14794
14795
14796
14797
14798
14799
14800
14801
14802
14803
14804
14805
14806
14807
14808
14809
14810
14811
14812
14813
14814
14815
14816
14817
14818
14819
14820
14821
14822
14823
14824
14825
14826
14827
14828
14829
14830
14831
14832
14833
14834
14835
14836
14837
14838
14839
14840
14841
14842
14843
14844
14845
14846
14847
14848
14849
14850
14851
14852
14853
14854
14855
14856
14857
14858
14859
14860
14861
14862
14863
14864
14865
14866
14867
14868
14869
14870
14871
14872
14873
14874
14875
14876
14877
14878
14879
14880
14881
14882
14883
14884
14885
14886
14887
14888
14889
14890
14891
14892
14893
14894
14895
14896
14897
14898
14899
14900
14901
14902
14903
14904
14905
14906
14907
14908
14909
14910
14911
14912
14913
14914
14915
14916
14917
14918
14919
14920
14921
14922
14923
14924
14925
14926
14927
14928
14929
14930
14931
14932
14933
14934
14935
14936
14937
14938
14939
14940
14941
14942
14943
14944
14945
14946
14947
14948
14949
14950
14951
14952
14953
14954
14955
14956
14957
14958
14959
14960
14961
14962
14963
14964
14965
14966
14967
14968
14969
14970
14971
14972
14973
14974
14975
14976
14977
14978
14979
14980
14981
14982
14983
14984
14985
14986
14987
14988
14989
14990
14991
14992
14993
14994
14995
14996
14997
14998
14999
15000
15001
15002
15003
15004
15005
15006
15007
15008
15009
15010
15011
15012
15013
15014
15015
15016
15017
15018
15019
15020
15021
15022
15023
15024
15025
15026
15027
15028
15029
15030
15031
15032
15033
15034
15035
15036
15037
15038
15039
15040
15041
15042
15043
15044
15045
15046
15047
15048
15049
15050
15051
15052
15053
15054
15055
15056
15057
15058
15059
15060
15061
15062
15063
15064
15065
15066
15067
15068
15069
15070
15071
15072
15073
15074
15075
15076
15077
15078
15079
15080
15081
15082
15083
15084
15085
15086
15087
15088
15089
15090
15091
15092
15093
15094
15095
15096
15097
15098
15099
15100
15101
15102
15103
15104
15105
15106
15107
15108
15109
15110
15111
15112
15113
15114
15115
15116
15117
15118
15119
15120
15121
15122
15123
15124
15125
15126
15127
15128
15129
15130
15131
15132
15133
15134
15135
15136
15137
15138
15139
15140
15141
15142
15143
15144
15145
15146
15147
15148
15149
15150
15151
15152
15153
15154
15155
15156
15157
15158
15159
15160
15161
15162
15163
15164
15165
15166
15167
15168
15169
15170
15171
15172
15173
15174
15175
15176
15177
15178
15179
15180
15181
15182
15183
15184
15185
15186
15187
15188
15189
15190
15191
15192
15193
15194
15195
15196
15197
15198
15199
15200
15201
15202
15203
15204
15205
15206
15207
15208
15209
15210
15211
15212
15213
15214
15215
15216
15217
15218
15219
15220
15221
15222
15223
15224
15225
15226
15227
15228
15229
15230
15231
15232
15233
15234
15235
15236
15237
15238
15239
15240
15241
15242
15243
15244
15245
15246
15247
15248
15249
15250
15251
15252
15253
15254
15255
15256
15257
15258
15259
15260
15261
15262
15263
15264
15265
15266
15267
15268
15269
15270
15271
15272
15273
15274
15275
15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
15290
15291
15292
15293
15294
15295
15296
15297
15298
15299
15300
15301
15302
15303
15304
15305
15306
15307
15308
15309
15310
15311
15312
15313
15314
15315
15316
15317
15318
15319
15320
15321
15322
15323
15324
15325
15326
15327
15328
15329
15330
15331
15332
15333
15334
15335
15336
15337
15338
15339
15340
15341
15342
15343
15344
15345
15346
15347
15348
15349
15350
15351
15352
15353
15354
15355
15356
15357
15358
15359
15360
15361
15362
15363
15364
15365
15366
15367
15368
15369
15370
15371
15372
15373
15374
15375
15376
15377
15378
15379
15380
15381
15382
15383
15384
15385
15386
15387
15388
15389
15390
15391
15392
15393
15394
15395
15396
15397
15398
15399
15400
15401
15402
15403
15404
15405
15406
15407
15408
15409
15410
15411
15412
15413
15414
15415
15416
15417
15418
15419
15420
15421
15422
15423
15424
15425
15426
15427
15428
15429
15430
15431
15432
15433
15434
15435
15436
15437
15438
15439
15440
15441
15442
15443
15444
15445
15446
15447
15448
15449
15450
15451
15452
15453
15454
15455
15456
15457
15458
15459
15460
15461
15462
15463
15464
15465
15466
15467
15468
15469
15470
15471
15472
15473
15474
15475
15476
15477
15478
15479
15480
15481
15482
15483
15484
15485
15486
15487
15488
15489
15490
15491
15492
15493
15494
15495
15496
15497
15498
15499
15500
15501
15502
15503
15504
15505
15506
15507
15508
15509
15510
15511
15512
15513
15514
15515
15516
15517
15518
15519
15520
15521
15522
15523
15524
15525
15526
15527
15528
15529
15530
15531
15532
15533
15534
15535
15536
15537
15538
15539
15540
15541
15542
15543
15544
15545
15546
15547
15548
15549
15550
15551
15552
15553
15554
15555
15556
15557
15558
15559
15560
15561
15562
15563
15564
15565
15566
15567
15568
15569
15570
15571
15572
15573
15574
15575
15576
15577
15578
15579
15580
15581
15582
15583
15584
15585
15586
15587
15588
15589
15590
15591
15592
15593
15594
15595
15596
15597
15598
15599
15600
15601
15602
15603
15604
15605
15606
15607
15608
15609
15610
15611
15612
15613
15614
15615
15616
15617
15618
15619
15620
15621
15622
15623
15624
15625
15626
15627
15628
15629
15630
15631
15632
15633
15634
15635
15636
15637
15638
15639
15640
15641
15642
15643
15644
15645
15646
15647
15648
15649
15650
15651
15652
15653
15654
15655
15656
15657
15658
15659
15660
15661
15662
15663
15664
15665
15666
15667
15668
15669
15670
15671
15672
15673
15674
15675
15676
15677
15678
15679
15680
15681
15682
15683
15684
15685
15686
15687
15688
15689
15690
15691
15692
15693
15694
15695
15696
15697
15698
15699
15700
15701
15702
15703
15704
15705
15706
15707
15708
15709
15710
15711
15712
15713
15714
15715
15716
15717
15718
15719
15720
15721
15722
15723
15724
15725
15726
15727
15728
15729
15730
15731
15732
15733
15734
15735
15736
15737
15738
15739
15740
15741
15742
15743
15744
15745
15746
15747
15748
15749
15750
15751
15752
15753
15754
15755
15756
15757
15758
15759
15760
15761
15762
15763
15764
15765
15766
15767
15768
15769
15770
15771
15772
15773
15774
15775
15776
15777
15778
15779
15780
15781
15782
15783
15784
15785
15786
15787
15788
15789
15790
15791
15792
15793
15794
15795
15796
15797
15798
15799
15800
15801
15802
15803
15804
15805
15806
15807
15808
15809
15810
15811
15812
15813
15814
15815
15816
15817
15818
15819
15820
15821
15822
15823
15824
15825
15826
15827
15828
15829
15830
15831
15832
15833
15834
15835
15836
15837
15838
15839
15840
15841
15842
15843
15844
15845
15846
15847
15848
15849
15850
15851
15852
15853
15854
15855
15856
15857
15858
15859
15860
15861
15862
15863
15864
15865
15866
15867
15868
15869
15870
15871
15872
15873
15874
15875
15876
15877
15878
15879
15880
15881
15882
15883
15884
15885
15886
15887
15888
15889
15890
15891
15892
15893
15894
15895
15896
15897
15898
15899
15900
15901
15902
15903
15904
15905
15906
15907
15908
15909
15910
15911
15912
15913
15914
15915
15916
15917
15918
15919
15920
15921
15922
15923
15924
15925
15926
15927
15928
15929
15930
15931
15932
15933
15934
15935
15936
15937
15938
15939
15940
15941
15942
15943
15944
15945
15946
15947
15948
15949
15950
15951
15952
15953
15954
15955
15956
15957
15958
15959
15960
15961
15962
15963
15964
15965
15966
15967
15968
15969
15970
15971
15972
15973
15974
15975
15976
15977
15978
15979
15980
15981
15982
15983
15984
15985
15986
15987
15988
15989
15990
15991
15992
15993
15994
15995
15996
15997
15998
15999
16000
16001
16002
16003
16004
16005
16006
16007
16008
16009
16010
16011
16012
16013
16014
16015
16016
16017
16018
16019
16020
16021
16022
16023
16024
16025
16026
16027
16028
16029
16030
16031
16032
16033
16034
16035
16036
16037
16038
16039
16040
16041
16042
16043
16044
16045
16046
16047
16048
16049
16050
16051
16052
16053
16054
16055
16056
16057
16058
16059
16060
16061
16062
16063
16064
16065
16066
16067
16068
16069
16070
16071
16072
16073
16074
16075
16076
16077
16078
16079
16080
16081
16082
16083
16084
16085
16086
16087
16088
16089
16090
16091
16092
16093
16094
16095
16096
16097
16098
16099
16100
16101
16102
16103
16104
16105
16106
16107
16108
16109
16110
16111
16112
16113
16114
16115
16116
16117
16118
16119
16120
16121
16122
16123
16124
16125
16126
16127
16128
16129
16130
16131
16132
16133
16134
16135
16136
16137
16138
16139
16140
16141
16142
16143
16144
16145
16146
16147
16148
16149
16150
16151
16152
16153
16154
16155
16156
16157
16158
16159
16160
16161
16162
16163
16164
16165
16166
16167
16168
16169
16170
16171
16172
16173
16174
16175
16176
16177
16178
16179
16180
16181
16182
16183
16184
16185
16186
16187
16188
16189
16190
16191
16192
16193
16194
16195
16196
16197
16198
16199
16200
16201
16202
16203
16204
16205
16206
16207
16208
16209
16210
16211
16212
16213
16214
16215
16216
16217
16218
16219
16220
16221
16222
16223
16224
16225
16226
16227
16228
16229
16230
16231
16232
16233
16234
16235
16236
16237
16238
16239
16240
16241
16242
16243
16244
16245
16246
16247
16248
16249
16250
16251
16252
16253
16254
16255
16256
16257
16258
16259
16260
16261
16262
16263
16264
16265
16266
16267
16268
16269
16270
16271
16272
16273
16274
16275
16276
16277
16278
16279
16280
16281
16282
16283
16284
16285
16286
16287
16288
16289
16290
16291
16292
16293
16294
16295
16296
16297
16298
16299
16300
16301
16302
16303
16304
16305
16306
16307
16308
16309
16310
16311
16312
16313
16314
16315
16316
16317
16318
16319
16320
16321
16322
16323
16324
16325
16326
16327
16328
16329
16330
16331
16332
16333
16334
16335
16336
16337
16338
16339
16340
16341
16342
16343
16344
16345
16346
16347
16348
16349
16350
16351
16352
16353
16354
16355
16356
16357
16358
16359
16360
16361
16362
16363
16364
16365
16366
16367
16368
16369
16370
16371
16372
16373
16374
16375
16376
16377
16378
16379
16380
16381
16382
16383
16384
16385
16386
16387
16388
16389
16390
16391
16392
16393
16394
16395
16396
16397
16398
16399
16400
16401
16402
16403
16404
16405
16406
16407
16408
16409
16410
16411
16412
16413
16414
16415
16416
16417
16418
16419
16420
16421
16422
16423
16424
16425
16426
16427
16428
16429
16430
16431
16432
16433
16434
16435
16436
16437
16438
16439
16440
16441
16442
16443
16444
16445
16446
16447
16448
16449
16450
16451
16452
16453
16454
16455
16456
16457
16458
16459
16460
16461
16462
16463
16464
16465
16466
16467
16468
16469
16470
16471
16472
16473
16474
16475
16476
16477
16478
16479
16480
16481
16482
16483
16484
16485
16486
16487
16488
16489
16490
16491
16492
16493
16494
16495
16496
16497
16498
16499
16500
16501
16502
16503
16504
16505
16506
16507
16508
16509
16510
16511
16512
16513
16514
16515
16516
16517
16518
16519
16520
16521
16522
16523
16524
16525
16526
16527
16528
16529
16530
16531
16532
16533
16534
16535
16536
16537
16538
16539
16540
16541
16542
16543
16544
16545
16546
16547
16548
16549
16550
16551
16552
16553
16554
16555
16556
16557
16558
16559
16560
16561
16562
16563
16564
16565
16566
16567
16568
16569
16570
16571
16572
16573
16574
16575
16576
16577
16578
16579
16580
16581
16582
16583
16584
16585
16586
16587
16588
16589
16590
16591
16592
16593
16594
16595
16596
16597
16598
16599
16600
16601
16602
16603
16604
16605
16606
16607
16608
16609
16610
16611
16612
16613
16614
16615
16616
16617
16618
16619
16620
16621
16622
16623
16624
16625
16626
16627
16628
16629
16630
16631
16632
16633
16634
16635
16636
16637
16638
16639
16640
16641
16642
16643
16644
16645
16646
16647
16648
16649
16650
16651
16652
16653
16654
16655
16656
16657
16658
16659
16660
16661
16662
16663
16664
16665
16666
16667
16668
16669
16670
16671
16672
16673
16674
16675
16676
16677
16678
16679
16680
16681
16682
16683
16684
16685
16686
16687
16688
16689
16690
16691
16692
16693
16694
16695
16696
16697
16698
16699
16700
16701
16702
16703
16704
16705
16706
16707
16708
16709
16710
16711
16712
16713
16714
16715
16716
16717
16718
16719
16720
16721
16722
16723
16724
16725
16726
16727
16728
16729
16730
16731
16732
16733
16734
16735
16736
16737
16738
16739
16740
16741
16742
16743
16744
16745
16746
16747
16748
16749
16750
16751
16752
16753
16754
16755
16756
16757
16758
16759
16760
16761
16762
16763
16764
16765
16766
16767
16768
16769
16770
16771
16772
16773
16774
16775
16776
16777
16778
16779
16780
16781
16782
16783
16784
16785
16786
16787
16788
16789
16790
16791
16792
16793
16794
16795
16796
16797
16798
16799
16800
16801
16802
16803
16804
16805
16806
16807
16808
16809
16810
16811
16812
16813
16814
16815
16816
16817
16818
16819
16820
16821
16822
16823
16824
16825
16826
16827
16828
16829
16830
16831
16832
16833
16834
16835
16836
16837
16838
16839
16840
16841
16842
16843
16844
16845
16846
16847
16848
16849
16850
16851
16852
16853
16854
16855
16856
16857
16858
16859
16860
16861
16862
16863
16864
16865
16866
16867
16868
16869
16870
16871
16872
16873
16874
16875
16876
16877
16878
16879
16880
16881
16882
16883
16884
16885
16886
16887
16888
16889
16890
16891
16892
16893
16894
16895
16896
16897
16898
16899
16900
16901
16902
16903
16904
16905
16906
16907
16908
16909
16910
16911
16912
16913
16914
16915
16916
16917
16918
16919
16920
16921
16922
16923
16924
16925
16926
16927
16928
16929
16930
16931
16932
16933
16934
16935
16936
16937
16938
16939
16940
16941
16942
16943
16944
16945
16946
16947
16948
16949
16950
16951
16952
16953
16954
16955
16956
16957
16958
16959
16960
16961
16962
16963
16964
16965
16966
16967
16968
16969
16970
16971
16972
16973
16974
16975
16976
16977
16978
16979
16980
16981
16982
16983
16984
16985
16986
16987
16988
16989
16990
16991
16992
16993
16994
16995
16996
16997
16998
16999
17000
17001
17002
17003
17004
17005
17006
17007
17008
17009
17010
17011
17012
17013
17014
17015
17016
17017
17018
17019
17020
17021
17022
17023
17024
17025
17026
17027
17028
17029
17030
17031
17032
17033
17034
17035
17036
17037
17038
17039
17040
17041
17042
17043
17044
17045
17046
17047
17048
17049
17050
17051
17052
17053
17054
17055
17056
17057
17058
17059
17060
17061
17062
17063
17064
17065
17066
17067
17068
17069
17070
17071
17072
17073
17074
17075
17076
17077
17078
17079
17080
17081
17082
17083
17084
17085
17086
17087
17088
17089
17090
17091
17092
17093
17094
17095
17096
17097
17098
17099
17100
17101
17102
17103
17104
17105
17106
17107
17108
17109
17110
17111
17112
17113
17114
17115
17116
17117
17118
17119
17120
17121
17122
17123
17124
17125
17126
17127
17128
17129
17130
17131
17132
17133
17134
17135
17136
17137
17138
17139
17140
17141
17142
17143
17144
17145
17146
17147
17148
17149
17150
17151
17152
17153
17154
17155
17156
17157
17158
17159
17160
17161
17162
17163
17164
17165
17166
17167
17168
17169
17170
17171
17172
17173
17174
17175
17176
17177
17178
17179
17180
17181
17182
17183
17184
17185
17186
17187
17188
17189
17190
17191
17192
17193
17194
17195
17196
17197
17198
17199
17200
17201
17202
17203
17204
17205
17206
17207
17208
17209
17210
17211
17212
17213
17214
17215
17216
17217
17218
17219
17220
17221
17222
17223
17224
17225
17226
17227
17228
17229
17230
17231
17232
17233
17234
17235
17236
17237
17238
17239
17240
17241
17242
17243
17244
17245
17246
17247
17248
17249
17250
17251
17252
17253
17254
17255
17256
17257
17258
17259
17260
17261
17262
17263
17264
17265
17266
17267
17268
17269
17270
17271
17272
17273
17274
17275
17276
17277
17278
17279
17280
17281
17282
17283
17284
17285
17286
17287
17288
17289
17290
17291
17292
17293
17294
17295
17296
17297
17298
17299
17300
17301
17302
17303
17304
17305
17306
17307
17308
17309
17310
17311
17312
17313
17314
17315
17316
17317
17318
17319
17320
17321
17322
17323
17324
17325
17326
17327
17328
17329
17330
17331
17332
17333
17334
17335
17336
17337
17338
17339
17340
17341
17342
17343
17344
17345
17346
17347
17348
17349
17350
17351
17352
17353
17354
17355
17356
17357
17358
17359
17360
17361
17362
17363
17364
17365
17366
17367
17368
17369
17370
17371
17372
17373
17374
17375
17376
17377
17378
17379
17380
17381
17382
17383
17384
17385
17386
17387
17388
17389
17390
17391
17392
17393
17394
17395
17396
17397
17398
17399
17400
17401
17402
17403
17404
17405
17406
17407
17408
17409
17410
17411
17412
17413
17414
17415
17416
17417
17418
17419
17420
17421
17422
17423
17424
17425
17426
17427
17428
17429
17430
17431
17432
17433
17434
17435
17436
17437
17438
17439
17440
17441
17442
17443
17444
17445
17446
17447
17448
17449
17450
17451
17452
17453
17454
17455
17456
17457
17458
17459
17460
17461
17462
17463
17464
17465
17466
17467
17468
17469
17470
17471
17472
17473
17474
17475
17476
17477
17478
17479
17480
17481
17482
17483
17484
17485
17486
17487
17488
17489
17490
17491
17492
17493
17494
17495
17496
17497
17498
17499
17500
17501
17502
17503
17504
17505
17506
17507
17508
17509
17510
17511
17512
17513
17514
17515
17516
17517
17518
17519
17520
17521
17522
17523
17524
17525
17526
17527
17528
17529
17530
17531
17532
17533
17534
17535
17536
17537
17538
17539
17540
17541
17542
17543
17544
17545
17546
17547
17548
17549
17550
17551
17552
17553
17554
17555
17556
17557
17558
17559
17560
17561
17562
17563
17564
17565
17566
17567
17568
17569
17570
17571
17572
17573
17574
17575
17576
17577
17578
17579
17580
17581
17582
17583
17584
17585
17586
17587
17588
17589
17590
17591
17592
17593
17594
17595
17596
17597
17598
17599
17600
17601
17602
17603
17604
17605
17606
17607
17608
17609
17610
17611
17612
17613
17614
17615
17616
17617
17618
17619
17620
17621
17622
17623
17624
17625
17626
17627
17628
17629
17630
17631
17632
17633
17634
17635
17636
17637
17638
17639
17640
17641
17642
17643
17644
17645
17646
17647
17648
17649
17650
17651
17652
17653
17654
17655
17656
17657
17658
17659
17660
17661
17662
17663
17664
17665
17666
17667
17668
17669
17670
17671
17672
17673
17674
17675
17676
17677
17678
17679
17680
17681
17682
17683
17684
17685
17686
17687
17688
17689
17690
17691
17692
17693
17694
17695
17696
17697
17698
17699
17700
17701
17702
17703
17704
17705
17706
17707
17708
17709
17710
17711
17712
17713
17714
17715
17716
17717
17718
17719
17720
17721
17722
17723
17724
17725
17726
17727
17728
17729
17730
17731
17732
17733
17734
17735
17736
17737
17738
17739
17740
17741
17742
17743
17744
17745
17746
17747
17748
17749
17750
17751
17752
17753
17754
17755
17756
17757
17758
17759
17760
17761
17762
17763
17764
17765
17766
17767
17768
17769
17770
17771
17772
17773
17774
17775
17776
17777
17778
17779
17780
17781
17782
17783
17784
17785
17786
17787
17788
17789
17790
17791
17792
17793
17794
17795
17796
17797
17798
17799
17800
17801
17802
17803
17804
17805
17806
17807
17808
17809
17810
17811
17812
17813
17814
17815
17816
17817
17818
17819
17820
17821
17822
17823
17824
17825
17826
17827
17828
17829
17830
17831
17832
17833
17834
17835
17836
17837
17838
17839
17840
17841
17842
17843
17844
17845
17846
17847
17848
17849
17850
17851
17852
17853
17854
17855
17856
17857
17858
17859
17860
17861
17862
17863
17864
17865
17866
17867
17868
17869
17870
17871
17872
17873
17874
17875
17876
17877
17878
17879
17880
17881
17882
17883
17884
17885
17886
17887
17888
17889
17890
17891
17892
17893
17894
17895
17896
17897
17898
17899
17900
17901
17902
17903
17904
17905
17906
17907
17908
17909
17910
17911
17912
17913
17914
17915
17916
17917
17918
17919
17920
17921
17922
17923
17924
17925
17926
17927
17928
17929
17930
17931
17932
17933
17934
17935
17936
17937
17938
17939
17940
17941
17942
17943
17944
17945
17946
17947
17948
17949
17950
17951
17952
17953
17954
17955
17956
17957
17958
17959
17960
17961
17962
17963
17964
17965
17966
17967
17968
17969
17970
17971
17972
17973
17974
17975
17976
17977
17978
17979
17980
17981
17982
17983
17984
17985
17986
17987
17988
17989
17990
17991
17992
17993
17994
17995
17996
17997
17998
17999
18000
18001
18002
18003
18004
18005
18006
18007
18008
18009
18010
18011
18012
18013
18014
18015
18016
18017
18018
18019
18020
18021
18022
18023
18024
18025
18026
18027
18028
18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
18040
18041
18042
18043
18044
18045
18046
18047
18048
18049
18050
18051
18052
18053
18054
18055
18056
18057
18058
18059
18060
18061
18062
18063
18064
18065
18066
18067
18068
18069
18070
18071
18072
18073
18074
18075
18076
18077
18078
18079
18080
18081
18082
18083
18084
18085
18086
18087
18088
18089
18090
18091
18092
18093
18094
18095
18096
18097
18098
18099
18100
18101
18102
18103
18104
18105
18106
18107
18108
18109
18110
18111
18112
18113
18114
18115
18116
18117
18118
18119
18120
18121
18122
18123
18124
18125
18126
18127
18128
18129
18130
18131
18132
18133
18134
18135
18136
18137
18138
18139
18140
18141
18142
18143
18144
18145
18146
18147
18148
18149
18150
18151
18152
18153
18154
18155
18156
18157
18158
18159
18160
18161
18162
18163
18164
18165
18166
18167
18168
18169
18170
18171
18172
18173
18174
18175
18176
18177
18178
18179
18180
18181
18182
18183
18184
18185
18186
18187
18188
18189
18190
18191
18192
18193
18194
18195
18196
18197
18198
18199
18200
18201
18202
18203
18204
18205
18206
18207
18208
18209
18210
18211
18212
18213
18214
18215
18216
18217
18218
18219
18220
18221
18222
18223
18224
18225
18226
18227
18228
18229
18230
18231
18232
18233
18234
18235
18236
18237
18238
18239
18240
18241
18242
18243
18244
18245
18246
18247
18248
18249
18250
18251
18252
18253
18254
18255
18256
18257
18258
18259
18260
18261
18262
18263
18264
18265
18266
18267
18268
18269
18270
18271
18272
18273
18274
18275
18276
18277
18278
18279
18280
18281
18282
18283
18284
18285
18286
18287
18288
18289
18290
18291
18292
18293
18294
18295
18296
18297
18298
18299
18300
18301
18302
18303
18304
18305
18306
18307
18308
18309
18310
18311
18312
18313
18314
18315
18316
18317
18318
18319
18320
18321
18322
18323
18324
18325
18326
18327
18328
18329
18330
18331
18332
18333
18334
18335
18336
18337
18338
18339
18340
18341
18342
18343
18344
18345
18346
18347
18348
18349
18350
18351
18352
18353
18354
18355
18356
18357
18358
18359
18360
18361
18362
18363
18364
18365
18366
18367
18368
18369
18370
18371
18372
18373
18374
18375
18376
18377
18378
18379
18380
18381
18382
18383
18384
18385
18386
18387
18388
18389
18390
18391
18392
18393
18394
18395
18396
18397
18398
18399
18400
18401
18402
18403
18404
18405
18406
18407
18408
18409
18410
18411
18412
18413
18414
18415
18416
18417
18418
18419
18420
18421
18422
18423
18424
18425
18426
18427
18428
18429
18430
18431
18432
18433
18434
18435
18436
18437
18438
18439
18440
18441
18442
18443
18444
18445
18446
18447
18448
18449
18450
18451
18452
18453
18454
18455
18456
18457
18458
18459
18460
18461
18462
18463
18464
18465
18466
18467
18468
18469
18470
18471
18472
18473
18474
18475
18476
18477
18478
18479
18480
18481
18482
18483
18484
18485
18486
18487
18488
18489
18490
18491
18492
18493
18494
18495
18496
18497
18498
18499
18500
18501
18502
18503
18504
18505
18506
18507
18508
18509
18510
18511
18512
18513
18514
18515
18516
18517
18518
18519
18520
18521
18522
18523
18524
18525
18526
18527
18528
18529
18530
18531
18532
18533
18534
18535
18536
18537
18538
18539
18540
18541
18542
18543
18544
18545
18546
18547
18548
18549
18550
18551
18552
18553
18554
18555
18556
18557
18558
18559
18560
18561
18562
18563
18564
18565
18566
18567
18568
18569
18570
18571
18572
18573
18574
18575
18576
18577
18578
18579
18580
18581
18582
18583
18584
18585
18586
18587
18588
18589
18590
18591
18592
18593
18594
18595
18596
18597
18598
18599
18600
18601
18602
18603
18604
18605
18606
18607
18608
18609
18610
18611
18612
18613
18614
18615
18616
18617
18618
18619
18620
18621
18622
18623
18624
18625
18626
18627
18628
18629
18630
18631
18632
18633
18634
18635
18636
18637
18638
18639
18640
18641
18642
18643
18644
18645
18646
18647
18648
18649
18650
18651
18652
18653
18654
18655
18656
18657
18658
18659
18660
18661
18662
18663
18664
18665
18666
18667
18668
18669
18670
18671
18672
18673
18674
18675
18676
18677
18678
18679
18680
18681
18682
18683
18684
18685
18686
18687
18688
18689
18690
18691
18692
18693
18694
18695
18696
18697
18698
18699
18700
18701
18702
18703
18704
18705
18706
18707
18708
18709
18710
18711
18712
18713
18714
18715
18716
18717
18718
18719
18720
18721
18722
18723
18724
18725
18726
18727
18728
18729
18730
18731
18732
18733
18734
18735
18736
18737
18738
18739
18740
18741
18742
18743
18744
18745
18746
18747
18748
18749
18750
18751
18752
18753
18754
18755
18756
18757
18758
18759
18760
18761
18762
18763
18764
18765
18766
18767
18768
18769
18770
18771
18772
18773
18774
18775
18776
18777
18778
18779
18780
18781
18782
18783
18784
18785
18786
18787
18788
18789
18790
18791
18792
18793
18794
18795
18796
18797
18798
18799
18800
18801
18802
18803
18804
18805
18806
18807
18808
18809
18810
18811
18812
18813
18814
18815
18816
18817
18818
18819
18820
18821
18822
18823
18824
18825
18826
18827
18828
18829
18830
18831
18832
18833
18834
18835
18836
18837
18838
18839
18840
18841
18842
18843
18844
18845
18846
18847
18848
18849
18850
18851
18852
18853
18854
18855
18856
18857
18858
18859
18860
18861
18862
18863
18864
18865
18866
18867
18868
18869
18870
18871
18872
18873
18874
18875
18876
18877
18878
18879
18880
18881
18882
18883
18884
18885
18886
18887
18888
18889
18890
18891
18892
18893
18894
18895
18896
18897
18898
18899
18900
18901
18902
18903
18904
18905
18906
18907
18908
18909
18910
18911
18912
18913
18914
18915
18916
18917
18918
18919
18920
18921
18922
18923
18924
18925
18926
18927
18928
18929
18930
18931
18932
18933
18934
18935
18936
18937
18938
18939
18940
18941
18942
18943
18944
18945
18946
18947
18948
18949
18950
18951
18952
18953
18954
18955
18956
18957
18958
18959
18960
18961
18962
18963
18964
18965
18966
18967
18968
18969
18970
18971
18972
18973
18974
18975
18976
18977
18978
18979
18980
18981
18982
18983
18984
18985
18986
18987
18988
18989
18990
18991
18992
18993
18994
18995
18996
18997
18998
18999
19000
19001
19002
19003
19004
19005
19006
19007
19008
19009
19010
19011
19012
19013
19014
19015
19016
19017
19018
19019
19020
19021
19022
19023
19024
19025
19026
19027
19028
19029
19030
19031
19032
19033
19034
19035
19036
19037
19038
19039
19040
19041
19042
19043
19044
19045
19046
19047
19048
19049
19050
19051
19052
19053
19054
19055
19056
19057
19058
19059
19060
19061
19062
19063
19064
19065
19066
19067
19068
19069
19070
19071
19072
19073
19074
19075
19076
19077
19078
19079
19080
19081
19082
19083
19084
19085
19086
19087
19088
19089
19090
19091
19092
19093
19094
19095
19096
19097
19098
19099
19100
19101
19102
19103
19104
19105
19106
19107
19108
19109
19110
19111
19112
19113
19114
19115
19116
19117
19118
19119
19120
19121
19122
19123
19124
19125
19126
19127
19128
19129
19130
19131
19132
19133
19134
19135
19136
19137
19138
19139
19140
19141
19142
19143
19144
19145
19146
19147
19148
19149
19150
19151
19152
19153
19154
19155
19156
19157
19158
19159
19160
19161
19162
19163
19164
19165
19166
19167
19168
19169
19170
19171
19172
19173
19174
19175
19176
19177
19178
19179
19180
19181
19182
19183
19184
19185
19186
19187
19188
19189
19190
19191
19192
19193
19194
19195
19196
19197
19198
19199
19200
19201
19202
19203
19204
19205
19206
19207
19208
19209
19210
19211
19212
19213
19214
19215
19216
19217
19218
19219
19220
19221
19222
19223
19224
19225
19226
19227
19228
19229
19230
19231
19232
19233
19234
19235
19236
19237
19238
19239
19240
19241
19242
19243
19244
19245
19246
19247
19248
19249
19250
19251
19252
19253
19254
19255
19256
19257
19258
19259
19260
19261
19262
19263
19264
19265
19266
19267
19268
19269
19270
19271
19272
19273
19274
19275
19276
19277
19278
19279
19280
19281
19282
19283
19284
19285
19286
19287
19288
19289
19290
19291
19292
19293
19294
19295
19296
19297
19298
19299
19300
19301
19302
19303
19304
19305
19306
19307
19308
19309
19310
19311
19312
19313
19314
19315
19316
19317
19318
19319
19320
19321
19322
19323
19324
19325
19326
19327
19328
19329
19330
19331
19332
19333
19334
19335
19336
19337
19338
19339
19340
19341
19342
19343
19344
19345
19346
19347
19348
19349
19350
19351
19352
19353
19354
19355
19356
19357
19358
19359
19360
19361
19362
19363
19364
19365
19366
19367
19368
19369
19370
19371
19372
19373
19374
19375
19376
19377
19378
19379
19380
19381
19382
19383
19384
19385
19386
19387
19388
19389
19390
19391
19392
19393
19394
19395
19396
19397
19398
19399
19400
19401
19402
19403
19404
19405
19406
19407
19408
19409
19410
19411
19412
19413
19414
19415
19416
19417
19418
19419
19420
19421
19422
19423
19424
19425
19426
19427
19428
19429
19430
19431
19432
19433
19434
19435
19436
19437
19438
19439
19440
19441
19442
19443
19444
19445
19446
19447
19448
19449
19450
19451
19452
19453
19454
19455
19456
19457
19458
19459
19460
19461
19462
19463
19464
19465
19466
19467
19468
19469
19470
19471
19472
19473
19474
19475
19476
19477
19478
19479
19480
19481
19482
19483
19484
19485
19486
19487
19488
19489
19490
19491
19492
19493
19494
19495
19496
19497
19498
19499
19500
19501
19502
19503
19504
19505
19506
19507
19508
19509
19510
19511
19512
19513
19514
19515
19516
19517
19518
19519
19520
19521
19522
19523
19524
19525
19526
19527
19528
19529
19530
19531
19532
19533
19534
19535
19536
19537
19538
19539
19540
19541
19542
19543
19544
19545
19546
19547
19548
19549
19550
19551
19552
19553
19554
19555
19556
19557
19558
19559
19560
19561
19562
19563
19564
19565
19566
19567
19568
19569
19570
19571
19572
19573
19574
19575
19576
19577
19578
19579
19580
19581
19582
19583
19584
19585
19586
19587
19588
19589
19590
19591
19592
19593
19594
19595
19596
19597
19598
19599
19600
19601
19602
19603
19604
19605
19606
19607
19608
19609
19610
19611
19612
19613
19614
19615
19616
19617
19618
19619
19620
19621
19622
19623
19624
19625
19626
19627
19628
19629
19630
19631
19632
19633
19634
19635
19636
19637
19638
19639
19640
19641
19642
19643
19644
19645
19646
19647
19648
19649
19650
19651
19652
19653
19654
19655
19656
19657
19658
19659
19660
19661
19662
19663
19664
19665
19666
19667
19668
19669
19670
19671
19672
19673
19674
19675
19676
19677
19678
19679
19680
19681
19682
19683
19684
19685
19686
19687
19688
19689
19690
19691
19692
19693
19694
19695
19696
19697
19698
19699
19700
19701
19702
19703
19704
19705
19706
19707
19708
19709
19710
19711
19712
19713
19714
19715
19716
19717
19718
19719
19720
19721
19722
19723
19724
19725
19726
19727
19728
19729
19730
19731
19732
19733
19734
19735
19736
19737
19738
19739
19740
19741
19742
19743
19744
19745
19746
19747
19748
19749
19750
19751
19752
19753
19754
19755
19756
19757
19758
19759
19760
19761
19762
19763
19764
19765
19766
19767
19768
19769
19770
19771
19772
19773
19774
19775
19776
19777
19778
19779
19780
19781
19782
19783
19784
19785
19786
19787
19788
19789
19790
19791
19792
19793
19794
19795
19796
19797
19798
19799
19800
19801
19802
19803
19804
19805
19806
19807
19808
19809
19810
19811
19812
19813
19814
19815
19816
19817
19818
19819
19820
19821
19822
19823
19824
19825
19826
19827
19828
19829
19830
19831
19832
19833
19834
19835
19836
19837
19838
19839
19840
19841
19842
19843
19844
19845
19846
19847
19848
19849
19850
19851
19852
19853
19854
19855
19856
19857
19858
19859
19860
19861
19862
19863
19864
19865
19866
19867
19868
19869
19870
19871
19872
19873
19874
19875
19876
19877
19878
19879
19880
19881
19882
19883
19884
19885
19886
19887
19888
19889
19890
19891
19892
19893
19894
19895
19896
19897
19898
19899
19900
19901
19902
19903
19904
19905
19906
19907
19908
19909
19910
19911
19912
19913
19914
19915
19916
19917
19918
19919
19920
19921
19922
19923
19924
19925
19926
19927
19928
19929
19930
19931
19932
19933
19934
19935
19936
19937
19938
19939
19940
19941
19942
19943
19944
19945
19946
19947
19948
19949
19950
19951
19952
19953
19954
19955
19956
19957
19958
19959
19960
19961
19962
19963
19964
19965
19966
19967
19968
19969
19970
19971
19972
19973
19974
19975
19976
19977
19978
19979
19980
19981
19982
19983
19984
19985
19986
19987
19988
19989
19990
19991
19992
19993
19994
19995
19996
19997
19998
19999
20000
20001
20002
20003
20004
20005
20006
20007
20008
20009
20010
20011
20012
20013
20014
20015
20016
20017
20018
20019
20020
20021
20022
20023
20024
20025
20026
20027
20028
20029
20030
20031
20032
20033
20034
20035
20036
20037
20038
20039
20040
20041
20042
20043
20044
20045
20046
20047
20048
20049
20050
20051
20052
20053
20054
20055
20056
20057
20058
20059
20060
20061
20062
20063
20064
20065
20066
20067
20068
20069
20070
20071
20072
20073
20074
20075
20076
20077
20078
20079
20080
20081
20082
20083
20084
20085
20086
20087
20088
20089
20090
20091
20092
20093
20094
20095
20096
20097
20098
20099
20100
20101
20102
20103
20104
20105
20106
20107
20108
20109
20110
20111
20112
20113
20114
20115
20116
20117
20118
20119
20120
20121
20122
20123
20124
20125
20126
20127
20128
20129
20130
20131
20132
20133
20134
20135
20136
20137
20138
20139
20140
20141
20142
20143
20144
20145
20146
20147
20148
20149
20150
20151
20152
20153
20154
20155
20156
20157
20158
20159
20160
20161
20162
20163
20164
20165
20166
20167
20168
20169
20170
20171
20172
20173
20174
20175
20176
20177
20178
20179
20180
20181
20182
20183
20184
20185
20186
20187
20188
20189
20190
20191
20192
20193
20194
20195
20196
20197
20198
20199
20200
20201
20202
20203
20204
20205
20206
20207
20208
20209
20210
20211
20212
20213
20214
20215
20216
20217
20218
20219
20220
20221
20222
20223
20224
20225
20226
20227
20228
20229
20230
20231
20232
20233
20234
20235
20236
20237
20238
20239
20240
20241
20242
20243
20244
20245
20246
20247
20248
20249
20250
20251
20252
20253
20254
20255
20256
20257
20258
20259
20260
20261
20262
20263
20264
20265
20266
20267
20268
20269
20270
20271
20272
20273
20274
20275
20276
20277
20278
20279
20280
20281
20282
20283
20284
20285
20286
20287
20288
20289
20290
20291
20292
20293
20294
20295
20296
20297
20298
20299
20300
20301
20302
20303
20304
20305
20306
20307
20308
20309
20310
20311
20312
20313
20314
20315
20316
20317
20318
20319
20320
20321
20322
20323
20324
20325
20326
20327
20328
20329
20330
20331
20332
20333
20334
20335
20336
20337
20338
20339
20340
20341
20342
20343
20344
20345
20346
20347
20348
20349
20350
20351
20352
20353
20354
20355
20356
20357
20358
20359
20360
20361
20362
20363
20364
20365
20366
20367
20368
20369
20370
20371
20372
20373
20374
20375
20376
20377
20378
20379
20380
20381
20382
20383
20384
20385
20386
20387
20388
20389
20390
20391
20392
20393
20394
20395
20396
20397
20398
20399
20400
20401
20402
20403
20404
20405
20406
20407
20408
20409
20410
20411
20412
20413
20414
20415
20416
20417
20418
20419
20420
20421
20422
20423
20424
20425
20426
20427
20428
20429
20430
20431
20432
20433
20434
20435
20436
20437
20438
20439
20440
20441
20442
20443
20444
20445
20446
20447
20448
20449
20450
20451
20452
20453
20454
20455
20456
20457
20458
20459
20460
20461
20462
20463
20464
20465
20466
20467
20468
20469
20470
20471
20472
20473
20474
20475
20476
20477
20478
20479
20480
20481
20482
20483
20484
20485
20486
20487
20488
20489
20490
20491
20492
20493
20494
20495
20496
20497
20498
20499
20500
20501
20502
20503
20504
20505
20506
20507
20508
20509
20510
20511
20512
20513
20514
20515
20516
20517
20518
20519
20520
20521
20522
20523
20524
20525
20526
20527
20528
20529
20530
20531
20532
20533
20534
20535
20536
20537
20538
20539
20540
20541
20542
20543
20544
20545
20546
20547
20548
20549
20550
20551
20552
20553
20554
20555
20556
20557
20558
20559
20560
20561
20562
20563
20564
20565
20566
20567
20568
20569
20570
20571
20572
20573
20574
20575
20576
20577
20578
20579
20580
20581
20582
20583
20584
20585
20586
20587
20588
20589
20590
20591
20592
20593
20594
20595
20596
20597
20598
20599
20600
20601
20602
20603
20604
20605
20606
20607
20608
20609
20610
20611
20612
20613
20614
20615
20616
20617
20618
20619
20620
20621
20622
20623
20624
20625
20626
20627
20628
20629
20630
20631
20632
20633
20634
20635
20636
20637
20638
20639
20640
20641
20642
20643
20644
20645
20646
20647
20648
20649
20650
20651
20652
20653
20654
20655
20656
20657
20658
20659
20660
20661
20662
20663
20664
20665
20666
20667
20668
20669
20670
20671
20672
20673
20674
20675
20676
20677
20678
20679
20680
20681
20682
20683
20684
20685
20686
20687
20688
20689
20690
20691
20692
20693
20694
20695
20696
20697
20698
20699
20700
20701
20702
20703
20704
20705
20706
20707
20708
20709
20710
20711
20712
20713
20714
20715
20716
20717
20718
20719
20720
20721
20722
20723
20724
20725
20726
20727
20728
20729
20730
20731
20732
20733
20734
20735
20736
20737
20738
20739
20740
20741
20742
20743
20744
20745
20746
20747
20748
20749
20750
20751
20752
20753
20754
20755
20756
20757
20758
20759
20760
20761
20762
20763
20764
20765
20766
20767
20768
20769
20770
20771
20772
20773
20774
20775
20776
20777
20778
20779
20780
20781
20782
20783
20784
20785
20786
20787
20788
20789
20790
20791
20792
20793
20794
20795
20796
20797
20798
20799
20800
20801
20802
20803
20804
20805
20806
20807
20808
20809
20810
20811
20812
20813
20814
20815
20816
20817
20818
20819
20820
20821
20822
20823
20824
20825
20826
20827
20828
20829
20830
20831
20832
20833
20834
20835
20836
20837
20838
20839
20840
20841
20842
20843
20844
20845
20846
20847
20848
20849
20850
20851
20852
20853
20854
20855
20856
20857
20858
20859
20860
20861
20862
20863
20864
20865
20866
20867
20868
20869
20870
20871
20872
20873
20874
20875
20876
20877
20878
20879
20880
20881
20882
20883
20884
20885
20886
20887
20888
20889
20890
20891
20892
20893
20894
20895
20896
20897
20898
20899
20900
20901
20902
20903
20904
20905
20906
20907
20908
20909
20910
20911
20912
20913
20914
20915
20916
20917
20918
20919
20920
20921
20922
20923
20924
20925
20926
20927
20928
20929
20930
20931
20932
20933
20934
20935
20936
20937
20938
20939
20940
20941
20942
20943
20944
20945
20946
20947
20948
20949
20950
20951
20952
20953
20954
20955
20956
20957
20958
20959
20960
20961
20962
20963
20964
20965
20966
20967
20968
20969
20970
20971
20972
20973
20974
20975
20976
20977
20978
20979
20980
20981
20982
20983
20984
20985
20986
20987
20988
20989
20990
20991
20992
20993
20994
20995
20996
20997
20998
20999
21000
21001
21002
21003
21004
21005
21006
21007
21008
21009
21010
21011
21012
21013
21014
21015
21016
21017
21018
21019
21020
21021
21022
21023
21024
21025
21026
21027
21028
21029
21030
21031
21032
21033
21034
21035
21036
21037
21038
21039
21040
21041
21042
21043
21044
21045
21046
21047
21048
21049
21050
21051
21052
21053
21054
21055
21056
21057
21058
21059
21060
21061
21062
21063
21064
21065
21066
21067
21068
21069
21070
21071
21072
21073
21074
21075
21076
21077
21078
21079
21080
21081
21082
21083
21084
21085
21086
21087
21088
21089
21090
21091
21092
21093
21094
21095
21096
21097
21098
21099
21100
21101
21102
21103
21104
21105
21106
21107
21108
21109
21110
21111
21112
21113
21114
21115
21116
21117
21118
21119
21120
21121
21122
21123
21124
21125
21126
21127
21128
21129
21130
21131
21132
21133
21134
21135
21136
21137
21138
21139
21140
21141
21142
21143
21144
21145
21146
21147
21148
21149
21150
21151
21152
21153
21154
21155
21156
21157
21158
21159
21160
21161
21162
21163
21164
21165
21166
21167
21168
21169
21170
21171
21172
21173
21174
21175
21176
21177
21178
21179
21180
21181
21182
21183
21184
21185
21186
21187
21188
21189
21190
21191
21192
21193
21194
21195
21196
21197
21198
21199
21200
21201
21202
21203
21204
21205
21206
21207
21208
21209
21210
21211
21212
21213
21214
21215
21216
21217
21218
21219
21220
21221
21222
21223
21224
21225
21226
21227
21228
21229
21230
21231
21232
21233
21234
21235
21236
21237
21238
21239
21240
21241
21242
21243
21244
21245
21246
21247
21248
21249
21250
21251
21252
21253
21254
21255
21256
21257
21258
21259
21260
21261
21262
21263
21264
21265
21266
21267
21268
21269
21270
21271
21272
21273
21274
21275
21276
21277
21278
21279
21280
21281
21282
21283
21284
21285
21286
21287
21288
21289
21290
21291
21292
21293
21294
21295
21296
21297
21298
21299
21300
21301
21302
21303
21304
21305
21306
21307
21308
21309
21310
21311
21312
21313
21314
21315
21316
21317
21318
21319
21320
21321
21322
21323
21324
21325
21326
21327
21328
21329
21330
21331
21332
21333
21334
21335
21336
21337
21338
21339
21340
21341
21342
21343
21344
21345
21346
21347
21348
21349
21350
21351
21352
21353
21354
21355
21356
21357
21358
21359
21360
21361
21362
21363
21364
21365
21366
21367
21368
21369
21370
21371
21372
21373
21374
21375
21376
21377
21378
21379
21380
21381
21382
21383
21384
21385
21386
21387
21388
21389
21390
21391
21392
21393
21394
21395
21396
21397
21398
21399
21400
21401
21402
21403
21404
21405
21406
21407
21408
21409
21410
21411
21412
21413
21414
21415
21416
21417
21418
21419
21420
21421
21422
21423
21424
21425
21426
21427
21428
21429
21430
21431
21432
21433
21434
21435
21436
21437
21438
21439
21440
21441
21442
21443
21444
21445
21446
21447
21448
21449
21450
21451
21452
21453
21454
21455
21456
21457
21458
21459
21460
21461
21462
21463
21464
21465
21466
21467
21468
21469
21470
21471
21472
21473
21474
21475
21476
21477
21478
21479
21480
21481
21482
21483
21484
21485
21486
21487
21488
21489
21490
21491
21492
21493
21494
21495
21496
21497
21498
21499
21500
21501
21502
21503
21504
21505
21506
21507
21508
21509
21510
21511
21512
21513
21514
21515
21516
21517
21518
21519
21520
21521
21522
21523
21524
21525
21526
21527
21528
21529
21530
21531
21532
21533
21534
21535
21536
21537
21538
21539
21540
21541
21542
21543
21544
21545
21546
21547
21548
21549
21550
21551
21552
21553
21554
21555
21556
21557
21558
21559
21560
21561
21562
21563
21564
21565
21566
21567
21568
21569
21570
21571
21572
21573
21574
21575
21576
21577
21578
21579
21580
21581
21582
21583
21584
21585
21586
21587
21588
21589
21590
21591
21592
21593
21594
21595
21596
21597
21598
21599
21600
21601
21602
21603
21604
21605
21606
21607
21608
21609
21610
21611
21612
21613
21614
21615
21616
21617
21618
21619
21620
21621
21622
21623
21624
21625
21626
21627
21628
21629
21630
21631
21632
21633
21634
21635
21636
21637
21638
21639
21640
21641
21642
21643
21644
21645
21646
21647
21648
21649
21650
21651
21652
21653
21654
21655
21656
21657
21658
21659
21660
21661
21662
21663
21664
21665
21666
21667
21668
21669
21670
21671
21672
21673
21674
21675
21676
21677
21678
21679
21680
21681
21682
21683
21684
21685
21686
21687
21688
21689
21690
21691
21692
21693
21694
21695
21696
21697
21698
21699
21700
21701
21702
21703
21704
21705
21706
21707
21708
21709
21710
21711
21712
21713
21714
21715
21716
21717
21718
21719
21720
21721
21722
21723
21724
21725
21726
21727
21728
21729
21730
21731
21732
21733
21734
21735
21736
21737
21738
21739
21740
21741
21742
21743
21744
21745
21746
21747
21748
21749
21750
21751
21752
21753
21754
21755
21756
21757
21758
21759
21760
21761
21762
21763
21764
21765
21766
21767
21768
21769
21770
21771
21772
21773
21774
21775
21776
21777
21778
21779
21780
21781
21782
21783
21784
21785
21786
21787
21788
21789
21790
21791
21792
21793
21794
21795
21796
21797
21798
21799
21800
21801
21802
21803
21804
21805
21806
21807
21808
21809
21810
21811
21812
21813
21814
21815
21816
21817
21818
21819
21820
21821
21822
21823
21824
21825
21826
21827
21828
21829
21830
21831
21832
21833
21834
21835
21836
21837
21838
21839
21840
21841
21842
21843
21844
21845
21846
21847
21848
21849
21850
21851
21852
21853
21854
21855
21856
21857
21858
21859
21860
21861
21862
21863
21864
21865
21866
21867
21868
21869
21870
21871
21872
21873
21874
21875
21876
21877
21878
21879
21880
21881
21882
21883
21884
21885
21886
21887
21888
21889
21890
21891
21892
21893
21894
21895
21896
21897
21898
21899
21900
21901
21902
21903
21904
21905
21906
21907
21908
21909
21910
21911
21912
21913
21914
21915
21916
21917
21918
21919
21920
21921
21922
21923
21924
21925
21926
21927
21928
21929
21930
21931
21932
21933
21934
21935
21936
21937
21938
21939
21940
21941
21942
21943
21944
21945
21946
21947
21948
21949
21950
21951
21952
21953
21954
21955
21956
21957
21958
21959
21960
21961
21962
21963
21964
21965
21966
21967
21968
21969
21970
21971
21972
21973
21974
21975
21976
21977
21978
21979
21980
21981
21982
21983
21984
21985
21986
21987
21988
21989
21990
21991
21992
21993
21994
21995
21996
21997
21998
21999
22000
22001
22002
22003
22004
22005
22006
22007
22008
22009
22010
22011
22012
22013
22014
22015
22016
22017
22018
22019
22020
22021
22022
22023
22024
22025
22026
22027
22028
22029
22030
22031
22032
22033
22034
22035
22036
22037
22038
22039
22040
22041
22042
22043
22044
22045
22046
22047
22048
22049
22050
22051
22052
22053
22054
22055
22056
22057
22058
22059
22060
22061
22062
22063
22064
22065
22066
22067
22068
22069
22070
22071
22072
22073
22074
22075
22076
22077
22078
22079
22080
22081
22082
22083
22084
22085
22086
22087
22088
22089
22090
22091
22092
22093
22094
22095
22096
22097
22098
22099
22100
22101
22102
22103
22104
22105
22106
22107
22108
22109
22110
22111
22112
22113
22114
22115
22116
22117
22118
22119
22120
22121
22122
22123
22124
22125
22126
22127
22128
22129
22130
22131
22132
22133
22134
22135
22136
22137
22138
22139
22140
22141
22142
22143
22144
22145
22146
22147
22148
22149
22150
22151
22152
22153
22154
22155
22156
22157
22158
22159
22160
22161
22162
22163
22164
22165
22166
22167
22168
22169
22170
22171
22172
22173
22174
22175
22176
22177
22178
22179
22180
22181
22182
22183
22184
22185
22186
22187
22188
22189
22190
22191
22192
22193
22194
22195
22196
22197
22198
22199
22200
22201
22202
22203
22204
22205
22206
22207
22208
22209
22210
22211
22212
22213
22214
22215
22216
22217
22218
22219
22220
22221
22222
22223
22224
22225
22226
22227
22228
22229
22230
22231
22232
22233
22234
22235
22236
22237
22238
22239
22240
22241
22242
22243
22244
22245
22246
22247
22248
22249
22250
22251
22252
22253
22254
22255
22256
22257
22258
22259
22260
22261
22262
22263
22264
22265
22266
22267
22268
22269
22270
22271
22272
22273
22274
22275
22276
22277
22278
22279
22280
22281
22282
22283
22284
22285
22286
22287
22288
22289
22290
22291
22292
22293
22294
22295
22296
22297
22298
22299
22300
22301
22302
22303
22304
22305
22306
22307
22308
22309
22310
22311
22312
22313
22314
22315
22316
22317
22318
22319
22320
22321
22322
22323
22324
22325
22326
22327
22328
22329
22330
22331
22332
22333
22334
22335
22336
22337
22338
22339
22340
22341
22342
22343
22344
22345
22346
22347
22348
22349
22350
22351
22352
22353
22354
22355
22356
22357
22358
22359
22360
22361
22362
22363
22364
22365
22366
22367
22368
22369
22370
22371
22372
22373
22374
22375
22376
22377
22378
22379
22380
22381
22382
22383
22384
22385
22386
22387
22388
22389
22390
22391
22392
22393
22394
22395
22396
22397
22398
22399
22400
22401
22402
22403
22404
22405
22406
22407
22408
22409
22410
22411
22412
22413
22414
22415
22416
22417
22418
22419
22420
22421
22422
22423
22424
22425
22426
22427
22428
22429
22430
22431
22432
22433
22434
22435
22436
22437
22438
22439
22440
22441
22442
22443
22444
22445
22446
22447
22448
22449
22450
22451
22452
22453
22454
22455
22456
22457
22458
22459
22460
22461
22462
22463
22464
22465
22466
22467
22468
22469
22470
22471
22472
22473
22474
22475
22476
22477
22478
22479
22480
22481
22482
22483
22484
22485
22486
22487
22488
22489
22490
22491
22492
22493
22494
22495
22496
22497
22498
22499
22500
22501
22502
22503
22504
22505
22506
22507
22508
22509
22510
22511
22512
22513
22514
22515
22516
22517
22518
22519
22520
22521
22522
22523
22524
22525
22526
22527
22528
22529
22530
22531
22532
22533
22534
22535
22536
22537
22538
22539
22540
22541
22542
22543
22544
22545
22546
22547
22548
22549
22550
22551
22552
22553
22554
22555
22556
22557
22558
22559
22560
22561
22562
22563
22564
22565
22566
22567
22568
22569
22570
22571
22572
22573
22574
22575
22576
22577
22578
22579
22580
22581
22582
22583
22584
22585
22586
22587
22588
22589
22590
22591
22592
22593
22594
22595
22596
22597
22598
22599
22600
22601
22602
22603
22604
22605
22606
22607
22608
22609
22610
22611
22612
22613
22614
22615
22616
22617
22618
22619
22620
22621
22622
22623
22624
22625
22626
22627
22628
22629
22630
22631
22632
22633
22634
22635
22636
22637
22638
22639
22640
22641
22642
22643
22644
22645
22646
22647
22648
22649
22650
22651
22652
22653
22654
22655
22656
22657
22658
22659
22660
22661
22662
22663
22664
22665
22666
22667
22668
22669
22670
22671
22672
22673
22674
22675
22676
22677
22678
22679
22680
22681
22682
22683
22684
22685
22686
22687
22688
22689
22690
22691
22692
22693
22694
22695
22696
22697
22698
22699
22700
22701
22702
22703
22704
22705
22706
22707
22708
22709
22710
22711
22712
22713
22714
22715
22716
22717
22718
22719
22720
22721
22722
22723
22724
22725
22726
22727
22728
22729
22730
22731
22732
22733
22734
22735
22736
22737
22738
22739
22740
22741
22742
22743
22744
22745
22746
22747
22748
22749
22750
22751
22752
22753
22754
22755
22756
22757
22758
22759
22760
22761
22762
22763
22764
22765
22766
22767
22768
22769
22770
22771
22772
22773
22774
22775
22776
22777
22778
22779
22780
22781
22782
22783
22784
22785
22786
22787
22788
22789
22790
22791
22792
22793
22794
22795
22796
22797
22798
22799
22800
22801
22802
22803
22804
22805
22806
22807
22808
22809
22810
22811
22812
22813
22814
22815
22816
22817
22818
22819
22820
22821
22822
22823
22824
22825
22826
22827
22828
22829
22830
22831
22832
22833
22834
22835
22836
22837
22838
22839
22840
22841
22842
22843
22844
22845
22846
22847
22848
22849
22850
22851
22852
22853
22854
22855
22856
22857
22858
22859
22860
22861
22862
22863
22864
22865
22866
22867
22868
22869
22870
22871
22872
22873
22874
22875
22876
22877
22878
22879
22880
22881
22882
22883
22884
22885
22886
22887
22888
22889
22890
22891
22892
22893
22894
22895
22896
22897
22898
22899
22900
22901
22902
22903
22904
22905
22906
22907
22908
22909
22910
22911
22912
22913
22914
22915
22916
22917
22918
22919
22920
22921
22922
22923
22924
22925
22926
22927
22928
22929
22930
22931
22932
22933
22934
22935
22936
22937
22938
22939
22940
22941
22942
22943
22944
22945
22946
22947
22948
22949
22950
22951
22952
22953
22954
22955
22956
22957
22958
22959
22960
22961
22962
22963
22964
22965
22966
22967
22968
22969
22970
22971
22972
22973
22974
22975
22976
22977
22978
22979
22980
22981
22982
22983
22984
22985
22986
22987
22988
22989
22990
22991
22992
22993
22994
22995
22996
22997
22998
22999
23000
23001
23002
23003
23004
23005
23006
23007
23008
23009
23010
23011
23012
23013
23014
23015
23016
23017
23018
23019
23020
23021
23022
23023
23024
23025
23026
23027
23028
23029
23030
23031
23032
23033
23034
23035
23036
23037
23038
23039
23040
23041
23042
23043
23044
23045
23046
23047
23048
23049
23050
23051
23052
23053
23054
23055
23056
23057
23058
23059
23060
23061
23062
23063
23064
23065
23066
23067
23068
23069
23070
23071
23072
23073
23074
23075
23076
23077
23078
23079
23080
23081
23082
23083
23084
23085
23086
23087
23088
23089
23090
23091
23092
23093
23094
23095
23096
23097
23098
23099
23100
23101
23102
23103
23104
23105
23106
23107
23108
23109
23110
23111
23112
23113
23114
23115
23116
23117
23118
23119
23120
23121
23122
23123
23124
23125
23126
23127
23128
23129
23130
23131
23132
23133
23134
23135
23136
23137
23138
23139
23140
23141
23142
23143
23144
23145
23146
23147
23148
23149
23150
23151
23152
23153
23154
23155
23156
23157
23158
23159
23160
23161
23162
23163
23164
23165
23166
23167
23168
23169
23170
23171
23172
23173
23174
23175
23176
23177
23178
23179
23180
23181
23182
23183
23184
23185
23186
23187
23188
23189
23190
23191
23192
23193
23194
23195
23196
23197
23198
23199
23200
23201
23202
23203
23204
23205
23206
23207
23208
23209
23210
23211
23212
23213
23214
23215
23216
23217
23218
23219
23220
23221
23222
23223
23224
23225
23226
23227
23228
23229
23230
23231
23232
23233
23234
23235
23236
23237
23238
23239
23240
23241
23242
23243
23244
23245
23246
23247
23248
23249
23250
23251
23252
23253
23254
23255
23256
23257
23258
23259
23260
23261
23262
23263
23264
23265
23266
23267
23268
23269
23270
23271
23272
23273
23274
23275
23276
23277
23278
23279
23280
23281
23282
23283
23284
23285
23286
23287
23288
23289
23290
23291
23292
23293
23294
23295
23296
23297
23298
23299
23300
23301
23302
23303
23304
23305
23306
23307
23308
23309
23310
23311
23312
23313
23314
23315
23316
23317
23318
23319
23320
23321
23322
23323
23324
23325
23326
23327
23328
23329
23330
23331
23332
23333
23334
23335
23336
23337
23338
23339
23340
23341
23342
23343
23344
23345
23346
23347
23348
23349
23350
23351
23352
23353
23354
23355
23356
23357
23358
23359
23360
23361
23362
23363
23364
23365
23366
23367
23368
23369
23370
23371
23372
23373
23374
23375
23376
23377
23378
23379
23380
23381
23382
23383
23384
23385
23386
23387
23388
23389
23390
23391
23392
23393
23394
23395
23396
23397
23398
23399
23400
23401
23402
23403
23404
23405
23406
23407
23408
23409
23410
23411
23412
23413
23414
23415
23416
23417
23418
23419
23420
23421
23422
23423
23424
23425
23426
23427
23428
23429
23430
23431
23432
23433
23434
23435
23436
23437
23438
23439
23440
23441
23442
23443
23444
23445
23446
23447
23448
23449
23450
23451
23452
23453
23454
23455
23456
23457
23458
23459
23460
23461
23462
23463
23464
23465
23466
23467
23468
23469
23470
23471
23472
23473
23474
23475
23476
23477
23478
23479
23480
23481
23482
23483
23484
23485
23486
23487
23488
23489
23490
23491
23492
23493
23494
23495
23496
23497
23498
23499
23500
23501
23502
23503
23504
23505
23506
23507
23508
23509
23510
23511
23512
23513
23514
23515
23516
23517
23518
23519
23520
23521
23522
23523
23524
23525
23526
23527
23528
23529
23530
23531
23532
23533
23534
23535
23536
23537
23538
23539
23540
23541
23542
23543
23544
23545
23546
23547
23548
23549
23550
23551
23552
23553
23554
23555
23556
23557
23558
23559
23560
23561
23562
23563
23564
23565
|
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>LLVM Language Reference Manual — 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="libFuzzer – a library for coverage-guided fuzz testing." href="LibFuzzer.html" />
<link rel="prev" title="Design and Usage of the InAlloca Attribute" href="InAlloca.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="LibFuzzer.html" title="libFuzzer – a library for coverage-guided fuzz testing."
accesskey="N">next</a> |</li>
<li class="right" >
<a href="InAlloca.html" title="Design and Usage of the InAlloca Attribute"
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="">LLVM Language Reference Manual</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/LangRef.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="llvm-language-reference-manual">
<h1>LLVM Language Reference Manual<a class="headerlink" href="#llvm-language-reference-manual" title="Permalink to this headline">¶</a></h1>
<div class="contents local topic" id="contents">
<ul class="simple">
<li><p><a class="reference internal" href="#abstract" id="id1409">Abstract</a></p></li>
<li><p><a class="reference internal" href="#introduction" id="id1410">Introduction</a></p>
<ul>
<li><p><a class="reference internal" href="#well-formedness" id="id1411">Well-Formedness</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#identifiers" id="id1412">Identifiers</a></p></li>
<li><p><a class="reference internal" href="#high-level-structure" id="id1413">High Level Structure</a></p>
<ul>
<li><p><a class="reference internal" href="#module-structure" id="id1414">Module Structure</a></p></li>
<li><p><a class="reference internal" href="#linkage-types" id="id1415">Linkage Types</a></p></li>
<li><p><a class="reference internal" href="#calling-conventions" id="id1416">Calling Conventions</a></p></li>
<li><p><a class="reference internal" href="#visibility-styles" id="id1417">Visibility Styles</a></p></li>
<li><p><a class="reference internal" href="#dll-storage-classes" id="id1418">DLL Storage Classes</a></p></li>
<li><p><a class="reference internal" href="#thread-local-storage-models" id="id1419">Thread Local Storage Models</a></p></li>
<li><p><a class="reference internal" href="#runtime-preemption-specifiers" id="id1420">Runtime Preemption Specifiers</a></p></li>
<li><p><a class="reference internal" href="#structure-types" id="id1421">Structure Types</a></p></li>
<li><p><a class="reference internal" href="#non-integral-pointer-type" id="id1422">Non-Integral Pointer Type</a></p></li>
<li><p><a class="reference internal" href="#global-variables" id="id1423">Global Variables</a></p></li>
<li><p><a class="reference internal" href="#functions" id="id1424">Functions</a></p></li>
<li><p><a class="reference internal" href="#aliases" id="id1425">Aliases</a></p></li>
<li><p><a class="reference internal" href="#ifuncs" id="id1426">IFuncs</a></p></li>
<li><p><a class="reference internal" href="#comdats" id="id1427">Comdats</a></p></li>
<li><p><a class="reference internal" href="#named-metadata" id="id1428">Named Metadata</a></p></li>
<li><p><a class="reference internal" href="#parameter-attributes" id="id1429">Parameter Attributes</a></p></li>
<li><p><a class="reference internal" href="#garbage-collector-strategy-names" id="id1430">Garbage Collector Strategy Names</a></p></li>
<li><p><a class="reference internal" href="#prefix-data" id="id1431">Prefix Data</a></p></li>
<li><p><a class="reference internal" href="#prologue-data" id="id1432">Prologue Data</a></p></li>
<li><p><a class="reference internal" href="#personality-function" id="id1433">Personality Function</a></p></li>
<li><p><a class="reference internal" href="#attribute-groups" id="id1434">Attribute Groups</a></p></li>
<li><p><a class="reference internal" href="#function-attributes" id="id1435">Function Attributes</a></p></li>
<li><p><a class="reference internal" href="#call-site-attributes" id="id1436">Call Site Attributes</a></p></li>
<li><p><a class="reference internal" href="#global-attributes" id="id1437">Global Attributes</a></p></li>
<li><p><a class="reference internal" href="#operand-bundles" id="id1438">Operand Bundles</a></p>
<ul>
<li><p><a class="reference internal" href="#deoptimization-operand-bundles" id="id1439">Deoptimization Operand Bundles</a></p></li>
<li><p><a class="reference internal" href="#funclet-operand-bundles" id="id1440">Funclet Operand Bundles</a></p></li>
<li><p><a class="reference internal" href="#gc-transition-operand-bundles" id="id1441">GC Transition Operand Bundles</a></p></li>
<li><p><a class="reference internal" href="#assume-operand-bundles" id="id1442">Assume Operand Bundles</a></p></li>
<li><p><a class="reference internal" href="#preallocated-operand-bundles" id="id1443">Preallocated Operand Bundles</a></p></li>
<li><p><a class="reference internal" href="#gc-live-operand-bundles" id="id1444">GC Live Operand Bundles</a></p></li>
<li><p><a class="reference internal" href="#objc-arc-attached-call-operand-bundles" id="id1445">ObjC ARC Attached Call Operand Bundles</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#module-level-inline-assembly" id="id1446">Module-Level Inline Assembly</a></p></li>
<li><p><a class="reference internal" href="#data-layout" id="id1447">Data Layout</a></p></li>
<li><p><a class="reference internal" href="#target-triple" id="id1448">Target Triple</a></p></li>
<li><p><a class="reference internal" href="#object-lifetime" id="id1449">Object Lifetime</a></p></li>
<li><p><a class="reference internal" href="#pointer-aliasing-rules" id="id1450">Pointer Aliasing Rules</a></p></li>
<li><p><a class="reference internal" href="#pointer-capture" id="id1451">Pointer Capture</a></p></li>
<li><p><a class="reference internal" href="#volatile-memory-accesses" id="id1452">Volatile Memory Accesses</a></p></li>
<li><p><a class="reference internal" href="#memory-model-for-concurrent-operations" id="id1453">Memory Model for Concurrent Operations</a></p></li>
<li><p><a class="reference internal" href="#atomic-memory-ordering-constraints" id="id1454">Atomic Memory Ordering Constraints</a></p></li>
<li><p><a class="reference internal" href="#floating-point-environment" id="id1455">Floating-Point Environment</a></p></li>
<li><p><a class="reference internal" href="#fast-math-flags" id="id1456">Fast-Math Flags</a></p></li>
<li><p><a class="reference internal" href="#use-list-order-directives" id="id1457">Use-list Order Directives</a></p></li>
<li><p><a class="reference internal" href="#source-filename" id="id1458">Source Filename</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#type-system" id="id1459">Type System</a></p>
<ul>
<li><p><a class="reference internal" href="#void-type" id="id1460">Void Type</a></p></li>
<li><p><a class="reference internal" href="#function-type" id="id1461">Function Type</a></p></li>
<li><p><a class="reference internal" href="#first-class-types" id="id1462">First Class Types</a></p>
<ul>
<li><p><a class="reference internal" href="#single-value-types" id="id1463">Single Value Types</a></p>
<ul>
<li><p><a class="reference internal" href="#integer-type" id="id1464">Integer Type</a></p></li>
<li><p><a class="reference internal" href="#floating-point-types" id="id1465">Floating-Point Types</a></p></li>
<li><p><a class="reference internal" href="#x86-amx-type" id="id1466">X86_amx Type</a></p></li>
<li><p><a class="reference internal" href="#x86-mmx-type" id="id1467">X86_mmx Type</a></p></li>
<li><p><a class="reference internal" href="#pointer-type" id="id1468">Pointer Type</a></p></li>
<li><p><a class="reference internal" href="#vector-type" id="id1469">Vector Type</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#label-type" id="id1470">Label Type</a></p></li>
<li><p><a class="reference internal" href="#token-type" id="id1471">Token Type</a></p></li>
<li><p><a class="reference internal" href="#metadata-type" id="id1472">Metadata Type</a></p></li>
<li><p><a class="reference internal" href="#aggregate-types" id="id1473">Aggregate Types</a></p>
<ul>
<li><p><a class="reference internal" href="#array-type" id="id1474">Array Type</a></p></li>
<li><p><a class="reference internal" href="#structure-type" id="id1475">Structure Type</a></p></li>
<li><p><a class="reference internal" href="#opaque-structure-types" id="id1476">Opaque Structure Types</a></p></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#constants" id="id1477">Constants</a></p>
<ul>
<li><p><a class="reference internal" href="#simple-constants" id="id1478">Simple Constants</a></p></li>
<li><p><a class="reference internal" href="#complex-constants" id="id1479">Complex Constants</a></p></li>
<li><p><a class="reference internal" href="#global-variable-and-function-addresses" id="id1480">Global Variable and Function Addresses</a></p></li>
<li><p><a class="reference internal" href="#undefined-values" id="id1481">Undefined Values</a></p></li>
<li><p><a class="reference internal" href="#poison-values" id="id1482">Poison Values</a></p></li>
<li><p><a class="reference internal" href="#well-defined-values" id="id1483">Well-Defined Values</a></p></li>
<li><p><a class="reference internal" href="#addresses-of-basic-blocks" id="id1484">Addresses of Basic Blocks</a></p></li>
<li><p><a class="reference internal" href="#dso-local-equivalent" id="id1485">DSO Local Equivalent</a></p></li>
<li><p><a class="reference internal" href="#constant-expressions" id="id1486">Constant Expressions</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#other-values" id="id1487">Other Values</a></p>
<ul>
<li><p><a class="reference internal" href="#inline-assembler-expressions" id="id1488">Inline Assembler Expressions</a></p>
<ul>
<li><p><a class="reference internal" href="#inline-asm-constraint-string" id="id1489">Inline Asm Constraint String</a></p>
<ul>
<li><p><a class="reference internal" href="#output-constraints" id="id1490">Output constraints</a></p></li>
<li><p><a class="reference internal" href="#input-constraints" id="id1491">Input constraints</a></p></li>
<li><p><a class="reference internal" href="#indirect-inputs-and-outputs" id="id1492">Indirect inputs and outputs</a></p></li>
<li><p><a class="reference internal" href="#clobber-constraints" id="id1493">Clobber constraints</a></p></li>
<li><p><a class="reference internal" href="#constraint-codes" id="id1494">Constraint Codes</a></p></li>
<li><p><a class="reference internal" href="#supported-constraint-code-list" id="id1495">Supported Constraint Code List</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#asm-template-argument-modifiers" id="id1496">Asm template argument modifiers</a></p></li>
<li><p><a class="reference internal" href="#inline-asm-metadata" id="id1497">Inline Asm Metadata</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#metadata" id="id1498">Metadata</a></p>
<ul>
<li><p><a class="reference internal" href="#metadata-nodes-and-metadata-strings" id="id1499">Metadata Nodes and Metadata Strings</a></p>
<ul>
<li><p><a class="reference internal" href="#specialized-metadata-nodes" id="id1500">Specialized Metadata Nodes</a></p>
<ul>
<li><p><a class="reference internal" href="#dicompileunit" id="id1501">DICompileUnit</a></p></li>
<li><p><a class="reference internal" href="#difile" id="id1502">DIFile</a></p></li>
<li><p><a class="reference internal" href="#dibasictype" id="id1503">DIBasicType</a></p></li>
<li><p><a class="reference internal" href="#disubroutinetype" id="id1504">DISubroutineType</a></p></li>
<li><p><a class="reference internal" href="#diderivedtype" id="id1505">DIDerivedType</a></p></li>
<li><p><a class="reference internal" href="#dicompositetype" id="id1506">DICompositeType</a></p></li>
<li><p><a class="reference internal" href="#disubrange" id="id1507">DISubrange</a></p></li>
<li><p><a class="reference internal" href="#dienumerator" id="id1508">DIEnumerator</a></p></li>
<li><p><a class="reference internal" href="#ditemplatetypeparameter" id="id1509">DITemplateTypeParameter</a></p></li>
<li><p><a class="reference internal" href="#ditemplatevalueparameter" id="id1510">DITemplateValueParameter</a></p></li>
<li><p><a class="reference internal" href="#dinamespace" id="id1511">DINamespace</a></p></li>
<li><p><a class="reference internal" href="#diglobalvariable" id="id1512">DIGlobalVariable</a></p></li>
<li><p><a class="reference internal" href="#diglobalvariableexpression" id="id1513">DIGlobalVariableExpression</a></p></li>
<li><p><a class="reference internal" href="#disubprogram" id="id1514">DISubprogram</a></p></li>
<li><p><a class="reference internal" href="#dilexicalblock" id="id1515">DILexicalBlock</a></p></li>
<li><p><a class="reference internal" href="#dilexicalblockfile" id="id1516">DILexicalBlockFile</a></p></li>
<li><p><a class="reference internal" href="#dilocation" id="id1517">DILocation</a></p></li>
<li><p><a class="reference internal" href="#dilocalvariable" id="id1518">DILocalVariable</a></p></li>
<li><p><a class="reference internal" href="#diexpression" id="id1519">DIExpression</a></p></li>
<li><p><a class="reference internal" href="#diarglist" id="id1520">DIArgList</a></p></li>
<li><p><a class="reference internal" href="#diflags" id="id1521">DIFlags</a></p></li>
<li><p><a class="reference internal" href="#diobjcproperty" id="id1522">DIObjCProperty</a></p></li>
<li><p><a class="reference internal" href="#diimportedentity" id="id1523">DIImportedEntity</a></p></li>
<li><p><a class="reference internal" href="#dimacro" id="id1524">DIMacro</a></p></li>
<li><p><a class="reference internal" href="#dimacrofile" id="id1525">DIMacroFile</a></p></li>
<li><p><a class="reference internal" href="#dilabel" id="id1526">DILabel</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#tbaa-metadata" id="id1527">‘<code class="docutils literal notranslate"><span class="pre">tbaa</span></code>’ Metadata</a></p>
<ul>
<li><p><a class="reference internal" href="#semantics" id="id1528">Semantics</a></p></li>
<li><p><a class="reference internal" href="#representation" id="id1529">Representation</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#tbaa-struct-metadata" id="id1530">‘<code class="docutils literal notranslate"><span class="pre">tbaa.struct</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#noalias-and-alias-scope-metadata" id="id1531">‘<code class="docutils literal notranslate"><span class="pre">noalias</span></code>’ and ‘<code class="docutils literal notranslate"><span class="pre">alias.scope</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#fpmath-metadata" id="id1532">‘<code class="docutils literal notranslate"><span class="pre">fpmath</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#range-metadata" id="id1533">‘<code class="docutils literal notranslate"><span class="pre">range</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#absolute-symbol-metadata" id="id1534">‘<code class="docutils literal notranslate"><span class="pre">absolute_symbol</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#callees-metadata" id="id1535">‘<code class="docutils literal notranslate"><span class="pre">callees</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#callback-metadata" id="id1536">‘<code class="docutils literal notranslate"><span class="pre">callback</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#unpredictable-metadata" id="id1537">‘<code class="docutils literal notranslate"><span class="pre">unpredictable</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#dereferenceable-metadata" id="id1538">‘<code class="docutils literal notranslate"><span class="pre">dereferenceable</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#dereferenceable-or-null-metadata" id="id1539">‘<code class="docutils literal notranslate"><span class="pre">dereferenceable_or_null</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop" id="id1540">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop</span></code>’</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-disable-nonforced" id="id1541">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.disable_nonforced</span></code>’</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-vectorize-and-llvm-loop-interleave" id="id1542">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize</span></code>’ and ‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.interleave</span></code>’</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-interleave-count-metadata" id="id1543">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.interleave.count</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-vectorize-enable-metadata" id="id1544">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize.enable</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-vectorize-predicate-enable-metadata" id="id1545">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize.predicate.enable</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-vectorize-scalable-enable-metadata" id="id1546">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize.scalable.enable</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-vectorize-width-metadata" id="id1547">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize.width</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-vectorize-followup-vectorized-metadata" id="id1548">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize.followup_vectorized</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-vectorize-followup-epilogue-metadata" id="id1549">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize.followup_epilogue</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-vectorize-followup-all-metadata" id="id1550">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize.followup_all</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-unroll" id="id1551">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll</span></code>’</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-unroll-count-metadata" id="id1552">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.count</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-unroll-disable-metadata" id="id1553">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.disable</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-unroll-runtime-disable-metadata" id="id1554">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.runtime.disable</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-unroll-enable-metadata" id="id1555">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.enable</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-unroll-full-metadata" id="id1556">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.full</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-unroll-followup-metadata" id="id1557">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.followup</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-unroll-followup-remainder-metadata" id="id1558">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.followup_remainder</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-unroll-and-jam" id="id1559">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam</span></code>’</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-unroll-and-jam-count-metadata" id="id1560">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.count</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-unroll-and-jam-disable-metadata" id="id1561">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.disable</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-unroll-and-jam-enable-metadata" id="id1562">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.enable</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-unroll-and-jam-followup-outer-metadata" id="id1563">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.followup_outer</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-unroll-and-jam-followup-inner-metadata" id="id1564">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.followup_inner</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-unroll-and-jam-followup-remainder-outer-metadata" id="id1565">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.followup_remainder_outer</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-unroll-and-jam-followup-remainder-inner-metadata" id="id1566">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.followup_remainder_inner</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-unroll-and-jam-followup-all-metadata" id="id1567">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.followup_all</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-licm-versioning-disable-metadata" id="id1568">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.licm_versioning.disable</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-distribute-enable-metadata" id="id1569">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.distribute.enable</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-distribute-followup-coincident-metadata" id="id1570">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.distribute.followup_coincident</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-distribute-followup-sequential-metadata" id="id1571">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.distribute.followup_sequential</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-distribute-followup-fallback-metadata" id="id1572">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.distribute.followup_fallback</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-distribute-followup-all-metadata" id="id1573">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.distribute.followup_all</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-licm-disable-metadata" id="id1574">‘<code class="docutils literal notranslate"><span class="pre">llvm.licm.disable</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-access-group-metadata" id="id1575">‘<code class="docutils literal notranslate"><span class="pre">llvm.access.group</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-parallel-accesses-metadata" id="id1576">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.parallel_accesses</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#llvm-loop-mustprogress-metadata" id="id1577">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.mustprogress</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#irr-loop-metadata" id="id1578">‘<code class="docutils literal notranslate"><span class="pre">irr_loop</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#invariant-group-metadata" id="id1579">‘<code class="docutils literal notranslate"><span class="pre">invariant.group</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#type-metadata" id="id1580">‘<code class="docutils literal notranslate"><span class="pre">type</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#associated-metadata" id="id1581">‘<code class="docutils literal notranslate"><span class="pre">associated</span></code>’ Metadata</a></p></li>
<li><p><a class="reference internal" href="#prof-metadata" id="id1582">‘<code class="docutils literal notranslate"><span class="pre">prof</span></code>’ Metadata</a></p>
<ul>
<li><p><a class="reference internal" href="#branch-weights" id="id1583">branch_weights</a></p></li>
<li><p><a class="reference internal" href="#function-entry-count" id="id1584">function_entry_count</a></p></li>
<li><p><a class="reference internal" href="#vp" id="id1585">VP</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#annotation-metadata" id="id1586">‘<code class="docutils literal notranslate"><span class="pre">annotation</span></code>’ Metadata</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#module-flags-metadata" id="id1587">Module Flags Metadata</a></p>
<ul>
<li><p><a class="reference internal" href="#synthesized-functions-module-flags-metadata" id="id1588">Synthesized Functions Module Flags Metadata</a></p></li>
<li><p><a class="reference internal" href="#objective-c-garbage-collection-module-flags-metadata" id="id1589">Objective-C Garbage Collection Module Flags Metadata</a></p></li>
<li><p><a class="reference internal" href="#c-type-width-module-flags-metadata" id="id1590">C type width Module Flags Metadata</a></p></li>
<li><p><a class="reference internal" href="#lto-post-link-module-flags-metadata" id="id1591">LTO Post-Link Module Flags Metadata</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#automatic-linker-flags-named-metadata" id="id1592">Automatic Linker Flags Named Metadata</a></p></li>
<li><p><a class="reference internal" href="#dependent-libs-named-metadata" id="id1593">Dependent Libs Named Metadata</a></p></li>
<li><p><a class="reference internal" href="#thinlto-summary" id="id1594">ThinLTO Summary</a></p>
<ul>
<li><p><a class="reference internal" href="#module-path-summary-entry" id="id1595">Module Path Summary Entry</a></p></li>
<li><p><a class="reference internal" href="#global-value-summary-entry" id="id1596">Global Value Summary Entry</a></p>
<ul>
<li><p><a class="reference internal" href="#function-summary" id="id1597">Function Summary</a></p></li>
<li><p><a class="reference internal" href="#global-variable-summary" id="id1598">Global Variable Summary</a></p></li>
<li><p><a class="reference internal" href="#alias-summary" id="id1599">Alias Summary</a></p></li>
<li><p><a class="reference internal" href="#function-flags" id="id1600">Function Flags</a></p></li>
<li><p><a class="reference internal" href="#calls" id="id1601">Calls</a></p></li>
<li><p><a class="reference internal" href="#params" id="id1602">Params</a></p></li>
<li><p><a class="reference internal" href="#refs" id="id1603">Refs</a></p></li>
<li><p><a class="reference internal" href="#typeidinfo" id="id1604">TypeIdInfo</a></p>
<ul>
<li><p><a class="reference internal" href="#typetests" id="id1605">TypeTests</a></p></li>
<li><p><a class="reference internal" href="#typetestassumevcalls" id="id1606">TypeTestAssumeVCalls</a></p></li>
<li><p><a class="reference internal" href="#typecheckedloadvcalls" id="id1607">TypeCheckedLoadVCalls</a></p></li>
<li><p><a class="reference internal" href="#typetestassumeconstvcalls" id="id1608">TypeTestAssumeConstVCalls</a></p></li>
<li><p><a class="reference internal" href="#typecheckedloadconstvcalls" id="id1609">TypeCheckedLoadConstVCalls</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#type-id-summary-entry" id="id1610">Type ID Summary Entry</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#intrinsic-global-variables" id="id1611">Intrinsic Global Variables</a></p>
<ul>
<li><p><a class="reference internal" href="#the-llvm-used-global-variable" id="id1612">The ‘<code class="docutils literal notranslate"><span class="pre">llvm.used</span></code>’ Global Variable</a></p></li>
<li><p><a class="reference internal" href="#the-llvm-compiler-used-global-variable" id="id1613">The ‘<code class="docutils literal notranslate"><span class="pre">llvm.compiler.used</span></code>’ Global Variable</a></p></li>
<li><p><a class="reference internal" href="#the-llvm-global-ctors-global-variable" id="id1614">The ‘<code class="docutils literal notranslate"><span class="pre">llvm.global_ctors</span></code>’ Global Variable</a></p></li>
<li><p><a class="reference internal" href="#the-llvm-global-dtors-global-variable" id="id1615">The ‘<code class="docutils literal notranslate"><span class="pre">llvm.global_dtors</span></code>’ Global Variable</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#instruction-reference" id="id1616">Instruction Reference</a></p>
<ul>
<li><p><a class="reference internal" href="#terminator-instructions" id="id1617">Terminator Instructions</a></p>
<ul>
<li><p><a class="reference internal" href="#ret-instruction" id="id1618">‘<code class="docutils literal notranslate"><span class="pre">ret</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#syntax" id="id1619">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#overview" id="id1620">Overview:</a></p></li>
<li><p><a class="reference internal" href="#arguments" id="id1621">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id28" id="id1622">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#example" id="id1623">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#br-instruction" id="id1624">‘<code class="docutils literal notranslate"><span class="pre">br</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id29" id="id1625">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id30" id="id1626">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id31" id="id1627">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id32" id="id1628">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id33" id="id1629">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#switch-instruction" id="id1630">‘<code class="docutils literal notranslate"><span class="pre">switch</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id34" id="id1631">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id35" id="id1632">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id36" id="id1633">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id37" id="id1634">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#implementation" id="id1635">Implementation:</a></p></li>
<li><p><a class="reference internal" href="#id38" id="id1636">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#indirectbr-instruction" id="id1637">‘<code class="docutils literal notranslate"><span class="pre">indirectbr</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id39" id="id1638">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id40" id="id1639">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id41" id="id1640">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id42" id="id1641">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id43" id="id1642">Implementation:</a></p></li>
<li><p><a class="reference internal" href="#id44" id="id1643">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#invoke-instruction" id="id1644">‘<code class="docutils literal notranslate"><span class="pre">invoke</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id45" id="id1645">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id46" id="id1646">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id47" id="id1647">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id48" id="id1648">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id49" id="id1649">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#callbr-instruction" id="id1650">‘<code class="docutils literal notranslate"><span class="pre">callbr</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id50" id="id1651">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id51" id="id1652">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id52" id="id1653">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id53" id="id1654">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id54" id="id1655">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#resume-instruction" id="id1656">‘<code class="docutils literal notranslate"><span class="pre">resume</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id55" id="id1657">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id56" id="id1658">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id57" id="id1659">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id58" id="id1660">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id59" id="id1661">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#catchswitch-instruction" id="id1662">‘<code class="docutils literal notranslate"><span class="pre">catchswitch</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id60" id="id1663">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id61" id="id1664">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id62" id="id1665">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id63" id="id1666">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id64" id="id1667">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#catchret-instruction" id="id1668">‘<code class="docutils literal notranslate"><span class="pre">catchret</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id65" id="id1669">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id66" id="id1670">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id67" id="id1671">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id68" id="id1672">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id69" id="id1673">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#cleanupret-instruction" id="id1674">‘<code class="docutils literal notranslate"><span class="pre">cleanupret</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id70" id="id1675">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id71" id="id1676">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id72" id="id1677">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id75" id="id1678">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id76" id="id1679">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#unreachable-instruction" id="id1680">‘<code class="docutils literal notranslate"><span class="pre">unreachable</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id77" id="id1681">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id78" id="id1682">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id79" id="id1683">Semantics:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#unary-operations" id="id1684">Unary Operations</a></p>
<ul>
<li><p><a class="reference internal" href="#fneg-instruction" id="id1685">‘<code class="docutils literal notranslate"><span class="pre">fneg</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id80" id="id1686">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id81" id="id1687">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id82" id="id1688">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id83" id="id1689">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id84" id="id1690">Example:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#binary-operations" id="id1691">Binary Operations</a></p>
<ul>
<li><p><a class="reference internal" href="#add-instruction" id="id1692">‘<code class="docutils literal notranslate"><span class="pre">add</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id85" id="id1693">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id86" id="id1694">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id87" id="id1695">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id88" id="id1696">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id89" id="id1697">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#fadd-instruction" id="id1698">‘<code class="docutils literal notranslate"><span class="pre">fadd</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id90" id="id1699">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id91" id="id1700">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id92" id="id1701">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id93" id="id1702">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id94" id="id1703">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#sub-instruction" id="id1704">‘<code class="docutils literal notranslate"><span class="pre">sub</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id95" id="id1705">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id96" id="id1706">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id97" id="id1707">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id98" id="id1708">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id99" id="id1709">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#fsub-instruction" id="id1710">‘<code class="docutils literal notranslate"><span class="pre">fsub</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id100" id="id1711">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id101" id="id1712">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id102" id="id1713">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id103" id="id1714">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id104" id="id1715">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#mul-instruction" id="id1716">‘<code class="docutils literal notranslate"><span class="pre">mul</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id105" id="id1717">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id106" id="id1718">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id107" id="id1719">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id108" id="id1720">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id109" id="id1721">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#fmul-instruction" id="id1722">‘<code class="docutils literal notranslate"><span class="pre">fmul</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id110" id="id1723">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id111" id="id1724">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id112" id="id1725">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id113" id="id1726">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id114" id="id1727">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#udiv-instruction" id="id1728">‘<code class="docutils literal notranslate"><span class="pre">udiv</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id115" id="id1729">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id116" id="id1730">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id117" id="id1731">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id118" id="id1732">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id119" id="id1733">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#sdiv-instruction" id="id1734">‘<code class="docutils literal notranslate"><span class="pre">sdiv</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id120" id="id1735">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id121" id="id1736">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id122" id="id1737">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id123" id="id1738">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id124" id="id1739">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#fdiv-instruction" id="id1740">‘<code class="docutils literal notranslate"><span class="pre">fdiv</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id125" id="id1741">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id126" id="id1742">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id127" id="id1743">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id128" id="id1744">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id129" id="id1745">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#urem-instruction" id="id1746">‘<code class="docutils literal notranslate"><span class="pre">urem</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id130" id="id1747">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id131" id="id1748">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id132" id="id1749">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id133" id="id1750">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id134" id="id1751">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#srem-instruction" id="id1752">‘<code class="docutils literal notranslate"><span class="pre">srem</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id135" id="id1753">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id136" id="id1754">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id137" id="id1755">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id138" id="id1756">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id139" id="id1757">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#frem-instruction" id="id1758">‘<code class="docutils literal notranslate"><span class="pre">frem</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id140" id="id1759">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id141" id="id1760">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id142" id="id1761">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id143" id="id1762">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id144" id="id1763">Example:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#bitwise-binary-operations" id="id1764">Bitwise Binary Operations</a></p>
<ul>
<li><p><a class="reference internal" href="#shl-instruction" id="id1765">‘<code class="docutils literal notranslate"><span class="pre">shl</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id145" id="id1766">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id146" id="id1767">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id147" id="id1768">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id148" id="id1769">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id149" id="id1770">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#lshr-instruction" id="id1771">‘<code class="docutils literal notranslate"><span class="pre">lshr</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id150" id="id1772">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id151" id="id1773">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id152" id="id1774">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id153" id="id1775">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id154" id="id1776">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#ashr-instruction" id="id1777">‘<code class="docutils literal notranslate"><span class="pre">ashr</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id155" id="id1778">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id156" id="id1779">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id157" id="id1780">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id158" id="id1781">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id159" id="id1782">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#and-instruction" id="id1783">‘<code class="docutils literal notranslate"><span class="pre">and</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id160" id="id1784">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id161" id="id1785">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id162" id="id1786">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id163" id="id1787">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id164" id="id1788">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#or-instruction" id="id1789">‘<code class="docutils literal notranslate"><span class="pre">or</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id165" id="id1790">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id166" id="id1791">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id167" id="id1792">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id168" id="id1793">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id169" id="id1794">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#xor-instruction" id="id1795">‘<code class="docutils literal notranslate"><span class="pre">xor</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id170" id="id1796">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id171" id="id1797">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id172" id="id1798">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id173" id="id1799">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id174" id="id1800">Example:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#vector-operations" id="id1801">Vector Operations</a></p>
<ul>
<li><p><a class="reference internal" href="#extractelement-instruction" id="id1802">‘<code class="docutils literal notranslate"><span class="pre">extractelement</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id175" id="id1803">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id176" id="id1804">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id177" id="id1805">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id178" id="id1806">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id179" id="id1807">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#insertelement-instruction" id="id1808">‘<code class="docutils literal notranslate"><span class="pre">insertelement</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id180" id="id1809">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id181" id="id1810">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id182" id="id1811">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id183" id="id1812">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id184" id="id1813">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#shufflevector-instruction" id="id1814">‘<code class="docutils literal notranslate"><span class="pre">shufflevector</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id185" id="id1815">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id186" id="id1816">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id187" id="id1817">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id188" id="id1818">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id189" id="id1819">Example:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#aggregate-operations" id="id1820">Aggregate Operations</a></p>
<ul>
<li><p><a class="reference internal" href="#extractvalue-instruction" id="id1821">‘<code class="docutils literal notranslate"><span class="pre">extractvalue</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id190" id="id1822">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id191" id="id1823">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id192" id="id1824">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id193" id="id1825">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id194" id="id1826">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#insertvalue-instruction" id="id1827">‘<code class="docutils literal notranslate"><span class="pre">insertvalue</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id195" id="id1828">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id196" id="id1829">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id197" id="id1830">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id198" id="id1831">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id199" id="id1832">Example:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#memory-access-and-addressing-operations" id="id1833">Memory Access and Addressing Operations</a></p>
<ul>
<li><p><a class="reference internal" href="#alloca-instruction" id="id1834">‘<code class="docutils literal notranslate"><span class="pre">alloca</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id200" id="id1835">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id201" id="id1836">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id202" id="id1837">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id203" id="id1838">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id204" id="id1839">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#load-instruction" id="id1840">‘<code class="docutils literal notranslate"><span class="pre">load</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id205" id="id1841">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id206" id="id1842">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id207" id="id1843">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id208" id="id1844">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id209" id="id1845">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#store-instruction" id="id1846">‘<code class="docutils literal notranslate"><span class="pre">store</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id210" id="id1847">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id211" id="id1848">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id212" id="id1849">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id213" id="id1850">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id214" id="id1851">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#fence-instruction" id="id1852">‘<code class="docutils literal notranslate"><span class="pre">fence</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id215" id="id1853">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id216" id="id1854">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id217" id="id1855">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id218" id="id1856">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id219" id="id1857">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#cmpxchg-instruction" id="id1858">‘<code class="docutils literal notranslate"><span class="pre">cmpxchg</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id220" id="id1859">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id221" id="id1860">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id222" id="id1861">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id223" id="id1862">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id224" id="id1863">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#atomicrmw-instruction" id="id1864">‘<code class="docutils literal notranslate"><span class="pre">atomicrmw</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id225" id="id1865">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id226" id="id1866">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id227" id="id1867">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id228" id="id1868">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id229" id="id1869">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#getelementptr-instruction" id="id1870">‘<code class="docutils literal notranslate"><span class="pre">getelementptr</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id230" id="id1871">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id231" id="id1872">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id232" id="id1873">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id233" id="id1874">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id234" id="id1875">Example:</a></p></li>
<li><p><a class="reference internal" href="#vector-of-pointers" id="id1876">Vector of pointers:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#conversion-operations" id="id1877">Conversion Operations</a></p>
<ul>
<li><p><a class="reference internal" href="#trunc-to-instruction" id="id1878">‘<code class="docutils literal notranslate"><span class="pre">trunc</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id235" id="id1879">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id236" id="id1880">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id237" id="id1881">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id238" id="id1882">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id239" id="id1883">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#zext-to-instruction" id="id1884">‘<code class="docutils literal notranslate"><span class="pre">zext</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id240" id="id1885">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id241" id="id1886">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id242" id="id1887">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id243" id="id1888">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id244" id="id1889">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#sext-to-instruction" id="id1890">‘<code class="docutils literal notranslate"><span class="pre">sext</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id245" id="id1891">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id246" id="id1892">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id247" id="id1893">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id248" id="id1894">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id249" id="id1895">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#fptrunc-to-instruction" id="id1896">‘<code class="docutils literal notranslate"><span class="pre">fptrunc</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id250" id="id1897">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id251" id="id1898">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id252" id="id1899">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id253" id="id1900">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id254" id="id1901">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#fpext-to-instruction" id="id1902">‘<code class="docutils literal notranslate"><span class="pre">fpext</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id255" id="id1903">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id256" id="id1904">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id257" id="id1905">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id258" id="id1906">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id259" id="id1907">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#fptoui-to-instruction" id="id1908">‘<code class="docutils literal notranslate"><span class="pre">fptoui</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id260" id="id1909">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id261" id="id1910">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id262" id="id1911">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id263" id="id1912">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id264" id="id1913">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#fptosi-to-instruction" id="id1914">‘<code class="docutils literal notranslate"><span class="pre">fptosi</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id265" id="id1915">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id266" id="id1916">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id267" id="id1917">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id268" id="id1918">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id269" id="id1919">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#uitofp-to-instruction" id="id1920">‘<code class="docutils literal notranslate"><span class="pre">uitofp</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id270" id="id1921">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id271" id="id1922">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id272" id="id1923">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id273" id="id1924">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id274" id="id1925">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#sitofp-to-instruction" id="id1926">‘<code class="docutils literal notranslate"><span class="pre">sitofp</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id275" id="id1927">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id276" id="id1928">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id277" id="id1929">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id278" id="id1930">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id279" id="id1931">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#ptrtoint-to-instruction" id="id1932">‘<code class="docutils literal notranslate"><span class="pre">ptrtoint</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id280" id="id1933">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id281" id="id1934">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id282" id="id1935">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id283" id="id1936">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id284" id="id1937">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#inttoptr-to-instruction" id="id1938">‘<code class="docutils literal notranslate"><span class="pre">inttoptr</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id285" id="id1939">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id286" id="id1940">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id287" id="id1941">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id288" id="id1942">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id289" id="id1943">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#bitcast-to-instruction" id="id1944">‘<code class="docutils literal notranslate"><span class="pre">bitcast</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id290" id="id1945">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id291" id="id1946">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id292" id="id1947">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id293" id="id1948">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id294" id="id1949">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#addrspacecast-to-instruction" id="id1950">‘<code class="docutils literal notranslate"><span class="pre">addrspacecast</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id295" id="id1951">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id296" id="id1952">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id297" id="id1953">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id298" id="id1954">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id299" id="id1955">Example:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#other-operations" id="id1956">Other Operations</a></p>
<ul>
<li><p><a class="reference internal" href="#icmp-instruction" id="id1957">‘<code class="docutils literal notranslate"><span class="pre">icmp</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id300" id="id1958">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id301" id="id1959">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id302" id="id1960">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id303" id="id1961">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id304" id="id1962">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#fcmp-instruction" id="id1963">‘<code class="docutils literal notranslate"><span class="pre">fcmp</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id305" id="id1964">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id306" id="id1965">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id307" id="id1966">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id308" id="id1967">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id309" id="id1968">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#phi-instruction" id="id1969">‘<code class="docutils literal notranslate"><span class="pre">phi</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id310" id="id1970">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id311" id="id1971">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id312" id="id1972">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id313" id="id1973">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id314" id="id1974">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#select-instruction" id="id1975">‘<code class="docutils literal notranslate"><span class="pre">select</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id315" id="id1976">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id316" id="id1977">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id317" id="id1978">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id318" id="id1979">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id319" id="id1980">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#freeze-instruction" id="id1981">‘<code class="docutils literal notranslate"><span class="pre">freeze</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id320" id="id1982">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id321" id="id1983">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id322" id="id1984">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id323" id="id1985">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id324" id="id1986">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#call-instruction" id="id1987">‘<code class="docutils literal notranslate"><span class="pre">call</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id325" id="id1988">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id326" id="id1989">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id327" id="id1990">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id328" id="id1991">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id329" id="id1992">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#va-arg-instruction" id="id1993">‘<code class="docutils literal notranslate"><span class="pre">va_arg</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id330" id="id1994">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id331" id="id1995">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id332" id="id1996">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id333" id="id1997">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id334" id="id1998">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#landingpad-instruction" id="id1999">‘<code class="docutils literal notranslate"><span class="pre">landingpad</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id335" id="id2000">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id336" id="id2001">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id338" id="id2002">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id339" id="id2003">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id340" id="id2004">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#catchpad-instruction" id="id2005">‘<code class="docutils literal notranslate"><span class="pre">catchpad</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id341" id="id2006">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id342" id="id2007">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id344" id="id2008">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id345" id="id2009">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id347" id="id2010">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#cleanuppad-instruction" id="id2011">‘<code class="docutils literal notranslate"><span class="pre">cleanuppad</span></code>’ Instruction</a></p>
<ul>
<li><p><a class="reference internal" href="#id348" id="id2012">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id349" id="id2013">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id351" id="id2014">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id352" id="id2015">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id354" id="id2016">Example:</a></p></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#intrinsic-functions" id="id2017">Intrinsic Functions</a></p>
<ul>
<li><p><a class="reference internal" href="#variable-argument-handling-intrinsics" id="id2018">Variable Argument Handling Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-va-start-intrinsic" id="id2019">‘<code class="docutils literal notranslate"><span class="pre">llvm.va_start</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id355" id="id2020">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id356" id="id2021">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id357" id="id2022">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id358" id="id2023">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-va-end-intrinsic" id="id2024">‘<code class="docutils literal notranslate"><span class="pre">llvm.va_end</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id359" id="id2025">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id360" id="id2026">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id361" id="id2027">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id362" id="id2028">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-va-copy-intrinsic" id="id2029">‘<code class="docutils literal notranslate"><span class="pre">llvm.va_copy</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id363" id="id2030">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id364" id="id2031">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id365" id="id2032">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id366" id="id2033">Semantics:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#accurate-garbage-collection-intrinsics" id="id2034">Accurate Garbage Collection Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-gcroot-intrinsic" id="id2035">‘<code class="docutils literal notranslate"><span class="pre">llvm.gcroot</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id368" id="id2036">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id369" id="id2037">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id370" id="id2038">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id371" id="id2039">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-gcread-intrinsic" id="id2040">‘<code class="docutils literal notranslate"><span class="pre">llvm.gcread</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id372" id="id2041">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id373" id="id2042">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id374" id="id2043">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id375" id="id2044">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-gcwrite-intrinsic" id="id2045">‘<code class="docutils literal notranslate"><span class="pre">llvm.gcwrite</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id376" id="id2046">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id377" id="id2047">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id378" id="id2048">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id379" id="id2049">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-gc-statepoint-intrinsic" id="id2050">‘llvm.experimental.gc.statepoint’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id380" id="id2051">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id381" id="id2052">Overview:</a></p></li>
<li><p><a class="reference internal" href="#operands" id="id2053">Operands:</a></p></li>
<li><p><a class="reference internal" href="#id382" id="id2054">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-gc-result-intrinsic" id="id2055">‘llvm.experimental.gc.result’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id383" id="id2056">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id384" id="id2057">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id385" id="id2058">Operands:</a></p></li>
<li><p><a class="reference internal" href="#id386" id="id2059">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-gc-relocate-intrinsic" id="id2060">‘llvm.experimental.gc.relocate’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id387" id="id2061">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id388" id="id2062">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id389" id="id2063">Operands:</a></p></li>
<li><p><a class="reference internal" href="#id390" id="id2064">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-gc-get-pointer-base-intrinsic" id="id2065">‘llvm.experimental.gc.get.pointer.base’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id391" id="id2066">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id392" id="id2067">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id393" id="id2068">Operands:</a></p></li>
<li><p><a class="reference internal" href="#id394" id="id2069">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-gc-get-pointer-offset-intrinsic" id="id2070">‘llvm.experimental.gc.get.pointer.offset’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id395" id="id2071">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id396" id="id2072">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id397" id="id2073">Operands:</a></p></li>
<li><p><a class="reference internal" href="#id398" id="id2074">Semantics:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#code-generator-intrinsics" id="id2075">Code Generator Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-returnaddress-intrinsic" id="id2076">‘<code class="docutils literal notranslate"><span class="pre">llvm.returnaddress</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id399" id="id2077">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id400" id="id2078">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id401" id="id2079">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id402" id="id2080">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-addressofreturnaddress-intrinsic" id="id2081">‘<code class="docutils literal notranslate"><span class="pre">llvm.addressofreturnaddress</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id403" id="id2082">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id404" id="id2083">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id405" id="id2084">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-sponentry-intrinsic" id="id2085">‘<code class="docutils literal notranslate"><span class="pre">llvm.sponentry</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id406" id="id2086">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id407" id="id2087">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id408" id="id2088">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-frameaddress-intrinsic" id="id2089">‘<code class="docutils literal notranslate"><span class="pre">llvm.frameaddress</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id409" id="id2090">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id410" id="id2091">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id411" id="id2092">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id412" id="id2093">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-swift-async-context-addr-intrinsic" id="id2094">‘<code class="docutils literal notranslate"><span class="pre">llvm.swift.async.context.addr</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id413" id="id2095">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id414" id="id2096">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id415" id="id2097">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-localescape-and-llvm-localrecover-intrinsics" id="id2098">‘<code class="docutils literal notranslate"><span class="pre">llvm.localescape</span></code>’ and ‘<code class="docutils literal notranslate"><span class="pre">llvm.localrecover</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id416" id="id2099">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id417" id="id2100">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id418" id="id2101">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id419" id="id2102">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-seh-try-begin-and-llvm-seh-try-end-intrinsics" id="id2103">‘<code class="docutils literal notranslate"><span class="pre">llvm.seh.try.begin</span></code>’ and ‘<code class="docutils literal notranslate"><span class="pre">llvm.seh.try.end</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id420" id="id2104">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id421" id="id2105">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id422" id="id2106">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-seh-scope-begin-and-llvm-seh-scope-end-intrinsics" id="id2107">‘<code class="docutils literal notranslate"><span class="pre">llvm.seh.scope.begin</span></code>’ and ‘<code class="docutils literal notranslate"><span class="pre">llvm.seh.scope.end</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id423" id="id2108">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id424" id="id2109">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id425" id="id2110">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-read-register-llvm-read-volatile-register-and-llvm-write-register-intrinsics" id="id2111">‘<code class="docutils literal notranslate"><span class="pre">llvm.read_register</span></code>’, ‘<code class="docutils literal notranslate"><span class="pre">llvm.read_volatile_register</span></code>’, and ‘<code class="docutils literal notranslate"><span class="pre">llvm.write_register</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id426" id="id2112">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id427" id="id2113">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id428" id="id2114">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-stacksave-intrinsic" id="id2115">‘<code class="docutils literal notranslate"><span class="pre">llvm.stacksave</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id429" id="id2116">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id430" id="id2117">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id431" id="id2118">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-stackrestore-intrinsic" id="id2119">‘<code class="docutils literal notranslate"><span class="pre">llvm.stackrestore</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id432" id="id2120">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id433" id="id2121">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id434" id="id2122">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-get-dynamic-area-offset-intrinsic" id="id2123">‘<code class="docutils literal notranslate"><span class="pre">llvm.get.dynamic.area.offset</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id435" id="id2124">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id436" id="id2125">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id437" id="id2126">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-prefetch-intrinsic" id="id2127">‘<code class="docutils literal notranslate"><span class="pre">llvm.prefetch</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id438" id="id2128">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id439" id="id2129">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id440" id="id2130">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id441" id="id2131">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-pcmarker-intrinsic" id="id2132">‘<code class="docutils literal notranslate"><span class="pre">llvm.pcmarker</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id442" id="id2133">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id443" id="id2134">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id444" id="id2135">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id445" id="id2136">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-readcyclecounter-intrinsic" id="id2137">‘<code class="docutils literal notranslate"><span class="pre">llvm.readcyclecounter</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id446" id="id2138">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id447" id="id2139">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id448" id="id2140">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-clear-cache-intrinsic" id="id2141">‘<code class="docutils literal notranslate"><span class="pre">llvm.clear_cache</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id449" id="id2142">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id450" id="id2143">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id451" id="id2144">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-instrprof-increment-intrinsic" id="id2145">‘<code class="docutils literal notranslate"><span class="pre">llvm.instrprof.increment</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id452" id="id2146">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id453" id="id2147">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id454" id="id2148">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id455" id="id2149">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-instrprof-increment-step-intrinsic" id="id2150">‘<code class="docutils literal notranslate"><span class="pre">llvm.instrprof.increment.step</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id456" id="id2151">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id457" id="id2152">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id458" id="id2153">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id459" id="id2154">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-instrprof-value-profile-intrinsic" id="id2155">‘<code class="docutils literal notranslate"><span class="pre">llvm.instrprof.value.profile</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id460" id="id2156">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id461" id="id2157">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id462" id="id2158">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id463" id="id2159">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-thread-pointer-intrinsic" id="id2160">‘<code class="docutils literal notranslate"><span class="pre">llvm.thread.pointer</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id464" id="id2161">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id465" id="id2162">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id466" id="id2163">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-call-preallocated-setup-intrinsic" id="id2164">‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.setup</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id467" id="id2165">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id468" id="id2166">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id469" id="id2167">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-call-preallocated-arg-intrinsic" id="id2168">‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.arg</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id470" id="id2169">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id471" id="id2170">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id472" id="id2171">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-call-preallocated-teardown-intrinsic" id="id2172">‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.teardown</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id473" id="id2173">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id474" id="id2174">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id475" id="id2175">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id476" id="id2176">Example:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#standard-c-c-library-intrinsics" id="id2177">Standard C/C++ Library Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-abs-intrinsic" id="id2178">‘<code class="docutils literal notranslate"><span class="pre">llvm.abs.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id477" id="id2179">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id478" id="id2180">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id479" id="id2181">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id480" id="id2182">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-smax-intrinsic" id="id2183">‘<code class="docutils literal notranslate"><span class="pre">llvm.smax.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id481" id="id2184">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id482" id="id2185">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id483" id="id2186">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-smin-intrinsic" id="id2187">‘<code class="docutils literal notranslate"><span class="pre">llvm.smin.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id484" id="id2188">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id485" id="id2189">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id486" id="id2190">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-umax-intrinsic" id="id2191">‘<code class="docutils literal notranslate"><span class="pre">llvm.umax.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id487" id="id2192">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id488" id="id2193">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id489" id="id2194">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-umin-intrinsic" id="id2195">‘<code class="docutils literal notranslate"><span class="pre">llvm.umin.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id490" id="id2196">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id491" id="id2197">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id492" id="id2198">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-memcpy-intrinsic" id="id2199">‘<code class="docutils literal notranslate"><span class="pre">llvm.memcpy</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id493" id="id2200">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id494" id="id2201">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id495" id="id2202">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id496" id="id2203">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-memcpy-inline-intrinsic" id="id2204">‘<code class="docutils literal notranslate"><span class="pre">llvm.memcpy.inline</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id497" id="id2205">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id498" id="id2206">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id499" id="id2207">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id500" id="id2208">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-memmove-intrinsic" id="id2209">‘<code class="docutils literal notranslate"><span class="pre">llvm.memmove</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id501" id="id2210">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id502" id="id2211">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id503" id="id2212">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id504" id="id2213">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-memset-intrinsics" id="id2214">‘<code class="docutils literal notranslate"><span class="pre">llvm.memset.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id505" id="id2215">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id506" id="id2216">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id507" id="id2217">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id508" id="id2218">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-sqrt-intrinsic" id="id2219">‘<code class="docutils literal notranslate"><span class="pre">llvm.sqrt.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id509" id="id2220">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id510" id="id2221">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id511" id="id2222">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id512" id="id2223">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-powi-intrinsic" id="id2224">‘<code class="docutils literal notranslate"><span class="pre">llvm.powi.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id513" id="id2225">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id514" id="id2226">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id515" id="id2227">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id516" id="id2228">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-sin-intrinsic" id="id2229">‘<code class="docutils literal notranslate"><span class="pre">llvm.sin.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id517" id="id2230">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id518" id="id2231">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id519" id="id2232">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id520" id="id2233">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-cos-intrinsic" id="id2234">‘<code class="docutils literal notranslate"><span class="pre">llvm.cos.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id521" id="id2235">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id522" id="id2236">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id523" id="id2237">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id524" id="id2238">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-pow-intrinsic" id="id2239">‘<code class="docutils literal notranslate"><span class="pre">llvm.pow.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id525" id="id2240">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id526" id="id2241">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id527" id="id2242">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id528" id="id2243">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-exp-intrinsic" id="id2244">‘<code class="docutils literal notranslate"><span class="pre">llvm.exp.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id529" id="id2245">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id530" id="id2246">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id531" id="id2247">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id532" id="id2248">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-exp2-intrinsic" id="id2249">‘<code class="docutils literal notranslate"><span class="pre">llvm.exp2.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id533" id="id2250">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id534" id="id2251">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id535" id="id2252">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id536" id="id2253">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-log-intrinsic" id="id2254">‘<code class="docutils literal notranslate"><span class="pre">llvm.log.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id537" id="id2255">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id538" id="id2256">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id539" id="id2257">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id540" id="id2258">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-log10-intrinsic" id="id2259">‘<code class="docutils literal notranslate"><span class="pre">llvm.log10.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id541" id="id2260">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id542" id="id2261">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id543" id="id2262">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id544" id="id2263">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-log2-intrinsic" id="id2264">‘<code class="docutils literal notranslate"><span class="pre">llvm.log2.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id545" id="id2265">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id546" id="id2266">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id547" id="id2267">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id548" id="id2268">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-fma-intrinsic" id="id2269">‘<code class="docutils literal notranslate"><span class="pre">llvm.fma.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id549" id="id2270">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id550" id="id2271">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id551" id="id2272">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id552" id="id2273">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-fabs-intrinsic" id="id2274">‘<code class="docutils literal notranslate"><span class="pre">llvm.fabs.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id553" id="id2275">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id554" id="id2276">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id555" id="id2277">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id556" id="id2278">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-minnum-intrinsic" id="id2279">‘<code class="docutils literal notranslate"><span class="pre">llvm.minnum.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id557" id="id2280">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id558" id="id2281">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id559" id="id2282">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id560" id="id2283">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-maxnum-intrinsic" id="id2284">‘<code class="docutils literal notranslate"><span class="pre">llvm.maxnum.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id561" id="id2285">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id562" id="id2286">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id563" id="id2287">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id564" id="id2288">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-minimum-intrinsic" id="id2289">‘<code class="docutils literal notranslate"><span class="pre">llvm.minimum.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id565" id="id2290">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id566" id="id2291">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id567" id="id2292">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id568" id="id2293">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-maximum-intrinsic" id="id2294">‘<code class="docutils literal notranslate"><span class="pre">llvm.maximum.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id569" id="id2295">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id570" id="id2296">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id571" id="id2297">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id572" id="id2298">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-copysign-intrinsic" id="id2299">‘<code class="docutils literal notranslate"><span class="pre">llvm.copysign.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id573" id="id2300">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id574" id="id2301">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id575" id="id2302">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id576" id="id2303">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-floor-intrinsic" id="id2304">‘<code class="docutils literal notranslate"><span class="pre">llvm.floor.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id577" id="id2305">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id578" id="id2306">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id579" id="id2307">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id580" id="id2308">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-ceil-intrinsic" id="id2309">‘<code class="docutils literal notranslate"><span class="pre">llvm.ceil.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id581" id="id2310">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id582" id="id2311">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id583" id="id2312">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id584" id="id2313">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-trunc-intrinsic" id="id2314">‘<code class="docutils literal notranslate"><span class="pre">llvm.trunc.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id585" id="id2315">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id586" id="id2316">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id587" id="id2317">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id588" id="id2318">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-rint-intrinsic" id="id2319">‘<code class="docutils literal notranslate"><span class="pre">llvm.rint.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id589" id="id2320">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id590" id="id2321">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id591" id="id2322">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id592" id="id2323">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-nearbyint-intrinsic" id="id2324">‘<code class="docutils literal notranslate"><span class="pre">llvm.nearbyint.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id593" id="id2325">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id594" id="id2326">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id595" id="id2327">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id596" id="id2328">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-round-intrinsic" id="id2329">‘<code class="docutils literal notranslate"><span class="pre">llvm.round.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id597" id="id2330">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id598" id="id2331">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id599" id="id2332">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id600" id="id2333">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-roundeven-intrinsic" id="id2334">‘<code class="docutils literal notranslate"><span class="pre">llvm.roundeven.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id601" id="id2335">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id602" id="id2336">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id603" id="id2337">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id604" id="id2338">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-lround-intrinsic" id="id2339">‘<code class="docutils literal notranslate"><span class="pre">llvm.lround.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id605" id="id2340">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id606" id="id2341">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id607" id="id2342">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id608" id="id2343">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-llround-intrinsic" id="id2344">‘<code class="docutils literal notranslate"><span class="pre">llvm.llround.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id609" id="id2345">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id610" id="id2346">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id611" id="id2347">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id612" id="id2348">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-lrint-intrinsic" id="id2349">‘<code class="docutils literal notranslate"><span class="pre">llvm.lrint.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id613" id="id2350">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id614" id="id2351">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id615" id="id2352">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id616" id="id2353">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-llrint-intrinsic" id="id2354">‘<code class="docutils literal notranslate"><span class="pre">llvm.llrint.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id617" id="id2355">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id618" id="id2356">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id619" id="id2357">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id620" id="id2358">Semantics:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#bit-manipulation-intrinsics" id="id2359">Bit Manipulation Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-bitreverse-intrinsics" id="id2360">‘<code class="docutils literal notranslate"><span class="pre">llvm.bitreverse.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id621" id="id2361">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id622" id="id2362">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id623" id="id2363">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-bswap-intrinsics" id="id2364">‘<code class="docutils literal notranslate"><span class="pre">llvm.bswap.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id624" id="id2365">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id625" id="id2366">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id626" id="id2367">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-ctpop-intrinsic" id="id2368">‘<code class="docutils literal notranslate"><span class="pre">llvm.ctpop.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id627" id="id2369">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id628" id="id2370">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id629" id="id2371">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id630" id="id2372">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-ctlz-intrinsic" id="id2373">‘<code class="docutils literal notranslate"><span class="pre">llvm.ctlz.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id631" id="id2374">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id632" id="id2375">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id633" id="id2376">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id634" id="id2377">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-cttz-intrinsic" id="id2378">‘<code class="docutils literal notranslate"><span class="pre">llvm.cttz.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id635" id="id2379">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id636" id="id2380">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id637" id="id2381">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id638" id="id2382">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-fshl-intrinsic" id="id2383">‘<code class="docutils literal notranslate"><span class="pre">llvm.fshl.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id639" id="id2384">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id640" id="id2385">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id641" id="id2386">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id642" id="id2387">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-fshr-intrinsic" id="id2388">‘<code class="docutils literal notranslate"><span class="pre">llvm.fshr.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id643" id="id2389">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id644" id="id2390">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id645" id="id2391">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id646" id="id2392">Example:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#arithmetic-with-overflow-intrinsics" id="id2393">Arithmetic with Overflow Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-sadd-with-overflow-intrinsics" id="id2394">‘<code class="docutils literal notranslate"><span class="pre">llvm.sadd.with.overflow.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id647" id="id2395">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id648" id="id2396">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id649" id="id2397">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id650" id="id2398">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id651" id="id2399">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-uadd-with-overflow-intrinsics" id="id2400">‘<code class="docutils literal notranslate"><span class="pre">llvm.uadd.with.overflow.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id652" id="id2401">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id653" id="id2402">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id654" id="id2403">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id655" id="id2404">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id656" id="id2405">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-ssub-with-overflow-intrinsics" id="id2406">‘<code class="docutils literal notranslate"><span class="pre">llvm.ssub.with.overflow.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id657" id="id2407">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id658" id="id2408">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id659" id="id2409">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id660" id="id2410">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id661" id="id2411">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-usub-with-overflow-intrinsics" id="id2412">‘<code class="docutils literal notranslate"><span class="pre">llvm.usub.with.overflow.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id662" id="id2413">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id663" id="id2414">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id664" id="id2415">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id665" id="id2416">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id666" id="id2417">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-smul-with-overflow-intrinsics" id="id2418">‘<code class="docutils literal notranslate"><span class="pre">llvm.smul.with.overflow.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id667" id="id2419">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id668" id="id2420">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id669" id="id2421">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id670" id="id2422">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id671" id="id2423">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-umul-with-overflow-intrinsics" id="id2424">‘<code class="docutils literal notranslate"><span class="pre">llvm.umul.with.overflow.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id672" id="id2425">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id673" id="id2426">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id674" id="id2427">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id675" id="id2428">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id676" id="id2429">Examples:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#saturation-arithmetic-intrinsics" id="id2430">Saturation Arithmetic Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-sadd-sat-intrinsics" id="id2431">‘<code class="docutils literal notranslate"><span class="pre">llvm.sadd.sat.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id677" id="id2432">Syntax</a></p></li>
<li><p><a class="reference internal" href="#id678" id="id2433">Overview</a></p></li>
<li><p><a class="reference internal" href="#id679" id="id2434">Arguments</a></p></li>
<li><p><a class="reference internal" href="#id680" id="id2435">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id681" id="id2436">Examples</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-uadd-sat-intrinsics" id="id2437">‘<code class="docutils literal notranslate"><span class="pre">llvm.uadd.sat.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id682" id="id2438">Syntax</a></p></li>
<li><p><a class="reference internal" href="#id683" id="id2439">Overview</a></p></li>
<li><p><a class="reference internal" href="#id684" id="id2440">Arguments</a></p></li>
<li><p><a class="reference internal" href="#id685" id="id2441">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id686" id="id2442">Examples</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-ssub-sat-intrinsics" id="id2443">‘<code class="docutils literal notranslate"><span class="pre">llvm.ssub.sat.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id687" id="id2444">Syntax</a></p></li>
<li><p><a class="reference internal" href="#id688" id="id2445">Overview</a></p></li>
<li><p><a class="reference internal" href="#id689" id="id2446">Arguments</a></p></li>
<li><p><a class="reference internal" href="#id690" id="id2447">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id691" id="id2448">Examples</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-usub-sat-intrinsics" id="id2449">‘<code class="docutils literal notranslate"><span class="pre">llvm.usub.sat.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id692" id="id2450">Syntax</a></p></li>
<li><p><a class="reference internal" href="#id693" id="id2451">Overview</a></p></li>
<li><p><a class="reference internal" href="#id694" id="id2452">Arguments</a></p></li>
<li><p><a class="reference internal" href="#id695" id="id2453">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id696" id="id2454">Examples</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-sshl-sat-intrinsics" id="id2455">‘<code class="docutils literal notranslate"><span class="pre">llvm.sshl.sat.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id697" id="id2456">Syntax</a></p></li>
<li><p><a class="reference internal" href="#id698" id="id2457">Overview</a></p></li>
<li><p><a class="reference internal" href="#id699" id="id2458">Arguments</a></p></li>
<li><p><a class="reference internal" href="#id700" id="id2459">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id701" id="id2460">Examples</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-ushl-sat-intrinsics" id="id2461">‘<code class="docutils literal notranslate"><span class="pre">llvm.ushl.sat.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id702" id="id2462">Syntax</a></p></li>
<li><p><a class="reference internal" href="#id703" id="id2463">Overview</a></p></li>
<li><p><a class="reference internal" href="#id704" id="id2464">Arguments</a></p></li>
<li><p><a class="reference internal" href="#id705" id="id2465">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id706" id="id2466">Examples</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#fixed-point-arithmetic-intrinsics" id="id2467">Fixed Point Arithmetic Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-smul-fix-intrinsics" id="id2468">‘<code class="docutils literal notranslate"><span class="pre">llvm.smul.fix.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id707" id="id2469">Syntax</a></p></li>
<li><p><a class="reference internal" href="#id708" id="id2470">Overview</a></p></li>
<li><p><a class="reference internal" href="#id709" id="id2471">Arguments</a></p></li>
<li><p><a class="reference internal" href="#id710" id="id2472">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id711" id="id2473">Examples</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-umul-fix-intrinsics" id="id2474">‘<code class="docutils literal notranslate"><span class="pre">llvm.umul.fix.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id712" id="id2475">Syntax</a></p></li>
<li><p><a class="reference internal" href="#id713" id="id2476">Overview</a></p></li>
<li><p><a class="reference internal" href="#id714" id="id2477">Arguments</a></p></li>
<li><p><a class="reference internal" href="#id715" id="id2478">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id716" id="id2479">Examples</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-smul-fix-sat-intrinsics" id="id2480">‘<code class="docutils literal notranslate"><span class="pre">llvm.smul.fix.sat.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id717" id="id2481">Syntax</a></p></li>
<li><p><a class="reference internal" href="#id718" id="id2482">Overview</a></p></li>
<li><p><a class="reference internal" href="#id719" id="id2483">Arguments</a></p></li>
<li><p><a class="reference internal" href="#id720" id="id2484">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id721" id="id2485">Examples</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-umul-fix-sat-intrinsics" id="id2486">‘<code class="docutils literal notranslate"><span class="pre">llvm.umul.fix.sat.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id722" id="id2487">Syntax</a></p></li>
<li><p><a class="reference internal" href="#id723" id="id2488">Overview</a></p></li>
<li><p><a class="reference internal" href="#id724" id="id2489">Arguments</a></p></li>
<li><p><a class="reference internal" href="#id725" id="id2490">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id726" id="id2491">Examples</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-sdiv-fix-intrinsics" id="id2492">‘<code class="docutils literal notranslate"><span class="pre">llvm.sdiv.fix.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id727" id="id2493">Syntax</a></p></li>
<li><p><a class="reference internal" href="#id728" id="id2494">Overview</a></p></li>
<li><p><a class="reference internal" href="#id729" id="id2495">Arguments</a></p></li>
<li><p><a class="reference internal" href="#id730" id="id2496">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id731" id="id2497">Examples</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-udiv-fix-intrinsics" id="id2498">‘<code class="docutils literal notranslate"><span class="pre">llvm.udiv.fix.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id732" id="id2499">Syntax</a></p></li>
<li><p><a class="reference internal" href="#id733" id="id2500">Overview</a></p></li>
<li><p><a class="reference internal" href="#id734" id="id2501">Arguments</a></p></li>
<li><p><a class="reference internal" href="#id735" id="id2502">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id736" id="id2503">Examples</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-sdiv-fix-sat-intrinsics" id="id2504">‘<code class="docutils literal notranslate"><span class="pre">llvm.sdiv.fix.sat.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id737" id="id2505">Syntax</a></p></li>
<li><p><a class="reference internal" href="#id738" id="id2506">Overview</a></p></li>
<li><p><a class="reference internal" href="#id739" id="id2507">Arguments</a></p></li>
<li><p><a class="reference internal" href="#id740" id="id2508">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id741" id="id2509">Examples</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-udiv-fix-sat-intrinsics" id="id2510">‘<code class="docutils literal notranslate"><span class="pre">llvm.udiv.fix.sat.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id742" id="id2511">Syntax</a></p></li>
<li><p><a class="reference internal" href="#id743" id="id2512">Overview</a></p></li>
<li><p><a class="reference internal" href="#id744" id="id2513">Arguments</a></p></li>
<li><p><a class="reference internal" href="#id745" id="id2514">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id746" id="id2515">Examples</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#specialised-arithmetic-intrinsics" id="id2516">Specialised Arithmetic Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-canonicalize-intrinsic" id="id2517">‘<code class="docutils literal notranslate"><span class="pre">llvm.canonicalize.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id747" id="id2518">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id748" id="id2519">Overview:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-fmuladd-intrinsic" id="id2520">‘<code class="docutils literal notranslate"><span class="pre">llvm.fmuladd.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id749" id="id2521">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id750" id="id2522">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id751" id="id2523">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id752" id="id2524">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id753" id="id2525">Examples:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#hardware-loop-intrinsics" id="id2526">Hardware-Loop Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-set-loop-iterations-intrinsic" id="id2527">‘<code class="docutils literal notranslate"><span class="pre">llvm.set.loop.iterations.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id754" id="id2528">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id755" id="id2529">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id756" id="id2530">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id757" id="id2531">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-start-loop-iterations-intrinsic" id="id2532">‘<code class="docutils literal notranslate"><span class="pre">llvm.start.loop.iterations.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id758" id="id2533">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id759" id="id2534">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id760" id="id2535">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id761" id="id2536">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-test-set-loop-iterations-intrinsic" id="id2537">‘<code class="docutils literal notranslate"><span class="pre">llvm.test.set.loop.iterations.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id762" id="id2538">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id763" id="id2539">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id764" id="id2540">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id765" id="id2541">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-test-start-loop-iterations-intrinsic" id="id2542">‘<code class="docutils literal notranslate"><span class="pre">llvm.test.start.loop.iterations.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id766" id="id2543">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id767" id="id2544">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id768" id="id2545">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id769" id="id2546">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-loop-decrement-reg-intrinsic" id="id2547">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.decrement.reg.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id770" id="id2548">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id771" id="id2549">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id772" id="id2550">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id773" id="id2551">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-loop-decrement-intrinsic" id="id2552">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.decrement.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id774" id="id2553">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id775" id="id2554">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id776" id="id2555">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id777" id="id2556">Semantics:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#vector-reduction-intrinsics" id="id2557">Vector Reduction Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-vector-reduce-add-intrinsic" id="id2558">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.add.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id778" id="id2559">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id779" id="id2560">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id780" id="id2561">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vector-reduce-fadd-intrinsic" id="id2562">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.fadd.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id781" id="id2563">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id782" id="id2564">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id783" id="id2565">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id784" id="id2566">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vector-reduce-mul-intrinsic" id="id2567">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.mul.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id785" id="id2568">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id786" id="id2569">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id787" id="id2570">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vector-reduce-fmul-intrinsic" id="id2571">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.fmul.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id788" id="id2572">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id789" id="id2573">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id790" id="id2574">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id791" id="id2575">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vector-reduce-and-intrinsic" id="id2576">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.and.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id792" id="id2577">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id793" id="id2578">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id794" id="id2579">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vector-reduce-or-intrinsic" id="id2580">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.or.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id795" id="id2581">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id796" id="id2582">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id797" id="id2583">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vector-reduce-xor-intrinsic" id="id2584">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.xor.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id798" id="id2585">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id799" id="id2586">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id800" id="id2587">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vector-reduce-smax-intrinsic" id="id2588">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.smax.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id801" id="id2589">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id802" id="id2590">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id803" id="id2591">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vector-reduce-smin-intrinsic" id="id2592">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.smin.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id804" id="id2593">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id805" id="id2594">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id806" id="id2595">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vector-reduce-umax-intrinsic" id="id2596">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.umax.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id807" id="id2597">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id808" id="id2598">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id809" id="id2599">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vector-reduce-umin-intrinsic" id="id2600">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.umin.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id810" id="id2601">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id811" id="id2602">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id812" id="id2603">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vector-reduce-fmax-intrinsic" id="id2604">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.fmax.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id813" id="id2605">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id814" id="id2606">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id815" id="id2607">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vector-reduce-fmin-intrinsic" id="id2608">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.fmin.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id816" id="id2609">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id817" id="id2610">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id818" id="id2611">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-vector-insert-intrinsic" id="id2612">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.vector.insert</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id819" id="id2613">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id820" id="id2614">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id821" id="id2615">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-vector-extract-intrinsic" id="id2616">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.vector.extract</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id822" id="id2617">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id823" id="id2618">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id824" id="id2619">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-vector-reverse-intrinsic" id="id2620">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.vector.reverse</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id825" id="id2621">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id826" id="id2622">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id827" id="id2623">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-vector-splice-intrinsic" id="id2624">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.vector.splice</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id828" id="id2625">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id829" id="id2626">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id830" id="id2627">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-stepvector-intrinsic" id="id2628">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.stepvector</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id831" id="id2629">Arguments:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#matrix-intrinsics" id="id2630">Matrix Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-matrix-transpose-intrinsic" id="id2631">‘<code class="docutils literal notranslate"><span class="pre">llvm.matrix.transpose.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id832" id="id2632">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id833" id="id2633">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id834" id="id2634">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-matrix-multiply-intrinsic" id="id2635">‘<code class="docutils literal notranslate"><span class="pre">llvm.matrix.multiply.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id835" id="id2636">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id836" id="id2637">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id837" id="id2638">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-matrix-column-major-load-intrinsic" id="id2639">‘<code class="docutils literal notranslate"><span class="pre">llvm.matrix.column.major.load.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id838" id="id2640">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id839" id="id2641">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id840" id="id2642">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-matrix-column-major-store-intrinsic" id="id2643">‘<code class="docutils literal notranslate"><span class="pre">llvm.matrix.column.major.store.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id841" id="id2644">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id842" id="id2645">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id843" id="id2646">Arguments:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#half-precision-floating-point-intrinsics" id="id2647">Half Precision Floating-Point Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-convert-to-fp16-intrinsic" id="id2648">‘<code class="docutils literal notranslate"><span class="pre">llvm.convert.to.fp16</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id844" id="id2649">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id845" id="id2650">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id846" id="id2651">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id847" id="id2652">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id848" id="id2653">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-convert-from-fp16-intrinsic" id="id2654">‘<code class="docutils literal notranslate"><span class="pre">llvm.convert.from.fp16</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id849" id="id2655">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id850" id="id2656">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id851" id="id2657">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id852" id="id2658">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id853" id="id2659">Examples:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#saturating-floating-point-to-integer-conversions" id="id2660">Saturating floating-point to integer conversions</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-fptoui-sat-intrinsic" id="id2661">‘<code class="docutils literal notranslate"><span class="pre">llvm.fptoui.sat.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id854" id="id2662">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id855" id="id2663">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id856" id="id2664">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id857" id="id2665">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id858" id="id2666">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-fptosi-sat-intrinsic" id="id2667">‘<code class="docutils literal notranslate"><span class="pre">llvm.fptosi.sat.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id859" id="id2668">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id860" id="id2669">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id861" id="id2670">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id862" id="id2671">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id863" id="id2672">Example:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#debugger-intrinsics" id="id2673">Debugger Intrinsics</a></p></li>
<li><p><a class="reference internal" href="#exception-handling-intrinsics" id="id2674">Exception Handling Intrinsics</a></p></li>
<li><p><a class="reference internal" href="#trampoline-intrinsics" id="id2675">Trampoline Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-init-trampoline-intrinsic" id="id2676">‘<code class="docutils literal notranslate"><span class="pre">llvm.init.trampoline</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id864" id="id2677">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id865" id="id2678">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id866" id="id2679">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id867" id="id2680">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-adjust-trampoline-intrinsic" id="id2681">‘<code class="docutils literal notranslate"><span class="pre">llvm.adjust.trampoline</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id868" id="id2682">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id869" id="id2683">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id870" id="id2684">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id871" id="id2685">Semantics:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#vector-predication-intrinsics" id="id2686">Vector Predication Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#optimization-hint" id="id2687">Optimization Hint</a></p></li>
<li><p><a class="reference internal" href="#llvm-vp-select-intrinsics" id="id2688">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.select.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id872" id="id2689">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id873" id="id2690">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id874" id="id2691">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id875" id="id2692">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id876" id="id2693">Example:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-add-intrinsics" id="id2694">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.add.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id877" id="id2695">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id878" id="id2696">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id879" id="id2697">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id880" id="id2698">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id881" id="id2699">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-sub-intrinsics" id="id2700">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.sub.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id882" id="id2701">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id883" id="id2702">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id884" id="id2703">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id885" id="id2704">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id886" id="id2705">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-mul-intrinsics" id="id2706">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.mul.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id887" id="id2707">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id888" id="id2708">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id889" id="id2709">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id890" id="id2710">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id891" id="id2711">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-sdiv-intrinsics" id="id2712">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.sdiv.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id892" id="id2713">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id893" id="id2714">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id894" id="id2715">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id895" id="id2716">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id896" id="id2717">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-udiv-intrinsics" id="id2718">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.udiv.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id897" id="id2719">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id898" id="id2720">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id899" id="id2721">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id900" id="id2722">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id901" id="id2723">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-srem-intrinsics" id="id2724">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.srem.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id902" id="id2725">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id903" id="id2726">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id904" id="id2727">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id905" id="id2728">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id906" id="id2729">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-urem-intrinsics" id="id2730">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.urem.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id907" id="id2731">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id908" id="id2732">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id909" id="id2733">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id910" id="id2734">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id911" id="id2735">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-ashr-intrinsics" id="id2736">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.ashr.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id912" id="id2737">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id913" id="id2738">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id914" id="id2739">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id915" id="id2740">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id916" id="id2741">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-lshr-intrinsics" id="id2742">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.lshr.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id917" id="id2743">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id918" id="id2744">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id919" id="id2745">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id920" id="id2746">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id921" id="id2747">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-shl-intrinsics" id="id2748">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.shl.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id922" id="id2749">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id923" id="id2750">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id924" id="id2751">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id925" id="id2752">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id926" id="id2753">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-or-intrinsics" id="id2754">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.or.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id927" id="id2755">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id928" id="id2756">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id929" id="id2757">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id930" id="id2758">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id931" id="id2759">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-and-intrinsics" id="id2760">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.and.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id932" id="id2761">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id933" id="id2762">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id934" id="id2763">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id935" id="id2764">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id936" id="id2765">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-xor-intrinsics" id="id2766">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.xor.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id937" id="id2767">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id938" id="id2768">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id939" id="id2769">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id940" id="id2770">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id941" id="id2771">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-fadd-intrinsics" id="id2772">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.fadd.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id942" id="id2773">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id943" id="id2774">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id944" id="id2775">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id945" id="id2776">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id946" id="id2777">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-fsub-intrinsics" id="id2778">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.fsub.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id947" id="id2779">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id948" id="id2780">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id949" id="id2781">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id950" id="id2782">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id951" id="id2783">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-fmul-intrinsics" id="id2784">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.fmul.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id952" id="id2785">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id953" id="id2786">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id954" id="id2787">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id955" id="id2788">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id956" id="id2789">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-fdiv-intrinsics" id="id2790">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.fdiv.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id957" id="id2791">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id958" id="id2792">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id959" id="id2793">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id960" id="id2794">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id961" id="id2795">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-frem-intrinsics" id="id2796">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.frem.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id962" id="id2797">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id963" id="id2798">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id964" id="id2799">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id965" id="id2800">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id966" id="id2801">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-reduce-add-intrinsics" id="id2802">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.add.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id967" id="id2803">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id968" id="id2804">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id969" id="id2805">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id970" id="id2806">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id971" id="id2807">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-reduce-fadd-intrinsics" id="id2808">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.fadd.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id972" id="id2809">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id973" id="id2810">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id974" id="id2811">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id975" id="id2812">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id976" id="id2813">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-reduce-mul-intrinsics" id="id2814">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.mul.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id977" id="id2815">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id978" id="id2816">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id979" id="id2817">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id980" id="id2818">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id981" id="id2819">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-reduce-fmul-intrinsics" id="id2820">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.fmul.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id982" id="id2821">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id983" id="id2822">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id984" id="id2823">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id985" id="id2824">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id986" id="id2825">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-reduce-and-intrinsics" id="id2826">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.and.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id987" id="id2827">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id988" id="id2828">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id989" id="id2829">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id990" id="id2830">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id991" id="id2831">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-reduce-or-intrinsics" id="id2832">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.or.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id992" id="id2833">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id993" id="id2834">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id994" id="id2835">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id995" id="id2836">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id996" id="id2837">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-reduce-xor-intrinsics" id="id2838">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.xor.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id997" id="id2839">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id998" id="id2840">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id999" id="id2841">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1000" id="id2842">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id1001" id="id2843">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-reduce-smax-intrinsics" id="id2844">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.smax.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id1002" id="id2845">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1003" id="id2846">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1004" id="id2847">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1005" id="id2848">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id1006" id="id2849">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-reduce-smin-intrinsics" id="id2850">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.smin.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id1007" id="id2851">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1008" id="id2852">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1009" id="id2853">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1010" id="id2854">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id1011" id="id2855">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-reduce-umax-intrinsics" id="id2856">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.umax.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id1012" id="id2857">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1013" id="id2858">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1014" id="id2859">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1015" id="id2860">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id1016" id="id2861">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-reduce-umin-intrinsics" id="id2862">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.umin.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id1017" id="id2863">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1018" id="id2864">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1019" id="id2865">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1020" id="id2866">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id1021" id="id2867">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-reduce-fmax-intrinsics" id="id2868">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.fmax.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id1022" id="id2869">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1023" id="id2870">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1024" id="id2871">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1025" id="id2872">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id1026" id="id2873">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vp-reduce-fmin-intrinsics" id="id2874">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.fmin.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id1027" id="id2875">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1028" id="id2876">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1029" id="id2877">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1030" id="id2878">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id1031" id="id2879">Examples:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-get-active-lane-mask-intrinsics" id="id2880">‘<code class="docutils literal notranslate"><span class="pre">llvm.get.active.lane.mask.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id1032" id="id2881">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1033" id="id2882">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1034" id="id2883">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1035" id="id2884">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id1036" id="id2885">Examples:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#masked-vector-load-and-store-intrinsics" id="id2886">Masked Vector Load and Store Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-masked-load-intrinsics" id="id2887">‘<code class="docutils literal notranslate"><span class="pre">llvm.masked.load.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id1037" id="id2888">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1038" id="id2889">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1039" id="id2890">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1040" id="id2891">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-masked-store-intrinsics" id="id2892">‘<code class="docutils literal notranslate"><span class="pre">llvm.masked.store.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id1041" id="id2893">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1042" id="id2894">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1043" id="id2895">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1044" id="id2896">Semantics:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#masked-vector-gather-and-scatter-intrinsics" id="id2897">Masked Vector Gather and Scatter Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-masked-gather-intrinsics" id="id2898">‘<code class="docutils literal notranslate"><span class="pre">llvm.masked.gather.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id1045" id="id2899">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1046" id="id2900">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1047" id="id2901">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1048" id="id2902">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-masked-scatter-intrinsics" id="id2903">‘<code class="docutils literal notranslate"><span class="pre">llvm.masked.scatter.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id1049" id="id2904">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1050" id="id2905">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1051" id="id2906">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1052" id="id2907">Semantics:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#masked-vector-expanding-load-and-compressing-store-intrinsics" id="id2908">Masked Vector Expanding Load and Compressing Store Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-masked-expandload-intrinsics" id="id2909">‘<code class="docutils literal notranslate"><span class="pre">llvm.masked.expandload.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id1053" id="id2910">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1054" id="id2911">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1055" id="id2912">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1056" id="id2913">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-masked-compressstore-intrinsics" id="id2914">‘<code class="docutils literal notranslate"><span class="pre">llvm.masked.compressstore.*</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id1057" id="id2915">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1058" id="id2916">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1059" id="id2917">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1060" id="id2918">Semantics:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#memory-use-markers" id="id2919">Memory Use Markers</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-lifetime-start-intrinsic" id="id2920">‘<code class="docutils literal notranslate"><span class="pre">llvm.lifetime.start</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1061" id="id2921">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1062" id="id2922">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1063" id="id2923">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1064" id="id2924">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-lifetime-end-intrinsic" id="id2925">‘<code class="docutils literal notranslate"><span class="pre">llvm.lifetime.end</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1065" id="id2926">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1066" id="id2927">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1067" id="id2928">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1068" id="id2929">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-invariant-start-intrinsic" id="id2930">‘<code class="docutils literal notranslate"><span class="pre">llvm.invariant.start</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1069" id="id2931">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1070" id="id2932">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1071" id="id2933">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1072" id="id2934">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-invariant-end-intrinsic" id="id2935">‘<code class="docutils literal notranslate"><span class="pre">llvm.invariant.end</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1073" id="id2936">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1074" id="id2937">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1075" id="id2938">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1076" id="id2939">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-launder-invariant-group-intrinsic" id="id2940">‘<code class="docutils literal notranslate"><span class="pre">llvm.launder.invariant.group</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1077" id="id2941">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1078" id="id2942">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1079" id="id2943">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1080" id="id2944">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-strip-invariant-group-intrinsic" id="id2945">‘<code class="docutils literal notranslate"><span class="pre">llvm.strip.invariant.group</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1081" id="id2946">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1082" id="id2947">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1083" id="id2948">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1084" id="id2949">Semantics:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#constrained-floating-point-intrinsics" id="id2950">Constrained Floating-Point Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-fadd-intrinsic" id="id2951">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fadd</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1085" id="id2952">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1086" id="id2953">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1087" id="id2954">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1088" id="id2955">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-fsub-intrinsic" id="id2956">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fsub</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1089" id="id2957">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1090" id="id2958">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1091" id="id2959">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1092" id="id2960">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-fmul-intrinsic" id="id2961">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fmul</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1093" id="id2962">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1094" id="id2963">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1095" id="id2964">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1096" id="id2965">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-fdiv-intrinsic" id="id2966">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fdiv</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1097" id="id2967">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1098" id="id2968">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1099" id="id2969">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1100" id="id2970">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-frem-intrinsic" id="id2971">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.frem</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1101" id="id2972">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1102" id="id2973">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1103" id="id2974">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1104" id="id2975">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-fma-intrinsic" id="id2976">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fma</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1105" id="id2977">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1106" id="id2978">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1107" id="id2979">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1108" id="id2980">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-fptoui-intrinsic" id="id2981">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fptoui</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1109" id="id2982">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1110" id="id2983">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1111" id="id2984">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1112" id="id2985">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-fptosi-intrinsic" id="id2986">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fptosi</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1113" id="id2987">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1114" id="id2988">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1115" id="id2989">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1116" id="id2990">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-uitofp-intrinsic" id="id2991">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.uitofp</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1117" id="id2992">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1118" id="id2993">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1119" id="id2994">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1120" id="id2995">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-sitofp-intrinsic" id="id2996">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.sitofp</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1121" id="id2997">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1122" id="id2998">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1123" id="id2999">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1124" id="id3000">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-fptrunc-intrinsic" id="id3001">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fptrunc</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1125" id="id3002">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1126" id="id3003">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1127" id="id3004">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1128" id="id3005">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-fpext-intrinsic" id="id3006">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fpext</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1129" id="id3007">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1130" id="id3008">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1131" id="id3009">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1132" id="id3010">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-fcmp-and-llvm-experimental-constrained-fcmps-intrinsics" id="id3011">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fcmp</span></code>’ and ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fcmps</span></code>’ Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#id1133" id="id3012">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1134" id="id3013">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1135" id="id3014">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1136" id="id3015">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-fmuladd-intrinsic" id="id3016">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fmuladd</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1137" id="id3017">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1138" id="id3018">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1139" id="id3019">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1140" id="id3020">Semantics:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#constrained-libm-equivalent-intrinsics" id="id3021">Constrained libm-equivalent Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-sqrt-intrinsic" id="id3022">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.sqrt</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1141" id="id3023">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1142" id="id3024">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1143" id="id3025">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1144" id="id3026">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-pow-intrinsic" id="id3027">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.pow</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1145" id="id3028">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1146" id="id3029">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1147" id="id3030">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1148" id="id3031">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-powi-intrinsic" id="id3032">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.powi</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1149" id="id3033">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1150" id="id3034">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1151" id="id3035">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1152" id="id3036">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-sin-intrinsic" id="id3037">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.sin</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1153" id="id3038">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1154" id="id3039">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1155" id="id3040">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1156" id="id3041">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-cos-intrinsic" id="id3042">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.cos</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1157" id="id3043">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1158" id="id3044">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1159" id="id3045">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1160" id="id3046">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-exp-intrinsic" id="id3047">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.exp</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1161" id="id3048">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1162" id="id3049">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1163" id="id3050">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1164" id="id3051">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-exp2-intrinsic" id="id3052">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.exp2</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1165" id="id3053">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1166" id="id3054">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1167" id="id3055">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1168" id="id3056">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-log-intrinsic" id="id3057">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.log</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1169" id="id3058">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1170" id="id3059">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1171" id="id3060">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1172" id="id3061">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-log10-intrinsic" id="id3062">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.log10</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1173" id="id3063">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1174" id="id3064">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1175" id="id3065">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1176" id="id3066">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-log2-intrinsic" id="id3067">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.log2</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1177" id="id3068">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1178" id="id3069">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1179" id="id3070">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1180" id="id3071">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-rint-intrinsic" id="id3072">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.rint</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1181" id="id3073">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1182" id="id3074">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1183" id="id3075">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1184" id="id3076">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-lrint-intrinsic" id="id3077">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.lrint</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1185" id="id3078">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1186" id="id3079">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1187" id="id3080">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1188" id="id3081">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-llrint-intrinsic" id="id3082">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.llrint</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1189" id="id3083">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1190" id="id3084">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1191" id="id3085">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1192" id="id3086">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-nearbyint-intrinsic" id="id3087">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.nearbyint</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1193" id="id3088">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1194" id="id3089">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1195" id="id3090">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1196" id="id3091">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-maxnum-intrinsic" id="id3092">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.maxnum</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1197" id="id3093">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1198" id="id3094">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1199" id="id3095">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1200" id="id3096">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-minnum-intrinsic" id="id3097">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.minnum</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1201" id="id3098">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1202" id="id3099">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1203" id="id3100">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1204" id="id3101">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-maximum-intrinsic" id="id3102">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.maximum</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1205" id="id3103">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1206" id="id3104">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1207" id="id3105">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1208" id="id3106">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-minimum-intrinsic" id="id3107">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.minimum</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1209" id="id3108">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1210" id="id3109">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1211" id="id3110">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1212" id="id3111">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-ceil-intrinsic" id="id3112">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.ceil</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1213" id="id3113">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1214" id="id3114">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1215" id="id3115">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1216" id="id3116">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-floor-intrinsic" id="id3117">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.floor</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1217" id="id3118">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1218" id="id3119">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1219" id="id3120">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1220" id="id3121">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-round-intrinsic" id="id3122">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.round</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1221" id="id3123">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1222" id="id3124">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1223" id="id3125">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1224" id="id3126">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-roundeven-intrinsic" id="id3127">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.roundeven</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1225" id="id3128">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1226" id="id3129">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1227" id="id3130">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1228" id="id3131">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-lround-intrinsic" id="id3132">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.lround</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1229" id="id3133">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1230" id="id3134">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1231" id="id3135">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1232" id="id3136">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-llround-intrinsic" id="id3137">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.llround</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1233" id="id3138">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1234" id="id3139">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1235" id="id3140">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1236" id="id3141">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-constrained-trunc-intrinsic" id="id3142">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.trunc</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1237" id="id3143">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1238" id="id3144">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1239" id="id3145">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1240" id="id3146">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-noalias-scope-decl-intrinsic" id="id3147">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.noalias.scope.decl</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1241" id="id3148">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1242" id="id3149">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1243" id="id3150">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1244" id="id3151">Semantics:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#floating-point-environment-manipulation-intrinsics" id="id3152">Floating Point Environment Manipulation intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-flt-rounds-intrinsic" id="id3153">‘<code class="docutils literal notranslate"><span class="pre">llvm.flt.rounds</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1245" id="id3154">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1246" id="id3155">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1247" id="id3156">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-set-rounding-intrinsic" id="id3157">‘<code class="docutils literal notranslate"><span class="pre">llvm.set.rounding</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1248" id="id3158">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1249" id="id3159">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1250" id="id3160">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1251" id="id3161">Semantics:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#general-intrinsics" id="id3162">General Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-var-annotation-intrinsic" id="id3163">‘<code class="docutils literal notranslate"><span class="pre">llvm.var.annotation</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1252" id="id3164">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1253" id="id3165">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1254" id="id3166">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1255" id="id3167">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-ptr-annotation-intrinsic" id="id3168">‘<code class="docutils literal notranslate"><span class="pre">llvm.ptr.annotation.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1256" id="id3169">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1257" id="id3170">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1258" id="id3171">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1259" id="id3172">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-annotation-intrinsic" id="id3173">‘<code class="docutils literal notranslate"><span class="pre">llvm.annotation.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1260" id="id3174">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1261" id="id3175">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1262" id="id3176">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1263" id="id3177">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-codeview-annotation-intrinsic" id="id3178">‘<code class="docutils literal notranslate"><span class="pre">llvm.codeview.annotation</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1264" id="id3179">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1265" id="id3180">Arguments:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-trap-intrinsic" id="id3181">‘<code class="docutils literal notranslate"><span class="pre">llvm.trap</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1266" id="id3182">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1267" id="id3183">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1268" id="id3184">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1269" id="id3185">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-debugtrap-intrinsic" id="id3186">‘<code class="docutils literal notranslate"><span class="pre">llvm.debugtrap</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1270" id="id3187">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1271" id="id3188">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1272" id="id3189">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1273" id="id3190">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-ubsantrap-intrinsic" id="id3191">‘<code class="docutils literal notranslate"><span class="pre">llvm.ubsantrap</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1274" id="id3192">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1275" id="id3193">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1276" id="id3194">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1277" id="id3195">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-stackprotector-intrinsic" id="id3196">‘<code class="docutils literal notranslate"><span class="pre">llvm.stackprotector</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1278" id="id3197">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1279" id="id3198">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1280" id="id3199">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1281" id="id3200">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-stackguard-intrinsic" id="id3201">‘<code class="docutils literal notranslate"><span class="pre">llvm.stackguard</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1282" id="id3202">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1283" id="id3203">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1284" id="id3204">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1285" id="id3205">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-objectsize-intrinsic" id="id3206">‘<code class="docutils literal notranslate"><span class="pre">llvm.objectsize</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1286" id="id3207">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1287" id="id3208">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1288" id="id3209">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1289" id="id3210">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-expect-intrinsic" id="id3211">‘<code class="docutils literal notranslate"><span class="pre">llvm.expect</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1290" id="id3212">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1291" id="id3213">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1292" id="id3214">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1293" id="id3215">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-expect-with-probability-intrinsic" id="id3216">‘<code class="docutils literal notranslate"><span class="pre">llvm.expect.with.probability</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1294" id="id3217">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1295" id="id3218">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1296" id="id3219">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1297" id="id3220">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-assume-intrinsic" id="id3221">‘<code class="docutils literal notranslate"><span class="pre">llvm.assume</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1298" id="id3222">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1299" id="id3223">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1300" id="id3224">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1301" id="id3225">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-ssa-copy-intrinsic" id="id3226">‘<code class="docutils literal notranslate"><span class="pre">llvm.ssa.copy</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1302" id="id3227">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1303" id="id3228">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1304" id="id3229">Overview:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-type-test-intrinsic" id="id3230">‘<code class="docutils literal notranslate"><span class="pre">llvm.type.test</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1305" id="id3231">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1306" id="id3232">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1307" id="id3233">Overview:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-type-checked-load-intrinsic" id="id3234">‘<code class="docutils literal notranslate"><span class="pre">llvm.type.checked.load</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1308" id="id3235">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1309" id="id3236">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1310" id="id3237">Overview:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-arithmetic-fence-intrinsic" id="id3238">‘<code class="docutils literal notranslate"><span class="pre">llvm.arithmetic.fence</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1311" id="id3239">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1312" id="id3240">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1313" id="id3241">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1314" id="id3242">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-donothing-intrinsic" id="id3243">‘<code class="docutils literal notranslate"><span class="pre">llvm.donothing</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1315" id="id3244">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1316" id="id3245">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1317" id="id3246">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1318" id="id3247">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-deoptimize-intrinsic" id="id3248">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.deoptimize</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1319" id="id3249">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1320" id="id3250">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1321" id="id3251">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1322" id="id3252">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#lowering" id="id3253">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-guard-intrinsic" id="id3254">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.guard</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1323" id="id3255">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1324" id="id3256">Overview:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-experimental-widenable-condition-intrinsic" id="id3257">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.widenable.condition</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1325" id="id3258">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1326" id="id3259">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1327" id="id3260">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1328" id="id3261">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#guard-widening" id="id3262">Guard widening:</a></p></li>
<li><p><a class="reference internal" href="#id1329" id="id3263">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-load-relative-intrinsic" id="id3264">‘<code class="docutils literal notranslate"><span class="pre">llvm.load.relative</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1330" id="id3265">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1331" id="id3266">Overview:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-sideeffect-intrinsic" id="id3267">‘<code class="docutils literal notranslate"><span class="pre">llvm.sideeffect</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1332" id="id3268">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1333" id="id3269">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1334" id="id3270">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1335" id="id3271">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-is-constant-intrinsic" id="id3272">‘<code class="docutils literal notranslate"><span class="pre">llvm.is.constant.*</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1336" id="id3273">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1337" id="id3274">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1338" id="id3275">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-ptrmask-intrinsic" id="id3276">‘<code class="docutils literal notranslate"><span class="pre">llvm.ptrmask</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1339" id="id3277">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1340" id="id3278">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1341" id="id3279">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1342" id="id3280">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-vscale-intrinsic" id="id3281">‘<code class="docutils literal notranslate"><span class="pre">llvm.vscale</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1343" id="id3282">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1344" id="id3283">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1345" id="id3284">Semantics:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#stack-map-intrinsics" id="id3285">Stack Map Intrinsics</a></p></li>
<li><p><a class="reference internal" href="#element-wise-atomic-memory-intrinsics" id="id3286">Element Wise Atomic Memory Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-memcpy-element-unordered-atomic-intrinsic" id="id3287">‘<code class="docutils literal notranslate"><span class="pre">llvm.memcpy.element.unordered.atomic</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1346" id="id3288">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1347" id="id3289">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1348" id="id3290">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1349" id="id3291">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id1350" id="id3292">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-memmove-element-unordered-atomic-intrinsic" id="id3293">‘<code class="docutils literal notranslate"><span class="pre">llvm.memmove.element.unordered.atomic</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1351" id="id3294">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1352" id="id3295">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1353" id="id3296">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1354" id="id3297">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id1355" id="id3298">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-memset-element-unordered-atomic-intrinsic" id="id3299">‘<code class="docutils literal notranslate"><span class="pre">llvm.memset.element.unordered.atomic</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1356" id="id3300">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1357" id="id3301">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1358" id="id3302">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1359" id="id3303">Semantics:</a></p></li>
<li><p><a class="reference internal" href="#id1360" id="id3304">Lowering:</a></p></li>
</ul>
</li>
</ul>
</li>
<li><p><a class="reference internal" href="#objective-c-arc-runtime-intrinsics" id="id3305">Objective-C ARC Runtime Intrinsics</a></p>
<ul>
<li><p><a class="reference internal" href="#llvm-objc-autorelease-intrinsic" id="id3306">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.autorelease</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1361" id="id3307">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1362" id="id3308">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-objc-autoreleasepoolpop-intrinsic" id="id3309">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.autoreleasePoolPop</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1363" id="id3310">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1364" id="id3311">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-objc-autoreleasepoolpush-intrinsic" id="id3312">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.autoreleasePoolPush</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1365" id="id3313">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1366" id="id3314">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-objc-autoreleasereturnvalue-intrinsic" id="id3315">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.autoreleaseReturnValue</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1367" id="id3316">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1368" id="id3317">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-objc-copyweak-intrinsic" id="id3318">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.copyWeak</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1369" id="id3319">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1370" id="id3320">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-objc-destroyweak-intrinsic" id="id3321">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.destroyWeak</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1371" id="id3322">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1372" id="id3323">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-objc-initweak-intrinsic" id="id3324">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.initWeak</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1373" id="id3325">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1374" id="id3326">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-objc-loadweak-intrinsic" id="id3327">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.loadWeak</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1375" id="id3328">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1376" id="id3329">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-objc-loadweakretained-intrinsic" id="id3330">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.loadWeakRetained</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1377" id="id3331">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1378" id="id3332">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-objc-moveweak-intrinsic" id="id3333">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.moveWeak</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1379" id="id3334">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1380" id="id3335">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-objc-release-intrinsic" id="id3336">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.release</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1381" id="id3337">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1382" id="id3338">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-objc-retain-intrinsic" id="id3339">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.retain</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1383" id="id3340">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1384" id="id3341">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-objc-retainautorelease-intrinsic" id="id3342">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.retainAutorelease</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1385" id="id3343">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1386" id="id3344">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-objc-retainautoreleasereturnvalue-intrinsic" id="id3345">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.retainAutoreleaseReturnValue</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1387" id="id3346">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1388" id="id3347">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-objc-retainautoreleasedreturnvalue-intrinsic" id="id3348">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.retainAutoreleasedReturnValue</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1389" id="id3349">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1390" id="id3350">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-objc-retainblock-intrinsic" id="id3351">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.retainBlock</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1391" id="id3352">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1392" id="id3353">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-objc-storestrong-intrinsic" id="id3354">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.storeStrong</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1393" id="id3355">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1394" id="id3356">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-objc-storeweak-intrinsic" id="id3357">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.storeWeak</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1395" id="id3358">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1396" id="id3359">Lowering:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#preserving-debug-information-intrinsics" id="id3360">Preserving Debug Information Intrinsics</a></p></li>
<li><p><a class="reference internal" href="#llvm-preserve-array-access-index-intrinsic" id="id3361">‘<code class="docutils literal notranslate"><span class="pre">llvm.preserve.array.access.index</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1397" id="id3362">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1398" id="id3363">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1399" id="id3364">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1400" id="id3365">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-preserve-union-access-index-intrinsic" id="id3366">‘<code class="docutils literal notranslate"><span class="pre">llvm.preserve.union.access.index</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1401" id="id3367">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1402" id="id3368">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1403" id="id3369">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1404" id="id3370">Semantics:</a></p></li>
</ul>
</li>
<li><p><a class="reference internal" href="#llvm-preserve-struct-access-index-intrinsic" id="id3371">‘<code class="docutils literal notranslate"><span class="pre">llvm.preserve.struct.access.index</span></code>’ Intrinsic</a></p>
<ul>
<li><p><a class="reference internal" href="#id1405" id="id3372">Syntax:</a></p></li>
<li><p><a class="reference internal" href="#id1406" id="id3373">Overview:</a></p></li>
<li><p><a class="reference internal" href="#id1407" id="id3374">Arguments:</a></p></li>
<li><p><a class="reference internal" href="#id1408" id="id3375">Semantics:</a></p></li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="section" id="abstract">
<h2><a class="toc-backref" href="#id1409">Abstract</a><a class="headerlink" href="#abstract" title="Permalink to this headline">¶</a></h2>
<p>This document is a reference manual for the LLVM assembly language. LLVM
is a Static Single Assignment (SSA) based representation that provides
type safety, low-level operations, flexibility, and the capability of
representing ‘all’ high-level languages cleanly. It is the common code
representation used throughout all phases of the LLVM compilation
strategy.</p>
</div>
<div class="section" id="introduction">
<h2><a class="toc-backref" href="#id1410">Introduction</a><a class="headerlink" href="#introduction" title="Permalink to this headline">¶</a></h2>
<p>The LLVM code representation is designed to be used in three different
forms: as an in-memory compiler IR, as an on-disk bitcode representation
(suitable for fast loading by a Just-In-Time compiler), and as a human
readable assembly language representation. This allows LLVM to provide a
powerful intermediate representation for efficient compiler
transformations and analysis, while providing a natural means to debug
and visualize the transformations. The three different forms of LLVM are
all equivalent. This document describes the human readable
representation and notation.</p>
<p>The LLVM representation aims to be light-weight and low-level while
being expressive, typed, and extensible at the same time. It aims to be
a “universal IR” of sorts, by being at a low enough level that
high-level ideas may be cleanly mapped to it (similar to how
microprocessors are “universal IR’s”, allowing many source languages to
be mapped to them). By providing type information, LLVM can be used as
the target of optimizations: for example, through pointer analysis, it
can be proven that a C automatic variable is never accessed outside of
the current function, allowing it to be promoted to a simple SSA value
instead of a memory location.</p>
<div class="section" id="well-formedness">
<span id="wellformed"></span><h3><a class="toc-backref" href="#id1411">Well-Formedness</a><a class="headerlink" href="#well-formedness" title="Permalink to this headline">¶</a></h3>
<p>It is important to note that this document describes ‘well formed’ LLVM
assembly language. There is a difference between what the parser accepts
and what is considered ‘well formed’. For example, the following
instruction is syntactically okay, but not well formed:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%x</span> <span class="p">=</span> <span class="k">add</span> <span class="k">i32</span> <span class="m">1</span><span class="p">,</span> <span class="nv">%x</span>
</pre></div>
</div>
<p>because the definition of <code class="docutils literal notranslate"><span class="pre">%x</span></code> does not dominate all of its uses. The
LLVM infrastructure provides a verification pass that may be used to
verify that an LLVM module is well formed. This pass is automatically
run by the parser after parsing input assembly and by the optimizer
before it outputs bitcode. The violations pointed out by the verifier
pass indicate bugs in transformation passes or input to the parser.</p>
</div>
</div>
<div class="section" id="identifiers">
<span id="id1"></span><h2><a class="toc-backref" href="#id1412">Identifiers</a><a class="headerlink" href="#identifiers" title="Permalink to this headline">¶</a></h2>
<p>LLVM identifiers come in two basic types: global and local. Global
identifiers (functions, global variables) begin with the <code class="docutils literal notranslate"><span class="pre">'@'</span></code>
character. Local identifiers (register names, types) begin with the
<code class="docutils literal notranslate"><span class="pre">'%'</span></code> character. Additionally, there are three different formats for
identifiers, for different purposes:</p>
<ol class="arabic simple">
<li><p>Named values are represented as a string of characters with their
prefix. For example, <code class="docutils literal notranslate"><span class="pre">%foo</span></code>, <code class="docutils literal notranslate"><span class="pre">@DivisionByZero</span></code>,
<code class="docutils literal notranslate"><span class="pre">%a.really.long.identifier</span></code>. The actual regular expression used is
‘<code class="docutils literal notranslate"><span class="pre">[%@][-a-zA-Z$._][-a-zA-Z$._0-9]*</span></code>’. Identifiers that require other
characters in their names can be surrounded with quotes. Special
characters may be escaped using <code class="docutils literal notranslate"><span class="pre">"\xx"</span></code> where <code class="docutils literal notranslate"><span class="pre">xx</span></code> is the ASCII
code for the character in hexadecimal. In this way, any character can
be used in a name value, even quotes themselves. The <code class="docutils literal notranslate"><span class="pre">"\01"</span></code> prefix
can be used on global values to suppress mangling.</p></li>
<li><p>Unnamed values are represented as an unsigned numeric value with
their prefix. For example, <code class="docutils literal notranslate"><span class="pre">%12</span></code>, <code class="docutils literal notranslate"><span class="pre">@2</span></code>, <code class="docutils literal notranslate"><span class="pre">%44</span></code>.</p></li>
<li><p>Constants, which are described in the section <a class="reference internal" href="#constants">Constants</a> below.</p></li>
</ol>
<p>LLVM requires that values start with a prefix for two reasons: Compilers
don’t need to worry about name clashes with reserved words, and the set
of reserved words may be expanded in the future without penalty.
Additionally, unnamed identifiers allow a compiler to quickly come up
with a temporary variable without having to avoid symbol table
conflicts.</p>
<p>Reserved words in LLVM are very similar to reserved words in other
languages. There are keywords for different opcodes (‘<code class="docutils literal notranslate"><span class="pre">add</span></code>’,
‘<code class="docutils literal notranslate"><span class="pre">bitcast</span></code>’, ‘<code class="docutils literal notranslate"><span class="pre">ret</span></code>’, etc…), for primitive type names (‘<code class="docutils literal notranslate"><span class="pre">void</span></code>’,
‘<code class="docutils literal notranslate"><span class="pre">i32</span></code>’, etc…), and others. These reserved words cannot conflict
with variable names, because none of them start with a prefix character
(<code class="docutils literal notranslate"><span class="pre">'%'</span></code> or <code class="docutils literal notranslate"><span class="pre">'@'</span></code>).</p>
<p>Here is an example of LLVM code to multiply the integer variable
‘<code class="docutils literal notranslate"><span class="pre">%X</span></code>’ by 8:</p>
<p>The easy way:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%result</span> <span class="p">=</span> <span class="k">mul</span> <span class="k">i32</span> <span class="nv">%X</span><span class="p">,</span> <span class="m">8</span>
</pre></div>
</div>
<p>After strength reduction:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%result</span> <span class="p">=</span> <span class="k">shl</span> <span class="k">i32</span> <span class="nv">%X</span><span class="p">,</span> <span class="m">3</span>
</pre></div>
</div>
<p>And the hard way:</p>
<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">add</span> <span class="k">i32</span> <span class="nv">%X</span><span class="p">,</span> <span class="nv">%X</span> <span class="c">; yields i32:%0</span>
<span class="nv nv-Anonymous">%1</span> <span class="p">=</span> <span class="k">add</span> <span class="k">i32</span> <span class="nv nv-Anonymous">%0</span><span class="p">,</span> <span class="nv nv-Anonymous">%0</span> <span class="c">; yields i32:%1</span>
<span class="nv">%result</span> <span class="p">=</span> <span class="k">add</span> <span class="k">i32</span> <span class="nv nv-Anonymous">%1</span><span class="p">,</span> <span class="nv nv-Anonymous">%1</span>
</pre></div>
</div>
<p>This last way of multiplying <code class="docutils literal notranslate"><span class="pre">%X</span></code> by 8 illustrates several important
lexical features of LLVM:</p>
<ol class="arabic simple">
<li><p>Comments are delimited with a ‘<code class="docutils literal notranslate"><span class="pre">;</span></code>’ and go until the end of line.</p></li>
<li><p>Unnamed temporaries are created when the result of a computation is
not assigned to a named value.</p></li>
<li><p>Unnamed temporaries are numbered sequentially (using a per-function
incrementing counter, starting with 0). Note that basic blocks and unnamed
function parameters are included in this numbering. For example, if the
entry basic block is not given a label name and all function parameters are
named, then it will get number 0.</p></li>
</ol>
<p>It also shows a convention that we follow in this document. When
demonstrating instructions, we will follow an instruction with a comment
that defines the type and name of value produced.</p>
</div>
<div class="section" id="high-level-structure">
<h2><a class="toc-backref" href="#id1413">High Level Structure</a><a class="headerlink" href="#high-level-structure" title="Permalink to this headline">¶</a></h2>
<div class="section" id="module-structure">
<h3><a class="toc-backref" href="#id1414">Module Structure</a><a class="headerlink" href="#module-structure" title="Permalink to this headline">¶</a></h3>
<p>LLVM programs are composed of <code class="docutils literal notranslate"><span class="pre">Module</span></code>’s, each of which is a
translation unit of the input programs. Each module consists of
functions, global variables, and symbol table entries. Modules may be
combined together with the LLVM linker, which merges function (and
global variable) definitions, resolves forward declarations, and merges
symbol table entries. Here is an example of the “hello world” module:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="c">; Declare the string constant as a global constant.</span>
<span class="vg">@.str</span> <span class="p">=</span> <span class="k">private</span> <span class="k">unnamed_addr</span> <span class="k">constant</span> <span class="p">[</span><span class="m">13</span> <span class="k">x</span> <span class="k">i8</span><span class="p">]</span> <span class="k">c</span><span class="s">"hello world\0A\00"</span>
<span class="c">; External declaration of the puts function</span>
<span class="k">declare</span> <span class="k">i32</span> <span class="vg">@puts</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="k">nocapture</span><span class="p">)</span> <span class="k">nounwind</span>
<span class="c">; Definition of main function</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="c">; i32()*</span>
<span class="c">; Convert [13 x i8]* to i8*...</span>
<span class="nv">%cast210</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="p">[</span><span class="m">13</span> <span class="k">x</span> <span class="k">i8</span><span class="p">],</span> <span class="p">[</span><span class="m">13</span> <span class="k">x</span> <span class="k">i8</span><span class="p">]*</span> <span class="vg">@.str</span><span class="p">,</span> <span class="k">i64</span> <span class="m">0</span><span class="p">,</span> <span class="k">i64</span> <span class="m">0</span>
<span class="c">; Call puts function to write out the string to stdout.</span>
<span class="k">call</span> <span class="k">i32</span> <span class="vg">@puts</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%cast210</span><span class="p">)</span>
<span class="k">ret</span> <span class="k">i32</span> <span class="m">0</span>
<span class="p">}</span>
<span class="c">; Named metadata</span>
<span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="k">i32</span> <span class="m">42</span><span class="p">,</span> <span class="k">null</span><span class="p">,</span> <span class="nv">!"string"</span><span class="p">}</span>
<span class="nv">!foo</span> <span class="p">=</span> <span class="p">!{</span><span class="nv nv-Anonymous">!0</span><span class="p">}</span>
</pre></div>
</div>
<p>This example is made up of a <a class="reference internal" href="#globalvars"><span class="std std-ref">global variable</span></a> named
“<code class="docutils literal notranslate"><span class="pre">.str</span></code>”, an external declaration of the “<code class="docutils literal notranslate"><span class="pre">puts</span></code>” function, a
<a class="reference internal" href="#functionstructure"><span class="std std-ref">function definition</span></a> for “<code class="docutils literal notranslate"><span class="pre">main</span></code>” and
<a class="reference internal" href="#namedmetadatastructure"><span class="std std-ref">named metadata</span></a> “<code class="docutils literal notranslate"><span class="pre">foo</span></code>”.</p>
<p>In general, a module is made up of a list of global values (where both
functions and global variables are global values). Global values are
represented by a pointer to a memory location (in this case, a pointer
to an array of char, and a pointer to a function), and have one of the
following <a class="reference internal" href="#linkage"><span class="std std-ref">linkage types</span></a>.</p>
</div>
<div class="section" id="linkage-types">
<span id="linkage"></span><h3><a class="toc-backref" href="#id1415">Linkage Types</a><a class="headerlink" href="#linkage-types" title="Permalink to this headline">¶</a></h3>
<p>All Global Variables and Functions have one of the following types of
linkage:</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">private</span></code></dt><dd><p>Global values with “<code class="docutils literal notranslate"><span class="pre">private</span></code>” linkage are only directly
accessible by objects in the current module. In particular, linking
code into a module with a private global value may cause the
private to be renamed as necessary to avoid collisions. Because the
symbol is private to the module, all references can be updated. This
doesn’t show up in any symbol table in the object file.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">internal</span></code></dt><dd><p>Similar to private, but the value shows as a local symbol
(<code class="docutils literal notranslate"><span class="pre">STB_LOCAL</span></code> in the case of ELF) in the object file. This
corresponds to the notion of the ‘<code class="docutils literal notranslate"><span class="pre">static</span></code>’ keyword in C.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">available_externally</span></code></dt><dd><p>Globals with “<code class="docutils literal notranslate"><span class="pre">available_externally</span></code>” linkage are never emitted into
the object file corresponding to the LLVM module. From the linker’s
perspective, an <code class="docutils literal notranslate"><span class="pre">available_externally</span></code> global is equivalent to
an external declaration. They exist to allow inlining and other
optimizations to take place given knowledge of the definition of the
global, which is known to be somewhere outside the module. Globals
with <code class="docutils literal notranslate"><span class="pre">available_externally</span></code> linkage are allowed to be discarded at
will, and allow inlining and other optimizations. This linkage type is
only allowed on definitions, not declarations.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">linkonce</span></code></dt><dd><p>Globals with “<code class="docutils literal notranslate"><span class="pre">linkonce</span></code>” linkage are merged with other globals of
the same name when linkage occurs. This can be used to implement
some forms of inline functions, templates, or other code which must
be generated in each translation unit that uses it, but where the
body may be overridden with a more definitive definition later.
Unreferenced <code class="docutils literal notranslate"><span class="pre">linkonce</span></code> globals are allowed to be discarded. Note
that <code class="docutils literal notranslate"><span class="pre">linkonce</span></code> linkage does not actually allow the optimizer to
inline the body of this function into callers because it doesn’t
know if this definition of the function is the definitive definition
within the program or whether it will be overridden by a stronger
definition. To enable inlining and other optimizations, use
“<code class="docutils literal notranslate"><span class="pre">linkonce_odr</span></code>” linkage.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">weak</span></code></dt><dd><p>“<code class="docutils literal notranslate"><span class="pre">weak</span></code>” linkage has the same merging semantics as <code class="docutils literal notranslate"><span class="pre">linkonce</span></code>
linkage, except that unreferenced globals with <code class="docutils literal notranslate"><span class="pre">weak</span></code> linkage may
not be discarded. This is used for globals that are declared “weak”
in C source code.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">common</span></code></dt><dd><p>“<code class="docutils literal notranslate"><span class="pre">common</span></code>” linkage is most similar to “<code class="docutils literal notranslate"><span class="pre">weak</span></code>” linkage, but they
are used for tentative definitions in C, such as “<code class="docutils literal notranslate"><span class="pre">int</span> <span class="pre">X;</span></code>” at
global scope. Symbols with “<code class="docutils literal notranslate"><span class="pre">common</span></code>” linkage are merged in the
same way as <code class="docutils literal notranslate"><span class="pre">weak</span> <span class="pre">symbols</span></code>, and they may not be deleted if
unreferenced. <code class="docutils literal notranslate"><span class="pre">common</span></code> symbols may not have an explicit section,
must have a zero initializer, and may not be marked
‘<a class="reference internal" href="#globalvars"><span class="std std-ref">constant</span></a>’. Functions and aliases may not have
common linkage.</p>
</dd>
</dl>
<dl id="linkage-appending">
<dt><code class="docutils literal notranslate"><span class="pre">appending</span></code></dt><dd><p>“<code class="docutils literal notranslate"><span class="pre">appending</span></code>” linkage may only be applied to global variables of
pointer to array type. When two global variables with appending
linkage are linked together, the two global arrays are appended
together. This is the LLVM, typesafe, equivalent of having the
system linker append together “sections” with identical names when
.o files are linked.</p>
<p>Unfortunately this doesn’t correspond to any feature in .o files, so it
can only be used for variables like <code class="docutils literal notranslate"><span class="pre">llvm.global_ctors</span></code> which llvm
interprets specially.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">extern_weak</span></code></dt><dd><p>The semantics of this linkage follow the ELF object file model: the
symbol is weak until linked, if not linked, the symbol becomes null
instead of being an undefined reference.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">linkonce_odr</span></code>, <code class="docutils literal notranslate"><span class="pre">weak_odr</span></code></dt><dd><p>Some languages allow differing globals to be merged, such as two
functions with different semantics. Other languages, such as
<code class="docutils literal notranslate"><span class="pre">C++</span></code>, ensure that only equivalent globals are ever merged (the
“one definition rule” — “ODR”). Such languages can use the
<code class="docutils literal notranslate"><span class="pre">linkonce_odr</span></code> and <code class="docutils literal notranslate"><span class="pre">weak_odr</span></code> linkage types to indicate that the
global will only be merged with equivalent globals. These linkage
types are otherwise the same as their non-<code class="docutils literal notranslate"><span class="pre">odr</span></code> versions.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">external</span></code></dt><dd><p>If none of the above identifiers are used, the global is externally
visible, meaning that it participates in linkage and can be used to
resolve external symbol references.</p>
</dd>
</dl>
<p>It is illegal for a global variable or function <em>declaration</em> to have any
linkage type other than <code class="docutils literal notranslate"><span class="pre">external</span></code> or <code class="docutils literal notranslate"><span class="pre">extern_weak</span></code>.</p>
</div>
<div class="section" id="calling-conventions">
<span id="callingconv"></span><h3><a class="toc-backref" href="#id1416">Calling Conventions</a><a class="headerlink" href="#calling-conventions" title="Permalink to this headline">¶</a></h3>
<p>LLVM <a class="reference internal" href="#functionstructure"><span class="std std-ref">functions</span></a>, <a class="reference internal" href="#i-call"><span class="std std-ref">calls</span></a> and
<a class="reference internal" href="#i-invoke"><span class="std std-ref">invokes</span></a> can all have an optional calling convention
specified for the call. The calling convention of any pair of dynamic
caller/callee must match, or the behavior of the program is undefined.
The following calling conventions are supported by LLVM, and more may be
added in the future:</p>
<dl>
<dt>“<code class="docutils literal notranslate"><span class="pre">ccc</span></code>” - The C calling convention</dt><dd><p>This calling convention (the default if no other calling convention
is specified) matches the target C calling conventions. This calling
convention supports varargs function calls and tolerates some
mismatch in the declared prototype and implemented declaration of
the function (as does normal C).</p>
</dd>
<dt>“<code class="docutils literal notranslate"><span class="pre">fastcc</span></code>” - The fast calling convention</dt><dd><p>This calling convention attempts to make calls as fast as possible
(e.g. by passing things in registers). This calling convention
allows the target to use whatever tricks it wants to produce fast
code for the target, without having to conform to an externally
specified ABI (Application Binary Interface). <a class="reference external" href="CodeGenerator.html#id80">Tail calls can only
be optimized when this, the tailcc, the GHC or the HiPE convention is
used.</a> This calling convention does not
support varargs and requires the prototype of all callees to exactly
match the prototype of the function definition.</p>
</dd>
<dt>“<code class="docutils literal notranslate"><span class="pre">coldcc</span></code>” - The cold calling convention</dt><dd><p>This calling convention attempts to make code in the caller as
efficient as possible under the assumption that the call is not
commonly executed. As such, these calls often preserve all registers
so that the call does not break any live ranges in the caller side.
This calling convention does not support varargs and requires the
prototype of all callees to exactly match the prototype of the
function definition. Furthermore the inliner doesn’t consider such function
calls for inlining.</p>
</dd>
<dt>“<code class="docutils literal notranslate"><span class="pre">cc</span> <span class="pre">10</span></code>” - GHC convention</dt><dd><p>This calling convention has been implemented specifically for use by
the <a class="reference external" href="http://www.haskell.org/ghc">Glasgow Haskell Compiler (GHC)</a>.
It passes everything in registers, going to extremes to achieve this
by disabling callee save registers. This calling convention should
not be used lightly but only for specific situations such as an
alternative to the <em>register pinning</em> performance technique often
used when implementing functional programming languages. At the
moment only X86 supports this convention and it has the following
limitations:</p>
<ul class="simple">
<li><p>On <em>X86-32</em> only supports up to 4 bit type parameters. No
floating-point types are supported.</p></li>
<li><p>On <em>X86-64</em> only supports up to 10 bit type parameters and 6
floating-point parameters.</p></li>
</ul>
<p>This calling convention supports <a class="reference external" href="CodeGenerator.html#id80">tail call
optimization</a> but requires both the
caller and callee are using it.</p>
</dd>
<dt>“<code class="docutils literal notranslate"><span class="pre">cc</span> <span class="pre">11</span></code>” - The HiPE calling convention</dt><dd><p>This calling convention has been implemented specifically for use by
the <a class="reference external" href="http://www.it.uu.se/research/group/hipe/">High-Performance Erlang
(HiPE)</a> compiler, <em>the</em>
native code compiler of the <a class="reference external" href="http://www.erlang.org/download.shtml">Ericsson’s Open Source Erlang/OTP
system</a>. It uses more
registers for argument passing than the ordinary C calling
convention and defines no callee-saved registers. The calling
convention properly supports <a class="reference external" href="CodeGenerator.html#id80">tail call
optimization</a> but requires that both the
caller and the callee use it. It uses a <em>register pinning</em>
mechanism, similar to GHC’s convention, for keeping frequently
accessed runtime components pinned to specific hardware registers.
At the moment only X86 supports this convention (both 32 and 64
bit).</p>
</dd>
<dt>“<code class="docutils literal notranslate"><span class="pre">webkit_jscc</span></code>” - WebKit’s JavaScript calling convention</dt><dd><p>This calling convention has been implemented for <a class="reference external" href="https://trac.webkit.org/wiki/FTLJIT">WebKit FTL JIT</a>. It passes arguments on the
stack right to left (as cdecl does), and returns a value in the
platform’s customary return register.</p>
</dd>
<dt>“<code class="docutils literal notranslate"><span class="pre">anyregcc</span></code>” - Dynamic calling convention for code patching</dt><dd><p>This is a special convention that supports patching an arbitrary code
sequence in place of a call site. This convention forces the call
arguments into registers but allows them to be dynamically
allocated. This can currently only be used with calls to
llvm.experimental.patchpoint because only this intrinsic records
the location of its arguments in a side table. See <a class="reference internal" href="StackMaps.html"><span class="doc">Stack maps and patch points in LLVM</span></a>.</p>
</dd>
<dt>“<code class="docutils literal notranslate"><span class="pre">preserve_mostcc</span></code>” - The <cite>PreserveMost</cite> calling convention</dt><dd><p>This calling convention attempts to make the code in the caller as
unintrusive as possible. This convention behaves identically to the <cite>C</cite>
calling convention on how arguments and return values are passed, but it
uses a different set of caller/callee-saved registers. This alleviates the
burden of saving and recovering a large register set before and after the
call in the caller. If the arguments are passed in callee-saved registers,
then they will be preserved by the callee across the call. This doesn’t
apply for values returned in callee-saved registers.</p>
<ul class="simple">
<li><p>On X86-64 the callee preserves all general purpose registers, except for
R11. R11 can be used as a scratch register. Floating-point registers
(XMMs/YMMs) are not preserved and need to be saved by the caller.</p></li>
</ul>
<p>The idea behind this convention is to support calls to runtime functions
that have a hot path and a cold path. The hot path is usually a small piece
of code that doesn’t use many registers. The cold path might need to call out to
another function and therefore only needs to preserve the caller-saved
registers, which haven’t already been saved by the caller. The
<cite>PreserveMost</cite> calling convention is very similar to the <cite>cold</cite> calling
convention in terms of caller/callee-saved registers, but they are used for
different types of function calls. <cite>coldcc</cite> is for function calls that are
rarely executed, whereas <cite>preserve_mostcc</cite> function calls are intended to be
on the hot path and definitely executed a lot. Furthermore <cite>preserve_mostcc</cite>
doesn’t prevent the inliner from inlining the function call.</p>
<p>This calling convention will be used by a future version of the ObjectiveC
runtime and should therefore still be considered experimental at this time.
Although this convention was created to optimize certain runtime calls to
the ObjectiveC runtime, it is not limited to this runtime and might be used
by other runtimes in the future too. The current implementation only
supports X86-64, but the intention is to support more architectures in the
future.</p>
</dd>
<dt>“<code class="docutils literal notranslate"><span class="pre">preserve_allcc</span></code>” - The <cite>PreserveAll</cite> calling convention</dt><dd><p>This calling convention attempts to make the code in the caller even less
intrusive than the <cite>PreserveMost</cite> calling convention. This calling
convention also behaves identical to the <cite>C</cite> calling convention on how
arguments and return values are passed, but it uses a different set of
caller/callee-saved registers. This removes the burden of saving and
recovering a large register set before and after the call in the caller. If
the arguments are passed in callee-saved registers, then they will be
preserved by the callee across the call. This doesn’t apply for values
returned in callee-saved registers.</p>
<ul class="simple">
<li><p>On X86-64 the callee preserves all general purpose registers, except for
R11. R11 can be used as a scratch register. Furthermore it also preserves
all floating-point registers (XMMs/YMMs).</p></li>
</ul>
<p>The idea behind this convention is to support calls to runtime functions
that don’t need to call out to any other functions.</p>
<p>This calling convention, like the <cite>PreserveMost</cite> calling convention, will be
used by a future version of the ObjectiveC runtime and should be considered
experimental at this time.</p>
</dd>
<dt>“<code class="docutils literal notranslate"><span class="pre">cxx_fast_tlscc</span></code>” - The <cite>CXX_FAST_TLS</cite> calling convention for access functions</dt><dd><p>Clang generates an access function to access C++-style TLS. The access
function generally has an entry block, an exit block and an initialization
block that is run at the first time. The entry and exit blocks can access
a few TLS IR variables, each access will be lowered to a platform-specific
sequence.</p>
<p>This calling convention aims to minimize overhead in the caller by
preserving as many registers as possible (all the registers that are
preserved on the fast path, composed of the entry and exit blocks).</p>
<p>This calling convention behaves identical to the <cite>C</cite> calling convention on
how arguments and return values are passed, but it uses a different set of
caller/callee-saved registers.</p>
<p>Given that each platform has its own lowering sequence, hence its own set
of preserved registers, we can’t use the existing <cite>PreserveMost</cite>.</p>
<ul class="simple">
<li><p>On X86-64 the callee preserves all general purpose registers, except for
RDI and RAX.</p></li>
</ul>
</dd>
<dt>“<code class="docutils literal notranslate"><span class="pre">tailcc</span></code>” - Tail callable calling convention</dt><dd><p>This calling convention ensures that calls in tail position will always be
tail call optimized. This calling convention is equivalent to fastcc,
except for an additional guarantee that tail calls will be produced
whenever possible. <a class="reference external" href="CodeGenerator.html#id80">Tail calls can only be optimized when this, the fastcc,
the GHC or the HiPE convention is used.</a> This
calling convention does not support varargs and requires the prototype of
all callees to exactly match the prototype of the function definition.</p>
</dd>
<dt>“<code class="docutils literal notranslate"><span class="pre">swiftcc</span></code>” - This calling convention is used for Swift language.</dt><dd><ul class="simple">
<li><p>On X86-64 RCX and R8 are available for additional integer returns, and
XMM2 and XMM3 are available for additional FP/vector returns.</p></li>
<li><p>On iOS platforms, we use AAPCS-VFP calling convention.</p></li>
</ul>
</dd>
<dt>“<code class="docutils literal notranslate"><span class="pre">swifttailcc</span></code>”</dt><dd><p>This calling convention is like <code class="docutils literal notranslate"><span class="pre">swiftcc</span></code> in most respects, but also the
callee pops the argument area of the stack so that mandatory tail calls are
possible as in <code class="docutils literal notranslate"><span class="pre">tailcc</span></code>.</p>
</dd>
<dt>“<code class="docutils literal notranslate"><span class="pre">cfguard_checkcc</span></code>” - Windows Control Flow Guard (Check mechanism)</dt><dd><p>This calling convention is used for the Control Flow Guard check function,
calls to which can be inserted before indirect calls to check that the call
target is a valid function address. The check function has no return value,
but it will trigger an OS-level error if the address is not a valid target.
The set of registers preserved by the check function, and the register
containing the target address are architecture-specific.</p>
<ul class="simple">
<li><p>On X86 the target address is passed in ECX.</p></li>
<li><p>On ARM the target address is passed in R0.</p></li>
<li><p>On AArch64 the target address is passed in X15.</p></li>
</ul>
</dd>
<dt>“<code class="docutils literal notranslate"><span class="pre">cc</span> <span class="pre"><n></span></code>” - Numbered convention</dt><dd><p>Any calling convention may be specified by number, allowing
target-specific calling conventions to be used. Target specific
calling conventions start at 64.</p>
</dd>
</dl>
<p>More calling conventions can be added/defined on an as-needed basis, to
support Pascal conventions or any other well-known target-independent
convention.</p>
</div>
<div class="section" id="visibility-styles">
<span id="visibilitystyles"></span><h3><a class="toc-backref" href="#id1417">Visibility Styles</a><a class="headerlink" href="#visibility-styles" title="Permalink to this headline">¶</a></h3>
<p>All Global Variables and Functions have one of the following visibility
styles:</p>
<dl class="simple">
<dt>“<code class="docutils literal notranslate"><span class="pre">default</span></code>” - Default style</dt><dd><p>On targets that use the ELF object file format, default visibility
means that the declaration is visible to other modules and, in
shared libraries, means that the declared entity may be overridden.
On Darwin, default visibility means that the declaration is visible
to other modules. Default visibility corresponds to “external
linkage” in the language.</p>
</dd>
<dt>“<code class="docutils literal notranslate"><span class="pre">hidden</span></code>” - Hidden style</dt><dd><p>Two declarations of an object with hidden visibility refer to the
same object if they are in the same shared object. Usually, hidden
visibility indicates that the symbol will not be placed into the
dynamic symbol table, so no other module (executable or shared
library) can reference it directly.</p>
</dd>
<dt>“<code class="docutils literal notranslate"><span class="pre">protected</span></code>” - Protected style</dt><dd><p>On ELF, protected visibility indicates that the symbol will be
placed in the dynamic symbol table, but that references within the
defining module will bind to the local symbol. That is, the symbol
cannot be overridden by another module.</p>
</dd>
</dl>
<p>A symbol with <code class="docutils literal notranslate"><span class="pre">internal</span></code> or <code class="docutils literal notranslate"><span class="pre">private</span></code> linkage must have <code class="docutils literal notranslate"><span class="pre">default</span></code>
visibility.</p>
</div>
<div class="section" id="dll-storage-classes">
<span id="dllstorageclass"></span><h3><a class="toc-backref" href="#id1418">DLL Storage Classes</a><a class="headerlink" href="#dll-storage-classes" title="Permalink to this headline">¶</a></h3>
<p>All Global Variables, Functions and Aliases can have one of the following
DLL storage class:</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">dllimport</span></code></dt><dd><p>“<code class="docutils literal notranslate"><span class="pre">dllimport</span></code>” causes the compiler to reference a function or variable via
a global pointer to a pointer that is set up by the DLL exporting the
symbol. On Microsoft Windows targets, the pointer name is formed by
combining <code class="docutils literal notranslate"><span class="pre">__imp_</span></code> and the function or variable name.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">dllexport</span></code></dt><dd><p>“<code class="docutils literal notranslate"><span class="pre">dllexport</span></code>” causes the compiler to provide a global pointer to a pointer
in a DLL, so that it can be referenced with the <code class="docutils literal notranslate"><span class="pre">dllimport</span></code> attribute. On
Microsoft Windows targets, the pointer name is formed by combining
<code class="docutils literal notranslate"><span class="pre">__imp_</span></code> and the function or variable name. Since this storage class
exists for defining a dll interface, the compiler, assembler and linker know
it is externally referenced and must refrain from deleting the symbol.</p>
</dd>
</dl>
</div>
<div class="section" id="thread-local-storage-models">
<span id="tls-model"></span><h3><a class="toc-backref" href="#id1419">Thread Local Storage Models</a><a class="headerlink" href="#thread-local-storage-models" title="Permalink to this headline">¶</a></h3>
<p>A variable may be defined as <code class="docutils literal notranslate"><span class="pre">thread_local</span></code>, which means that it will
not be shared by threads (each thread will have a separated copy of the
variable). Not all targets support thread-local variables. Optionally, a
TLS model may be specified:</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">localdynamic</span></code></dt><dd><p>For variables that are only used within the current shared library.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">initialexec</span></code></dt><dd><p>For variables in modules that will not be loaded dynamically.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">localexec</span></code></dt><dd><p>For variables defined in the executable and only used within it.</p>
</dd>
</dl>
<p>If no explicit model is given, the “general dynamic” model is used.</p>
<p>The models correspond to the ELF TLS models; see <a class="reference external" href="http://people.redhat.com/drepper/tls.pdf">ELF Handling For
Thread-Local Storage</a> for
more information on under which circumstances the different models may
be used. The target may choose a different TLS model if the specified
model is not supported, or if a better choice of model can be made.</p>
<p>A model can also be specified in an alias, but then it only governs how
the alias is accessed. It will not have any effect in the aliasee.</p>
<p>For platforms without linker support of ELF TLS model, the -femulated-tls
flag can be used to generate GCC compatible emulated TLS code.</p>
</div>
<div class="section" id="runtime-preemption-specifiers">
<span id="runtime-preemption-model"></span><h3><a class="toc-backref" href="#id1420">Runtime Preemption Specifiers</a><a class="headerlink" href="#runtime-preemption-specifiers" title="Permalink to this headline">¶</a></h3>
<p>Global variables, functions and aliases may have an optional runtime preemption
specifier. If a preemption specifier isn’t given explicitly, then a
symbol is assumed to be <code class="docutils literal notranslate"><span class="pre">dso_preemptable</span></code>.</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">dso_preemptable</span></code></dt><dd><p>Indicates that the function or variable may be replaced by a symbol from
outside the linkage unit at runtime.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">dso_local</span></code></dt><dd><p>The compiler may assume that a function or variable marked as <code class="docutils literal notranslate"><span class="pre">dso_local</span></code>
will resolve to a symbol within the same linkage unit. Direct access will
be generated even if the definition is not within this compilation unit.</p>
</dd>
</dl>
</div>
<div class="section" id="structure-types">
<span id="namedtypes"></span><h3><a class="toc-backref" href="#id1421">Structure Types</a><a class="headerlink" href="#structure-types" title="Permalink to this headline">¶</a></h3>
<p>LLVM IR allows you to specify both “identified” and “literal” <a class="reference internal" href="#t-struct"><span class="std std-ref">structure
types</span></a>. Literal types are uniqued structurally, but identified types
are never uniqued. An <a class="reference internal" href="#t-opaque"><span class="std std-ref">opaque structural type</span></a> can also be used
to forward declare a type that is not yet available.</p>
<p>An example of an identified structure specification is:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%mytype</span> <span class="p">=</span> <span class="k">type</span> <span class="p">{</span> <span class="nv">%mytype</span><span class="p">*,</span> <span class="k">i32</span> <span class="p">}</span>
</pre></div>
</div>
<p>Prior to the LLVM 3.0 release, identified types were structurally uniqued. Only
literal types are uniqued in recent versions of LLVM.</p>
</div>
<div class="section" id="non-integral-pointer-type">
<span id="nointptrtype"></span><h3><a class="toc-backref" href="#id1422">Non-Integral Pointer Type</a><a class="headerlink" href="#non-integral-pointer-type" title="Permalink to this headline">¶</a></h3>
<p>Note: non-integral pointer types are a work in progress, and they should be
considered experimental at this time.</p>
<p>LLVM IR optionally allows the frontend to denote pointers in certain address
spaces as “non-integral” via the <a class="reference internal" href="#langref-datalayout"><span class="std std-ref">datalayout string</span></a>.
Non-integral pointer types represent pointers that have an <em>unspecified</em> bitwise
representation; that is, the integral representation may be target dependent or
unstable (not backed by a fixed integer).</p>
<p><code class="docutils literal notranslate"><span class="pre">inttoptr</span></code> and <code class="docutils literal notranslate"><span class="pre">ptrtoint</span></code> instructions have the same semantics as for
integral (i.e. normal) pointers in that they convert integers to and from
corresponding pointer types, but there are additional implications to be
aware of. Because the bit-representation of a non-integral pointer may
not be stable, two identical casts of the same operand may or may not
return the same value. Said differently, the conversion to or from the
non-integral type depends on environmental state in an implementation
defined manner.</p>
<p>If the frontend wishes to observe a <em>particular</em> value following a cast, the
generated IR must fence with the underlying environment in an implementation
defined manner. (In practice, this tends to require <code class="docutils literal notranslate"><span class="pre">noinline</span></code> routines for
such operations.)</p>
<p>From the perspective of the optimizer, <code class="docutils literal notranslate"><span class="pre">inttoptr</span></code> and <code class="docutils literal notranslate"><span class="pre">ptrtoint</span></code> for
non-integral types are analogous to ones on integral types with one
key exception: the optimizer may not, in general, insert new dynamic
occurrences of such casts. If a new cast is inserted, the optimizer would
need to either ensure that a) all possible values are valid, or b)
appropriate fencing is inserted. Since the appropriate fencing is
implementation defined, the optimizer can’t do the latter. The former is
challenging as many commonly expected properties, such as
<code class="docutils literal notranslate"><span class="pre">ptrtoint(v)-ptrtoint(v)</span> <span class="pre">==</span> <span class="pre">0</span></code>, don’t hold for non-integral types.</p>
</div>
<div class="section" id="global-variables">
<span id="globalvars"></span><h3><a class="toc-backref" href="#id1423">Global Variables</a><a class="headerlink" href="#global-variables" title="Permalink to this headline">¶</a></h3>
<p>Global variables define regions of memory allocated at compilation time
instead of run-time.</p>
<p>Global variable definitions must be initialized.</p>
<p>Global variables in other translation units can also be declared, in which
case they don’t have an initializer.</p>
<p>Global variables can optionally specify a <a class="reference internal" href="#linkage"><span class="std std-ref">linkage type</span></a>.</p>
<p>Either global variable definitions or declarations may have an explicit section
to be placed in and may have an optional explicit alignment specified. If there
is a mismatch between the explicit or inferred section information for the
variable declaration and its definition the resulting behavior is undefined.</p>
<p>A variable may be defined as a global <code class="docutils literal notranslate"><span class="pre">constant</span></code>, which indicates that
the contents of the variable will <strong>never</strong> be modified (enabling better
optimization, allowing the global data to be placed in the read-only
section of an executable, etc). Note that variables that need runtime
initialization cannot be marked <code class="docutils literal notranslate"><span class="pre">constant</span></code> as there is a store to the
variable.</p>
<p>LLVM explicitly allows <em>declarations</em> of global variables to be marked
constant, even if the final definition of the global is not. This
capability can be used to enable slightly better optimization of the
program, but requires the language definition to guarantee that
optimizations based on the ‘constantness’ are valid for the translation
units that do not include the definition.</p>
<p>As SSA values, global variables define pointer values that are in scope
(i.e. they dominate) all basic blocks in the program. Global variables
always define a pointer to their “content” type because they describe a
region of memory, and all memory objects in LLVM are accessed through
pointers.</p>
<p>Global variables can be marked with <code class="docutils literal notranslate"><span class="pre">unnamed_addr</span></code> which indicates
that the address is not significant, only the content. Constants marked
like this can be merged with other constants if they have the same
initializer. Note that a constant with significant address <em>can</em> be
merged with a <code class="docutils literal notranslate"><span class="pre">unnamed_addr</span></code> constant, the result being a constant
whose address is significant.</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">local_unnamed_addr</span></code> attribute is given, the address is known to
not be significant within the module.</p>
<p>A global variable may be declared to reside in a target-specific
numbered address space. For targets that support them, address spaces
may affect how optimizations are performed and/or what target
instructions are used to access the variable. The default address space
is zero. The address space qualifier must precede any other attributes.</p>
<p>LLVM allows an explicit section to be specified for globals. If the
target supports it, it will emit globals to the section specified.
Additionally, the global can placed in a comdat if the target has the necessary
support.</p>
<p>External declarations may have an explicit section specified. Section
information is retained in LLVM IR for targets that make use of this
information. Attaching section information to an external declaration is an
assertion that its definition is located in the specified section. If the
definition is located in a different section, the behavior is undefined.</p>
<p>By default, global initializers are optimized by assuming that global
variables defined within the module are not modified from their
initial values before the start of the global initializer. This is
true even for variables potentially accessible from outside the
module, including those with external linkage or appearing in
<code class="docutils literal notranslate"><span class="pre">@llvm.used</span></code> or dllexported variables. This assumption may be suppressed
by marking the variable with <code class="docutils literal notranslate"><span class="pre">externally_initialized</span></code>.</p>
<p>An explicit alignment may be specified for a global, which must be a
power of 2. If not present, or if the alignment is set to zero, the
alignment of the global is set by the target to whatever it feels
convenient. If an explicit alignment is specified, the global is forced
to have exactly that alignment. Targets and optimizers are not allowed
to over-align the global if the global has an assigned section. In this
case, the extra alignment could be observable: for example, code could
assume that the globals are densely packed in their section and try to
iterate over them as an array, alignment padding would break this
iteration. The maximum alignment is <code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre"><<</span> <span class="pre">29</span></code>.</p>
<p>For global variables declarations, as well as definitions that may be
replaced at link time (<code class="docutils literal notranslate"><span class="pre">linkonce</span></code>, <code class="docutils literal notranslate"><span class="pre">weak</span></code>, <code class="docutils literal notranslate"><span class="pre">extern_weak</span></code> and <code class="docutils literal notranslate"><span class="pre">common</span></code>
linkage types), LLVM makes no assumptions about the allocation size of the
variables, except that they may not overlap. The alignment of a global variable
declaration or replaceable definition must not be greater than the alignment of
the definition it resolves to.</p>
<p>Globals can also have a <a class="reference internal" href="#dllstorageclass"><span class="std std-ref">DLL storage class</span></a>,
an optional <a class="reference internal" href="#runtime-preemption-model"><span class="std std-ref">runtime preemption specifier</span></a>,
an optional <a class="reference internal" href="#glattrs"><span class="std std-ref">global attributes</span></a> and
an optional list of attached <a class="reference internal" href="#metadata"><span class="std std-ref">metadata</span></a>.</p>
<p>Variables and aliases can have a
<a class="reference internal" href="#tls-model"><span class="std std-ref">Thread Local Storage Model</span></a>.</p>
<p><a class="reference internal" href="#t-vector"><span class="std std-ref">Scalable vectors</span></a> cannot be global variables or members of
arrays because their size is unknown at compile time. They are allowed in
structs to facilitate intrinsics returning multiple values. Structs containing
scalable vectors cannot be used in loads, stores, allocas, or GEPs.</p>
<p>Syntax:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>@<GlobalVarName> = [Linkage] [PreemptionSpecifier] [Visibility]
[DLLStorageClass] [ThreadLocal]
[(unnamed_addr|local_unnamed_addr)] [AddrSpace]
[ExternallyInitialized]
<global | constant> <Type> [<InitializerConstant>]
[, section "name"] [, comdat [($name)]]
[, align <Alignment>] (, !name !N)*
</pre></div>
</div>
<p>For example, the following defines a global in a numbered address space
with an initializer, section, and alignment:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="vg">@G</span> <span class="p">=</span> <span class="k">addrspace</span><span class="p">(</span><span class="m">5</span><span class="p">)</span> <span class="k">constant</span> <span class="k">float</span> <span class="m">1.0</span><span class="p">,</span> <span class="k">section</span> <span class="s">"foo"</span><span class="p">,</span> <span class="k">align</span> <span class="m">4</span>
</pre></div>
</div>
<p>The following example just declares a global variable</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="vg">@G</span> <span class="p">=</span> <span class="k">external</span> <span class="k">global</span> <span class="k">i32</span>
</pre></div>
</div>
<p>The following example defines a thread-local global with the
<code class="docutils literal notranslate"><span class="pre">initialexec</span></code> TLS model:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="vg">@G</span> <span class="p">=</span> <span class="k">thread_local</span><span class="p">(</span><span class="k">initialexec</span><span class="p">)</span> <span class="k">global</span> <span class="k">i32</span> <span class="m">0</span><span class="p">,</span> <span class="k">align</span> <span class="m">4</span>
</pre></div>
</div>
</div>
<div class="section" id="functions">
<span id="functionstructure"></span><h3><a class="toc-backref" href="#id1424">Functions</a><a class="headerlink" href="#functions" title="Permalink to this headline">¶</a></h3>
<p>LLVM function definitions consist of the “<code class="docutils literal notranslate"><span class="pre">define</span></code>” keyword, an
optional <a class="reference internal" href="#linkage"><span class="std std-ref">linkage type</span></a>, an optional <a class="reference internal" href="#runtime-preemption-model"><span class="std std-ref">runtime preemption
specifier</span></a>, an optional <a class="reference internal" href="BitCodeFormat.html#visibility"><span class="std std-ref">visibility
style</span></a>, an optional <a class="reference internal" href="#dllstorageclass"><span class="std std-ref">DLL storage class</span></a>,
an optional <a class="reference internal" href="#callingconv"><span class="std std-ref">calling convention</span></a>,
an optional <code class="docutils literal notranslate"><span class="pre">unnamed_addr</span></code> attribute, a return type, an optional
<a class="reference internal" href="#paramattrs"><span class="std std-ref">parameter attribute</span></a> for the return type, a function
name, a (possibly empty) argument list (each with optional <a class="reference internal" href="#paramattrs"><span class="std std-ref">parameter
attributes</span></a>), optional <a class="reference internal" href="#fnattrs"><span class="std std-ref">function attributes</span></a>,
an optional address space, an optional section, an optional alignment,
an optional <a class="reference internal" href="#langref-comdats"><span class="std std-ref">comdat</span></a>,
an optional <a class="reference internal" href="#gc"><span class="std std-ref">garbage collector name</span></a>, an optional <a class="reference internal" href="#prefixdata"><span class="std std-ref">prefix</span></a>,
an optional <a class="reference internal" href="#prologuedata"><span class="std std-ref">prologue</span></a>,
an optional <a class="reference internal" href="#personalityfn"><span class="std std-ref">personality</span></a>,
an optional list of attached <a class="reference internal" href="#metadata"><span class="std std-ref">metadata</span></a>,
an opening curly brace, a list of basic blocks, and a closing curly brace.</p>
<p>LLVM function declarations consist of the “<code class="docutils literal notranslate"><span class="pre">declare</span></code>” keyword, an
optional <a class="reference internal" href="#linkage"><span class="std std-ref">linkage type</span></a>, an optional <a class="reference internal" href="BitCodeFormat.html#visibility"><span class="std std-ref">visibility style</span></a>, an optional <a class="reference internal" href="#dllstorageclass"><span class="std std-ref">DLL storage class</span></a>, an
optional <a class="reference internal" href="#callingconv"><span class="std std-ref">calling convention</span></a>, an optional <code class="docutils literal notranslate"><span class="pre">unnamed_addr</span></code>
or <code class="docutils literal notranslate"><span class="pre">local_unnamed_addr</span></code> attribute, an optional address space, a return type,
an optional <a class="reference internal" href="#paramattrs"><span class="std std-ref">parameter attribute</span></a> for the return type, a function name, a possibly
empty list of arguments, an optional alignment, an optional <a class="reference internal" href="#gc"><span class="std std-ref">garbage
collector name</span></a>, an optional <a class="reference internal" href="#prefixdata"><span class="std std-ref">prefix</span></a>, and an optional
<a class="reference internal" href="#prologuedata"><span class="std std-ref">prologue</span></a>.</p>
<p>A function definition contains a list of basic blocks, forming the CFG (Control
Flow Graph) for the function. Each basic block may optionally start with a label
(giving the basic block a symbol table entry), contains a list of instructions,
and ends with a <a class="reference internal" href="#terminators"><span class="std std-ref">terminator</span></a> instruction (such as a branch or
function return). If an explicit label name is not provided, a block is assigned
an implicit numbered label, using the next value from the same counter as used
for unnamed temporaries (<a class="reference internal" href="#identifiers"><span class="std std-ref">see above</span></a>). For example, if a
function entry block does not have an explicit label, it will be assigned label
“%0”, then the first unnamed temporary in that block will be “%1”, etc. If a
numeric label is explicitly specified, it must match the numeric label that
would be used implicitly.</p>
<p>The first basic block in a function is special in two ways: it is
immediately executed on entrance to the function, and it is not allowed
to have predecessor basic blocks (i.e. there can not be any branches to
the entry block of a function). Because the block can have no
predecessors, it also cannot have any <a class="reference internal" href="#i-phi"><span class="std std-ref">PHI nodes</span></a>.</p>
<p>LLVM allows an explicit section to be specified for functions. If the
target supports it, it will emit functions to the section specified.
Additionally, the function can be placed in a COMDAT.</p>
<p>An explicit alignment may be specified for a function. If not present,
or if the alignment is set to zero, the alignment of the function is set
by the target to whatever it feels convenient. If an explicit alignment
is specified, the function is forced to have at least that much
alignment. All alignments must be a power of 2.</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">unnamed_addr</span></code> attribute is given, the address is known to not
be significant and two identical functions can be merged.</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">local_unnamed_addr</span></code> attribute is given, the address is known to
not be significant within the module.</p>
<p>If an explicit address space is not given, it will default to the program
address space from the <a class="reference internal" href="#langref-datalayout"><span class="std std-ref">datalayout string</span></a>.</p>
<p>Syntax:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>define [linkage] [PreemptionSpecifier] [visibility] [DLLStorageClass]
[cconv] [ret attrs]
<ResultType> @<FunctionName> ([argument list])
[(unnamed_addr|local_unnamed_addr)] [AddrSpace] [fn Attrs]
[section "name"] [comdat [($name)]] [align N] [gc] [prefix Constant]
[prologue Constant] [personality Constant] (!name !N)* { ... }
</pre></div>
</div>
<p>The argument list is a comma separated sequence of arguments where each
argument is of the following form:</p>
<p>Syntax:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="p">[</span><span class="n">parameter</span> <span class="n">Attrs</span><span class="p">]</span> <span class="p">[</span><span class="n">name</span><span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="aliases">
<span id="langref-aliases"></span><h3><a class="toc-backref" href="#id1425">Aliases</a><a class="headerlink" href="#aliases" title="Permalink to this headline">¶</a></h3>
<p>Aliases, unlike function or variables, don’t create any new data. They
are just a new symbol and metadata for an existing position.</p>
<p>Aliases have a name and an aliasee that is either a global value or a
constant expression.</p>
<p>Aliases may have an optional <a class="reference internal" href="#linkage"><span class="std std-ref">linkage type</span></a>, an optional
<a class="reference internal" href="#runtime-preemption-model"><span class="std std-ref">runtime preemption specifier</span></a>, an optional
<a class="reference internal" href="BitCodeFormat.html#visibility"><span class="std std-ref">visibility style</span></a>, an optional <a class="reference internal" href="#dllstorageclass"><span class="std std-ref">DLL storage class</span></a> and an optional <a class="reference internal" href="#tls-model"><span class="std std-ref">tls model</span></a>.</p>
<p>Syntax:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">@<</span><span class="n">Name</span><span class="o">></span> <span class="o">=</span> <span class="p">[</span><span class="n">Linkage</span><span class="p">]</span> <span class="p">[</span><span class="n">PreemptionSpecifier</span><span class="p">]</span> <span class="p">[</span><span class="n">Visibility</span><span class="p">]</span> <span class="p">[</span><span class="n">DLLStorageClass</span><span class="p">]</span> <span class="p">[</span><span class="n">ThreadLocal</span><span class="p">]</span> <span class="p">[(</span><span class="n">unnamed_addr</span><span class="o">|</span><span class="n">local_unnamed_addr</span><span class="p">)]</span> <span class="n">alias</span> <span class="o"><</span><span class="n">AliaseeTy</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">AliaseeTy</span><span class="o">>*</span> <span class="o">@<</span><span class="n">Aliasee</span><span class="o">></span>
</pre></div>
</div>
<p>The linkage must be one of <code class="docutils literal notranslate"><span class="pre">private</span></code>, <code class="docutils literal notranslate"><span class="pre">internal</span></code>, <code class="docutils literal notranslate"><span class="pre">linkonce</span></code>, <code class="docutils literal notranslate"><span class="pre">weak</span></code>,
<code class="docutils literal notranslate"><span class="pre">linkonce_odr</span></code>, <code class="docutils literal notranslate"><span class="pre">weak_odr</span></code>, <code class="docutils literal notranslate"><span class="pre">external</span></code>. Note that some system linkers
might not correctly handle dropping a weak symbol that is aliased.</p>
<p>Aliases that are not <code class="docutils literal notranslate"><span class="pre">unnamed_addr</span></code> are guaranteed to have the same address as
the aliasee expression. <code class="docutils literal notranslate"><span class="pre">unnamed_addr</span></code> ones are only guaranteed to point
to the same content.</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">local_unnamed_addr</span></code> attribute is given, the address is known to
not be significant within the module.</p>
<p>Since aliases are only a second name, some restrictions apply, of which
some can only be checked when producing an object file:</p>
<ul class="simple">
<li><p>The expression defining the aliasee must be computable at assembly
time. Since it is just a name, no relocations can be used.</p></li>
<li><p>No alias in the expression can be weak as the possibility of the
intermediate alias being overridden cannot be represented in an
object file.</p></li>
<li><p>No global value in the expression can be a declaration, since that
would require a relocation, which is not possible.</p></li>
</ul>
</div>
<div class="section" id="ifuncs">
<span id="langref-ifunc"></span><h3><a class="toc-backref" href="#id1426">IFuncs</a><a class="headerlink" href="#ifuncs" title="Permalink to this headline">¶</a></h3>
<p>IFuncs, like as aliases, don’t create any new data or func. They are just a new
symbol that dynamic linker resolves at runtime by calling a resolver function.</p>
<p>IFuncs have a name and a resolver that is a function called by dynamic linker
that returns address of another function associated with the name.</p>
<p>IFunc may have an optional <a class="reference internal" href="#linkage"><span class="std std-ref">linkage type</span></a> and an optional
<a class="reference internal" href="BitCodeFormat.html#visibility"><span class="std std-ref">visibility style</span></a>.</p>
<p>Syntax:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">@<</span><span class="n">Name</span><span class="o">></span> <span class="o">=</span> <span class="p">[</span><span class="n">Linkage</span><span class="p">]</span> <span class="p">[</span><span class="n">Visibility</span><span class="p">]</span> <span class="n">ifunc</span> <span class="o"><</span><span class="n">IFuncTy</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">ResolverTy</span><span class="o">>*</span> <span class="o">@<</span><span class="n">Resolver</span><span class="o">></span>
</pre></div>
</div>
</div>
<div class="section" id="comdats">
<span id="langref-comdats"></span><h3><a class="toc-backref" href="#id1427">Comdats</a><a class="headerlink" href="#comdats" title="Permalink to this headline">¶</a></h3>
<p>Comdat IR provides access to object file COMDAT/section group functionality
which represents interrelated sections.</p>
<p>Comdats have a name which represents the COMDAT key and a selection kind to
provide input on how the linker deduplicates comdats with the same key in two
different object files. A comdat must be included or omitted as a unit.
Discarding the whole comdat is allowed but discarding a subset is not.</p>
<p>A global object may be a member of at most one comdat. Aliases are placed in the
same COMDAT that their aliasee computes to, if any.</p>
<p>Syntax:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>$<Name> = comdat SelectionKind
</pre></div>
</div>
<p>For selection kinds other than <code class="docutils literal notranslate"><span class="pre">nodeduplicate</span></code>, only one of the duplicate
comdats may be retained by the linker and the members of the remaining comdats
must be discarded. The following selection kinds are supported:</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">any</span></code></dt><dd><p>The linker may choose any COMDAT key, the choice is arbitrary.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">exactmatch</span></code></dt><dd><p>The linker may choose any COMDAT key but the sections must contain the
same data.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">largest</span></code></dt><dd><p>The linker will choose the section containing the largest COMDAT key.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">nodeduplicate</span></code></dt><dd><p>No deduplication is performed.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">samesize</span></code></dt><dd><p>The linker may choose any COMDAT key but the sections must contain the
same amount of data.</p>
</dd>
</dl>
<ul class="simple">
<li><p>XCOFF and Mach-O don’t support COMDATs.</p></li>
<li><p>COFF supports all selection kinds. Non-<code class="docutils literal notranslate"><span class="pre">nodeduplicate</span></code> selection kinds need
a non-local linkage COMDAT symbol.</p></li>
<li><p>ELF supports <code class="docutils literal notranslate"><span class="pre">any</span></code> and <code class="docutils literal notranslate"><span class="pre">nodeduplicate</span></code>.</p></li>
<li><p>WebAssembly only supports <code class="docutils literal notranslate"><span class="pre">any</span></code>.</p></li>
</ul>
<p>Here is an example of a COFF COMDAT where a function will only be selected if
the COMDAT key’s section is the largest:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$foo = comdat largest
@foo = global i32 2, comdat($foo)
define void @bar() comdat($foo) {
ret void
}
</pre></div>
</div>
<p>In a COFF object file, this will create a COMDAT section with selection kind
<code class="docutils literal notranslate"><span class="pre">IMAGE_COMDAT_SELECT_LARGEST</span></code> containing the contents of the <code class="docutils literal notranslate"><span class="pre">@foo</span></code> symbol
and another COMDAT section with selection kind
<code class="docutils literal notranslate"><span class="pre">IMAGE_COMDAT_SELECT_ASSOCIATIVE</span></code> which is associated with the first COMDAT
section and contains the contents of the <code class="docutils literal notranslate"><span class="pre">@bar</span></code> symbol.</p>
<p>As a syntactic sugar the <code class="docutils literal notranslate"><span class="pre">$name</span></code> can be omitted if the name is the same as
the global name:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span>$foo = comdat any
@foo = global i32 2, comdat
@bar = global i32 3, comdat($foo)
</pre></div>
</div>
<p>There are some restrictions on the properties of the global object.
It, or an alias to it, must have the same name as the COMDAT group when
targeting COFF.
The contents and size of this object may be used during link-time to determine
which COMDAT groups get selected depending on the selection kind.
Because the name of the object must match the name of the COMDAT group, the
linkage of the global object must not be local; local symbols can get renamed
if a collision occurs in the symbol table.</p>
<p>The combined use of COMDATS and section attributes may yield surprising results.
For example:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span>$foo = comdat any
$bar = comdat any
@g1 = global i32 42, section "sec", comdat($foo)
@g2 = global i32 42, section "sec", comdat($bar)
</pre></div>
</div>
<p>From the object file perspective, this requires the creation of two sections
with the same name. This is necessary because both globals belong to different
COMDAT groups and COMDATs, at the object file level, are represented by
sections.</p>
<p>Note that certain IR constructs like global variables and functions may
create COMDATs in the object file in addition to any which are specified using
COMDAT IR. This arises when the code generator is configured to emit globals
in individual sections (e.g. when <cite>-data-sections</cite> or <cite>-function-sections</cite>
is supplied to <cite>llc</cite>).</p>
</div>
<div class="section" id="named-metadata">
<span id="namedmetadatastructure"></span><h3><a class="toc-backref" href="#id1428">Named Metadata</a><a class="headerlink" href="#named-metadata" title="Permalink to this headline">¶</a></h3>
<p>Named metadata is a collection of metadata. <a class="reference internal" href="#metadata"><span class="std std-ref">Metadata
nodes</span></a> (but not metadata strings) are the only valid
operands for a named metadata.</p>
<ol class="arabic simple">
<li><p>Named metadata are represented as a string of characters with the
metadata prefix. The rules for metadata names are the same as for
identifiers, but quoted names are not allowed. <code class="docutils literal notranslate"><span class="pre">"\xx"</span></code> type escapes
are still valid, which allows any character to be part of a name.</p></li>
</ol>
<p>Syntax:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>; Some unnamed metadata nodes, which are referenced by the named metadata.
!0 = !{!"zero"}
!1 = !{!"one"}
!2 = !{!"two"}
; A named metadata.
!name = !{!0, !1, !2}
</pre></div>
</div>
</div>
<div class="section" id="parameter-attributes">
<span id="paramattrs"></span><h3><a class="toc-backref" href="#id1429">Parameter Attributes</a><a class="headerlink" href="#parameter-attributes" title="Permalink to this headline">¶</a></h3>
<p>The return type and each parameter of a function type may have a set of
<em>parameter attributes</em> associated with them. Parameter attributes are
used to communicate additional information about the result or
parameters of a function. Parameter attributes are considered to be part
of the function, not of the function type, so functions with different
parameter attributes can have the same function type.</p>
<p>Parameter attributes are simple keywords that follow the type specified.
If multiple parameter attributes are needed, they are space separated.
For example:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">declare</span> <span class="k">i32</span> <span class="vg">@printf</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="k">noalias</span> <span class="k">nocapture</span><span class="p">,</span> <span class="p">...)</span>
<span class="k">declare</span> <span class="k">i32</span> <span class="vg">@atoi</span><span class="p">(</span><span class="k">i8</span> <span class="k">zeroext</span><span class="p">)</span>
<span class="k">declare</span> <span class="k">signext</span> <span class="k">i8</span> <span class="vg">@returns_signed_char</span><span class="p">()</span>
</pre></div>
</div>
<p>Note that any attributes for the function result (<code class="docutils literal notranslate"><span class="pre">nounwind</span></code>,
<code class="docutils literal notranslate"><span class="pre">readonly</span></code>) come immediately after the argument list.</p>
<p>Currently, only the following parameter attributes are defined:</p>
<dl>
<dt><code class="docutils literal notranslate"><span class="pre">zeroext</span></code></dt><dd><p>This indicates to the code generator that the parameter or return
value should be zero-extended to the extent required by the target’s
ABI by the caller (for a parameter) or the callee (for a return value).</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">signext</span></code></dt><dd><p>This indicates to the code generator that the parameter or return
value should be sign-extended to the extent required by the target’s
ABI (which is usually 32-bits) by the caller (for a parameter) or
the callee (for a return value).</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">inreg</span></code></dt><dd><p>This indicates that this parameter or return value should be treated
in a special target-dependent fashion while emitting code for
a function call or return (usually, by putting it in a register as
opposed to memory, though some targets use it to distinguish between
two different kinds of registers). Use of this attribute is
target-specific.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">byval(<ty>)</span></code></dt><dd><p>This indicates that the pointer parameter should really be passed by
value to the function. The attribute implies that a hidden copy of
the pointee is made between the caller and the callee, so the callee
is unable to modify the value in the caller. This attribute is only
valid on LLVM pointer arguments. It is generally used to pass
structs and arrays by value, but is also valid on pointers to
scalars. The copy is considered to belong to the caller not the
callee (for example, <code class="docutils literal notranslate"><span class="pre">readonly</span></code> functions should not write to
<code class="docutils literal notranslate"><span class="pre">byval</span></code> parameters). This is not a valid attribute for return
values.</p>
<p>The byval type argument indicates the in-memory value type, and
must be the same as the pointee type of the argument.</p>
<p>The byval attribute also supports specifying an alignment with the
align attribute. It indicates the alignment of the stack slot to
form and the known alignment of the pointer specified to the call
site. If the alignment is not specified, then the code generator
makes a target-specific assumption.</p>
</dd>
</dl>
<p id="attr-byref"><code class="docutils literal notranslate"><span class="pre">byref(<ty>)</span></code></p>
<blockquote>
<div><p>The <code class="docutils literal notranslate"><span class="pre">byref</span></code> argument attribute allows specifying the pointee
memory type of an argument. This is similar to <code class="docutils literal notranslate"><span class="pre">byval</span></code>, but does
not imply a copy is made anywhere, or that the argument is passed
on the stack. This implies the pointer is dereferenceable up to
the storage size of the type.</p>
<p>It is not generally permissible to introduce a write to an
<code class="docutils literal notranslate"><span class="pre">byref</span></code> pointer. The pointer may have any address space and may
be read only.</p>
<p>This is not a valid attribute for return values.</p>
<p>The alignment for an <code class="docutils literal notranslate"><span class="pre">byref</span></code> parameter can be explicitly
specified by combining it with the <code class="docutils literal notranslate"><span class="pre">align</span></code> attribute, similar to
<code class="docutils literal notranslate"><span class="pre">byval</span></code>. If the alignment is not specified, then the code generator
makes a target-specific assumption.</p>
<p>This is intended for representing ABI constraints, and is not
intended to be inferred for optimization use.</p>
</div></blockquote>
<dl id="attr-preallocated">
<dt><code class="docutils literal notranslate"><span class="pre">preallocated(<ty>)</span></code></dt><dd><p>This indicates that the pointer parameter should really be passed by
value to the function, and that the pointer parameter’s pointee has
already been initialized before the call instruction. This attribute
is only valid on LLVM pointer arguments. The argument must be the value
returned by the appropriate
<a class="reference internal" href="#int-call-preallocated-arg"><span class="std std-ref">llvm.call.preallocated.arg</span></a> on non
<code class="docutils literal notranslate"><span class="pre">musttail</span></code> calls, or the corresponding caller parameter in <code class="docutils literal notranslate"><span class="pre">musttail</span></code>
calls, although it is ignored during codegen.</p>
<p>A non <code class="docutils literal notranslate"><span class="pre">musttail</span></code> function call with a <code class="docutils literal notranslate"><span class="pre">preallocated</span></code> attribute in
any parameter must have a <code class="docutils literal notranslate"><span class="pre">"preallocated"</span></code> operand bundle. A <code class="docutils literal notranslate"><span class="pre">musttail</span></code>
function call cannot have a <code class="docutils literal notranslate"><span class="pre">"preallocated"</span></code> operand bundle.</p>
<p>The preallocated attribute requires a type argument, which must be
the same as the pointee type of the argument.</p>
<p>The preallocated attribute also supports specifying an alignment with the
align attribute. It indicates the alignment of the stack slot to
form and the known alignment of the pointer specified to the call
site. If the alignment is not specified, then the code generator
makes a target-specific assumption.</p>
</dd>
</dl>
<p id="attr-inalloca"><code class="docutils literal notranslate"><span class="pre">inalloca(<ty>)</span></code></p>
<blockquote>
<div><p>The <code class="docutils literal notranslate"><span class="pre">inalloca</span></code> argument attribute allows the caller to take the
address of outgoing stack arguments. An <code class="docutils literal notranslate"><span class="pre">inalloca</span></code> argument must
be a pointer to stack memory produced by an <code class="docutils literal notranslate"><span class="pre">alloca</span></code> instruction.
The alloca, or argument allocation, must also be tagged with the
inalloca keyword. Only the last argument may have the <code class="docutils literal notranslate"><span class="pre">inalloca</span></code>
attribute, and that argument is guaranteed to be passed in memory.</p>
<p>An argument allocation may be used by a call at most once because
the call may deallocate it. The <code class="docutils literal notranslate"><span class="pre">inalloca</span></code> attribute cannot be
used in conjunction with other attributes that affect argument
storage, like <code class="docutils literal notranslate"><span class="pre">inreg</span></code>, <code class="docutils literal notranslate"><span class="pre">nest</span></code>, <code class="docutils literal notranslate"><span class="pre">sret</span></code>, or <code class="docutils literal notranslate"><span class="pre">byval</span></code>. The
<code class="docutils literal notranslate"><span class="pre">inalloca</span></code> attribute also disables LLVM’s implicit lowering of
large aggregate return values, which means that frontend authors
must lower them with <code class="docutils literal notranslate"><span class="pre">sret</span></code> pointers.</p>
<p>When the call site is reached, the argument allocation must have
been the most recent stack allocation that is still live, or the
behavior is undefined. It is possible to allocate additional stack
space after an argument allocation and before its call site, but it
must be cleared off with <a class="reference internal" href="#int-stackrestore"><span class="std std-ref">llvm.stackrestore</span></a>.</p>
<p>The inalloca attribute requires a type argument, which must be the
same as the pointee type of the argument.</p>
<p>See <a class="reference internal" href="InAlloca.html"><span class="doc">Design and Usage of the InAlloca Attribute</span></a> for more information on how to use this
attribute.</p>
</div></blockquote>
<dl>
<dt><code class="docutils literal notranslate"><span class="pre">sret(<ty>)</span></code></dt><dd><p>This indicates that the pointer parameter specifies the address of a
structure that is the return value of the function in the source
program. This pointer must be guaranteed by the caller to be valid:
loads and stores to the structure may be assumed by the callee not
to trap and to be properly aligned. This is not a valid attribute
for return values.</p>
<p>The sret type argument specifies the in memory type, which must be
the same as the pointee type of the argument.</p>
</dd>
</dl>
<p id="attr-elementtype"><code class="docutils literal notranslate"><span class="pre">elementtype(<ty>)</span></code></p>
<blockquote>
<div><p>The <code class="docutils literal notranslate"><span class="pre">elementtype</span></code> argument attribute can be used to specify a pointer
element type in a way that is compatible with <cite>opaque pointers
<OpaquePointers.html></cite>.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">elementtype</span></code> attribute by itself does not carry any specific
semantics. However, certain intrinsics may require this attribute to be
present and assign it particular semantics. This will be documented on
individual intrinsics.</p>
<p>The attribute may only be applied to pointer typed arguments of intrinsic
calls. It cannot be applied to non-intrinsic calls, and cannot be applied
to parameters on function declarations. For non-opaque pointers, the type
passed to <code class="docutils literal notranslate"><span class="pre">elementtype</span></code> must match the pointer element type.</p>
</div></blockquote>
<dl id="attr-align">
<dt><code class="docutils literal notranslate"><span class="pre">align</span> <span class="pre"><n></span></code> or <code class="docutils literal notranslate"><span class="pre">align(<n>)</span></code></dt><dd><p>This indicates that the pointer value has the specified alignment.
If the pointer value does not have the specified alignment,
<a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a> is returned or passed instead. The
<code class="docutils literal notranslate"><span class="pre">align</span></code> attribute should be combined with the <code class="docutils literal notranslate"><span class="pre">noundef</span></code> attribute to
ensure a pointer is aligned, or otherwise the behavior is undefined. Note
that <code class="docutils literal notranslate"><span class="pre">align</span> <span class="pre">1</span></code> has no effect on non-byval, non-preallocated arguments.</p>
<p>Note that this attribute has additional semantics when combined with the
<code class="docutils literal notranslate"><span class="pre">byval</span></code> or <code class="docutils literal notranslate"><span class="pre">preallocated</span></code> attribute, which are documented there.</p>
</dd>
</dl>
<dl id="noalias">
<dt><code class="docutils literal notranslate"><span class="pre">noalias</span></code></dt><dd><p>This indicates that memory locations accessed via pointer values
<a class="reference internal" href="#pointeraliasing"><span class="std std-ref">based</span></a> on the argument or return value are not also
accessed, during the execution of the function, via pointer values not
<em>based</em> on the argument or return value. This guarantee only holds for
memory locations that are <em>modified</em>, by any means, during the execution of
the function. The attribute on a return value also has additional semantics
described below. The caller shares the responsibility with the callee for
ensuring that these requirements are met. For further details, please see
the discussion of the NoAlias response in <a class="reference internal" href="AliasAnalysis.html#must-may-or-no"><span class="std std-ref">alias analysis</span></a>.</p>
<p>Note that this definition of <code class="docutils literal notranslate"><span class="pre">noalias</span></code> is intentionally similar
to the definition of <code class="docutils literal notranslate"><span class="pre">restrict</span></code> in C99 for function arguments.</p>
<p>For function return values, C99’s <code class="docutils literal notranslate"><span class="pre">restrict</span></code> is not meaningful,
while LLVM’s <code class="docutils literal notranslate"><span class="pre">noalias</span></code> is. Furthermore, the semantics of the <code class="docutils literal notranslate"><span class="pre">noalias</span></code>
attribute on return values are stronger than the semantics of the attribute
when used on function arguments. On function return values, the <code class="docutils literal notranslate"><span class="pre">noalias</span></code>
attribute indicates that the function acts like a system memory allocation
function, returning a pointer to allocated storage disjoint from the
storage for any other object accessible to the caller.</p>
</dd>
</dl>
<dl class="simple" id="nocapture">
<dt><code class="docutils literal notranslate"><span class="pre">nocapture</span></code></dt><dd><p>This indicates that the callee does not <a class="reference internal" href="#pointercapture"><span class="std std-ref">capture</span></a> the
pointer. This is not a valid attribute for return values.
This attribute applies only to the particular copy of the pointer passed in
this argument. A caller could pass two copies of the same pointer with one
being annotated nocapture and the other not, and the callee could validly
capture through the non annotated parameter.</p>
</dd>
</dl>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="k">void</span> <span class="vg">@f</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="k">nocapture</span> <span class="nv">%a</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%b</span><span class="p">)</span> <span class="p">{</span>
<span class="c">; (capture %b)</span>
<span class="p">}</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@f</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="vg">@glb</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@glb</span><span class="p">)</span> <span class="c">; well-defined</span>
</pre></div>
</div>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">nofree</span></code></dt><dd><p>This indicates that callee does not free the pointer argument. This is not
a valid attribute for return values.</p>
</dd>
</dl>
<dl id="nest">
<dt><code class="docutils literal notranslate"><span class="pre">nest</span></code></dt><dd><p>This indicates that the pointer parameter can be excised using the
<a class="reference internal" href="#int-trampoline"><span class="std std-ref">trampoline intrinsics</span></a>. This is not a valid
attribute for return values and can only be applied to one parameter.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">returned</span></code></dt><dd><p>This indicates that the function always returns the argument as its return
value. This is a hint to the optimizer and code generator used when
generating the caller, allowing value propagation, tail call optimization,
and omission of register saves and restores in some cases; it is not
checked or enforced when generating the callee. The parameter and the
function return type must be valid operands for the
<a class="reference internal" href="#i-bitcast"><span class="std std-ref">bitcast instruction</span></a>. This is not a valid attribute for
return values and can only be applied to one parameter.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">nonnull</span></code></dt><dd><p>This indicates that the parameter or return pointer is not null. This
attribute may only be applied to pointer typed parameters. This is not
checked or enforced by LLVM; if the parameter or return pointer is null,
<a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a> is returned or passed instead.
The <code class="docutils literal notranslate"><span class="pre">nonnull</span></code> attribute should be combined with the <code class="docutils literal notranslate"><span class="pre">noundef</span></code> attribute
to ensure a pointer is not null or otherwise the behavior is undefined.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">dereferenceable(<n>)</span></code></dt><dd><p>This indicates that the parameter or return pointer is dereferenceable. This
attribute may only be applied to pointer typed parameters. A pointer that
is dereferenceable can be loaded from speculatively without a risk of
trapping. The number of bytes known to be dereferenceable must be provided
in parentheses. It is legal for the number of bytes to be less than the
size of the pointee type. The <code class="docutils literal notranslate"><span class="pre">nonnull</span></code> attribute does not imply
dereferenceability (consider a pointer to one element past the end of an
array), however <code class="docutils literal notranslate"><span class="pre">dereferenceable(<n>)</span></code> does imply <code class="docutils literal notranslate"><span class="pre">nonnull</span></code> in
<code class="docutils literal notranslate"><span class="pre">addrspace(0)</span></code> (which is the default address space), except if the
<code class="docutils literal notranslate"><span class="pre">null_pointer_is_valid</span></code> function attribute is present.
<code class="docutils literal notranslate"><span class="pre">n</span></code> should be a positive number. The pointer should be well defined,
otherwise it is undefined behavior. This means <code class="docutils literal notranslate"><span class="pre">dereferenceable(<n>)</span></code>
implies <code class="docutils literal notranslate"><span class="pre">noundef</span></code>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">dereferenceable_or_null(<n>)</span></code></dt><dd><p>This indicates that the parameter or return value isn’t both
non-null and non-dereferenceable (up to <code class="docutils literal notranslate"><span class="pre"><n></span></code> bytes) at the same
time. All non-null pointers tagged with
<code class="docutils literal notranslate"><span class="pre">dereferenceable_or_null(<n>)</span></code> are <code class="docutils literal notranslate"><span class="pre">dereferenceable(<n>)</span></code>.
For address space 0 <code class="docutils literal notranslate"><span class="pre">dereferenceable_or_null(<n>)</span></code> implies that
a pointer is exactly one of <code class="docutils literal notranslate"><span class="pre">dereferenceable(<n>)</span></code> or <code class="docutils literal notranslate"><span class="pre">null</span></code>,
and in other address spaces <code class="docutils literal notranslate"><span class="pre">dereferenceable_or_null(<n>)</span></code>
implies that a pointer is at least one of <code class="docutils literal notranslate"><span class="pre">dereferenceable(<n>)</span></code>
or <code class="docutils literal notranslate"><span class="pre">null</span></code> (i.e. it may be both <code class="docutils literal notranslate"><span class="pre">null</span></code> and
<code class="docutils literal notranslate"><span class="pre">dereferenceable(<n>)</span></code>). This attribute may only be applied to
pointer typed parameters.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">swiftself</span></code></dt><dd><p>This indicates that the parameter is the self/context parameter. This is not
a valid attribute for return values and can only be applied to one
parameter.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">swiftasync</span></code></dt><dd><p>This indicates that the parameter is the asynchronous context parameter and
triggers the creation of a target-specific extended frame record to store
this pointer. This is not a valid attribute for return values and can only
be applied to one parameter.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">swifterror</span></code></dt><dd><p>This attribute is motivated to model and optimize Swift error handling. It
can be applied to a parameter with pointer to pointer type or a
pointer-sized alloca. At the call site, the actual argument that corresponds
to a <code class="docutils literal notranslate"><span class="pre">swifterror</span></code> parameter has to come from a <code class="docutils literal notranslate"><span class="pre">swifterror</span></code> alloca or
the <code class="docutils literal notranslate"><span class="pre">swifterror</span></code> parameter of the caller. A <code class="docutils literal notranslate"><span class="pre">swifterror</span></code> value (either
the parameter or the alloca) can only be loaded and stored from, or used as
a <code class="docutils literal notranslate"><span class="pre">swifterror</span></code> argument. This is not a valid attribute for return values
and can only be applied to one parameter.</p>
<p>These constraints allow the calling convention to optimize access to
<code class="docutils literal notranslate"><span class="pre">swifterror</span></code> variables by associating them with a specific register at
call boundaries rather than placing them in memory. Since this does change
the calling convention, a function which uses the <code class="docutils literal notranslate"><span class="pre">swifterror</span></code> attribute
on a parameter is not ABI-compatible with one which does not.</p>
<p>These constraints also allow LLVM to assume that a <code class="docutils literal notranslate"><span class="pre">swifterror</span></code> argument
does not alias any other memory visible within a function and that a
<code class="docutils literal notranslate"><span class="pre">swifterror</span></code> alloca passed as an argument does not escape.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">immarg</span></code></dt><dd><p>This indicates the parameter is required to be an immediate
value. This must be a trivial immediate integer or floating-point
constant. Undef or constant expressions are not valid. This is
only valid on intrinsic declarations and cannot be applied to a
call site or arbitrary function.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">noundef</span></code></dt><dd><p>This attribute applies to parameters and return values. If the value
representation contains any undefined or poison bits, the behavior is
undefined. Note that this does not refer to padding introduced by the
type’s storage representation.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">alignstack(<n>)</span></code></dt><dd><p>This indicates the alignment that should be considered by the backend when
assigning this parameter to a stack slot during calling convention
lowering. The enforcement of the specified alignment is target-dependent,
as target-specific calling convention rules may override this value. This
attribute serves the purpose of carrying language specific alignment
information that is not mapped to base types in the backend (for example,
over-alignment specification through language attributes).</p>
</dd>
</dl>
</div>
<div class="section" id="garbage-collector-strategy-names">
<span id="gc"></span><h3><a class="toc-backref" href="#id1430">Garbage Collector Strategy Names</a><a class="headerlink" href="#garbage-collector-strategy-names" title="Permalink to this headline">¶</a></h3>
<p>Each function may specify a garbage collector strategy name, which is simply a
string:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="k">void</span> <span class="vg">@f</span><span class="p">()</span> <span class="k">gc</span> <span class="s">"name"</span> <span class="p">{</span> <span class="p">...</span> <span class="p">}</span>
</pre></div>
</div>
<p>The supported values of <em>name</em> includes those <a class="reference internal" href="GarbageCollection.html#builtin-gc-strategies"><span class="std std-ref">built in to LLVM</span></a> and any provided by loaded plugins. Specifying a GC
strategy will cause the compiler to alter its output in order to support the
named garbage collection algorithm. Note that LLVM itself does not contain a
garbage collector, this functionality is restricted to generating machine code
which can interoperate with a collector provided externally.</p>
</div>
<div class="section" id="prefix-data">
<span id="prefixdata"></span><h3><a class="toc-backref" href="#id1431">Prefix Data</a><a class="headerlink" href="#prefix-data" title="Permalink to this headline">¶</a></h3>
<p>Prefix data is data associated with a function which the code
generator will emit immediately before the function’s entrypoint.
The purpose of this feature is to allow frontends to associate
language-specific runtime metadata with specific functions and make it
available through the function pointer while still allowing the
function pointer to be called.</p>
<p>To access the data for a given function, a program may bitcast the
function pointer to a pointer to the constant’s type and dereference
index -1. This implies that the IR symbol points just past the end of
the prefix data. For instance, take the example of a function annotated
with a single <code class="docutils literal notranslate"><span class="pre">i32</span></code>,</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="k">void</span> <span class="vg">@f</span><span class="p">()</span> <span class="k">prefix</span> <span class="k">i32</span> <span class="m">123</span> <span class="p">{</span> <span class="p">...</span> <span class="p">}</span>
</pre></div>
</div>
<p>The prefix data can be referenced as,</p>
<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">bitcast</span> <span class="k">void</span><span class="p">*</span> <span class="p">()</span> <span class="vg">@f</span> <span class="k">to</span> <span class="k">i32</span><span class="p">*</span>
<span class="nv">%a</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="k">inbounds</span> <span class="k">i32</span><span class="p">,</span> <span class="k">i32</span><span class="p">*</span> <span class="nv nv-Anonymous">%0</span><span class="p">,</span> <span class="k">i32</span> <span class="m">-1</span>
<span class="nv">%b</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">%a</span>
</pre></div>
</div>
<p>Prefix data is laid out as if it were an initializer for a global variable
of the prefix data’s type. The function will be placed such that the
beginning of the prefix data is aligned. This means that if the size
of the prefix data is not a multiple of the alignment size, the
function’s entrypoint will not be aligned. If alignment of the
function’s entrypoint is desired, padding must be added to the prefix
data.</p>
<p>A function may have prefix data but no body. This has similar semantics
to the <code class="docutils literal notranslate"><span class="pre">available_externally</span></code> linkage in that the data may be used by the
optimizers but will not be emitted in the object file.</p>
</div>
<div class="section" id="prologue-data">
<span id="prologuedata"></span><h3><a class="toc-backref" href="#id1432">Prologue Data</a><a class="headerlink" href="#prologue-data" title="Permalink to this headline">¶</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">prologue</span></code> attribute allows arbitrary code (encoded as bytes) to
be inserted prior to the function body. This can be used for enabling
function hot-patching and instrumentation.</p>
<p>To maintain the semantics of ordinary function calls, the prologue data must
have a particular format. Specifically, it must begin with a sequence of
bytes which decode to a sequence of machine instructions, valid for the
module’s target, which transfer control to the point immediately succeeding
the prologue data, without performing any other visible action. This allows
the inliner and other passes to reason about the semantics of the function
definition without needing to reason about the prologue data. Obviously this
makes the format of the prologue data highly target dependent.</p>
<p>A trivial example of valid prologue data for the x86 architecture is <code class="docutils literal notranslate"><span class="pre">i8</span> <span class="pre">144</span></code>,
which encodes the <code class="docutils literal notranslate"><span class="pre">nop</span></code> instruction:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>define void @f() prologue i8 144 { ... }
</pre></div>
</div>
<p>Generally prologue data can be formed by encoding a relative branch instruction
which skips the metadata, as in this example of valid prologue data for the
x86_64 architecture, where the first two bytes encode <code class="docutils literal notranslate"><span class="pre">jmp</span> <span class="pre">.+10</span></code>:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>%0 = type <{ i8, i8, i8* }>
define void @f() prologue %0 <{ i8 235, i8 8, i8* @md}> { ... }
</pre></div>
</div>
<p>A function may have prologue data but no body. This has similar semantics
to the <code class="docutils literal notranslate"><span class="pre">available_externally</span></code> linkage in that the data may be used by the
optimizers but will not be emitted in the object file.</p>
</div>
<div class="section" id="personality-function">
<span id="personalityfn"></span><h3><a class="toc-backref" href="#id1433">Personality Function</a><a class="headerlink" href="#personality-function" title="Permalink to this headline">¶</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">personality</span></code> attribute permits functions to specify what function
to use for exception handling.</p>
</div>
<div class="section" id="attribute-groups">
<span id="attrgrp"></span><h3><a class="toc-backref" href="#id1434">Attribute Groups</a><a class="headerlink" href="#attribute-groups" title="Permalink to this headline">¶</a></h3>
<p>Attribute groups are groups of attributes that are referenced by objects within
the IR. They are important for keeping <code class="docutils literal notranslate"><span class="pre">.ll</span></code> files readable, because a lot of
functions will use the same set of attributes. In the degenerative case of a
<code class="docutils literal notranslate"><span class="pre">.ll</span></code> file that corresponds to a single <code class="docutils literal notranslate"><span class="pre">.c</span></code> file, the single attribute
group will capture the important command line flags used to build that file.</p>
<p>An attribute group is a module-level object. To use an attribute group, an
object references the attribute group’s ID (e.g. <code class="docutils literal notranslate"><span class="pre">#37</span></code>). An object may refer
to more than one attribute group. In that situation, the attributes from the
different groups are merged.</p>
<p>Here is an example of attribute groups for a function that should always be
inlined, has a stack alignment of 4, and which shouldn’t use SSE instructions:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="c">; Target-independent attributes:</span>
<span class="k">attributes</span> <span class="vg">#0</span> <span class="p">=</span> <span class="p">{</span> <span class="k">alwaysinline</span> <span class="k">alignstack</span><span class="p">=</span><span class="m">4</span> <span class="p">}</span>
<span class="c">; Target-dependent attributes:</span>
<span class="k">attributes</span> <span class="vg">#1</span> <span class="p">=</span> <span class="p">{</span> <span class="s">"no-sse"</span> <span class="p">}</span>
<span class="c">; Function @f has attributes: alwaysinline, alignstack=4, and "no-sse".</span>
<span class="k">define</span> <span class="k">void</span> <span class="vg">@f</span><span class="p">()</span> <span class="vg">#0</span> <span class="vg">#1</span> <span class="p">{</span> <span class="p">...</span> <span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="function-attributes">
<span id="fnattrs"></span><h3><a class="toc-backref" href="#id1435">Function Attributes</a><a class="headerlink" href="#function-attributes" title="Permalink to this headline">¶</a></h3>
<p>Function attributes are set to communicate additional information about
a function. Function attributes are considered to be part of the
function, not of the function type, so functions with different function
attributes can have the same function type.</p>
<p>Function attributes are simple keywords that follow the type specified.
If multiple attributes are needed, they are space separated. For
example:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="k">void</span> <span class="vg">@f</span><span class="p">()</span> <span class="k">noinline</span> <span class="p">{</span> <span class="p">...</span> <span class="p">}</span>
<span class="k">define</span> <span class="k">void</span> <span class="vg">@f</span><span class="p">()</span> <span class="k">alwaysinline</span> <span class="p">{</span> <span class="p">...</span> <span class="p">}</span>
<span class="k">define</span> <span class="k">void</span> <span class="vg">@f</span><span class="p">()</span> <span class="k">alwaysinline</span> <span class="k">optsize</span> <span class="p">{</span> <span class="p">...</span> <span class="p">}</span>
<span class="k">define</span> <span class="k">void</span> <span class="vg">@f</span><span class="p">()</span> <span class="k">optsize</span> <span class="p">{</span> <span class="p">...</span> <span class="p">}</span>
</pre></div>
</div>
<dl>
<dt><code class="docutils literal notranslate"><span class="pre">alignstack(<n>)</span></code></dt><dd><p>This attribute indicates that, when emitting the prologue and
epilogue, the backend should forcibly align the stack pointer.
Specify the desired alignment, which must be a power of two, in
parentheses.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">allocsize(<EltSizeParam>[,</span> <span class="pre"><NumEltsParam>])</span></code></dt><dd><p>This attribute indicates that the annotated function will always return at
least a given number of bytes (or null). Its arguments are zero-indexed
parameter numbers; if one argument is provided, then it’s assumed that at
least <code class="docutils literal notranslate"><span class="pre">CallSite.Args[EltSizeParam]</span></code> bytes will be available at the
returned pointer. If two are provided, then it’s assumed that
<code class="docutils literal notranslate"><span class="pre">CallSite.Args[EltSizeParam]</span> <span class="pre">*</span> <span class="pre">CallSite.Args[NumEltsParam]</span></code> bytes are
available. The referenced parameters must be integer types. No assumptions
are made about the contents of the returned block of memory.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">alwaysinline</span></code></dt><dd><p>This attribute indicates that the inliner should attempt to inline
this function into callers whenever possible, ignoring any active
inlining size threshold for this caller.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">builtin</span></code></dt><dd><p>This indicates that the callee function at a call site should be
recognized as a built-in function, even though the function’s declaration
uses the <code class="docutils literal notranslate"><span class="pre">nobuiltin</span></code> attribute. This is only valid at call sites for
direct calls to functions that are declared with the <code class="docutils literal notranslate"><span class="pre">nobuiltin</span></code>
attribute.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">cold</span></code></dt><dd><p>This attribute indicates that this function is rarely called. When
computing edge weights, basic blocks post-dominated by a cold
function call are also considered to be cold; and, thus, given low
weight.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">convergent</span></code></dt><dd><p>In some parallel execution models, there exist operations that cannot be
made control-dependent on any additional values. We call such operations
<code class="docutils literal notranslate"><span class="pre">convergent</span></code>, and mark them with this attribute.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">convergent</span></code> attribute may appear on functions or call/invoke
instructions. When it appears on a function, it indicates that calls to
this function should not be made control-dependent on additional values.
For example, the intrinsic <code class="docutils literal notranslate"><span class="pre">llvm.nvvm.barrier0</span></code> is <code class="docutils literal notranslate"><span class="pre">convergent</span></code>, so
calls to this intrinsic cannot be made control-dependent on additional
values.</p>
<p>When it appears on a call/invoke, the <code class="docutils literal notranslate"><span class="pre">convergent</span></code> attribute indicates
that we should treat the call as though we’re calling a convergent
function. This is particularly useful on indirect calls; without this we
may treat such calls as though the target is non-convergent.</p>
<p>The optimizer may remove the <code class="docutils literal notranslate"><span class="pre">convergent</span></code> attribute on functions when it
can prove that the function does not execute any convergent operations.
Similarly, the optimizer may remove <code class="docutils literal notranslate"><span class="pre">convergent</span></code> on calls/invokes when it
can prove that the call/invoke cannot call a convergent function.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">disable_sanitizer_instrumentation</span></code></dt><dd><p>When instrumenting code with sanitizers, it can be important to skip certain
functions to ensure no instrumentation is applied to them.</p>
<p>This attribute is not always similar to absent <code class="docutils literal notranslate"><span class="pre">sanitize_<name></span></code>
attributes: depending on the specific sanitizer, code can be inserted into
functions regardless of the <code class="docutils literal notranslate"><span class="pre">sanitize_<name></span></code> attribute to prevent false
positive reports.</p>
<p><code class="docutils literal notranslate"><span class="pre">disable_sanitizer_instrumentation</span></code> disables all kinds of instrumentation,
taking precedence over the <code class="docutils literal notranslate"><span class="pre">sanitize_<name></span></code> attributes and other compiler
flags.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">"dontcall"</span></code></dt><dd><p>This attribute denotes that a diagnostic should be emitted when a call of a
function with this attribute is not eliminated via optimization. Front ends
can provide optional <code class="docutils literal notranslate"><span class="pre">srcloc</span></code> metadata nodes on call sites of such
callees to attach information about where in the source language such a
call came from.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">"frame-pointer"</span></code></dt><dd><p>This attribute tells the code generator whether the function
should keep the frame pointer. The code generator may emit the frame pointer
even if this attribute says the frame pointer can be eliminated.
The allowed string values are:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">"none"</span></code> (default) - the frame pointer can be eliminated.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">"non-leaf"</span></code> - the frame pointer should be kept if the function calls
other functions.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">"all"</span></code> - the frame pointer should be kept.</p></li>
</ul>
</div></blockquote>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">hot</span></code></dt><dd><p>This attribute indicates that this function is a hot spot of the program
execution. The function will be optimized more aggressively and will be
placed into special subsection of the text section to improving locality.</p>
<p>When profile feedback is enabled, this attribute has the precedence over
the profile information. By marking a function <code class="docutils literal notranslate"><span class="pre">hot</span></code>, users can work
around the cases where the training input does not have good coverage
on all the hot functions.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">inaccessiblememonly</span></code></dt><dd><p>This attribute indicates that the function may only access memory that
is not accessible by the module being compiled. This is a weaker form
of <code class="docutils literal notranslate"><span class="pre">readnone</span></code>. If the function reads or writes other memory, the
behavior is undefined.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">inaccessiblemem_or_argmemonly</span></code></dt><dd><p>This attribute indicates that the function may only access memory that is
either not accessible by the module being compiled, or is pointed to
by its pointer arguments. This is a weaker form of <code class="docutils literal notranslate"><span class="pre">argmemonly</span></code>. If the
function reads or writes other memory, the behavior is undefined.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">inlinehint</span></code></dt><dd><p>This attribute indicates that the source code contained a hint that
inlining this function is desirable (such as the “inline” keyword in
C/C++). It is just a hint; it imposes no requirements on the
inliner.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">jumptable</span></code></dt><dd><p>This attribute indicates that the function should be added to a
jump-instruction table at code-generation time, and that all address-taken
references to this function should be replaced with a reference to the
appropriate jump-instruction-table function pointer. Note that this creates
a new pointer for the original function, which means that code that depends
on function-pointer identity can break. So, any function annotated with
<code class="docutils literal notranslate"><span class="pre">jumptable</span></code> must also be <code class="docutils literal notranslate"><span class="pre">unnamed_addr</span></code>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">minsize</span></code></dt><dd><p>This attribute suggests that optimization passes and code generator
passes make choices that keep the code size of this function as small
as possible and perform optimizations that may sacrifice runtime
performance in order to minimize the size of the generated code.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">naked</span></code></dt><dd><p>This attribute disables prologue / epilogue emission for the
function. This can have very system-specific consequences.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">"no-inline-line-tables"</span></code></dt><dd><p>When this attribute is set to true, the inliner discards source locations
when inlining code and instead uses the source location of the call site.
Breakpoints set on code that was inlined into the current function will
not fire during the execution of the inlined call sites. If the debugger
stops inside an inlined call site, it will appear to be stopped at the
outermost inlined call site.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">no-jump-tables</span></code></dt><dd><p>When this attribute is set to true, the jump tables and lookup tables that
can be generated from a switch case lowering are disabled.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">nobuiltin</span></code></dt><dd><p>This indicates that the callee function at a call site is not recognized as
a built-in function. LLVM will retain the original call and not replace it
with equivalent code based on the semantics of the built-in function, unless
the call site uses the <code class="docutils literal notranslate"><span class="pre">builtin</span></code> attribute. This is valid at call sites
and on function declarations and definitions.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">noduplicate</span></code></dt><dd><p>This attribute indicates that calls to the function cannot be
duplicated. A call to a <code class="docutils literal notranslate"><span class="pre">noduplicate</span></code> function may be moved
within its parent function, but may not be duplicated within
its parent function.</p>
<p>A function containing a <code class="docutils literal notranslate"><span class="pre">noduplicate</span></code> call may still
be an inlining candidate, provided that the call is not
duplicated by inlining. That implies that the function has
internal linkage and only has one call site, so the original
call is dead after inlining.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">nofree</span></code></dt><dd><p>This function attribute indicates that the function does not, directly or
transitively, call a memory-deallocation function (<code class="docutils literal notranslate"><span class="pre">free</span></code>, for example)
on a memory allocation which existed before the call.</p>
<p>As a result, uncaptured pointers that are known to be dereferenceable
prior to a call to a function with the <code class="docutils literal notranslate"><span class="pre">nofree</span></code> attribute are still
known to be dereferenceable after the call. The capturing condition is
necessary in environments where the function might communicate the
pointer to another thread which then deallocates the memory. Alternatively,
<code class="docutils literal notranslate"><span class="pre">nosync</span></code> would ensure such communication cannot happen and even captured
pointers cannot be freed by the function.</p>
<p>A <code class="docutils literal notranslate"><span class="pre">nofree</span></code> function is explicitly allowed to free memory which it
allocated or (if not <code class="docutils literal notranslate"><span class="pre">nosync</span></code>) arrange for another thread to free
memory on it’s behalf. As a result, perhaps surprisingly, a <code class="docutils literal notranslate"><span class="pre">nofree</span></code>
function can return a pointer to a previously deallocated memory object.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">noimplicitfloat</span></code></dt><dd><p>Disallows implicit floating-point code. This inhibits optimizations that
use floating-point code and floating-point/SIMD/vector registers for
operations that are not nominally floating-point. LLVM instructions that
perform floating-point operations or require access to floating-point
registers may still cause floating-point code to be generated.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">noinline</span></code></dt><dd><p>This attribute indicates that the inliner should never inline this
function in any situation. This attribute may not be used together
with the <code class="docutils literal notranslate"><span class="pre">alwaysinline</span></code> attribute.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">nomerge</span></code></dt><dd><p>This attribute indicates that calls to this function should never be merged
during optimization. For example, it will prevent tail merging otherwise
identical code sequences that raise an exception or terminate the program.
Tail merging normally reduces the precision of source location information,
making stack traces less useful for debugging. This attribute gives the
user control over the tradeoff between code size and debug information
precision.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">nonlazybind</span></code></dt><dd><p>This attribute suppresses lazy symbol binding for the function. This
may make calls to the function faster, at the cost of extra program
startup time if the function is not called during program startup.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">noprofile</span></code></dt><dd><p>This function attribute prevents instrumentation based profiling, used for
coverage or profile based optimization, from being added to a function,
even when inlined.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">noredzone</span></code></dt><dd><p>This attribute indicates that the code generator should not use a
red zone, even if the target-specific ABI normally permits it.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">indirect-tls-seg-refs</span></code></dt><dd><p>This attribute indicates that the code generator should not use
direct TLS access through segment registers, even if the
target-specific ABI normally permits it.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">noreturn</span></code></dt><dd><p>This function attribute indicates that the function never returns
normally, hence through a return instruction. This produces undefined
behavior at runtime if the function ever does dynamically return. Annotated
functions may still raise an exception, i.a., <code class="docutils literal notranslate"><span class="pre">nounwind</span></code> is not implied.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">norecurse</span></code></dt><dd><p>This function attribute indicates that the function does not call itself
either directly or indirectly down any possible call path. This produces
undefined behavior at runtime if the function ever does recurse.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">willreturn</span></code></dt><dd><p>This function attribute indicates that a call of this function will
either exhibit undefined behavior or comes back and continues execution
at a point in the existing call stack that includes the current invocation.
Annotated functions may still raise an exception, i.a., <code class="docutils literal notranslate"><span class="pre">nounwind</span></code> is not implied.
If an invocation of an annotated function does not return control back
to a point in the call stack, the behavior is undefined.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">nosync</span></code></dt><dd><p>This function attribute indicates that the function does not communicate
(synchronize) with another thread through memory or other well-defined means.
Synchronization is considered possible in the presence of <cite>atomic</cite> accesses
that enforce an order, thus not “unordered” and “monotonic”, <cite>volatile</cite> accesses,
as well as <cite>convergent</cite> function calls. Note that through <cite>convergent</cite> function calls
non-memory communication, e.g., cross-lane operations, are possible and are also
considered synchronization. However <cite>convergent</cite> does not contradict <cite>nosync</cite>.
If an annotated function does ever synchronize with another thread,
the behavior is undefined.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">nounwind</span></code></dt><dd><p>This function attribute indicates that the function never raises an
exception. If the function does raise an exception, its runtime
behavior is undefined. However, functions marked nounwind may still
trap or generate asynchronous exceptions. Exception handling schemes
that are recognized by LLVM to handle asynchronous exceptions, such
as SEH, will still provide their implementation defined semantics.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">nosanitize_coverage</span></code></dt><dd><p>This attribute indicates that SanitizerCoverage instrumentation is disabled
for this function.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">null_pointer_is_valid</span></code></dt><dd><p>If <code class="docutils literal notranslate"><span class="pre">null_pointer_is_valid</span></code> is set, then the <code class="docutils literal notranslate"><span class="pre">null</span></code> address
in address-space 0 is considered to be a valid address for memory loads and
stores. Any analysis or optimization should not treat dereferencing a
pointer to <code class="docutils literal notranslate"><span class="pre">null</span></code> as undefined behavior in this function.
Note: Comparing address of a global variable to <code class="docutils literal notranslate"><span class="pre">null</span></code> may still
evaluate to false because of a limitation in querying this attribute inside
constant expressions.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">optforfuzzing</span></code></dt><dd><p>This attribute indicates that this function should be optimized
for maximum fuzzing signal.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">optnone</span></code></dt><dd><p>This function attribute indicates that most optimization passes will skip
this function, with the exception of interprocedural optimization passes.
Code generation defaults to the “fast” instruction selector.
This attribute cannot be used together with the <code class="docutils literal notranslate"><span class="pre">alwaysinline</span></code>
attribute; this attribute is also incompatible
with the <code class="docutils literal notranslate"><span class="pre">minsize</span></code> attribute and the <code class="docutils literal notranslate"><span class="pre">optsize</span></code> attribute.</p>
<p>This attribute requires the <code class="docutils literal notranslate"><span class="pre">noinline</span></code> attribute to be specified on
the function as well, so the function is never inlined into any caller.
Only functions with the <code class="docutils literal notranslate"><span class="pre">alwaysinline</span></code> attribute are valid
candidates for inlining into the body of this function.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">optsize</span></code></dt><dd><p>This attribute suggests that optimization passes and code generator
passes make choices that keep the code size of this function low,
and otherwise do optimizations specifically to reduce code size as
long as they do not significantly impact runtime performance.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">"patchable-function"</span></code></dt><dd><p>This attribute tells the code generator that the code
generated for this function needs to follow certain conventions that
make it possible for a runtime function to patch over it later.
The exact effect of this attribute depends on its string value,
for which there currently is one legal possibility:</p>
<blockquote>
<div><ul>
<li><p><code class="docutils literal notranslate"><span class="pre">"prologue-short-redirect"</span></code> - This style of patchable
function is intended to support patching a function prologue to
redirect control away from the function in a thread safe
manner. It guarantees that the first instruction of the
function will be large enough to accommodate a short jump
instruction, and will be sufficiently aligned to allow being
fully changed via an atomic compare-and-swap instruction.
While the first requirement can be satisfied by inserting large
enough NOP, LLVM can and will try to re-purpose an existing
instruction (i.e. one that would have to be emitted anyway) as
the patchable instruction larger than a short jump.</p>
<p><code class="docutils literal notranslate"><span class="pre">"prologue-short-redirect"</span></code> is currently only supported on
x86-64.</p>
</li>
</ul>
</div></blockquote>
<p>This attribute by itself does not imply restrictions on
inter-procedural optimizations. All of the semantic effects the
patching may have to be separately conveyed via the linkage type.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">"probe-stack"</span></code></dt><dd><p>This attribute indicates that the function will trigger a guard region
in the end of the stack. It ensures that accesses to the stack must be
no further apart than the size of the guard region to a previous
access of the stack. It takes one required string value, the name of
the stack probing function that will be called.</p>
<p>If a function that has a <code class="docutils literal notranslate"><span class="pre">"probe-stack"</span></code> attribute is inlined into
a function with another <code class="docutils literal notranslate"><span class="pre">"probe-stack"</span></code> attribute, the resulting
function has the <code class="docutils literal notranslate"><span class="pre">"probe-stack"</span></code> attribute of the caller. If a
function that has a <code class="docutils literal notranslate"><span class="pre">"probe-stack"</span></code> attribute is inlined into a
function that has no <code class="docutils literal notranslate"><span class="pre">"probe-stack"</span></code> attribute at all, the resulting
function has the <code class="docutils literal notranslate"><span class="pre">"probe-stack"</span></code> attribute of the callee.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">readnone</span></code></dt><dd><p>On a function, this attribute indicates that the function computes its
result (or decides to unwind an exception) based strictly on its arguments,
without dereferencing any pointer arguments or otherwise accessing
any mutable state (e.g. memory, control registers, etc) visible to
caller functions. It does not write through any pointer arguments
(including <code class="docutils literal notranslate"><span class="pre">byval</span></code> arguments) and never changes any state visible
to callers. This means while it cannot unwind exceptions by calling
the <code class="docutils literal notranslate"><span class="pre">C++</span></code> exception throwing methods (since they write to memory), there may
be non-<code class="docutils literal notranslate"><span class="pre">C++</span></code> mechanisms that throw exceptions without writing to LLVM
visible memory.</p>
<p>On an argument, this attribute indicates that the function does not
dereference that pointer argument, even though it may read or write the
memory that the pointer points to if accessed through other pointers.</p>
<p>If a readnone function reads or writes memory visible to the program, or
has other side-effects, the behavior is undefined. If a function reads from
or writes to a readnone pointer argument, the behavior is undefined.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">readonly</span></code></dt><dd><p>On a function, this attribute indicates that the function does not write
through any pointer arguments (including <code class="docutils literal notranslate"><span class="pre">byval</span></code> arguments) or otherwise
modify any state (e.g. memory, control registers, etc) visible to
caller functions. It may dereference pointer arguments and read
state that may be set in the caller. A readonly function always
returns the same value (or unwinds an exception identically) when
called with the same set of arguments and global state. This means while it
cannot unwind exceptions by calling the <code class="docutils literal notranslate"><span class="pre">C++</span></code> exception throwing methods
(since they write to memory), there may be non-<code class="docutils literal notranslate"><span class="pre">C++</span></code> mechanisms that throw
exceptions without writing to LLVM visible memory.</p>
<p>On an argument, this attribute indicates that the function does not write
through this pointer argument, even though it may write to the memory that
the pointer points to.</p>
<p>If a readonly function writes memory visible to the program, or
has other side-effects, the behavior is undefined. If a function writes to
a readonly pointer argument, the behavior is undefined.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">"stack-probe-size"</span></code></dt><dd><p>This attribute controls the behavior of stack probes: either
the <code class="docutils literal notranslate"><span class="pre">"probe-stack"</span></code> attribute, or ABI-required stack probes, if any.
It defines the size of the guard region. It ensures that if the function
may use more stack space than the size of the guard region, stack probing
sequence will be emitted. It takes one required integer value, which
is 4096 by default.</p>
<p>If a function that has a <code class="docutils literal notranslate"><span class="pre">"stack-probe-size"</span></code> attribute is inlined into
a function with another <code class="docutils literal notranslate"><span class="pre">"stack-probe-size"</span></code> attribute, the resulting
function has the <code class="docutils literal notranslate"><span class="pre">"stack-probe-size"</span></code> attribute that has the lower
numeric value. If a function that has a <code class="docutils literal notranslate"><span class="pre">"stack-probe-size"</span></code> attribute is
inlined into a function that has no <code class="docutils literal notranslate"><span class="pre">"stack-probe-size"</span></code> attribute
at all, the resulting function has the <code class="docutils literal notranslate"><span class="pre">"stack-probe-size"</span></code> attribute
of the callee.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">"no-stack-arg-probe"</span></code></dt><dd><p>This attribute disables ABI-required stack probes, if any.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">writeonly</span></code></dt><dd><p>On a function, this attribute indicates that the function may write to but
does not read from memory.</p>
<p>On an argument, this attribute indicates that the function may write to but
does not read through this pointer argument (even though it may read from
the memory that the pointer points to).</p>
<p>If a writeonly function reads memory visible to the program, or
has other side-effects, the behavior is undefined. If a function reads
from a writeonly pointer argument, the behavior is undefined.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">argmemonly</span></code></dt><dd><p>This attribute indicates that the only memory accesses inside function are
loads and stores from objects pointed to by its pointer-typed arguments,
with arbitrary offsets. Or in other words, all memory operations in the
function can refer to memory only using pointers based on its function
arguments.</p>
<p>Note that <code class="docutils literal notranslate"><span class="pre">argmemonly</span></code> can be used together with <code class="docutils literal notranslate"><span class="pre">readonly</span></code> attribute
in order to specify that function reads only from its arguments.</p>
<p>If an argmemonly function reads or writes memory other than the pointer
arguments, or has other side-effects, the behavior is undefined.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">returns_twice</span></code></dt><dd><p>This attribute indicates that this function can return twice. The C
<code class="docutils literal notranslate"><span class="pre">setjmp</span></code> is an example of such a function. The compiler disables
some optimizations (like tail calls) in the caller of these
functions.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">safestack</span></code></dt><dd><p>This attribute indicates that
<a class="reference external" href="https://clang.llvm.org/docs/SafeStack.html">SafeStack</a>
protection is enabled for this function.</p>
<p>If a function that has a <code class="docutils literal notranslate"><span class="pre">safestack</span></code> attribute is inlined into a
function that doesn’t have a <code class="docutils literal notranslate"><span class="pre">safestack</span></code> attribute or which has an
<code class="docutils literal notranslate"><span class="pre">ssp</span></code>, <code class="docutils literal notranslate"><span class="pre">sspstrong</span></code> or <code class="docutils literal notranslate"><span class="pre">sspreq</span></code> attribute, then the resulting
function will have a <code class="docutils literal notranslate"><span class="pre">safestack</span></code> attribute.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">sanitize_address</span></code></dt><dd><p>This attribute indicates that AddressSanitizer checks
(dynamic address safety analysis) are enabled for this function.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">sanitize_memory</span></code></dt><dd><p>This attribute indicates that MemorySanitizer checks (dynamic detection
of accesses to uninitialized memory) are enabled for this function.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">sanitize_thread</span></code></dt><dd><p>This attribute indicates that ThreadSanitizer checks
(dynamic thread safety analysis) are enabled for this function.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">sanitize_hwaddress</span></code></dt><dd><p>This attribute indicates that HWAddressSanitizer checks
(dynamic address safety analysis based on tagged pointers) are enabled for
this function.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">sanitize_memtag</span></code></dt><dd><p>This attribute indicates that MemTagSanitizer checks
(dynamic address safety analysis based on Armv8 MTE) are enabled for
this function.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">speculative_load_hardening</span></code></dt><dd><p>This attribute indicates that
<a class="reference external" href="https://llvm.org/docs/SpeculativeLoadHardening.html">Speculative Load Hardening</a>
should be enabled for the function body.</p>
<p>Speculative Load Hardening is a best-effort mitigation against
information leak attacks that make use of control flow
miss-speculation - specifically miss-speculation of whether a branch
is taken or not. Typically vulnerabilities enabling such attacks are
classified as “Spectre variant #1”. Notably, this does not attempt to
mitigate against miss-speculation of branch target, classified as
“Spectre variant #2” vulnerabilities.</p>
<p>When inlining, the attribute is sticky. Inlining a function that carries
this attribute will cause the caller to gain the attribute. This is intended
to provide a maximally conservative model where the code in a function
annotated with this attribute will always (even after inlining) end up
hardened.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">speculatable</span></code></dt><dd><p>This function attribute indicates that the function does not have any
effects besides calculating its result and does not have undefined behavior.
Note that <code class="docutils literal notranslate"><span class="pre">speculatable</span></code> is not enough to conclude that along any
particular execution path the number of calls to this function will not be
externally observable. This attribute is only valid on functions
and declarations, not on individual call sites. If a function is
incorrectly marked as speculatable and really does exhibit
undefined behavior, the undefined behavior may be observed even
if the call site is dead code.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">ssp</span></code></dt><dd><p>This attribute indicates that the function should emit a stack
smashing protector. It is in the form of a “canary” — a random value
placed on the stack before the local variables that’s checked upon
return from the function to see if it has been overwritten. A
heuristic is used to determine if a function needs stack protectors
or not. The heuristic used will enable protectors for functions with:</p>
<ul class="simple">
<li><p>Character arrays larger than <code class="docutils literal notranslate"><span class="pre">ssp-buffer-size</span></code> (default 8).</p></li>
<li><p>Aggregates containing character arrays larger than <code class="docutils literal notranslate"><span class="pre">ssp-buffer-size</span></code>.</p></li>
<li><p>Calls to alloca() with variable sizes or constant sizes greater than
<code class="docutils literal notranslate"><span class="pre">ssp-buffer-size</span></code>.</p></li>
</ul>
<p>Variables that are identified as requiring a protector will be arranged
on the stack such that they are adjacent to the stack protector guard.</p>
<p>A function with the <code class="docutils literal notranslate"><span class="pre">ssp</span></code> attribute but without the <code class="docutils literal notranslate"><span class="pre">alwaysinline</span></code>
attribute cannot be inlined into a function without a
<code class="docutils literal notranslate"><span class="pre">ssp/sspreq/sspstrong</span></code> attribute. If inlined, the caller will get the
<code class="docutils literal notranslate"><span class="pre">ssp</span></code> attribute. <code class="docutils literal notranslate"><span class="pre">call</span></code>, <code class="docutils literal notranslate"><span class="pre">invoke</span></code>, and <code class="docutils literal notranslate"><span class="pre">callbr</span></code> instructions with
the <code class="docutils literal notranslate"><span class="pre">alwaysinline</span></code> attribute force inlining.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">sspstrong</span></code></dt><dd><p>This attribute indicates that the function should emit a stack smashing
protector. This attribute causes a strong heuristic to be used when
determining if a function needs stack protectors. The strong heuristic
will enable protectors for functions with:</p>
<ul class="simple">
<li><p>Arrays of any size and type</p></li>
<li><p>Aggregates containing an array of any size and type.</p></li>
<li><p>Calls to alloca().</p></li>
<li><p>Local variables that have had their address taken.</p></li>
</ul>
<p>Variables that are identified as requiring a protector will be arranged
on the stack such that they are adjacent to the stack protector guard.
The specific layout rules are:</p>
<ol class="arabic simple">
<li><p>Large arrays and structures containing large arrays
(<code class="docutils literal notranslate"><span class="pre">>=</span> <span class="pre">ssp-buffer-size</span></code>) are closest to the stack protector.</p></li>
<li><p>Small arrays and structures containing small arrays
(<code class="docutils literal notranslate"><span class="pre"><</span> <span class="pre">ssp-buffer-size</span></code>) are 2nd closest to the protector.</p></li>
<li><p>Variables that have had their address taken are 3rd closest to the
protector.</p></li>
</ol>
<p>This overrides the <code class="docutils literal notranslate"><span class="pre">ssp</span></code> function attribute.</p>
<p>A function with the <code class="docutils literal notranslate"><span class="pre">sspstrong</span></code> attribute but without the
<code class="docutils literal notranslate"><span class="pre">alwaysinline</span></code> attribute cannot be inlined into a function without a
<code class="docutils literal notranslate"><span class="pre">ssp/sspstrong/sspreq</span></code> attribute. If inlined, the caller will get the
<code class="docutils literal notranslate"><span class="pre">sspstrong</span></code> attribute unless the <code class="docutils literal notranslate"><span class="pre">sspreq</span></code> attribute exists. <code class="docutils literal notranslate"><span class="pre">call</span></code>,
<code class="docutils literal notranslate"><span class="pre">invoke</span></code>, and <code class="docutils literal notranslate"><span class="pre">callbr</span></code> instructions with the <code class="docutils literal notranslate"><span class="pre">alwaysinline</span></code> attribute
force inlining.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">sspreq</span></code></dt><dd><p>This attribute indicates that the function should <em>always</em> emit a stack
smashing protector. This overrides the <code class="docutils literal notranslate"><span class="pre">ssp</span></code> and <code class="docutils literal notranslate"><span class="pre">sspstrong</span></code> function
attributes.</p>
<p>Variables that are identified as requiring a protector will be arranged
on the stack such that they are adjacent to the stack protector guard.
The specific layout rules are:</p>
<ol class="arabic simple">
<li><p>Large arrays and structures containing large arrays
(<code class="docutils literal notranslate"><span class="pre">>=</span> <span class="pre">ssp-buffer-size</span></code>) are closest to the stack protector.</p></li>
<li><p>Small arrays and structures containing small arrays
(<code class="docutils literal notranslate"><span class="pre"><</span> <span class="pre">ssp-buffer-size</span></code>) are 2nd closest to the protector.</p></li>
<li><p>Variables that have had their address taken are 3rd closest to the
protector.</p></li>
</ol>
<p>A function with the <code class="docutils literal notranslate"><span class="pre">sspreq</span></code> attribute but without the <code class="docutils literal notranslate"><span class="pre">alwaysinline</span></code>
attribute cannot be inlined into a function without a
<code class="docutils literal notranslate"><span class="pre">ssp/sspstrong/sspreq</span></code> attribute. If inlined, the caller will get the
<code class="docutils literal notranslate"><span class="pre">sspreq</span></code> attribute. <code class="docutils literal notranslate"><span class="pre">call</span></code>, <code class="docutils literal notranslate"><span class="pre">invoke</span></code>, and <code class="docutils literal notranslate"><span class="pre">callbr</span></code> instructions
with the <code class="docutils literal notranslate"><span class="pre">alwaysinline</span></code> attribute force inlining.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">strictfp</span></code></dt><dd><p>This attribute indicates that the function was called from a scope that
requires strict floating-point semantics. LLVM will not attempt any
optimizations that require assumptions about the floating-point rounding
mode or that might alter the state of floating-point status flags that
might otherwise be set or cleared by calling this function. LLVM will
not introduce any new floating-point instructions that may trap.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">"denormal-fp-math"</span></code></dt><dd><blockquote>
<div><p>This indicates the denormal (subnormal) handling that may be
assumed for the default floating-point environment. This is a
comma separated pair. The elements may be one of <code class="docutils literal notranslate"><span class="pre">"ieee"</span></code>,
<code class="docutils literal notranslate"><span class="pre">"preserve-sign"</span></code>, or <code class="docutils literal notranslate"><span class="pre">"positive-zero"</span></code>. The first entry
indicates the flushing mode for the result of floating point
operations. The second indicates the handling of denormal inputs
to floating point instructions. For compatibility with older
bitcode, if the second value is omitted, both input and output
modes will assume the same mode.</p>
<p>If this is attribute is not specified, the default is
<code class="docutils literal notranslate"><span class="pre">"ieee,ieee"</span></code>.</p>
<p>If the output mode is <code class="docutils literal notranslate"><span class="pre">"preserve-sign"</span></code>, or <code class="docutils literal notranslate"><span class="pre">"positive-zero"</span></code>,
denormal outputs may be flushed to zero by standard floating-point
operations. It is not mandated that flushing to zero occurs, but if
a denormal output is flushed to zero, it must respect the sign
mode. Not all targets support all modes. While this indicates the
expected floating point mode the function will be executed with,
this does not make any attempt to ensure the mode is
consistent. User or platform code is expected to set the floating
point mode appropriately before function entry.</p>
</div></blockquote>
<p>If the input mode is <code class="docutils literal notranslate"><span class="pre">"preserve-sign"</span></code>, or <code class="docutils literal notranslate"><span class="pre">"positive-zero"</span></code>, a
floating-point operation must treat any input denormal value as
zero. In some situations, if an instruction does not respect this
mode, the input may need to be converted to 0 as if by
<code class="docutils literal notranslate"><span class="pre">@llvm.canonicalize</span></code> during lowering for correctness.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">"denormal-fp-math-f32"</span></code></dt><dd><p>Same as <code class="docutils literal notranslate"><span class="pre">"denormal-fp-math"</span></code>, but only controls the behavior of
the 32-bit float type (or vectors of 32-bit floats). If both are
are present, this overrides <code class="docutils literal notranslate"><span class="pre">"denormal-fp-math"</span></code>. Not all targets
support separately setting the denormal mode per type, and no
attempt is made to diagnose unsupported uses. Currently this
attribute is respected by the AMDGPU and NVPTX backends.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">"thunk"</span></code></dt><dd><p>This attribute indicates that the function will delegate to some other
function with a tail call. The prototype of a thunk should not be used for
optimization purposes. The caller is expected to cast the thunk prototype to
match the thunk target prototype.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">uwtable</span></code></dt><dd><p>This attribute indicates that the ABI being targeted requires that
an unwind table entry be produced for this function even if we can
show that no exceptions passes by it. This is normally the case for
the ELF x86-64 abi, but it can be disabled for some compilation
units.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">nocf_check</span></code></dt><dd><p>This attribute indicates that no control-flow check will be performed on
the attributed entity. It disables -fcf-protection=<> for a specific
entity to fine grain the HW control flow protection mechanism. The flag
is target independent and currently appertains to a function or function
pointer.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">shadowcallstack</span></code></dt><dd><p>This attribute indicates that the ShadowCallStack checks are enabled for
the function. The instrumentation checks that the return address for the
function has not changed between the function prolog and epilog. It is
currently x86_64-specific.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">mustprogress</span></code></dt><dd><p>This attribute indicates that the function is required to return, unwind,
or interact with the environment in an observable way e.g. via a volatile
memory access, I/O, or other synchronization. The <code class="docutils literal notranslate"><span class="pre">mustprogress</span></code>
attribute is intended to model the requirements of the first section of
[intro.progress] of the C++ Standard. As a consequence, a loop in a
function with the <cite>mustprogress</cite> attribute can be assumed to terminate if
it does not interact with the environment in an observable way, and
terminating loops without side-effects can be removed. If a <cite>mustprogress</cite>
function does not satisfy this contract, the behavior is undefined. This
attribute does not apply transitively to callees, but does apply to call
sites within the function. Note that <cite>willreturn</cite> implies <cite>mustprogress</cite>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">"warn-stack-size"="<threshold>"</span></code></dt><dd><p>This attribute sets a threshold to emit diagnostics once the frame size is
known should the frame size exceed the specified value. It takes one
required integer value, which should be a non-negative integer, and less
than <cite>UINT_MAX</cite>. It’s unspecified which threshold will be used when
duplicate definitions are linked together with differing values.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">vscale_range(<min>[,</span> <span class="pre"><max>])</span></code></dt><dd><p>This attribute indicates the minimum and maximum vscale value for the given
function. A value of 0 means unbounded. If the optional max value is omitted
then max is set to the value of min. If the attribute is not present, no
assumptions are made about the range of vscale.</p>
</dd>
</dl>
</div>
<div class="section" id="call-site-attributes">
<h3><a class="toc-backref" href="#id1436">Call Site Attributes</a><a class="headerlink" href="#call-site-attributes" title="Permalink to this headline">¶</a></h3>
<p>In addition to function attributes the following call site only
attributes are supported:</p>
<dl>
<dt><code class="docutils literal notranslate"><span class="pre">vector-function-abi-variant</span></code></dt><dd><p>This attribute can be attached to a <a class="reference internal" href="#i-call"><span class="std std-ref">call</span></a> to list
the vector functions associated to the function. Notice that the
attribute cannot be attached to a <a class="reference internal" href="#i-invoke"><span class="std std-ref">invoke</span></a> or a
<a class="reference internal" href="#i-callbr"><span class="std std-ref">callbr</span></a> instruction. The attribute consists of a
comma separated list of mangled names. The order of the list does
not imply preference (it is logically a set). The compiler is free
to pick any listed vector function of its choosing.</p>
<p>The syntax for the mangled names is as follows::</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">_ZGV</span><span class="o"><</span><span class="n">isa</span><span class="o">><</span><span class="n">mask</span><span class="o">><</span><span class="n">vlen</span><span class="o">><</span><span class="n">parameters</span><span class="o">></span><span class="n">_</span><span class="o"><</span><span class="n">scalar_name</span><span class="o">></span><span class="p">[(</span><span class="o"><</span><span class="n">vector_redirection</span><span class="o">></span><span class="p">)]</span>
</pre></div>
</div>
<p>When present, the attribute informs the compiler that the function
<code class="docutils literal notranslate"><span class="pre"><scalar_name></span></code> has a corresponding vector variant that can be
used to perform the concurrent invocation of <code class="docutils literal notranslate"><span class="pre"><scalar_name></span></code> on
vectors. The shape of the vector function is described by the
tokens between the prefix <code class="docutils literal notranslate"><span class="pre">_ZGV</span></code> and the <code class="docutils literal notranslate"><span class="pre"><scalar_name></span></code>
token. The standard name of the vector function is
<code class="docutils literal notranslate"><span class="pre">_ZGV<isa><mask><vlen><parameters>_<scalar_name></span></code>. When present,
the optional token <code class="docutils literal notranslate"><span class="pre">(<vector_redirection>)</span></code> informs the compiler
that a custom name is provided in addition to the standard one
(custom names can be provided for example via the use of <code class="docutils literal notranslate"><span class="pre">declare</span>
<span class="pre">variant</span></code> in OpenMP 5.0). The declaration of the variant must be
present in the IR Module. The signature of the vector variant is
determined by the rules of the Vector Function ABI (VFABI)
specifications of the target. For Arm and X86, the VFABI can be
found at <a class="reference external" href="https://github.com/ARM-software/abi-aa">https://github.com/ARM-software/abi-aa</a> and
<a class="reference external" href="https://software.intel.com/content/www/us/en/develop/download/vector-simd-function-abi.html">https://software.intel.com/content/www/us/en/develop/download/vector-simd-function-abi.html</a>,
respectively.</p>
<p>For X86 and Arm targets, the values of the tokens in the standard
name are those that are defined in the VFABI. LLVM has an internal
<code class="docutils literal notranslate"><span class="pre"><isa></span></code> token that can be used to create scalar-to-vector
mappings for functions that are not directly associated to any of
the target ISAs (for example, some of the mappings stored in the
TargetLibraryInfo). Valid values for the <code class="docutils literal notranslate"><span class="pre"><isa></span></code> token are::</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">isa</span><span class="o">>:=</span> <span class="n">b</span> <span class="o">|</span> <span class="n">c</span> <span class="o">|</span> <span class="n">d</span> <span class="o">|</span> <span class="n">e</span> <span class="o">-></span> <span class="n">X86</span> <span class="n">SSE</span><span class="p">,</span> <span class="n">AVX</span><span class="p">,</span> <span class="n">AVX2</span><span class="p">,</span> <span class="n">AVX512</span>
<span class="o">|</span> <span class="n">n</span> <span class="o">|</span> <span class="n">s</span> <span class="o">-></span> <span class="n">Armv8</span> <span class="n">Advanced</span> <span class="n">SIMD</span><span class="p">,</span> <span class="n">SVE</span>
<span class="o">|</span> <span class="n">__LLVM__</span> <span class="o">-></span> <span class="n">Internal</span> <span class="n">LLVM</span> <span class="n">Vector</span> <span class="n">ISA</span>
</pre></div>
</div>
<p>For all targets currently supported (x86, Arm and Internal LLVM),
the remaining tokens can have the following values::</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">mask</span><span class="o">>:=</span> <span class="n">M</span> <span class="o">|</span> <span class="n">N</span> <span class="o">-></span> <span class="n">mask</span> <span class="o">|</span> <span class="n">no</span> <span class="n">mask</span>
<span class="o"><</span><span class="n">vlen</span><span class="o">>:=</span> <span class="n">number</span> <span class="o">-></span> <span class="n">number</span> <span class="n">of</span> <span class="n">lanes</span>
<span class="o">|</span> <span class="n">x</span> <span class="o">-></span> <span class="n">VLA</span> <span class="p">(</span><span class="n">Vector</span> <span class="n">Length</span> <span class="n">Agnostic</span><span class="p">)</span>
<span class="o"><</span><span class="n">parameters</span><span class="o">>:=</span> <span class="n">v</span> <span class="o">-></span> <span class="n">vector</span>
<span class="o">|</span> <span class="n">l</span> <span class="o">|</span> <span class="n">l</span> <span class="o"><</span><span class="n">number</span><span class="o">></span> <span class="o">-></span> <span class="n">linear</span>
<span class="o">|</span> <span class="n">R</span> <span class="o">|</span> <span class="n">R</span> <span class="o"><</span><span class="n">number</span><span class="o">></span> <span class="o">-></span> <span class="n">linear</span> <span class="k">with</span> <span class="n">ref</span> <span class="n">modifier</span>
<span class="o">|</span> <span class="n">L</span> <span class="o">|</span> <span class="n">L</span> <span class="o"><</span><span class="n">number</span><span class="o">></span> <span class="o">-></span> <span class="n">linear</span> <span class="k">with</span> <span class="n">val</span> <span class="n">modifier</span>
<span class="o">|</span> <span class="n">U</span> <span class="o">|</span> <span class="n">U</span> <span class="o"><</span><span class="n">number</span><span class="o">></span> <span class="o">-></span> <span class="n">linear</span> <span class="k">with</span> <span class="n">uval</span> <span class="n">modifier</span>
<span class="o">|</span> <span class="n">ls</span> <span class="o"><</span><span class="n">pos</span><span class="o">></span> <span class="o">-></span> <span class="n">runtime</span> <span class="n">linear</span>
<span class="o">|</span> <span class="n">Rs</span> <span class="o"><</span><span class="n">pos</span><span class="o">></span> <span class="o">-></span> <span class="n">runtime</span> <span class="n">linear</span> <span class="k">with</span> <span class="n">ref</span> <span class="n">modifier</span>
<span class="o">|</span> <span class="n">Ls</span> <span class="o"><</span><span class="n">pos</span><span class="o">></span> <span class="o">-></span> <span class="n">runtime</span> <span class="n">linear</span> <span class="k">with</span> <span class="n">val</span> <span class="n">modifier</span>
<span class="o">|</span> <span class="n">Us</span> <span class="o"><</span><span class="n">pos</span><span class="o">></span> <span class="o">-></span> <span class="n">runtime</span> <span class="n">linear</span> <span class="k">with</span> <span class="n">uval</span> <span class="n">modifier</span>
<span class="o">|</span> <span class="n">u</span> <span class="o">-></span> <span class="n">uniform</span>
<span class="o"><</span><span class="n">scalar_name</span><span class="o">>:=</span> <span class="n">name</span> <span class="n">of</span> <span class="n">the</span> <span class="n">scalar</span> <span class="n">function</span>
<span class="o"><</span><span class="n">vector_redirection</span><span class="o">>:=</span> <span class="n">optional</span><span class="p">,</span> <span class="n">custom</span> <span class="n">name</span> <span class="n">of</span> <span class="n">the</span> <span class="n">vector</span> <span class="n">function</span>
</pre></div>
</div>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">preallocated(<ty>)</span></code></dt><dd><p>This attribute is required on calls to <code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.arg</span></code>
and cannot be used on any other call. See
<a class="reference internal" href="#int-call-preallocated-arg"><span class="std std-ref">llvm.call.preallocated.arg</span></a> for more
details.</p>
</dd>
</dl>
</div>
<div class="section" id="global-attributes">
<span id="glattrs"></span><h3><a class="toc-backref" href="#id1437">Global Attributes</a><a class="headerlink" href="#global-attributes" title="Permalink to this headline">¶</a></h3>
<p>Attributes may be set to communicate additional information about a global variable.
Unlike <a class="reference internal" href="#fnattrs"><span class="std std-ref">function attributes</span></a>, attributes on a global variable
are grouped into a single <a class="reference internal" href="#attrgrp"><span class="std std-ref">attribute group</span></a>.</p>
</div>
<div class="section" id="operand-bundles">
<span id="opbundles"></span><h3><a class="toc-backref" href="#id1438">Operand Bundles</a><a class="headerlink" href="#operand-bundles" title="Permalink to this headline">¶</a></h3>
<p>Operand bundles are tagged sets of SSA values that can be associated
with certain LLVM instructions (currently only <code class="docutils literal notranslate"><span class="pre">call</span></code> s and
<code class="docutils literal notranslate"><span class="pre">invoke</span></code> s). In a way they are like metadata, but dropping them is
incorrect and will change program semantics.</p>
<p>Syntax:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">operand</span> <span class="n">bundle</span> <span class="nb">set</span> <span class="p">:</span><span class="o">:=</span> <span class="s1">'['</span> <span class="n">operand</span> <span class="n">bundle</span> <span class="p">(,</span> <span class="n">operand</span> <span class="n">bundle</span> <span class="p">)</span><span class="o">*</span> <span class="s1">']'</span>
<span class="n">operand</span> <span class="n">bundle</span> <span class="p">:</span><span class="o">:=</span> <span class="n">tag</span> <span class="s1">'('</span> <span class="p">[</span> <span class="n">bundle</span> <span class="n">operand</span> <span class="p">]</span> <span class="p">(,</span> <span class="n">bundle</span> <span class="n">operand</span> <span class="p">)</span><span class="o">*</span> <span class="s1">')'</span>
<span class="n">bundle</span> <span class="n">operand</span> <span class="p">:</span><span class="o">:=</span> <span class="n">SSA</span> <span class="n">value</span>
<span class="n">tag</span> <span class="p">:</span><span class="o">:=</span> <span class="n">string</span> <span class="n">constant</span>
</pre></div>
</div>
<p>Operand bundles are <strong>not</strong> part of a function’s signature, and a
given function may be called from multiple places with different kinds
of operand bundles. This reflects the fact that the operand bundles
are conceptually a part of the <code class="docutils literal notranslate"><span class="pre">call</span></code> (or <code class="docutils literal notranslate"><span class="pre">invoke</span></code>), not the
callee being dispatched to.</p>
<p>Operand bundles are a generic mechanism intended to support
runtime-introspection-like functionality for managed languages. While
the exact semantics of an operand bundle depend on the bundle tag,
there are certain limitations to how much the presence of an operand
bundle can influence the semantics of a program. These restrictions
are described as the semantics of an “unknown” operand bundle. As
long as the behavior of an operand bundle is describable within these
restrictions, LLVM does not need to have special knowledge of the
operand bundle to not miscompile programs containing it.</p>
<ul class="simple">
<li><p>The bundle operands for an unknown operand bundle escape in unknown
ways before control is transferred to the callee or invokee.</p></li>
<li><p>Calls and invokes with operand bundles have unknown read / write
effect on the heap on entry and exit (even if the call target is
<code class="docutils literal notranslate"><span class="pre">readnone</span></code> or <code class="docutils literal notranslate"><span class="pre">readonly</span></code>), unless they’re overridden with
callsite specific attributes.</p></li>
<li><p>An operand bundle at a call site cannot change the implementation
of the called function. Inter-procedural optimizations work as
usual as long as they take into account the first two properties.</p></li>
</ul>
<p>More specific types of operand bundles are described below.</p>
<div class="section" id="deoptimization-operand-bundles">
<span id="deopt-opbundles"></span><h4><a class="toc-backref" href="#id1439">Deoptimization Operand Bundles</a><a class="headerlink" href="#deoptimization-operand-bundles" title="Permalink to this headline">¶</a></h4>
<p>Deoptimization operand bundles are characterized by the <code class="docutils literal notranslate"><span class="pre">"deopt"</span></code>
operand bundle tag. These operand bundles represent an alternate
“safe” continuation for the call site they’re attached to, and can be
used by a suitable runtime to deoptimize the compiled frame at the
specified call site. There can be at most one <code class="docutils literal notranslate"><span class="pre">"deopt"</span></code> operand
bundle attached to a call site. Exact details of deoptimization is
out of scope for the language reference, but it usually involves
rewriting a compiled frame into a set of interpreted frames.</p>
<p>From the compiler’s perspective, deoptimization operand bundles make
the call sites they’re attached to at least <code class="docutils literal notranslate"><span class="pre">readonly</span></code>. They read
through all of their pointer typed operands (even if they’re not
otherwise escaped) and the entire visible heap. Deoptimization
operand bundles do not capture their operands except during
deoptimization, in which case control will not be returned to the
compiled frame.</p>
<p>The inliner knows how to inline through calls that have deoptimization
operand bundles. Just like inlining through a normal call site
involves composing the normal and exceptional continuations, inlining
through a call site with a deoptimization operand bundle needs to
appropriately compose the “safe” deoptimization continuation. The
inliner does this by prepending the parent’s deoptimization
continuation to every deoptimization continuation in the inlined body.
E.g. inlining <code class="docutils literal notranslate"><span class="pre">@f</span></code> into <code class="docutils literal notranslate"><span class="pre">@g</span></code> in the following example</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="k">void</span> <span class="vg">@f</span><span class="p">()</span> <span class="p">{</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@x</span><span class="p">()</span> <span class="c">;; no deopt state</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@y</span><span class="p">()</span> <span class="p">[</span> <span class="s">"deopt"</span><span class="p">(</span><span class="k">i32</span> <span class="m">10</span><span class="p">)</span> <span class="p">]</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@y</span><span class="p">()</span> <span class="p">[</span> <span class="s">"deopt"</span><span class="p">(</span><span class="k">i32</span> <span class="m">10</span><span class="p">),</span> <span class="s">"unknown"</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="k">ret</span> <span class="k">void</span>
<span class="p">}</span>
<span class="k">define</span> <span class="k">void</span> <span class="vg">@g</span><span class="p">()</span> <span class="p">{</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@f</span><span class="p">()</span> <span class="p">[</span> <span class="s">"deopt"</span><span class="p">(</span><span class="k">i32</span> <span class="m">20</span><span class="p">)</span> <span class="p">]</span>
<span class="k">ret</span> <span class="k">void</span>
<span class="p">}</span>
</pre></div>
</div>
<p>will result in</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="k">void</span> <span class="vg">@g</span><span class="p">()</span> <span class="p">{</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@x</span><span class="p">()</span> <span class="c">;; still no deopt state</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@y</span><span class="p">()</span> <span class="p">[</span> <span class="s">"deopt"</span><span class="p">(</span><span class="k">i32</span> <span class="m">20</span><span class="p">,</span> <span class="k">i32</span> <span class="m">10</span><span class="p">)</span> <span class="p">]</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@y</span><span class="p">()</span> <span class="p">[</span> <span class="s">"deopt"</span><span class="p">(</span><span class="k">i32</span> <span class="m">20</span><span class="p">,</span> <span class="k">i32</span> <span class="m">10</span><span class="p">),</span> <span class="s">"unknown"</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="k">ret</span> <span class="k">void</span>
<span class="p">}</span>
</pre></div>
</div>
<p>It is the frontend’s responsibility to structure or encode the
deoptimization state in a way that syntactically prepending the
caller’s deoptimization state to the callee’s deoptimization state is
semantically equivalent to composing the caller’s deoptimization
continuation after the callee’s deoptimization continuation.</p>
</div>
<div class="section" id="funclet-operand-bundles">
<span id="ob-funclet"></span><h4><a class="toc-backref" href="#id1440">Funclet Operand Bundles</a><a class="headerlink" href="#funclet-operand-bundles" title="Permalink to this headline">¶</a></h4>
<p>Funclet operand bundles are characterized by the <code class="docutils literal notranslate"><span class="pre">"funclet"</span></code>
operand bundle tag. These operand bundles indicate that a call site
is within a particular funclet. There can be at most one
<code class="docutils literal notranslate"><span class="pre">"funclet"</span></code> operand bundle attached to a call site and it must have
exactly one bundle operand.</p>
<p>If any funclet EH pads have been “entered” but not “exited” (per the
<a class="reference external" href="ExceptionHandling.html#wineh-constraints">description in the EH doc</a>),
it is undefined behavior to execute a <code class="docutils literal notranslate"><span class="pre">call</span></code> or <code class="docutils literal notranslate"><span class="pre">invoke</span></code> which:</p>
<ul class="simple">
<li><p>does not have a <code class="docutils literal notranslate"><span class="pre">"funclet"</span></code> bundle and is not a <code class="docutils literal notranslate"><span class="pre">call</span></code> to a nounwind
intrinsic, or</p></li>
<li><p>has a <code class="docutils literal notranslate"><span class="pre">"funclet"</span></code> bundle whose operand is not the most-recently-entered
not-yet-exited funclet EH pad.</p></li>
</ul>
<p>Similarly, if no funclet EH pads have been entered-but-not-yet-exited,
executing a <code class="docutils literal notranslate"><span class="pre">call</span></code> or <code class="docutils literal notranslate"><span class="pre">invoke</span></code> with a <code class="docutils literal notranslate"><span class="pre">"funclet"</span></code> bundle is undefined behavior.</p>
</div>
<div class="section" id="gc-transition-operand-bundles">
<h4><a class="toc-backref" href="#id1441">GC Transition Operand Bundles</a><a class="headerlink" href="#gc-transition-operand-bundles" title="Permalink to this headline">¶</a></h4>
<p>GC transition operand bundles are characterized by the
<code class="docutils literal notranslate"><span class="pre">"gc-transition"</span></code> operand bundle tag. These operand bundles mark a
call as a transition between a function with one GC strategy to a
function with a different GC strategy. If coordinating the transition
between GC strategies requires additional code generation at the call
site, these bundles may contain any values that are needed by the
generated code. For more details, see <a class="reference internal" href="Statepoints.html#gc-transition-args"><span class="std std-ref">GC Transitions</span></a>.</p>
<p>The bundle contain an arbitrary list of Values which need to be passed
to GC transition code. They will be lowered and passed as operands to
the appropriate GC_TRANSITION nodes in the selection DAG. It is assumed
that these arguments must be available before and after (but not
necessarily during) the execution of the callee.</p>
</div>
<div class="section" id="assume-operand-bundles">
<span id="assume-opbundles"></span><h4><a class="toc-backref" href="#id1442">Assume Operand Bundles</a><a class="headerlink" href="#assume-operand-bundles" title="Permalink to this headline">¶</a></h4>
<p>Operand bundles on an <a class="reference internal" href="#int-assume"><span class="std std-ref">llvm.assume</span></a> allows representing
assumptions that a <a class="reference internal" href="#paramattrs"><span class="std std-ref">parameter attribute</span></a> or a
<a class="reference internal" href="#fnattrs"><span class="std std-ref">function attribute</span></a> holds for a certain value at a certain
location. Operand bundles enable assumptions that are either hard or impossible
to represent as a boolean argument of an <a class="reference internal" href="#int-assume"><span class="std std-ref">llvm.assume</span></a>.</p>
<p>An assume operand bundle has the form:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s2">"<tag>"</span><span class="p">([</span> <span class="o"><</span><span class="n">holds</span> <span class="k">for</span> <span class="n">value</span><span class="o">></span> <span class="p">[,</span> <span class="o"><</span><span class="n">attribute</span> <span class="n">argument</span><span class="o">></span><span class="p">]</span> <span class="p">])</span>
</pre></div>
</div>
<ul class="simple">
<li><p>The tag of the operand bundle is usually the name of attribute that can be
assumed to hold. It can also be <cite>ignore</cite>, this tag doesn’t contain any
information and should be ignored.</p></li>
<li><p>The first argument if present is the value for which the attribute hold.</p></li>
<li><p>The second argument if present is an argument of the attribute.</p></li>
</ul>
<p>If there are no arguments the attribute is a property of the call location.</p>
<p>If the represented attribute expects a constant argument, the argument provided
to the operand bundle should be a constant as well.</p>
<p>For example:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">call</span> <span class="k">void</span> <span class="vg">@llvm.assume</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">"align"</span><span class="p">(</span><span class="k">i32</span><span class="p">*</span> <span class="nv">%val</span><span class="p">,</span> <span class="k">i32</span> <span class="m">8</span><span class="p">)]</span>
</pre></div>
</div>
<p>allows the optimizer to assume that at location of call to
<a class="reference internal" href="#int-assume"><span class="std std-ref">llvm.assume</span></a> <code class="docutils literal notranslate"><span class="pre">%val</span></code> has an alignment of at least 8.</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">call</span> <span class="k">void</span> <span class="vg">@llvm.assume</span><span class="p">(</span><span class="k">i1</span> <span class="nv">%cond</span><span class="p">)</span> <span class="p">[</span><span class="s">"cold"</span><span class="p">(),</span> <span class="s">"nonnull"</span><span class="p">(</span><span class="k">i64</span><span class="p">*</span> <span class="nv">%val</span><span class="p">)]</span>
</pre></div>
</div>
<p>allows the optimizer to assume that the <a class="reference internal" href="#int-assume"><span class="std std-ref">llvm.assume</span></a>
call location is cold and that <code class="docutils literal notranslate"><span class="pre">%val</span></code> may not be null.</p>
<p>Just like for the argument of <a class="reference internal" href="#int-assume"><span class="std std-ref">llvm.assume</span></a>, if any of the
provided guarantees are violated at runtime the behavior is undefined.</p>
<p>Even if the assumed property can be encoded as a boolean value, like
<code class="docutils literal notranslate"><span class="pre">nonnull</span></code>, using operand bundles to express the property can still have
benefits:</p>
<ul class="simple">
<li><p>Attributes that can be expressed via operand bundles are directly the
property that the optimizer uses and cares about. Encoding attributes as
operand bundles removes the need for an instruction sequence that represents
the property (e.g., <cite>icmp ne i32* %p, null</cite> for <cite>nonnull</cite>) and for the
optimizer to deduce the property from that instruction sequence.</p></li>
<li><p>Expressing the property using operand bundles makes it easy to identify the
use of the value as a use in an <a class="reference internal" href="#int-assume"><span class="std std-ref">llvm.assume</span></a>. This then
simplifies and improves heuristics, e.g., for use “use-sensitive”
optimizations.</p></li>
</ul>
</div>
<div class="section" id="preallocated-operand-bundles">
<span id="ob-preallocated"></span><h4><a class="toc-backref" href="#id1443">Preallocated Operand Bundles</a><a class="headerlink" href="#preallocated-operand-bundles" title="Permalink to this headline">¶</a></h4>
<p>Preallocated operand bundles are characterized by the <code class="docutils literal notranslate"><span class="pre">"preallocated"</span></code>
operand bundle tag. These operand bundles allow separation of the allocation
of the call argument memory from the call site. This is necessary to pass
non-trivially copyable objects by value in a way that is compatible with MSVC
on some targets. There can be at most one <code class="docutils literal notranslate"><span class="pre">"preallocated"</span></code> operand bundle
attached to a call site and it must have exactly one bundle operand, which is
a token generated by <code class="docutils literal notranslate"><span class="pre">@llvm.call.preallocated.setup</span></code>. A call with this
operand bundle should not adjust the stack before entering the function, as
that will have been done by one of the <code class="docutils literal notranslate"><span class="pre">@llvm.call.preallocated.*</span></code> intrinsics.</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span>%foo = type { i64, i32 }
...
%t = call token @llvm.call.preallocated.setup(i32 1)
%a = call i8* @llvm.call.preallocated.arg(token %t, i32 0) preallocated(%foo)
%b = bitcast i8* %a to %foo*
; initialize %b
call void @bar(i32 42, %foo* preallocated(%foo) %b) ["preallocated"(token %t)]
</pre></div>
</div>
</div>
<div class="section" id="gc-live-operand-bundles">
<span id="ob-gc-live"></span><h4><a class="toc-backref" href="#id1444">GC Live Operand Bundles</a><a class="headerlink" href="#gc-live-operand-bundles" title="Permalink to this headline">¶</a></h4>
<p>A “gc-live” operand bundle is only valid on a <a class="reference internal" href="#gc-statepoint"><span class="std std-ref">gc.statepoint</span></a>
intrinsic. The operand bundle must contain every pointer to a garbage collected
object which potentially needs to be updated by the garbage collector.</p>
<p>When lowered, any relocated value will be recorded in the corresponding
<a class="reference internal" href="Statepoints.html#statepoint-stackmap-format"><span class="std std-ref">stackmap entry</span></a>. See the intrinsic description
for further details.</p>
</div>
<div class="section" id="objc-arc-attached-call-operand-bundles">
<h4><a class="toc-backref" href="#id1445">ObjC ARC Attached Call Operand Bundles</a><a class="headerlink" href="#objc-arc-attached-call-operand-bundles" title="Permalink to this headline">¶</a></h4>
<p>A <code class="docutils literal notranslate"><span class="pre">"clang.arc.attachedcall"</span></code> operand bundle on a call indicates the call is
implicitly followed by a marker instruction and a call to an ObjC runtime
function that uses the result of the call. The operand bundle takes either the
pointer to the runtime function (<code class="docutils literal notranslate"><span class="pre">@objc_retainAutoreleasedReturnValue</span></code> or
<code class="docutils literal notranslate"><span class="pre">@objc_unsafeClaimAutoreleasedReturnValue</span></code>) or no arguments. If the bundle
doesn’t take any arguments, only the marker instruction has to be emitted after
the call; the runtime function calls don’t have to be emitted since they already
have been emitted. The return value of a call with this bundle is used by a call
to <code class="docutils literal notranslate"><span class="pre">@llvm.objc.clang.arc.noop.use</span></code> unless the called function’s return type is
void, in which case the operand bundle is ignored.</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="c">; The marker instruction and a runtime function call are inserted after the call</span>
<span class="c">; to @foo.</span>
<span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@foo</span><span class="p">()</span> <span class="p">[</span> <span class="s">"clang.arc.attachedcall"</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="vg">@objc_retainAutoreleasedReturnValue</span><span class="p">)</span> <span class="p">]</span>
<span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@foo</span><span class="p">()</span> <span class="p">[</span> <span class="s">"clang.arc.attachedcall"</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="vg">@objc_unsafeClaimAutoreleasedReturnValue</span><span class="p">)</span> <span class="p">]</span>
<span class="c">; Only the marker instruction is inserted after the call to @foo.</span>
<span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@foo</span><span class="p">()</span> <span class="p">[</span> <span class="s">"clang.arc.attachedcall"</span><span class="p">()</span> <span class="p">]</span>
</pre></div>
</div>
<p>The operand bundle is needed to ensure the call is immediately followed by the
marker instruction or the ObjC runtime call in the final output.</p>
</div>
</div>
<div class="section" id="module-level-inline-assembly">
<span id="moduleasm"></span><h3><a class="toc-backref" href="#id1446">Module-Level Inline Assembly</a><a class="headerlink" href="#module-level-inline-assembly" title="Permalink to this headline">¶</a></h3>
<p>Modules may contain “module-level inline asm” blocks, which corresponds
to the GCC “file scope inline asm” blocks. These blocks are internally
concatenated by LLVM and treated as a single unit, but may be separated
in the <code class="docutils literal notranslate"><span class="pre">.ll</span></code> file if desired. The syntax is very simple:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">module</span> <span class="k">asm</span> <span class="s">"inline asm code goes here"</span>
<span class="k">module</span> <span class="k">asm</span> <span class="s">"more can go here"</span>
</pre></div>
</div>
<p>The strings can contain any character by escaping non-printable
characters. The escape sequence used is simply “\xx” where “xx” is the
two digit hex code for the number.</p>
<p>Note that the assembly string <em>must</em> be parseable by LLVM’s integrated assembler
(unless it is disabled), even when emitting a <code class="docutils literal notranslate"><span class="pre">.s</span></code> file.</p>
</div>
<div class="section" id="data-layout">
<span id="langref-datalayout"></span><h3><a class="toc-backref" href="#id1447">Data Layout</a><a class="headerlink" href="#data-layout" title="Permalink to this headline">¶</a></h3>
<p>A module may specify a target specific data layout string that specifies
how data is to be laid out in memory. The syntax for the data layout is
simply:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">target</span> <span class="k">datalayout</span> <span class="p">=</span> <span class="s">"layout specification"</span>
</pre></div>
</div>
<p>The <em>layout specification</em> consists of a list of specifications
separated by the minus sign character (‘-‘). Each specification starts
with a letter and may include other information after the letter to
define some aspect of the data layout. The specifications accepted are
as follows:</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">E</span></code></dt><dd><p>Specifies that the target lays out data in big-endian form. That is,
the bits with the most significance have the lowest address
location.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">e</span></code></dt><dd><p>Specifies that the target lays out data in little-endian form. That
is, the bits with the least significance have the lowest address
location.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">S<size></span></code></dt><dd><p>Specifies the natural alignment of the stack in bits. Alignment
promotion of stack variables is limited to the natural stack
alignment to avoid dynamic stack realignment. The stack alignment
must be a multiple of 8-bits. If omitted, the natural stack
alignment defaults to “unspecified”, which does not prevent any
alignment promotions.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">P<address</span> <span class="pre">space></span></code></dt><dd><p>Specifies the address space that corresponds to program memory.
Harvard architectures can use this to specify what space LLVM
should place things such as functions into. If omitted, the
program memory space defaults to the default address space of 0,
which corresponds to a Von Neumann architecture that has code
and data in the same space.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">G<address</span> <span class="pre">space></span></code></dt><dd><p>Specifies the address space to be used by default when creating global
variables. If omitted, the globals address space defaults to the default
address space 0.
Note: variable declarations without an address space are always created in
address space 0, this property only affects the default value to be used
when creating globals without additional contextual information (e.g. in
LLVM passes).</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">A<address</span> <span class="pre">space></span></code></dt><dd><p>Specifies the address space of objects created by ‘<code class="docutils literal notranslate"><span class="pre">alloca</span></code>’.
Defaults to the default address space of 0.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">p[n]:<size>:<abi>:<pref>:<idx></span></code></dt><dd><p>This specifies the <em>size</em> of a pointer and its <code class="docutils literal notranslate"><span class="pre"><abi></span></code> and
<code class="docutils literal notranslate"><span class="pre"><pref></span></code>erred alignments for address space <code class="docutils literal notranslate"><span class="pre">n</span></code>. The fourth parameter
<code class="docutils literal notranslate"><span class="pre"><idx></span></code> is a size of index that used for address calculation. If not
specified, the default index size is equal to the pointer size. All sizes
are in bits. The address space, <code class="docutils literal notranslate"><span class="pre">n</span></code>, is optional, and if not specified,
denotes the default address space 0. The value of <code class="docutils literal notranslate"><span class="pre">n</span></code> must be
in the range [1,2^23).</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">i<size>:<abi>:<pref></span></code></dt><dd><p>This specifies the alignment for an integer type of a given bit
<code class="docutils literal notranslate"><span class="pre"><size></span></code>. The value of <code class="docutils literal notranslate"><span class="pre"><size></span></code> must be in the range [1,2^23).</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">v<size>:<abi>:<pref></span></code></dt><dd><p>This specifies the alignment for a vector type of a given bit
<code class="docutils literal notranslate"><span class="pre"><size></span></code>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">f<size>:<abi>:<pref></span></code></dt><dd><p>This specifies the alignment for a floating-point type of a given bit
<code class="docutils literal notranslate"><span class="pre"><size></span></code>. Only values of <code class="docutils literal notranslate"><span class="pre"><size></span></code> that are supported by the target
will work. 32 (float) and 64 (double) are supported on all targets; 80
or 128 (different flavors of long double) are also supported on some
targets.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">a:<abi>:<pref></span></code></dt><dd><p>This specifies the alignment for an object of aggregate type.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">F<type><abi></span></code></dt><dd><p>This specifies the alignment for function pointers.
The options for <code class="docutils literal notranslate"><span class="pre"><type></span></code> are:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">i</span></code>: The alignment of function pointers is independent of the alignment
of functions, and is a multiple of <code class="docutils literal notranslate"><span class="pre"><abi></span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">n</span></code>: The alignment of function pointers is a multiple of the explicit
alignment specified on the function, and is a multiple of <code class="docutils literal notranslate"><span class="pre"><abi></span></code>.</p></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">m:<mangling></span></code></dt><dd><p>If present, specifies that llvm names are mangled in the output. Symbols
prefixed with the mangling escape character <code class="docutils literal notranslate"><span class="pre">\01</span></code> are passed through
directly to the assembler without the escape character. The mangling style
options are</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">e</span></code>: ELF mangling: Private symbols get a <code class="docutils literal notranslate"><span class="pre">.L</span></code> prefix.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">m</span></code>: Mips mangling: Private symbols get a <code class="docutils literal notranslate"><span class="pre">$</span></code> prefix.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">o</span></code>: Mach-O mangling: Private symbols get <code class="docutils literal notranslate"><span class="pre">L</span></code> prefix. Other
symbols get a <code class="docutils literal notranslate"><span class="pre">_</span></code> prefix.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">x</span></code>: Windows x86 COFF mangling: Private symbols get the usual prefix.
Regular C symbols get a <code class="docutils literal notranslate"><span class="pre">_</span></code> prefix. Functions with <code class="docutils literal notranslate"><span class="pre">__stdcall</span></code>,
<code class="docutils literal notranslate"><span class="pre">__fastcall</span></code>, and <code class="docutils literal notranslate"><span class="pre">__vectorcall</span></code> have custom mangling that appends
<code class="docutils literal notranslate"><span class="pre">@N</span></code> where N is the number of bytes used to pass parameters. C++ symbols
starting with <code class="docutils literal notranslate"><span class="pre">?</span></code> are not mangled in any way.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">w</span></code>: Windows COFF mangling: Similar to <code class="docutils literal notranslate"><span class="pre">x</span></code>, except that normal C
symbols do not receive a <code class="docutils literal notranslate"><span class="pre">_</span></code> prefix.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">a</span></code>: XCOFF mangling: Private symbols get a <code class="docutils literal notranslate"><span class="pre">L..</span></code> prefix.</p></li>
</ul>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">n<size1>:<size2>:<size3>...</span></code></dt><dd><p>This specifies a set of native integer widths for the target CPU in
bits. For example, it might contain <code class="docutils literal notranslate"><span class="pre">n32</span></code> for 32-bit PowerPC,
<code class="docutils literal notranslate"><span class="pre">n32:64</span></code> for PowerPC 64, or <code class="docutils literal notranslate"><span class="pre">n8:16:32:64</span></code> for X86-64. Elements of
this set are considered to support most general arithmetic operations
efficiently.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">ni:<address</span> <span class="pre">space0>:<address</span> <span class="pre">space1>:<address</span> <span class="pre">space2>...</span></code></dt><dd><p>This specifies pointer types with the specified address spaces
as <a class="reference internal" href="#nointptrtype"><span class="std std-ref">Non-Integral Pointer Type</span></a> s. The <code class="docutils literal notranslate"><span class="pre">0</span></code>
address space cannot be specified as non-integral.</p>
</dd>
</dl>
<p>On every specification that takes a <code class="docutils literal notranslate"><span class="pre"><abi>:<pref></span></code>, specifying the
<code class="docutils literal notranslate"><span class="pre"><pref></span></code> alignment is optional. If omitted, the preceding <code class="docutils literal notranslate"><span class="pre">:</span></code>
should be omitted too and <code class="docutils literal notranslate"><span class="pre"><pref></span></code> will be equal to <code class="docutils literal notranslate"><span class="pre"><abi></span></code>.</p>
<p>When constructing the data layout for a given target, LLVM starts with a
default set of specifications which are then (possibly) overridden by
the specifications in the <code class="docutils literal notranslate"><span class="pre">datalayout</span></code> keyword. The default
specifications are given in this list:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">E</span></code> - big endian</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">p:64:64:64</span></code> - 64-bit pointers with 64-bit alignment.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">p[n]:64:64:64</span></code> - Other address spaces are assumed to be the
same as the default address space.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">S0</span></code> - natural stack alignment is unspecified</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">i1:8:8</span></code> - i1 is 8-bit (byte) aligned</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">i8:8:8</span></code> - i8 is 8-bit (byte) aligned</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">i16:16:16</span></code> - i16 is 16-bit aligned</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">i32:32:32</span></code> - i32 is 32-bit aligned</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">i64:32:64</span></code> - i64 has ABI alignment of 32-bits but preferred
alignment of 64-bits</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">f16:16:16</span></code> - half is 16-bit aligned</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">f32:32:32</span></code> - float is 32-bit aligned</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">f64:64:64</span></code> - double is 64-bit aligned</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">f128:128:128</span></code> - quad is 128-bit aligned</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">v64:64:64</span></code> - 64-bit vector is 64-bit aligned</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">v128:128:128</span></code> - 128-bit vector is 128-bit aligned</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">a:0:64</span></code> - aggregates are 64-bit aligned</p></li>
</ul>
<p>When LLVM is determining the alignment for a given type, it uses the
following rules:</p>
<ol class="arabic simple">
<li><p>If the type sought is an exact match for one of the specifications,
that specification is used.</p></li>
<li><p>If no match is found, and the type sought is an integer type, then
the smallest integer type that is larger than the bitwidth of the
sought type is used. If none of the specifications are larger than
the bitwidth then the largest integer type is used. For example,
given the default specifications above, the i7 type will use the
alignment of i8 (next largest) while both i65 and i256 will use the
alignment of i64 (largest specified).</p></li>
<li><p>If no match is found, and the type sought is a vector type, then the
largest vector type that is smaller than the sought vector type will
be used as a fall back. This happens because <128 x double> can be
implemented in terms of 64 <2 x double>, for example.</p></li>
</ol>
<p>The function of the data layout string may not be what you expect.
Notably, this is not a specification from the frontend of what alignment
the code generator should use.</p>
<p>Instead, if specified, the target data layout is required to match what
the ultimate <em>code generator</em> expects. This string is used by the
mid-level optimizers to improve code, and this only works if it matches
what the ultimate code generator uses. There is no way to generate IR
that does not embed this target-specific detail into the IR. If you
don’t specify the string, the default specifications will be used to
generate a Data Layout and the optimization phases will operate
accordingly and introduce target specificity into the IR with respect to
these default specifications.</p>
</div>
<div class="section" id="target-triple">
<span id="langref-triple"></span><h3><a class="toc-backref" href="#id1448">Target Triple</a><a class="headerlink" href="#target-triple" title="Permalink to this headline">¶</a></h3>
<p>A module may specify a target triple string that describes the target
host. The syntax for the target triple is simply:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">target</span> <span class="k">triple</span> <span class="p">=</span> <span class="s">"x86_64-apple-macosx10.7.0"</span>
</pre></div>
</div>
<p>The <em>target triple</em> string consists of a series of identifiers delimited
by the minus sign character (‘-‘). The canonical forms are:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">ARCHITECTURE</span><span class="o">-</span><span class="n">VENDOR</span><span class="o">-</span><span class="n">OPERATING_SYSTEM</span>
<span class="n">ARCHITECTURE</span><span class="o">-</span><span class="n">VENDOR</span><span class="o">-</span><span class="n">OPERATING_SYSTEM</span><span class="o">-</span><span class="n">ENVIRONMENT</span>
</pre></div>
</div>
<p>This information is passed along to the backend so that it generates
code for the proper architecture. It’s possible to override this on the
command line with the <code class="docutils literal notranslate"><span class="pre">-mtriple</span></code> command line option.</p>
</div>
<div class="section" id="object-lifetime">
<span id="objectlifetime"></span><h3><a class="toc-backref" href="#id1449">Object Lifetime</a><a class="headerlink" href="#object-lifetime" title="Permalink to this headline">¶</a></h3>
<p>A memory object, or simply object, is a region of a memory space that is
reserved by a memory allocation such as <a class="reference internal" href="#i-alloca"><span class="std std-ref">alloca</span></a>, heap
allocation calls, and global variable definitions.
Once it is allocated, the bytes stored in the region can only be read or written
through a pointer that is <a class="reference internal" href="#pointeraliasing"><span class="std std-ref">based on</span></a> the allocation
value.
If a pointer that is not based on the object tries to read or write to the
object, it is undefined behavior.</p>
<p>A lifetime of a memory object is a property that decides its accessibility.
Unless stated otherwise, a memory object is alive since its allocation, and
dead after its deallocation.
It is undefined behavior to access a memory object that isn’t alive, but
operations that don’t dereference it such as
<a class="reference internal" href="#i-getelementptr"><span class="std std-ref">getelementptr</span></a>, <a class="reference internal" href="#i-ptrtoint"><span class="std std-ref">ptrtoint</span></a> and
<a class="reference internal" href="#i-icmp"><span class="std std-ref">icmp</span></a> return a valid result.
This explains code motion of these instructions across operations that
impact the object’s lifetime.
A stack object’s lifetime can be explicitly specified using
<a class="reference internal" href="#int-lifestart"><span class="std std-ref">llvm.lifetime.start</span></a> and
<a class="reference internal" href="#int-lifeend"><span class="std std-ref">llvm.lifetime.end</span></a> intrinsic function calls.</p>
</div>
<div class="section" id="pointer-aliasing-rules">
<span id="pointeraliasing"></span><h3><a class="toc-backref" href="#id1450">Pointer Aliasing Rules</a><a class="headerlink" href="#pointer-aliasing-rules" title="Permalink to this headline">¶</a></h3>
<p>Any memory access must be done through a pointer value associated with
an address range of the memory access, otherwise the behavior is
undefined. Pointer values are associated with address ranges according
to the following rules:</p>
<ul class="simple">
<li><p>A pointer value is associated with the addresses associated with any
value it is <em>based</em> on.</p></li>
<li><p>An address of a global variable is associated with the address range
of the variable’s storage.</p></li>
<li><p>The result value of an allocation instruction is associated with the
address range of the allocated storage.</p></li>
<li><p>A null pointer in the default address-space is associated with no
address.</p></li>
<li><p>An <a class="reference internal" href="#undefvalues"><span class="std std-ref">undef value</span></a> in <em>any</em> address-space is
associated with no address.</p></li>
<li><p>An integer constant other than zero or a pointer value returned from
a function not defined within LLVM may be associated with address
ranges allocated through mechanisms other than those provided by
LLVM. Such ranges shall not overlap with any ranges of addresses
allocated by mechanisms provided by LLVM.</p></li>
</ul>
<p>A pointer value is <em>based</em> on another pointer value according to the
following rules:</p>
<ul class="simple">
<li><p>A pointer value formed from a scalar <code class="docutils literal notranslate"><span class="pre">getelementptr</span></code> operation is <em>based</em> on
the pointer-typed operand of the <code class="docutils literal notranslate"><span class="pre">getelementptr</span></code>.</p></li>
<li><p>The pointer in lane <em>l</em> of the result of a vector <code class="docutils literal notranslate"><span class="pre">getelementptr</span></code> operation
is <em>based</em> on the pointer in lane <em>l</em> of the vector-of-pointers-typed operand
of the <code class="docutils literal notranslate"><span class="pre">getelementptr</span></code>.</p></li>
<li><p>The result value of a <code class="docutils literal notranslate"><span class="pre">bitcast</span></code> is <em>based</em> on the operand of the
<code class="docutils literal notranslate"><span class="pre">bitcast</span></code>.</p></li>
<li><p>A pointer value formed by an <code class="docutils literal notranslate"><span class="pre">inttoptr</span></code> is <em>based</em> on all pointer
values that contribute (directly or indirectly) to the computation of
the pointer’s value.</p></li>
<li><p>The “<em>based</em> on” relationship is transitive.</p></li>
</ul>
<p>Note that this definition of <em>“based”</em> is intentionally similar to the
definition of <em>“based”</em> in C99, though it is slightly weaker.</p>
<p>LLVM IR does not associate types with memory. The result type of a
<code class="docutils literal notranslate"><span class="pre">load</span></code> merely indicates the size and alignment of the memory from
which to load, as well as the interpretation of the value. The first
operand type of a <code class="docutils literal notranslate"><span class="pre">store</span></code> similarly only indicates the size and
alignment of the store.</p>
<p>Consequently, type-based alias analysis, aka TBAA, aka
<code class="docutils literal notranslate"><span class="pre">-fstrict-aliasing</span></code>, is not applicable to general unadorned LLVM IR.
<a class="reference internal" href="#metadata"><span class="std std-ref">Metadata</span></a> may be used to encode additional information
which specialized optimization passes may use to implement type-based
alias analysis.</p>
</div>
<div class="section" id="pointer-capture">
<span id="pointercapture"></span><h3><a class="toc-backref" href="#id1451">Pointer Capture</a><a class="headerlink" href="#pointer-capture" title="Permalink to this headline">¶</a></h3>
<p>Given a function call and a pointer that is passed as an argument or stored in
the memory before the call, a pointer is <em>captured</em> by the call if it makes a
copy of any part of the pointer that outlives the call.
To be precise, a pointer is captured if one or more of the following conditions
hold:</p>
<ol class="arabic simple">
<li><p>The call stores any bit of the pointer carrying information into a place,
and the stored bits can be read from the place by the caller after this call
exits.</p></li>
</ol>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="vg">@glb</span> <span class="p">=</span> <span class="k">global</span> <span class="k">i8</span><span class="p">*</span> <span class="k">null</span>
<span class="vg">@glb2</span> <span class="p">=</span> <span class="k">global</span> <span class="k">i8</span><span class="p">*</span> <span class="k">null</span>
<span class="vg">@glb3</span> <span class="p">=</span> <span class="k">global</span> <span class="k">i8</span><span class="p">*</span> <span class="k">null</span>
<span class="vg">@glbi</span> <span class="p">=</span> <span class="k">global</span> <span class="k">i32</span> <span class="m">0</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">i8</span><span class="p">*</span> <span class="nv">%a</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%b</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%c</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%d</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%e</span><span class="p">)</span> <span class="p">{</span>
<span class="k">store</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%a</span><span class="p">,</span> <span class="k">i8</span><span class="p">**</span> <span class="vg">@glb</span> <span class="c">; %a is captured by this call</span>
<span class="k">store</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%b</span><span class="p">,</span> <span class="k">i8</span><span class="p">**</span> <span class="vg">@glb2</span> <span class="c">; %b isn't captured because the stored value is overwritten by the store below</span>
<span class="k">store</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="vg">@glb2</span>
<span class="k">store</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%c</span><span class="p">,</span> <span class="k">i8</span><span class="p">**</span> <span class="vg">@glb3</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@g</span><span class="p">()</span> <span class="c">; If @g makes a copy of %c that outlives this call (@f), %c is captured</span>
<span class="k">store</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="vg">@glb3</span>
<span class="nv">%i</span> <span class="p">=</span> <span class="k">ptrtoint</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%d</span> <span class="k">to</span> <span class="k">i64</span>
<span class="nv">%j</span> <span class="p">=</span> <span class="k">trunc</span> <span class="k">i64</span> <span class="nv">%i</span> <span class="k">to</span> <span class="k">i32</span>
<span class="k">store</span> <span class="k">i32</span> <span class="nv">%j</span><span class="p">,</span> <span class="k">i32</span><span class="p">*</span> <span class="vg">@glbi</span> <span class="c">; %d is captured</span>
<span class="k">ret</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%e</span> <span class="c">; %e is captured</span>
<span class="p">}</span>
</pre></div>
</div>
<ol class="arabic simple" start="2">
<li><p>The call stores any bit of the pointer carrying information into a place,
and the stored bits can be safely read from the place by another thread via
synchronization.</p></li>
</ol>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="vg">@lock</span> <span class="p">=</span> <span class="k">global</span> <span class="k">i1</span> <span class="k">true</span>
<span class="k">define</span> <span class="k">void</span> <span class="vg">@f</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%a</span><span class="p">)</span> <span class="p">{</span>
<span class="k">store</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%a</span><span class="p">,</span> <span class="k">i8</span><span class="p">**</span> <span class="vg">@glb</span>
<span class="k">store</span> <span class="k">atomic</span> <span class="k">i1</span> <span class="k">false</span><span class="p">,</span> <span class="k">i1</span><span class="p">*</span> <span class="vg">@lock</span> <span class="k">release</span> <span class="c">; %a is captured because another thread can safely read @glb</span>
<span class="k">store</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="vg">@glb</span>
<span class="k">ret</span> <span class="k">void</span>
<span class="p">}</span>
</pre></div>
</div>
<ol class="arabic simple" start="3">
<li><p>The call’s behavior depends on any bit of the pointer carrying information.</p></li>
</ol>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="vg">@glb</span> <span class="p">=</span> <span class="k">global</span> <span class="k">i8</span> <span class="m">0</span>
<span class="k">define</span> <span class="k">void</span> <span class="vg">@f</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%a</span><span class="p">)</span> <span class="p">{</span>
<span class="nv">%c</span> <span class="p">=</span> <span class="k">icmp</span> <span class="k">eq</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%a</span><span class="p">,</span> <span class="vg">@glb</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%c</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%BB_EXIT</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%BB_CONTINUE</span> <span class="c">; escapes %a</span>
<span class="nl">BB_EXIT:</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@exit</span><span class="p">()</span>
<span class="k">unreachable</span>
<span class="nl">BB_CONTINUE:</span>
<span class="k">ret</span> <span class="k">void</span>
<span class="p">}</span>
</pre></div>
</div>
<ol class="arabic simple" start="4">
<li><p>The pointer is used in a volatile access as its address.</p></li>
</ol>
</div>
<div class="section" id="volatile-memory-accesses">
<span id="volatile"></span><h3><a class="toc-backref" href="#id1452">Volatile Memory Accesses</a><a class="headerlink" href="#volatile-memory-accesses" title="Permalink to this headline">¶</a></h3>
<p>Certain memory accesses, such as <a class="reference internal" href="#i-load"><span class="std std-ref">load</span></a>’s,
<a class="reference internal" href="#i-store"><span class="std std-ref">store</span></a>’s, and <a class="reference internal" href="#int-memcpy"><span class="std std-ref">llvm.memcpy</span></a>’s may be
marked <code class="docutils literal notranslate"><span class="pre">volatile</span></code>. The optimizers must not change the number of
volatile operations or change their order of execution relative to other
volatile operations. The optimizers <em>may</em> change the order of volatile
operations relative to non-volatile operations. This is not Java’s
“volatile” and has no cross-thread synchronization behavior.</p>
<p>A volatile load or store may have additional target-specific semantics.
Any volatile operation can have side effects, and any volatile operation
can read and/or modify state which is not accessible via a regular load
or store in this module. Volatile operations may use addresses which do
not point to memory (like MMIO registers). This means the compiler may
not use a volatile operation to prove a non-volatile access to that
address has defined behavior.</p>
<p>The allowed side-effects for volatile accesses are limited. If a
non-volatile store to a given address would be legal, a volatile
operation may modify the memory at that address. A volatile operation
may not modify any other memory accessible by the module being compiled.
A volatile operation may not call any code in the current module.</p>
<p>The compiler may assume execution will continue after a volatile operation,
so operations which modify memory or may have undefined behavior can be
hoisted past a volatile operation.</p>
<p>As an exception to the preceding rule, the compiler may not assume execution
will continue after a volatile store operation. This restriction is necessary
to support the somewhat common pattern in C of intentionally storing to an
invalid pointer to crash the program. In the future, it might make sense to
allow frontends to control this behavior.</p>
<p>IR-level volatile loads and stores cannot safely be optimized into llvm.memcpy
or llvm.memmove intrinsics even when those intrinsics are flagged volatile.
Likewise, the backend should never split or merge target-legal volatile
load/store instructions. Similarly, IR-level volatile loads and stores cannot
change from integer to floating-point or vice versa.</p>
<div class="admonition-rationale admonition">
<p class="admonition-title">Rationale</p>
<p>Platforms may rely on volatile loads and stores of natively supported
data width to be executed as single instruction. For example, in C
this holds for an l-value of volatile primitive type with native
hardware support, but not necessarily for aggregate types. The
frontend upholds these expectations, which are intentionally
unspecified in the IR. The rules above ensure that IR transformations
do not violate the frontend’s contract with the language.</p>
</div>
</div>
<div class="section" id="memory-model-for-concurrent-operations">
<span id="memmodel"></span><h3><a class="toc-backref" href="#id1453">Memory Model for Concurrent Operations</a><a class="headerlink" href="#memory-model-for-concurrent-operations" title="Permalink to this headline">¶</a></h3>
<p>The LLVM IR does not define any way to start parallel threads of
execution or to register signal handlers. Nonetheless, there are
platform-specific ways to create them, and we define LLVM IR’s behavior
in their presence. This model is inspired by the C++0x memory model.</p>
<p>For a more informal introduction to this model, see the <a class="reference internal" href="Atomics.html"><span class="doc">LLVM Atomic Instructions and Concurrency Guide</span></a>.</p>
<p>We define a <em>happens-before</em> partial order as the least partial order
that</p>
<ul class="simple">
<li><p>Is a superset of single-thread program order, and</p></li>
<li><p>When a <em>synchronizes-with</em> <code class="docutils literal notranslate"><span class="pre">b</span></code>, includes an edge from <code class="docutils literal notranslate"><span class="pre">a</span></code> to
<code class="docutils literal notranslate"><span class="pre">b</span></code>. <em>Synchronizes-with</em> pairs are introduced by platform-specific
techniques, like pthread locks, thread creation, thread joining,
etc., and by atomic instructions. (See also <a class="reference internal" href="#ordering"><span class="std std-ref">Atomic Memory Ordering
Constraints</span></a>).</p></li>
</ul>
<p>Note that program order does not introduce <em>happens-before</em> edges
between a thread and signals executing inside that thread.</p>
<p>Every (defined) read operation (load instructions, memcpy, atomic
loads/read-modify-writes, etc.) R reads a series of bytes written by
(defined) write operations (store instructions, atomic
stores/read-modify-writes, memcpy, etc.). For the purposes of this
section, initialized globals are considered to have a write of the
initializer which is atomic and happens before any other read or write
of the memory in question. For each byte of a read R, R<sub>byte</sub>
may see any write to the same byte, except:</p>
<ul class="simple">
<li><p>If write<sub>1</sub> happens before write<sub>2</sub>, and
write<sub>2</sub> happens before R<sub>byte</sub>, then
R<sub>byte</sub> does not see write<sub>1</sub>.</p></li>
<li><p>If R<sub>byte</sub> happens before write<sub>3</sub>, then
R<sub>byte</sub> does not see write<sub>3</sub>.</p></li>
</ul>
<p>Given that definition, R<sub>byte</sub> is defined as follows:</p>
<ul class="simple">
<li><p>If R is volatile, the result is target-dependent. (Volatile is
supposed to give guarantees which can support <code class="docutils literal notranslate"><span class="pre">sig_atomic_t</span></code> in
C/C++, and may be used for accesses to addresses that do not behave
like normal memory. It does not generally provide cross-thread
synchronization.)</p></li>
<li><p>Otherwise, if there is no write to the same byte that happens before
R<sub>byte</sub>, R<sub>byte</sub> returns <code class="docutils literal notranslate"><span class="pre">undef</span></code> for that byte.</p></li>
<li><p>Otherwise, if R<sub>byte</sub> may see exactly one write,
R<sub>byte</sub> returns the value written by that write.</p></li>
<li><p>Otherwise, if R is atomic, and all the writes R<sub>byte</sub> may
see are atomic, it chooses one of the values written. See the <a class="reference internal" href="#ordering"><span class="std std-ref">Atomic
Memory Ordering Constraints</span></a> section for additional
constraints on how the choice is made.</p></li>
<li><p>Otherwise R<sub>byte</sub> returns <code class="docutils literal notranslate"><span class="pre">undef</span></code>.</p></li>
</ul>
<p>R returns the value composed of the series of bytes it read. This
implies that some bytes within the value may be <code class="docutils literal notranslate"><span class="pre">undef</span></code> <strong>without</strong>
the entire value being <code class="docutils literal notranslate"><span class="pre">undef</span></code>. Note that this only defines the
semantics of the operation; it doesn’t mean that targets will emit more
than one instruction to read the series of bytes.</p>
<p>Note that in cases where none of the atomic intrinsics are used, this
model places only one restriction on IR transformations on top of what
is required for single-threaded execution: introducing a store to a byte
which might not otherwise be stored is not allowed in general.
(Specifically, in the case where another thread might write to and read
from an address, introducing a store can change a load that may see
exactly one write into a load that may see multiple writes.)</p>
</div>
<div class="section" id="atomic-memory-ordering-constraints">
<span id="ordering"></span><h3><a class="toc-backref" href="#id1454">Atomic Memory Ordering Constraints</a><a class="headerlink" href="#atomic-memory-ordering-constraints" title="Permalink to this headline">¶</a></h3>
<p>Atomic instructions (<a class="reference internal" href="#i-cmpxchg"><span class="std std-ref">cmpxchg</span></a>,
<a class="reference internal" href="#i-atomicrmw"><span class="std std-ref">atomicrmw</span></a>, <a class="reference internal" href="#i-fence"><span class="std std-ref">fence</span></a>,
<a class="reference internal" href="#i-load"><span class="std std-ref">atomic load</span></a>, and <a class="reference internal" href="#i-store"><span class="std std-ref">atomic store</span></a>) take
ordering parameters that determine which other atomic instructions on
the same address they <em>synchronize with</em>. These semantics are borrowed
from Java and C++0x, but are somewhat more colloquial. If these
descriptions aren’t precise enough, check those specs (see spec
references in the <a class="reference internal" href="Atomics.html"><span class="doc">atomics guide</span></a>).
<a class="reference internal" href="#i-fence"><span class="std std-ref">fence</span></a> instructions treat these orderings somewhat
differently since they don’t take an address. See that instruction’s
documentation for details.</p>
<p>For a simpler introduction to the ordering constraints, see the
<a class="reference internal" href="Atomics.html"><span class="doc">LLVM Atomic Instructions and Concurrency Guide</span></a>.</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">unordered</span></code></dt><dd><p>The set of values that can be read is governed by the happens-before
partial order. A value cannot be read unless some operation wrote
it. This is intended to provide a guarantee strong enough to model
Java’s non-volatile shared variables. This ordering cannot be
specified for read-modify-write operations; it is not strong enough
to make them atomic in any interesting way.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">monotonic</span></code></dt><dd><p>In addition to the guarantees of <code class="docutils literal notranslate"><span class="pre">unordered</span></code>, there is a single
total order for modifications by <code class="docutils literal notranslate"><span class="pre">monotonic</span></code> operations on each
address. All modification orders must be compatible with the
happens-before order. There is no guarantee that the modification
orders can be combined to a global total order for the whole program
(and this often will not be possible). The read in an atomic
read-modify-write operation (<a class="reference internal" href="#i-cmpxchg"><span class="std std-ref">cmpxchg</span></a> and
<a class="reference internal" href="#i-atomicrmw"><span class="std std-ref">atomicrmw</span></a>) reads the value in the modification
order immediately before the value it writes. If one atomic read
happens before another atomic read of the same address, the later
read must see the same value or a later value in the address’s
modification order. This disallows reordering of <code class="docutils literal notranslate"><span class="pre">monotonic</span></code> (or
stronger) operations on the same address. If an address is written
<code class="docutils literal notranslate"><span class="pre">monotonic</span></code>-ally by one thread, and other threads <code class="docutils literal notranslate"><span class="pre">monotonic</span></code>-ally
read that address repeatedly, the other threads must eventually see
the write. This corresponds to the C++0x/C1x
<code class="docutils literal notranslate"><span class="pre">memory_order_relaxed</span></code>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">acquire</span></code></dt><dd><p>In addition to the guarantees of <code class="docutils literal notranslate"><span class="pre">monotonic</span></code>, a
<em>synchronizes-with</em> edge may be formed with a <code class="docutils literal notranslate"><span class="pre">release</span></code> operation.
This is intended to model C++’s <code class="docutils literal notranslate"><span class="pre">memory_order_acquire</span></code>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">release</span></code></dt><dd><p>In addition to the guarantees of <code class="docutils literal notranslate"><span class="pre">monotonic</span></code>, if this operation
writes a value which is subsequently read by an <code class="docutils literal notranslate"><span class="pre">acquire</span></code>
operation, it <em>synchronizes-with</em> that operation. (This isn’t a
complete description; see the C++0x definition of a release
sequence.) This corresponds to the C++0x/C1x
<code class="docutils literal notranslate"><span class="pre">memory_order_release</span></code>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">acq_rel</span></code> (acquire+release)</dt><dd><p>Acts as both an <code class="docutils literal notranslate"><span class="pre">acquire</span></code> and <code class="docutils literal notranslate"><span class="pre">release</span></code> operation on its
address. This corresponds to the C++0x/C1x <code class="docutils literal notranslate"><span class="pre">memory_order_acq_rel</span></code>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">seq_cst</span></code> (sequentially consistent)</dt><dd><p>In addition to the guarantees of <code class="docutils literal notranslate"><span class="pre">acq_rel</span></code> (<code class="docutils literal notranslate"><span class="pre">acquire</span></code> for an
operation that only reads, <code class="docutils literal notranslate"><span class="pre">release</span></code> for an operation that only
writes), there is a global total order on all
sequentially-consistent operations on all addresses, which is
consistent with the <em>happens-before</em> partial order and with the
modification orders of all the affected addresses. Each
sequentially-consistent read sees the last preceding write to the
same address in this global order. This corresponds to the C++0x/C1x
<code class="docutils literal notranslate"><span class="pre">memory_order_seq_cst</span></code> and Java volatile.</p>
</dd>
</dl>
<p id="syncscope">If an atomic operation is marked <code class="docutils literal notranslate"><span class="pre">syncscope("singlethread")</span></code>, it only
<em>synchronizes with</em> and only participates in the seq_cst total orderings of
other operations running in the same thread (for example, in signal handlers).</p>
<p>If an atomic operation is marked <code class="docutils literal notranslate"><span class="pre">syncscope("<target-scope>")</span></code>, where
<code class="docutils literal notranslate"><span class="pre"><target-scope></span></code> is a target specific synchronization scope, then it is target
dependent if it <em>synchronizes with</em> and participates in the seq_cst total
orderings of other operations.</p>
<p>Otherwise, an atomic operation that is not marked <code class="docutils literal notranslate"><span class="pre">syncscope("singlethread")</span></code>
or <code class="docutils literal notranslate"><span class="pre">syncscope("<target-scope>")</span></code> <em>synchronizes with</em> and participates in the
seq_cst total orderings of other operations that are not marked
<code class="docutils literal notranslate"><span class="pre">syncscope("singlethread")</span></code> or <code class="docutils literal notranslate"><span class="pre">syncscope("<target-scope>")</span></code>.</p>
</div>
<div class="section" id="floating-point-environment">
<span id="floatenv"></span><h3><a class="toc-backref" href="#id1455">Floating-Point Environment</a><a class="headerlink" href="#floating-point-environment" title="Permalink to this headline">¶</a></h3>
<p>The default LLVM floating-point environment assumes that floating-point
instructions do not have side effects. Results assume the round-to-nearest
rounding mode. No floating-point exception state is maintained in this
environment. Therefore, there is no attempt to create or preserve invalid
operation (SNaN) or division-by-zero exceptions.</p>
<p>The benefit of this exception-free assumption is that floating-point
operations may be speculated freely without any other fast-math relaxations
to the floating-point model.</p>
<p>Code that requires different behavior than this should use the
<a class="reference internal" href="#constrainedfp"><span class="std std-ref">Constrained Floating-Point Intrinsics</span></a>.</p>
</div>
<div class="section" id="fast-math-flags">
<span id="fastmath"></span><h3><a class="toc-backref" href="#id1456">Fast-Math Flags</a><a class="headerlink" href="#fast-math-flags" title="Permalink to this headline">¶</a></h3>
<p>LLVM IR floating-point operations (<a class="reference internal" href="#i-fneg"><span class="std std-ref">fneg</span></a>, <a class="reference internal" href="#i-fadd"><span class="std std-ref">fadd</span></a>,
<a class="reference internal" href="#i-fsub"><span class="std std-ref">fsub</span></a>, <a class="reference internal" href="#i-fmul"><span class="std std-ref">fmul</span></a>, <a class="reference internal" href="#i-fdiv"><span class="std std-ref">fdiv</span></a>,
<a class="reference internal" href="#i-frem"><span class="std std-ref">frem</span></a>, <a class="reference internal" href="#i-fcmp"><span class="std std-ref">fcmp</span></a>), <a class="reference internal" href="#i-phi"><span class="std std-ref">phi</span></a>,
<a class="reference internal" href="#i-select"><span class="std std-ref">select</span></a> and <a class="reference internal" href="#i-call"><span class="std std-ref">call</span></a>
may use the following flags to enable otherwise unsafe
floating-point transformations.</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">nnan</span></code></dt><dd><p>No NaNs - Allow optimizations to assume the arguments and result are not
NaN. If an argument is a nan, or the result would be a nan, it produces
a <a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a> instead.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">ninf</span></code></dt><dd><p>No Infs - Allow optimizations to assume the arguments and result are not
+/-Inf. If an argument is +/-Inf, or the result would be +/-Inf, it
produces a <a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a> instead.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">nsz</span></code></dt><dd><p>No Signed Zeros - Allow optimizations to treat the sign of a zero
argument or result as insignificant. This does not imply that -0.0
is poison and/or guaranteed to not exist in the operation.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">arcp</span></code></dt><dd><p>Allow Reciprocal - Allow optimizations to use the reciprocal of an
argument rather than perform division.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">contract</span></code></dt><dd><p>Allow floating-point contraction (e.g. fusing a multiply followed by an
addition into a fused multiply-and-add). This does not enable reassociating
to form arbitrary contractions. For example, <code class="docutils literal notranslate"><span class="pre">(a*b)</span> <span class="pre">+</span> <span class="pre">(c*d)</span> <span class="pre">+</span> <span class="pre">e</span></code> can not
be transformed into <code class="docutils literal notranslate"><span class="pre">(a*b)</span> <span class="pre">+</span> <span class="pre">((c*d)</span> <span class="pre">+</span> <span class="pre">e)</span></code> to create two fma operations.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">afn</span></code></dt><dd><p>Approximate functions - Allow substitution of approximate calculations for
functions (sin, log, sqrt, etc). See floating-point intrinsic definitions
for places where this can apply to LLVM’s intrinsic math functions.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">reassoc</span></code></dt><dd><p>Allow reassociation transformations for floating-point instructions.
This may dramatically change results in floating-point.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">fast</span></code></dt><dd><p>This flag implies all of the others.</p>
</dd>
</dl>
</div>
<div class="section" id="use-list-order-directives">
<span id="uselistorder"></span><h3><a class="toc-backref" href="#id1457">Use-list Order Directives</a><a class="headerlink" href="#use-list-order-directives" title="Permalink to this headline">¶</a></h3>
<p>Use-list directives encode the in-memory order of each use-list, allowing the
order to be recreated. <code class="docutils literal notranslate"><span class="pre"><order-indexes></span></code> is a comma-separated list of
indexes that are assigned to the referenced value’s uses. The referenced
value’s use-list is immediately sorted by these indexes.</p>
<p>Use-list directives may appear at function scope or global scope. They are not
instructions, and have no effect on the semantics of the IR. When they’re at
function scope, they must appear after the terminator of the final basic block.</p>
<p>If basic blocks have their address taken via <code class="docutils literal notranslate"><span class="pre">blockaddress()</span></code> expressions,
<code class="docutils literal notranslate"><span class="pre">uselistorder_bb</span></code> can be used to reorder their use-lists from outside their
function’s scope.</p>
<dl class="field-list simple">
<dt class="field-odd">Syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">uselistorder</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">,</span> <span class="p">{</span> <span class="o"><</span><span class="n">order</span><span class="o">-</span><span class="n">indexes</span><span class="o">></span> <span class="p">}</span>
<span class="n">uselistorder_bb</span> <span class="nd">@function</span><span class="p">,</span> <span class="o">%</span><span class="n">block</span> <span class="p">{</span> <span class="o"><</span><span class="n">order</span><span class="o">-</span><span class="n">indexes</span><span class="o">></span> <span class="p">}</span>
</pre></div>
</div>
<dl class="field-list simple">
<dt class="field-odd">Examples</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">define</span> <span class="n">void</span> <span class="nd">@foo</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">arg1</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">arg2</span><span class="p">)</span> <span class="p">{</span>
<span class="n">entry</span><span class="p">:</span>
<span class="p">;</span> <span class="o">...</span> <span class="n">instructions</span> <span class="o">...</span>
<span class="n">bb</span><span class="p">:</span>
<span class="p">;</span> <span class="o">...</span> <span class="n">instructions</span> <span class="o">...</span>
<span class="p">;</span> <span class="n">At</span> <span class="n">function</span> <span class="n">scope</span><span class="o">.</span>
<span class="n">uselistorder</span> <span class="n">i32</span> <span class="o">%</span><span class="n">arg1</span><span class="p">,</span> <span class="p">{</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">2</span> <span class="p">}</span>
<span class="n">uselistorder</span> <span class="n">label</span> <span class="o">%</span><span class="n">bb</span><span class="p">,</span> <span class="p">{</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">0</span> <span class="p">}</span>
<span class="p">}</span>
<span class="p">;</span> <span class="n">At</span> <span class="k">global</span> <span class="n">scope</span><span class="o">.</span>
<span class="n">uselistorder</span> <span class="n">i32</span><span class="o">*</span> <span class="nd">@global</span><span class="p">,</span> <span class="p">{</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">0</span> <span class="p">}</span>
<span class="n">uselistorder</span> <span class="n">i32</span> <span class="mi">7</span><span class="p">,</span> <span class="p">{</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">0</span> <span class="p">}</span>
<span class="n">uselistorder</span> <span class="n">i32</span> <span class="p">(</span><span class="n">i32</span><span class="p">)</span> <span class="nd">@bar</span><span class="p">,</span> <span class="p">{</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">0</span> <span class="p">}</span>
<span class="n">uselistorder_bb</span> <span class="nd">@foo</span><span class="p">,</span> <span class="o">%</span><span class="n">bb</span><span class="p">,</span> <span class="p">{</span> <span class="mi">5</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">3</span><span class="p">,</span> <span class="mi">2</span><span class="p">,</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">4</span> <span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="source-filename">
<span id="id3"></span><h3><a class="toc-backref" href="#id1458">Source Filename</a><a class="headerlink" href="#source-filename" title="Permalink to this headline">¶</a></h3>
<p>The <em>source filename</em> string is set to the original module identifier,
which will be the name of the compiled source file when compiling from
source through the clang front end, for example. It is then preserved through
the IR and bitcode.</p>
<p>This is currently necessary to generate a consistent unique global
identifier for local functions used in profile data, which prepends the
source file name to the local function name.</p>
<p>The syntax for the source file name is simply:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>source_filename = "/path/to/source.c"
</pre></div>
</div>
</div>
</div>
<div class="section" id="type-system">
<span id="typesystem"></span><h2><a class="toc-backref" href="#id1459">Type System</a><a class="headerlink" href="#type-system" title="Permalink to this headline">¶</a></h2>
<p>The LLVM type system is one of the most important features of the
intermediate representation. Being typed enables a number of
optimizations to be performed on the intermediate representation
directly, without having to do extra analyses on the side before the
transformation. A strong type system makes it easier to read the
generated code and enables novel analyses and transformations that are
not feasible to perform on normal three address code representations.</p>
<div class="section" id="void-type">
<span id="t-void"></span><h3><a class="toc-backref" href="#id1460">Void Type</a><a class="headerlink" href="#void-type" title="Permalink to this headline">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">Overview</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<p>The void type does not represent any value and has no size.</p>
<dl class="field-list simple">
<dt class="field-odd">Syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">void</span>
</pre></div>
</div>
</div>
<div class="section" id="function-type">
<span id="t-function"></span><h3><a class="toc-backref" href="#id1461">Function Type</a><a class="headerlink" href="#function-type" title="Permalink to this headline">¶</a></h3>
<dl class="field-list simple">
<dt class="field-odd">Overview</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<p>The function type can be thought of as a function signature. It consists of a
return type and a list of formal parameter types. The return type of a function
type is a void type or first class type — except for <a class="reference internal" href="#t-label"><span class="std std-ref">label</span></a>
and <a class="reference internal" href="#t-metadata"><span class="std std-ref">metadata</span></a> types.</p>
<dl class="field-list simple">
<dt class="field-odd">Syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">returntype</span><span class="o">></span> <span class="p">(</span><span class="o"><</span><span class="n">parameter</span> <span class="nb">list</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<p>…where ‘<code class="docutils literal notranslate"><span class="pre"><parameter</span> <span class="pre">list></span></code>’ is a comma-separated list of type
specifiers. Optionally, the parameter list may include a type <code class="docutils literal notranslate"><span class="pre">...</span></code>, which
indicates that the function takes a variable number of arguments. Variable
argument functions can access their arguments with the <a class="reference internal" href="#int-varargs"><span class="std std-ref">variable argument
handling intrinsic</span></a> functions. ‘<code class="docutils literal notranslate"><span class="pre"><returntype></span></code>’ is any type
except <a class="reference internal" href="#t-label"><span class="std std-ref">label</span></a> and <a class="reference internal" href="#t-metadata"><span class="std std-ref">metadata</span></a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Examples</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 17%" />
<col style="width: 83%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">i32</span> <span class="pre">(i32)</span></code></p></td>
<td><p>function taking an <code class="docutils literal notranslate"><span class="pre">i32</span></code>, returning an <code class="docutils literal notranslate"><span class="pre">i32</span></code></p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">float</span> <span class="pre">(i16,</span> <span class="pre">i32</span> <span class="pre">*)</span> <span class="pre">*</span></code></p></td>
<td><p><a class="reference internal" href="#t-pointer"><span class="std std-ref">Pointer</span></a> to a function that takes an <code class="docutils literal notranslate"><span class="pre">i16</span></code> and a <a class="reference internal" href="#t-pointer"><span class="std std-ref">pointer</span></a> to <code class="docutils literal notranslate"><span class="pre">i32</span></code>, returning <code class="docutils literal notranslate"><span class="pre">float</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">i32</span> <span class="pre">(i8*,</span> <span class="pre">...)</span></code></p></td>
<td><p>A vararg function that takes at least one <a class="reference internal" href="#t-pointer"><span class="std std-ref">pointer</span></a> to <code class="docutils literal notranslate"><span class="pre">i8</span></code> (char in C), which returns an integer. This is the signature for <code class="docutils literal notranslate"><span class="pre">printf</span></code> in LLVM.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">{i32,</span> <span class="pre">i32}</span> <span class="pre">(i32)</span></code></p></td>
<td><p>A function taking an <code class="docutils literal notranslate"><span class="pre">i32</span></code>, returning a <a class="reference internal" href="#t-struct"><span class="std std-ref">structure</span></a> containing two <code class="docutils literal notranslate"><span class="pre">i32</span></code> values</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="first-class-types">
<span id="t-firstclass"></span><h3><a class="toc-backref" href="#id1462">First Class Types</a><a class="headerlink" href="#first-class-types" title="Permalink to this headline">¶</a></h3>
<p>The <a class="reference internal" href="#t-firstclass"><span class="std std-ref">first class</span></a> types are perhaps the most important.
Values of these types are the only ones which can be produced by
instructions.</p>
<div class="section" id="single-value-types">
<span id="t-single-value"></span><h4><a class="toc-backref" href="#id1463">Single Value Types</a><a class="headerlink" href="#single-value-types" title="Permalink to this headline">¶</a></h4>
<p>These are the types that are valid in registers from CodeGen’s perspective.</p>
<div class="section" id="integer-type">
<span id="t-integer"></span><h5><a class="toc-backref" href="#id1464">Integer Type</a><a class="headerlink" href="#integer-type" title="Permalink to this headline">¶</a></h5>
<dl class="field-list simple">
<dt class="field-odd">Overview</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<p>The integer type is a very simple type that simply specifies an
arbitrary bit width for the integer type desired. Any bit width from 1
bit to 2<sup>23</sup>(about 8 million) can be specified.</p>
<dl class="field-list simple">
<dt class="field-odd">Syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">iN</span>
</pre></div>
</div>
<p>The number of bits the integer will occupy is specified by the <code class="docutils literal notranslate"><span class="pre">N</span></code>
value.</p>
<div class="section" id="examples">
<h6>Examples:<a class="headerlink" href="#examples" title="Permalink to this headline">¶</a></h6>
<table class="docutils align-default">
<colgroup>
<col style="width: 25%" />
<col style="width: 75%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">i1</span></code></p></td>
<td><p>a single-bit integer.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">i32</span></code></p></td>
<td><p>a 32-bit integer.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">i1942652</span></code></p></td>
<td><p>a really big integer of over 1 million bits.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="floating-point-types">
<span id="t-floating"></span><h5><a class="toc-backref" href="#id1465">Floating-Point Types</a><a class="headerlink" href="#floating-point-types" title="Permalink to this headline">¶</a></h5>
<table class="docutils align-default">
<colgroup>
<col style="width: 50%" />
<col style="width: 50%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Type</p></th>
<th class="head"><p>Description</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">half</span></code></p></td>
<td><p>16-bit floating-point value</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">bfloat</span></code></p></td>
<td><p>16-bit “brain” floating-point value (7-bit significand). Provides the
same number of exponent bits as <code class="docutils literal notranslate"><span class="pre">float</span></code>, so that it matches its dynamic
range, but with greatly reduced precision. Used in Intel’s AVX-512 BF16
extensions and Arm’s ARMv8.6-A extensions, among others.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">float</span></code></p></td>
<td><p>32-bit floating-point value</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">double</span></code></p></td>
<td><p>64-bit floating-point value</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">fp128</span></code></p></td>
<td><p>128-bit floating-point value (113-bit significand)</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">x86_fp80</span></code></p></td>
<td><p>80-bit floating-point value (X87)</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ppc_fp128</span></code></p></td>
<td><p>128-bit floating-point value (two 64-bits)</p></td>
</tr>
</tbody>
</table>
<p>The binary format of half, float, double, and fp128 correspond to the
IEEE-754-2008 specifications for binary16, binary32, binary64, and binary128
respectively.</p>
</div>
<div class="section" id="x86-amx-type">
<h5><a class="toc-backref" href="#id1466">X86_amx Type</a><a class="headerlink" href="#x86-amx-type" title="Permalink to this headline">¶</a></h5>
<dl class="field-list simple">
<dt class="field-odd">Overview</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<p>The x86_amx type represents a value held in an AMX tile register on an x86
machine. The operations allowed on it are quite limited. Only few intrinsics
are allowed: stride load and store, zero and dot product. No instruction is
allowed for this type. There are no arguments, arrays, pointers, vectors
or constants of this type.</p>
<dl class="field-list simple">
<dt class="field-odd">Syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">x86_amx</span>
</pre></div>
</div>
</div>
<div class="section" id="x86-mmx-type">
<h5><a class="toc-backref" href="#id1467">X86_mmx Type</a><a class="headerlink" href="#x86-mmx-type" title="Permalink to this headline">¶</a></h5>
<dl class="field-list simple">
<dt class="field-odd">Overview</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<p>The x86_mmx type represents a value held in an MMX register on an x86
machine. The operations allowed on it are quite limited: parameters and
return values, load and store, and bitcast. User-specified MMX
instructions are represented as intrinsic or asm calls with arguments
and/or results of this type. There are no arrays, vectors or constants
of this type.</p>
<dl class="field-list simple">
<dt class="field-odd">Syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">x86_mmx</span>
</pre></div>
</div>
</div>
<div class="section" id="pointer-type">
<span id="t-pointer"></span><h5><a class="toc-backref" href="#id1468">Pointer Type</a><a class="headerlink" href="#pointer-type" title="Permalink to this headline">¶</a></h5>
<dl class="field-list simple">
<dt class="field-odd">Overview</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<p>The pointer type is used to specify memory locations. Pointers are
commonly used to reference objects in memory.</p>
<p>Pointer types may have an optional address space attribute defining the
numbered address space where the pointed-to object resides. The default
address space is number zero. The semantics of non-zero address spaces
are target-specific.</p>
<p>Note that LLVM does not permit pointers to void (<code class="docutils literal notranslate"><span class="pre">void*</span></code>) nor does it
permit pointers to labels (<code class="docutils literal notranslate"><span class="pre">label*</span></code>). Use <code class="docutils literal notranslate"><span class="pre">i8*</span></code> instead.</p>
<p>LLVM is in the process of transitioning to
<a class="reference external" href="OpaquePointers.html#opaque-pointers">opaque pointers</a>.
Opaque pointers do not have a pointee type. Rather, instructions
interacting through pointers specify the type of the underlying memory
they are interacting with. Opaque pointers are still in the process of
being worked on and are not complete.</p>
<dl class="field-list simple">
<dt class="field-odd">Syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o">*</span>
<span class="n">ptr</span>
</pre></div>
</div>
<dl class="field-list simple">
<dt class="field-odd">Examples</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 19%" />
<col style="width: 81%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">[4</span> <span class="pre">x</span> <span class="pre">i32]*</span></code></p></td>
<td><p>A <a class="reference internal" href="#t-pointer"><span class="std std-ref">pointer</span></a> to <a class="reference internal" href="#t-array"><span class="std std-ref">array</span></a> of four <code class="docutils literal notranslate"><span class="pre">i32</span></code> values.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">i32</span> <span class="pre">(i32*)</span> <span class="pre">*</span></code></p></td>
<td><p>A <a class="reference internal" href="#t-pointer"><span class="std std-ref">pointer</span></a> to a <a class="reference internal" href="#t-function"><span class="std std-ref">function</span></a> that takes an <code class="docutils literal notranslate"><span class="pre">i32*</span></code>, returning an <code class="docutils literal notranslate"><span class="pre">i32</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">i32</span> <span class="pre">addrspace(5)*</span></code></p></td>
<td><p>A <a class="reference internal" href="#t-pointer"><span class="std std-ref">pointer</span></a> to an <code class="docutils literal notranslate"><span class="pre">i32</span></code> value that resides in address space 5.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">ptr</span></code></p></td>
<td><p>An opaque pointer type to a value that resides in address space 0.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">ptr</span> <span class="pre">addrspace(5)</span></code></p></td>
<td><p>An opaque pointer type to a value that resides in address space 5.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="vector-type">
<span id="t-vector"></span><h5><a class="toc-backref" href="#id1469">Vector Type</a><a class="headerlink" href="#vector-type" title="Permalink to this headline">¶</a></h5>
<dl class="field-list simple">
<dt class="field-odd">Overview</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<p>A vector type is a simple derived type that represents a vector of
elements. Vector types are used when multiple primitive data are
operated in parallel using a single instruction (SIMD). A vector type
requires a size (number of elements), an underlying primitive data type,
and a scalable property to represent vectors where the exact hardware
vector length is unknown at compile time. Vector types are considered
<a class="reference internal" href="#t-firstclass"><span class="std std-ref">first class</span></a>.</p>
<dl class="field-list simple">
<dt class="field-odd">Memory Layout</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<p>In general vector elements are laid out in memory in the same way as
<a class="reference internal" href="#t-array"><span class="std std-ref">array types</span></a>. Such an analogy works fine as long as the vector
elements are byte sized. However, when the elements of the vector aren’t byte
sized it gets a bit more complicated. One way to describe the layout is by
describing what happens when a vector such as <N x iM> is bitcasted to an
integer type with N*M bits, and then following the rules for storing such an
integer to memory.</p>
<p>A bitcast from a vector type to a scalar integer type will see the elements
being packed together (without padding). The order in which elements are
inserted in the integer depends on endianess. For little endian element zero
is put in the least significant bits of the integer, and for big endian
element zero is put in the most significant bits.</p>
<p>Using a vector such as <code class="docutils literal notranslate"><span class="pre"><i4</span> <span class="pre">1,</span> <span class="pre">i4</span> <span class="pre">2,</span> <span class="pre">i4</span> <span class="pre">3,</span> <span class="pre">i4</span> <span class="pre">5></span></code> as an example, together
with the analogy that we can replace a vector store by a bitcast followed by
an integer store, we get this for big endian:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%val</span> <span class="p">=</span> <span class="k">bitcast</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i4</span><span class="p">></span> <span class="p"><</span><span class="k">i4</span> <span class="m">1</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">5</span><span class="p">></span> <span class="k">to</span> <span class="k">i16</span>
<span class="c">; Bitcasting from a vector to an integral type can be seen as</span>
<span class="c">; concatenating the values:</span>
<span class="c">; %val now has the hexadecimal value 0x1235.</span>
<span class="k">store</span> <span class="k">i16</span> <span class="nv">%val</span><span class="p">,</span> <span class="k">i16</span><span class="p">*</span> <span class="nv">%ptr</span>
<span class="c">; In memory the content will be (8-bit addressing):</span>
<span class="c">;</span>
<span class="c">; [%ptr + 0]: 00010010 (0x12)</span>
<span class="c">; [%ptr + 1]: 00110101 (0x35)</span>
</pre></div>
</div>
<p>The same example for little endian:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%val</span> <span class="p">=</span> <span class="k">bitcast</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i4</span><span class="p">></span> <span class="p"><</span><span class="k">i4</span> <span class="m">1</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">5</span><span class="p">></span> <span class="k">to</span> <span class="k">i16</span>
<span class="c">; Bitcasting from a vector to an integral type can be seen as</span>
<span class="c">; concatenating the values:</span>
<span class="c">; %val now has the hexadecimal value 0x5321.</span>
<span class="k">store</span> <span class="k">i16</span> <span class="nv">%val</span><span class="p">,</span> <span class="k">i16</span><span class="p">*</span> <span class="nv">%ptr</span>
<span class="c">; In memory the content will be (8-bit addressing):</span>
<span class="c">;</span>
<span class="c">; [%ptr + 0]: 01010011 (0x53)</span>
<span class="c">; [%ptr + 1]: 00100001 (0x21)</span>
</pre></div>
</div>
<p>When <code class="docutils literal notranslate"><span class="pre"><N*M></span></code> isn’t evenly divisible by the byte size the exact memory layout
is unspecified (just like it is for an integral type of the same size). This
is because different targets could put the padding at different positions when
the type size is smaller than the type’s store size.</p>
<dl class="field-list simple">
<dt class="field-odd">Syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span> <span class="o"><</span><span class="c1"># elements> x <elementtype> > ; Fixed-length vector</span>
<span class="o"><</span> <span class="n">vscale</span> <span class="n">x</span> <span class="o"><</span><span class="c1"># elements> x <elementtype> > ; Scalable vector</span>
</pre></div>
</div>
<p>The number of elements is a constant integer value larger than 0;
elementtype may be any integer, floating-point or pointer type. Vectors
of size zero are not allowed. For scalable vectors, the total number of
elements is a constant multiple (called vscale) of the specified number
of elements; vscale is a positive integer that is unknown at compile time
and the same hardware-dependent constant for all scalable vectors at run
time. The size of a specific scalable vector type is thus constant within
IR, even if the exact size in bytes cannot be determined until run time.</p>
<dl class="field-list simple">
<dt class="field-odd">Examples</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 32%" />
<col style="width: 68%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre"><4</span> <span class="pre">x</span> <span class="pre">i32></span></code></p></td>
<td><p>Vector of 4 32-bit integer values.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre"><8</span> <span class="pre">x</span> <span class="pre">float></span></code></p></td>
<td><p>Vector of 8 32-bit floating-point values.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre"><2</span> <span class="pre">x</span> <span class="pre">i64></span></code></p></td>
<td><p>Vector of 2 64-bit integer values.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre"><4</span> <span class="pre">x</span> <span class="pre">i64*></span></code></p></td>
<td><p>Vector of 4 pointers to 64-bit integer values.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre"><vscale</span> <span class="pre">x</span> <span class="pre">4</span> <span class="pre">x</span> <span class="pre">i32></span></code></p></td>
<td><p>Vector with a multiple of 4 32-bit integer values.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="label-type">
<span id="t-label"></span><h4><a class="toc-backref" href="#id1470">Label Type</a><a class="headerlink" href="#label-type" title="Permalink to this headline">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">Overview</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<p>The label type represents code labels.</p>
<dl class="field-list simple">
<dt class="field-odd">Syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">label</span>
</pre></div>
</div>
</div>
<div class="section" id="token-type">
<span id="t-token"></span><h4><a class="toc-backref" href="#id1471">Token Type</a><a class="headerlink" href="#token-type" title="Permalink to this headline">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">Overview</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<p>The token type is used when a value is associated with an instruction
but all uses of the value must not attempt to introspect or obscure it.
As such, it is not appropriate to have a <a class="reference internal" href="#i-phi"><span class="std std-ref">phi</span></a> or
<a class="reference internal" href="#i-select"><span class="std std-ref">select</span></a> of type token.</p>
<dl class="field-list simple">
<dt class="field-odd">Syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">token</span>
</pre></div>
</div>
</div>
<div class="section" id="metadata-type">
<span id="t-metadata"></span><h4><a class="toc-backref" href="#id1472">Metadata Type</a><a class="headerlink" href="#metadata-type" title="Permalink to this headline">¶</a></h4>
<dl class="field-list simple">
<dt class="field-odd">Overview</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<p>The metadata type represents embedded metadata. No derived types may be
created from metadata except for <a class="reference internal" href="#t-function"><span class="std std-ref">function</span></a> arguments.</p>
<dl class="field-list simple">
<dt class="field-odd">Syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">metadata</span>
</pre></div>
</div>
</div>
<div class="section" id="aggregate-types">
<span id="t-aggregate"></span><h4><a class="toc-backref" href="#id1473">Aggregate Types</a><a class="headerlink" href="#aggregate-types" title="Permalink to this headline">¶</a></h4>
<p>Aggregate Types are a subset of derived types that can contain multiple
member types. <a class="reference internal" href="#t-array"><span class="std std-ref">Arrays</span></a> and <a class="reference internal" href="#t-struct"><span class="std std-ref">structs</span></a> are
aggregate types. <a class="reference internal" href="#t-vector"><span class="std std-ref">Vectors</span></a> are not considered to be
aggregate types.</p>
<div class="section" id="array-type">
<span id="t-array"></span><h5><a class="toc-backref" href="#id1474">Array Type</a><a class="headerlink" href="#array-type" title="Permalink to this headline">¶</a></h5>
<dl class="field-list simple">
<dt class="field-odd">Overview</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<p>The array type is a very simple derived type that arranges elements
sequentially in memory. The array type requires a size (number of
elements) and an underlying data type.</p>
<dl class="field-list simple">
<dt class="field-odd">Syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">[</span><span class="o"><</span><span class="c1"># elements> x <elementtype>]</span>
</pre></div>
</div>
<p>The number of elements is a constant integer value; <code class="docutils literal notranslate"><span class="pre">elementtype</span></code> may
be any type with a size.</p>
<dl class="field-list simple">
<dt class="field-odd">Examples</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 32%" />
<col style="width: 68%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">[40</span> <span class="pre">x</span> <span class="pre">i32]</span></code></p></td>
<td><p>Array of 40 32-bit integer values.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">[41</span> <span class="pre">x</span> <span class="pre">i32]</span></code></p></td>
<td><p>Array of 41 32-bit integer values.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">[4</span> <span class="pre">x</span> <span class="pre">i8]</span></code></p></td>
<td><p>Array of 4 8-bit integer values.</p></td>
</tr>
</tbody>
</table>
<p>Here are some examples of multidimensional arrays:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 67%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">[3</span> <span class="pre">x</span> <span class="pre">[4</span> <span class="pre">x</span> <span class="pre">i32]]</span></code></p></td>
<td><p>3x4 array of 32-bit integer values.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">[12</span> <span class="pre">x</span> <span class="pre">[10</span> <span class="pre">x</span> <span class="pre">float]]</span></code></p></td>
<td><p>12x10 array of single precision floating-point values.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">[2</span> <span class="pre">x</span> <span class="pre">[3</span> <span class="pre">x</span> <span class="pre">[4</span> <span class="pre">x</span> <span class="pre">i16]]]</span></code></p></td>
<td><p>2x3x4 array of 16-bit integer values.</p></td>
</tr>
</tbody>
</table>
<p>There is no restriction on indexing beyond the end of the array implied
by a static type (though there are restrictions on indexing beyond the
bounds of an allocated object in some cases). This means that
single-dimension ‘variable sized array’ addressing can be implemented in
LLVM with a zero length array type. An implementation of ‘pascal style
arrays’ in LLVM could use the type “<code class="docutils literal notranslate"><span class="pre">{</span> <span class="pre">i32,</span> <span class="pre">[0</span> <span class="pre">x</span> <span class="pre">float]}</span></code>”, for
example.</p>
</div>
<div class="section" id="structure-type">
<span id="t-struct"></span><h5><a class="toc-backref" href="#id1475">Structure Type</a><a class="headerlink" href="#structure-type" title="Permalink to this headline">¶</a></h5>
<dl class="field-list simple">
<dt class="field-odd">Overview</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<p>The structure type is used to represent a collection of data members
together in memory. The elements of a structure may be any type that has
a size.</p>
<p>Structures in memory are accessed using ‘<code class="docutils literal notranslate"><span class="pre">load</span></code>’ and ‘<code class="docutils literal notranslate"><span class="pre">store</span></code>’ by
getting a pointer to a field with the ‘<code class="docutils literal notranslate"><span class="pre">getelementptr</span></code>’ instruction.
Structures in registers are accessed using the ‘<code class="docutils literal notranslate"><span class="pre">extractvalue</span></code>’ and
‘<code class="docutils literal notranslate"><span class="pre">insertvalue</span></code>’ instructions.</p>
<p>Structures may optionally be “packed” structures, which indicate that
the alignment of the struct is one byte, and that there is no padding
between the elements. In non-packed structs, padding between field types
is inserted as defined by the DataLayout string in the module, which is
required to match what the underlying code generator expects.</p>
<p>Structures can either be “literal” or “identified”. A literal structure
is defined inline with other types (e.g. <code class="docutils literal notranslate"><span class="pre">{i32,</span> <span class="pre">i32}*</span></code>) whereas
identified types are always defined at the top level with a name.
Literal types are uniqued by their contents and can never be recursive
or opaque since there is no way to write one. Identified types can be
recursive, can be opaqued, and are never uniqued.</p>
<dl class="field-list simple">
<dt class="field-odd">Syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">T1</span> <span class="o">=</span> <span class="nb">type</span> <span class="p">{</span> <span class="o"><</span><span class="nb">type</span> <span class="nb">list</span><span class="o">></span> <span class="p">}</span> <span class="p">;</span> <span class="n">Identified</span> <span class="n">normal</span> <span class="n">struct</span> <span class="nb">type</span>
<span class="o">%</span><span class="n">T2</span> <span class="o">=</span> <span class="nb">type</span> <span class="o"><</span><span class="p">{</span> <span class="o"><</span><span class="nb">type</span> <span class="nb">list</span><span class="o">></span> <span class="p">}</span><span class="o">></span> <span class="p">;</span> <span class="n">Identified</span> <span class="n">packed</span> <span class="n">struct</span> <span class="nb">type</span>
</pre></div>
</div>
<dl class="field-list simple">
<dt class="field-odd">Examples</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 14%" />
<col style="width: 86%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">{</span> <span class="pre">i32,</span> <span class="pre">i32,</span> <span class="pre">i32</span> <span class="pre">}</span></code></p></td>
<td><p>A triple of three <code class="docutils literal notranslate"><span class="pre">i32</span></code> values</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">{</span> <span class="pre">float,</span> <span class="pre">i32</span> <span class="pre">(i32)</span> <span class="pre">*</span> <span class="pre">}</span></code></p></td>
<td><p>A pair, where the first element is a <code class="docutils literal notranslate"><span class="pre">float</span></code> and the second element is a <a class="reference internal" href="#t-pointer"><span class="std std-ref">pointer</span></a> to a <a class="reference internal" href="#t-function"><span class="std std-ref">function</span></a> that takes an <code class="docutils literal notranslate"><span class="pre">i32</span></code>, returning an <code class="docutils literal notranslate"><span class="pre">i32</span></code>.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre"><{</span> <span class="pre">i8,</span> <span class="pre">i32</span> <span class="pre">}></span></code></p></td>
<td><p>A packed struct known to be 5 bytes in size.</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="opaque-structure-types">
<span id="t-opaque"></span><h5><a class="toc-backref" href="#id1476">Opaque Structure Types</a><a class="headerlink" href="#opaque-structure-types" title="Permalink to this headline">¶</a></h5>
<dl class="field-list simple">
<dt class="field-odd">Overview</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<p>Opaque structure types are used to represent structure types that
do not have a body specified. This corresponds (for example) to the C
notion of a forward declared structure. They can be named (<code class="docutils literal notranslate"><span class="pre">%X</span></code>) or
unnamed (<code class="docutils literal notranslate"><span class="pre">%52</span></code>).</p>
<dl class="field-list simple">
<dt class="field-odd">Syntax</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">X</span> <span class="o">=</span> <span class="nb">type</span> <span class="n">opaque</span>
<span class="o">%</span><span class="mi">52</span> <span class="o">=</span> <span class="nb">type</span> <span class="n">opaque</span>
</pre></div>
</div>
<dl class="field-list simple">
<dt class="field-odd">Examples</dt>
<dd class="field-odd"><p></p></dd>
</dl>
<table class="docutils align-default">
<colgroup>
<col style="width: 42%" />
<col style="width: 58%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">opaque</span></code></p></td>
<td><p>An opaque type.</p></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div class="section" id="constants">
<span id="id4"></span><h2><a class="toc-backref" href="#id1477">Constants</a><a class="headerlink" href="#constants" title="Permalink to this headline">¶</a></h2>
<p>LLVM has several different basic types of constants. This section
describes them all and their syntax.</p>
<div class="section" id="simple-constants">
<h3><a class="toc-backref" href="#id1478">Simple Constants</a><a class="headerlink" href="#simple-constants" title="Permalink to this headline">¶</a></h3>
<dl class="simple">
<dt><strong>Boolean constants</strong></dt><dd><p>The two strings ‘<code class="docutils literal notranslate"><span class="pre">true</span></code>’ and ‘<code class="docutils literal notranslate"><span class="pre">false</span></code>’ are both valid constants
of the <code class="docutils literal notranslate"><span class="pre">i1</span></code> type.</p>
</dd>
<dt><strong>Integer constants</strong></dt><dd><p>Standard integers (such as ‘4’) are constants of the
<a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> type. Negative numbers may be used with
integer types.</p>
</dd>
<dt><strong>Floating-point constants</strong></dt><dd><p>Floating-point constants use standard decimal notation (e.g.
123.421), exponential notation (e.g. 1.23421e+2), or a more precise
hexadecimal notation (see below). The assembler requires the exact
decimal value of a floating-point constant. For example, the
assembler accepts 1.25 but rejects 1.3 because 1.3 is a repeating
decimal in binary. Floating-point constants must have a
<a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> type.</p>
</dd>
<dt><strong>Null pointer constants</strong></dt><dd><p>The identifier ‘<code class="docutils literal notranslate"><span class="pre">null</span></code>’ is recognized as a null pointer constant
and must be of <a class="reference internal" href="#t-pointer"><span class="std std-ref">pointer type</span></a>.</p>
</dd>
<dt><strong>Token constants</strong></dt><dd><p>The identifier ‘<code class="docutils literal notranslate"><span class="pre">none</span></code>’ is recognized as an empty token constant
and must be of <a class="reference internal" href="#t-token"><span class="std std-ref">token type</span></a>.</p>
</dd>
</dl>
<p>The one non-intuitive notation for constants is the hexadecimal form of
floating-point constants. For example, the form
‘<code class="docutils literal notranslate"><span class="pre">double</span>    <span class="pre">0x432ff973cafa8000</span></code>’ is equivalent to (but harder to read
than) ‘<code class="docutils literal notranslate"><span class="pre">double</span> <span class="pre">4.5e+15</span></code>’. The only time hexadecimal floating-point
constants are required (and the only time that they are generated by the
disassembler) is when a floating-point constant must be emitted but it
cannot be represented as a decimal floating-point number in a reasonable
number of digits. For example, NaN’s, infinities, and other special
values are represented in their IEEE hexadecimal format so that assembly
and disassembly do not cause any bits to change in the constants.</p>
<p>When using the hexadecimal form, constants of types bfloat, half, float, and
double are represented using the 16-digit form shown above (which matches the
IEEE754 representation for double); bfloat, half and float values must, however,
be exactly representable as bfloat, IEEE 754 half, and IEEE 754 single
precision respectively. Hexadecimal format is always used for long double, and
there are three forms of long double. The 80-bit format used by x86 is
represented as <code class="docutils literal notranslate"><span class="pre">0xK</span></code> followed by 20 hexadecimal digits. The 128-bit format
used by PowerPC (two adjacent doubles) is represented by <code class="docutils literal notranslate"><span class="pre">0xM</span></code> followed by 32
hexadecimal digits. The IEEE 128-bit format is represented by <code class="docutils literal notranslate"><span class="pre">0xL</span></code> followed
by 32 hexadecimal digits. Long doubles will only work if they match the long
double format on your target. The IEEE 16-bit format (half precision) is
represented by <code class="docutils literal notranslate"><span class="pre">0xH</span></code> followed by 4 hexadecimal digits. The bfloat 16-bit
format is represented by <code class="docutils literal notranslate"><span class="pre">0xR</span></code> followed by 4 hexadecimal digits. All
hexadecimal formats are big-endian (sign bit at the left).</p>
<p>There are no constants of type x86_mmx and x86_amx.</p>
</div>
<div class="section" id="complex-constants">
<span id="complexconstants"></span><h3><a class="toc-backref" href="#id1479">Complex Constants</a><a class="headerlink" href="#complex-constants" title="Permalink to this headline">¶</a></h3>
<p>Complex constants are a (potentially recursive) combination of simple
constants and smaller complex constants.</p>
<dl class="simple">
<dt><strong>Structure constants</strong></dt><dd><p>Structure constants are represented with notation similar to
structure type definitions (a comma separated list of elements,
surrounded by braces (<code class="docutils literal notranslate"><span class="pre">{}</span></code>)). For example:
“<code class="docutils literal notranslate"><span class="pre">{</span> <span class="pre">i32</span> <span class="pre">4,</span> <span class="pre">float</span> <span class="pre">17.0,</span> <span class="pre">i32*</span> <span class="pre">@G</span> <span class="pre">}</span></code>”, where “<code class="docutils literal notranslate"><span class="pre">@G</span></code>” is declared as
“<code class="docutils literal notranslate"><span class="pre">@G</span> <span class="pre">=</span> <span class="pre">external</span> <span class="pre">global</span> <span class="pre">i32</span></code>”. Structure constants must have
<a class="reference internal" href="#t-struct"><span class="std std-ref">structure type</span></a>, and the number and types of elements
must match those specified by the type.</p>
</dd>
<dt><strong>Array constants</strong></dt><dd><p>Array constants are represented with notation similar to array type
definitions (a comma separated list of elements, surrounded by
square brackets (<code class="docutils literal notranslate"><span class="pre">[]</span></code>)). For example:
“<code class="docutils literal notranslate"><span class="pre">[</span> <span class="pre">i32</span> <span class="pre">42,</span> <span class="pre">i32</span> <span class="pre">11,</span> <span class="pre">i32</span> <span class="pre">74</span> <span class="pre">]</span></code>”. Array constants must have
<a class="reference internal" href="#t-array"><span class="std std-ref">array type</span></a>, and the number and types of elements must
match those specified by the type. As a special case, character array
constants may also be represented as a double-quoted string using the <code class="docutils literal notranslate"><span class="pre">c</span></code>
prefix. For example: “<code class="docutils literal notranslate"><span class="pre">c"Hello</span> <span class="pre">World\0A\00"</span></code>”.</p>
</dd>
<dt><strong>Vector constants</strong></dt><dd><p>Vector constants are represented with notation similar to vector
type definitions (a comma separated list of elements, surrounded by
less-than/greater-than’s (<code class="docutils literal notranslate"><span class="pre"><></span></code>)). For example:
“<code class="docutils literal notranslate"><span class="pre"><</span> <span class="pre">i32</span> <span class="pre">42,</span> <span class="pre">i32</span> <span class="pre">11,</span> <span class="pre">i32</span> <span class="pre">74,</span> <span class="pre">i32</span> <span class="pre">100</span> <span class="pre">></span></code>”. Vector constants
must have <a class="reference internal" href="#t-vector"><span class="std std-ref">vector type</span></a>, and the number and types of
elements must match those specified by the type.</p>
</dd>
<dt><strong>Zero initialization</strong></dt><dd><p>The string ‘<code class="docutils literal notranslate"><span class="pre">zeroinitializer</span></code>’ can be used to zero initialize a
value to zero of <em>any</em> type, including scalar and
<a class="reference internal" href="#t-aggregate"><span class="std std-ref">aggregate</span></a> types. This is often used to avoid
having to print large zero initializers (e.g. for large arrays) and
is always exactly equivalent to using explicit zero initializers.</p>
</dd>
<dt><strong>Metadata node</strong></dt><dd><p>A metadata node is a constant tuple without types. For example:
“<code class="docutils literal notranslate"><span class="pre">!{!0,</span> <span class="pre">!{!2,</span> <span class="pre">!0},</span> <span class="pre">!"test"}</span></code>”. Metadata can reference constant values,
for example: “<code class="docutils literal notranslate"><span class="pre">!{!0,</span> <span class="pre">i32</span> <span class="pre">0,</span> <span class="pre">i8*</span> <span class="pre">@global,</span> <span class="pre">i64</span> <span class="pre">(i64)*</span> <span class="pre">@function,</span> <span class="pre">!"str"}</span></code>”.
Unlike other typed constants that are meant to be interpreted as part of
the instruction stream, metadata is a place to attach additional
information such as debug info.</p>
</dd>
</dl>
</div>
<div class="section" id="global-variable-and-function-addresses">
<h3><a class="toc-backref" href="#id1480">Global Variable and Function Addresses</a><a class="headerlink" href="#global-variable-and-function-addresses" title="Permalink to this headline">¶</a></h3>
<p>The addresses of <a class="reference internal" href="#globalvars"><span class="std std-ref">global variables</span></a> and
<a class="reference internal" href="#functionstructure"><span class="std std-ref">functions</span></a> are always implicitly valid
(link-time) constants. These constants are explicitly referenced when
the <a class="reference internal" href="#identifiers"><span class="std std-ref">identifier for the global</span></a> is used and always have
<a class="reference internal" href="#t-pointer"><span class="std std-ref">pointer</span></a> type. For example, the following is a legal LLVM
file:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="vg">@X</span> <span class="p">=</span> <span class="k">global</span> <span class="k">i32</span> <span class="m">17</span>
<span class="vg">@Y</span> <span class="p">=</span> <span class="k">global</span> <span class="k">i32</span> <span class="m">42</span>
<span class="vg">@Z</span> <span class="p">=</span> <span class="k">global</span> <span class="p">[</span><span class="m">2</span> <span class="k">x</span> <span class="k">i32</span><span class="p">*]</span> <span class="p">[</span> <span class="k">i32</span><span class="p">*</span> <span class="vg">@X</span><span class="p">,</span> <span class="k">i32</span><span class="p">*</span> <span class="vg">@Y</span> <span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="undefined-values">
<span id="undefvalues"></span><h3><a class="toc-backref" href="#id1481">Undefined Values</a><a class="headerlink" href="#undefined-values" title="Permalink to this headline">¶</a></h3>
<p>The string ‘<code class="docutils literal notranslate"><span class="pre">undef</span></code>’ can be used anywhere a constant is expected, and
indicates that the user of the value may receive an unspecified
bit-pattern. Undefined values may be of any type (other than ‘<code class="docutils literal notranslate"><span class="pre">label</span></code>’
or ‘<code class="docutils literal notranslate"><span class="pre">void</span></code>’) and be used anywhere a constant is permitted.</p>
<p>Undefined values are useful because they indicate to the compiler that
the program is well defined no matter what value is used. This gives the
compiler more freedom to optimize. Here are some examples of
(potentially surprising) transformations that are valid (in pseudo IR):</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span> <span class="nv">%A</span> <span class="p">=</span> <span class="k">add</span> <span class="nv">%X</span><span class="p">,</span> <span class="k">undef</span>
<span class="nv">%B</span> <span class="p">=</span> <span class="k">sub</span> <span class="nv">%X</span><span class="p">,</span> <span class="k">undef</span>
<span class="nv">%C</span> <span class="p">=</span> <span class="k">xor</span> <span class="nv">%X</span><span class="p">,</span> <span class="k">undef</span>
<span class="nl">Safe:</span>
<span class="nv">%A</span> <span class="p">=</span> <span class="k">undef</span>
<span class="nv">%B</span> <span class="p">=</span> <span class="k">undef</span>
<span class="nv">%C</span> <span class="p">=</span> <span class="k">undef</span>
</pre></div>
</div>
<p>This is safe because all of the output bits are affected by the undef
bits. Any output bit can have a zero or one depending on the input bits.</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span> <span class="nv">%A</span> <span class="p">=</span> <span class="k">or</span> <span class="nv">%X</span><span class="p">,</span> <span class="k">undef</span>
<span class="nv">%B</span> <span class="p">=</span> <span class="k">and</span> <span class="nv">%X</span><span class="p">,</span> <span class="k">undef</span>
<span class="nl">Safe:</span>
<span class="nv">%A</span> <span class="p">=</span> <span class="m">-1</span>
<span class="nv">%B</span> <span class="p">=</span> <span class="m">0</span>
<span class="nl">Safe:</span>
<span class="nv">%A</span> <span class="p">=</span> <span class="nv">%X</span> <span class="c">;; By choosing undef as 0</span>
<span class="nv">%B</span> <span class="p">=</span> <span class="nv">%X</span> <span class="c">;; By choosing undef as -1</span>
<span class="nl">Unsafe:</span>
<span class="nv">%A</span> <span class="p">=</span> <span class="k">undef</span>
<span class="nv">%B</span> <span class="p">=</span> <span class="k">undef</span>
</pre></div>
</div>
<p>These logical operations have bits that are not always affected by the
input. For example, if <code class="docutils literal notranslate"><span class="pre">%X</span></code> has a zero bit, then the output of the
‘<code class="docutils literal notranslate"><span class="pre">and</span></code>’ operation will always be a zero for that bit, no matter what
the corresponding bit from the ‘<code class="docutils literal notranslate"><span class="pre">undef</span></code>’ is. As such, it is unsafe to
optimize or assume that the result of the ‘<code class="docutils literal notranslate"><span class="pre">and</span></code>’ is ‘<code class="docutils literal notranslate"><span class="pre">undef</span></code>’.
However, it is safe to assume that all bits of the ‘<code class="docutils literal notranslate"><span class="pre">undef</span></code>’ could be
0, and optimize the ‘<code class="docutils literal notranslate"><span class="pre">and</span></code>’ to 0. Likewise, it is safe to assume that
all the bits of the ‘<code class="docutils literal notranslate"><span class="pre">undef</span></code>’ operand to the ‘<code class="docutils literal notranslate"><span class="pre">or</span></code>’ could be set,
allowing the ‘<code class="docutils literal notranslate"><span class="pre">or</span></code>’ to be folded to -1.</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span> <span class="nv">%A</span> <span class="p">=</span> <span class="k">select</span> <span class="k">undef</span><span class="p">,</span> <span class="nv">%X</span><span class="p">,</span> <span class="nv">%Y</span>
<span class="nv">%B</span> <span class="p">=</span> <span class="k">select</span> <span class="k">undef</span><span class="p">,</span> <span class="m">42</span><span class="p">,</span> <span class="nv">%Y</span>
<span class="nv">%C</span> <span class="p">=</span> <span class="k">select</span> <span class="nv">%X</span><span class="p">,</span> <span class="nv">%Y</span><span class="p">,</span> <span class="k">undef</span>
<span class="nl">Safe:</span>
<span class="nv">%A</span> <span class="p">=</span> <span class="nv">%X</span> <span class="p">(</span><span class="k">or</span> <span class="nv">%Y</span><span class="p">)</span>
<span class="nv">%B</span> <span class="p">=</span> <span class="m">42</span> <span class="p">(</span><span class="k">or</span> <span class="nv">%Y</span><span class="p">)</span>
<span class="nv">%C</span> <span class="p">=</span> <span class="nv">%Y</span>
<span class="nl">Unsafe:</span>
<span class="nv">%A</span> <span class="p">=</span> <span class="k">undef</span>
<span class="nv">%B</span> <span class="p">=</span> <span class="k">undef</span>
<span class="nv">%C</span> <span class="p">=</span> <span class="k">undef</span>
</pre></div>
</div>
<p>This set of examples shows that undefined ‘<code class="docutils literal notranslate"><span class="pre">select</span></code>’ (and conditional
branch) conditions can go <em>either way</em>, but they have to come from one
of the two operands. In the <code class="docutils literal notranslate"><span class="pre">%A</span></code> example, if <code class="docutils literal notranslate"><span class="pre">%X</span></code> and <code class="docutils literal notranslate"><span class="pre">%Y</span></code> were
both known to have a clear low bit, then <code class="docutils literal notranslate"><span class="pre">%A</span></code> would have to have a
cleared low bit. However, in the <code class="docutils literal notranslate"><span class="pre">%C</span></code> example, the optimizer is
allowed to assume that the ‘<code class="docutils literal notranslate"><span class="pre">undef</span></code>’ operand could be the same as
<code class="docutils literal notranslate"><span class="pre">%Y</span></code>, allowing the whole ‘<code class="docutils literal notranslate"><span class="pre">select</span></code>’ to be eliminated.</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span> %A = xor undef, undef
%B = undef
%C = xor %B, %B
%D = undef
%E = icmp slt %D, 4
%F = icmp gte %D, 4
Safe:
%A = undef
%B = undef
%C = undef
%D = undef
%E = undef
%F = undef
</pre></div>
</div>
<p>This example points out that two ‘<code class="docutils literal notranslate"><span class="pre">undef</span></code>’ operands are not
necessarily the same. This can be surprising to people (and also matches
C semantics) where they assume that “<code class="docutils literal notranslate"><span class="pre">X^X</span></code>” is always zero, even if
<code class="docutils literal notranslate"><span class="pre">X</span></code> is undefined. This isn’t true for a number of reasons, but the
short answer is that an ‘<code class="docutils literal notranslate"><span class="pre">undef</span></code>’ “variable” can arbitrarily change
its value over its “live range”. This is true because the variable
doesn’t actually <em>have a live range</em>. Instead, the value is logically
read from arbitrary registers that happen to be around when needed, so
the value is not necessarily consistent over time. In fact, <code class="docutils literal notranslate"><span class="pre">%A</span></code> and
<code class="docutils literal notranslate"><span class="pre">%C</span></code> need to have the same semantics or the core LLVM “replace all
uses with” concept would not hold.</p>
<p>To ensure all uses of a given register observe the same value (even if
‘<code class="docutils literal notranslate"><span class="pre">undef</span></code>’), the <a class="reference internal" href="#i-freeze"><span class="std std-ref">freeze instruction</span></a> can be used.</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span> <span class="nv">%A</span> <span class="p">=</span> <span class="k">sdiv</span> <span class="k">undef</span><span class="p">,</span> <span class="nv">%X</span>
<span class="nv">%B</span> <span class="p">=</span> <span class="k">sdiv</span> <span class="nv">%X</span><span class="p">,</span> <span class="k">undef</span>
<span class="nl">Safe:</span>
<span class="nv">%A</span> <span class="p">=</span> <span class="m">0</span>
<span class="nl">b:</span> <span class="k">unreachable</span>
</pre></div>
</div>
<p>These examples show the crucial difference between an <em>undefined value</em>
and <em>undefined behavior</em>. An undefined value (like ‘<code class="docutils literal notranslate"><span class="pre">undef</span></code>’) is
allowed to have an arbitrary bit-pattern. This means that the <code class="docutils literal notranslate"><span class="pre">%A</span></code>
operation can be constant folded to ‘<code class="docutils literal notranslate"><span class="pre">0</span></code>’, because the ‘<code class="docutils literal notranslate"><span class="pre">undef</span></code>’
could be zero, and zero divided by any value is zero.
However, in the second example, we can make a more aggressive
assumption: because the <code class="docutils literal notranslate"><span class="pre">undef</span></code> is allowed to be an arbitrary value,
we are allowed to assume that it could be zero. Since a divide by zero
has <em>undefined behavior</em>, we are allowed to assume that the operation
does not execute at all. This allows us to delete the divide and all
code after it. Because the undefined operation “can’t happen”, the
optimizer can assume that it occurs in dead code.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>a: store undef -> %X
b: store %X -> undef
Safe:
a: <deleted>
b: unreachable
</pre></div>
</div>
<p>A store <em>of</em> an undefined value can be assumed to not have any effect;
we can assume that the value is overwritten with bits that happen to
match what was already there. However, a store <em>to</em> an undefined
location could clobber arbitrary memory, therefore, it has undefined
behavior.</p>
<p>Branching on an undefined value is undefined behavior.
This explains optimizations that depend on branch conditions to construct
predicates, such as Correlated Value Propagation and Global Value Numbering.
In case of switch instruction, the branch condition should be frozen, otherwise
it is undefined behavior.</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span>Unsafe:
br undef, BB1, BB2 ; UB
%X = and i32 undef, 255
switch %X, label %ret [ .. ] ; UB
store undef, i8* %ptr
%X = load i8* %ptr ; %X is undef
switch i8 %X, label %ret [ .. ] ; UB
Safe:
%X = or i8 undef, 255 ; always 255
switch i8 %X, label %ret [ .. ] ; Well-defined
%X = freeze i1 undef
br %X, BB1, BB2 ; Well-defined (non-deterministic jump)
</pre></div>
</div>
<p>This is also consistent with the behavior of MemorySanitizer.
MemorySanitizer, detector of uses of uninitialized memory,
defines a branch with condition that depends on an undef value (or
certain other values, like e.g. a result of a load from heap-allocated
memory that has never been stored to) to have an externally visible
side effect. For this reason functions with <em>sanitize_memory</em>
attribute are not allowed to produce such branches “out of thin
air”. More strictly, an optimization that inserts a conditional branch
is only valid if in all executions where the branch condition has at
least one undefined bit, the same branch condition is evaluated in the
input IR as well.</p>
</div>
<div class="section" id="poison-values">
<span id="poisonvalues"></span><h3><a class="toc-backref" href="#id1482">Poison Values</a><a class="headerlink" href="#poison-values" title="Permalink to this headline">¶</a></h3>
<p>A poison value is a result of an erroneous operation.
In order to facilitate speculative execution, many instructions do not
invoke immediate undefined behavior when provided with illegal operands,
and return a poison value instead.
The string ‘<code class="docutils literal notranslate"><span class="pre">poison</span></code>’ can be used anywhere a constant is expected, and
operations such as <a class="reference internal" href="#i-add"><span class="std std-ref">add</span></a> with the <code class="docutils literal notranslate"><span class="pre">nsw</span></code> flag can produce
a poison value.</p>
<p>Poison value behavior is defined in terms of value <em>dependence</em>:</p>
<ul class="simple">
<li><p>Values other than <a class="reference internal" href="#i-phi"><span class="std std-ref">phi</span></a> nodes, <a class="reference internal" href="#i-select"><span class="std std-ref">select</span></a>, and
<a class="reference internal" href="#i-freeze"><span class="std std-ref">freeze</span></a> instructions depend on their operands.</p></li>
<li><p><a class="reference internal" href="#i-phi"><span class="std std-ref">Phi</span></a> nodes depend on the operand corresponding to
their dynamic predecessor basic block.</p></li>
<li><p><a class="reference internal" href="#i-select"><span class="std std-ref">Select</span></a> instructions depend on their condition operand and
their selected operand.</p></li>
<li><p>Function arguments depend on the corresponding actual argument values
in the dynamic callers of their functions.</p></li>
<li><p><a class="reference internal" href="#i-call"><span class="std std-ref">Call</span></a> instructions depend on the <a class="reference internal" href="#i-ret"><span class="std std-ref">ret</span></a>
instructions that dynamically transfer control back to them.</p></li>
<li><p><a class="reference internal" href="#i-invoke"><span class="std std-ref">Invoke</span></a> instructions depend on the
<a class="reference internal" href="#i-ret"><span class="std std-ref">ret</span></a>, <a class="reference internal" href="#i-resume"><span class="std std-ref">resume</span></a>, or exception-throwing
call instructions that dynamically transfer control back to them.</p></li>
<li><p>Non-volatile loads and stores depend on the most recent stores to all
of the referenced memory addresses, following the order in the IR
(including loads and stores implied by intrinsics such as
<a class="reference internal" href="#int-memcpy"><span class="std std-ref">@llvm.memcpy</span></a>.)</p></li>
<li><p>An instruction with externally visible side effects depends on the
most recent preceding instruction with externally visible side
effects, following the order in the IR. (This includes <a class="reference internal" href="#volatile"><span class="std std-ref">volatile
operations</span></a>.)</p></li>
<li><p>An instruction <em>control-depends</em> on a <a class="reference internal" href="#terminators"><span class="std std-ref">terminator
instruction</span></a> if the terminator instruction has
multiple successors and the instruction is always executed when
control transfers to one of the successors, and may not be executed
when control is transferred to another.</p></li>
<li><p>Additionally, an instruction also <em>control-depends</em> on a terminator
instruction if the set of instructions it otherwise depends on would
be different if the terminator had transferred control to a different
successor.</p></li>
<li><p>Dependence is transitive.</p></li>
<li><p>Vector elements may be independently poisoned. Therefore, transforms
on instructions such as shufflevector must be careful to propagate
poison across values or elements only as allowed by the original code.</p></li>
</ul>
<p>An instruction that <em>depends</em> on a poison value, produces a poison value
itself. A poison value may be relaxed into an
<a class="reference internal" href="#undefvalues"><span class="std std-ref">undef value</span></a>, which takes an arbitrary bit-pattern.
Propagation of poison can be stopped with the
<a class="reference internal" href="#i-freeze"><span class="std std-ref">freeze instruction</span></a>.</p>
<p>This means that immediate undefined behavior occurs if a poison value is
used as an instruction operand that has any values that trigger undefined
behavior. Notably this includes (but is not limited to):</p>
<ul class="simple">
<li><p>The pointer operand of a <a class="reference internal" href="#i-load"><span class="std std-ref">load</span></a>, <a class="reference internal" href="#i-store"><span class="std std-ref">store</span></a> or
any other pointer dereferencing instruction (independent of address
space).</p></li>
<li><p>The divisor operand of a <code class="docutils literal notranslate"><span class="pre">udiv</span></code>, <code class="docutils literal notranslate"><span class="pre">sdiv</span></code>, <code class="docutils literal notranslate"><span class="pre">urem</span></code> or <code class="docutils literal notranslate"><span class="pre">srem</span></code>
instruction.</p></li>
<li><p>The condition operand of a <a class="reference internal" href="#i-br"><span class="std std-ref">br</span></a> instruction.</p></li>
<li><p>The callee operand of a <a class="reference internal" href="#i-call"><span class="std std-ref">call</span></a> or <a class="reference internal" href="#i-invoke"><span class="std std-ref">invoke</span></a>
instruction.</p></li>
<li><p>The parameter operand of a <a class="reference internal" href="#i-call"><span class="std std-ref">call</span></a> or <a class="reference internal" href="#i-invoke"><span class="std std-ref">invoke</span></a>
instruction, when the function or invoking call site has a <code class="docutils literal notranslate"><span class="pre">noundef</span></code>
attribute in the corresponding position.</p></li>
<li><p>The operand of a <a class="reference internal" href="#i-ret"><span class="std std-ref">ret</span></a> instruction if the function or invoking
call site has a <cite>noundef</cite> attribute in the return value position.</p></li>
</ul>
<p>Here are some examples:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span>entry:
%poison = sub nuw i32 0, 1 ; Results in a poison value.
%poison2 = sub i32 poison, 1 ; Also results in a poison value.
%still_poison = and i32 %poison, 0 ; 0, but also poison.
%poison_yet_again = getelementptr i32, i32* @h, i32 %still_poison
store i32 0, i32* %poison_yet_again ; Undefined behavior due to
; store to poison.
store i32 %poison, i32* @g ; Poison value stored to memory.
%poison3 = load i32, i32* @g ; Poison value loaded back from memory.
%narrowaddr = bitcast i32* @g to i16*
%wideaddr = bitcast i32* @g to i64*
%poison4 = load i16, i16* %narrowaddr ; Returns a poison value.
%poison5 = load i64, i64* %wideaddr ; Returns a poison value.
%cmp = icmp slt i32 %poison, 0 ; Returns a poison value.
br i1 %cmp, label %end, label %end ; undefined behavior
end:
</pre></div>
</div>
</div>
<div class="section" id="well-defined-values">
<span id="welldefinedvalues"></span><h3><a class="toc-backref" href="#id1483">Well-Defined Values</a><a class="headerlink" href="#well-defined-values" title="Permalink to this headline">¶</a></h3>
<p>Given a program execution, a value is <em>well defined</em> if the value does not
have an undef bit and is not poison in the execution.
An aggregate value or vector is well defined if its elements are well defined.
The padding of an aggregate isn’t considered, since it isn’t visible
without storing it into memory and loading it with a different type.</p>
<p>A constant of a <a class="reference internal" href="#t-single-value"><span class="std std-ref">single value</span></a>, non-vector type is well
defined if it is neither ‘<code class="docutils literal notranslate"><span class="pre">undef</span></code>’ constant nor ‘<code class="docutils literal notranslate"><span class="pre">poison</span></code>’ constant.
The result of <a class="reference internal" href="#i-freeze"><span class="std std-ref">freeze instruction</span></a> is well defined regardless
of its operand.</p>
</div>
<div class="section" id="addresses-of-basic-blocks">
<span id="blockaddress"></span><h3><a class="toc-backref" href="#id1484">Addresses of Basic Blocks</a><a class="headerlink" href="#addresses-of-basic-blocks" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">blockaddress(@function,</span> <span class="pre">%block)</span></code></p>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">blockaddress</span></code>’ constant computes the address of the specified
basic block in the specified function.</p>
<p>It always has an <code class="docutils literal notranslate"><span class="pre">i8</span> <span class="pre">addrspace(P)*</span></code> type, where <code class="docutils literal notranslate"><span class="pre">P</span></code> is the address space
of the function containing <code class="docutils literal notranslate"><span class="pre">%block</span></code> (usually <code class="docutils literal notranslate"><span class="pre">addrspace(0)</span></code>).</p>
<p>Taking the address of the entry block is illegal.</p>
<p>This value only has defined behavior when used as an operand to the
‘<a class="reference internal" href="#i-indirectbr"><span class="std std-ref">indirectbr</span></a>’ or ‘<a class="reference internal" href="#i-callbr"><span class="std std-ref">callbr</span></a>’instruction, or
for comparisons against null. Pointer equality tests between labels addresses
results in undefined behavior — though, again, comparison against null is ok,
and no label is equal to the null pointer. This may be passed around as an
opaque pointer sized value as long as the bits are not inspected. This
allows <code class="docutils literal notranslate"><span class="pre">ptrtoint</span></code> and arithmetic to be performed on these values so
long as the original value is reconstituted before the <code class="docutils literal notranslate"><span class="pre">indirectbr</span></code> or
<code class="docutils literal notranslate"><span class="pre">callbr</span></code> instruction.</p>
<p>Finally, some targets may provide defined semantics when using the value
as the operand to an inline assembly, but that is target specific.</p>
</div>
<div class="section" id="dso-local-equivalent">
<span id="id5"></span><h3><a class="toc-backref" href="#id1485">DSO Local Equivalent</a><a class="headerlink" href="#dso-local-equivalent" title="Permalink to this headline">¶</a></h3>
<p><code class="docutils literal notranslate"><span class="pre">dso_local_equivalent</span> <span class="pre">@func</span></code></p>
<p>A ‘<code class="docutils literal notranslate"><span class="pre">dso_local_equivalent</span></code>’ constant represents a function which is
functionally equivalent to a given function, but is always defined in the
current linkage unit. The resulting pointer has the same type as the underlying
function. The resulting pointer is permitted, but not required, to be different
from a pointer to the function, and it may have different values in different
translation units.</p>
<p>The target function may not have <code class="docutils literal notranslate"><span class="pre">extern_weak</span></code> linkage.</p>
<p><code class="docutils literal notranslate"><span class="pre">dso_local_equivalent</span></code> can be implemented as such:</p>
<ul class="simple">
<li><p>If the function has local linkage, hidden visibility, or is
<code class="docutils literal notranslate"><span class="pre">dso_local</span></code>, <code class="docutils literal notranslate"><span class="pre">dso_local_equivalent</span></code> can be implemented as simply a pointer
to the function.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">dso_local_equivalent</span></code> can be implemented with a stub that tail-calls the
function. Many targets support relocations that resolve at link time to either
a function or a stub for it, depending on if the function is defined within the
linkage unit; LLVM will use this when available. (This is commonly called a
“PLT stub”.) On other targets, the stub may need to be emitted explicitly.</p></li>
</ul>
<p>This can be used wherever a <code class="docutils literal notranslate"><span class="pre">dso_local</span></code> instance of a function is needed without
needing to explicitly make the original function <code class="docutils literal notranslate"><span class="pre">dso_local</span></code>. An instance where
this can be used is for static offset calculations between a function and some other
<code class="docutils literal notranslate"><span class="pre">dso_local</span></code> symbol. This is especially useful for the Relative VTables C++ ABI,
where dynamic relocations for function pointers in VTables can be replaced with
static relocations for offsets between the VTable and virtual functions which
may not be <code class="docutils literal notranslate"><span class="pre">dso_local</span></code>.</p>
<p>This is currently only supported for ELF binary formats.</p>
</div>
<div class="section" id="constant-expressions">
<span id="constantexprs"></span><h3><a class="toc-backref" href="#id1486">Constant Expressions</a><a class="headerlink" href="#constant-expressions" title="Permalink to this headline">¶</a></h3>
<p>Constant expressions are used to allow expressions involving other
constants to be used as constants. Constant expressions may be of any
<a class="reference internal" href="#t-firstclass"><span class="std std-ref">first class</span></a> type and may involve any LLVM operation
that does not have side effects (e.g. load and call are not supported).
The following is the syntax for constant expressions:</p>
<dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">trunc</span> <span class="pre">(CST</span> <span class="pre">to</span> <span class="pre">TYPE)</span></code></dt><dd><p>Perform the <a class="reference internal" href="#i-trunc"><span class="std std-ref">trunc operation</span></a> on constants.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">zext</span> <span class="pre">(CST</span> <span class="pre">to</span> <span class="pre">TYPE)</span></code></dt><dd><p>Perform the <a class="reference internal" href="#i-zext"><span class="std std-ref">zext operation</span></a> on constants.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">sext</span> <span class="pre">(CST</span> <span class="pre">to</span> <span class="pre">TYPE)</span></code></dt><dd><p>Perform the <a class="reference internal" href="#i-sext"><span class="std std-ref">sext operation</span></a> on constants.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">fptrunc</span> <span class="pre">(CST</span> <span class="pre">to</span> <span class="pre">TYPE)</span></code></dt><dd><p>Truncate a floating-point constant to another floating-point type.
The size of CST must be larger than the size of TYPE. Both types
must be floating-point.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">fpext</span> <span class="pre">(CST</span> <span class="pre">to</span> <span class="pre">TYPE)</span></code></dt><dd><p>Floating-point extend a constant to another type. The size of CST
must be smaller or equal to the size of TYPE. Both types must be
floating-point.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">fptoui</span> <span class="pre">(CST</span> <span class="pre">to</span> <span class="pre">TYPE)</span></code></dt><dd><p>Convert a floating-point constant to the corresponding unsigned
integer constant. TYPE must be a scalar or vector integer type. CST
must be of scalar or vector floating-point type. Both CST and TYPE
must be scalars, or vectors of the same number of elements. If the
value won’t fit in the integer type, the result is a
<a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">fptosi</span> <span class="pre">(CST</span> <span class="pre">to</span> <span class="pre">TYPE)</span></code></dt><dd><p>Convert a floating-point constant to the corresponding signed
integer constant. TYPE must be a scalar or vector integer type. CST
must be of scalar or vector floating-point type. Both CST and TYPE
must be scalars, or vectors of the same number of elements. If the
value won’t fit in the integer type, the result is a
<a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">uitofp</span> <span class="pre">(CST</span> <span class="pre">to</span> <span class="pre">TYPE)</span></code></dt><dd><p>Convert an unsigned integer constant to the corresponding
floating-point constant. TYPE must be a scalar or vector floating-point
type. CST must be of scalar or vector integer type. Both CST and TYPE must
be scalars, or vectors of the same number of elements.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">sitofp</span> <span class="pre">(CST</span> <span class="pre">to</span> <span class="pre">TYPE)</span></code></dt><dd><p>Convert a signed integer constant to the corresponding floating-point
constant. TYPE must be a scalar or vector floating-point type.
CST must be of scalar or vector integer type. Both CST and TYPE must
be scalars, or vectors of the same number of elements.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">ptrtoint</span> <span class="pre">(CST</span> <span class="pre">to</span> <span class="pre">TYPE)</span></code></dt><dd><p>Perform the <a class="reference internal" href="#i-ptrtoint"><span class="std std-ref">ptrtoint operation</span></a> on constants.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">inttoptr</span> <span class="pre">(CST</span> <span class="pre">to</span> <span class="pre">TYPE)</span></code></dt><dd><p>Perform the <a class="reference internal" href="#i-inttoptr"><span class="std std-ref">inttoptr operation</span></a> on constants.
This one is <em>really</em> dangerous!</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">bitcast</span> <span class="pre">(CST</span> <span class="pre">to</span> <span class="pre">TYPE)</span></code></dt><dd><p>Convert a constant, CST, to another TYPE.
The constraints of the operands are the same as those for the
<a class="reference internal" href="#i-bitcast"><span class="std std-ref">bitcast instruction</span></a>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">addrspacecast</span> <span class="pre">(CST</span> <span class="pre">to</span> <span class="pre">TYPE)</span></code></dt><dd><p>Convert a constant pointer or constant vector of pointer, CST, to another
TYPE in a different address space. The constraints of the operands are the
same as those for the <a class="reference internal" href="#i-addrspacecast"><span class="std std-ref">addrspacecast instruction</span></a>.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">getelementptr</span> <span class="pre">(TY,</span> <span class="pre">CSTPTR,</span> <span class="pre">IDX0,</span> <span class="pre">IDX1,</span> <span class="pre">...)</span></code>, <code class="docutils literal notranslate"><span class="pre">getelementptr</span> <span class="pre">inbounds</span> <span class="pre">(TY,</span> <span class="pre">CSTPTR,</span> <span class="pre">IDX0,</span> <span class="pre">IDX1,</span> <span class="pre">...)</span></code></dt><dd><p>Perform the <a class="reference internal" href="#i-getelementptr"><span class="std std-ref">getelementptr operation</span></a> on
constants. As with the <a class="reference internal" href="#i-getelementptr"><span class="std std-ref">getelementptr</span></a>
instruction, the index list may have one or more indexes, which are
required to make sense for the type of “pointer to TY”.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">select</span> <span class="pre">(COND,</span> <span class="pre">VAL1,</span> <span class="pre">VAL2)</span></code></dt><dd><p>Perform the <a class="reference internal" href="#i-select"><span class="std std-ref">select operation</span></a> on constants.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">icmp</span> <span class="pre">COND</span> <span class="pre">(VAL1,</span> <span class="pre">VAL2)</span></code></dt><dd><p>Perform the <a class="reference internal" href="#i-icmp"><span class="std std-ref">icmp operation</span></a> on constants.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">fcmp</span> <span class="pre">COND</span> <span class="pre">(VAL1,</span> <span class="pre">VAL2)</span></code></dt><dd><p>Perform the <a class="reference internal" href="#i-fcmp"><span class="std std-ref">fcmp operation</span></a> on constants.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">extractelement</span> <span class="pre">(VAL,</span> <span class="pre">IDX)</span></code></dt><dd><p>Perform the <a class="reference internal" href="#i-extractelement"><span class="std std-ref">extractelement operation</span></a> on
constants.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">insertelement</span> <span class="pre">(VAL,</span> <span class="pre">ELT,</span> <span class="pre">IDX)</span></code></dt><dd><p>Perform the <a class="reference internal" href="#i-insertelement"><span class="std std-ref">insertelement operation</span></a> on
constants.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">shufflevector</span> <span class="pre">(VEC1,</span> <span class="pre">VEC2,</span> <span class="pre">IDXMASK)</span></code></dt><dd><p>Perform the <a class="reference internal" href="#i-shufflevector"><span class="std std-ref">shufflevector operation</span></a> on
constants.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">extractvalue</span> <span class="pre">(VAL,</span> <span class="pre">IDX0,</span> <span class="pre">IDX1,</span> <span class="pre">...)</span></code></dt><dd><p>Perform the <a class="reference internal" href="#i-extractvalue"><span class="std std-ref">extractvalue operation</span></a> on
constants. The index list is interpreted in a similar manner as
indices in a ‘<a class="reference internal" href="#i-getelementptr"><span class="std std-ref">getelementptr</span></a>’ operation. At
least one index value must be specified.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">insertvalue</span> <span class="pre">(VAL,</span> <span class="pre">ELT,</span> <span class="pre">IDX0,</span> <span class="pre">IDX1,</span> <span class="pre">...)</span></code></dt><dd><p>Perform the <a class="reference internal" href="#i-insertvalue"><span class="std std-ref">insertvalue operation</span></a> on constants.
The index list is interpreted in a similar manner as indices in a
‘<a class="reference internal" href="#i-getelementptr"><span class="std std-ref">getelementptr</span></a>’ operation. At least one index
value must be specified.</p>
</dd>
<dt><code class="docutils literal notranslate"><span class="pre">OPCODE</span> <span class="pre">(LHS,</span> <span class="pre">RHS)</span></code></dt><dd><p>Perform the specified operation of the LHS and RHS constants. OPCODE
may be any of the <a class="reference internal" href="#binaryops"><span class="std std-ref">binary</span></a> or <a class="reference internal" href="#bitwiseops"><span class="std std-ref">bitwise
binary</span></a> operations. The constraints on operands are
the same as those for the corresponding instruction (e.g. no bitwise
operations on floating-point values are allowed).</p>
</dd>
</dl>
</div>
</div>
<div class="section" id="other-values">
<h2><a class="toc-backref" href="#id1487">Other Values</a><a class="headerlink" href="#other-values" title="Permalink to this headline">¶</a></h2>
<div class="section" id="inline-assembler-expressions">
<span id="inlineasmexprs"></span><h3><a class="toc-backref" href="#id1488">Inline Assembler Expressions</a><a class="headerlink" href="#inline-assembler-expressions" title="Permalink to this headline">¶</a></h3>
<p>LLVM supports inline assembler expressions (as opposed to <a class="reference internal" href="#moduleasm"><span class="std std-ref">Module-Level
Inline Assembly</span></a>) through the use of a special value. This value
represents the inline assembler as a template string (containing the
instructions to emit), a list of operand constraints (stored as a string), a
flag that indicates whether or not the inline asm expression has side effects,
and a flag indicating whether the function containing the asm needs to align its
stack conservatively.</p>
<p>The template string supports argument substitution of the operands using “<code class="docutils literal notranslate"><span class="pre">$</span></code>”
followed by a number, to indicate substitution of the given register/memory
location, as specified by the constraint string. “<code class="docutils literal notranslate"><span class="pre">${NUM:MODIFIER}</span></code>” may also
be used, where <code class="docutils literal notranslate"><span class="pre">MODIFIER</span></code> is a target-specific annotation for how to print the
operand (See <a class="reference internal" href="#inline-asm-modifiers"><span class="std std-ref">Asm template argument modifiers</span></a>).</p>
<p>A literal “<code class="docutils literal notranslate"><span class="pre">$</span></code>” may be included by using “<code class="docutils literal notranslate"><span class="pre">$$</span></code>” in the template. To include
other special characters into the output, the usual “<code class="docutils literal notranslate"><span class="pre">\XX</span></code>” escapes may be
used, just as in other strings. Note that after template substitution, the
resulting assembly string is parsed by LLVM’s integrated assembler unless it is
disabled – even when emitting a <code class="docutils literal notranslate"><span class="pre">.s</span></code> file – and thus must contain assembly
syntax known to LLVM.</p>
<p>LLVM also supports a few more substitutions useful for writing inline assembly:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">${:uid}</span></code>: Expands to a decimal integer unique to this inline assembly blob.
This substitution is useful when declaring a local label. Many standard
compiler optimizations, such as inlining, may duplicate an inline asm blob.
Adding a blob-unique identifier ensures that the two labels will not conflict
during assembly. This is used to implement <a class="reference external" href="https://gcc.gnu.org/onlinedocs/gcc/Extended-Asm.html">GCC’s %= special format
string</a>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">${:comment}</span></code>: Expands to the comment character of the current target’s
assembly dialect. This is usually <code class="docutils literal notranslate"><span class="pre">#</span></code>, but many targets use other strings,
such as <code class="docutils literal notranslate"><span class="pre">;</span></code>, <code class="docutils literal notranslate"><span class="pre">//</span></code>, or <code class="docutils literal notranslate"><span class="pre">!</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">${:private}</span></code>: Expands to the assembler private label prefix. Labels with
this prefix will not appear in the symbol table of the assembled object.
Typically the prefix is <code class="docutils literal notranslate"><span class="pre">L</span></code>, but targets may use other strings. <code class="docutils literal notranslate"><span class="pre">.L</span></code> is
relatively popular.</p></li>
</ul>
<p>LLVM’s support for inline asm is modeled closely on the requirements of Clang’s
GCC-compatible inline-asm support. Thus, the feature-set and the constraint and
modifier codes listed here are similar or identical to those in GCC’s inline asm
support. However, to be clear, the syntax of the template and constraint strings
described here is <em>not</em> the same as the syntax accepted by GCC and Clang, and,
while most constraint letters are passed through as-is by Clang, some get
translated to other codes when converting from the C source to the LLVM
assembly.</p>
<p>An example inline assembler expression is:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">i32</span> <span class="p">(</span><span class="k">i32</span><span class="p">)</span> <span class="k">asm</span> <span class="s">"bswap $0"</span><span class="p">,</span> <span class="s">"=r,r"</span>
</pre></div>
</div>
<p>Inline assembler expressions may <strong>only</strong> be used as the callee operand
of a <a class="reference internal" href="#i-call"><span class="std std-ref">call</span></a> or an <a class="reference internal" href="#i-invoke"><span class="std std-ref">invoke</span></a> instruction.
Thus, typically we have:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%X</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="k">asm</span> <span class="s">"bswap $0"</span><span class="p">,</span> <span class="s">"=r,r"</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%Y</span><span class="p">)</span>
</pre></div>
</div>
<p>Inline asms with side effects not visible in the constraint list must be
marked as having side effects. This is done through the use of the
‘<code class="docutils literal notranslate"><span class="pre">sideeffect</span></code>’ keyword, like so:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">call</span> <span class="k">void</span> <span class="k">asm</span> <span class="k">sideeffect</span> <span class="s">"eieio"</span><span class="p">,</span> <span class="s">""</span><span class="p">()</span>
</pre></div>
</div>
<p>In some cases inline asms will contain code that will not work unless
the stack is aligned in some way, such as calls or SSE instructions on
x86, yet will not contain code that does that alignment within the asm.
The compiler should make conservative assumptions about what the asm
might contain and should generate its usual stack alignment code in the
prologue if the ‘<code class="docutils literal notranslate"><span class="pre">alignstack</span></code>’ keyword is present:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">call</span> <span class="k">void</span> <span class="k">asm</span> <span class="k">alignstack</span> <span class="s">"eieio"</span><span class="p">,</span> <span class="s">""</span><span class="p">()</span>
</pre></div>
</div>
<p>Inline asms also support using non-standard assembly dialects. The
assumed dialect is ATT. When the ‘<code class="docutils literal notranslate"><span class="pre">inteldialect</span></code>’ keyword is present,
the inline asm is using the Intel dialect. Currently, ATT and Intel are
the only supported dialects. An example is:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">call</span> <span class="k">void</span> <span class="k">asm</span> <span class="k">inteldialect</span> <span class="s">"eieio"</span><span class="p">,</span> <span class="s">""</span><span class="p">()</span>
</pre></div>
</div>
<p>In the case that the inline asm might unwind the stack,
the ‘<code class="docutils literal notranslate"><span class="pre">unwind</span></code>’ keyword must be used, so that the compiler emits
unwinding information:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">call</span> <span class="k">void</span> <span class="k">asm</span> <span class="k">unwind</span> <span class="s">"call func"</span><span class="p">,</span> <span class="s">""</span><span class="p">()</span>
</pre></div>
</div>
<p>If the inline asm unwinds the stack and isn’t marked with
the ‘<code class="docutils literal notranslate"><span class="pre">unwind</span></code>’ keyword, the behavior is undefined.</p>
<p>If multiple keywords appear, the ‘<code class="docutils literal notranslate"><span class="pre">sideeffect</span></code>’ keyword must come
first, the ‘<code class="docutils literal notranslate"><span class="pre">alignstack</span></code>’ keyword second, the ‘<code class="docutils literal notranslate"><span class="pre">inteldialect</span></code>’ keyword
third and the ‘<code class="docutils literal notranslate"><span class="pre">unwind</span></code>’ keyword last.</p>
<div class="section" id="inline-asm-constraint-string">
<h4><a class="toc-backref" href="#id1489">Inline Asm Constraint String</a><a class="headerlink" href="#inline-asm-constraint-string" title="Permalink to this headline">¶</a></h4>
<p>The constraint list is a comma-separated string, each element containing one or
more constraint codes.</p>
<p>For each element in the constraint list an appropriate register or memory
operand will be chosen, and it will be made available to assembly template
string expansion as <code class="docutils literal notranslate"><span class="pre">$0</span></code> for the first constraint in the list, <code class="docutils literal notranslate"><span class="pre">$1</span></code> for the
second, etc.</p>
<p>There are three different types of constraints, which are distinguished by a
prefix symbol in front of the constraint code: Output, Input, and Clobber. The
constraints must always be given in that order: outputs first, then inputs, then
clobbers. They cannot be intermingled.</p>
<p>There are also three different categories of constraint codes:</p>
<ul class="simple">
<li><p>Register constraint. This is either a register class, or a fixed physical
register. This kind of constraint will allocate a register, and if necessary,
bitcast the argument or result to the appropriate type.</p></li>
<li><p>Memory constraint. This kind of constraint is for use with an instruction
taking a memory operand. Different constraints allow for different addressing
modes used by the target.</p></li>
<li><p>Immediate value constraint. This kind of constraint is for an integer or other
immediate value which can be rendered directly into an instruction. The
various target-specific constraints allow the selection of a value in the
proper range for the instruction you wish to use it with.</p></li>
</ul>
<div class="section" id="output-constraints">
<h5><a class="toc-backref" href="#id1490">Output constraints</a><a class="headerlink" href="#output-constraints" title="Permalink to this headline">¶</a></h5>
<p>Output constraints are specified by an “<code class="docutils literal notranslate"><span class="pre">=</span></code>” prefix (e.g. “<code class="docutils literal notranslate"><span class="pre">=r</span></code>”). This
indicates that the assembly will write to this operand, and the operand will
then be made available as a return value of the <code class="docutils literal notranslate"><span class="pre">asm</span></code> expression. Output
constraints do not consume an argument from the call instruction. (Except, see
below about indirect outputs).</p>
<p>Normally, it is expected that no output locations are written to by the assembly
expression until <em>all</em> of the inputs have been read. As such, LLVM may assign
the same register to an output and an input. If this is not safe (e.g. if the
assembly contains two instructions, where the first writes to one output, and
the second reads an input and writes to a second output), then the “<code class="docutils literal notranslate"><span class="pre">&</span></code>”
modifier must be used (e.g. “<code class="docutils literal notranslate"><span class="pre">=&r</span></code>”) to specify that the output is an
“early-clobber” output. Marking an output as “early-clobber” ensures that LLVM
will not use the same register for any inputs (other than an input tied to this
output).</p>
</div>
<div class="section" id="input-constraints">
<h5><a class="toc-backref" href="#id1491">Input constraints</a><a class="headerlink" href="#input-constraints" title="Permalink to this headline">¶</a></h5>
<p>Input constraints do not have a prefix – just the constraint codes. Each input
constraint will consume one argument from the call instruction. It is not
permitted for the asm to write to any input register or memory location (unless
that input is tied to an output). Note also that multiple inputs may all be
assigned to the same register, if LLVM can determine that they necessarily all
contain the same value.</p>
<p>Instead of providing a Constraint Code, input constraints may also “tie”
themselves to an output constraint, by providing an integer as the constraint
string. Tied inputs still consume an argument from the call instruction, and
take up a position in the asm template numbering as is usual – they will simply
be constrained to always use the same register as the output they’ve been tied
to. For example, a constraint string of “<code class="docutils literal notranslate"><span class="pre">=r,0</span></code>” says to assign a register for
output, and use that register as an input as well (it being the 0’th
constraint).</p>
<p>It is permitted to tie an input to an “early-clobber” output. In that case, no
<em>other</em> input may share the same register as the input tied to the early-clobber
(even when the other input has the same value).</p>
<p>You may only tie an input to an output which has a register constraint, not a
memory constraint. Only a single input may be tied to an output.</p>
<p>There is also an “interesting” feature which deserves a bit of explanation: if a
register class constraint allocates a register which is too small for the value
type operand provided as input, the input value will be split into multiple
registers, and all of them passed to the inline asm.</p>
<p>However, this feature is often not as useful as you might think.</p>
<p>Firstly, the registers are <em>not</em> guaranteed to be consecutive. So, on those
architectures that have instructions which operate on multiple consecutive
instructions, this is not an appropriate way to support them. (e.g. the 32-bit
SparcV8 has a 64-bit load, which instruction takes a single 32-bit register. The
hardware then loads into both the named register, and the next register. This
feature of inline asm would not be useful to support that.)</p>
<p>A few of the targets provide a template string modifier allowing explicit access
to the second register of a two-register operand (e.g. MIPS <code class="docutils literal notranslate"><span class="pre">L</span></code>, <code class="docutils literal notranslate"><span class="pre">M</span></code>, and
<code class="docutils literal notranslate"><span class="pre">D</span></code>). On such an architecture, you can actually access the second allocated
register (yet, still, not any subsequent ones). But, in that case, you’re still
probably better off simply splitting the value into two separate operands, for
clarity. (e.g. see the description of the <code class="docutils literal notranslate"><span class="pre">A</span></code> constraint on X86, which,
despite existing only for use with this feature, is not really a good idea to
use)</p>
</div>
<div class="section" id="indirect-inputs-and-outputs">
<h5><a class="toc-backref" href="#id1492">Indirect inputs and outputs</a><a class="headerlink" href="#indirect-inputs-and-outputs" title="Permalink to this headline">¶</a></h5>
<p>Indirect output or input constraints can be specified by the “<code class="docutils literal notranslate"><span class="pre">*</span></code>” modifier
(which goes after the “<code class="docutils literal notranslate"><span class="pre">=</span></code>” in case of an output). This indicates that the asm
will write to or read from the contents of an <em>address</em> provided as an input
argument. (Note that in this way, indirect outputs act more like an <em>input</em> than
an output: just like an input, they consume an argument of the call expression,
rather than producing a return value. An indirect output constraint is an
“output” only in that the asm is expected to write to the contents of the input
memory location, instead of just read from it).</p>
<p>This is most typically used for memory constraint, e.g. “<code class="docutils literal notranslate"><span class="pre">=*m</span></code>”, to pass the
address of a variable as a value.</p>
<p>It is also possible to use an indirect <em>register</em> constraint, but only on output
(e.g. “<code class="docutils literal notranslate"><span class="pre">=*r</span></code>”). This will cause LLVM to allocate a register for an output
value normally, and then, separately emit a store to the address provided as
input, after the provided inline asm. (It’s not clear what value this
functionality provides, compared to writing the store explicitly after the asm
statement, and it can only produce worse code, since it bypasses many
optimization passes. I would recommend not using it.)</p>
</div>
<div class="section" id="clobber-constraints">
<h5><a class="toc-backref" href="#id1493">Clobber constraints</a><a class="headerlink" href="#clobber-constraints" title="Permalink to this headline">¶</a></h5>
<p>A clobber constraint is indicated by a “<code class="docutils literal notranslate"><span class="pre">~</span></code>” prefix. A clobber does not
consume an input operand, nor generate an output. Clobbers cannot use any of the
general constraint code letters – they may use only explicit register
constraints, e.g. “<code class="docutils literal notranslate"><span class="pre">~{eax}</span></code>”. The one exception is that a clobber string of
“<code class="docutils literal notranslate"><span class="pre">~{memory}</span></code>” indicates that the assembly writes to arbitrary undeclared
memory locations – not only the memory pointed to by a declared indirect
output.</p>
<p>Note that clobbering named registers that are also present in output
constraints is not legal.</p>
</div>
<div class="section" id="constraint-codes">
<h5><a class="toc-backref" href="#id1494">Constraint Codes</a><a class="headerlink" href="#constraint-codes" title="Permalink to this headline">¶</a></h5>
<p>After a potential prefix comes constraint code, or codes.</p>
<p>A Constraint Code is either a single letter (e.g. “<code class="docutils literal notranslate"><span class="pre">r</span></code>”), a “<code class="docutils literal notranslate"><span class="pre">^</span></code>” character
followed by two letters (e.g. “<code class="docutils literal notranslate"><span class="pre">^wc</span></code>”), or “<code class="docutils literal notranslate"><span class="pre">{</span></code>” register-name “<code class="docutils literal notranslate"><span class="pre">}</span></code>”
(e.g. “<code class="docutils literal notranslate"><span class="pre">{eax}</span></code>”).</p>
<p>The one and two letter constraint codes are typically chosen to be the same as
GCC’s constraint codes.</p>
<p>A single constraint may include one or more than constraint code in it, leaving
it up to LLVM to choose which one to use. This is included mainly for
compatibility with the translation of GCC inline asm coming from clang.</p>
<p>There are two ways to specify alternatives, and either or both may be used in an
inline asm constraint list:</p>
<ol class="arabic simple">
<li><p>Append the codes to each other, making a constraint code set. E.g. “<code class="docutils literal notranslate"><span class="pre">im</span></code>”
or “<code class="docutils literal notranslate"><span class="pre">{eax}m</span></code>”. This means “choose any of the options in the set”. The
choice of constraint is made independently for each constraint in the
constraint list.</p></li>
<li><p>Use “<code class="docutils literal notranslate"><span class="pre">|</span></code>” between constraint code sets, creating alternatives. Every
constraint in the constraint list must have the same number of alternative
sets. With this syntax, the same alternative in <em>all</em> of the items in the
constraint list will be chosen together.</p></li>
</ol>
<p>Putting those together, you might have a two operand constraint string like
<code class="docutils literal notranslate"><span class="pre">"rm|r,ri|rm"</span></code>. This indicates that if operand 0 is <code class="docutils literal notranslate"><span class="pre">r</span></code> or <code class="docutils literal notranslate"><span class="pre">m</span></code>, then
operand 1 may be one of <code class="docutils literal notranslate"><span class="pre">r</span></code> or <code class="docutils literal notranslate"><span class="pre">i</span></code>. If operand 0 is <code class="docutils literal notranslate"><span class="pre">r</span></code>, then operand 1
may be one of <code class="docutils literal notranslate"><span class="pre">r</span></code> or <code class="docutils literal notranslate"><span class="pre">m</span></code>. But, operand 0 and 1 cannot both be of type m.</p>
<p>However, the use of either of the alternatives features is <em>NOT</em> recommended, as
LLVM is not able to make an intelligent choice about which one to use. (At the
point it currently needs to choose, not enough information is available to do so
in a smart way.) Thus, it simply tries to make a choice that’s most likely to
compile, not one that will be optimal performance. (e.g., given “<code class="docutils literal notranslate"><span class="pre">rm</span></code>”, it’ll
always choose to use memory, not registers). And, if given multiple registers,
or multiple register classes, it will simply choose the first one. (In fact, it
doesn’t currently even ensure explicitly specified physical registers are
unique, so specifying multiple physical registers as alternatives, like
<code class="docutils literal notranslate"><span class="pre">{r11}{r12},{r11}{r12}</span></code>, will assign r11 to both operands, not at all what was
intended.)</p>
</div>
<div class="section" id="supported-constraint-code-list">
<h5><a class="toc-backref" href="#id1495">Supported Constraint Code List</a><a class="headerlink" href="#supported-constraint-code-list" title="Permalink to this headline">¶</a></h5>
<p>The constraint codes are, in general, expected to behave the same way they do in
GCC. LLVM’s support is often implemented on an ‘as-needed’ basis, to support C
inline asm code which was supported by GCC. A mismatch in behavior between LLVM
and GCC likely indicates a bug in LLVM.</p>
<p>Some constraint codes are typically supported by all targets:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">r</span></code>: A register in the target’s general purpose register class.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">m</span></code>: A memory address operand. It is target-specific what addressing modes
are supported, typical examples are register, or register + register offset,
or register + immediate offset (of some target-specific size).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">i</span></code>: An integer constant (of target-specific width). Allows either a simple
immediate, or a relocatable value.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">n</span></code>: An integer constant – <em>not</em> including relocatable values.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">s</span></code>: An integer constant, but allowing <em>only</em> relocatable values.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">X</span></code>: Allows an operand of any kind, no constraint whatsoever. Typically
useful to pass a label for an asm branch or call.</p>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">{register-name}</span></code>: Requires exactly the named physical register.</p></li>
</ul>
<p>Other constraints are target-specific:</p>
<p>AArch64:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">z</span></code>: An immediate integer 0. Outputs <code class="docutils literal notranslate"><span class="pre">WZR</span></code> or <code class="docutils literal notranslate"><span class="pre">XZR</span></code>, as appropriate.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">I</span></code>: An immediate integer valid for an <code class="docutils literal notranslate"><span class="pre">ADD</span></code> or <code class="docutils literal notranslate"><span class="pre">SUB</span></code> instruction,
i.e. 0 to 4095 with optional shift by 12.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">J</span></code>: An immediate integer that, when negated, is valid for an <code class="docutils literal notranslate"><span class="pre">ADD</span></code> or
<code class="docutils literal notranslate"><span class="pre">SUB</span></code> instruction, i.e. -1 to -4095 with optional left shift by 12.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">K</span></code>: An immediate integer that is valid for the ‘bitmask immediate 32’ of a
logical instruction like <code class="docutils literal notranslate"><span class="pre">AND</span></code>, <code class="docutils literal notranslate"><span class="pre">EOR</span></code>, or <code class="docutils literal notranslate"><span class="pre">ORR</span></code> with a 32-bit register.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">L</span></code>: An immediate integer that is valid for the ‘bitmask immediate 64’ of a
logical instruction like <code class="docutils literal notranslate"><span class="pre">AND</span></code>, <code class="docutils literal notranslate"><span class="pre">EOR</span></code>, or <code class="docutils literal notranslate"><span class="pre">ORR</span></code> with a 64-bit register.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">M</span></code>: An immediate integer for use with the <code class="docutils literal notranslate"><span class="pre">MOV</span></code> assembly alias on a
32-bit register. This is a superset of <code class="docutils literal notranslate"><span class="pre">K</span></code>: in addition to the bitmask
immediate, also allows immediate integers which can be loaded with a single
<code class="docutils literal notranslate"><span class="pre">MOVZ</span></code> or <code class="docutils literal notranslate"><span class="pre">MOVL</span></code> instruction.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">N</span></code>: An immediate integer for use with the <code class="docutils literal notranslate"><span class="pre">MOV</span></code> assembly alias on a
64-bit register. This is a superset of <code class="docutils literal notranslate"><span class="pre">L</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Q</span></code>: Memory address operand must be in a single register (no
offsets). (However, LLVM currently does this for the <code class="docutils literal notranslate"><span class="pre">m</span></code> constraint as
well.)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">r</span></code>: A 32 or 64-bit integer register (W* or X*).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">w</span></code>: A 32, 64, or 128-bit floating-point, SIMD or SVE vector register.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">x</span></code>: Like w, but restricted to registers 0 to 15 inclusive.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">y</span></code>: Like w, but restricted to SVE vector registers Z0 to Z7 inclusive.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Upl</span></code>: One of the low eight SVE predicate registers (P0 to P7)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Upa</span></code>: Any of the SVE predicate registers (P0 to P15)</p></li>
</ul>
<p>AMDGPU:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">r</span></code>: A 32 or 64-bit integer register.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[0-9]v</span></code>: The 32-bit VGPR register, number 0-9.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[0-9]s</span></code>: The 32-bit SGPR register, number 0-9.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">[0-9]a</span></code>: The 32-bit AGPR register, number 0-9.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">I</span></code>: An integer inline constant in the range from -16 to 64.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">J</span></code>: A 16-bit signed integer constant.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">A</span></code>: An integer or a floating-point inline constant.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">B</span></code>: A 32-bit signed integer constant.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">C</span></code>: A 32-bit unsigned integer constant or an integer inline constant in the range from -16 to 64.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DA</span></code>: A 64-bit constant that can be split into two “A” constants.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DB</span></code>: A 64-bit constant that can be split into two “B” constants.</p></li>
</ul>
<p>All ARM modes:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">Q</span></code>, <code class="docutils literal notranslate"><span class="pre">Um</span></code>, <code class="docutils literal notranslate"><span class="pre">Un</span></code>, <code class="docutils literal notranslate"><span class="pre">Uq</span></code>, <code class="docutils literal notranslate"><span class="pre">Us</span></code>, <code class="docutils literal notranslate"><span class="pre">Ut</span></code>, <code class="docutils literal notranslate"><span class="pre">Uv</span></code>, <code class="docutils literal notranslate"><span class="pre">Uy</span></code>: Memory address
operand. Treated the same as operand <code class="docutils literal notranslate"><span class="pre">m</span></code>, at the moment.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Te</span></code>: An even general-purpose 32-bit integer register: <code class="docutils literal notranslate"><span class="pre">r0,r2,...,r12,r14</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">To</span></code>: An odd general-purpose 32-bit integer register: <code class="docutils literal notranslate"><span class="pre">r1,r3,...,r11</span></code></p></li>
</ul>
<p>ARM and ARM’s Thumb2 mode:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">j</span></code>: An immediate integer between 0 and 65535 (valid for <code class="docutils literal notranslate"><span class="pre">MOVW</span></code>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">I</span></code>: An immediate integer valid for a data-processing instruction.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">J</span></code>: An immediate integer between -4095 and 4095.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">K</span></code>: An immediate integer whose bitwise inverse is valid for a
data-processing instruction. (Can be used with template modifier “<code class="docutils literal notranslate"><span class="pre">B</span></code>” to
print the inverted value).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">L</span></code>: An immediate integer whose negation is valid for a data-processing
instruction. (Can be used with template modifier “<code class="docutils literal notranslate"><span class="pre">n</span></code>” to print the negated
value).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">M</span></code>: A power of two or an integer between 0 and 32.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">N</span></code>: Invalid immediate constraint.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">O</span></code>: Invalid immediate constraint.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">r</span></code>: A general-purpose 32-bit integer register (<code class="docutils literal notranslate"><span class="pre">r0-r15</span></code>).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">l</span></code>: In Thumb2 mode, low 32-bit GPR registers (<code class="docutils literal notranslate"><span class="pre">r0-r7</span></code>). In ARM mode, same
as <code class="docutils literal notranslate"><span class="pre">r</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">h</span></code>: In Thumb2 mode, a high 32-bit GPR register (<code class="docutils literal notranslate"><span class="pre">r8-r15</span></code>). In ARM mode,
invalid.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">w</span></code>: A 32, 64, or 128-bit floating-point/SIMD register in the ranges
<code class="docutils literal notranslate"><span class="pre">s0-s31</span></code>, <code class="docutils literal notranslate"><span class="pre">d0-d31</span></code>, or <code class="docutils literal notranslate"><span class="pre">q0-q15</span></code>, respectively.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">t</span></code>: A 32, 64, or 128-bit floating-point/SIMD register in the ranges
<code class="docutils literal notranslate"><span class="pre">s0-s31</span></code>, <code class="docutils literal notranslate"><span class="pre">d0-d15</span></code>, or <code class="docutils literal notranslate"><span class="pre">q0-q7</span></code>, respectively.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">x</span></code>: A 32, 64, or 128-bit floating-point/SIMD register in the ranges
<code class="docutils literal notranslate"><span class="pre">s0-s15</span></code>, <code class="docutils literal notranslate"><span class="pre">d0-d7</span></code>, or <code class="docutils literal notranslate"><span class="pre">q0-q3</span></code>, respectively.</p></li>
</ul>
<p>ARM’s Thumb1 mode:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">I</span></code>: An immediate integer between 0 and 255.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">J</span></code>: An immediate integer between -255 and -1.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">K</span></code>: An immediate integer between 0 and 255, with optional left-shift by
some amount.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">L</span></code>: An immediate integer between -7 and 7.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">M</span></code>: An immediate integer which is a multiple of 4 between 0 and 1020.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">N</span></code>: An immediate integer between 0 and 31.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">O</span></code>: An immediate integer which is a multiple of 4 between -508 and 508.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">r</span></code>: A low 32-bit GPR register (<code class="docutils literal notranslate"><span class="pre">r0-r7</span></code>).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">l</span></code>: A low 32-bit GPR register (<code class="docutils literal notranslate"><span class="pre">r0-r7</span></code>).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">h</span></code>: A high GPR register (<code class="docutils literal notranslate"><span class="pre">r0-r7</span></code>).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">w</span></code>: A 32, 64, or 128-bit floating-point/SIMD register in the ranges
<code class="docutils literal notranslate"><span class="pre">s0-s31</span></code>, <code class="docutils literal notranslate"><span class="pre">d0-d31</span></code>, or <code class="docutils literal notranslate"><span class="pre">q0-q15</span></code>, respectively.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">t</span></code>: A 32, 64, or 128-bit floating-point/SIMD register in the ranges
<code class="docutils literal notranslate"><span class="pre">s0-s31</span></code>, <code class="docutils literal notranslate"><span class="pre">d0-d15</span></code>, or <code class="docutils literal notranslate"><span class="pre">q0-q7</span></code>, respectively.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">x</span></code>: A 32, 64, or 128-bit floating-point/SIMD register in the ranges
<code class="docutils literal notranslate"><span class="pre">s0-s15</span></code>, <code class="docutils literal notranslate"><span class="pre">d0-d7</span></code>, or <code class="docutils literal notranslate"><span class="pre">q0-q3</span></code>, respectively.</p></li>
</ul>
<p>Hexagon:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">o</span></code>, <code class="docutils literal notranslate"><span class="pre">v</span></code>: A memory address operand, treated the same as constraint <code class="docutils literal notranslate"><span class="pre">m</span></code>,
at the moment.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">r</span></code>: A 32 or 64-bit register.</p></li>
</ul>
<p>MSP430:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">r</span></code>: An 8 or 16-bit register.</p></li>
</ul>
<p>MIPS:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">I</span></code>: An immediate signed 16-bit integer.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">J</span></code>: An immediate integer zero.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">K</span></code>: An immediate unsigned 16-bit integer.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">L</span></code>: An immediate 32-bit integer, where the lower 16 bits are 0.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">N</span></code>: An immediate integer between -65535 and -1.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">O</span></code>: An immediate signed 15-bit integer.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">P</span></code>: An immediate integer between 1 and 65535.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">m</span></code>: A memory address operand. In MIPS-SE mode, allows a base address
register plus 16-bit immediate offset. In MIPS mode, just a base register.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">R</span></code>: A memory address operand. In MIPS-SE mode, allows a base address
register plus a 9-bit signed offset. In MIPS mode, the same as constraint
<code class="docutils literal notranslate"><span class="pre">m</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ZC</span></code>: A memory address operand, suitable for use in a <code class="docutils literal notranslate"><span class="pre">pref</span></code>, <code class="docutils literal notranslate"><span class="pre">ll</span></code>, or
<code class="docutils literal notranslate"><span class="pre">sc</span></code> instruction on the given subtarget (details vary).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">r</span></code>, <code class="docutils literal notranslate"><span class="pre">d</span></code>, <code class="docutils literal notranslate"><span class="pre">y</span></code>: A 32 or 64-bit GPR register.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">f</span></code>: A 32 or 64-bit FPU register (<code class="docutils literal notranslate"><span class="pre">F0-F31</span></code>), or a 128-bit MSA register
(<code class="docutils literal notranslate"><span class="pre">W0-W31</span></code>). In the case of MSA registers, it is recommended to use the <code class="docutils literal notranslate"><span class="pre">w</span></code>
argument modifier for compatibility with GCC.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">c</span></code>: A 32-bit or 64-bit GPR register suitable for indirect jump (always
<code class="docutils literal notranslate"><span class="pre">25</span></code>).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">l</span></code>: The <code class="docutils literal notranslate"><span class="pre">lo</span></code> register, 32 or 64-bit.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">x</span></code>: Invalid.</p></li>
</ul>
<p>NVPTX:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">b</span></code>: A 1-bit integer register.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">c</span></code> or <code class="docutils literal notranslate"><span class="pre">h</span></code>: A 16-bit integer register.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">r</span></code>: A 32-bit integer register.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">l</span></code> or <code class="docutils literal notranslate"><span class="pre">N</span></code>: A 64-bit integer register.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">f</span></code>: A 32-bit float register.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">d</span></code>: A 64-bit float register.</p></li>
</ul>
<p>PowerPC:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">I</span></code>: An immediate signed 16-bit integer.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">J</span></code>: An immediate unsigned 16-bit integer, shifted left 16 bits.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">K</span></code>: An immediate unsigned 16-bit integer.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">L</span></code>: An immediate signed 16-bit integer, shifted left 16 bits.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">M</span></code>: An immediate integer greater than 31.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">N</span></code>: An immediate integer that is an exact power of 2.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">O</span></code>: The immediate integer constant 0.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">P</span></code>: An immediate integer constant whose negation is a signed 16-bit
constant.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">es</span></code>, <code class="docutils literal notranslate"><span class="pre">o</span></code>, <code class="docutils literal notranslate"><span class="pre">Q</span></code>, <code class="docutils literal notranslate"><span class="pre">Z</span></code>, <code class="docutils literal notranslate"><span class="pre">Zy</span></code>: A memory address operand, currently
treated the same as <code class="docutils literal notranslate"><span class="pre">m</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">r</span></code>: A 32 or 64-bit integer register.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">b</span></code>: A 32 or 64-bit integer register, excluding <code class="docutils literal notranslate"><span class="pre">R0</span></code> (that is:
<code class="docutils literal notranslate"><span class="pre">R1-R31</span></code>).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">f</span></code>: A 32 or 64-bit float register (<code class="docutils literal notranslate"><span class="pre">F0-F31</span></code>),</p></li>
<li><dl class="simple">
<dt><code class="docutils literal notranslate"><span class="pre">v</span></code>: For <code class="docutils literal notranslate"><span class="pre">4</span> <span class="pre">x</span> <span class="pre">f32</span></code> or <code class="docutils literal notranslate"><span class="pre">4</span> <span class="pre">x</span> <span class="pre">f64</span></code> types, a 128-bit altivec vector</dt><dd><p>register (<code class="docutils literal notranslate"><span class="pre">V0-V31</span></code>).</p>
</dd>
</dl>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">y</span></code>: Condition register (<code class="docutils literal notranslate"><span class="pre">CR0-CR7</span></code>).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">wc</span></code>: An individual CR bit in a CR register.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">wa</span></code>, <code class="docutils literal notranslate"><span class="pre">wd</span></code>, <code class="docutils literal notranslate"><span class="pre">wf</span></code>: Any 128-bit VSX vector register, from the full VSX
register set (overlapping both the floating-point and vector register files).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ws</span></code>: A 32 or 64-bit floating-point register, from the full VSX register
set.</p></li>
</ul>
<p>RISC-V:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">A</span></code>: An address operand (using a general-purpose register, without an
offset).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">I</span></code>: A 12-bit signed integer immediate operand.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">J</span></code>: A zero integer immediate operand.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">K</span></code>: A 5-bit unsigned integer immediate operand.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">f</span></code>: A 32- or 64-bit floating-point register (requires F or D extension).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">r</span></code>: A 32- or 64-bit general-purpose register (depending on the platform
<code class="docutils literal notranslate"><span class="pre">XLEN</span></code>).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">vr</span></code>: A vector register. (requires V extension).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">vm</span></code>: A vector mask register. (requires V extension).</p></li>
</ul>
<p>Sparc:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">I</span></code>: An immediate 13-bit signed integer.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">r</span></code>: A 32-bit integer register.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">f</span></code>: Any floating-point register on SparcV8, or a floating-point
register in the “low” half of the registers on SparcV9.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">e</span></code>: Any floating-point register. (Same as <code class="docutils literal notranslate"><span class="pre">f</span></code> on SparcV8.)</p></li>
</ul>
<p>SystemZ:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">I</span></code>: An immediate unsigned 8-bit integer.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">J</span></code>: An immediate unsigned 12-bit integer.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">K</span></code>: An immediate signed 16-bit integer.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">L</span></code>: An immediate signed 20-bit integer.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">M</span></code>: An immediate integer 0x7fffffff.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Q</span></code>: A memory address operand with a base address and a 12-bit immediate
unsigned displacement.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">R</span></code>: A memory address operand with a base address, a 12-bit immediate
unsigned displacement, and an index register.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">S</span></code>: A memory address operand with a base address and a 20-bit immediate
signed displacement.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">T</span></code>: A memory address operand with a base address, a 20-bit immediate
signed displacement, and an index register.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">r</span></code> or <code class="docutils literal notranslate"><span class="pre">d</span></code>: A 32, 64, or 128-bit integer register.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">a</span></code>: A 32, 64, or 128-bit integer address register (excludes R0, which in an
address context evaluates as zero).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">h</span></code>: A 32-bit value in the high part of a 64bit data register
(LLVM-specific)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">f</span></code>: A 32, 64, or 128-bit floating-point register.</p></li>
</ul>
<p>X86:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">I</span></code>: An immediate integer between 0 and 31.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">J</span></code>: An immediate integer between 0 and 64.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">K</span></code>: An immediate signed 8-bit integer.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">L</span></code>: An immediate integer, 0xff or 0xffff or (in 64-bit mode only)
0xffffffff.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">M</span></code>: An immediate integer between 0 and 3.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">N</span></code>: An immediate unsigned 8-bit integer.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">O</span></code>: An immediate integer between 0 and 127.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">e</span></code>: An immediate 32-bit signed integer.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Z</span></code>: An immediate 32-bit unsigned integer.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">o</span></code>, <code class="docutils literal notranslate"><span class="pre">v</span></code>: Treated the same as <code class="docutils literal notranslate"><span class="pre">m</span></code>, at the moment.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">q</span></code>: An 8, 16, 32, or 64-bit register which can be accessed as an 8-bit
<code class="docutils literal notranslate"><span class="pre">l</span></code> integer register. On X86-32, this is the <code class="docutils literal notranslate"><span class="pre">a</span></code>, <code class="docutils literal notranslate"><span class="pre">b</span></code>, <code class="docutils literal notranslate"><span class="pre">c</span></code>, and <code class="docutils literal notranslate"><span class="pre">d</span></code>
registers, and on X86-64, it is all of the integer registers.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Q</span></code>: An 8, 16, 32, or 64-bit register which can be accessed as an 8-bit
<code class="docutils literal notranslate"><span class="pre">h</span></code> integer register. This is the <code class="docutils literal notranslate"><span class="pre">a</span></code>, <code class="docutils literal notranslate"><span class="pre">b</span></code>, <code class="docutils literal notranslate"><span class="pre">c</span></code>, and <code class="docutils literal notranslate"><span class="pre">d</span></code> registers.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">r</span></code> or <code class="docutils literal notranslate"><span class="pre">l</span></code>: An 8, 16, 32, or 64-bit integer register.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">R</span></code>: An 8, 16, 32, or 64-bit “legacy” integer register – one which has
existed since i386, and can be accessed without the REX prefix.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">f</span></code>: A 32, 64, or 80-bit ‘387 FPU stack pseudo-register.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">y</span></code>: A 64-bit MMX register, if MMX is enabled.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">x</span></code>: If SSE is enabled: a 32 or 64-bit scalar operand, or 128-bit vector
operand in a SSE register. If AVX is also enabled, can also be a 256-bit
vector operand in an AVX register. If AVX-512 is also enabled, can also be a
512-bit vector operand in an AVX512 register, Otherwise, an error.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Y</span></code>: The same as <code class="docutils literal notranslate"><span class="pre">x</span></code>, if <em>SSE2</em> is enabled, otherwise an error.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">A</span></code>: Special case: allocates EAX first, then EDX, for a single operand (in
32-bit mode, a 64-bit integer operand will get split into two registers). It
is not recommended to use this constraint, as in 64-bit mode, the 64-bit
operand will get allocated only to RAX – if two 32-bit operands are needed,
you’re better off splitting it yourself, before passing it to the asm
statement.</p></li>
</ul>
<p>XCore:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">r</span></code>: A 32-bit integer register.</p></li>
</ul>
</div>
</div>
<div class="section" id="asm-template-argument-modifiers">
<span id="inline-asm-modifiers"></span><h4><a class="toc-backref" href="#id1496">Asm template argument modifiers</a><a class="headerlink" href="#asm-template-argument-modifiers" title="Permalink to this headline">¶</a></h4>
<p>In the asm template string, modifiers can be used on the operand reference, like
“<code class="docutils literal notranslate"><span class="pre">${0:n}</span></code>”.</p>
<p>The modifiers are, in general, expected to behave the same way they do in
GCC. LLVM’s support is often implemented on an ‘as-needed’ basis, to support C
inline asm code which was supported by GCC. A mismatch in behavior between LLVM
and GCC likely indicates a bug in LLVM.</p>
<p>Target-independent:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">c</span></code>: Print an immediate integer constant unadorned, without
the target-specific immediate punctuation (e.g. no <code class="docutils literal notranslate"><span class="pre">$</span></code> prefix).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">n</span></code>: Negate and print immediate integer constant unadorned, without the
target-specific immediate punctuation (e.g. no <code class="docutils literal notranslate"><span class="pre">$</span></code> prefix).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">l</span></code>: Print as an unadorned label, without the target-specific label
punctuation (e.g. no <code class="docutils literal notranslate"><span class="pre">$</span></code> prefix).</p></li>
</ul>
<p>AArch64:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">w</span></code>: Print a GPR register with a <code class="docutils literal notranslate"><span class="pre">w*</span></code> name instead of <code class="docutils literal notranslate"><span class="pre">x*</span></code> name. E.g.,
instead of <code class="docutils literal notranslate"><span class="pre">x30</span></code>, print <code class="docutils literal notranslate"><span class="pre">w30</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">x</span></code>: Print a GPR register with a <code class="docutils literal notranslate"><span class="pre">x*</span></code> name. (this is the default, anyhow).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">b</span></code>, <code class="docutils literal notranslate"><span class="pre">h</span></code>, <code class="docutils literal notranslate"><span class="pre">s</span></code>, <code class="docutils literal notranslate"><span class="pre">d</span></code>, <code class="docutils literal notranslate"><span class="pre">q</span></code>: Print a floating-point/SIMD register with a
<code class="docutils literal notranslate"><span class="pre">b*</span></code>, <code class="docutils literal notranslate"><span class="pre">h*</span></code>, <code class="docutils literal notranslate"><span class="pre">s*</span></code>, <code class="docutils literal notranslate"><span class="pre">d*</span></code>, or <code class="docutils literal notranslate"><span class="pre">q*</span></code> name, rather than the default of
<code class="docutils literal notranslate"><span class="pre">v*</span></code>.</p></li>
</ul>
<p>AMDGPU:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">r</span></code>: No effect.</p></li>
</ul>
<p>ARM:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">a</span></code>: Print an operand as an address (with <code class="docutils literal notranslate"><span class="pre">[</span></code> and <code class="docutils literal notranslate"><span class="pre">]</span></code> surrounding a
register).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">P</span></code>: No effect.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">q</span></code>: No effect.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">y</span></code>: Print a VFP single-precision register as an indexed double (e.g. print
as <code class="docutils literal notranslate"><span class="pre">d4[1]</span></code> instead of <code class="docutils literal notranslate"><span class="pre">s9</span></code>)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">B</span></code>: Bitwise invert and print an immediate integer constant without <code class="docutils literal notranslate"><span class="pre">#</span></code>
prefix.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">L</span></code>: Print the low 16-bits of an immediate integer constant.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">M</span></code>: Print as a register set suitable for ldm/stm. Also prints <em>all</em>
register operands subsequent to the specified one (!), so use carefully.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">Q</span></code>: Print the low-order register of a register-pair, or the low-order
register of a two-register operand.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">R</span></code>: Print the high-order register of a register-pair, or the high-order
register of a two-register operand.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">H</span></code>: Print the second register of a register-pair. (On a big-endian system,
<code class="docutils literal notranslate"><span class="pre">H</span></code> is equivalent to <code class="docutils literal notranslate"><span class="pre">Q</span></code>, and on little-endian system, <code class="docutils literal notranslate"><span class="pre">H</span></code> is equivalent
to <code class="docutils literal notranslate"><span class="pre">R</span></code>.)</p>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">e</span></code>: Print the low doubleword register of a NEON quad register.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">f</span></code>: Print the high doubleword register of a NEON quad register.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">m</span></code>: Print the base register of a memory operand without the <code class="docutils literal notranslate"><span class="pre">[</span></code> and <code class="docutils literal notranslate"><span class="pre">]</span></code>
adornment.</p></li>
</ul>
<p>Hexagon:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">L</span></code>: Print the second register of a two-register operand. Requires that it
has been allocated consecutively to the first.</p>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">I</span></code>: Print the letter ‘i’ if the operand is an integer constant, otherwise
nothing. Used to print ‘addi’ vs ‘add’ instructions.</p></li>
</ul>
<p>MSP430:</p>
<p>No additional modifiers.</p>
<p>MIPS:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">X</span></code>: Print an immediate integer as hexadecimal</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">x</span></code>: Print the low 16 bits of an immediate integer as hexadecimal.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">d</span></code>: Print an immediate integer as decimal.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">m</span></code>: Subtract one and print an immediate integer as decimal.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">z</span></code>: Print $0 if an immediate zero, otherwise print normally.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">L</span></code>: Print the low-order register of a two-register operand, or prints the
address of the low-order word of a double-word memory operand.</p>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">M</span></code>: Print the high-order register of a two-register operand, or prints the
address of the high-order word of a double-word memory operand.</p>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">D</span></code>: Print the second register of a two-register operand, or prints the
second word of a double-word memory operand. (On a big-endian system, <code class="docutils literal notranslate"><span class="pre">D</span></code> is
equivalent to <code class="docutils literal notranslate"><span class="pre">L</span></code>, and on little-endian system, <code class="docutils literal notranslate"><span class="pre">D</span></code> is equivalent to
<code class="docutils literal notranslate"><span class="pre">M</span></code>.)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">w</span></code>: No effect. Provided for compatibility with GCC which requires this
modifier in order to print MSA registers (<code class="docutils literal notranslate"><span class="pre">W0-W31</span></code>) with the <code class="docutils literal notranslate"><span class="pre">f</span></code>
constraint.</p></li>
</ul>
<p>NVPTX:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">r</span></code>: No effect.</p></li>
</ul>
<p>PowerPC:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">L</span></code>: Print the second register of a two-register operand. Requires that it
has been allocated consecutively to the first.</p>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">I</span></code>: Print the letter ‘i’ if the operand is an integer constant, otherwise
nothing. Used to print ‘addi’ vs ‘add’ instructions.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">y</span></code>: For a memory operand, prints formatter for a two-register X-form
instruction. (Currently always prints <code class="docutils literal notranslate"><span class="pre">r0,OPERAND</span></code>).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">U</span></code>: Prints ‘u’ if the memory operand is an update form, and nothing
otherwise. (NOTE: LLVM does not support update form, so this will currently
always print nothing)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">X</span></code>: Prints ‘x’ if the memory operand is an indexed form. (NOTE: LLVM does
not support indexed form, so this will currently always print nothing)</p></li>
</ul>
<p>RISC-V:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">i</span></code>: Print the letter ‘i’ if the operand is not a register, otherwise print
nothing. Used to print ‘addi’ vs ‘add’ instructions, etc.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">z</span></code>: Print the register <code class="docutils literal notranslate"><span class="pre">zero</span></code> if an immediate zero, otherwise print
normally.</p></li>
</ul>
<p>Sparc:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">r</span></code>: No effect.</p></li>
</ul>
<p>SystemZ:</p>
<p>SystemZ implements only <code class="docutils literal notranslate"><span class="pre">n</span></code>, and does <em>not</em> support any of the other
target-independent modifiers.</p>
<p>X86:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">c</span></code>: Print an unadorned integer or symbol name. (The latter is
target-specific behavior for this typically target-independent modifier).</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">A</span></code>: Print a register name with a ‘<code class="docutils literal notranslate"><span class="pre">*</span></code>’ before it.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">b</span></code>: Print an 8-bit register name (e.g. <code class="docutils literal notranslate"><span class="pre">al</span></code>); do nothing on a memory
operand.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">h</span></code>: Print the upper 8-bit register name (e.g. <code class="docutils literal notranslate"><span class="pre">ah</span></code>); do nothing on a
memory operand.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">w</span></code>: Print the 16-bit register name (e.g. <code class="docutils literal notranslate"><span class="pre">ax</span></code>); do nothing on a memory
operand.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">k</span></code>: Print the 32-bit register name (e.g. <code class="docutils literal notranslate"><span class="pre">eax</span></code>); do nothing on a memory
operand.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">q</span></code>: Print the 64-bit register name (e.g. <code class="docutils literal notranslate"><span class="pre">rax</span></code>), if 64-bit registers are
available, otherwise the 32-bit register name; do nothing on a memory operand.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">n</span></code>: Negate and print an unadorned integer, or, for operands other than an
immediate integer (e.g. a relocatable symbol expression), print a ‘-‘ before
the operand. (The behavior for relocatable symbol expressions is a
target-specific behavior for this typically target-independent modifier)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">H</span></code>: Print a memory reference with additional offset +8.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">P</span></code>: Print a memory reference or operand for use as the argument of a call
instruction. (E.g. omit <code class="docutils literal notranslate"><span class="pre">(rip)</span></code>, even though it’s PC-relative.)</p></li>
</ul>
<p>XCore:</p>
<p>No additional modifiers.</p>
</div>
<div class="section" id="inline-asm-metadata">
<h4><a class="toc-backref" href="#id1497">Inline Asm Metadata</a><a class="headerlink" href="#inline-asm-metadata" title="Permalink to this headline">¶</a></h4>
<p>The call instructions that wrap inline asm nodes may have a
“<code class="docutils literal notranslate"><span class="pre">!srcloc</span></code>” MDNode attached to it that contains a list of constant
integers. If present, the code generator will use the integer as the
location cookie value when report errors through the <code class="docutils literal notranslate"><span class="pre">LLVMContext</span></code>
error reporting mechanisms. This allows a front-end to correlate backend
errors that occur with inline asm back to the source code that produced
it. For example:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">call</span> <span class="k">void</span> <span class="k">asm</span> <span class="k">sideeffect</span> <span class="s">"something bad"</span><span class="p">,</span> <span class="s">""</span><span class="p">(),</span> <span class="nv">!srcloc</span> <span class="nv nv-Anonymous">!42</span>
<span class="p">...</span>
<span class="nv nv-Anonymous">!42</span> <span class="p">=</span> <span class="p">!{</span> <span class="k">i32</span> <span class="m">1234567</span> <span class="p">}</span>
</pre></div>
</div>
<p>It is up to the front-end to make sense of the magic numbers it places
in the IR. If the MDNode contains multiple constants, the code generator
will use the one that corresponds to the line of the asm that the error
occurs on.</p>
</div>
</div>
</div>
<div class="section" id="metadata">
<span id="id6"></span><h2><a class="toc-backref" href="#id1498">Metadata</a><a class="headerlink" href="#metadata" title="Permalink to this headline">¶</a></h2>
<p>LLVM IR allows metadata to be attached to instructions and global objects in the
program that can convey extra information about the code to the optimizers and
code generator. One example application of metadata is source-level
debug information. There are two metadata primitives: strings and nodes.</p>
<p>Metadata does not have a type, and is not a value. If referenced from a
<code class="docutils literal notranslate"><span class="pre">call</span></code> instruction, it uses the <code class="docutils literal notranslate"><span class="pre">metadata</span></code> type.</p>
<p>All metadata are identified in syntax by an exclamation point (‘<code class="docutils literal notranslate"><span class="pre">!</span></code>’).</p>
<div class="section" id="metadata-nodes-and-metadata-strings">
<span id="metadata-string"></span><h3><a class="toc-backref" href="#id1499">Metadata Nodes and Metadata Strings</a><a class="headerlink" href="#metadata-nodes-and-metadata-strings" title="Permalink to this headline">¶</a></h3>
<p>A metadata string is a string surrounded by double quotes. It can
contain any character by escaping non-printable characters with
“<code class="docutils literal notranslate"><span class="pre">\xx</span></code>” where “<code class="docutils literal notranslate"><span class="pre">xx</span></code>” is the two digit hex code. For example:
“<code class="docutils literal notranslate"><span class="pre">!"test\00"</span></code>”.</p>
<p>Metadata nodes are represented with notation similar to structure
constants (a comma separated list of elements, surrounded by braces and
preceded by an exclamation point). Metadata nodes can have any values as
their operand. For example:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="p">!{</span> <span class="nv">!"test\00"</span><span class="p">,</span> <span class="k">i32</span> <span class="m">10</span><span class="p">}</span>
</pre></div>
</div>
<p>Metadata nodes that aren’t uniqued use the <code class="docutils literal notranslate"><span class="pre">distinct</span></code> keyword. For example:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>!0 = distinct !{!"test\00", i32 10}
</pre></div>
</div>
<p><code class="docutils literal notranslate"><span class="pre">distinct</span></code> nodes are useful when nodes shouldn’t be merged based on their
content. They can also occur when transformations cause uniquing collisions
when metadata operands change.</p>
<p>A <a class="reference internal" href="#namedmetadatastructure"><span class="std std-ref">named metadata</span></a> is a collection of
metadata nodes, which can be looked up in the module symbol table. For
example:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">!foo</span> <span class="p">=</span> <span class="p">!{</span><span class="nv nv-Anonymous">!4</span><span class="p">,</span> <span class="nv nv-Anonymous">!3</span><span class="p">}</span>
</pre></div>
</div>
<p>Metadata can be used as function arguments. Here the <code class="docutils literal notranslate"><span class="pre">llvm.dbg.value</span></code>
intrinsic is using three metadata arguments:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">call</span> <span class="k">void</span> <span class="vg">@llvm.dbg.value</span><span class="p">(</span><span class="k">metadata</span> <span class="nv nv-Anonymous">!24</span><span class="p">,</span> <span class="k">metadata</span> <span class="nv nv-Anonymous">!25</span><span class="p">,</span> <span class="k">metadata</span> <span class="nv nv-Anonymous">!26</span><span class="p">)</span>
</pre></div>
</div>
<p>Metadata can be attached to an instruction. Here metadata <code class="docutils literal notranslate"><span class="pre">!21</span></code> is attached
to the <code class="docutils literal notranslate"><span class="pre">add</span></code> instruction using the <code class="docutils literal notranslate"><span class="pre">!dbg</span></code> identifier:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%indvar.next</span> <span class="p">=</span> <span class="k">add</span> <span class="k">i64</span> <span class="nv">%indvar</span><span class="p">,</span> <span class="m">1</span><span class="p">,</span> <span class="nv">!dbg</span> <span class="nv nv-Anonymous">!21</span>
</pre></div>
</div>
<p>Instructions may not have multiple metadata attachments with the same
identifier.</p>
<p>Metadata can also be attached to a function or a global variable. Here metadata
<code class="docutils literal notranslate"><span class="pre">!22</span></code> is attached to the <code class="docutils literal notranslate"><span class="pre">f1</span></code> and <code class="docutils literal notranslate"><span class="pre">f2</span></code> functions, and the globals <code class="docutils literal notranslate"><span class="pre">g1</span></code>
and <code class="docutils literal notranslate"><span class="pre">g2</span></code> using the <code class="docutils literal notranslate"><span class="pre">!dbg</span></code> identifier:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">declare</span> <span class="nv">!dbg</span> <span class="nv nv-Anonymous">!22</span> <span class="k">void</span> <span class="vg">@f1</span><span class="p">()</span>
<span class="k">define</span> <span class="k">void</span> <span class="vg">@f2</span><span class="p">()</span> <span class="nv">!dbg</span> <span class="nv nv-Anonymous">!22</span> <span class="p">{</span>
<span class="k">ret</span> <span class="k">void</span>
<span class="p">}</span>
<span class="vg">@g1</span> <span class="p">=</span> <span class="k">global</span> <span class="k">i32</span> <span class="m">0</span><span class="p">,</span> <span class="nv">!dbg</span> <span class="nv nv-Anonymous">!22</span>
<span class="vg">@g2</span> <span class="p">=</span> <span class="k">external</span> <span class="k">global</span> <span class="k">i32</span><span class="p">,</span> <span class="nv">!dbg</span> <span class="nv nv-Anonymous">!22</span>
</pre></div>
</div>
<p>Unlike instructions, global objects (functions and global variables) may have
multiple metadata attachments with the same identifier.</p>
<p>A transformation is required to drop any metadata attachment that it does not
know or know it can’t preserve. Currently there is an exception for metadata
attachment to globals for <code class="docutils literal notranslate"><span class="pre">!type</span></code> and <code class="docutils literal notranslate"><span class="pre">!absolute_symbol</span></code> which can’t be
unconditionally dropped unless the global is itself deleted.</p>
<p>Metadata attached to a module using named metadata may not be dropped, with
the exception of debug metadata (named metadata with the name <code class="docutils literal notranslate"><span class="pre">!llvm.dbg.*</span></code>).</p>
<p>More information about specific metadata nodes recognized by the
optimizers and code generator is found below.</p>
<div class="section" id="specialized-metadata-nodes">
<span id="specialized-metadata"></span><h4><a class="toc-backref" href="#id1500">Specialized Metadata Nodes</a><a class="headerlink" href="#specialized-metadata-nodes" title="Permalink to this headline">¶</a></h4>
<p>Specialized metadata nodes are custom data structures in metadata (as opposed
to generic tuples). Their fields are labelled, and can be specified in any
order.</p>
<p>These aren’t inherently debug info centric, but currently all the specialized
metadata nodes are related to debug info.</p>
<div class="section" id="dicompileunit">
<span id="id7"></span><h5><a class="toc-backref" href="#id1501">DICompileUnit</a><a class="headerlink" href="#dicompileunit" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DICompileUnit</span></code> nodes represent a compile unit. The <code class="docutils literal notranslate"><span class="pre">enums:</span></code>,
<code class="docutils literal notranslate"><span class="pre">retainedTypes:</span></code>, <code class="docutils literal notranslate"><span class="pre">globals:</span></code>, <code class="docutils literal notranslate"><span class="pre">imports:</span></code> and <code class="docutils literal notranslate"><span class="pre">macros:</span></code> fields are tuples
containing the debug info to be emitted along with the compile unit, regardless
of code optimizations (some nodes are only emitted if there are references to
them from instructions). The <code class="docutils literal notranslate"><span class="pre">debugInfoForProfiling:</span></code> field is a boolean
indicating whether or not line-table discriminators are updated to provide
more-accurate debug info for profiling results.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>!0 = !DICompileUnit(language: DW_LANG_C99, file: !1, producer: "clang",
isOptimized: true, flags: "-O2", runtimeVersion: 2,
splitDebugFilename: "abc.debug", emissionKind: FullDebug,
enums: !2, retainedTypes: !3, globals: !4, imports: !5,
macros: !6, dwoId: 0x0abcd)
</pre></div>
</div>
<p>Compile unit descriptors provide the root scope for objects declared in a
specific compilation unit. File descriptors are defined using this scope. These
descriptors are collected by a named metadata node <code class="docutils literal notranslate"><span class="pre">!llvm.dbg.cu</span></code>. They keep
track of global variables, type information, and imported entities (declarations
and namespaces).</p>
</div>
<div class="section" id="difile">
<span id="id8"></span><h5><a class="toc-backref" href="#id1502">DIFile</a><a class="headerlink" href="#difile" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DIFile</span></code> nodes represent files. The <code class="docutils literal notranslate"><span class="pre">filename:</span></code> can include slashes.</p>
<div class="highlight-none notranslate"><div class="highlight"><pre><span></span>!0 = !DIFile(filename: "path/to/file", directory: "/path/to/dir",
checksumkind: CSK_MD5,
checksum: "000102030405060708090a0b0c0d0e0f")
</pre></div>
</div>
<p>Files are sometimes used in <code class="docutils literal notranslate"><span class="pre">scope:</span></code> fields, and are the only valid target
for <code class="docutils literal notranslate"><span class="pre">file:</span></code> fields.
Valid values for <code class="docutils literal notranslate"><span class="pre">checksumkind:</span></code> field are: {CSK_None, CSK_MD5, CSK_SHA1, CSK_SHA256}</p>
</div>
<div class="section" id="dibasictype">
<span id="id9"></span><h5><a class="toc-backref" href="#id1503">DIBasicType</a><a class="headerlink" href="#dibasictype" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DIBasicType</span></code> nodes represent primitive types, such as <code class="docutils literal notranslate"><span class="pre">int</span></code>, <code class="docutils literal notranslate"><span class="pre">bool</span></code> and
<code class="docutils literal notranslate"><span class="pre">float</span></code>. <code class="docutils literal notranslate"><span class="pre">tag:</span></code> defaults to <code class="docutils literal notranslate"><span class="pre">DW_TAG_base_type</span></code>.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>!0 = !DIBasicType(name: "unsigned char", size: 8, align: 8,
encoding: DW_ATE_unsigned_char)
!1 = !DIBasicType(tag: DW_TAG_unspecified_type, name: "decltype(nullptr)")
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">encoding:</span></code> describes the details of the type. Usually it’s one of the
following:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>DW_ATE_address = 1
DW_ATE_boolean = 2
DW_ATE_float = 4
DW_ATE_signed = 5
DW_ATE_signed_char = 6
DW_ATE_unsigned = 7
DW_ATE_unsigned_char = 8
</pre></div>
</div>
</div>
<div class="section" id="disubroutinetype">
<span id="id10"></span><h5><a class="toc-backref" href="#id1504">DISubroutineType</a><a class="headerlink" href="#disubroutinetype" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DISubroutineType</span></code> nodes represent subroutine types. Their <code class="docutils literal notranslate"><span class="pre">types:</span></code> field
refers to a tuple; the first operand is the return type, while the rest are the
types of the formal arguments in order. If the first operand is <code class="docutils literal notranslate"><span class="pre">null</span></code>, that
represents a function with no return value (such as <code class="docutils literal notranslate"><span class="pre">void</span> <span class="pre">foo()</span> <span class="pre">{}</span></code> in C++).</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>!0 = !BasicType(name: "int", size: 32, align: 32, DW_ATE_signed)
!1 = !BasicType(name: "char", size: 8, align: 8, DW_ATE_signed_char)
!2 = !DISubroutineType(types: !{null, !0, !1}) ; void (int, char)
</pre></div>
</div>
</div>
<div class="section" id="diderivedtype">
<span id="id11"></span><h5><a class="toc-backref" href="#id1505">DIDerivedType</a><a class="headerlink" href="#diderivedtype" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DIDerivedType</span></code> nodes represent types derived from other types, such as
qualified types.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>!0 = !DIBasicType(name: "unsigned char", size: 8, align: 8,
encoding: DW_ATE_unsigned_char)
!1 = !DIDerivedType(tag: DW_TAG_pointer_type, baseType: !0, size: 32,
align: 32)
</pre></div>
</div>
<p>The following <code class="docutils literal notranslate"><span class="pre">tag:</span></code> values are valid:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>DW_TAG_member = 13
DW_TAG_pointer_type = 15
DW_TAG_reference_type = 16
DW_TAG_typedef = 22
DW_TAG_inheritance = 28
DW_TAG_ptr_to_member_type = 31
DW_TAG_const_type = 38
DW_TAG_friend = 42
DW_TAG_volatile_type = 53
DW_TAG_restrict_type = 55
DW_TAG_atomic_type = 71
</pre></div>
</div>
<p id="diderivedtypemember"><code class="docutils literal notranslate"><span class="pre">DW_TAG_member</span></code> is used to define a member of a <a class="reference internal" href="#dicompositetype"><span class="std std-ref">composite type</span></a>. The type of the member is the <code class="docutils literal notranslate"><span class="pre">baseType:</span></code>. The
<code class="docutils literal notranslate"><span class="pre">offset:</span></code> is the member’s bit offset. If the composite type has an ODR
<code class="docutils literal notranslate"><span class="pre">identifier:</span></code> and does not set <code class="docutils literal notranslate"><span class="pre">flags:</span> <span class="pre">DIFwdDecl</span></code>, then the member is
uniqued based only on its <code class="docutils literal notranslate"><span class="pre">name:</span></code> and <code class="docutils literal notranslate"><span class="pre">scope:</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">DW_TAG_inheritance</span></code> and <code class="docutils literal notranslate"><span class="pre">DW_TAG_friend</span></code> are used in the <code class="docutils literal notranslate"><span class="pre">elements:</span></code>
field of <a class="reference internal" href="#dicompositetype"><span class="std std-ref">composite types</span></a> to describe parents and
friends.</p>
<p><code class="docutils literal notranslate"><span class="pre">DW_TAG_typedef</span></code> is used to provide a name for the <code class="docutils literal notranslate"><span class="pre">baseType:</span></code>.</p>
<p><code class="docutils literal notranslate"><span class="pre">DW_TAG_pointer_type</span></code>, <code class="docutils literal notranslate"><span class="pre">DW_TAG_reference_type</span></code>, <code class="docutils literal notranslate"><span class="pre">DW_TAG_const_type</span></code>,
<code class="docutils literal notranslate"><span class="pre">DW_TAG_volatile_type</span></code>, <code class="docutils literal notranslate"><span class="pre">DW_TAG_restrict_type</span></code> and <code class="docutils literal notranslate"><span class="pre">DW_TAG_atomic_type</span></code>
are used to qualify the <code class="docutils literal notranslate"><span class="pre">baseType:</span></code>.</p>
<p>Note that the <code class="docutils literal notranslate"><span class="pre">void</span> <span class="pre">*</span></code> type is expressed as a type derived from NULL.</p>
</div>
<div class="section" id="dicompositetype">
<span id="id12"></span><h5><a class="toc-backref" href="#id1506">DICompositeType</a><a class="headerlink" href="#dicompositetype" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DICompositeType</span></code> nodes represent types composed of other types, like
structures and unions. <code class="docutils literal notranslate"><span class="pre">elements:</span></code> points to a tuple of the composed types.</p>
<p>If the source language supports ODR, the <code class="docutils literal notranslate"><span class="pre">identifier:</span></code> field gives the unique
identifier used for type merging between modules. When specified,
<a class="reference internal" href="#disubprogramdeclaration"><span class="std std-ref">subprogram declarations</span></a> and <a class="reference internal" href="#diderivedtypemember"><span class="std std-ref">member
derived types</span></a> that reference the ODR-type in their
<code class="docutils literal notranslate"><span class="pre">scope:</span></code> change uniquing rules.</p>
<p>For a given <code class="docutils literal notranslate"><span class="pre">identifier:</span></code>, there should only be a single composite type that
does not have <code class="docutils literal notranslate"><span class="pre">flags:</span> <span class="pre">DIFlagFwdDecl</span></code> set. LLVM tools that link modules
together will unique such definitions at parse time via the <code class="docutils literal notranslate"><span class="pre">identifier:</span></code>
field, even if the nodes are <code class="docutils literal notranslate"><span class="pre">distinct</span></code>.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>!0 = !DIEnumerator(name: "SixKind", value: 7)
!1 = !DIEnumerator(name: "SevenKind", value: 7)
!2 = !DIEnumerator(name: "NegEightKind", value: -8)
!3 = !DICompositeType(tag: DW_TAG_enumeration_type, name: "Enum", file: !12,
line: 2, size: 32, align: 32, identifier: "_M4Enum",
elements: !{!0, !1, !2})
</pre></div>
</div>
<p>The following <code class="docutils literal notranslate"><span class="pre">tag:</span></code> values are valid:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>DW_TAG_array_type = 1
DW_TAG_class_type = 2
DW_TAG_enumeration_type = 4
DW_TAG_structure_type = 19
DW_TAG_union_type = 23
</pre></div>
</div>
<p>For <code class="docutils literal notranslate"><span class="pre">DW_TAG_array_type</span></code>, the <code class="docutils literal notranslate"><span class="pre">elements:</span></code> should be <a class="reference internal" href="#disubrange"><span class="std std-ref">subrange
descriptors</span></a>, each representing the range of subscripts at that
level of indexing. The <code class="docutils literal notranslate"><span class="pre">DIFlagVector</span></code> flag to <code class="docutils literal notranslate"><span class="pre">flags:</span></code> indicates that an
array type is a native packed vector. The optional <code class="docutils literal notranslate"><span class="pre">dataLocation</span></code> is a
DIExpression that describes how to get from an object’s address to the actual
raw data, if they aren’t equivalent. This is only supported for array types,
particularly to describe Fortran arrays, which have an array descriptor in
addition to the array data. Alternatively it can also be DIVariable which
has the address of the actual raw data. The Fortran language supports pointer
arrays which can be attached to actual arrays, this attachment between pointer
and pointee is called association. The optional <code class="docutils literal notranslate"><span class="pre">associated</span></code> is a
DIExpression that describes whether the pointer array is currently associated.
The optional <code class="docutils literal notranslate"><span class="pre">allocated</span></code> is a DIExpression that describes whether the
allocatable array is currently allocated. The optional <code class="docutils literal notranslate"><span class="pre">rank</span></code> is a
DIExpression that describes the rank (number of dimensions) of fortran assumed
rank array (rank is known at runtime).</p>
<p>For <code class="docutils literal notranslate"><span class="pre">DW_TAG_enumeration_type</span></code>, the <code class="docutils literal notranslate"><span class="pre">elements:</span></code> should be <a class="reference internal" href="#dienumerator"><span class="std std-ref">enumerator
descriptors</span></a>, each representing the definition of an enumeration
value for the set. All enumeration type descriptors are collected in the
<code class="docutils literal notranslate"><span class="pre">enums:</span></code> field of the <a class="reference internal" href="#dicompileunit"><span class="std std-ref">compile unit</span></a>.</p>
<p>For <code class="docutils literal notranslate"><span class="pre">DW_TAG_structure_type</span></code>, <code class="docutils literal notranslate"><span class="pre">DW_TAG_class_type</span></code>, and
<code class="docutils literal notranslate"><span class="pre">DW_TAG_union_type</span></code>, the <code class="docutils literal notranslate"><span class="pre">elements:</span></code> should be <a class="reference internal" href="#diderivedtype"><span class="std std-ref">derived types</span></a> with <code class="docutils literal notranslate"><span class="pre">tag:</span> <span class="pre">DW_TAG_member</span></code>, <code class="docutils literal notranslate"><span class="pre">tag:</span> <span class="pre">DW_TAG_inheritance</span></code>, or
<code class="docutils literal notranslate"><span class="pre">tag:</span> <span class="pre">DW_TAG_friend</span></code>; or <a class="reference internal" href="#disubprogram"><span class="std std-ref">subprograms</span></a> with
<code class="docutils literal notranslate"><span class="pre">isDefinition:</span> <span class="pre">false</span></code>.</p>
</div>
<div class="section" id="disubrange">
<span id="id13"></span><h5><a class="toc-backref" href="#id1507">DISubrange</a><a class="headerlink" href="#disubrange" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DISubrange</span></code> nodes are the elements for <code class="docutils literal notranslate"><span class="pre">DW_TAG_array_type</span></code> variants of
<a class="reference internal" href="#dicompositetype"><span class="std std-ref">DICompositeType</span></a>.</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">count:</span> <span class="pre">-1</span></code> indicates an empty array.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">count:</span> <span class="pre">!9</span></code> describes the count with a <a class="reference internal" href="#dilocalvariable"><span class="std std-ref">DILocalVariable</span></a>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">count:</span> <span class="pre">!11</span></code> describes the count with a <a class="reference internal" href="#diglobalvariable"><span class="std std-ref">DIGlobalVariable</span></a>.</p></li>
</ul>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>!0 = !DISubrange(count: 5, lowerBound: 0) ; array counting from 0
!1 = !DISubrange(count: 5, lowerBound: 1) ; array counting from 1
!2 = !DISubrange(count: -1) ; empty array.
; Scopes used in rest of example
!6 = !DIFile(filename: "vla.c", directory: "/path/to/file")
!7 = distinct !DICompileUnit(language: DW_LANG_C99, file: !6)
!8 = distinct !DISubprogram(name: "foo", scope: !7, file: !6, line: 5)
; Use of local variable as count value
!9 = !DIBasicType(name: "int", size: 32, encoding: DW_ATE_signed)
!10 = !DILocalVariable(name: "count", scope: !8, file: !6, line: 42, type: !9)
!11 = !DISubrange(count: !10, lowerBound: 0)
; Use of global variable as count value
!12 = !DIGlobalVariable(name: "count", scope: !8, file: !6, line: 22, type: !9)
!13 = !DISubrange(count: !12, lowerBound: 0)
</pre></div>
</div>
</div>
<div class="section" id="dienumerator">
<span id="id14"></span><h5><a class="toc-backref" href="#id1508">DIEnumerator</a><a class="headerlink" href="#dienumerator" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DIEnumerator</span></code> nodes are the elements for <code class="docutils literal notranslate"><span class="pre">DW_TAG_enumeration_type</span></code>
variants of <a class="reference internal" href="#dicompositetype"><span class="std std-ref">DICompositeType</span></a>.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>!0 = !DIEnumerator(name: "SixKind", value: 7)
!1 = !DIEnumerator(name: "SevenKind", value: 7)
!2 = !DIEnumerator(name: "NegEightKind", value: -8)
</pre></div>
</div>
</div>
<div class="section" id="ditemplatetypeparameter">
<h5><a class="toc-backref" href="#id1509">DITemplateTypeParameter</a><a class="headerlink" href="#ditemplatetypeparameter" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DITemplateTypeParameter</span></code> nodes represent type parameters to generic source
language constructs. They are used (optionally) in <a class="reference internal" href="#dicompositetype"><span class="std std-ref">DICompositeType</span></a> and
<a class="reference internal" href="#disubprogram"><span class="std std-ref">DISubprogram</span></a> <code class="docutils literal notranslate"><span class="pre">templateParams:</span></code> fields.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>!0 = !DITemplateTypeParameter(name: "Ty", type: !1)
</pre></div>
</div>
</div>
<div class="section" id="ditemplatevalueparameter">
<h5><a class="toc-backref" href="#id1510">DITemplateValueParameter</a><a class="headerlink" href="#ditemplatevalueparameter" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DITemplateValueParameter</span></code> nodes represent value parameters to generic source
language constructs. <code class="docutils literal notranslate"><span class="pre">tag:</span></code> defaults to <code class="docutils literal notranslate"><span class="pre">DW_TAG_template_value_parameter</span></code>,
but if specified can also be set to <code class="docutils literal notranslate"><span class="pre">DW_TAG_GNU_template_template_param</span></code> or
<code class="docutils literal notranslate"><span class="pre">DW_TAG_GNU_template_param_pack</span></code>. They are used (optionally) in
<a class="reference internal" href="#dicompositetype"><span class="std std-ref">DICompositeType</span></a> and <a class="reference internal" href="#disubprogram"><span class="std std-ref">DISubprogram</span></a> <code class="docutils literal notranslate"><span class="pre">templateParams:</span></code> fields.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>!0 = !DITemplateValueParameter(name: "Ty", type: !1, value: i32 7)
</pre></div>
</div>
</div>
<div class="section" id="dinamespace">
<h5><a class="toc-backref" href="#id1511">DINamespace</a><a class="headerlink" href="#dinamespace" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DINamespace</span></code> nodes represent namespaces in the source language.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>!0 = !DINamespace(name: "myawesomeproject", scope: !1, file: !2, line: 7)
</pre></div>
</div>
</div>
<div class="section" id="diglobalvariable">
<span id="id15"></span><h5><a class="toc-backref" href="#id1512">DIGlobalVariable</a><a class="headerlink" href="#diglobalvariable" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DIGlobalVariable</span></code> nodes represent global variables in the source language.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>@foo = global i32, !dbg !0
!0 = !DIGlobalVariableExpression(var: !1, expr: !DIExpression())
!1 = !DIGlobalVariable(name: "foo", linkageName: "foo", scope: !2,
file: !3, line: 7, type: !4, isLocal: true,
isDefinition: false, declaration: !5)
</pre></div>
</div>
</div>
<div class="section" id="diglobalvariableexpression">
<h5><a class="toc-backref" href="#id1513">DIGlobalVariableExpression</a><a class="headerlink" href="#diglobalvariableexpression" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DIGlobalVariableExpression</span></code> nodes tie a <a class="reference internal" href="#diglobalvariable"><span class="std std-ref">DIGlobalVariable</span></a> together
with a <a class="reference internal" href="#diexpression"><span class="std std-ref">DIExpression</span></a>.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>@lower = global i32, !dbg !0
@upper = global i32, !dbg !1
!0 = !DIGlobalVariableExpression(
var: !2,
expr: !DIExpression(DW_OP_LLVM_fragment, 0, 32)
)
!1 = !DIGlobalVariableExpression(
var: !2,
expr: !DIExpression(DW_OP_LLVM_fragment, 32, 32)
)
!2 = !DIGlobalVariable(name: "split64", linkageName: "split64", scope: !3,
file: !4, line: 8, type: !5, declaration: !6)
</pre></div>
</div>
<p>All global variable expressions should be referenced by the <cite>globals:</cite> field of
a <a class="reference internal" href="#dicompileunit"><span class="std std-ref">compile unit</span></a>.</p>
</div>
<div class="section" id="disubprogram">
<span id="id16"></span><h5><a class="toc-backref" href="#id1514">DISubprogram</a><a class="headerlink" href="#disubprogram" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DISubprogram</span></code> nodes represent functions from the source language. A distinct
<code class="docutils literal notranslate"><span class="pre">DISubprogram</span></code> may be attached to a function definition using <code class="docutils literal notranslate"><span class="pre">!dbg</span></code>
metadata. A unique <code class="docutils literal notranslate"><span class="pre">DISubprogram</span></code> may be attached to a function declaration
used for call site debug info. The <code class="docutils literal notranslate"><span class="pre">retainedNodes:</span></code> field is a list of
<a class="reference internal" href="#dilocalvariable"><span class="std std-ref">variables</span></a> and <a class="reference internal" href="#dilabel"><span class="std std-ref">labels</span></a> that must be
retained, even if their IR counterparts are optimized out of the IR. The
<code class="docutils literal notranslate"><span class="pre">type:</span></code> field must point at an <a class="reference internal" href="#disubroutinetype"><span class="std std-ref">DISubroutineType</span></a>.</p>
<p id="disubprogramdeclaration">When <code class="docutils literal notranslate"><span class="pre">isDefinition:</span> <span class="pre">false</span></code>, subprograms describe a declaration in the type
tree as opposed to a definition of a function. If the scope is a composite
type with an ODR <code class="docutils literal notranslate"><span class="pre">identifier:</span></code> and that does not set <code class="docutils literal notranslate"><span class="pre">flags:</span> <span class="pre">DIFwdDecl</span></code>,
then the subprogram declaration is uniqued based only on its <code class="docutils literal notranslate"><span class="pre">linkageName:</span></code>
and <code class="docutils literal notranslate"><span class="pre">scope:</span></code>.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>define void @_Z3foov() !dbg !0 {
...
}
!0 = distinct !DISubprogram(name: "foo", linkageName: "_Zfoov", scope: !1,
file: !2, line: 7, type: !3, isLocal: true,
isDefinition: true, scopeLine: 8,
containingType: !4,
virtuality: DW_VIRTUALITY_pure_virtual,
virtualIndex: 10, flags: DIFlagPrototyped,
isOptimized: true, unit: !5, templateParams: !6,
declaration: !7, retainedNodes: !8,
thrownTypes: !9)
</pre></div>
</div>
</div>
<div class="section" id="dilexicalblock">
<span id="id17"></span><h5><a class="toc-backref" href="#id1515">DILexicalBlock</a><a class="headerlink" href="#dilexicalblock" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DILexicalBlock</span></code> nodes describe nested blocks within a <a class="reference internal" href="#disubprogram"><span class="std std-ref">subprogram</span></a>. The line number and column numbers are used to distinguish
two lexical blocks at same depth. They are valid targets for <code class="docutils literal notranslate"><span class="pre">scope:</span></code>
fields.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>!0 = distinct !DILexicalBlock(scope: !1, file: !2, line: 7, column: 35)
</pre></div>
</div>
<p>Usually lexical blocks are <code class="docutils literal notranslate"><span class="pre">distinct</span></code> to prevent node merging based on
operands.</p>
</div>
<div class="section" id="dilexicalblockfile">
<span id="id18"></span><h5><a class="toc-backref" href="#id1516">DILexicalBlockFile</a><a class="headerlink" href="#dilexicalblockfile" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DILexicalBlockFile</span></code> nodes are used to discriminate between sections of a
<a class="reference internal" href="#dilexicalblock"><span class="std std-ref">lexical block</span></a>. The <code class="docutils literal notranslate"><span class="pre">file:</span></code> field can be changed to
indicate textual inclusion, or the <code class="docutils literal notranslate"><span class="pre">discriminator:</span></code> field can be used to
discriminate between control flow within a single block in the source language.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>!0 = !DILexicalBlock(scope: !3, file: !4, line: 7, column: 35)
!1 = !DILexicalBlockFile(scope: !0, file: !4, discriminator: 0)
!2 = !DILexicalBlockFile(scope: !0, file: !4, discriminator: 1)
</pre></div>
</div>
</div>
<div class="section" id="dilocation">
<span id="id19"></span><h5><a class="toc-backref" href="#id1517">DILocation</a><a class="headerlink" href="#dilocation" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DILocation</span></code> nodes represent source debug locations. The <code class="docutils literal notranslate"><span class="pre">scope:</span></code> field is
mandatory, and points at an <a class="reference internal" href="#dilexicalblockfile"><span class="std std-ref">DILexicalBlockFile</span></a>, an
<a class="reference internal" href="#dilexicalblock"><span class="std std-ref">DILexicalBlock</span></a>, or an <a class="reference internal" href="#disubprogram"><span class="std std-ref">DISubprogram</span></a>.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>!0 = !DILocation(line: 2900, column: 42, scope: !1, inlinedAt: !2)
</pre></div>
</div>
</div>
<div class="section" id="dilocalvariable">
<span id="id20"></span><h5><a class="toc-backref" href="#id1518">DILocalVariable</a><a class="headerlink" href="#dilocalvariable" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DILocalVariable</span></code> nodes represent local variables in the source language. If
the <code class="docutils literal notranslate"><span class="pre">arg:</span></code> field is set to non-zero, then this variable is a subprogram
parameter, and it will be included in the <code class="docutils literal notranslate"><span class="pre">retainedNodes:</span></code> field of its
<a class="reference internal" href="#disubprogram"><span class="std std-ref">DISubprogram</span></a>.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>!0 = !DILocalVariable(name: "this", arg: 1, scope: !3, file: !2, line: 7,
type: !3, flags: DIFlagArtificial)
!1 = !DILocalVariable(name: "x", arg: 2, scope: !4, file: !2, line: 7,
type: !3)
!2 = !DILocalVariable(name: "y", scope: !5, file: !2, line: 7, type: !3)
</pre></div>
</div>
</div>
<div class="section" id="diexpression">
<span id="id21"></span><h5><a class="toc-backref" href="#id1519">DIExpression</a><a class="headerlink" href="#diexpression" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DIExpression</span></code> nodes represent expressions that are inspired by the DWARF
expression language. They are used in <a class="reference internal" href="#dbg-intrinsics"><span class="std std-ref">debug intrinsics</span></a>
(such as <code class="docutils literal notranslate"><span class="pre">llvm.dbg.declare</span></code> and <code class="docutils literal notranslate"><span class="pre">llvm.dbg.value</span></code>) to describe how the
referenced LLVM variable relates to the source language variable. Debug
intrinsics are interpreted left-to-right: start by pushing the value/address
operand of the intrinsic onto a stack, then repeatedly push and evaluate
opcodes from the DIExpression until the final variable description is produced.</p>
<p>The current supported opcode vocabulary is limited:</p>
<ul>
<li><p><code class="docutils literal notranslate"><span class="pre">DW_OP_deref</span></code> dereferences the top of the expression stack.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DW_OP_plus</span></code> pops the last two entries from the expression stack, adds
them together and appends the result to the expression stack.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DW_OP_minus</span></code> pops the last two entries from the expression stack, subtracts
the last entry from the second last entry and appends the result to the
expression stack.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DW_OP_plus_uconst,</span> <span class="pre">93</span></code> adds <code class="docutils literal notranslate"><span class="pre">93</span></code> to the working expression.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DW_OP_LLVM_fragment,</span> <span class="pre">16,</span> <span class="pre">8</span></code> specifies the offset and size (<code class="docutils literal notranslate"><span class="pre">16</span></code> and <code class="docutils literal notranslate"><span class="pre">8</span></code>
here, respectively) of the variable fragment from the working expression. Note
that contrary to DW_OP_bit_piece, the offset is describing the location
within the described source variable.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DW_OP_LLVM_convert,</span> <span class="pre">16,</span> <span class="pre">DW_ATE_signed</span></code> specifies a bit size and encoding
(<code class="docutils literal notranslate"><span class="pre">16</span></code> and <code class="docutils literal notranslate"><span class="pre">DW_ATE_signed</span></code> here, respectively) to which the top of the
expression stack is to be converted. Maps into a <code class="docutils literal notranslate"><span class="pre">DW_OP_convert</span></code> operation
that references a base type constructed from the supplied values.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DW_OP_LLVM_tag_offset,</span> <span class="pre">tag_offset</span></code> specifies that a memory tag should be
optionally applied to the pointer. The memory tag is derived from the
given tag offset in an implementation-defined manner.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DW_OP_swap</span></code> swaps top two stack entries.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DW_OP_xderef</span></code> provides extended dereference mechanism. The entry at the top
of the stack is treated as an address. The second stack entry is treated as an
address space identifier.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DW_OP_stack_value</span></code> marks a constant value.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DW_OP_LLVM_entry_value,</span> <span class="pre">N</span></code> may only appear in MIR and at the
beginning of a <code class="docutils literal notranslate"><span class="pre">DIExpression</span></code>. In DWARF a <code class="docutils literal notranslate"><span class="pre">DBG_VALUE</span></code>
instruction binding a <code class="docutils literal notranslate"><span class="pre">DIExpression(DW_OP_LLVM_entry_value</span></code> to a
register is lowered to a <code class="docutils literal notranslate"><span class="pre">DW_OP_entry_value</span> <span class="pre">[reg]</span></code>, pushing the
value the register had upon function entry onto the stack. The next
<code class="docutils literal notranslate"><span class="pre">(N</span> <span class="pre">-</span> <span class="pre">1)</span></code> operations will be part of the <code class="docutils literal notranslate"><span class="pre">DW_OP_entry_value</span></code>
block argument. For example, <code class="docutils literal notranslate"><span class="pre">!DIExpression(DW_OP_LLVM_entry_value,</span>
<span class="pre">1,</span> <span class="pre">DW_OP_plus_uconst,</span> <span class="pre">123,</span> <span class="pre">DW_OP_stack_value)</span></code> specifies an
expression where the entry value of the debug value instruction’s
value/address operand is pushed to the stack, and is added
with 123. Due to framework limitations <code class="docutils literal notranslate"><span class="pre">N</span></code> can currently only
be 1.</p>
<p>The operation is introduced by the <code class="docutils literal notranslate"><span class="pre">LiveDebugValues</span></code> pass, which
applies it only to function parameters that are unmodified
throughout the function. Support is limited to simple register
location descriptions, or as indirect locations (e.g., when a struct
is passed-by-value to a callee via a pointer to a temporary copy
made in the caller). The entry value op is also introduced by the
<code class="docutils literal notranslate"><span class="pre">AsmPrinter</span></code> pass when a call site parameter value
(<code class="docutils literal notranslate"><span class="pre">DW_AT_call_site_parameter_value</span></code>) is represented as entry value
of the parameter.</p>
</li>
<li><p><code class="docutils literal notranslate"><span class="pre">DW_OP_LLVM_arg,</span> <span class="pre">N</span></code> is used in debug intrinsics that refer to more than one
value, such as one that calculates the sum of two registers. This is always
used in combination with an ordered list of values, such that
<code class="docutils literal notranslate"><span class="pre">DW_OP_LLVM_arg,</span> <span class="pre">N</span></code> refers to the <code class="docutils literal notranslate"><span class="pre">N``th</span> <span class="pre">element</span> <span class="pre">in</span> <span class="pre">that</span> <span class="pre">list.</span> <span class="pre">For</span>
<span class="pre">example,</span> <span class="pre">``!DIExpression(DW_OP_LLVM_arg,</span> <span class="pre">0,</span> <span class="pre">DW_OP_LLVM_arg,</span> <span class="pre">1,</span> <span class="pre">DW_OP_minus,</span>
<span class="pre">DW_OP_stack_value)</span></code> used with the list <code class="docutils literal notranslate"><span class="pre">(%reg1,</span> <span class="pre">%reg2)</span></code> would evaluate to
<code class="docutils literal notranslate"><span class="pre">%reg1</span> <span class="pre">-</span> <span class="pre">reg2</span></code>. This list of values should be provided by the containing
intrinsic/instruction.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DW_OP_breg</span></code> (or <code class="docutils literal notranslate"><span class="pre">DW_OP_bregx</span></code>) represents a content on the provided
signed offset of the specified register. The opcode is only generated by the
<code class="docutils literal notranslate"><span class="pre">AsmPrinter</span></code> pass to describe call site parameter value which requires an
expression over two registers.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DW_OP_push_object_address</span></code> pushes the address of the object which can then
serve as a descriptor in subsequent calculation. This opcode can be used to
calculate bounds of fortran allocatable array which has array descriptors.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DW_OP_over</span></code> duplicates the entry currently second in the stack at the top
of the stack. This opcode can be used to calculate bounds of fortran assumed
rank array which has rank known at run time and current dimension number is
implicitly first element of the stack.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">DW_OP_LLVM_implicit_pointer</span></code> It specifies the dereferenced value. It can
be used to represent pointer variables which are optimized out but the value
it points to is known. This operator is required as it is different than DWARF
operator DW_OP_implicit_pointer in representation and specification (number
and types of operands) and later can not be used as multiple level.</p></li>
</ul>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>IR for "*ptr = 4;"
--------------
call void @llvm.dbg.value(metadata i32 4, metadata !17, metadata !20)
!17 = !DILocalVariable(name: "ptr1", scope: !12, file: !3, line: 5,
type: !18)
!18 = !DIDerivedType(tag: DW_TAG_pointer_type, baseType: !19, size: 64)
!19 = !DIBasicType(name: "int", size: 32, encoding: DW_ATE_signed)
!20 = !DIExpression(DW_OP_LLVM_implicit_pointer))
IR for "**ptr = 4;"
--------------
call void @llvm.dbg.value(metadata i32 4, metadata !17, metadata !21)
!17 = !DILocalVariable(name: "ptr1", scope: !12, file: !3, line: 5,
type: !18)
!18 = !DIDerivedType(tag: DW_TAG_pointer_type, baseType: !19, size: 64)
!19 = !DIDerivedType(tag: DW_TAG_pointer_type, baseType: !20, size: 64)
!20 = !DIBasicType(name: "int", size: 32, encoding: DW_ATE_signed)
!21 = !DIExpression(DW_OP_LLVM_implicit_pointer,
DW_OP_LLVM_implicit_pointer))
</pre></div>
</div>
<p>DWARF specifies three kinds of simple location descriptions: Register, memory,
and implicit location descriptions. Note that a location description is
defined over certain ranges of a program, i.e the location of a variable may
change over the course of the program. Register and memory location
descriptions describe the <em>concrete location</em> of a source variable (in the
sense that a debugger might modify its value), whereas <em>implicit locations</em>
describe merely the actual <em>value</em> of a source variable which might not exist
in registers or in memory (see <code class="docutils literal notranslate"><span class="pre">DW_OP_stack_value</span></code>).</p>
<p>A <code class="docutils literal notranslate"><span class="pre">llvm.dbg.addr</span></code> or <code class="docutils literal notranslate"><span class="pre">llvm.dbg.declare</span></code> intrinsic describes an indirect
value (the address) of a source variable. The first operand of the intrinsic
must be an address of some kind. A DIExpression attached to the intrinsic
refines this address to produce a concrete location for the source variable.</p>
<p>A <code class="docutils literal notranslate"><span class="pre">llvm.dbg.value</span></code> intrinsic describes the direct value of a source variable.
The first operand of the intrinsic may be a direct or indirect value. A
DIExpression attached to the intrinsic refines the first operand to produce a
direct value. For example, if the first operand is an indirect value, it may be
necessary to insert <code class="docutils literal notranslate"><span class="pre">DW_OP_deref</span></code> into the DIExpression in order to produce a
valid debug intrinsic.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>A DIExpression is interpreted in the same way regardless of which kind of
debug intrinsic it’s attached to.</p>
</div>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>!0 = !DIExpression(DW_OP_deref)
!1 = !DIExpression(DW_OP_plus_uconst, 3)
!1 = !DIExpression(DW_OP_constu, 3, DW_OP_plus)
!2 = !DIExpression(DW_OP_bit_piece, 3, 7)
!3 = !DIExpression(DW_OP_deref, DW_OP_constu, 3, DW_OP_plus, DW_OP_LLVM_fragment, 3, 7)
!4 = !DIExpression(DW_OP_constu, 2, DW_OP_swap, DW_OP_xderef)
!5 = !DIExpression(DW_OP_constu, 42, DW_OP_stack_value)
</pre></div>
</div>
</div>
<div class="section" id="diarglist">
<h5><a class="toc-backref" href="#id1520">DIArgList</a><a class="headerlink" href="#diarglist" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DIArgList</span></code> nodes hold a list of constant or SSA value references. These are
used in <a class="reference internal" href="#dbg-intrinsics"><span class="std std-ref">debug intrinsics</span></a> (currently only in
<code class="docutils literal notranslate"><span class="pre">llvm.dbg.value</span></code>) in combination with a <code class="docutils literal notranslate"><span class="pre">DIExpression</span></code> that uses the
<code class="docutils literal notranslate"><span class="pre">DW_OP_LLVM_arg</span></code> operator. Because a DIArgList may refer to local values
within a function, it must only be used as a function argument, must always be
inlined, and cannot appear in named metadata.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>llvm.dbg.value(metadata !DIArgList(i32 %a, i32 %b),
metadata !16,
metadata !DIExpression(DW_OP_LLVM_arg, 0, DW_OP_LLVM_arg, 1, DW_OP_plus))
</pre></div>
</div>
</div>
<div class="section" id="diflags">
<h5><a class="toc-backref" href="#id1521">DIFlags</a><a class="headerlink" href="#diflags" title="Permalink to this headline">¶</a></h5>
<p>These flags encode various properties of DINodes.</p>
<p>The <cite>ExportSymbols</cite> flag marks a class, struct or union whose members
may be referenced as if they were defined in the containing class or
union. This flag is used to decide whether the DW_AT_export_symbols can
be used for the structure type.</p>
</div>
<div class="section" id="diobjcproperty">
<h5><a class="toc-backref" href="#id1522">DIObjCProperty</a><a class="headerlink" href="#diobjcproperty" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DIObjCProperty</span></code> nodes represent Objective-C property nodes.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>!3 = !DIObjCProperty(name: "foo", file: !1, line: 7, setter: "setFoo",
getter: "getFoo", attributes: 7, type: !2)
</pre></div>
</div>
</div>
<div class="section" id="diimportedentity">
<h5><a class="toc-backref" href="#id1523">DIImportedEntity</a><a class="headerlink" href="#diimportedentity" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DIImportedEntity</span></code> nodes represent entities (such as modules) imported into a
compile unit.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>!2 = !DIImportedEntity(tag: DW_TAG_imported_module, name: "foo", scope: !0,
entity: !1, line: 7)
</pre></div>
</div>
</div>
<div class="section" id="dimacro">
<h5><a class="toc-backref" href="#id1524">DIMacro</a><a class="headerlink" href="#dimacro" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DIMacro</span></code> nodes represent definition or undefinition of a macro identifiers.
The <code class="docutils literal notranslate"><span class="pre">name:</span></code> field is the macro identifier, followed by macro parameters when
defining a function-like macro, and the <code class="docutils literal notranslate"><span class="pre">value</span></code> field is the token-string
used to expand the macro identifier.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>!2 = !DIMacro(macinfo: DW_MACINFO_define, line: 7, name: "foo(x)",
value: "((x) + 1)")
!3 = !DIMacro(macinfo: DW_MACINFO_undef, line: 30, name: "foo")
</pre></div>
</div>
</div>
<div class="section" id="dimacrofile">
<h5><a class="toc-backref" href="#id1525">DIMacroFile</a><a class="headerlink" href="#dimacrofile" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DIMacroFile</span></code> nodes represent inclusion of source files.
The <code class="docutils literal notranslate"><span class="pre">nodes:</span></code> field is a list of <code class="docutils literal notranslate"><span class="pre">DIMacro</span></code> and <code class="docutils literal notranslate"><span class="pre">DIMacroFile</span></code> nodes that
appear in the included source file.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>!2 = !DIMacroFile(macinfo: DW_MACINFO_start_file, line: 7, file: !2,
nodes: !3)
</pre></div>
</div>
</div>
<div class="section" id="dilabel">
<span id="id22"></span><h5><a class="toc-backref" href="#id1526">DILabel</a><a class="headerlink" href="#dilabel" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">DILabel</span></code> nodes represent labels within a <a class="reference internal" href="#disubprogram"><span class="std std-ref">DISubprogram</span></a>. All fields of
a <code class="docutils literal notranslate"><span class="pre">DILabel</span></code> are mandatory. The <code class="docutils literal notranslate"><span class="pre">scope:</span></code> field must be one of either a
<a class="reference internal" href="#dilexicalblockfile"><span class="std std-ref">DILexicalBlockFile</span></a>, a <a class="reference internal" href="#dilexicalblock"><span class="std std-ref">DILexicalBlock</span></a>, or a <a class="reference internal" href="#disubprogram"><span class="std std-ref">DISubprogram</span></a>.
The <code class="docutils literal notranslate"><span class="pre">name:</span></code> field is the label identifier. The <code class="docutils literal notranslate"><span class="pre">file:</span></code> field is the
<a class="reference internal" href="#difile"><span class="std std-ref">DIFile</span></a> the label is present in. The <code class="docutils literal notranslate"><span class="pre">line:</span></code> field is the source line
within the file where the label is declared.</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>!2 = !DILabel(scope: !0, name: "foo", file: !1, line: 7)
</pre></div>
</div>
</div>
</div>
<div class="section" id="tbaa-metadata">
<h4><a class="toc-backref" href="#id1527">‘<code class="docutils literal notranslate"><span class="pre">tbaa</span></code>’ Metadata</a><a class="headerlink" href="#tbaa-metadata" title="Permalink to this headline">¶</a></h4>
<p>In LLVM IR, memory does not have types, so LLVM’s own type system is not
suitable for doing type based alias analysis (TBAA). Instead, metadata is
added to the IR to describe a type system of a higher level language. This
can be used to implement C/C++ strict type aliasing rules, but it can also
be used to implement custom alias analysis behavior for other languages.</p>
<p>This description of LLVM’s TBAA system is broken into two parts:
<a class="reference internal" href="#tbaa-node-semantics"><span class="std std-ref">Semantics</span></a> talks about high level issues, and
<a class="reference internal" href="#tbaa-node-representation"><span class="std std-ref">Representation</span></a> talks about the metadata
encoding of various entities.</p>
<p>It is always possible to trace any TBAA node to a “root” TBAA node (details
in the <a class="reference internal" href="#tbaa-node-representation"><span class="std std-ref">Representation</span></a> section). TBAA
nodes with different roots have an unknown aliasing relationship, and LLVM
conservatively infers <code class="docutils literal notranslate"><span class="pre">MayAlias</span></code> between them. The rules mentioned in
this section only pertain to TBAA nodes living under the same root.</p>
<div class="section" id="semantics">
<span id="tbaa-node-semantics"></span><h5><a class="toc-backref" href="#id1528">Semantics</a><a class="headerlink" href="#semantics" title="Permalink to this headline">¶</a></h5>
<p>The TBAA metadata system, referred to as “struct path TBAA” (not to be
confused with <code class="docutils literal notranslate"><span class="pre">tbaa.struct</span></code>), consists of the following high level
concepts: <em>Type Descriptors</em>, further subdivided into scalar type
descriptors and struct type descriptors; and <em>Access Tags</em>.</p>
<p><strong>Type descriptors</strong> describe the type system of the higher level language
being compiled. <strong>Scalar type descriptors</strong> describe types that do not
contain other types. Each scalar type has a parent type, which must also
be a scalar type or the TBAA root. Via this parent relation, scalar types
within a TBAA root form a tree. <strong>Struct type descriptors</strong> denote types
that contain a sequence of other type descriptors, at known offsets. These
contained type descriptors can either be struct type descriptors themselves
or scalar type descriptors.</p>
<p><strong>Access tags</strong> are metadata nodes attached to load and store instructions.
Access tags use type descriptors to describe the <em>location</em> being accessed
in terms of the type system of the higher level language. Access tags are
tuples consisting of a base type, an access type and an offset. The base
type is a scalar type descriptor or a struct type descriptor, the access
type is a scalar type descriptor, and the offset is a constant integer.</p>
<p>The access tag <code class="docutils literal notranslate"><span class="pre">(BaseTy,</span> <span class="pre">AccessTy,</span> <span class="pre">Offset)</span></code> can describe one of two
things:</p>
<blockquote>
<div><ul class="simple">
<li><p>If <code class="docutils literal notranslate"><span class="pre">BaseTy</span></code> is a struct type, the tag describes a memory access (load
or store) of a value of type <code class="docutils literal notranslate"><span class="pre">AccessTy</span></code> contained in the struct type
<code class="docutils literal notranslate"><span class="pre">BaseTy</span></code> at offset <code class="docutils literal notranslate"><span class="pre">Offset</span></code>.</p></li>
<li><p>If <code class="docutils literal notranslate"><span class="pre">BaseTy</span></code> is a scalar type, <code class="docutils literal notranslate"><span class="pre">Offset</span></code> must be 0 and <code class="docutils literal notranslate"><span class="pre">BaseTy</span></code> and
<code class="docutils literal notranslate"><span class="pre">AccessTy</span></code> must be the same; and the access tag describes a scalar
access with scalar type <code class="docutils literal notranslate"><span class="pre">AccessTy</span></code>.</p></li>
</ul>
</div></blockquote>
<p>We first define an <code class="docutils literal notranslate"><span class="pre">ImmediateParent</span></code> relation on <code class="docutils literal notranslate"><span class="pre">(BaseTy,</span> <span class="pre">Offset)</span></code>
tuples this way:</p>
<blockquote>
<div><ul class="simple">
<li><p>If <code class="docutils literal notranslate"><span class="pre">BaseTy</span></code> is a scalar type then <code class="docutils literal notranslate"><span class="pre">ImmediateParent(BaseTy,</span> <span class="pre">0)</span></code> is
<code class="docutils literal notranslate"><span class="pre">(ParentTy,</span> <span class="pre">0)</span></code> where <code class="docutils literal notranslate"><span class="pre">ParentTy</span></code> is the parent of the scalar type as
described in the TBAA metadata. <code class="docutils literal notranslate"><span class="pre">ImmediateParent(BaseTy,</span> <span class="pre">Offset)</span></code> is
undefined if <code class="docutils literal notranslate"><span class="pre">Offset</span></code> is non-zero.</p></li>
<li><p>If <code class="docutils literal notranslate"><span class="pre">BaseTy</span></code> is a struct type then <code class="docutils literal notranslate"><span class="pre">ImmediateParent(BaseTy,</span> <span class="pre">Offset)</span></code>
is <code class="docutils literal notranslate"><span class="pre">(NewTy,</span> <span class="pre">NewOffset)</span></code> where <code class="docutils literal notranslate"><span class="pre">NewTy</span></code> is the type contained in
<code class="docutils literal notranslate"><span class="pre">BaseTy</span></code> at offset <code class="docutils literal notranslate"><span class="pre">Offset</span></code> and <code class="docutils literal notranslate"><span class="pre">NewOffset</span></code> is <code class="docutils literal notranslate"><span class="pre">Offset</span></code> adjusted
to be relative within that inner type.</p></li>
</ul>
</div></blockquote>
<p>A memory access with an access tag <code class="docutils literal notranslate"><span class="pre">(BaseTy1,</span> <span class="pre">AccessTy1,</span> <span class="pre">Offset1)</span></code>
aliases a memory access with an access tag <code class="docutils literal notranslate"><span class="pre">(BaseTy2,</span> <span class="pre">AccessTy2,</span>
<span class="pre">Offset2)</span></code> if either <code class="docutils literal notranslate"><span class="pre">(BaseTy1,</span> <span class="pre">Offset1)</span></code> is reachable from <code class="docutils literal notranslate"><span class="pre">(Base2,</span>
<span class="pre">Offset2)</span></code> via the <code class="docutils literal notranslate"><span class="pre">Parent</span></code> relation or vice versa.</p>
<p>As a concrete example, the type descriptor graph for the following program</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="k">struct</span> <span class="nc">Inner</span> <span class="p">{</span>
<span class="kt">int</span> <span class="n">i</span><span class="p">;</span> <span class="c1">// offset 0</span>
<span class="kt">float</span> <span class="n">f</span><span class="p">;</span> <span class="c1">// offset 4</span>
<span class="p">};</span>
<span class="k">struct</span> <span class="nc">Outer</span> <span class="p">{</span>
<span class="kt">float</span> <span class="n">f</span><span class="p">;</span> <span class="c1">// offset 0</span>
<span class="kt">double</span> <span class="n">d</span><span class="p">;</span> <span class="c1">// offset 4</span>
<span class="k">struct</span> <span class="nc">Inner</span> <span class="n">inner_a</span><span class="p">;</span> <span class="c1">// offset 12</span>
<span class="p">};</span>
<span class="kt">void</span> <span class="nf">f</span><span class="p">(</span><span class="k">struct</span> <span class="nc">Outer</span><span class="o">*</span> <span class="n">outer</span><span class="p">,</span> <span class="k">struct</span> <span class="nc">Inner</span><span class="o">*</span> <span class="n">inner</span><span class="p">,</span> <span class="kt">float</span><span class="o">*</span> <span class="n">f</span><span class="p">,</span> <span class="kt">int</span><span class="o">*</span> <span class="n">i</span><span class="p">,</span> <span class="kt">char</span><span class="o">*</span> <span class="n">c</span><span class="p">)</span> <span class="p">{</span>
<span class="n">outer</span><span class="o">-></span><span class="n">f</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="c1">// tag0: (OuterStructTy, FloatScalarTy, 0)</span>
<span class="n">outer</span><span class="o">-></span><span class="n">inner_a</span><span class="p">.</span><span class="n">i</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span> <span class="c1">// tag1: (OuterStructTy, IntScalarTy, 12)</span>
<span class="n">outer</span><span class="o">-></span><span class="n">inner_a</span><span class="p">.</span><span class="n">f</span> <span class="o">=</span> <span class="mf">0.0</span><span class="p">;</span> <span class="c1">// tag2: (OuterStructTy, FloatScalarTy, 16)</span>
<span class="o">*</span><span class="n">f</span> <span class="o">=</span> <span class="mf">0.0</span><span class="p">;</span> <span class="c1">// tag3: (FloatScalarTy, FloatScalarTy, 0)</span>
<span class="p">}</span>
</pre></div>
</div>
<p>is (note that in C and C++, <code class="docutils literal notranslate"><span class="pre">char</span></code> can be used to access any arbitrary
type):</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Root = "TBAA Root"
CharScalarTy = ("char", Root, 0)
FloatScalarTy = ("float", CharScalarTy, 0)
DoubleScalarTy = ("double", CharScalarTy, 0)
IntScalarTy = ("int", CharScalarTy, 0)
InnerStructTy = {"Inner" (IntScalarTy, 0), (FloatScalarTy, 4)}
OuterStructTy = {"Outer", (FloatScalarTy, 0), (DoubleScalarTy, 4),
(InnerStructTy, 12)}
</pre></div>
</div>
<p>with (e.g.) <code class="docutils literal notranslate"><span class="pre">ImmediateParent(OuterStructTy,</span> <span class="pre">12)</span></code> = <code class="docutils literal notranslate"><span class="pre">(InnerStructTy,</span>
<span class="pre">0)</span></code>, <code class="docutils literal notranslate"><span class="pre">ImmediateParent(InnerStructTy,</span> <span class="pre">0)</span></code> = <code class="docutils literal notranslate"><span class="pre">(IntScalarTy,</span> <span class="pre">0)</span></code>, and
<code class="docutils literal notranslate"><span class="pre">ImmediateParent(IntScalarTy,</span> <span class="pre">0)</span></code> = <code class="docutils literal notranslate"><span class="pre">(CharScalarTy,</span> <span class="pre">0)</span></code>.</p>
</div>
<div class="section" id="representation">
<span id="tbaa-node-representation"></span><h5><a class="toc-backref" href="#id1529">Representation</a><a class="headerlink" href="#representation" title="Permalink to this headline">¶</a></h5>
<p>The root node of a TBAA type hierarchy is an <code class="docutils literal notranslate"><span class="pre">MDNode</span></code> with 0 operands or
with exactly one <code class="docutils literal notranslate"><span class="pre">MDString</span></code> operand.</p>
<p>Scalar type descriptors are represented as an <code class="docutils literal notranslate"><span class="pre">MDNode</span></code> s with two
operands. The first operand is an <code class="docutils literal notranslate"><span class="pre">MDString</span></code> denoting the name of the
struct type. LLVM does not assign meaning to the value of this operand, it
only cares about it being an <code class="docutils literal notranslate"><span class="pre">MDString</span></code>. The second operand is an
<code class="docutils literal notranslate"><span class="pre">MDNode</span></code> which points to the parent for said scalar type descriptor,
which is either another scalar type descriptor or the TBAA root. Scalar
type descriptors can have an optional third argument, but that must be the
constant integer zero.</p>
<p>Struct type descriptors are represented as <code class="docutils literal notranslate"><span class="pre">MDNode</span></code> s with an odd number
of operands greater than 1. The first operand is an <code class="docutils literal notranslate"><span class="pre">MDString</span></code> denoting
the name of the struct type. Like in scalar type descriptors the actual
value of this name operand is irrelevant to LLVM. After the name operand,
the struct type descriptors have a sequence of alternating <code class="docutils literal notranslate"><span class="pre">MDNode</span></code> and
<code class="docutils literal notranslate"><span class="pre">ConstantInt</span></code> operands. With N starting from 1, the 2N - 1 th operand,
an <code class="docutils literal notranslate"><span class="pre">MDNode</span></code>, denotes a contained field, and the 2N th operand, a
<code class="docutils literal notranslate"><span class="pre">ConstantInt</span></code>, is the offset of the said contained field. The offsets
must be in non-decreasing order.</p>
<p>Access tags are represented as <code class="docutils literal notranslate"><span class="pre">MDNode</span></code> s with either 3 or 4 operands.
The first operand is an <code class="docutils literal notranslate"><span class="pre">MDNode</span></code> pointing to the node representing the
base type. The second operand is an <code class="docutils literal notranslate"><span class="pre">MDNode</span></code> pointing to the node
representing the access type. The third operand is a <code class="docutils literal notranslate"><span class="pre">ConstantInt</span></code> that
states the offset of the access. If a fourth field is present, it must be
a <code class="docutils literal notranslate"><span class="pre">ConstantInt</span></code> valued at 0 or 1. If it is 1 then the access tag states
that the location being accessed is “constant” (meaning
<code class="docutils literal notranslate"><span class="pre">pointsToConstantMemory</span></code> should return true; see <a class="reference external" href="AliasAnalysis.html#OtherItfs">other useful
AliasAnalysis methods</a>). The TBAA root of
the access type and the base type of an access tag must be the same, and
that is the TBAA root of the access tag.</p>
</div>
</div>
<div class="section" id="tbaa-struct-metadata">
<h4><a class="toc-backref" href="#id1530">‘<code class="docutils literal notranslate"><span class="pre">tbaa.struct</span></code>’ Metadata</a><a class="headerlink" href="#tbaa-struct-metadata" title="Permalink to this headline">¶</a></h4>
<p>The <a class="reference internal" href="#int-memcpy"><span class="std std-ref">llvm.memcpy</span></a> is often used to implement
aggregate assignment operations in C and similar languages, however it
is defined to copy a contiguous region of memory, which is more than
strictly necessary for aggregate types which contain holes due to
padding. Also, it doesn’t contain any TBAA information about the fields
of the aggregate.</p>
<p><code class="docutils literal notranslate"><span class="pre">!tbaa.struct</span></code> metadata can describe which memory subregions in a
memcpy are padding and what the TBAA tags of the struct are.</p>
<p>The current metadata format is very simple. <code class="docutils literal notranslate"><span class="pre">!tbaa.struct</span></code> metadata
nodes are a list of operands which are in conceptual groups of three.
For each group of three, the first operand gives the byte offset of a
field in bytes, the second gives its size in bytes, and the third gives
its tbaa tag. e.g.:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv nv-Anonymous">!4</span> <span class="p">=</span> <span class="p">!{</span> <span class="k">i64</span> <span class="m">0</span><span class="p">,</span> <span class="k">i64</span> <span class="m">4</span><span class="p">,</span> <span class="nv nv-Anonymous">!1</span><span class="p">,</span> <span class="k">i64</span> <span class="m">8</span><span class="p">,</span> <span class="k">i64</span> <span class="m">4</span><span class="p">,</span> <span class="nv nv-Anonymous">!2</span> <span class="p">}</span>
</pre></div>
</div>
<p>This describes a struct with two fields. The first is at offset 0 bytes
with size 4 bytes, and has tbaa tag !1. The second is at offset 8 bytes
and has size 4 bytes and has tbaa tag !2.</p>
<p>Note that the fields need not be contiguous. In this example, there is a
4 byte gap between the two fields. This gap represents padding which
does not carry useful data and need not be preserved.</p>
</div>
<div class="section" id="noalias-and-alias-scope-metadata">
<h4><a class="toc-backref" href="#id1531">‘<code class="docutils literal notranslate"><span class="pre">noalias</span></code>’ and ‘<code class="docutils literal notranslate"><span class="pre">alias.scope</span></code>’ Metadata</a><a class="headerlink" href="#noalias-and-alias-scope-metadata" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">noalias</span></code> and <code class="docutils literal notranslate"><span class="pre">alias.scope</span></code> metadata provide the ability to specify generic
noalias memory-access sets. This means that some collection of memory access
instructions (loads, stores, memory-accessing calls, etc.) that carry
<code class="docutils literal notranslate"><span class="pre">noalias</span></code> metadata can specifically be specified not to alias with some other
collection of memory access instructions that carry <code class="docutils literal notranslate"><span class="pre">alias.scope</span></code> metadata.
Each type of metadata specifies a list of scopes where each scope has an id and
a domain.</p>
<p>When evaluating an aliasing query, if for some domain, the set
of scopes with that domain in one instruction’s <code class="docutils literal notranslate"><span class="pre">alias.scope</span></code> list is a
subset of (or equal to) the set of scopes for that domain in another
instruction’s <code class="docutils literal notranslate"><span class="pre">noalias</span></code> list, then the two memory accesses are assumed not to
alias.</p>
<p>Because scopes in one domain don’t affect scopes in other domains, separate
domains can be used to compose multiple independent noalias sets. This is
used for example during inlining. As the noalias function parameters are
turned into noalias scope metadata, a new domain is used every time the
function is inlined.</p>
<p>The metadata identifying each domain is itself a list containing one or two
entries. The first entry is the name of the domain. Note that if the name is a
string then it can be combined across functions and translation units. A
self-reference can be used to create globally unique domain names. A
descriptive string may optionally be provided as a second list entry.</p>
<p>The metadata identifying each scope is also itself a list containing two or
three entries. The first entry is the name of the scope. Note that if the name
is a string then it can be combined across functions and translation units. A
self-reference can be used to create globally unique scope names. A metadata
reference to the scope’s domain is the second entry. A descriptive string may
optionally be provided as a third list entry.</p>
<p>For example,</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="c">; Two scope domains:</span>
<span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="nv nv-Anonymous">!0</span><span class="p">}</span>
<span class="nv nv-Anonymous">!1</span> <span class="p">=</span> <span class="p">!{</span><span class="nv nv-Anonymous">!1</span><span class="p">}</span>
<span class="c">; Some scopes in these domains:</span>
<span class="nv nv-Anonymous">!2</span> <span class="p">=</span> <span class="p">!{</span><span class="nv nv-Anonymous">!2</span><span class="p">,</span> <span class="nv nv-Anonymous">!0</span><span class="p">}</span>
<span class="nv nv-Anonymous">!3</span> <span class="p">=</span> <span class="p">!{</span><span class="nv nv-Anonymous">!3</span><span class="p">,</span> <span class="nv nv-Anonymous">!0</span><span class="p">}</span>
<span class="nv nv-Anonymous">!4</span> <span class="p">=</span> <span class="p">!{</span><span class="nv nv-Anonymous">!4</span><span class="p">,</span> <span class="nv nv-Anonymous">!1</span><span class="p">}</span>
<span class="c">; Some scope lists:</span>
<span class="nv nv-Anonymous">!5</span> <span class="p">=</span> <span class="p">!{</span><span class="nv nv-Anonymous">!4</span><span class="p">}</span> <span class="c">; A list containing only scope !4</span>
<span class="nv nv-Anonymous">!6</span> <span class="p">=</span> <span class="p">!{</span><span class="nv nv-Anonymous">!4</span><span class="p">,</span> <span class="nv nv-Anonymous">!3</span><span class="p">,</span> <span class="nv nv-Anonymous">!2</span><span class="p">}</span>
<span class="nv nv-Anonymous">!7</span> <span class="p">=</span> <span class="p">!{</span><span class="nv nv-Anonymous">!3</span><span class="p">}</span>
<span class="c">; These two instructions don't alias:</span>
<span class="nv nv-Anonymous">%0</span> <span class="p">=</span> <span class="k">load</span> <span class="k">float</span><span class="p">,</span> <span class="k">float</span><span class="p">*</span> <span class="nv">%c</span><span class="p">,</span> <span class="k">align</span> <span class="m">4</span><span class="p">,</span> <span class="nv">!alias.scope</span> <span class="nv nv-Anonymous">!5</span>
<span class="k">store</span> <span class="k">float</span> <span class="nv nv-Anonymous">%0</span><span class="p">,</span> <span class="k">float</span><span class="p">*</span> <span class="nv">%arrayidx.i</span><span class="p">,</span> <span class="k">align</span> <span class="m">4</span><span class="p">,</span> <span class="nv">!noalias</span> <span class="nv nv-Anonymous">!5</span>
<span class="c">; These two instructions also don't alias (for domain !1, the set of scopes</span>
<span class="c">; in the !alias.scope equals that in the !noalias list):</span>
<span class="nv nv-Anonymous">%2</span> <span class="p">=</span> <span class="k">load</span> <span class="k">float</span><span class="p">,</span> <span class="k">float</span><span class="p">*</span> <span class="nv">%c</span><span class="p">,</span> <span class="k">align</span> <span class="m">4</span><span class="p">,</span> <span class="nv">!alias.scope</span> <span class="nv nv-Anonymous">!5</span>
<span class="k">store</span> <span class="k">float</span> <span class="nv nv-Anonymous">%2</span><span class="p">,</span> <span class="k">float</span><span class="p">*</span> <span class="nv">%arrayidx.i2</span><span class="p">,</span> <span class="k">align</span> <span class="m">4</span><span class="p">,</span> <span class="nv">!noalias</span> <span class="nv nv-Anonymous">!6</span>
<span class="c">; These two instructions may alias (for domain !0, the set of scopes in</span>
<span class="c">; the !noalias list is not a superset of, or equal to, the scopes in the</span>
<span class="c">; !alias.scope list):</span>
<span class="nv nv-Anonymous">%2</span> <span class="p">=</span> <span class="k">load</span> <span class="k">float</span><span class="p">,</span> <span class="k">float</span><span class="p">*</span> <span class="nv">%c</span><span class="p">,</span> <span class="k">align</span> <span class="m">4</span><span class="p">,</span> <span class="nv">!alias.scope</span> <span class="nv nv-Anonymous">!6</span>
<span class="k">store</span> <span class="k">float</span> <span class="nv nv-Anonymous">%0</span><span class="p">,</span> <span class="k">float</span><span class="p">*</span> <span class="nv">%arrayidx.i</span><span class="p">,</span> <span class="k">align</span> <span class="m">4</span><span class="p">,</span> <span class="nv">!noalias</span> <span class="nv nv-Anonymous">!7</span>
</pre></div>
</div>
</div>
<div class="section" id="fpmath-metadata">
<h4><a class="toc-backref" href="#id1532">‘<code class="docutils literal notranslate"><span class="pre">fpmath</span></code>’ Metadata</a><a class="headerlink" href="#fpmath-metadata" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">fpmath</span></code> metadata may be attached to any instruction of floating-point
type. It can be used to express the maximum acceptable error in the
result of that instruction, in ULPs, thus potentially allowing the
compiler to use a more efficient but less accurate method of computing
it. ULP is defined as follows:</p>
<blockquote>
<div><p>If <code class="docutils literal notranslate"><span class="pre">x</span></code> is a real number that lies between two finite consecutive
floating-point numbers <code class="docutils literal notranslate"><span class="pre">a</span></code> and <code class="docutils literal notranslate"><span class="pre">b</span></code>, without being equal to one
of them, then <code class="docutils literal notranslate"><span class="pre">ulp(x)</span> <span class="pre">=</span> <span class="pre">|b</span> <span class="pre">-</span> <span class="pre">a|</span></code>, otherwise <code class="docutils literal notranslate"><span class="pre">ulp(x)</span></code> is the
distance between the two non-equal finite floating-point numbers
nearest <code class="docutils literal notranslate"><span class="pre">x</span></code>. Moreover, <code class="docutils literal notranslate"><span class="pre">ulp(NaN)</span></code> is <code class="docutils literal notranslate"><span class="pre">NaN</span></code>.</p>
</div></blockquote>
<p>The metadata node shall consist of a single positive float type number
representing the maximum relative error, for example:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span> <span class="k">float</span> <span class="m">2.5</span> <span class="p">}</span> <span class="c">; maximum acceptable inaccuracy is 2.5 ULPs</span>
</pre></div>
</div>
</div>
<div class="section" id="range-metadata">
<span id="id23"></span><h4><a class="toc-backref" href="#id1533">‘<code class="docutils literal notranslate"><span class="pre">range</span></code>’ Metadata</a><a class="headerlink" href="#range-metadata" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">range</span></code> metadata may be attached only to <code class="docutils literal notranslate"><span class="pre">load</span></code>, <code class="docutils literal notranslate"><span class="pre">call</span></code> and <code class="docutils literal notranslate"><span class="pre">invoke</span></code> of
integer types. It expresses the possible ranges the loaded value or the value
returned by the called function at this call site is in. If the loaded or
returned value is not in the specified range, the behavior is undefined. The
ranges are represented with a flattened list of integers. The loaded value or
the value returned is known to be in the union of the ranges defined by each
consecutive pair. Each pair has the following properties:</p>
<ul class="simple">
<li><p>The type must match the type loaded by the instruction.</p></li>
<li><p>The pair <code class="docutils literal notranslate"><span class="pre">a,b</span></code> represents the range <code class="docutils literal notranslate"><span class="pre">[a,b)</span></code>.</p></li>
<li><p>Both <code class="docutils literal notranslate"><span class="pre">a</span></code> and <code class="docutils literal notranslate"><span class="pre">b</span></code> are constants.</p></li>
<li><p>The range is allowed to wrap.</p></li>
<li><p>The range should not represent the full or empty set. That is,
<code class="docutils literal notranslate"><span class="pre">a!=b</span></code>.</p></li>
</ul>
<p>In addition, the pairs must be in signed order of the lower bound and
they must be non-contiguous.</p>
<p>Examples:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span> <span class="nv">%a</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">%x</span><span class="p">,</span> <span class="k">align</span> <span class="m">1</span><span class="p">,</span> <span class="nv">!range</span> <span class="nv nv-Anonymous">!0</span> <span class="c">; Can only be 0 or 1</span>
<span class="nv">%b</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">%y</span><span class="p">,</span> <span class="k">align</span> <span class="m">1</span><span class="p">,</span> <span class="nv">!range</span> <span class="nv nv-Anonymous">!1</span> <span class="c">; Can only be 255 (-1), 0 or 1</span>
<span class="nv">%c</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span> <span class="vg">@foo</span><span class="p">(),</span> <span class="nv">!range</span> <span class="nv nv-Anonymous">!2</span> <span class="c">; Can only be 0, 1, 3, 4 or 5</span>
<span class="nv">%d</span> <span class="p">=</span> <span class="k">invoke</span> <span class="k">i8</span> <span class="vg">@bar</span><span class="p">()</span> <span class="k">to</span> <span class="k">label</span> <span class="nv">%cont</span>
<span class="k">unwind</span> <span class="k">label</span> <span class="nv">%lpad</span><span class="p">,</span> <span class="nv">!range</span> <span class="nv nv-Anonymous">!3</span> <span class="c">; Can only be -2, -1, 3, 4 or 5</span>
<span class="p">...</span>
<span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span> <span class="k">i8</span> <span class="m">0</span><span class="p">,</span> <span class="k">i8</span> <span class="m">2</span> <span class="p">}</span>
<span class="nv nv-Anonymous">!1</span> <span class="p">=</span> <span class="p">!{</span> <span class="k">i8</span> <span class="m">255</span><span class="p">,</span> <span class="k">i8</span> <span class="m">2</span> <span class="p">}</span>
<span class="nv nv-Anonymous">!2</span> <span class="p">=</span> <span class="p">!{</span> <span class="k">i8</span> <span class="m">0</span><span class="p">,</span> <span class="k">i8</span> <span class="m">2</span><span class="p">,</span> <span class="k">i8</span> <span class="m">3</span><span class="p">,</span> <span class="k">i8</span> <span class="m">6</span> <span class="p">}</span>
<span class="nv nv-Anonymous">!3</span> <span class="p">=</span> <span class="p">!{</span> <span class="k">i8</span> <span class="m">-2</span><span class="p">,</span> <span class="k">i8</span> <span class="m">0</span><span class="p">,</span> <span class="k">i8</span> <span class="m">3</span><span class="p">,</span> <span class="k">i8</span> <span class="m">6</span> <span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="absolute-symbol-metadata">
<h4><a class="toc-backref" href="#id1534">‘<code class="docutils literal notranslate"><span class="pre">absolute_symbol</span></code>’ Metadata</a><a class="headerlink" href="#absolute-symbol-metadata" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">absolute_symbol</span></code> metadata may be attached to a global variable
declaration. It marks the declaration as a reference to an absolute symbol,
which causes the backend to use absolute relocations for the symbol even
in position independent code, and expresses the possible ranges that the
global variable’s <em>address</em> (not its value) is in, in the same format as
<code class="docutils literal notranslate"><span class="pre">range</span></code> metadata, with the extension that the pair <code class="docutils literal notranslate"><span class="pre">all-ones,all-ones</span></code>
may be used to represent the full set.</p>
<p>Example (assuming 64-bit pointers):</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span> <span class="vg">@a</span> <span class="p">=</span> <span class="k">external</span> <span class="k">global</span> <span class="k">i8</span><span class="p">,</span> <span class="nv">!absolute_symbol</span> <span class="nv nv-Anonymous">!0</span> <span class="c">; Absolute symbol in range [0,256)</span>
<span class="vg">@b</span> <span class="p">=</span> <span class="k">external</span> <span class="k">global</span> <span class="k">i8</span><span class="p">,</span> <span class="nv">!absolute_symbol</span> <span class="nv nv-Anonymous">!1</span> <span class="c">; Absolute symbol in range [0,2^64)</span>
<span class="p">...</span>
<span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span> <span class="k">i64</span> <span class="m">0</span><span class="p">,</span> <span class="k">i64</span> <span class="m">256</span> <span class="p">}</span>
<span class="nv nv-Anonymous">!1</span> <span class="p">=</span> <span class="p">!{</span> <span class="k">i64</span> <span class="m">-1</span><span class="p">,</span> <span class="k">i64</span> <span class="m">-1</span> <span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="callees-metadata">
<h4><a class="toc-backref" href="#id1535">‘<code class="docutils literal notranslate"><span class="pre">callees</span></code>’ Metadata</a><a class="headerlink" href="#callees-metadata" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">callees</span></code> metadata may be attached to indirect call sites. If <code class="docutils literal notranslate"><span class="pre">callees</span></code>
metadata is attached to a call site, and any callee is not among the set of
functions provided by the metadata, the behavior is undefined. The intent of
this metadata is to facilitate optimizations such as indirect-call promotion.
For example, in the code below, the call instruction may only target the
<code class="docutils literal notranslate"><span class="pre">add</span></code> or <code class="docutils literal notranslate"><span class="pre">sub</span></code> functions:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%result</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i64</span> <span class="nv">%binop</span><span class="p">(</span><span class="k">i64</span> <span class="nv">%x</span><span class="p">,</span> <span class="k">i64</span> <span class="nv">%y</span><span class="p">),</span> <span class="nv">!callees</span> <span class="nv nv-Anonymous">!0</span>
<span class="p">...</span>
<span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="k">i64</span> <span class="p">(</span><span class="k">i64</span><span class="p">,</span> <span class="k">i64</span><span class="p">)*</span> <span class="vg">@add</span><span class="p">,</span> <span class="k">i64</span> <span class="p">(</span><span class="k">i64</span><span class="p">,</span> <span class="k">i64</span><span class="p">)*</span> <span class="vg">@sub</span><span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="callback-metadata">
<h4><a class="toc-backref" href="#id1536">‘<code class="docutils literal notranslate"><span class="pre">callback</span></code>’ Metadata</a><a class="headerlink" href="#callback-metadata" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">callback</span></code> metadata may be attached to a function declaration, or definition.
(Call sites are excluded only due to the lack of a use case.) For ease of
exposition, we’ll refer to the function annotated w/ metadata as a broker
function. The metadata describes how the arguments of a call to the broker are
in turn passed to the callback function specified by the metadata. Thus, the
<code class="docutils literal notranslate"><span class="pre">callback</span></code> metadata provides a partial description of a call site inside the
broker function with regards to the arguments of a call to the broker. The only
semantic restriction on the broker function itself is that it is not allowed to
inspect or modify arguments referenced in the <code class="docutils literal notranslate"><span class="pre">callback</span></code> metadata as
pass-through to the callback function.</p>
<p>The broker is not required to actually invoke the callback function at runtime.
However, the assumptions about not inspecting or modifying arguments that would
be passed to the specified callback function still hold, even if the callback
function is not dynamically invoked. The broker is allowed to invoke the
callback function more than once per invocation of the broker. The broker is
also allowed to invoke (directly or indirectly) the function passed as a
callback through another use. Finally, the broker is also allowed to relay the
callback callee invocation to a different thread.</p>
<p>The metadata is structured as follows: At the outer level, <code class="docutils literal notranslate"><span class="pre">callback</span></code>
metadata is a list of <code class="docutils literal notranslate"><span class="pre">callback</span></code> encodings. Each encoding starts with a
constant <code class="docutils literal notranslate"><span class="pre">i64</span></code> which describes the argument position of the callback function
in the call to the broker. The following elements, except the last, describe
what arguments are passed to the callback function. Each element is again an
<code class="docutils literal notranslate"><span class="pre">i64</span></code> constant identifying the argument of the broker that is passed through,
or <code class="docutils literal notranslate"><span class="pre">i64</span> <span class="pre">-1</span></code> to indicate an unknown or inspected argument. The order in which
they are listed has to be the same in which they are passed to the callback
callee. The last element of the encoding is a boolean which specifies how
variadic arguments of the broker are handled. If it is true, all variadic
arguments of the broker are passed through to the callback function <em>after</em> the
arguments encoded explicitly before.</p>
<p>In the code below, the <code class="docutils literal notranslate"><span class="pre">pthread_create</span></code> function is marked as a broker
through the <code class="docutils literal notranslate"><span class="pre">!callback</span> <span class="pre">!1</span></code> metadata. In the example, there is only one
callback encoding, namely <code class="docutils literal notranslate"><span class="pre">!2</span></code>, associated with the broker. This encoding
identifies the callback function as the second argument of the broker (<code class="docutils literal notranslate"><span class="pre">i64</span>
<span class="pre">2</span></code>) and the sole argument of the callback function as the third one of the
broker function (<code class="docutils literal notranslate"><span class="pre">i64</span> <span class="pre">3</span></code>).</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>declare !callback !1 dso_local i32 @pthread_create(i64*, %union.pthread_attr_t*, i8* (i8*)*, i8*)
...
!2 = !{i64 2, i64 3, i1 false}
!1 = !{!2}
</pre></div>
</div>
<p>Another example is shown below. The callback callee is the second argument of
the <code class="docutils literal notranslate"><span class="pre">__kmpc_fork_call</span></code> function (<code class="docutils literal notranslate"><span class="pre">i64</span> <span class="pre">2</span></code>). The callee is given two unknown
values (each identified by a <code class="docutils literal notranslate"><span class="pre">i64</span> <span class="pre">-1</span></code>) and afterwards all
variadic arguments that are passed to the <code class="docutils literal notranslate"><span class="pre">__kmpc_fork_call</span></code> call (due to the
final <code class="docutils literal notranslate"><span class="pre">i1</span> <span class="pre">true</span></code>).</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>declare !callback !0 dso_local void @__kmpc_fork_call(%struct.ident_t*, i32, void (i32*, i32*, ...)*, ...)
...
!1 = !{i64 2, i64 -1, i64 -1, i1 true}
!0 = !{!1}
</pre></div>
</div>
</div>
<div class="section" id="unpredictable-metadata">
<h4><a class="toc-backref" href="#id1537">‘<code class="docutils literal notranslate"><span class="pre">unpredictable</span></code>’ Metadata</a><a class="headerlink" href="#unpredictable-metadata" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">unpredictable</span></code> metadata may be attached to any branch or switch
instruction. It can be used to express the unpredictability of control
flow. Similar to the llvm.expect intrinsic, it may be used to alter
optimizations related to compare and branch instructions. The metadata
is treated as a boolean value; if it exists, it signals that the branch
or switch that it is attached to is completely unpredictable.</p>
</div>
<div class="section" id="dereferenceable-metadata">
<span id="md-dereferenceable"></span><h4><a class="toc-backref" href="#id1538">‘<code class="docutils literal notranslate"><span class="pre">dereferenceable</span></code>’ Metadata</a><a class="headerlink" href="#dereferenceable-metadata" title="Permalink to this headline">¶</a></h4>
<p>The existence of the <code class="docutils literal notranslate"><span class="pre">!dereferenceable</span></code> metadata on the instruction
tells the optimizer that the value loaded is known to be dereferenceable.
The number of bytes known to be dereferenceable is specified by the integer
value in the metadata node. This is analogous to the ‘’dereferenceable’’
attribute on parameters and return values.</p>
</div>
<div class="section" id="dereferenceable-or-null-metadata">
<span id="md-dereferenceable-or-null"></span><h4><a class="toc-backref" href="#id1539">‘<code class="docutils literal notranslate"><span class="pre">dereferenceable_or_null</span></code>’ Metadata</a><a class="headerlink" href="#dereferenceable-or-null-metadata" title="Permalink to this headline">¶</a></h4>
<p>The existence of the <code class="docutils literal notranslate"><span class="pre">!dereferenceable_or_null</span></code> metadata on the
instruction tells the optimizer that the value loaded is known to be either
dereferenceable or null.
The number of bytes known to be dereferenceable is specified by the integer
value in the metadata node. This is analogous to the ‘’dereferenceable_or_null’’
attribute on parameters and return values.</p>
</div>
<div class="section" id="llvm-loop">
<span id="id24"></span><h4><a class="toc-backref" href="#id1540">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop</span></code>’</a><a class="headerlink" href="#llvm-loop" title="Permalink to this headline">¶</a></h4>
<p>It is sometimes useful to attach information to loop constructs. Currently,
loop metadata is implemented as metadata attached to the branch instruction
in the loop latch block. The loop metadata node is a list of
other metadata nodes, each representing a property of the loop. Usually,
the first item of the property node is a string. For example, the
<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.count</span></code> suggests an unroll factor to the loop
unroller:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span> <span class="k">br</span> <span class="k">i1</span> <span class="nv">%exitcond</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%._crit_edge</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%.lr.ph</span><span class="p">,</span> <span class="nv">!llvm.loop</span> <span class="nv nv-Anonymous">!0</span>
<span class="p">...</span>
<span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="nv nv-Anonymous">!0</span><span class="p">,</span> <span class="nv nv-Anonymous">!1</span><span class="p">,</span> <span class="nv nv-Anonymous">!2</span><span class="p">}</span>
<span class="nv nv-Anonymous">!1</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.loop.unroll.enable"</span><span class="p">}</span>
<span class="nv nv-Anonymous">!2</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.loop.unroll.count"</span><span class="p">,</span> <span class="k">i32</span> <span class="m">4</span><span class="p">}</span>
</pre></div>
</div>
<p>For legacy reasons, the first item of a loop metadata node must be a
reference to itself. Before the advent of the ‘distinct’ keyword, this
forced the preservation of otherwise identical metadata nodes. Since
the loop-metadata node can be attached to multiple nodes, the ‘distinct’
keyword has become unnecessary.</p>
<p>Prior to the property nodes, one or two <code class="docutils literal notranslate"><span class="pre">DILocation</span></code> (debug location)
nodes can be present in the list. The first, if present, identifies the
source-code location where the loop begins. The second, if present,
identifies the source-code location where the loop ends.</p>
<p>Loop metadata nodes cannot be used as unique identifiers. They are
neither persistent for the same loop through transformations nor
necessarily unique to just one loop.</p>
</div>
<div class="section" id="llvm-loop-disable-nonforced">
<h4><a class="toc-backref" href="#id1541">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.disable_nonforced</span></code>’</a><a class="headerlink" href="#llvm-loop-disable-nonforced" title="Permalink to this headline">¶</a></h4>
<p>This metadata disables all optional loop transformations unless
explicitly instructed using other transformation metadata such as
<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.enable</span></code>. That is, no heuristic will try to determine
whether a transformation is profitable. The purpose is to avoid that the
loop is transformed to a different loop before an explicitly requested
(forced) transformation is applied. For instance, loop fusion can make
other transformations impossible. Mandatory loop canonicalizations such
as loop rotation are still applied.</p>
<p>It is recommended to use this metadata in addition to any llvm.loop.*
transformation directive. Also, any loop should have at most one
directive applied to it (and a sequence of transformations built using
followup-attributes). Otherwise, which transformation will be applied
depends on implementation details such as the pass pipeline order.</p>
<p>See <a class="reference internal" href="TransformMetadata.html#transformation-metadata"><span class="std std-ref">Code Transformation Metadata</span></a> for details.</p>
</div>
<div class="section" id="llvm-loop-vectorize-and-llvm-loop-interleave">
<h4><a class="toc-backref" href="#id1542">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize</span></code>’ and ‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.interleave</span></code>’</a><a class="headerlink" href="#llvm-loop-vectorize-and-llvm-loop-interleave" title="Permalink to this headline">¶</a></h4>
<p>Metadata prefixed with <code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize</span></code> or <code class="docutils literal notranslate"><span class="pre">llvm.loop.interleave</span></code> are
used to control per-loop vectorization and interleaving parameters such as
vectorization width and interleave count. These metadata should be used in
conjunction with <code class="docutils literal notranslate"><span class="pre">llvm.loop</span></code> loop identification metadata. The
<code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize</span></code> and <code class="docutils literal notranslate"><span class="pre">llvm.loop.interleave</span></code> metadata are only
optimization hints and the optimizer will only interleave and vectorize loops if
it believes it is safe to do so. The <code class="docutils literal notranslate"><span class="pre">llvm.loop.parallel_accesses</span></code> metadata
which contains information about loop-carried memory dependencies can be helpful
in determining the safety of these transformations.</p>
</div>
<div class="section" id="llvm-loop-interleave-count-metadata">
<h4><a class="toc-backref" href="#id1543">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.interleave.count</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-interleave-count-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata suggests an interleave count to the loop interleaver.
The first operand is the string <code class="docutils literal notranslate"><span class="pre">llvm.loop.interleave.count</span></code> and the
second operand is an integer specifying the interleave count. For
example:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.loop.interleave.count"</span><span class="p">,</span> <span class="k">i32</span> <span class="m">4</span><span class="p">}</span>
</pre></div>
</div>
<p>Note that setting <code class="docutils literal notranslate"><span class="pre">llvm.loop.interleave.count</span></code> to 1 disables interleaving
multiple iterations of the loop. If <code class="docutils literal notranslate"><span class="pre">llvm.loop.interleave.count</span></code> is set to 0
then the interleave count will be determined automatically.</p>
</div>
<div class="section" id="llvm-loop-vectorize-enable-metadata">
<h4><a class="toc-backref" href="#id1544">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize.enable</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-vectorize-enable-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata selectively enables or disables vectorization for the loop. The
first operand is the string <code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize.enable</span></code> and the second operand
is a bit. If the bit operand value is 1 vectorization is enabled. A value of
0 disables vectorization:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.loop.vectorize.enable"</span><span class="p">,</span> <span class="k">i1</span> <span class="m">0</span><span class="p">}</span>
<span class="nv nv-Anonymous">!1</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.loop.vectorize.enable"</span><span class="p">,</span> <span class="k">i1</span> <span class="m">1</span><span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="llvm-loop-vectorize-predicate-enable-metadata">
<h4><a class="toc-backref" href="#id1545">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize.predicate.enable</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-vectorize-predicate-enable-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata selectively enables or disables creating predicated instructions
for the loop, which can enable folding of the scalar epilogue loop into the
main loop. The first operand is the string
<code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize.predicate.enable</span></code> and the second operand is a bit. If
the bit operand value is 1 vectorization is enabled. A value of 0 disables
vectorization:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.loop.vectorize.predicate.enable"</span><span class="p">,</span> <span class="k">i1</span> <span class="m">0</span><span class="p">}</span>
<span class="nv nv-Anonymous">!1</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.loop.vectorize.predicate.enable"</span><span class="p">,</span> <span class="k">i1</span> <span class="m">1</span><span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="llvm-loop-vectorize-scalable-enable-metadata">
<h4><a class="toc-backref" href="#id1546">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize.scalable.enable</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-vectorize-scalable-enable-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata selectively enables or disables scalable vectorization for the
loop, and only has any effect if vectorization for the loop is already enabled.
The first operand is the string <code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize.scalable.enable</span></code>
and the second operand is a bit. If the bit operand value is 1 scalable
vectorization is enabled, whereas a value of 0 reverts to the default fixed
width vectorization:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.loop.vectorize.scalable.enable"</span><span class="p">,</span> <span class="k">i1</span> <span class="m">0</span><span class="p">}</span>
<span class="nv nv-Anonymous">!1</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.loop.vectorize.scalable.enable"</span><span class="p">,</span> <span class="k">i1</span> <span class="m">1</span><span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="llvm-loop-vectorize-width-metadata">
<h4><a class="toc-backref" href="#id1547">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize.width</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-vectorize-width-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata sets the target width of the vectorizer. The first
operand is the string <code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize.width</span></code> and the second
operand is an integer specifying the width. For example:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.loop.vectorize.width"</span><span class="p">,</span> <span class="k">i32</span> <span class="m">4</span><span class="p">}</span>
</pre></div>
</div>
<p>Note that setting <code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize.width</span></code> to 1 disables
vectorization of the loop. If <code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize.width</span></code> is set to
0 or if the loop does not have this metadata the width will be
determined automatically.</p>
</div>
<div class="section" id="llvm-loop-vectorize-followup-vectorized-metadata">
<h4><a class="toc-backref" href="#id1548">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize.followup_vectorized</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-vectorize-followup-vectorized-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata defines which loop attributes the vectorized loop will
have. See <a class="reference internal" href="TransformMetadata.html#transformation-metadata"><span class="std std-ref">Code Transformation Metadata</span></a> for details.</p>
</div>
<div class="section" id="llvm-loop-vectorize-followup-epilogue-metadata">
<h4><a class="toc-backref" href="#id1549">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize.followup_epilogue</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-vectorize-followup-epilogue-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata defines which loop attributes the epilogue will have. The
epilogue is not vectorized and is executed when either the vectorized
loop is not known to preserve semantics (because e.g., it processes two
arrays that are found to alias by a runtime check) or for the last
iterations that do not fill a complete set of vector lanes. See
<a class="reference internal" href="TransformMetadata.html#transformation-metadata"><span class="std std-ref">Transformation Metadata</span></a> for details.</p>
</div>
<div class="section" id="llvm-loop-vectorize-followup-all-metadata">
<h4><a class="toc-backref" href="#id1550">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.vectorize.followup_all</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-vectorize-followup-all-metadata" title="Permalink to this headline">¶</a></h4>
<p>Attributes in the metadata will be added to both the vectorized and
epilogue loop.
See <a class="reference internal" href="TransformMetadata.html#transformation-metadata"><span class="std std-ref">Transformation Metadata</span></a> for details.</p>
</div>
<div class="section" id="llvm-loop-unroll">
<h4><a class="toc-backref" href="#id1551">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll</span></code>’</a><a class="headerlink" href="#llvm-loop-unroll" title="Permalink to this headline">¶</a></h4>
<p>Metadata prefixed with <code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll</span></code> are loop unrolling
optimization hints such as the unroll factor. <code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll</span></code>
metadata should be used in conjunction with <code class="docutils literal notranslate"><span class="pre">llvm.loop</span></code> loop
identification metadata. The <code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll</span></code> metadata are only
optimization hints and the unrolling will only be performed if the
optimizer believes it is safe to do so.</p>
</div>
<div class="section" id="llvm-loop-unroll-count-metadata">
<h4><a class="toc-backref" href="#id1552">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.count</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-unroll-count-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata suggests an unroll factor to the loop unroller. The
first operand is the string <code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.count</span></code> and the second
operand is a positive integer specifying the unroll factor. For
example:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.loop.unroll.count"</span><span class="p">,</span> <span class="k">i32</span> <span class="m">4</span><span class="p">}</span>
</pre></div>
</div>
<p>If the trip count of the loop is less than the unroll count the loop
will be partially unrolled.</p>
</div>
<div class="section" id="llvm-loop-unroll-disable-metadata">
<h4><a class="toc-backref" href="#id1553">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.disable</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-unroll-disable-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata disables loop unrolling. The metadata has a single operand
which is the string <code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.disable</span></code>. For example:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.loop.unroll.disable"</span><span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="llvm-loop-unroll-runtime-disable-metadata">
<h4><a class="toc-backref" href="#id1554">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.runtime.disable</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-unroll-runtime-disable-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata disables runtime loop unrolling. The metadata has a single
operand which is the string <code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.runtime.disable</span></code>. For example:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.loop.unroll.runtime.disable"</span><span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="llvm-loop-unroll-enable-metadata">
<h4><a class="toc-backref" href="#id1555">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.enable</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-unroll-enable-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata suggests that the loop should be fully unrolled if the trip count
is known at compile time and partially unrolled if the trip count is not known
at compile time. The metadata has a single operand which is the string
<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.enable</span></code>. For example:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.loop.unroll.enable"</span><span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="llvm-loop-unroll-full-metadata">
<h4><a class="toc-backref" href="#id1556">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.full</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-unroll-full-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata suggests that the loop should be unrolled fully. The
metadata has a single operand which is the string <code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.full</span></code>.
For example:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.loop.unroll.full"</span><span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="llvm-loop-unroll-followup-metadata">
<h4><a class="toc-backref" href="#id1557">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.followup</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-unroll-followup-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata defines which loop attributes the unrolled loop will have.
See <a class="reference internal" href="TransformMetadata.html#transformation-metadata"><span class="std std-ref">Transformation Metadata</span></a> for details.</p>
</div>
<div class="section" id="llvm-loop-unroll-followup-remainder-metadata">
<h4><a class="toc-backref" href="#id1558">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.followup_remainder</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-unroll-followup-remainder-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata defines which loop attributes the remainder loop after
partial/runtime unrolling will have. See
<a class="reference internal" href="TransformMetadata.html#transformation-metadata"><span class="std std-ref">Transformation Metadata</span></a> for details.</p>
</div>
<div class="section" id="llvm-loop-unroll-and-jam">
<h4><a class="toc-backref" href="#id1559">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam</span></code>’</a><a class="headerlink" href="#llvm-loop-unroll-and-jam" title="Permalink to this headline">¶</a></h4>
<p>This metadata is treated very similarly to the <code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll</span></code> metadata
above, but affect the unroll and jam pass. In addition any loop with
<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll</span></code> metadata but no <code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam</span></code> metadata will
disable unroll and jam (so <code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll</span></code> metadata will be left to the
unroller, plus <code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.disable</span></code> metadata will disable unroll and jam
too.)</p>
<p>The metadata for unroll and jam otherwise is the same as for <code class="docutils literal notranslate"><span class="pre">unroll</span></code>.
<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.enable</span></code>, <code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.disable</span></code> and
<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.count</span></code> do the same as for unroll.
<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.full</span></code> is not supported. Again these are only hints
and the normal safety checks will still be performed.</p>
</div>
<div class="section" id="llvm-loop-unroll-and-jam-count-metadata">
<h4><a class="toc-backref" href="#id1560">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.count</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-unroll-and-jam-count-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata suggests an unroll and jam factor to use, similarly to
<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll.count</span></code>. The first operand is the string
<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.count</span></code> and the second operand is a positive integer
specifying the unroll factor. For example:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.loop.unroll_and_jam.count"</span><span class="p">,</span> <span class="k">i32</span> <span class="m">4</span><span class="p">}</span>
</pre></div>
</div>
<p>If the trip count of the loop is less than the unroll count the loop
will be partially unroll and jammed.</p>
</div>
<div class="section" id="llvm-loop-unroll-and-jam-disable-metadata">
<h4><a class="toc-backref" href="#id1561">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.disable</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-unroll-and-jam-disable-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata disables loop unroll and jamming. The metadata has a single
operand which is the string <code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.disable</span></code>. For example:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.loop.unroll_and_jam.disable"</span><span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="llvm-loop-unroll-and-jam-enable-metadata">
<h4><a class="toc-backref" href="#id1562">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.enable</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-unroll-and-jam-enable-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata suggests that the loop should be fully unroll and jammed if the
trip count is known at compile time and partially unrolled if the trip count is
not known at compile time. The metadata has a single operand which is the
string <code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.enable</span></code>. For example:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.loop.unroll_and_jam.enable"</span><span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="llvm-loop-unroll-and-jam-followup-outer-metadata">
<h4><a class="toc-backref" href="#id1563">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.followup_outer</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-unroll-and-jam-followup-outer-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata defines which loop attributes the outer unrolled loop will
have. See <a class="reference internal" href="TransformMetadata.html#transformation-metadata"><span class="std std-ref">Transformation Metadata</span></a> for
details.</p>
</div>
<div class="section" id="llvm-loop-unroll-and-jam-followup-inner-metadata">
<h4><a class="toc-backref" href="#id1564">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.followup_inner</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-unroll-and-jam-followup-inner-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata defines which loop attributes the inner jammed loop will
have. See <a class="reference internal" href="TransformMetadata.html#transformation-metadata"><span class="std std-ref">Transformation Metadata</span></a> for
details.</p>
</div>
<div class="section" id="llvm-loop-unroll-and-jam-followup-remainder-outer-metadata">
<h4><a class="toc-backref" href="#id1565">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.followup_remainder_outer</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-unroll-and-jam-followup-remainder-outer-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata defines which attributes the epilogue of the outer loop
will have. This loop is usually unrolled, meaning there is no such
loop. This attribute will be ignored in this case. See
<a class="reference internal" href="TransformMetadata.html#transformation-metadata"><span class="std std-ref">Transformation Metadata</span></a> for details.</p>
</div>
<div class="section" id="llvm-loop-unroll-and-jam-followup-remainder-inner-metadata">
<h4><a class="toc-backref" href="#id1566">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.followup_remainder_inner</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-unroll-and-jam-followup-remainder-inner-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata defines which attributes the inner loop of the epilogue
will have. The outer epilogue will usually be unrolled, meaning there
can be multiple inner remainder loops. See
<a class="reference internal" href="TransformMetadata.html#transformation-metadata"><span class="std std-ref">Transformation Metadata</span></a> for details.</p>
</div>
<div class="section" id="llvm-loop-unroll-and-jam-followup-all-metadata">
<h4><a class="toc-backref" href="#id1567">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.followup_all</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-unroll-and-jam-followup-all-metadata" title="Permalink to this headline">¶</a></h4>
<p>Attributes specified in the metadata is added to all
<code class="docutils literal notranslate"><span class="pre">llvm.loop.unroll_and_jam.*</span></code> loops. See
<a class="reference internal" href="TransformMetadata.html#transformation-metadata"><span class="std std-ref">Transformation Metadata</span></a> for details.</p>
</div>
<div class="section" id="llvm-loop-licm-versioning-disable-metadata">
<h4><a class="toc-backref" href="#id1568">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.licm_versioning.disable</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-licm-versioning-disable-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata indicates that the loop should not be versioned for the purpose
of enabling loop-invariant code motion (LICM). The metadata has a single operand
which is the string <code class="docutils literal notranslate"><span class="pre">llvm.loop.licm_versioning.disable</span></code>. For example:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.loop.licm_versioning.disable"</span><span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="llvm-loop-distribute-enable-metadata">
<h4><a class="toc-backref" href="#id1569">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.distribute.enable</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-distribute-enable-metadata" title="Permalink to this headline">¶</a></h4>
<p>Loop distribution allows splitting a loop into multiple loops. Currently,
this is only performed if the entire loop cannot be vectorized due to unsafe
memory dependencies. The transformation will attempt to isolate the unsafe
dependencies into their own loop.</p>
<p>This metadata can be used to selectively enable or disable distribution of the
loop. The first operand is the string <code class="docutils literal notranslate"><span class="pre">llvm.loop.distribute.enable</span></code> and the
second operand is a bit. If the bit operand value is 1 distribution is
enabled. A value of 0 disables distribution:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.loop.distribute.enable"</span><span class="p">,</span> <span class="k">i1</span> <span class="m">0</span><span class="p">}</span>
<span class="nv nv-Anonymous">!1</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.loop.distribute.enable"</span><span class="p">,</span> <span class="k">i1</span> <span class="m">1</span><span class="p">}</span>
</pre></div>
</div>
<p>This metadata should be used in conjunction with <code class="docutils literal notranslate"><span class="pre">llvm.loop</span></code> loop
identification metadata.</p>
</div>
<div class="section" id="llvm-loop-distribute-followup-coincident-metadata">
<h4><a class="toc-backref" href="#id1570">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.distribute.followup_coincident</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-distribute-followup-coincident-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata defines which attributes extracted loops with no cyclic
dependencies will have (i.e. can be vectorized). See
<a class="reference internal" href="TransformMetadata.html#transformation-metadata"><span class="std std-ref">Transformation Metadata</span></a> for details.</p>
</div>
<div class="section" id="llvm-loop-distribute-followup-sequential-metadata">
<h4><a class="toc-backref" href="#id1571">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.distribute.followup_sequential</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-distribute-followup-sequential-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata defines which attributes the isolated loops with unsafe
memory dependencies will have. See
<a class="reference internal" href="TransformMetadata.html#transformation-metadata"><span class="std std-ref">Transformation Metadata</span></a> for details.</p>
</div>
<div class="section" id="llvm-loop-distribute-followup-fallback-metadata">
<h4><a class="toc-backref" href="#id1572">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.distribute.followup_fallback</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-distribute-followup-fallback-metadata" title="Permalink to this headline">¶</a></h4>
<p>If loop versioning is necessary, this metadata defined the attributes
the non-distributed fallback version will have. See
<a class="reference internal" href="TransformMetadata.html#transformation-metadata"><span class="std std-ref">Transformation Metadata</span></a> for details.</p>
</div>
<div class="section" id="llvm-loop-distribute-followup-all-metadata">
<h4><a class="toc-backref" href="#id1573">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.distribute.followup_all</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-distribute-followup-all-metadata" title="Permalink to this headline">¶</a></h4>
<p>The attributes in this metadata is added to all followup loops of the
loop distribution pass. See
<a class="reference internal" href="TransformMetadata.html#transformation-metadata"><span class="std std-ref">Transformation Metadata</span></a> for details.</p>
</div>
<div class="section" id="llvm-licm-disable-metadata">
<h4><a class="toc-backref" href="#id1574">‘<code class="docutils literal notranslate"><span class="pre">llvm.licm.disable</span></code>’ Metadata</a><a class="headerlink" href="#llvm-licm-disable-metadata" title="Permalink to this headline">¶</a></h4>
<p>This metadata indicates that loop-invariant code motion (LICM) should not be
performed on this loop. The metadata has a single operand which is the string
<code class="docutils literal notranslate"><span class="pre">llvm.licm.disable</span></code>. For example:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"llvm.licm.disable"</span><span class="p">}</span>
</pre></div>
</div>
<p>Note that although it operates per loop it isn’t given the llvm.loop prefix
as it is not affected by the <code class="docutils literal notranslate"><span class="pre">llvm.loop.disable_nonforced</span></code> metadata.</p>
</div>
<div class="section" id="llvm-access-group-metadata">
<h4><a class="toc-backref" href="#id1575">‘<code class="docutils literal notranslate"><span class="pre">llvm.access.group</span></code>’ Metadata</a><a class="headerlink" href="#llvm-access-group-metadata" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">llvm.access.group</span></code> metadata can be attached to any instruction that
potentially accesses memory. It can point to a single distinct metadata
node, which we call access group. This node represents all memory access
instructions referring to it via <code class="docutils literal notranslate"><span class="pre">llvm.access.group</span></code>. When an
instruction belongs to multiple access groups, it can also point to a
list of accesses groups, illustrated by the following example.</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></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">%arrayidx</span><span class="p">,</span> <span class="nv">!llvm.access.group</span> <span class="nv nv-Anonymous">!0</span>
<span class="p">...</span>
<span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="nv nv-Anonymous">!1</span><span class="p">,</span> <span class="nv nv-Anonymous">!2</span><span class="p">}</span>
<span class="nv nv-Anonymous">!1</span> <span class="p">=</span> <span class="k">distinct</span> <span class="p">!{}</span>
<span class="nv nv-Anonymous">!2</span> <span class="p">=</span> <span class="k">distinct</span> <span class="p">!{}</span>
</pre></div>
</div>
<p>It is illegal for the list node to be empty since it might be confused
with an access group.</p>
<p>The access group metadata node must be ‘distinct’ to avoid collapsing
multiple access groups by content. A access group metadata node must
always be empty which can be used to distinguish an access group
metadata node from a list of access groups. Being empty avoids the
situation that the content must be updated which, because metadata is
immutable by design, would required finding and updating all references
to the access group node.</p>
<p>The access group can be used to refer to a memory access instruction
without pointing to it directly (which is not possible in global
metadata). Currently, the only metadata making use of it is
<code class="docutils literal notranslate"><span class="pre">llvm.loop.parallel_accesses</span></code>.</p>
</div>
<div class="section" id="llvm-loop-parallel-accesses-metadata">
<h4><a class="toc-backref" href="#id1576">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.parallel_accesses</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-parallel-accesses-metadata" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.loop.parallel_accesses</span></code> metadata refers to one or more
access group metadata nodes (see <code class="docutils literal notranslate"><span class="pre">llvm.access.group</span></code>). It denotes that
no loop-carried memory dependence exist between it and other instructions
in the loop with this metadata.</p>
<p>Let <code class="docutils literal notranslate"><span class="pre">m1</span></code> and <code class="docutils literal notranslate"><span class="pre">m2</span></code> be two instructions that both have the
<code class="docutils literal notranslate"><span class="pre">llvm.access.group</span></code> metadata to the access group <code class="docutils literal notranslate"><span class="pre">g1</span></code>, respectively
<code class="docutils literal notranslate"><span class="pre">g2</span></code> (which might be identical). If a loop contains both access groups
in its <code class="docutils literal notranslate"><span class="pre">llvm.loop.parallel_accesses</span></code> metadata, then the compiler can
assume that there is no dependency between <code class="docutils literal notranslate"><span class="pre">m1</span></code> and <code class="docutils literal notranslate"><span class="pre">m2</span></code> carried by
this loop. Instructions that belong to multiple access groups are
considered having this property if at least one of the access groups
matches the <code class="docutils literal notranslate"><span class="pre">llvm.loop.parallel_accesses</span></code> list.</p>
<p>If all memory-accessing instructions in a loop have
<code class="docutils literal notranslate"><span class="pre">llvm.access.group</span></code> metadata that each refer to one of the access
groups of a loop’s <code class="docutils literal notranslate"><span class="pre">llvm.loop.parallel_accesses</span></code> metadata, then the
loop has no loop carried memory dependences and is considered to be a
parallel loop.</p>
<p>Note that if not all memory access instructions belong to an access
group referred to by <code class="docutils literal notranslate"><span class="pre">llvm.loop.parallel_accesses</span></code>, then the loop must
not be considered trivially parallel. Additional
memory dependence analysis is required to make that determination. As a fail
safe mechanism, this causes loops that were originally parallel to be considered
sequential (if optimization passes that are unaware of the parallel semantics
insert new memory instructions into the loop body).</p>
<p>Example of a loop that is considered parallel due to its correct use of
both <code class="docutils literal notranslate"><span class="pre">llvm.access.group</span></code> and <code class="docutils literal notranslate"><span class="pre">llvm.loop.parallel_accesses</span></code>
metadata types.</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nl">for.body:</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">%arrayidx</span><span class="p">,</span> <span class="nv">!llvm.access.group</span> <span class="nv nv-Anonymous">!1</span>
<span class="p">...</span>
<span class="k">store</span> <span class="k">i32</span> <span class="nv">%val0</span><span class="p">,</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%arrayidx1</span><span class="p">,</span> <span class="nv">!llvm.access.group</span> <span class="nv nv-Anonymous">!1</span>
<span class="p">...</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%exitcond</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%for.end</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%for.body</span><span class="p">,</span> <span class="nv">!llvm.loop</span> <span class="nv nv-Anonymous">!0</span>
<span class="nl">for.end:</span>
<span class="p">...</span>
<span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="k">distinct</span> <span class="p">!{</span><span class="nv nv-Anonymous">!0</span><span class="p">,</span> <span class="p">!{</span><span class="nv">!"llvm.loop.parallel_accesses"</span><span class="p">,</span> <span class="nv nv-Anonymous">!1</span><span class="p">}}</span>
<span class="nv nv-Anonymous">!1</span> <span class="p">=</span> <span class="k">distinct</span> <span class="p">!{}</span>
</pre></div>
</div>
<p>It is also possible to have nested parallel loops:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nl">outer.for.body:</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">%arrayidx3</span><span class="p">,</span> <span class="nv">!llvm.access.group</span> <span class="nv nv-Anonymous">!4</span>
<span class="p">...</span>
<span class="k">br</span> <span class="k">label</span> <span class="nv">%inner.for.body</span>
<span class="nl">inner.for.body:</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">%arrayidx1</span><span class="p">,</span> <span class="nv">!llvm.access.group</span> <span class="nv nv-Anonymous">!3</span>
<span class="p">...</span>
<span class="k">store</span> <span class="k">i32</span> <span class="nv">%val0</span><span class="p">,</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%arrayidx2</span><span class="p">,</span> <span class="nv">!llvm.access.group</span> <span class="nv nv-Anonymous">!3</span>
<span class="p">...</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%exitcond</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%inner.for.end</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%inner.for.body</span><span class="p">,</span> <span class="nv">!llvm.loop</span> <span class="nv nv-Anonymous">!1</span>
<span class="nl">inner.for.end:</span>
<span class="p">...</span>
<span class="k">store</span> <span class="k">i32</span> <span class="nv">%val1</span><span class="p">,</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%arrayidx4</span><span class="p">,</span> <span class="nv">!llvm.access.group</span> <span class="nv nv-Anonymous">!4</span>
<span class="p">...</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%exitcond</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%outer.for.end</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%outer.for.body</span><span class="p">,</span> <span class="nv">!llvm.loop</span> <span class="nv nv-Anonymous">!2</span>
<span class="nl">outer.for.end:</span> <span class="c">; preds = %for.body</span>
<span class="p">...</span>
<span class="nv nv-Anonymous">!1</span> <span class="p">=</span> <span class="k">distinct</span> <span class="p">!{</span><span class="nv nv-Anonymous">!1</span><span class="p">,</span> <span class="p">!{</span><span class="nv">!"llvm.loop.parallel_accesses"</span><span class="p">,</span> <span class="nv nv-Anonymous">!3</span><span class="p">}}</span> <span class="c">; metadata for the inner loop</span>
<span class="nv nv-Anonymous">!2</span> <span class="p">=</span> <span class="k">distinct</span> <span class="p">!{</span><span class="nv nv-Anonymous">!2</span><span class="p">,</span> <span class="p">!{</span><span class="nv">!"llvm.loop.parallel_accesses"</span><span class="p">,</span> <span class="nv nv-Anonymous">!3</span><span class="p">,</span> <span class="nv nv-Anonymous">!4</span><span class="p">}}</span> <span class="c">; metadata for the outer loop</span>
<span class="nv nv-Anonymous">!3</span> <span class="p">=</span> <span class="k">distinct</span> <span class="p">!{}</span> <span class="c">; access group for instructions in the inner loop (which are implicitly contained in outer loop as well)</span>
<span class="nv nv-Anonymous">!4</span> <span class="p">=</span> <span class="k">distinct</span> <span class="p">!{}</span> <span class="c">; access group for instructions in the outer, but not the inner loop</span>
</pre></div>
</div>
</div>
<div class="section" id="llvm-loop-mustprogress-metadata">
<h4><a class="toc-backref" href="#id1577">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.mustprogress</span></code>’ Metadata</a><a class="headerlink" href="#llvm-loop-mustprogress-metadata" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.loop.mustprogress</span></code> metadata indicates that this loop is required to
terminate, unwind, or interact with the environment in an observable way e.g.
via a volatile memory access, I/O, or other synchronization. If such a loop is
not found to interact with the environment in an observable way, the loop may
be removed. This corresponds to the <code class="docutils literal notranslate"><span class="pre">mustprogress</span></code> function attribute.</p>
</div>
<div class="section" id="irr-loop-metadata">
<h4><a class="toc-backref" href="#id1578">‘<code class="docutils literal notranslate"><span class="pre">irr_loop</span></code>’ Metadata</a><a class="headerlink" href="#irr-loop-metadata" title="Permalink to this headline">¶</a></h4>
<p><code class="docutils literal notranslate"><span class="pre">irr_loop</span></code> metadata may be attached to the terminator instruction of a basic
block that’s an irreducible loop header (note that an irreducible loop has more
than once header basic blocks.) If <code class="docutils literal notranslate"><span class="pre">irr_loop</span></code> metadata is attached to the
terminator instruction of a basic block that is not really an irreducible loop
header, the behavior is undefined. The intent of this metadata is to improve the
accuracy of the block frequency propagation. For example, in the code below, the
block <code class="docutils literal notranslate"><span class="pre">header0</span></code> may have a loop header weight (relative to the other headers of
the irreducible loop) of 100:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nl">header0:</span>
<span class="p">...</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%cmp</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%t1</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%t2</span><span class="p">,</span> <span class="nv">!irr_loop</span> <span class="nv nv-Anonymous">!0</span>
<span class="p">...</span>
<span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="s">"loop_header_weight"</span><span class="p">,</span> <span class="k">i64</span> <span class="m">100</span><span class="p">}</span>
</pre></div>
</div>
<p>Irreducible loop header weights are typically based on profile data.</p>
</div>
<div class="section" id="invariant-group-metadata">
<span id="md-invariant-group"></span><h4><a class="toc-backref" href="#id1579">‘<code class="docutils literal notranslate"><span class="pre">invariant.group</span></code>’ Metadata</a><a class="headerlink" href="#invariant-group-metadata" title="Permalink to this headline">¶</a></h4>
<p>The experimental <code class="docutils literal notranslate"><span class="pre">invariant.group</span></code> metadata may be attached to
<code class="docutils literal notranslate"><span class="pre">load</span></code>/<code class="docutils literal notranslate"><span class="pre">store</span></code> instructions referencing a single metadata with no entries.
The existence of the <code class="docutils literal notranslate"><span class="pre">invariant.group</span></code> metadata on the instruction tells
the optimizer that every <code class="docutils literal notranslate"><span class="pre">load</span></code> and <code class="docutils literal notranslate"><span class="pre">store</span></code> to the same pointer operand
can be assumed to load or store the same
value (but see the <code class="docutils literal notranslate"><span class="pre">llvm.launder.invariant.group</span></code> intrinsic which affects
when two pointers are considered the same). Pointers returned by bitcast or
getelementptr with only zero indices are considered the same.</p>
<p>Examples:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="vg">@unknownPtr</span> <span class="p">=</span> <span class="k">external</span> <span class="k">global</span> <span class="k">i8</span>
<span class="p">...</span>
<span class="nv">%ptr</span> <span class="p">=</span> <span class="k">alloca</span> <span class="k">i8</span>
<span class="k">store</span> <span class="k">i8</span> <span class="m">42</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%ptr</span><span class="p">,</span> <span class="nv">!invariant.group</span> <span class="nv nv-Anonymous">!0</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@foo</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%ptr</span><span class="p">)</span>
<span class="nv">%a</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">%ptr</span><span class="p">,</span> <span class="nv">!invariant.group</span> <span class="nv nv-Anonymous">!0</span> <span class="c">; Can assume that value under %ptr didn't change</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@foo</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%ptr</span><span class="p">)</span>
<span class="nv">%newPtr</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@getPointer</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%ptr</span><span class="p">)</span>
<span class="nv">%c</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">%newPtr</span><span class="p">,</span> <span class="nv">!invariant.group</span> <span class="nv nv-Anonymous">!0</span> <span class="c">; Can't assume anything, because we only have information about %ptr</span>
<span class="nv">%unknownValue</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="vg">@unknownPtr</span>
<span class="k">store</span> <span class="k">i8</span> <span class="nv">%unknownValue</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%ptr</span><span class="p">,</span> <span class="nv">!invariant.group</span> <span class="nv nv-Anonymous">!0</span> <span class="c">; Can assume that %unknownValue == 42</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@foo</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%ptr</span><span class="p">)</span>
<span class="nv">%newPtr2</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@llvm.launder.invariant.group</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%ptr</span><span class="p">)</span>
<span class="nv">%d</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">%newPtr2</span><span class="p">,</span> <span class="nv">!invariant.group</span> <span class="nv nv-Anonymous">!0</span> <span class="c">; Can't step through launder.invariant.group to get value of %ptr</span>
<span class="p">...</span>
<span class="k">declare</span> <span class="k">void</span> <span class="vg">@foo</span><span class="p">(</span><span class="k">i8</span><span class="p">*)</span>
<span class="k">declare</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@getPointer</span><span class="p">(</span><span class="k">i8</span><span class="p">*)</span>
<span class="k">declare</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@llvm.launder.invariant.group</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="p">!{}</span>
</pre></div>
</div>
<p>The invariant.group metadata must be dropped when replacing one pointer by
another based on aliasing information. This is because invariant.group is tied
to the SSA value of the pointer operand.</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%v</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">%x</span><span class="p">,</span> <span class="nv">!invariant.group</span> <span class="nv nv-Anonymous">!0</span>
<span class="c">; if %x mustalias %y then we can replace the above instruction with</span>
<span class="nv">%v</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">%y</span>
</pre></div>
</div>
<p>Note that this is an experimental feature, which means that its semantics might
change in the future.</p>
</div>
<div class="section" id="type-metadata">
<h4><a class="toc-backref" href="#id1580">‘<code class="docutils literal notranslate"><span class="pre">type</span></code>’ Metadata</a><a class="headerlink" href="#type-metadata" title="Permalink to this headline">¶</a></h4>
<p>See <a class="reference internal" href="TypeMetadata.html"><span class="doc">Type Metadata</span></a>.</p>
</div>
<div class="section" id="associated-metadata">
<h4><a class="toc-backref" href="#id1581">‘<code class="docutils literal notranslate"><span class="pre">associated</span></code>’ Metadata</a><a class="headerlink" href="#associated-metadata" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">associated</span></code> metadata may be attached to a global variable definition with
a single argument that references a global object (optionally through an alias).</p>
<p>This metadata lowers to the ELF section flag <code class="docutils literal notranslate"><span class="pre">SHF_LINK_ORDER</span></code> which prevents
discarding of the global variable in linker GC unless the referenced object is
also discarded. The linker support for this feature is spotty. For best
compatibility, globals carrying this metadata should:</p>
<ul class="simple">
<li><p>Be in <code class="docutils literal notranslate"><span class="pre">@llvm.compiler.used</span></code>.</p></li>
<li><p>If the referenced global variable is in a comdat, be in the same comdat.</p></li>
</ul>
<p><code class="docutils literal notranslate"><span class="pre">!associated</span></code> can not express many-to-one relationship. A global variable with
the metadata should generally not be referenced by a function: the function may
be inlined into other functions, leading to more references to the metadata.
Ideally we would want to keep metadata alive as long as any inline location is
alive, but this many-to-one relationship is not representable. Moreover, if the
metadata is retained while the function is discarded, the linker will report an
error of a relocation referencing a discarded section.</p>
<p>The metadata is often used with an explicit section consisting of valid C
identifiers so that the runtime can find the metadata section with
linker-defined encapsulation symbols <code class="docutils literal notranslate"><span class="pre">__start_<section_name></span></code> and
<code class="docutils literal notranslate"><span class="pre">__stop_<section_name></span></code>.</p>
<p>It does not have any effect on non-ELF targets.</p>
<p>Example:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>$a = comdat any
@a = global i32 1, comdat $a
@b = internal global i32 2, comdat $a, section "abc", !associated !0
!0 = !{i32* @a}
</pre></div>
</div>
</div>
<div class="section" id="prof-metadata">
<h4><a class="toc-backref" href="#id1582">‘<code class="docutils literal notranslate"><span class="pre">prof</span></code>’ Metadata</a><a class="headerlink" href="#prof-metadata" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">prof</span></code> metadata is used to record profile data in the IR.
The first operand of the metadata node indicates the profile metadata
type. There are currently 3 types:
<a class="reference internal" href="#prof-node-branch-weights"><span class="std std-ref">branch_weights</span></a>,
<a class="reference internal" href="#prof-node-function-entry-count"><span class="std std-ref">function_entry_count</span></a>, and
<a class="reference internal" href="#prof-node-vp"><span class="std std-ref">VP</span></a>.</p>
<div class="section" id="branch-weights">
<span id="prof-node-branch-weights"></span><h5><a class="toc-backref" href="#id1583">branch_weights</a><a class="headerlink" href="#branch-weights" title="Permalink to this headline">¶</a></h5>
<p>Branch weight metadata attached to a branch, select, switch or call instruction
represents the likeliness of the associated branch being taken.
For more information, see <a class="reference internal" href="BranchWeightMetadata.html"><span class="doc">LLVM Branch Weight Metadata</span></a>.</p>
</div>
<div class="section" id="function-entry-count">
<span id="prof-node-function-entry-count"></span><h5><a class="toc-backref" href="#id1584">function_entry_count</a><a class="headerlink" href="#function-entry-count" title="Permalink to this headline">¶</a></h5>
<p>Function entry count metadata can be attached to function definitions
to record the number of times the function is called. Used with BFI
information, it is also used to derive the basic block profile count.
For more information, see <a class="reference internal" href="BranchWeightMetadata.html"><span class="doc">LLVM Branch Weight Metadata</span></a>.</p>
</div>
<div class="section" id="vp">
<span id="prof-node-vp"></span><h5><a class="toc-backref" href="#id1585">VP</a><a class="headerlink" href="#vp" title="Permalink to this headline">¶</a></h5>
<p>VP (value profile) metadata can be attached to instructions that have
value profile information. Currently this is indirect calls (where it
records the hottest callees) and calls to memory intrinsics such as memcpy,
memmove, and memset (where it records the hottest byte lengths).</p>
<p>Each VP metadata node contains “VP” string, then a uint32_t value for the value
profiling kind, a uint64_t value for the total number of times the instruction
is executed, followed by uint64_t value and execution count pairs.
The value profiling kind is 0 for indirect call targets and 1 for memory
operations. For indirect call targets, each profile value is a hash
of the callee function name, and for memory operations each value is the
byte length.</p>
<p>Note that the value counts do not need to add up to the total count
listed in the third operand (in practice only the top hottest values
are tracked and reported).</p>
<p>Indirect call example:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">call</span> <span class="k">void</span> <span class="nv">%f</span><span class="p">(),</span> <span class="nv">!prof</span> <span class="nv nv-Anonymous">!1</span>
<span class="nv nv-Anonymous">!1</span> <span class="p">=</span> <span class="p">!{</span><span class="nv">!"VP"</span><span class="p">,</span> <span class="k">i32</span> <span class="m">0</span><span class="p">,</span> <span class="k">i64</span> <span class="m">1600</span><span class="p">,</span> <span class="k">i64</span> <span class="m">7651369219802541373</span><span class="p">,</span> <span class="k">i64</span> <span class="m">1030</span><span class="p">,</span> <span class="k">i64</span> <span class="m">-4377547752858689819</span><span class="p">,</span> <span class="k">i64</span> <span class="m">410</span><span class="p">}</span>
</pre></div>
</div>
<p>Note that the VP type is 0 (the second operand), which indicates this is
an indirect call value profile data. The third operand indicates that the
indirect call executed 1600 times. The 4th and 6th operands give the
hashes of the 2 hottest target functions’ names (this is the same hash used
to represent function names in the profile database), and the 5th and 7th
operands give the execution count that each of the respective prior target
functions was called.</p>
</div>
</div>
<div class="section" id="annotation-metadata">
<span id="md-annotation"></span><h4><a class="toc-backref" href="#id1586">‘<code class="docutils literal notranslate"><span class="pre">annotation</span></code>’ Metadata</a><a class="headerlink" href="#annotation-metadata" title="Permalink to this headline">¶</a></h4>
<p>The <code class="docutils literal notranslate"><span class="pre">annotation</span></code> metadata can be used to attach a tuple of annotation strings
to any instruction. This metadata does not impact the semantics of the program
and may only be used to provide additional insight about the program and
transformations to users.</p>
<p>Example:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>%a.addr = alloca float*, align 8, !annotation !0
!0 = !{!"auto-init"}
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="module-flags-metadata">
<h2><a class="toc-backref" href="#id1587">Module Flags Metadata</a><a class="headerlink" href="#module-flags-metadata" title="Permalink to this headline">¶</a></h2>
<p>Information about the module as a whole is difficult to convey to LLVM’s
subsystems. The LLVM IR isn’t sufficient to transmit this information.
The <code class="docutils literal notranslate"><span class="pre">llvm.module.flags</span></code> named metadata exists in order to facilitate
this. These flags are in the form of key / value pairs — much like a
dictionary — making it easy for any subsystem who cares about a flag to
look it up.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.module.flags</span></code> metadata contains a list of metadata triplets.
Each triplet has the following form:</p>
<ul class="simple">
<li><p>The first element is a <em>behavior</em> flag, which specifies the behavior
when two (or more) modules are merged together, and it encounters two
(or more) metadata with the same ID. The supported behaviors are
described below.</p></li>
<li><p>The second element is a metadata string that is a unique ID for the
metadata. Each module may only have one flag entry for each unique ID (not
including entries with the <strong>Require</strong> behavior).</p></li>
<li><p>The third element is the value of the flag.</p></li>
</ul>
<p>When two (or more) modules are merged together, the resulting
<code class="docutils literal notranslate"><span class="pre">llvm.module.flags</span></code> metadata is the union of the modules’ flags. That is, for
each unique metadata ID string, there will be exactly one entry in the merged
modules <code class="docutils literal notranslate"><span class="pre">llvm.module.flags</span></code> metadata table, and the value for that entry will
be determined by the merge behavior flag, as described below. The only exception
is that entries with the <em>Require</em> behavior are always preserved.</p>
<p>The following behaviors are supported:</p>
<table class="colwidths-given docutils align-default">
<colgroup>
<col style="width: 10%" />
<col style="width: 90%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Value</p></th>
<th class="head"><p>Behavior</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>1</p></td>
<td><dl class="simple">
<dt><strong>Error</strong></dt><dd><p>Emits an error if two values disagree, otherwise the resulting value
is that of the operands.</p>
</dd>
</dl>
</td>
</tr>
<tr class="row-odd"><td><p>2</p></td>
<td><dl class="simple">
<dt><strong>Warning</strong></dt><dd><p>Emits a warning if two values disagree. The result value will be the
operand for the flag from the first module being linked, or the max
if the other module uses <strong>Max</strong> (in which case the resulting flag
will be <strong>Max</strong>).</p>
</dd>
</dl>
</td>
</tr>
<tr class="row-even"><td><p>3</p></td>
<td><dl class="simple">
<dt><strong>Require</strong></dt><dd><p>Adds a requirement that another module flag be present and have a
specified value after linking is performed. The value must be a
metadata pair, where the first element of the pair is the ID of the
module flag to be restricted, and the second element of the pair is
the value the module flag should be restricted to. This behavior can
be used to restrict the allowable results (via triggering of an
error) of linking IDs with the <strong>Override</strong> behavior.</p>
</dd>
</dl>
</td>
</tr>
<tr class="row-odd"><td><p>4</p></td>
<td><dl class="simple">
<dt><strong>Override</strong></dt><dd><p>Uses the specified value, regardless of the behavior or value of the
other module. If both modules specify <strong>Override</strong>, but the values
differ, an error will be emitted.</p>
</dd>
</dl>
</td>
</tr>
<tr class="row-even"><td><p>5</p></td>
<td><dl class="simple">
<dt><strong>Append</strong></dt><dd><p>Appends the two values, which are required to be metadata nodes.</p>
</dd>
</dl>
</td>
</tr>
<tr class="row-odd"><td><p>6</p></td>
<td><dl class="simple">
<dt><strong>AppendUnique</strong></dt><dd><p>Appends the two values, which are required to be metadata
nodes. However, duplicate entries in the second list are dropped
during the append operation.</p>
</dd>
</dl>
</td>
</tr>
<tr class="row-even"><td><p>7</p></td>
<td><dl class="simple">
<dt><strong>Max</strong></dt><dd><p>Takes the max of the two values, which are required to be integers.</p>
</dd>
</dl>
</td>
</tr>
</tbody>
</table>
<p>It is an error for a particular unique flag ID to have multiple behaviors,
except in the case of <strong>Require</strong> (which adds restrictions on another metadata
value) or <strong>Override</strong>.</p>
<p>An example of module flags:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span> <span class="k">i32</span> <span class="m">1</span><span class="p">,</span> <span class="nv">!"foo"</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span> <span class="p">}</span>
<span class="nv nv-Anonymous">!1</span> <span class="p">=</span> <span class="p">!{</span> <span class="k">i32</span> <span class="m">4</span><span class="p">,</span> <span class="nv">!"bar"</span><span class="p">,</span> <span class="k">i32</span> <span class="m">37</span> <span class="p">}</span>
<span class="nv nv-Anonymous">!2</span> <span class="p">=</span> <span class="p">!{</span> <span class="k">i32</span> <span class="m">2</span><span class="p">,</span> <span class="nv">!"qux"</span><span class="p">,</span> <span class="k">i32</span> <span class="m">42</span> <span class="p">}</span>
<span class="nv nv-Anonymous">!3</span> <span class="p">=</span> <span class="p">!{</span> <span class="k">i32</span> <span class="m">3</span><span class="p">,</span> <span class="nv">!"qux"</span><span class="p">,</span>
<span class="p">!{</span>
<span class="nv">!"foo"</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span>
<span class="p">}</span>
<span class="p">}</span>
<span class="nv">!llvm.module.flags</span> <span class="p">=</span> <span class="p">!{</span> <span class="nv nv-Anonymous">!0</span><span class="p">,</span> <span class="nv nv-Anonymous">!1</span><span class="p">,</span> <span class="nv nv-Anonymous">!2</span><span class="p">,</span> <span class="nv nv-Anonymous">!3</span> <span class="p">}</span>
</pre></div>
</div>
<ul>
<li><p>Metadata <code class="docutils literal notranslate"><span class="pre">!0</span></code> has the ID <code class="docutils literal notranslate"><span class="pre">!"foo"</span></code> and the value ‘1’. The behavior
if two or more <code class="docutils literal notranslate"><span class="pre">!"foo"</span></code> flags are seen is to emit an error if their
values are not equal.</p></li>
<li><p>Metadata <code class="docutils literal notranslate"><span class="pre">!1</span></code> has the ID <code class="docutils literal notranslate"><span class="pre">!"bar"</span></code> and the value ‘37’. The
behavior if two or more <code class="docutils literal notranslate"><span class="pre">!"bar"</span></code> flags are seen is to use the value
‘37’.</p></li>
<li><p>Metadata <code class="docutils literal notranslate"><span class="pre">!2</span></code> has the ID <code class="docutils literal notranslate"><span class="pre">!"qux"</span></code> and the value ‘42’. The
behavior if two or more <code class="docutils literal notranslate"><span class="pre">!"qux"</span></code> flags are seen is to emit a
warning if their values are not equal.</p></li>
<li><p>Metadata <code class="docutils literal notranslate"><span class="pre">!3</span></code> has the ID <code class="docutils literal notranslate"><span class="pre">!"qux"</span></code> and the value:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>!{ !"foo", i32 1 }
</pre></div>
</div>
<p>The behavior is to emit an error if the <code class="docutils literal notranslate"><span class="pre">llvm.module.flags</span></code> does not
contain a flag with the ID <code class="docutils literal notranslate"><span class="pre">!"foo"</span></code> that has the value ‘1’ after linking is
performed.</p>
</li>
</ul>
<div class="section" id="synthesized-functions-module-flags-metadata">
<h3><a class="toc-backref" href="#id1588">Synthesized Functions Module Flags Metadata</a><a class="headerlink" href="#synthesized-functions-module-flags-metadata" title="Permalink to this headline">¶</a></h3>
<p>These metadata specify the default attributes synthesized functions should have.
These metadata are currently respected by a few instrumentation passes, such as
sanitizers.</p>
<p>These metadata correspond to a few function attributes with significant code
generation behaviors. Function attributes with just optimization purposes
should not be listed because the performance impact of these synthesized
functions is small.</p>
<ul class="simple">
<li><p>“frame-pointer”: <strong>Max</strong>. The value can be 0, 1, or 2. A synthesized function
will get the “frame-pointer” function attribute, with value being “none”,
“non-leaf”, or “all”, respectively.</p></li>
<li><p>“uwtable”: <strong>Max</strong>. The value can be 0 or 1. If the value is 1, a synthesized
function will get the <code class="docutils literal notranslate"><span class="pre">uwtable</span></code> function attribute.</p></li>
</ul>
</div>
<div class="section" id="objective-c-garbage-collection-module-flags-metadata">
<h3><a class="toc-backref" href="#id1589">Objective-C Garbage Collection Module Flags Metadata</a><a class="headerlink" href="#objective-c-garbage-collection-module-flags-metadata" title="Permalink to this headline">¶</a></h3>
<p>On the Mach-O platform, Objective-C stores metadata about garbage
collection in a special section called “image info”. The metadata
consists of a version number and a bitmask specifying what types of
garbage collection are supported (if any) by the file. If two or more
modules are linked together their garbage collection metadata needs to
be merged rather than appended together.</p>
<p>The Objective-C garbage collection module flags metadata consists of the
following key-value pairs:</p>
<table class="colwidths-given docutils align-default">
<colgroup>
<col style="width: 30%" />
<col style="width: 70%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>Value</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">Objective-C</span> <span class="pre">Version</span></code></p></td>
<td><p><strong>[Required]</strong> — The Objective-C ABI version. Valid values are 1 and 2.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">Objective-C</span> <span class="pre">Image</span> <span class="pre">Info</span> <span class="pre">Version</span></code></p></td>
<td><p><strong>[Required]</strong> — The version of the image info section. Currently
always 0.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">Objective-C</span> <span class="pre">Image</span> <span class="pre">Info</span> <span class="pre">Section</span></code></p></td>
<td><p><strong>[Required]</strong> — The section to place the metadata. Valid values are
<code class="docutils literal notranslate"><span class="pre">"__OBJC,</span> <span class="pre">__image_info,</span> <span class="pre">regular"</span></code> for Objective-C ABI version 1, and
<code class="docutils literal notranslate"><span class="pre">"__DATA,__objc_imageinfo,</span> <span class="pre">regular,</span> <span class="pre">no_dead_strip"</span></code> for
Objective-C ABI version 2.</p></td>
</tr>
<tr class="row-odd"><td><p><code class="docutils literal notranslate"><span class="pre">Objective-C</span> <span class="pre">Garbage</span> <span class="pre">Collection</span></code></p></td>
<td><p><strong>[Required]</strong> — Specifies whether garbage collection is supported or
not. Valid values are 0, for no garbage collection, and 2, for garbage
collection supported.</p></td>
</tr>
<tr class="row-even"><td><p><code class="docutils literal notranslate"><span class="pre">Objective-C</span> <span class="pre">GC</span> <span class="pre">Only</span></code></p></td>
<td><p><strong>[Optional]</strong> — Specifies that only garbage collection is supported.
If present, its value must be 6. This flag requires that the
<code class="docutils literal notranslate"><span class="pre">Objective-C</span> <span class="pre">Garbage</span> <span class="pre">Collection</span></code> flag have the value 2.</p></td>
</tr>
</tbody>
</table>
<p>Some important flag interactions:</p>
<ul class="simple">
<li><p>If a module with <code class="docutils literal notranslate"><span class="pre">Objective-C</span> <span class="pre">Garbage</span> <span class="pre">Collection</span></code> set to 0 is
merged with a module with <code class="docutils literal notranslate"><span class="pre">Objective-C</span> <span class="pre">Garbage</span> <span class="pre">Collection</span></code> set to
2, then the resulting module has the
<code class="docutils literal notranslate"><span class="pre">Objective-C</span> <span class="pre">Garbage</span> <span class="pre">Collection</span></code> flag set to 0.</p></li>
<li><p>A module with <code class="docutils literal notranslate"><span class="pre">Objective-C</span> <span class="pre">Garbage</span> <span class="pre">Collection</span></code> set to 0 cannot be
merged with a module with <code class="docutils literal notranslate"><span class="pre">Objective-C</span> <span class="pre">GC</span> <span class="pre">Only</span></code> set to 6.</p></li>
</ul>
</div>
<div class="section" id="c-type-width-module-flags-metadata">
<h3><a class="toc-backref" href="#id1590">C type width Module Flags Metadata</a><a class="headerlink" href="#c-type-width-module-flags-metadata" title="Permalink to this headline">¶</a></h3>
<p>The ARM backend emits a section into each generated object file describing the
options that it was compiled with (in a compiler-independent way) to prevent
linking incompatible objects, and to allow automatic library selection. Some
of these options are not visible at the IR level, namely wchar_t width and enum
width.</p>
<p>To pass this information to the backend, these options are encoded in module
flags metadata, using the following key-value pairs:</p>
<table class="colwidths-given docutils align-default">
<colgroup>
<col style="width: 30%" />
<col style="width: 70%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Key</p></th>
<th class="head"><p>Value</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>short_wchar</p></td>
<td><ul class="simple">
<li><p>0 — sizeof(wchar_t) == 4</p></li>
<li><p>1 — sizeof(wchar_t) == 2</p></li>
</ul>
</td>
</tr>
<tr class="row-odd"><td><p>short_enum</p></td>
<td><ul class="simple">
<li><p>0 — Enums are at least as large as an <code class="docutils literal notranslate"><span class="pre">int</span></code>.</p></li>
<li><p>1 — Enums are stored in the smallest integer type which can
represent all of its values.</p></li>
</ul>
</td>
</tr>
</tbody>
</table>
<p>For example, the following metadata section specifies that the module was
compiled with a <code class="docutils literal notranslate"><span class="pre">wchar_t</span></code> width of 4 bytes, and the underlying type of an
enum is the smallest type which can represent all of its values:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>!llvm.module.flags = !{!0, !1}
!0 = !{i32 1, !"short_wchar", i32 1}
!1 = !{i32 1, !"short_enum", i32 0}
</pre></div>
</div>
</div>
<div class="section" id="lto-post-link-module-flags-metadata">
<h3><a class="toc-backref" href="#id1591">LTO Post-Link Module Flags Metadata</a><a class="headerlink" href="#lto-post-link-module-flags-metadata" title="Permalink to this headline">¶</a></h3>
<p>Some optimisations are only when the entire LTO unit is present in the current
module. This is represented by the <code class="docutils literal notranslate"><span class="pre">LTOPostLink</span></code> module flags metadata, which
will be created with a value of <code class="docutils literal notranslate"><span class="pre">1</span></code> when LTO linking occurs.</p>
</div>
</div>
<div class="section" id="automatic-linker-flags-named-metadata">
<h2><a class="toc-backref" href="#id1592">Automatic Linker Flags Named Metadata</a><a class="headerlink" href="#automatic-linker-flags-named-metadata" title="Permalink to this headline">¶</a></h2>
<p>Some targets support embedding of flags to the linker inside individual object
files. Typically this is used in conjunction with language extensions which
allow source files to contain linker command line options, and have these
automatically be transmitted to the linker via object files.</p>
<p>These flags are encoded in the IR using named metadata with the name
<code class="docutils literal notranslate"><span class="pre">!llvm.linker.options</span></code>. Each operand is expected to be a metadata node
which should be a list of other metadata nodes, each of which should be a
list of metadata strings defining linker options.</p>
<p>For example, the following metadata section specifies two separate sets of
linker options, presumably to link against <code class="docutils literal notranslate"><span class="pre">libz</span></code> and the <code class="docutils literal notranslate"><span class="pre">Cocoa</span></code>
framework:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>!0 = !{ !"-lz" }
!1 = !{ !"-framework", !"Cocoa" }
!llvm.linker.options = !{ !0, !1 }
</pre></div>
</div>
<p>The metadata encoding as lists of lists of options, as opposed to a collapsed
list of options, is chosen so that the IR encoding can use multiple option
strings to specify e.g., a single library, while still having that specifier be
preserved as an atomic element that can be recognized by a target specific
assembly writer or object file emitter.</p>
<p>Each individual option is required to be either a valid option for the target’s
linker, or an option that is reserved by the target specific assembly writer or
object file emitter. No other aspect of these options is defined by the IR.</p>
</div>
<div class="section" id="dependent-libs-named-metadata">
<h2><a class="toc-backref" href="#id1593">Dependent Libs Named Metadata</a><a class="headerlink" href="#dependent-libs-named-metadata" title="Permalink to this headline">¶</a></h2>
<p>Some targets support embedding of strings into object files to indicate
a set of libraries to add to the link. Typically this is used in conjunction
with language extensions which allow source files to explicitly declare the
libraries they depend on, and have these automatically be transmitted to the
linker via object files.</p>
<p>The list is encoded in the IR using named metadata with the name
<code class="docutils literal notranslate"><span class="pre">!llvm.dependent-libraries</span></code>. Each operand is expected to be a metadata node
which should contain a single string operand.</p>
<p>For example, the following metadata section contains two library specifiers:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>!0 = !{!"a library specifier"}
!1 = !{!"another library specifier"}
!llvm.dependent-libraries = !{ !0, !1 }
</pre></div>
</div>
<p>Each library specifier will be handled independently by the consuming linker.
The effect of the library specifiers are defined by the consuming linker.</p>
</div>
<div class="section" id="thinlto-summary">
<span id="summary"></span><h2><a class="toc-backref" href="#id1594">ThinLTO Summary</a><a class="headerlink" href="#thinlto-summary" title="Permalink to this headline">¶</a></h2>
<p>Compiling with <a class="reference external" href="https://clang.llvm.org/docs/ThinLTO.html">ThinLTO</a>
causes the building of a compact summary of the module that is emitted into
the bitcode. The summary is emitted into the LLVM assembly and identified
in syntax by a caret (‘<code class="docutils literal notranslate"><span class="pre">^</span></code>’).</p>
<p>The summary is parsed into a bitcode output, along with the Module
IR, via the “<code class="docutils literal notranslate"><span class="pre">llvm-as</span></code>” tool. Tools that parse the Module IR for the purposes
of optimization (e.g. “<code class="docutils literal notranslate"><span class="pre">clang</span> <span class="pre">-x</span> <span class="pre">ir</span></code>” and “<code class="docutils literal notranslate"><span class="pre">opt</span></code>”), will ignore the
summary entries (just as they currently ignore summary entries in a bitcode
input file).</p>
<p>Eventually, the summary will be parsed into a ModuleSummaryIndex object under
the same conditions where summary index is currently built from bitcode.
Specifically, tools that test the Thin Link portion of a ThinLTO compile
(i.e. llvm-lto and llvm-lto2), or when parsing a combined index
for a distributed ThinLTO backend via clang’s “<code class="docutils literal notranslate"><span class="pre">-fthinlto-index=<></span></code>” flag
(this part is not yet implemented, use llvm-as to create a bitcode object
before feeding into thin link tools for now).</p>
<p>There are currently 3 types of summary entries in the LLVM assembly:
<a class="reference internal" href="#module-path-summary"><span class="std std-ref">module paths</span></a>,
<a class="reference internal" href="#gv-summary"><span class="std std-ref">global values</span></a>, and
<a class="reference internal" href="#typeid-summary"><span class="std std-ref">type identifiers</span></a>.</p>
<div class="section" id="module-path-summary-entry">
<span id="module-path-summary"></span><h3><a class="toc-backref" href="#id1595">Module Path Summary Entry</a><a class="headerlink" href="#module-path-summary-entry" title="Permalink to this headline">¶</a></h3>
<p>Each module path summary entry lists a module containing global values included
in the summary. For a single IR module there will be one such entry, but
in a combined summary index produced during the thin link, there will be
one module path entry per linked module with summary.</p>
<p>Example:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>^0 = module: (path: "/path/to/file.o", hash: (2468601609, 1329373163, 1565878005, 638838075, 3148790418))
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">path</span></code> field is a string path to the bitcode file, and the <code class="docutils literal notranslate"><span class="pre">hash</span></code>
field is the 160-bit SHA-1 hash of the IR bitcode contents, used for
incremental builds and caching.</p>
</div>
<div class="section" id="global-value-summary-entry">
<span id="gv-summary"></span><h3><a class="toc-backref" href="#id1596">Global Value Summary Entry</a><a class="headerlink" href="#global-value-summary-entry" title="Permalink to this headline">¶</a></h3>
<p>Each global value summary entry corresponds to a global value defined or
referenced by a summarized module.</p>
<p>Example:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>^4 = gv: (name: "f"[, summaries: (Summary)[, (Summary)]*]?) ; guid = 14740650423002898831
</pre></div>
</div>
<p>For declarations, there will not be a summary list. For definitions, a
global value will contain a list of summaries, one per module containing
a definition. There can be multiple entries in a combined summary index
for symbols with weak linkage.</p>
<p>Each <code class="docutils literal notranslate"><span class="pre">Summary</span></code> format will depend on whether the global value is a
<a class="reference internal" href="#function-summary"><span class="std std-ref">function</span></a>, <a class="reference internal" href="#variable-summary"><span class="std std-ref">variable</span></a>, or
<a class="reference internal" href="#alias-summary"><span class="std std-ref">alias</span></a>.</p>
<div class="section" id="function-summary">
<span id="id25"></span><h4><a class="toc-backref" href="#id1597">Function Summary</a><a class="headerlink" href="#function-summary" title="Permalink to this headline">¶</a></h4>
<p>If the global value is a function, the <code class="docutils literal notranslate"><span class="pre">Summary</span></code> entry will look like:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>function: (module: ^0, flags: (linkage: external, notEligibleToImport: 0, live: 0, dsoLocal: 0), insts: 2[, FuncFlags]?[, Calls]?[, TypeIdInfo]?[, Params]?[, Refs]?
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">module</span></code> field includes the summary entry id for the module containing
this definition, and the <code class="docutils literal notranslate"><span class="pre">flags</span></code> field contains information such as
the linkage type, a flag indicating whether it is legal to import the
definition, whether it is globally live and whether the linker resolved it
to a local definition (the latter two are populated during the thin link).
The <code class="docutils literal notranslate"><span class="pre">insts</span></code> field contains the number of IR instructions in the function.
Finally, there are several optional fields: <a class="reference internal" href="#funcflags-summary"><span class="std std-ref">FuncFlags</span></a>,
<a class="reference internal" href="#calls-summary"><span class="std std-ref">Calls</span></a>, <a class="reference internal" href="#typeidinfo-summary"><span class="std std-ref">TypeIdInfo</span></a>,
<a class="reference internal" href="#params-summary"><span class="std std-ref">Params</span></a>, <a class="reference internal" href="#refs-summary"><span class="std std-ref">Refs</span></a>.</p>
</div>
<div class="section" id="global-variable-summary">
<span id="variable-summary"></span><h4><a class="toc-backref" href="#id1598">Global Variable Summary</a><a class="headerlink" href="#global-variable-summary" title="Permalink to this headline">¶</a></h4>
<p>If the global value is a variable, the <code class="docutils literal notranslate"><span class="pre">Summary</span></code> entry will look like:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>variable: (module: ^0, flags: (linkage: external, notEligibleToImport: 0, live: 0, dsoLocal: 0)[, Refs]?
</pre></div>
</div>
<p>The variable entry contains a subset of the fields in a
<a class="reference internal" href="#function-summary"><span class="std std-ref">function summary</span></a>, see the descriptions there.</p>
</div>
<div class="section" id="alias-summary">
<span id="id26"></span><h4><a class="toc-backref" href="#id1599">Alias Summary</a><a class="headerlink" href="#alias-summary" title="Permalink to this headline">¶</a></h4>
<p>If the global value is an alias, the <code class="docutils literal notranslate"><span class="pre">Summary</span></code> entry will look like:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>alias: (module: ^0, flags: (linkage: external, notEligibleToImport: 0, live: 0, dsoLocal: 0), aliasee: ^2)
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">module</span></code> and <code class="docutils literal notranslate"><span class="pre">flags</span></code> fields are as described for a
<a class="reference internal" href="#function-summary"><span class="std std-ref">function summary</span></a>. The <code class="docutils literal notranslate"><span class="pre">aliasee</span></code> field
contains a reference to the global value summary entry of the aliasee.</p>
</div>
<div class="section" id="function-flags">
<span id="funcflags-summary"></span><h4><a class="toc-backref" href="#id1600">Function Flags</a><a class="headerlink" href="#function-flags" title="Permalink to this headline">¶</a></h4>
<p>The optional <code class="docutils literal notranslate"><span class="pre">FuncFlags</span></code> field looks like:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>funcFlags: (readNone: 0, readOnly: 0, noRecurse: 0, returnDoesNotAlias: 0)
</pre></div>
</div>
<p>If unspecified, flags are assumed to hold the conservative <code class="docutils literal notranslate"><span class="pre">false</span></code> value of
<code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>
</div>
<div class="section" id="calls">
<span id="calls-summary"></span><h4><a class="toc-backref" href="#id1601">Calls</a><a class="headerlink" href="#calls" title="Permalink to this headline">¶</a></h4>
<p>The optional <code class="docutils literal notranslate"><span class="pre">Calls</span></code> field looks like:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>calls: ((Callee)[, (Callee)]*)
</pre></div>
</div>
<p>where each <code class="docutils literal notranslate"><span class="pre">Callee</span></code> looks like:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>callee: ^1[, hotness: None]?[, relbf: 0]?
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">callee</span></code> refers to the summary entry id of the callee. At most one
of <code class="docutils literal notranslate"><span class="pre">hotness</span></code> (which can take the values <code class="docutils literal notranslate"><span class="pre">Unknown</span></code>, <code class="docutils literal notranslate"><span class="pre">Cold</span></code>, <code class="docutils literal notranslate"><span class="pre">None</span></code>,
<code class="docutils literal notranslate"><span class="pre">Hot</span></code>, and <code class="docutils literal notranslate"><span class="pre">Critical</span></code>), and <code class="docutils literal notranslate"><span class="pre">relbf</span></code> (which holds the integer
branch frequency relative to the entry frequency, scaled down by 2^8)
may be specified. The defaults are <code class="docutils literal notranslate"><span class="pre">Unknown</span></code> and <code class="docutils literal notranslate"><span class="pre">0</span></code>, respectively.</p>
</div>
<div class="section" id="params">
<span id="params-summary"></span><h4><a class="toc-backref" href="#id1602">Params</a><a class="headerlink" href="#params" title="Permalink to this headline">¶</a></h4>
<p>The optional <code class="docutils literal notranslate"><span class="pre">Params</span></code> is used by <code class="docutils literal notranslate"><span class="pre">StackSafety</span></code> and looks like:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>Params: ((Param)[, (Param)]*)
</pre></div>
</div>
<p>where each <code class="docutils literal notranslate"><span class="pre">Param</span></code> describes pointer parameter access inside of the
function and looks like:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>param: 4, offset: [0, 5][, calls: ((Callee)[, (Callee)]*)]?
</pre></div>
</div>
<p>where the first <code class="docutils literal notranslate"><span class="pre">param</span></code> is the number of the parameter it describes,
<code class="docutils literal notranslate"><span class="pre">offset</span></code> is the inclusive range of offsets from the pointer parameter to bytes
which can be accessed by the function. This range does not include accesses by
function calls from <code class="docutils literal notranslate"><span class="pre">calls</span></code> list.</p>
<p>where each <code class="docutils literal notranslate"><span class="pre">Callee</span></code> describes how parameter is forwarded into other
functions and looks like:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>callee: ^3, param: 5, offset: [-3, 3]
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">callee</span></code> refers to the summary entry id of the callee, <code class="docutils literal notranslate"><span class="pre">param</span></code> is
the number of the callee parameter which points into the callers parameter
with offset known to be inside of the <code class="docutils literal notranslate"><span class="pre">offset</span></code> range. <code class="docutils literal notranslate"><span class="pre">calls</span></code> will be
consumed and removed by thin link stage to update <code class="docutils literal notranslate"><span class="pre">Param::offset</span></code> so it
covers all accesses possible by <code class="docutils literal notranslate"><span class="pre">calls</span></code>.</p>
<p>Pointer parameter without corresponding <code class="docutils literal notranslate"><span class="pre">Param</span></code> is considered unsafe and we
assume that access with any offset is possible.</p>
<p>Example:</p>
<p>If we have the following function:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>define i64 @foo(i64* %0, i32* %1, i8* %2, i8 %3) {
store i32* %1, i32** @x
%5 = getelementptr inbounds i8, i8* %2, i64 5
%6 = load i8, i8* %5
%7 = getelementptr inbounds i8, i8* %2, i8 %3
tail call void @bar(i8 %3, i8* %7)
%8 = load i64, i64* %0
ret i64 %8
}
</pre></div>
</div>
<p>We can expect the record like this:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>params: ((param: 0, offset: [0, 7]),(param: 2, offset: [5, 5], calls: ((callee: ^3, param: 1, offset: [-128, 127]))))
</pre></div>
</div>
<p>The function may access just 8 bytes of the parameter %0 . <code class="docutils literal notranslate"><span class="pre">calls</span></code> is empty,
so the parameter is either not used for function calls or <code class="docutils literal notranslate"><span class="pre">offset</span></code> already
covers all accesses from nested function calls.
Parameter %1 escapes, so access is unknown.
The function itself can access just a single byte of the parameter %2. Additional
access is possible inside of the <code class="docutils literal notranslate"><span class="pre">@bar</span></code> or <code class="docutils literal notranslate"><span class="pre">^3</span></code>. The function adds signed
offset to the pointer and passes the result as the argument %1 into <code class="docutils literal notranslate"><span class="pre">^3</span></code>.
This record itself does not tell us how <code class="docutils literal notranslate"><span class="pre">^3</span></code> will access the parameter.
Parameter %3 is not a pointer.</p>
</div>
<div class="section" id="refs">
<span id="refs-summary"></span><h4><a class="toc-backref" href="#id1603">Refs</a><a class="headerlink" href="#refs" title="Permalink to this headline">¶</a></h4>
<p>The optional <code class="docutils literal notranslate"><span class="pre">Refs</span></code> field looks like:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>refs: ((Ref)[, (Ref)]*)
</pre></div>
</div>
<p>where each <code class="docutils literal notranslate"><span class="pre">Ref</span></code> contains a reference to the summary id of the referenced
value (e.g. <code class="docutils literal notranslate"><span class="pre">^1</span></code>).</p>
</div>
<div class="section" id="typeidinfo">
<span id="typeidinfo-summary"></span><h4><a class="toc-backref" href="#id1604">TypeIdInfo</a><a class="headerlink" href="#typeidinfo" title="Permalink to this headline">¶</a></h4>
<p>The optional <code class="docutils literal notranslate"><span class="pre">TypeIdInfo</span></code> field, used for
<a class="reference external" href="https://clang.llvm.org/docs/ControlFlowIntegrity.html">Control Flow Integrity</a>,
looks like:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>typeIdInfo: [(TypeTests)]?[, (TypeTestAssumeVCalls)]?[, (TypeCheckedLoadVCalls)]?[, (TypeTestAssumeConstVCalls)]?[, (TypeCheckedLoadConstVCalls)]?
</pre></div>
</div>
<p>These optional fields have the following forms:</p>
<div class="section" id="typetests">
<h5><a class="toc-backref" href="#id1605">TypeTests</a><a class="headerlink" href="#typetests" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>typeTests: (TypeIdRef[, TypeIdRef]*)
</pre></div>
</div>
<p>Where each <code class="docutils literal notranslate"><span class="pre">TypeIdRef</span></code> refers to a <a class="reference internal" href="#typeid-summary"><span class="std std-ref">type id</span></a>
by summary id or <code class="docutils literal notranslate"><span class="pre">GUID</span></code>.</p>
</div>
<div class="section" id="typetestassumevcalls">
<h5><a class="toc-backref" href="#id1606">TypeTestAssumeVCalls</a><a class="headerlink" href="#typetestassumevcalls" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>typeTestAssumeVCalls: (VFuncId[, VFuncId]*)
</pre></div>
</div>
<p>Where each VFuncId has the format:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>vFuncId: (TypeIdRef, offset: 16)
</pre></div>
</div>
<p>Where each <code class="docutils literal notranslate"><span class="pre">TypeIdRef</span></code> refers to a <a class="reference internal" href="#typeid-summary"><span class="std std-ref">type id</span></a>
by summary id or <code class="docutils literal notranslate"><span class="pre">GUID</span></code> preceded by a <code class="docutils literal notranslate"><span class="pre">guid:</span></code> tag.</p>
</div>
<div class="section" id="typecheckedloadvcalls">
<h5><a class="toc-backref" href="#id1607">TypeCheckedLoadVCalls</a><a class="headerlink" href="#typecheckedloadvcalls" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>typeCheckedLoadVCalls: (VFuncId[, VFuncId]*)
</pre></div>
</div>
<p>Where each VFuncId has the format described for <code class="docutils literal notranslate"><span class="pre">TypeTestAssumeVCalls</span></code>.</p>
</div>
<div class="section" id="typetestassumeconstvcalls">
<h5><a class="toc-backref" href="#id1608">TypeTestAssumeConstVCalls</a><a class="headerlink" href="#typetestassumeconstvcalls" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>typeTestAssumeConstVCalls: (ConstVCall[, ConstVCall]*)
</pre></div>
</div>
<p>Where each ConstVCall has the format:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>(VFuncId, args: (Arg[, Arg]*))
</pre></div>
</div>
<p>and where each VFuncId has the format described for <code class="docutils literal notranslate"><span class="pre">TypeTestAssumeVCalls</span></code>,
and each Arg is an integer argument number.</p>
</div>
<div class="section" id="typecheckedloadconstvcalls">
<h5><a class="toc-backref" href="#id1609">TypeCheckedLoadConstVCalls</a><a class="headerlink" href="#typecheckedloadconstvcalls" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>typeCheckedLoadConstVCalls: (ConstVCall[, ConstVCall]*)
</pre></div>
</div>
<p>Where each ConstVCall has the format described for
<code class="docutils literal notranslate"><span class="pre">TypeTestAssumeConstVCalls</span></code>.</p>
</div>
</div>
</div>
<div class="section" id="type-id-summary-entry">
<span id="typeid-summary"></span><h3><a class="toc-backref" href="#id1610">Type ID Summary Entry</a><a class="headerlink" href="#type-id-summary-entry" title="Permalink to this headline">¶</a></h3>
<p>Each type id summary entry corresponds to a type identifier resolution
which is generated during the LTO link portion of the compile when building
with <a class="reference external" href="https://clang.llvm.org/docs/ControlFlowIntegrity.html">Control Flow Integrity</a>,
so these are only present in a combined summary index.</p>
<p>Example:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>^4 = typeid: (name: "_ZTS1A", summary: (typeTestRes: (kind: allOnes, sizeM1BitWidth: 7[, alignLog2: 0]?[, sizeM1: 0]?[, bitMask: 0]?[, inlineBits: 0]?)[, WpdResolutions]?)) ; guid = 7004155349499253778
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">typeTestRes</span></code> gives the type test resolution <code class="docutils literal notranslate"><span class="pre">kind</span></code> (which may
be <code class="docutils literal notranslate"><span class="pre">unsat</span></code>, <code class="docutils literal notranslate"><span class="pre">byteArray</span></code>, <code class="docutils literal notranslate"><span class="pre">inline</span></code>, <code class="docutils literal notranslate"><span class="pre">single</span></code>, or <code class="docutils literal notranslate"><span class="pre">allOnes</span></code>), and
the <code class="docutils literal notranslate"><span class="pre">size-1</span></code> bit width. It is followed by optional flags, which default to 0,
and an optional WpdResolutions (whole program devirtualization resolution)
field that looks like:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>wpdResolutions: ((offset: 0, WpdRes)[, (offset: 1, WpdRes)]*
</pre></div>
</div>
<p>where each entry is a mapping from the given byte offset to the whole-program
devirtualization resolution WpdRes, that has one of the following formats:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>wpdRes: (kind: branchFunnel)
wpdRes: (kind: singleImpl, singleImplName: "_ZN1A1nEi")
wpdRes: (kind: indir)
</pre></div>
</div>
<p>Additionally, each wpdRes has an optional <code class="docutils literal notranslate"><span class="pre">resByArg</span></code> field, which
describes the resolutions for calls with all constant integer arguments:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>resByArg: (ResByArg[, ResByArg]*)
</pre></div>
</div>
<p>where ResByArg is:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>args: (Arg[, Arg]*), byArg: (kind: UniformRetVal[, info: 0][, byte: 0][, bit: 0])
</pre></div>
</div>
<p>Where the <code class="docutils literal notranslate"><span class="pre">kind</span></code> can be <code class="docutils literal notranslate"><span class="pre">Indir</span></code>, <code class="docutils literal notranslate"><span class="pre">UniformRetVal</span></code>, <code class="docutils literal notranslate"><span class="pre">UniqueRetVal</span></code>
or <code class="docutils literal notranslate"><span class="pre">VirtualConstProp</span></code>. The <code class="docutils literal notranslate"><span class="pre">info</span></code> field is only used if the kind
is <code class="docutils literal notranslate"><span class="pre">UniformRetVal</span></code> (indicates the uniform return value), or
<code class="docutils literal notranslate"><span class="pre">UniqueRetVal</span></code> (holds the return value associated with the unique vtable
(0 or 1)). The <code class="docutils literal notranslate"><span class="pre">byte</span></code> and <code class="docutils literal notranslate"><span class="pre">bit</span></code> fields are only used if the target does
not support the use of absolute symbols to store constants.</p>
</div>
</div>
<div class="section" id="intrinsic-global-variables">
<span id="intrinsicglobalvariables"></span><h2><a class="toc-backref" href="#id1611">Intrinsic Global Variables</a><a class="headerlink" href="#intrinsic-global-variables" title="Permalink to this headline">¶</a></h2>
<p>LLVM has a number of “magic” global variables that contain data that
affect code generation or other IR semantics. These are documented here.
All globals of this sort should have a section specified as
“<code class="docutils literal notranslate"><span class="pre">llvm.metadata</span></code>”. This section and all globals that start with
“<code class="docutils literal notranslate"><span class="pre">llvm.</span></code>” are reserved for use by LLVM.</p>
<div class="section" id="the-llvm-used-global-variable">
<span id="gv-llvmused"></span><h3><a class="toc-backref" href="#id1612">The ‘<code class="docutils literal notranslate"><span class="pre">llvm.used</span></code>’ Global Variable</a><a class="headerlink" href="#the-llvm-used-global-variable" title="Permalink to this headline">¶</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">@llvm.used</span></code> global is an array which has
<a class="reference internal" href="#linkage-appending"><span class="std std-ref">appending linkage</span></a>. This array contains a list of
pointers to named global variables, functions and aliases which may optionally
have a pointer cast formed of bitcast or getelementptr. For example, a legal
use of it is:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="vg">@X</span> <span class="p">=</span> <span class="k">global</span> <span class="k">i8</span> <span class="m">4</span>
<span class="vg">@Y</span> <span class="p">=</span> <span class="k">global</span> <span class="k">i32</span> <span class="m">123</span>
<span class="vg">@llvm.used</span> <span class="p">=</span> <span class="k">appending</span> <span class="k">global</span> <span class="p">[</span><span class="m">2</span> <span class="k">x</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="vg">@X</span><span class="p">,</span>
<span class="k">i8</span><span class="p">*</span> <span class="k">bitcast</span> <span class="p">(</span><span class="k">i32</span><span class="p">*</span> <span class="vg">@Y</span> <span class="k">to</span> <span class="k">i8</span><span class="p">*)</span>
<span class="p">],</span> <span class="k">section</span> <span class="s">"llvm.metadata"</span>
</pre></div>
</div>
<p>If a symbol appears in the <code class="docutils literal notranslate"><span class="pre">@llvm.used</span></code> list, then the compiler, assembler,
and linker are required to treat the symbol as if there is a reference to the
symbol that it cannot see (which is why they have to be named). For example, if
a variable has internal linkage and no references other than that from the
<code class="docutils literal notranslate"><span class="pre">@llvm.used</span></code> list, it cannot be deleted. This is commonly used to represent
references from inline asms and other things the compiler cannot “see”, and
corresponds to “<code class="docutils literal notranslate"><span class="pre">attribute((used))</span></code>” in GNU C.</p>
<p>On some targets, the code generator must emit a directive to the
assembler or object file to prevent the assembler and linker from
removing the symbol.</p>
</div>
<div class="section" id="the-llvm-compiler-used-global-variable">
<span id="gv-llvmcompilerused"></span><h3><a class="toc-backref" href="#id1613">The ‘<code class="docutils literal notranslate"><span class="pre">llvm.compiler.used</span></code>’ Global Variable</a><a class="headerlink" href="#the-llvm-compiler-used-global-variable" title="Permalink to this headline">¶</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">@llvm.compiler.used</span></code> directive is the same as the <code class="docutils literal notranslate"><span class="pre">@llvm.used</span></code>
directive, except that it only prevents the compiler from touching the
symbol. On targets that support it, this allows an intelligent linker to
optimize references to the symbol without being impeded as it would be
by <code class="docutils literal notranslate"><span class="pre">@llvm.used</span></code>.</p>
<p>This is a rare construct that should only be used in rare circumstances,
and should not be exposed to source languages.</p>
</div>
<div class="section" id="the-llvm-global-ctors-global-variable">
<span id="gv-llvmglobalctors"></span><h3><a class="toc-backref" href="#id1614">The ‘<code class="docutils literal notranslate"><span class="pre">llvm.global_ctors</span></code>’ Global Variable</a><a class="headerlink" href="#the-llvm-global-ctors-global-variable" title="Permalink to this headline">¶</a></h3>
<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">type</span> <span class="p">{</span> <span class="k">i32</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="p">}</span>
<span class="vg">@llvm.global_ctors</span> <span class="p">=</span> <span class="k">appending</span> <span class="k">global</span> <span class="p">[</span><span class="m">1</span> <span class="k">x</span> <span class="nv nv-Anonymous">%0</span><span class="p">]</span> <span class="p">[</span><span class="nv nv-Anonymous">%0</span> <span class="p">{</span> <span class="k">i32</span> <span class="m">65535</span><span class="p">,</span> <span class="k">void</span> <span class="p">()*</span> <span class="vg">@ctor</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@data</span> <span class="p">}]</span>
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">@llvm.global_ctors</span></code> array contains a list of constructor
functions, priorities, and an associated global or function.
The functions referenced by this array will be called in ascending order
of priority (i.e. lowest first) when the module is loaded. The order of
functions with the same priority is not defined.</p>
<p>If the third field is non-null, and points to a global variable
or function, the initializer function will only run if the associated
data from the current module is not discarded.
On ELF the referenced global variable or function must be in a comdat.</p>
</div>
<div class="section" id="the-llvm-global-dtors-global-variable">
<span id="llvmglobaldtors"></span><h3><a class="toc-backref" href="#id1615">The ‘<code class="docutils literal notranslate"><span class="pre">llvm.global_dtors</span></code>’ Global Variable</a><a class="headerlink" href="#the-llvm-global-dtors-global-variable" title="Permalink to this headline">¶</a></h3>
<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">type</span> <span class="p">{</span> <span class="k">i32</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="p">}</span>
<span class="vg">@llvm.global_dtors</span> <span class="p">=</span> <span class="k">appending</span> <span class="k">global</span> <span class="p">[</span><span class="m">1</span> <span class="k">x</span> <span class="nv nv-Anonymous">%0</span><span class="p">]</span> <span class="p">[</span><span class="nv nv-Anonymous">%0</span> <span class="p">{</span> <span class="k">i32</span> <span class="m">65535</span><span class="p">,</span> <span class="k">void</span> <span class="p">()*</span> <span class="vg">@dtor</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@data</span> <span class="p">}]</span>
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">@llvm.global_dtors</span></code> array contains a list of destructor
functions, priorities, and an associated global or function.
The functions referenced by this array will be called in descending
order of priority (i.e. highest first) when the module is unloaded. The
order of functions with the same priority is not defined.</p>
<p>If the third field is non-null, and points to a global variable
or function, the destructor function will only run if the associated
data from the current module is not discarded.
On ELF the referenced global variable or function must be in a comdat.</p>
</div>
</div>
<div class="section" id="instruction-reference">
<h2><a class="toc-backref" href="#id1616">Instruction Reference</a><a class="headerlink" href="#instruction-reference" title="Permalink to this headline">¶</a></h2>
<p>The LLVM instruction set consists of several different classifications
of instructions: <a class="reference internal" href="#terminators"><span class="std std-ref">terminator instructions</span></a>, <a class="reference internal" href="#binaryops"><span class="std std-ref">binary
instructions</span></a>, <a class="reference internal" href="#bitwiseops"><span class="std std-ref">bitwise binary
instructions</span></a>, <a class="reference internal" href="#memoryops"><span class="std std-ref">memory instructions</span></a>, and
<a class="reference internal" href="#otherops"><span class="std std-ref">other instructions</span></a>.</p>
<div class="section" id="terminator-instructions">
<span id="terminators"></span><h3><a class="toc-backref" href="#id1617">Terminator Instructions</a><a class="headerlink" href="#terminator-instructions" title="Permalink to this headline">¶</a></h3>
<p>As mentioned <a class="reference internal" href="#functionstructure"><span class="std std-ref">previously</span></a>, every basic block in a
program ends with a “Terminator” instruction, which indicates which
block should be executed after the current block is finished. These
terminator instructions typically yield a ‘<code class="docutils literal notranslate"><span class="pre">void</span></code>’ value: they produce
control flow, not values (the one exception being the
‘<a class="reference internal" href="#i-invoke"><span class="std std-ref">invoke</span></a>’ instruction).</p>
<p>The terminator instructions are: ‘<a class="reference internal" href="#i-ret"><span class="std std-ref">ret</span></a>’,
‘<a class="reference internal" href="#i-br"><span class="std std-ref">br</span></a>’, ‘<a class="reference internal" href="#i-switch"><span class="std std-ref">switch</span></a>’,
‘<a class="reference internal" href="#i-indirectbr"><span class="std std-ref">indirectbr</span></a>’, ‘<a class="reference internal" href="#i-invoke"><span class="std std-ref">invoke</span></a>’,
‘<a class="reference internal" href="#i-callbr"><span class="std std-ref">callbr</span></a>’
‘<a class="reference internal" href="#i-resume"><span class="std std-ref">resume</span></a>’, ‘<a class="reference internal" href="#i-catchswitch"><span class="std std-ref">catchswitch</span></a>’,
‘<a class="reference internal" href="#i-catchret"><span class="std std-ref">catchret</span></a>’,
‘<a class="reference internal" href="#i-cleanupret"><span class="std std-ref">cleanupret</span></a>’,
and ‘<a class="reference internal" href="#i-unreachable"><span class="std std-ref">unreachable</span></a>’.</p>
<div class="section" id="ret-instruction">
<span id="i-ret"></span><h4><a class="toc-backref" href="#id1618">‘<code class="docutils literal notranslate"><span class="pre">ret</span></code>’ Instruction</a><a class="headerlink" href="#ret-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="syntax">
<h5><a class="toc-backref" href="#id1619">Syntax:</a><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">ret</span> <span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span> <span class="p">;</span> <span class="n">Return</span> <span class="n">a</span> <span class="n">value</span> <span class="kn">from</span> <span class="nn">a</span> <span class="n">non</span><span class="o">-</span><span class="n">void</span> <span class="n">function</span>
<span class="n">ret</span> <span class="n">void</span> <span class="p">;</span> <span class="n">Return</span> <span class="kn">from</span> <span class="nn">void</span> <span class="n">function</span>
</pre></div>
</div>
</div>
<div class="section" id="overview">
<h5><a class="toc-backref" href="#id1620">Overview:</a><a class="headerlink" href="#overview" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">ret</span></code>’ instruction is used to return control flow (and optionally
a value) from a function back to the caller.</p>
<p>There are two forms of the ‘<code class="docutils literal notranslate"><span class="pre">ret</span></code>’ instruction: one that returns a
value and then causes control flow, and one that just causes control
flow to occur.</p>
</div>
<div class="section" id="arguments">
<h5><a class="toc-backref" href="#id1621">Arguments:</a><a class="headerlink" href="#arguments" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">ret</span></code>’ instruction optionally accepts a single argument, the
return value. The type of the return value must be a ‘<a class="reference internal" href="#t-firstclass"><span class="std std-ref">first
class</span></a>’ type.</p>
<p>A function is not <a class="reference internal" href="#wellformed"><span class="std std-ref">well formed</span></a> if it has a non-void
return type and contains a ‘<code class="docutils literal notranslate"><span class="pre">ret</span></code>’ instruction with no return value or
a return value with a type that does not match its type, or if it has a
void return type and contains a ‘<code class="docutils literal notranslate"><span class="pre">ret</span></code>’ instruction with a return
value.</p>
</div>
<div class="section" id="id28">
<h5><a class="toc-backref" href="#id1622">Semantics:</a><a class="headerlink" href="#id28" title="Permalink to this headline">¶</a></h5>
<p>When the ‘<code class="docutils literal notranslate"><span class="pre">ret</span></code>’ instruction is executed, control flow returns back to
the calling function’s context. If the caller is a
“<a class="reference internal" href="#i-call"><span class="std std-ref">call</span></a>” instruction, execution continues at the
instruction after the call. If the caller was an
“<a class="reference internal" href="#i-invoke"><span class="std std-ref">invoke</span></a>” instruction, execution continues at the
beginning of the “normal” destination block. If the instruction returns
a value, that value shall set the call or invoke instruction’s return
value.</p>
</div>
<div class="section" id="example">
<h5><a class="toc-backref" href="#id1623">Example:</a><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">ret</span> <span class="k">i32</span> <span class="m">5</span> <span class="c">; Return an integer value of 5</span>
<span class="k">ret</span> <span class="k">void</span> <span class="c">; Return from a void function</span>
<span class="k">ret</span> <span class="p">{</span> <span class="k">i32</span><span class="p">,</span> <span class="k">i8</span> <span class="p">}</span> <span class="p">{</span> <span class="k">i32</span> <span class="m">4</span><span class="p">,</span> <span class="k">i8</span> <span class="m">2</span> <span class="p">}</span> <span class="c">; Return a struct of values 4 and 2</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="br-instruction">
<span id="i-br"></span><h4><a class="toc-backref" href="#id1624">‘<code class="docutils literal notranslate"><span class="pre">br</span></code>’ Instruction</a><a class="headerlink" href="#br-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id29">
<h5><a class="toc-backref" href="#id1625">Syntax:</a><a class="headerlink" href="#id29" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">br</span> <span class="n">i1</span> <span class="o"><</span><span class="n">cond</span><span class="o">></span><span class="p">,</span> <span class="n">label</span> <span class="o"><</span><span class="n">iftrue</span><span class="o">></span><span class="p">,</span> <span class="n">label</span> <span class="o"><</span><span class="n">iffalse</span><span class="o">></span>
<span class="n">br</span> <span class="n">label</span> <span class="o"><</span><span class="n">dest</span><span class="o">></span> <span class="p">;</span> <span class="n">Unconditional</span> <span class="n">branch</span>
</pre></div>
</div>
</div>
<div class="section" id="id30">
<h5><a class="toc-backref" href="#id1626">Overview:</a><a class="headerlink" href="#id30" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">br</span></code>’ instruction is used to cause control flow to transfer to a
different basic block in the current function. There are two forms of
this instruction, corresponding to a conditional branch and an
unconditional branch.</p>
</div>
<div class="section" id="id31">
<h5><a class="toc-backref" href="#id1627">Arguments:</a><a class="headerlink" href="#id31" title="Permalink to this headline">¶</a></h5>
<p>The conditional branch form of the ‘<code class="docutils literal notranslate"><span class="pre">br</span></code>’ instruction takes a single
‘<code class="docutils literal notranslate"><span class="pre">i1</span></code>’ value and two ‘<code class="docutils literal notranslate"><span class="pre">label</span></code>’ values. The unconditional form of the
‘<code class="docutils literal notranslate"><span class="pre">br</span></code>’ instruction takes a single ‘<code class="docutils literal notranslate"><span class="pre">label</span></code>’ value as a target.</p>
</div>
<div class="section" id="id32">
<h5><a class="toc-backref" href="#id1628">Semantics:</a><a class="headerlink" href="#id32" title="Permalink to this headline">¶</a></h5>
<p>Upon execution of a conditional ‘<code class="docutils literal notranslate"><span class="pre">br</span></code>’ instruction, the ‘<code class="docutils literal notranslate"><span class="pre">i1</span></code>’
argument is evaluated. If the value is <code class="docutils literal notranslate"><span class="pre">true</span></code>, control flows to the
‘<code class="docutils literal notranslate"><span class="pre">iftrue</span></code>’ <code class="docutils literal notranslate"><span class="pre">label</span></code> argument. If “cond” is <code class="docutils literal notranslate"><span class="pre">false</span></code>, control flows
to the ‘<code class="docutils literal notranslate"><span class="pre">iffalse</span></code>’ <code class="docutils literal notranslate"><span class="pre">label</span></code> argument.
If ‘<code class="docutils literal notranslate"><span class="pre">cond</span></code>’ is <code class="docutils literal notranslate"><span class="pre">poison</span></code> or <code class="docutils literal notranslate"><span class="pre">undef</span></code>, this instruction has undefined
behavior.</p>
</div>
<div class="section" id="id33">
<h5><a class="toc-backref" href="#id1629">Example:</a><a class="headerlink" href="#id33" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nl">Test:</span>
<span class="nv">%cond</span> <span class="p">=</span> <span class="k">icmp</span> <span class="k">eq</span> <span class="k">i32</span> <span class="nv">%a</span><span class="p">,</span> <span class="nv">%b</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%cond</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%IfEqual</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%IfUnequal</span>
<span class="nl">IfEqual:</span>
<span class="k">ret</span> <span class="k">i32</span> <span class="m">1</span>
<span class="nl">IfUnequal:</span>
<span class="k">ret</span> <span class="k">i32</span> <span class="m">0</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="switch-instruction">
<span id="i-switch"></span><h4><a class="toc-backref" href="#id1630">‘<code class="docutils literal notranslate"><span class="pre">switch</span></code>’ Instruction</a><a class="headerlink" href="#switch-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id34">
<h5><a class="toc-backref" href="#id1631">Syntax:</a><a class="headerlink" href="#id34" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">switch</span> <span class="o"><</span><span class="n">intty</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">,</span> <span class="n">label</span> <span class="o"><</span><span class="n">defaultdest</span><span class="o">></span> <span class="p">[</span> <span class="o"><</span><span class="n">intty</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="n">label</span> <span class="o"><</span><span class="n">dest</span><span class="o">></span> <span class="o">...</span> <span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="id35">
<h5><a class="toc-backref" href="#id1632">Overview:</a><a class="headerlink" href="#id35" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">switch</span></code>’ instruction is used to transfer control flow to one of
several different places. It is a generalization of the ‘<code class="docutils literal notranslate"><span class="pre">br</span></code>’
instruction, allowing a branch to occur to one of many possible
destinations.</p>
</div>
<div class="section" id="id36">
<h5><a class="toc-backref" href="#id1633">Arguments:</a><a class="headerlink" href="#id36" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">switch</span></code>’ instruction uses three parameters: an integer
comparison value ‘<code class="docutils literal notranslate"><span class="pre">value</span></code>’, a default ‘<code class="docutils literal notranslate"><span class="pre">label</span></code>’ destination, and an
array of pairs of comparison value constants and ‘<code class="docutils literal notranslate"><span class="pre">label</span></code>’s. The table
is not allowed to contain duplicate constant entries.</p>
</div>
<div class="section" id="id37">
<h5><a class="toc-backref" href="#id1634">Semantics:</a><a class="headerlink" href="#id37" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">switch</span></code> instruction specifies a table of values and destinations.
When the ‘<code class="docutils literal notranslate"><span class="pre">switch</span></code>’ instruction is executed, this table is searched
for the given value. If the value is found, control flow is transferred
to the corresponding destination; otherwise, control flow is transferred
to the default destination.
If ‘<code class="docutils literal notranslate"><span class="pre">value</span></code>’ is <code class="docutils literal notranslate"><span class="pre">poison</span></code> or <code class="docutils literal notranslate"><span class="pre">undef</span></code>, this instruction has undefined
behavior.</p>
</div>
<div class="section" id="implementation">
<h5><a class="toc-backref" href="#id1635">Implementation:</a><a class="headerlink" href="#implementation" title="Permalink to this headline">¶</a></h5>
<p>Depending on properties of the target machine and the particular
<code class="docutils literal notranslate"><span class="pre">switch</span></code> instruction, this instruction may be code generated in
different ways. For example, it could be generated as a series of
chained conditional branches or with a lookup table.</p>
</div>
<div class="section" id="id38">
<h5><a class="toc-backref" href="#id1636">Example:</a><a class="headerlink" href="#id38" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="c">; Emulate a conditional br instruction</span>
<span class="nv">%Val</span> <span class="p">=</span> <span class="k">zext</span> <span class="k">i1</span> <span class="nv">%value</span> <span class="k">to</span> <span class="k">i32</span>
<span class="k">switch</span> <span class="k">i32</span> <span class="nv">%Val</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%truedest</span> <span class="p">[</span> <span class="k">i32</span> <span class="m">0</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%falsedest</span> <span class="p">]</span>
<span class="c">; Emulate an unconditional br instruction</span>
<span class="k">switch</span> <span class="k">i32</span> <span class="m">0</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%dest</span> <span class="p">[</span> <span class="p">]</span>
<span class="c">; Implement a jump table:</span>
<span class="k">switch</span> <span class="k">i32</span> <span class="nv">%val</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%otherwise</span> <span class="p">[</span> <span class="k">i32</span> <span class="m">0</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%onzero</span>
<span class="k">i32</span> <span class="m">1</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%onone</span>
<span class="k">i32</span> <span class="m">2</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%ontwo</span> <span class="p">]</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="indirectbr-instruction">
<span id="i-indirectbr"></span><h4><a class="toc-backref" href="#id1637">‘<code class="docutils literal notranslate"><span class="pre">indirectbr</span></code>’ Instruction</a><a class="headerlink" href="#indirectbr-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id39">
<h5><a class="toc-backref" href="#id1638">Syntax:</a><a class="headerlink" href="#id39" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">indirectbr</span> <span class="o"><</span><span class="n">somety</span><span class="o">>*</span> <span class="o"><</span><span class="n">address</span><span class="o">></span><span class="p">,</span> <span class="p">[</span> <span class="n">label</span> <span class="o"><</span><span class="n">dest1</span><span class="o">></span><span class="p">,</span> <span class="n">label</span> <span class="o"><</span><span class="n">dest2</span><span class="o">></span><span class="p">,</span> <span class="o">...</span> <span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="id40">
<h5><a class="toc-backref" href="#id1639">Overview:</a><a class="headerlink" href="#id40" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">indirectbr</span></code>’ instruction implements an indirect branch to a
label within the current function, whose address is specified by
“<code class="docutils literal notranslate"><span class="pre">address</span></code>”. Address must be derived from a
<a class="reference internal" href="#blockaddress"><span class="std std-ref">blockaddress</span></a> constant.</p>
</div>
<div class="section" id="id41">
<h5><a class="toc-backref" href="#id1640">Arguments:</a><a class="headerlink" href="#id41" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">address</span></code>’ argument is the address of the label to jump to. The
rest of the arguments indicate the full set of possible destinations
that the address may point to. Blocks are allowed to occur multiple
times in the destination list, though this isn’t particularly useful.</p>
<p>This destination list is required so that dataflow analysis has an
accurate understanding of the CFG.</p>
</div>
<div class="section" id="id42">
<h5><a class="toc-backref" href="#id1641">Semantics:</a><a class="headerlink" href="#id42" title="Permalink to this headline">¶</a></h5>
<p>Control transfers to the block specified in the address argument. All
possible destination blocks must be listed in the label list, otherwise
this instruction has undefined behavior. This implies that jumps to
labels defined in other functions have undefined behavior as well.
If ‘<code class="docutils literal notranslate"><span class="pre">address</span></code>’ is <code class="docutils literal notranslate"><span class="pre">poison</span></code> or <code class="docutils literal notranslate"><span class="pre">undef</span></code>, this instruction has undefined
behavior.</p>
</div>
<div class="section" id="id43">
<h5><a class="toc-backref" href="#id1642">Implementation:</a><a class="headerlink" href="#id43" title="Permalink to this headline">¶</a></h5>
<p>This is typically implemented with a jump through a register.</p>
</div>
<div class="section" id="id44">
<h5><a class="toc-backref" href="#id1643">Example:</a><a class="headerlink" href="#id44" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">indirectbr</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%Addr</span><span class="p">,</span> <span class="p">[</span> <span class="k">label</span> <span class="nv">%bb1</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%bb2</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%bb3</span> <span class="p">]</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="invoke-instruction">
<span id="i-invoke"></span><h4><a class="toc-backref" href="#id1644">‘<code class="docutils literal notranslate"><span class="pre">invoke</span></code>’ Instruction</a><a class="headerlink" href="#invoke-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id45">
<h5><a class="toc-backref" href="#id1645">Syntax:</a><a class="headerlink" href="#id45" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">invoke</span> <span class="p">[</span><span class="n">cconv</span><span class="p">]</span> <span class="p">[</span><span class="n">ret</span> <span class="n">attrs</span><span class="p">]</span> <span class="p">[</span><span class="n">addrspace</span><span class="p">(</span><span class="o"><</span><span class="n">num</span><span class="o">></span><span class="p">)]</span> <span class="o"><</span><span class="n">ty</span><span class="o">>|<</span><span class="n">fnty</span><span class="o">></span> <span class="o"><</span><span class="n">fnptrval</span><span class="o">></span><span class="p">(</span><span class="o"><</span><span class="n">function</span> <span class="n">args</span><span class="o">></span><span class="p">)</span> <span class="p">[</span><span class="n">fn</span> <span class="n">attrs</span><span class="p">]</span>
<span class="p">[</span><span class="n">operand</span> <span class="n">bundles</span><span class="p">]</span> <span class="n">to</span> <span class="n">label</span> <span class="o"><</span><span class="n">normal</span> <span class="n">label</span><span class="o">></span> <span class="n">unwind</span> <span class="n">label</span> <span class="o"><</span><span class="n">exception</span> <span class="n">label</span><span class="o">></span>
</pre></div>
</div>
</div>
<div class="section" id="id46">
<h5><a class="toc-backref" href="#id1646">Overview:</a><a class="headerlink" href="#id46" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">invoke</span></code>’ instruction causes control to transfer to a specified
function, with the possibility of control flow transfer to either the
‘<code class="docutils literal notranslate"><span class="pre">normal</span></code>’ label or the ‘<code class="docutils literal notranslate"><span class="pre">exception</span></code>’ label. If the callee function
returns with the “<code class="docutils literal notranslate"><span class="pre">ret</span></code>” instruction, control flow will return to the
“normal” label. If the callee (or any indirect callees) returns via the
“<a class="reference internal" href="#i-resume"><span class="std std-ref">resume</span></a>” instruction or other exception handling
mechanism, control is interrupted and continued at the dynamically
nearest “exception” label.</p>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">exception</span></code>’ label is a <a class="reference external" href="ExceptionHandling.html#overview">landing
pad</a> for the exception. As such,
‘<code class="docutils literal notranslate"><span class="pre">exception</span></code>’ label is required to have the
“<a class="reference internal" href="#i-landingpad"><span class="std std-ref">landingpad</span></a>” instruction, which contains the
information about the behavior of the program after unwinding happens,
as its first non-PHI instruction. The restrictions on the
“<code class="docutils literal notranslate"><span class="pre">landingpad</span></code>” instruction’s tightly couples it to the “<code class="docutils literal notranslate"><span class="pre">invoke</span></code>”
instruction, so that the important information contained within the
“<code class="docutils literal notranslate"><span class="pre">landingpad</span></code>” instruction can’t be lost through normal code motion.</p>
</div>
<div class="section" id="id47">
<h5><a class="toc-backref" href="#id1647">Arguments:</a><a class="headerlink" href="#id47" title="Permalink to this headline">¶</a></h5>
<p>This instruction requires several arguments:</p>
<ol class="arabic simple">
<li><p>The optional “cconv” marker indicates which <a class="reference internal" href="#callingconv"><span class="std std-ref">calling
convention</span></a> the call should use. If none is
specified, the call defaults to using C calling conventions.</p></li>
<li><p>The optional <a class="reference internal" href="#paramattrs"><span class="std std-ref">Parameter Attributes</span></a> list for return
values. Only ‘<code class="docutils literal notranslate"><span class="pre">zeroext</span></code>’, ‘<code class="docutils literal notranslate"><span class="pre">signext</span></code>’, and ‘<code class="docutils literal notranslate"><span class="pre">inreg</span></code>’ attributes
are valid here.</p></li>
<li><p>The optional addrspace attribute can be used to indicate the address space
of the called function. If it is not specified, the program address space
from the <a class="reference internal" href="#langref-datalayout"><span class="std std-ref">datalayout string</span></a> will be used.</p></li>
<li><p>‘<code class="docutils literal notranslate"><span class="pre">ty</span></code>’: the type of the call instruction itself which is also the
type of the return value. Functions that return no value are marked
<code class="docutils literal notranslate"><span class="pre">void</span></code>.</p></li>
<li><p>‘<code class="docutils literal notranslate"><span class="pre">fnty</span></code>’: shall be the signature of the function being invoked. The
argument types must match the types implied by this signature. This
type can be omitted if the function is not varargs.</p></li>
<li><p>‘<code class="docutils literal notranslate"><span class="pre">fnptrval</span></code>’: An LLVM value containing a pointer to a function to
be invoked. In most cases, this is a direct function invocation, but
indirect <code class="docutils literal notranslate"><span class="pre">invoke</span></code>’s are just as possible, calling an arbitrary pointer
to function value.</p></li>
<li><p>‘<code class="docutils literal notranslate"><span class="pre">function</span> <span class="pre">args</span></code>’: argument list whose types match the function
signature argument types and parameter attributes. All arguments must
be of <a class="reference internal" href="#t-firstclass"><span class="std std-ref">first class</span></a> type. If the function signature
indicates the function accepts a variable number of arguments, the
extra arguments can be specified.</p></li>
<li><p>‘<code class="docutils literal notranslate"><span class="pre">normal</span> <span class="pre">label</span></code>’: the label reached when the called function
executes a ‘<code class="docutils literal notranslate"><span class="pre">ret</span></code>’ instruction.</p></li>
<li><p>‘<code class="docutils literal notranslate"><span class="pre">exception</span> <span class="pre">label</span></code>’: the label reached when a callee returns via
the <a class="reference internal" href="#i-resume"><span class="std std-ref">resume</span></a> instruction or other exception handling
mechanism.</p></li>
<li><p>The optional <a class="reference internal" href="#fnattrs"><span class="std std-ref">function attributes</span></a> list.</p></li>
<li><p>The optional <a class="reference internal" href="#opbundles"><span class="std std-ref">operand bundles</span></a> list.</p></li>
</ol>
</div>
<div class="section" id="id48">
<h5><a class="toc-backref" href="#id1648">Semantics:</a><a class="headerlink" href="#id48" title="Permalink to this headline">¶</a></h5>
<p>This instruction is designed to operate as a standard ‘<code class="docutils literal notranslate"><span class="pre">call</span></code>’
instruction in most regards. The primary difference is that it
establishes an association with a label, which is used by the runtime
library to unwind the stack.</p>
<p>This instruction is used in languages with destructors to ensure that
proper cleanup is performed in the case of either a <code class="docutils literal notranslate"><span class="pre">longjmp</span></code> or a
thrown exception. Additionally, this is important for implementation of
‘<code class="docutils literal notranslate"><span class="pre">catch</span></code>’ clauses in high-level languages that support them.</p>
<p>For the purposes of the SSA form, the definition of the value returned
by the ‘<code class="docutils literal notranslate"><span class="pre">invoke</span></code>’ instruction is deemed to occur on the edge from the
current block to the “normal” label. If the callee unwinds then no
return value is available.</p>
</div>
<div class="section" id="id49">
<h5><a class="toc-backref" href="#id1649">Example:</a><a class="headerlink" href="#id49" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%retval</span> <span class="p">=</span> <span class="k">invoke</span> <span class="k">i32</span> <span class="vg">@Test</span><span class="p">(</span><span class="k">i32</span> <span class="m">15</span><span class="p">)</span> <span class="k">to</span> <span class="k">label</span> <span class="nv">%Continue</span>
<span class="k">unwind</span> <span class="k">label</span> <span class="nv">%TestCleanup</span> <span class="c">; i32:retval set</span>
<span class="nv">%retval</span> <span class="p">=</span> <span class="k">invoke</span> <span class="k">coldcc</span> <span class="k">i32</span> <span class="nv">%Testfnptr</span><span class="p">(</span><span class="k">i32</span> <span class="m">15</span><span class="p">)</span> <span class="k">to</span> <span class="k">label</span> <span class="nv">%Continue</span>
<span class="k">unwind</span> <span class="k">label</span> <span class="nv">%TestCleanup</span> <span class="c">; i32:retval set</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="callbr-instruction">
<span id="i-callbr"></span><h4><a class="toc-backref" href="#id1650">‘<code class="docutils literal notranslate"><span class="pre">callbr</span></code>’ Instruction</a><a class="headerlink" href="#callbr-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id50">
<h5><a class="toc-backref" href="#id1651">Syntax:</a><a class="headerlink" href="#id50" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">callbr</span> <span class="p">[</span><span class="n">cconv</span><span class="p">]</span> <span class="p">[</span><span class="n">ret</span> <span class="n">attrs</span><span class="p">]</span> <span class="p">[</span><span class="n">addrspace</span><span class="p">(</span><span class="o"><</span><span class="n">num</span><span class="o">></span><span class="p">)]</span> <span class="o"><</span><span class="n">ty</span><span class="o">>|<</span><span class="n">fnty</span><span class="o">></span> <span class="o"><</span><span class="n">fnptrval</span><span class="o">></span><span class="p">(</span><span class="o"><</span><span class="n">function</span> <span class="n">args</span><span class="o">></span><span class="p">)</span> <span class="p">[</span><span class="n">fn</span> <span class="n">attrs</span><span class="p">]</span>
<span class="p">[</span><span class="n">operand</span> <span class="n">bundles</span><span class="p">]</span> <span class="n">to</span> <span class="n">label</span> <span class="o"><</span><span class="n">fallthrough</span> <span class="n">label</span><span class="o">></span> <span class="p">[</span><span class="n">indirect</span> <span class="n">labels</span><span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="id51">
<h5><a class="toc-backref" href="#id1652">Overview:</a><a class="headerlink" href="#id51" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">callbr</span></code>’ instruction causes control to transfer to a specified
function, with the possibility of control flow transfer to either the
‘<code class="docutils literal notranslate"><span class="pre">fallthrough</span></code>’ label or one of the ‘<code class="docutils literal notranslate"><span class="pre">indirect</span></code>’ labels.</p>
<p>This instruction should only be used to implement the “goto” feature of gcc
style inline assembly. Any other usage is an error in the IR verifier.</p>
</div>
<div class="section" id="id52">
<h5><a class="toc-backref" href="#id1653">Arguments:</a><a class="headerlink" href="#id52" title="Permalink to this headline">¶</a></h5>
<p>This instruction requires several arguments:</p>
<ol class="arabic simple">
<li><p>The optional “cconv” marker indicates which <a class="reference internal" href="#callingconv"><span class="std std-ref">calling
convention</span></a> the call should use. If none is
specified, the call defaults to using C calling conventions.</p></li>
<li><p>The optional <a class="reference internal" href="#paramattrs"><span class="std std-ref">Parameter Attributes</span></a> list for return
values. Only ‘<code class="docutils literal notranslate"><span class="pre">zeroext</span></code>’, ‘<code class="docutils literal notranslate"><span class="pre">signext</span></code>’, and ‘<code class="docutils literal notranslate"><span class="pre">inreg</span></code>’ attributes
are valid here.</p></li>
<li><p>The optional addrspace attribute can be used to indicate the address space
of the called function. If it is not specified, the program address space
from the <a class="reference internal" href="#langref-datalayout"><span class="std std-ref">datalayout string</span></a> will be used.</p></li>
<li><p>‘<code class="docutils literal notranslate"><span class="pre">ty</span></code>’: the type of the call instruction itself which is also the
type of the return value. Functions that return no value are marked
<code class="docutils literal notranslate"><span class="pre">void</span></code>.</p></li>
<li><p>‘<code class="docutils literal notranslate"><span class="pre">fnty</span></code>’: shall be the signature of the function being called. The
argument types must match the types implied by this signature. This
type can be omitted if the function is not varargs.</p></li>
<li><p>‘<code class="docutils literal notranslate"><span class="pre">fnptrval</span></code>’: An LLVM value containing a pointer to a function to
be called. In most cases, this is a direct function call, but
other <code class="docutils literal notranslate"><span class="pre">callbr</span></code>’s are just as possible, calling an arbitrary pointer
to function value.</p></li>
<li><p>‘<code class="docutils literal notranslate"><span class="pre">function</span> <span class="pre">args</span></code>’: argument list whose types match the function
signature argument types and parameter attributes. All arguments must
be of <a class="reference internal" href="#t-firstclass"><span class="std std-ref">first class</span></a> type. If the function signature
indicates the function accepts a variable number of arguments, the
extra arguments can be specified.</p></li>
<li><p>‘<code class="docutils literal notranslate"><span class="pre">fallthrough</span> <span class="pre">label</span></code>’: the label reached when the inline assembly’s
execution exits the bottom.</p></li>
<li><p>‘<code class="docutils literal notranslate"><span class="pre">indirect</span> <span class="pre">labels</span></code>’: the labels reached when a callee transfers control
to a location other than the ‘<code class="docutils literal notranslate"><span class="pre">fallthrough</span> <span class="pre">label</span></code>’. The blockaddress
constant for these should also be in the list of ‘<code class="docutils literal notranslate"><span class="pre">function</span> <span class="pre">args</span></code>’.</p></li>
<li><p>The optional <a class="reference internal" href="#fnattrs"><span class="std std-ref">function attributes</span></a> list.</p></li>
<li><p>The optional <a class="reference internal" href="#opbundles"><span class="std std-ref">operand bundles</span></a> list.</p></li>
</ol>
</div>
<div class="section" id="id53">
<h5><a class="toc-backref" href="#id1654">Semantics:</a><a class="headerlink" href="#id53" title="Permalink to this headline">¶</a></h5>
<p>This instruction is designed to operate as a standard ‘<code class="docutils literal notranslate"><span class="pre">call</span></code>’
instruction in most regards. The primary difference is that it
establishes an association with additional labels to define where control
flow goes after the call.</p>
<p>The output values of a ‘<code class="docutils literal notranslate"><span class="pre">callbr</span></code>’ instruction are available only to
the ‘<code class="docutils literal notranslate"><span class="pre">fallthrough</span></code>’ block, not to any ‘<code class="docutils literal notranslate"><span class="pre">indirect</span></code>’ blocks(s).</p>
<p>The only use of this today is to implement the “goto” feature of gcc inline
assembly where additional labels can be provided as locations for the inline
assembly to jump to.</p>
</div>
<div class="section" id="id54">
<h5><a class="toc-backref" href="#id1655">Example:</a><a class="headerlink" href="#id54" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span>; "asm goto" without output constraints.
callbr void asm "", "r,X"(i32 %x, i8 *blockaddress(@foo, %indirect))
to label %fallthrough [label %indirect]
; "asm goto" with output constraints.
<result> = callbr i32 asm "", "=r,r,X"(i32 %x, i8 *blockaddress(@foo, %indirect))
to label %fallthrough [label %indirect]
</pre></div>
</div>
</div>
</div>
<div class="section" id="resume-instruction">
<span id="i-resume"></span><h4><a class="toc-backref" href="#id1656">‘<code class="docutils literal notranslate"><span class="pre">resume</span></code>’ Instruction</a><a class="headerlink" href="#resume-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id55">
<h5><a class="toc-backref" href="#id1657">Syntax:</a><a class="headerlink" href="#id55" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">resume</span> <span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span>
</pre></div>
</div>
</div>
<div class="section" id="id56">
<h5><a class="toc-backref" href="#id1658">Overview:</a><a class="headerlink" href="#id56" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">resume</span></code>’ instruction is a terminator instruction that has no
successors.</p>
</div>
<div class="section" id="id57">
<h5><a class="toc-backref" href="#id1659">Arguments:</a><a class="headerlink" href="#id57" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">resume</span></code>’ instruction requires one argument, which must have the
same type as the result of any ‘<code class="docutils literal notranslate"><span class="pre">landingpad</span></code>’ instruction in the same
function.</p>
</div>
<div class="section" id="id58">
<h5><a class="toc-backref" href="#id1660">Semantics:</a><a class="headerlink" href="#id58" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">resume</span></code>’ instruction resumes propagation of an existing
(in-flight) exception whose unwinding was interrupted with a
<a class="reference internal" href="#i-landingpad"><span class="std std-ref">landingpad</span></a> instruction.</p>
</div>
<div class="section" id="id59">
<h5><a class="toc-backref" href="#id1661">Example:</a><a class="headerlink" href="#id59" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></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">%exn</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="catchswitch-instruction">
<span id="i-catchswitch"></span><h4><a class="toc-backref" href="#id1662">‘<code class="docutils literal notranslate"><span class="pre">catchswitch</span></code>’ Instruction</a><a class="headerlink" href="#catchswitch-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id60">
<h5><a class="toc-backref" href="#id1663">Syntax:</a><a class="headerlink" href="#id60" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">resultval</span><span class="o">></span> <span class="o">=</span> <span class="n">catchswitch</span> <span class="n">within</span> <span class="o"><</span><span class="n">parent</span><span class="o">></span> <span class="p">[</span> <span class="n">label</span> <span class="o"><</span><span class="n">handler1</span><span class="o">></span><span class="p">,</span> <span class="n">label</span> <span class="o"><</span><span class="n">handler2</span><span class="o">></span><span class="p">,</span> <span class="o">...</span> <span class="p">]</span> <span class="n">unwind</span> <span class="n">to</span> <span class="n">caller</span>
<span class="o"><</span><span class="n">resultval</span><span class="o">></span> <span class="o">=</span> <span class="n">catchswitch</span> <span class="n">within</span> <span class="o"><</span><span class="n">parent</span><span class="o">></span> <span class="p">[</span> <span class="n">label</span> <span class="o"><</span><span class="n">handler1</span><span class="o">></span><span class="p">,</span> <span class="n">label</span> <span class="o"><</span><span class="n">handler2</span><span class="o">></span><span class="p">,</span> <span class="o">...</span> <span class="p">]</span> <span class="n">unwind</span> <span class="n">label</span> <span class="o"><</span><span class="n">default</span><span class="o">></span>
</pre></div>
</div>
</div>
<div class="section" id="id61">
<h5><a class="toc-backref" href="#id1664">Overview:</a><a class="headerlink" href="#id61" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">catchswitch</span></code>’ instruction is used by <a class="reference external" href="ExceptionHandling.html#overview">LLVM’s exception handling system</a> to describe the set of possible catch handlers
that may be executed by the <a class="reference internal" href="#personalityfn"><span class="std std-ref">EH personality routine</span></a>.</p>
</div>
<div class="section" id="id62">
<h5><a class="toc-backref" href="#id1665">Arguments:</a><a class="headerlink" href="#id62" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">parent</span></code> argument is the token of the funclet that contains the
<code class="docutils literal notranslate"><span class="pre">catchswitch</span></code> instruction. If the <code class="docutils literal notranslate"><span class="pre">catchswitch</span></code> is not inside a funclet,
this operand may be the token <code class="docutils literal notranslate"><span class="pre">none</span></code>.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">default</span></code> argument is the label of another basic block beginning with
either a <code class="docutils literal notranslate"><span class="pre">cleanuppad</span></code> or <code class="docutils literal notranslate"><span class="pre">catchswitch</span></code> instruction. This unwind destination
must be a legal target with respect to the <code class="docutils literal notranslate"><span class="pre">parent</span></code> links, as described in
the <a class="reference external" href="ExceptionHandling.html#wineh-constraints">exception handling documentation</a>.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">handlers</span></code> are a nonempty list of successor blocks that each begin with a
<a class="reference internal" href="#i-catchpad"><span class="std std-ref">catchpad</span></a> instruction.</p>
</div>
<div class="section" id="id63">
<h5><a class="toc-backref" href="#id1666">Semantics:</a><a class="headerlink" href="#id63" title="Permalink to this headline">¶</a></h5>
<p>Executing this instruction transfers control to one of the successors in
<code class="docutils literal notranslate"><span class="pre">handlers</span></code>, if appropriate, or continues to unwind via the unwind label if
present.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">catchswitch</span></code> is both a terminator and a “pad” instruction, meaning that
it must be both the first non-phi instruction and last instruction in the basic
block. Therefore, it must be the only non-phi instruction in the block.</p>
</div>
<div class="section" id="id64">
<h5><a class="toc-backref" href="#id1667">Example:</a><a class="headerlink" href="#id64" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>dispatch1:
%cs1 = catchswitch within none [label %handler0, label %handler1] unwind to caller
dispatch2:
%cs2 = catchswitch within %parenthandler [label %handler0] unwind label %cleanup
</pre></div>
</div>
</div>
</div>
<div class="section" id="catchret-instruction">
<span id="i-catchret"></span><h4><a class="toc-backref" href="#id1668">‘<code class="docutils literal notranslate"><span class="pre">catchret</span></code>’ Instruction</a><a class="headerlink" href="#catchret-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id65">
<h5><a class="toc-backref" href="#id1669">Syntax:</a><a class="headerlink" href="#id65" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">catchret</span> <span class="kn">from</span> <span class="o"><</span><span class="n">token</span><span class="o">></span> <span class="n">to</span> <span class="n">label</span> <span class="o"><</span><span class="n">normal</span><span class="o">></span>
</pre></div>
</div>
</div>
<div class="section" id="id66">
<h5><a class="toc-backref" href="#id1670">Overview:</a><a class="headerlink" href="#id66" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">catchret</span></code>’ instruction is a terminator instruction that has a
single successor.</p>
</div>
<div class="section" id="id67">
<h5><a class="toc-backref" href="#id1671">Arguments:</a><a class="headerlink" href="#id67" title="Permalink to this headline">¶</a></h5>
<p>The first argument to a ‘<code class="docutils literal notranslate"><span class="pre">catchret</span></code>’ indicates which <code class="docutils literal notranslate"><span class="pre">catchpad</span></code> it
exits. It must be a <a class="reference internal" href="#i-catchpad"><span class="std std-ref">catchpad</span></a>.
The second argument to a ‘<code class="docutils literal notranslate"><span class="pre">catchret</span></code>’ specifies where control will
transfer to next.</p>
</div>
<div class="section" id="id68">
<h5><a class="toc-backref" href="#id1672">Semantics:</a><a class="headerlink" href="#id68" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">catchret</span></code>’ instruction ends an existing (in-flight) exception whose
unwinding was interrupted with a <a class="reference internal" href="#i-catchpad"><span class="std std-ref">catchpad</span></a> instruction. The
<a class="reference internal" href="#personalityfn"><span class="std std-ref">personality function</span></a> gets a chance to execute arbitrary
code to, for example, destroy the active exception. Control then transfers to
<code class="docutils literal notranslate"><span class="pre">normal</span></code>.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">token</span></code> argument must be a token produced by a <code class="docutils literal notranslate"><span class="pre">catchpad</span></code> instruction.
If the specified <code class="docutils literal notranslate"><span class="pre">catchpad</span></code> is not the most-recently-entered not-yet-exited
funclet pad (as described in the <a class="reference external" href="ExceptionHandling.html#wineh-constraints">EH documentation</a>),
the <code class="docutils literal notranslate"><span class="pre">catchret</span></code>’s behavior is undefined.</p>
</div>
<div class="section" id="id69">
<h5><a class="toc-backref" href="#id1673">Example:</a><a class="headerlink" href="#id69" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>catchret from %catch label %continue
</pre></div>
</div>
</div>
</div>
<div class="section" id="cleanupret-instruction">
<span id="i-cleanupret"></span><h4><a class="toc-backref" href="#id1674">‘<code class="docutils literal notranslate"><span class="pre">cleanupret</span></code>’ Instruction</a><a class="headerlink" href="#cleanupret-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id70">
<h5><a class="toc-backref" href="#id1675">Syntax:</a><a class="headerlink" href="#id70" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cleanupret</span> <span class="kn">from</span> <span class="o"><</span><span class="n">value</span><span class="o">></span> <span class="n">unwind</span> <span class="n">label</span> <span class="o"><</span><span class="k">continue</span><span class="o">></span>
<span class="n">cleanupret</span> <span class="kn">from</span> <span class="o"><</span><span class="n">value</span><span class="o">></span> <span class="n">unwind</span> <span class="n">to</span> <span class="n">caller</span>
</pre></div>
</div>
</div>
<div class="section" id="id71">
<h5><a class="toc-backref" href="#id1676">Overview:</a><a class="headerlink" href="#id71" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">cleanupret</span></code>’ instruction is a terminator instruction that has
an optional successor.</p>
</div>
<div class="section" id="id72">
<h5><a class="toc-backref" href="#id1677">Arguments:</a><a class="headerlink" href="#id72" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">cleanupret</span></code>’ instruction requires one argument, which indicates
which <code class="docutils literal notranslate"><span class="pre">cleanuppad</span></code> it exits, and must be a <a class="reference internal" href="#i-cleanuppad"><span class="std std-ref">cleanuppad</span></a>.
If the specified <code class="docutils literal notranslate"><span class="pre">cleanuppad</span></code> is not the most-recently-entered not-yet-exited
funclet pad (as described in the <a class="reference external" href="ExceptionHandling.html#wineh-constraints">EH documentation</a>),
the <code class="docutils literal notranslate"><span class="pre">cleanupret</span></code>’s behavior is undefined.</p>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">cleanupret</span></code>’ instruction also has an optional successor, <code class="docutils literal notranslate"><span class="pre">continue</span></code>,
which must be the label of another basic block beginning with either a
<code class="docutils literal notranslate"><span class="pre">cleanuppad</span></code> or <code class="docutils literal notranslate"><span class="pre">catchswitch</span></code> instruction. This unwind destination must
be a legal target with respect to the <code class="docutils literal notranslate"><span class="pre">parent</span></code> links, as described in the
<a class="reference external" href="ExceptionHandling.html#wineh-constraints">exception handling documentation</a>.</p>
</div>
<div class="section" id="id75">
<h5><a class="toc-backref" href="#id1678">Semantics:</a><a class="headerlink" href="#id75" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">cleanupret</span></code>’ instruction indicates to the
<a class="reference internal" href="#personalityfn"><span class="std std-ref">personality function</span></a> that one
<a class="reference internal" href="#i-cleanuppad"><span class="std std-ref">cleanuppad</span></a> it transferred control to has ended.
It transfers control to <code class="docutils literal notranslate"><span class="pre">continue</span></code> or unwinds out of the function.</p>
</div>
<div class="section" id="id76">
<h5><a class="toc-backref" href="#id1679">Example:</a><a class="headerlink" href="#id76" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>cleanupret from %cleanup unwind to caller
cleanupret from %cleanup unwind label %continue
</pre></div>
</div>
</div>
</div>
<div class="section" id="unreachable-instruction">
<span id="i-unreachable"></span><h4><a class="toc-backref" href="#id1680">‘<code class="docutils literal notranslate"><span class="pre">unreachable</span></code>’ Instruction</a><a class="headerlink" href="#unreachable-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id77">
<h5><a class="toc-backref" href="#id1681">Syntax:</a><a class="headerlink" href="#id77" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">unreachable</span>
</pre></div>
</div>
</div>
<div class="section" id="id78">
<h5><a class="toc-backref" href="#id1682">Overview:</a><a class="headerlink" href="#id78" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">unreachable</span></code>’ instruction has no defined semantics. This
instruction is used to inform the optimizer that a particular portion of
the code is not reachable. This can be used to indicate that the code
after a no-return function cannot be reached, and other facts.</p>
</div>
<div class="section" id="id79">
<h5><a class="toc-backref" href="#id1683">Semantics:</a><a class="headerlink" href="#id79" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">unreachable</span></code>’ instruction has no defined semantics.</p>
</div>
</div>
</div>
<div class="section" id="unary-operations">
<span id="unaryops"></span><h3><a class="toc-backref" href="#id1684">Unary Operations</a><a class="headerlink" href="#unary-operations" title="Permalink to this headline">¶</a></h3>
<p>Unary operators require a single operand, execute an operation on
it, and produce a single value. The operand might represent multiple
data, as is the case with the <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> data type. The
result value has the same type as its operand.</p>
<div class="section" id="fneg-instruction">
<span id="i-fneg"></span><h4><a class="toc-backref" href="#id1685">‘<code class="docutils literal notranslate"><span class="pre">fneg</span></code>’ Instruction</a><a class="headerlink" href="#fneg-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id80">
<h5><a class="toc-backref" href="#id1686">Syntax:</a><a class="headerlink" href="#id80" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">fneg</span> <span class="p">[</span><span class="n">fast</span><span class="o">-</span><span class="n">math</span> <span class="n">flags</span><span class="p">]</span><span class="o">*</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id81">
<h5><a class="toc-backref" href="#id1687">Overview:</a><a class="headerlink" href="#id81" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">fneg</span></code>’ instruction returns the negation of its operand.</p>
</div>
<div class="section" id="id82">
<h5><a class="toc-backref" href="#id1688">Arguments:</a><a class="headerlink" href="#id82" title="Permalink to this headline">¶</a></h5>
<p>The argument to the ‘<code class="docutils literal notranslate"><span class="pre">fneg</span></code>’ instruction must be a
<a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of
floating-point values.</p>
</div>
<div class="section" id="id83">
<h5><a class="toc-backref" href="#id1689">Semantics:</a><a class="headerlink" href="#id83" title="Permalink to this headline">¶</a></h5>
<p>The value produced is a copy of the operand with its sign bit flipped.
This instruction can also take any number of <a class="reference internal" href="#fastmath"><span class="std std-ref">fast-math
flags</span></a>, which are optimization hints to enable otherwise
unsafe floating-point optimizations:</p>
</div>
<div class="section" id="id84">
<h5><a class="toc-backref" href="#id1690">Example:</a><a class="headerlink" href="#id84" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = fneg float %val ; yields float:result = -%var
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="binary-operations">
<span id="binaryops"></span><h3><a class="toc-backref" href="#id1691">Binary Operations</a><a class="headerlink" href="#binary-operations" title="Permalink to this headline">¶</a></h3>
<p>Binary operators are used to do most of the computation in a program.
They require two operands of the same type, execute an operation on
them, and produce a single value. The operands might represent multiple
data, as is the case with the <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> data type. The
result value has the same type as its operands.</p>
<p>There are several different binary operators:</p>
<div class="section" id="add-instruction">
<span id="i-add"></span><h4><a class="toc-backref" href="#id1692">‘<code class="docutils literal notranslate"><span class="pre">add</span></code>’ Instruction</a><a class="headerlink" href="#add-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id85">
<h5><a class="toc-backref" href="#id1693">Syntax:</a><a class="headerlink" href="#id85" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">add</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">add</span> <span class="n">nuw</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">add</span> <span class="n">nsw</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">add</span> <span class="n">nuw</span> <span class="n">nsw</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id86">
<h5><a class="toc-backref" href="#id1694">Overview:</a><a class="headerlink" href="#id86" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">add</span></code>’ instruction returns the sum of its two operands.</p>
</div>
<div class="section" id="id87">
<h5><a class="toc-backref" href="#id1695">Arguments:</a><a class="headerlink" href="#id87" title="Permalink to this headline">¶</a></h5>
<p>The two arguments to the ‘<code class="docutils literal notranslate"><span class="pre">add</span></code>’ instruction must be
<a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of integer values. Both
arguments must have identical types.</p>
</div>
<div class="section" id="id88">
<h5><a class="toc-backref" href="#id1696">Semantics:</a><a class="headerlink" href="#id88" title="Permalink to this headline">¶</a></h5>
<p>The value produced is the integer sum of the two operands.</p>
<p>If the sum has unsigned overflow, the result returned is the
mathematical result modulo 2<sup>n</sup>, where n is the bit width of
the result.</p>
<p>Because LLVM integers use a two’s complement representation, this
instruction is appropriate for both signed and unsigned integers.</p>
<p><code class="docutils literal notranslate"><span class="pre">nuw</span></code> and <code class="docutils literal notranslate"><span class="pre">nsw</span></code> stand for “No Unsigned Wrap” and “No Signed Wrap”,
respectively. If the <code class="docutils literal notranslate"><span class="pre">nuw</span></code> and/or <code class="docutils literal notranslate"><span class="pre">nsw</span></code> keywords are present, the
result value of the <code class="docutils literal notranslate"><span class="pre">add</span></code> is a <a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a> if
unsigned and/or signed overflow, respectively, occurs.</p>
</div>
<div class="section" id="id89">
<h5><a class="toc-backref" href="#id1697">Example:</a><a class="headerlink" href="#id89" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = add i32 4, %var ; yields i32:result = 4 + %var
</pre></div>
</div>
</div>
</div>
<div class="section" id="fadd-instruction">
<span id="i-fadd"></span><h4><a class="toc-backref" href="#id1698">‘<code class="docutils literal notranslate"><span class="pre">fadd</span></code>’ Instruction</a><a class="headerlink" href="#fadd-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id90">
<h5><a class="toc-backref" href="#id1699">Syntax:</a><a class="headerlink" href="#id90" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">fadd</span> <span class="p">[</span><span class="n">fast</span><span class="o">-</span><span class="n">math</span> <span class="n">flags</span><span class="p">]</span><span class="o">*</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id91">
<h5><a class="toc-backref" href="#id1700">Overview:</a><a class="headerlink" href="#id91" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">fadd</span></code>’ instruction returns the sum of its two operands.</p>
</div>
<div class="section" id="id92">
<h5><a class="toc-backref" href="#id1701">Arguments:</a><a class="headerlink" href="#id92" title="Permalink to this headline">¶</a></h5>
<p>The two arguments to the ‘<code class="docutils literal notranslate"><span class="pre">fadd</span></code>’ instruction must be
<a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of
floating-point values. Both arguments must have identical types.</p>
</div>
<div class="section" id="id93">
<h5><a class="toc-backref" href="#id1702">Semantics:</a><a class="headerlink" href="#id93" title="Permalink to this headline">¶</a></h5>
<p>The value produced is the floating-point sum of the two operands.
This instruction is assumed to execute in the default <a class="reference internal" href="#floatenv"><span class="std std-ref">floating-point
environment</span></a>.
This instruction can also take any number of <a class="reference internal" href="#fastmath"><span class="std std-ref">fast-math
flags</span></a>, which are optimization hints to enable otherwise
unsafe floating-point optimizations:</p>
</div>
<div class="section" id="id94">
<h5><a class="toc-backref" href="#id1703">Example:</a><a class="headerlink" href="#id94" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = fadd float 4.0, %var ; yields float:result = 4.0 + %var
</pre></div>
</div>
</div>
</div>
<div class="section" id="sub-instruction">
<span id="i-sub"></span><h4><a class="toc-backref" href="#id1704">‘<code class="docutils literal notranslate"><span class="pre">sub</span></code>’ Instruction</a><a class="headerlink" href="#sub-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id95">
<h5><a class="toc-backref" href="#id1705">Syntax:</a><a class="headerlink" href="#id95" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">sub</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">sub</span> <span class="n">nuw</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">sub</span> <span class="n">nsw</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">sub</span> <span class="n">nuw</span> <span class="n">nsw</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id96">
<h5><a class="toc-backref" href="#id1706">Overview:</a><a class="headerlink" href="#id96" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">sub</span></code>’ instruction returns the difference of its two operands.</p>
<p>Note that the ‘<code class="docutils literal notranslate"><span class="pre">sub</span></code>’ instruction is used to represent the ‘<code class="docutils literal notranslate"><span class="pre">neg</span></code>’
instruction present in most other intermediate representations.</p>
</div>
<div class="section" id="id97">
<h5><a class="toc-backref" href="#id1707">Arguments:</a><a class="headerlink" href="#id97" title="Permalink to this headline">¶</a></h5>
<p>The two arguments to the ‘<code class="docutils literal notranslate"><span class="pre">sub</span></code>’ instruction must be
<a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of integer values. Both
arguments must have identical types.</p>
</div>
<div class="section" id="id98">
<h5><a class="toc-backref" href="#id1708">Semantics:</a><a class="headerlink" href="#id98" title="Permalink to this headline">¶</a></h5>
<p>The value produced is the integer difference of the two operands.</p>
<p>If the difference has unsigned overflow, the result returned is the
mathematical result modulo 2<sup>n</sup>, where n is the bit width of
the result.</p>
<p>Because LLVM integers use a two’s complement representation, this
instruction is appropriate for both signed and unsigned integers.</p>
<p><code class="docutils literal notranslate"><span class="pre">nuw</span></code> and <code class="docutils literal notranslate"><span class="pre">nsw</span></code> stand for “No Unsigned Wrap” and “No Signed Wrap”,
respectively. If the <code class="docutils literal notranslate"><span class="pre">nuw</span></code> and/or <code class="docutils literal notranslate"><span class="pre">nsw</span></code> keywords are present, the
result value of the <code class="docutils literal notranslate"><span class="pre">sub</span></code> is a <a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a> if
unsigned and/or signed overflow, respectively, occurs.</p>
</div>
<div class="section" id="id99">
<h5><a class="toc-backref" href="#id1709">Example:</a><a class="headerlink" href="#id99" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = sub i32 4, %var ; yields i32:result = 4 - %var
<result> = sub i32 0, %val ; yields i32:result = -%var
</pre></div>
</div>
</div>
</div>
<div class="section" id="fsub-instruction">
<span id="i-fsub"></span><h4><a class="toc-backref" href="#id1710">‘<code class="docutils literal notranslate"><span class="pre">fsub</span></code>’ Instruction</a><a class="headerlink" href="#fsub-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id100">
<h5><a class="toc-backref" href="#id1711">Syntax:</a><a class="headerlink" href="#id100" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">fsub</span> <span class="p">[</span><span class="n">fast</span><span class="o">-</span><span class="n">math</span> <span class="n">flags</span><span class="p">]</span><span class="o">*</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id101">
<h5><a class="toc-backref" href="#id1712">Overview:</a><a class="headerlink" href="#id101" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">fsub</span></code>’ instruction returns the difference of its two operands.</p>
</div>
<div class="section" id="id102">
<h5><a class="toc-backref" href="#id1713">Arguments:</a><a class="headerlink" href="#id102" title="Permalink to this headline">¶</a></h5>
<p>The two arguments to the ‘<code class="docutils literal notranslate"><span class="pre">fsub</span></code>’ instruction must be
<a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of
floating-point values. Both arguments must have identical types.</p>
</div>
<div class="section" id="id103">
<h5><a class="toc-backref" href="#id1714">Semantics:</a><a class="headerlink" href="#id103" title="Permalink to this headline">¶</a></h5>
<p>The value produced is the floating-point difference of the two operands.
This instruction is assumed to execute in the default <a class="reference internal" href="#floatenv"><span class="std std-ref">floating-point
environment</span></a>.
This instruction can also take any number of <a class="reference internal" href="#fastmath"><span class="std std-ref">fast-math
flags</span></a>, which are optimization hints to enable otherwise
unsafe floating-point optimizations:</p>
</div>
<div class="section" id="id104">
<h5><a class="toc-backref" href="#id1715">Example:</a><a class="headerlink" href="#id104" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = fsub float 4.0, %var ; yields float:result = 4.0 - %var
<result> = fsub float -0.0, %val ; yields float:result = -%var
</pre></div>
</div>
</div>
</div>
<div class="section" id="mul-instruction">
<span id="i-mul"></span><h4><a class="toc-backref" href="#id1716">‘<code class="docutils literal notranslate"><span class="pre">mul</span></code>’ Instruction</a><a class="headerlink" href="#mul-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id105">
<h5><a class="toc-backref" href="#id1717">Syntax:</a><a class="headerlink" href="#id105" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">mul</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">mul</span> <span class="n">nuw</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">mul</span> <span class="n">nsw</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">mul</span> <span class="n">nuw</span> <span class="n">nsw</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id106">
<h5><a class="toc-backref" href="#id1718">Overview:</a><a class="headerlink" href="#id106" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">mul</span></code>’ instruction returns the product of its two operands.</p>
</div>
<div class="section" id="id107">
<h5><a class="toc-backref" href="#id1719">Arguments:</a><a class="headerlink" href="#id107" title="Permalink to this headline">¶</a></h5>
<p>The two arguments to the ‘<code class="docutils literal notranslate"><span class="pre">mul</span></code>’ instruction must be
<a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of integer values. Both
arguments must have identical types.</p>
</div>
<div class="section" id="id108">
<h5><a class="toc-backref" href="#id1720">Semantics:</a><a class="headerlink" href="#id108" title="Permalink to this headline">¶</a></h5>
<p>The value produced is the integer product of the two operands.</p>
<p>If the result of the multiplication has unsigned overflow, the result
returned is the mathematical result modulo 2<sup>n</sup>, where n is the
bit width of the result.</p>
<p>Because LLVM integers use a two’s complement representation, and the
result is the same width as the operands, this instruction returns the
correct result for both signed and unsigned integers. If a full product
(e.g. <code class="docutils literal notranslate"><span class="pre">i32</span></code> * <code class="docutils literal notranslate"><span class="pre">i32</span></code> -> <code class="docutils literal notranslate"><span class="pre">i64</span></code>) is needed, the operands should be
sign-extended or zero-extended as appropriate to the width of the full
product.</p>
<p><code class="docutils literal notranslate"><span class="pre">nuw</span></code> and <code class="docutils literal notranslate"><span class="pre">nsw</span></code> stand for “No Unsigned Wrap” and “No Signed Wrap”,
respectively. If the <code class="docutils literal notranslate"><span class="pre">nuw</span></code> and/or <code class="docutils literal notranslate"><span class="pre">nsw</span></code> keywords are present, the
result value of the <code class="docutils literal notranslate"><span class="pre">mul</span></code> is a <a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a> if
unsigned and/or signed overflow, respectively, occurs.</p>
</div>
<div class="section" id="id109">
<h5><a class="toc-backref" href="#id1721">Example:</a><a class="headerlink" href="#id109" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = mul i32 4, %var ; yields i32:result = 4 * %var
</pre></div>
</div>
</div>
</div>
<div class="section" id="fmul-instruction">
<span id="i-fmul"></span><h4><a class="toc-backref" href="#id1722">‘<code class="docutils literal notranslate"><span class="pre">fmul</span></code>’ Instruction</a><a class="headerlink" href="#fmul-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id110">
<h5><a class="toc-backref" href="#id1723">Syntax:</a><a class="headerlink" href="#id110" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">fmul</span> <span class="p">[</span><span class="n">fast</span><span class="o">-</span><span class="n">math</span> <span class="n">flags</span><span class="p">]</span><span class="o">*</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id111">
<h5><a class="toc-backref" href="#id1724">Overview:</a><a class="headerlink" href="#id111" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">fmul</span></code>’ instruction returns the product of its two operands.</p>
</div>
<div class="section" id="id112">
<h5><a class="toc-backref" href="#id1725">Arguments:</a><a class="headerlink" href="#id112" title="Permalink to this headline">¶</a></h5>
<p>The two arguments to the ‘<code class="docutils literal notranslate"><span class="pre">fmul</span></code>’ instruction must be
<a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of
floating-point values. Both arguments must have identical types.</p>
</div>
<div class="section" id="id113">
<h5><a class="toc-backref" href="#id1726">Semantics:</a><a class="headerlink" href="#id113" title="Permalink to this headline">¶</a></h5>
<p>The value produced is the floating-point product of the two operands.
This instruction is assumed to execute in the default <a class="reference internal" href="#floatenv"><span class="std std-ref">floating-point
environment</span></a>.
This instruction can also take any number of <a class="reference internal" href="#fastmath"><span class="std std-ref">fast-math
flags</span></a>, which are optimization hints to enable otherwise
unsafe floating-point optimizations:</p>
</div>
<div class="section" id="id114">
<h5><a class="toc-backref" href="#id1727">Example:</a><a class="headerlink" href="#id114" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = fmul float 4.0, %var ; yields float:result = 4.0 * %var
</pre></div>
</div>
</div>
</div>
<div class="section" id="udiv-instruction">
<span id="i-udiv"></span><h4><a class="toc-backref" href="#id1728">‘<code class="docutils literal notranslate"><span class="pre">udiv</span></code>’ Instruction</a><a class="headerlink" href="#udiv-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id115">
<h5><a class="toc-backref" href="#id1729">Syntax:</a><a class="headerlink" href="#id115" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">udiv</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">udiv</span> <span class="n">exact</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id116">
<h5><a class="toc-backref" href="#id1730">Overview:</a><a class="headerlink" href="#id116" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">udiv</span></code>’ instruction returns the quotient of its two operands.</p>
</div>
<div class="section" id="id117">
<h5><a class="toc-backref" href="#id1731">Arguments:</a><a class="headerlink" href="#id117" title="Permalink to this headline">¶</a></h5>
<p>The two arguments to the ‘<code class="docutils literal notranslate"><span class="pre">udiv</span></code>’ instruction must be
<a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of integer values. Both
arguments must have identical types.</p>
</div>
<div class="section" id="id118">
<h5><a class="toc-backref" href="#id1732">Semantics:</a><a class="headerlink" href="#id118" title="Permalink to this headline">¶</a></h5>
<p>The value produced is the unsigned integer quotient of the two operands.</p>
<p>Note that unsigned integer division and signed integer division are
distinct operations; for signed integer division, use ‘<code class="docutils literal notranslate"><span class="pre">sdiv</span></code>’.</p>
<p>Division by zero is undefined behavior. For vectors, if any element
of the divisor is zero, the operation has undefined behavior.</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">exact</span></code> keyword is present, the result value of the <code class="docutils literal notranslate"><span class="pre">udiv</span></code> is
a <a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a> if %op1 is not a multiple of %op2 (as
such, “((a udiv exact b) mul b) == a”).</p>
</div>
<div class="section" id="id119">
<h5><a class="toc-backref" href="#id1733">Example:</a><a class="headerlink" href="#id119" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = udiv i32 4, %var ; yields i32:result = 4 / %var
</pre></div>
</div>
</div>
</div>
<div class="section" id="sdiv-instruction">
<span id="i-sdiv"></span><h4><a class="toc-backref" href="#id1734">‘<code class="docutils literal notranslate"><span class="pre">sdiv</span></code>’ Instruction</a><a class="headerlink" href="#sdiv-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id120">
<h5><a class="toc-backref" href="#id1735">Syntax:</a><a class="headerlink" href="#id120" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">sdiv</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">sdiv</span> <span class="n">exact</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id121">
<h5><a class="toc-backref" href="#id1736">Overview:</a><a class="headerlink" href="#id121" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">sdiv</span></code>’ instruction returns the quotient of its two operands.</p>
</div>
<div class="section" id="id122">
<h5><a class="toc-backref" href="#id1737">Arguments:</a><a class="headerlink" href="#id122" title="Permalink to this headline">¶</a></h5>
<p>The two arguments to the ‘<code class="docutils literal notranslate"><span class="pre">sdiv</span></code>’ instruction must be
<a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of integer values. Both
arguments must have identical types.</p>
</div>
<div class="section" id="id123">
<h5><a class="toc-backref" href="#id1738">Semantics:</a><a class="headerlink" href="#id123" title="Permalink to this headline">¶</a></h5>
<p>The value produced is the signed integer quotient of the two operands
rounded towards zero.</p>
<p>Note that signed integer division and unsigned integer division are
distinct operations; for unsigned integer division, use ‘<code class="docutils literal notranslate"><span class="pre">udiv</span></code>’.</p>
<p>Division by zero is undefined behavior. For vectors, if any element
of the divisor is zero, the operation has undefined behavior.
Overflow also leads to undefined behavior; this is a rare case, but can
occur, for example, by doing a 32-bit division of -2147483648 by -1.</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">exact</span></code> keyword is present, the result value of the <code class="docutils literal notranslate"><span class="pre">sdiv</span></code> is
a <a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a> if the result would be rounded.</p>
</div>
<div class="section" id="id124">
<h5><a class="toc-backref" href="#id1739">Example:</a><a class="headerlink" href="#id124" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = sdiv i32 4, %var ; yields i32:result = 4 / %var
</pre></div>
</div>
</div>
</div>
<div class="section" id="fdiv-instruction">
<span id="i-fdiv"></span><h4><a class="toc-backref" href="#id1740">‘<code class="docutils literal notranslate"><span class="pre">fdiv</span></code>’ Instruction</a><a class="headerlink" href="#fdiv-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id125">
<h5><a class="toc-backref" href="#id1741">Syntax:</a><a class="headerlink" href="#id125" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">fdiv</span> <span class="p">[</span><span class="n">fast</span><span class="o">-</span><span class="n">math</span> <span class="n">flags</span><span class="p">]</span><span class="o">*</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id126">
<h5><a class="toc-backref" href="#id1742">Overview:</a><a class="headerlink" href="#id126" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">fdiv</span></code>’ instruction returns the quotient of its two operands.</p>
</div>
<div class="section" id="id127">
<h5><a class="toc-backref" href="#id1743">Arguments:</a><a class="headerlink" href="#id127" title="Permalink to this headline">¶</a></h5>
<p>The two arguments to the ‘<code class="docutils literal notranslate"><span class="pre">fdiv</span></code>’ instruction must be
<a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of
floating-point values. Both arguments must have identical types.</p>
</div>
<div class="section" id="id128">
<h5><a class="toc-backref" href="#id1744">Semantics:</a><a class="headerlink" href="#id128" title="Permalink to this headline">¶</a></h5>
<p>The value produced is the floating-point quotient of the two operands.
This instruction is assumed to execute in the default <a class="reference internal" href="#floatenv"><span class="std std-ref">floating-point
environment</span></a>.
This instruction can also take any number of <a class="reference internal" href="#fastmath"><span class="std std-ref">fast-math
flags</span></a>, which are optimization hints to enable otherwise
unsafe floating-point optimizations:</p>
</div>
<div class="section" id="id129">
<h5><a class="toc-backref" href="#id1745">Example:</a><a class="headerlink" href="#id129" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = fdiv float 4.0, %var ; yields float:result = 4.0 / %var
</pre></div>
</div>
</div>
</div>
<div class="section" id="urem-instruction">
<span id="i-urem"></span><h4><a class="toc-backref" href="#id1746">‘<code class="docutils literal notranslate"><span class="pre">urem</span></code>’ Instruction</a><a class="headerlink" href="#urem-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id130">
<h5><a class="toc-backref" href="#id1747">Syntax:</a><a class="headerlink" href="#id130" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">urem</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id131">
<h5><a class="toc-backref" href="#id1748">Overview:</a><a class="headerlink" href="#id131" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">urem</span></code>’ instruction returns the remainder from the unsigned
division of its two arguments.</p>
</div>
<div class="section" id="id132">
<h5><a class="toc-backref" href="#id1749">Arguments:</a><a class="headerlink" href="#id132" title="Permalink to this headline">¶</a></h5>
<p>The two arguments to the ‘<code class="docutils literal notranslate"><span class="pre">urem</span></code>’ instruction must be
<a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of integer values. Both
arguments must have identical types.</p>
</div>
<div class="section" id="id133">
<h5><a class="toc-backref" href="#id1750">Semantics:</a><a class="headerlink" href="#id133" title="Permalink to this headline">¶</a></h5>
<p>This instruction returns the unsigned integer <em>remainder</em> of a division.
This instruction always performs an unsigned division to get the
remainder.</p>
<p>Note that unsigned integer remainder and signed integer remainder are
distinct operations; for signed integer remainder, use ‘<code class="docutils literal notranslate"><span class="pre">srem</span></code>’.</p>
<p>Taking the remainder of a division by zero is undefined behavior.
For vectors, if any element of the divisor is zero, the operation has
undefined behavior.</p>
</div>
<div class="section" id="id134">
<h5><a class="toc-backref" href="#id1751">Example:</a><a class="headerlink" href="#id134" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = urem i32 4, %var ; yields i32:result = 4 % %var
</pre></div>
</div>
</div>
</div>
<div class="section" id="srem-instruction">
<span id="i-srem"></span><h4><a class="toc-backref" href="#id1752">‘<code class="docutils literal notranslate"><span class="pre">srem</span></code>’ Instruction</a><a class="headerlink" href="#srem-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id135">
<h5><a class="toc-backref" href="#id1753">Syntax:</a><a class="headerlink" href="#id135" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">srem</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id136">
<h5><a class="toc-backref" href="#id1754">Overview:</a><a class="headerlink" href="#id136" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">srem</span></code>’ instruction returns the remainder from the signed
division of its two operands. This instruction can also take
<a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> versions of the values in which case the elements
must be integers.</p>
</div>
<div class="section" id="id137">
<h5><a class="toc-backref" href="#id1755">Arguments:</a><a class="headerlink" href="#id137" title="Permalink to this headline">¶</a></h5>
<p>The two arguments to the ‘<code class="docutils literal notranslate"><span class="pre">srem</span></code>’ instruction must be
<a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of integer values. Both
arguments must have identical types.</p>
</div>
<div class="section" id="id138">
<h5><a class="toc-backref" href="#id1756">Semantics:</a><a class="headerlink" href="#id138" title="Permalink to this headline">¶</a></h5>
<p>This instruction returns the <em>remainder</em> of a division (where the result
is either zero or has the same sign as the dividend, <code class="docutils literal notranslate"><span class="pre">op1</span></code>), not the
<em>modulo</em> operator (where the result is either zero or has the same sign
as the divisor, <code class="docutils literal notranslate"><span class="pre">op2</span></code>) of a value. For more information about the
difference, see <a class="reference external" href="http://mathforum.org/dr.math/problems/anne.4.28.99.html">The Math
Forum</a>. For a
table of how this is implemented in various languages, please see
<a class="reference external" href="http://en.wikipedia.org/wiki/Modulo_operation">Wikipedia: modulo
operation</a>.</p>
<p>Note that signed integer remainder and unsigned integer remainder are
distinct operations; for unsigned integer remainder, use ‘<code class="docutils literal notranslate"><span class="pre">urem</span></code>’.</p>
<p>Taking the remainder of a division by zero is undefined behavior.
For vectors, if any element of the divisor is zero, the operation has
undefined behavior.
Overflow also leads to undefined behavior; this is a rare case, but can
occur, for example, by taking the remainder of a 32-bit division of
-2147483648 by -1. (The remainder doesn’t actually overflow, but this
rule lets srem be implemented using instructions that return both the
result of the division and the remainder.)</p>
</div>
<div class="section" id="id139">
<h5><a class="toc-backref" href="#id1757">Example:</a><a class="headerlink" href="#id139" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = srem i32 4, %var ; yields i32:result = 4 % %var
</pre></div>
</div>
</div>
</div>
<div class="section" id="frem-instruction">
<span id="i-frem"></span><h4><a class="toc-backref" href="#id1758">‘<code class="docutils literal notranslate"><span class="pre">frem</span></code>’ Instruction</a><a class="headerlink" href="#frem-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id140">
<h5><a class="toc-backref" href="#id1759">Syntax:</a><a class="headerlink" href="#id140" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">frem</span> <span class="p">[</span><span class="n">fast</span><span class="o">-</span><span class="n">math</span> <span class="n">flags</span><span class="p">]</span><span class="o">*</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id141">
<h5><a class="toc-backref" href="#id1760">Overview:</a><a class="headerlink" href="#id141" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">frem</span></code>’ instruction returns the remainder from the division of
its two operands.</p>
</div>
<div class="section" id="id142">
<h5><a class="toc-backref" href="#id1761">Arguments:</a><a class="headerlink" href="#id142" title="Permalink to this headline">¶</a></h5>
<p>The two arguments to the ‘<code class="docutils literal notranslate"><span class="pre">frem</span></code>’ instruction must be
<a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of
floating-point values. Both arguments must have identical types.</p>
</div>
<div class="section" id="id143">
<h5><a class="toc-backref" href="#id1762">Semantics:</a><a class="headerlink" href="#id143" title="Permalink to this headline">¶</a></h5>
<p>The value produced is the floating-point remainder of the two operands.
This is the same output as a libm ‘<code class="docutils literal notranslate"><span class="pre">fmod</span></code>’ function, but without any
possibility of setting <code class="docutils literal notranslate"><span class="pre">errno</span></code>. The remainder has the same sign as the
dividend.
This instruction is assumed to execute in the default <a class="reference internal" href="#floatenv"><span class="std std-ref">floating-point
environment</span></a>.
This instruction can also take any number of <a class="reference internal" href="#fastmath"><span class="std std-ref">fast-math
flags</span></a>, which are optimization hints to enable otherwise
unsafe floating-point optimizations:</p>
</div>
<div class="section" id="id144">
<h5><a class="toc-backref" href="#id1763">Example:</a><a class="headerlink" href="#id144" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = frem float 4.0, %var ; yields float:result = 4.0 % %var
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="bitwise-binary-operations">
<span id="bitwiseops"></span><h3><a class="toc-backref" href="#id1764">Bitwise Binary Operations</a><a class="headerlink" href="#bitwise-binary-operations" title="Permalink to this headline">¶</a></h3>
<p>Bitwise binary operators are used to do various forms of bit-twiddling
in a program. They are generally very efficient instructions and can
commonly be strength reduced from other instructions. They require two
operands of the same type, execute an operation on them, and produce a
single value. The resulting value is the same type as its operands.</p>
<div class="section" id="shl-instruction">
<span id="i-shl"></span><h4><a class="toc-backref" href="#id1765">‘<code class="docutils literal notranslate"><span class="pre">shl</span></code>’ Instruction</a><a class="headerlink" href="#shl-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id145">
<h5><a class="toc-backref" href="#id1766">Syntax:</a><a class="headerlink" href="#id145" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">shl</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">shl</span> <span class="n">nuw</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">shl</span> <span class="n">nsw</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">shl</span> <span class="n">nuw</span> <span class="n">nsw</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id146">
<h5><a class="toc-backref" href="#id1767">Overview:</a><a class="headerlink" href="#id146" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">shl</span></code>’ instruction returns the first operand shifted to the left
a specified number of bits.</p>
</div>
<div class="section" id="id147">
<h5><a class="toc-backref" href="#id1768">Arguments:</a><a class="headerlink" href="#id147" title="Permalink to this headline">¶</a></h5>
<p>Both arguments to the ‘<code class="docutils literal notranslate"><span class="pre">shl</span></code>’ instruction must be the same
<a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of integer type.
‘<code class="docutils literal notranslate"><span class="pre">op2</span></code>’ is treated as an unsigned value.</p>
</div>
<div class="section" id="id148">
<h5><a class="toc-backref" href="#id1769">Semantics:</a><a class="headerlink" href="#id148" title="Permalink to this headline">¶</a></h5>
<p>The value produced is <code class="docutils literal notranslate"><span class="pre">op1</span></code> * 2<sup>op2</sup> mod 2<sup>n</sup>,
where <code class="docutils literal notranslate"><span class="pre">n</span></code> is the width of the result. If <code class="docutils literal notranslate"><span class="pre">op2</span></code> is (statically or
dynamically) equal to or larger than the number of bits in
<code class="docutils literal notranslate"><span class="pre">op1</span></code>, this instruction returns a <a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a>.
If the arguments are vectors, each vector element of <code class="docutils literal notranslate"><span class="pre">op1</span></code> is shifted
by the corresponding shift amount in <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">nuw</span></code> keyword is present, then the shift produces a poison
value if it shifts out any non-zero bits.
If the <code class="docutils literal notranslate"><span class="pre">nsw</span></code> keyword is present, then the shift produces a poison
value if it shifts out any bits that disagree with the resultant sign bit.</p>
</div>
<div class="section" id="id149">
<h5><a class="toc-backref" href="#id1770">Example:</a><a class="headerlink" href="#id149" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = shl i32 4, %var ; yields i32: 4 << %var
<result> = shl i32 4, 2 ; yields i32: 16
<result> = shl i32 1, 10 ; yields i32: 1024
<result> = shl i32 1, 32 ; undefined
<result> = shl <2 x i32> < i32 1, i32 1>, < i32 1, i32 2> ; yields: result=<2 x i32> < i32 2, i32 4>
</pre></div>
</div>
</div>
</div>
<div class="section" id="lshr-instruction">
<span id="i-lshr"></span><h4><a class="toc-backref" href="#id1771">‘<code class="docutils literal notranslate"><span class="pre">lshr</span></code>’ Instruction</a><a class="headerlink" href="#lshr-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id150">
<h5><a class="toc-backref" href="#id1772">Syntax:</a><a class="headerlink" href="#id150" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">lshr</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">lshr</span> <span class="n">exact</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id151">
<h5><a class="toc-backref" href="#id1773">Overview:</a><a class="headerlink" href="#id151" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">lshr</span></code>’ instruction (logical shift right) returns the first
operand shifted to the right a specified number of bits with zero fill.</p>
</div>
<div class="section" id="id152">
<h5><a class="toc-backref" href="#id1774">Arguments:</a><a class="headerlink" href="#id152" title="Permalink to this headline">¶</a></h5>
<p>Both arguments to the ‘<code class="docutils literal notranslate"><span class="pre">lshr</span></code>’ instruction must be the same
<a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of integer type.
‘<code class="docutils literal notranslate"><span class="pre">op2</span></code>’ is treated as an unsigned value.</p>
</div>
<div class="section" id="id153">
<h5><a class="toc-backref" href="#id1775">Semantics:</a><a class="headerlink" href="#id153" title="Permalink to this headline">¶</a></h5>
<p>This instruction always performs a logical shift right operation. The
most significant bits of the result will be filled with zero bits after
the shift. If <code class="docutils literal notranslate"><span class="pre">op2</span></code> is (statically or dynamically) equal to or larger
than the number of bits in <code class="docutils literal notranslate"><span class="pre">op1</span></code>, this instruction returns a <a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison
value</span></a>. If the arguments are vectors, each vector element
of <code class="docutils literal notranslate"><span class="pre">op1</span></code> is shifted by the corresponding shift amount in <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">exact</span></code> keyword is present, the result value of the <code class="docutils literal notranslate"><span class="pre">lshr</span></code> is
a poison value if any of the bits shifted out are non-zero.</p>
</div>
<div class="section" id="id154">
<h5><a class="toc-backref" href="#id1776">Example:</a><a class="headerlink" href="#id154" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = lshr i32 4, 1 ; yields i32:result = 2
<result> = lshr i32 4, 2 ; yields i32:result = 1
<result> = lshr i8 4, 3 ; yields i8:result = 0
<result> = lshr i8 -2, 1 ; yields i8:result = 0x7F
<result> = lshr i32 1, 32 ; undefined
<result> = lshr <2 x i32> < i32 -2, i32 4>, < i32 1, i32 2> ; yields: result=<2 x i32> < i32 0x7FFFFFFF, i32 1>
</pre></div>
</div>
</div>
</div>
<div class="section" id="ashr-instruction">
<span id="i-ashr"></span><h4><a class="toc-backref" href="#id1777">‘<code class="docutils literal notranslate"><span class="pre">ashr</span></code>’ Instruction</a><a class="headerlink" href="#ashr-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id155">
<h5><a class="toc-backref" href="#id1778">Syntax:</a><a class="headerlink" href="#id155" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">ashr</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">ashr</span> <span class="n">exact</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id156">
<h5><a class="toc-backref" href="#id1779">Overview:</a><a class="headerlink" href="#id156" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">ashr</span></code>’ instruction (arithmetic shift right) returns the first
operand shifted to the right a specified number of bits with sign
extension.</p>
</div>
<div class="section" id="id157">
<h5><a class="toc-backref" href="#id1780">Arguments:</a><a class="headerlink" href="#id157" title="Permalink to this headline">¶</a></h5>
<p>Both arguments to the ‘<code class="docutils literal notranslate"><span class="pre">ashr</span></code>’ instruction must be the same
<a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of integer type.
‘<code class="docutils literal notranslate"><span class="pre">op2</span></code>’ is treated as an unsigned value.</p>
</div>
<div class="section" id="id158">
<h5><a class="toc-backref" href="#id1781">Semantics:</a><a class="headerlink" href="#id158" title="Permalink to this headline">¶</a></h5>
<p>This instruction always performs an arithmetic shift right operation,
The most significant bits of the result will be filled with the sign bit
of <code class="docutils literal notranslate"><span class="pre">op1</span></code>. If <code class="docutils literal notranslate"><span class="pre">op2</span></code> is (statically or dynamically) equal to or larger
than the number of bits in <code class="docutils literal notranslate"><span class="pre">op1</span></code>, this instruction returns a <a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison
value</span></a>. If the arguments are vectors, each vector element
of <code class="docutils literal notranslate"><span class="pre">op1</span></code> is shifted by the corresponding shift amount in <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">exact</span></code> keyword is present, the result value of the <code class="docutils literal notranslate"><span class="pre">ashr</span></code> is
a poison value if any of the bits shifted out are non-zero.</p>
</div>
<div class="section" id="id159">
<h5><a class="toc-backref" href="#id1782">Example:</a><a class="headerlink" href="#id159" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = ashr i32 4, 1 ; yields i32:result = 2
<result> = ashr i32 4, 2 ; yields i32:result = 1
<result> = ashr i8 4, 3 ; yields i8:result = 0
<result> = ashr i8 -2, 1 ; yields i8:result = -1
<result> = ashr i32 1, 32 ; undefined
<result> = ashr <2 x i32> < i32 -2, i32 4>, < i32 1, i32 3> ; yields: result=<2 x i32> < i32 -1, i32 0>
</pre></div>
</div>
</div>
</div>
<div class="section" id="and-instruction">
<span id="i-and"></span><h4><a class="toc-backref" href="#id1783">‘<code class="docutils literal notranslate"><span class="pre">and</span></code>’ Instruction</a><a class="headerlink" href="#and-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id160">
<h5><a class="toc-backref" href="#id1784">Syntax:</a><a class="headerlink" href="#id160" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="ow">and</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id161">
<h5><a class="toc-backref" href="#id1785">Overview:</a><a class="headerlink" href="#id161" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">and</span></code>’ instruction returns the bitwise logical and of its two
operands.</p>
</div>
<div class="section" id="id162">
<h5><a class="toc-backref" href="#id1786">Arguments:</a><a class="headerlink" href="#id162" title="Permalink to this headline">¶</a></h5>
<p>The two arguments to the ‘<code class="docutils literal notranslate"><span class="pre">and</span></code>’ instruction must be
<a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of integer values. Both
arguments must have identical types.</p>
</div>
<div class="section" id="id163">
<h5><a class="toc-backref" href="#id1787">Semantics:</a><a class="headerlink" href="#id163" title="Permalink to this headline">¶</a></h5>
<p>The truth table used for the ‘<code class="docutils literal notranslate"><span class="pre">and</span></code>’ instruction is:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>In0</p></td>
<td><p>In1</p></td>
<td><p>Out</p></td>
</tr>
<tr class="row-even"><td><p>0</p></td>
<td><p>0</p></td>
<td><p>0</p></td>
</tr>
<tr class="row-odd"><td><p>0</p></td>
<td><p>1</p></td>
<td><p>0</p></td>
</tr>
<tr class="row-even"><td><p>1</p></td>
<td><p>0</p></td>
<td><p>0</p></td>
</tr>
<tr class="row-odd"><td><p>1</p></td>
<td><p>1</p></td>
<td><p>1</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id164">
<h5><a class="toc-backref" href="#id1788">Example:</a><a class="headerlink" href="#id164" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = and i32 4, %var ; yields i32:result = 4 & %var
<result> = and i32 15, 40 ; yields i32:result = 8
<result> = and i32 4, 8 ; yields i32:result = 0
</pre></div>
</div>
</div>
</div>
<div class="section" id="or-instruction">
<span id="i-or"></span><h4><a class="toc-backref" href="#id1789">‘<code class="docutils literal notranslate"><span class="pre">or</span></code>’ Instruction</a><a class="headerlink" href="#or-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id165">
<h5><a class="toc-backref" href="#id1790">Syntax:</a><a class="headerlink" href="#id165" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="ow">or</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id166">
<h5><a class="toc-backref" href="#id1791">Overview:</a><a class="headerlink" href="#id166" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">or</span></code>’ instruction returns the bitwise logical inclusive or of its
two operands.</p>
</div>
<div class="section" id="id167">
<h5><a class="toc-backref" href="#id1792">Arguments:</a><a class="headerlink" href="#id167" title="Permalink to this headline">¶</a></h5>
<p>The two arguments to the ‘<code class="docutils literal notranslate"><span class="pre">or</span></code>’ instruction must be
<a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of integer values. Both
arguments must have identical types.</p>
</div>
<div class="section" id="id168">
<h5><a class="toc-backref" href="#id1793">Semantics:</a><a class="headerlink" href="#id168" title="Permalink to this headline">¶</a></h5>
<p>The truth table used for the ‘<code class="docutils literal notranslate"><span class="pre">or</span></code>’ instruction is:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>In0</p></td>
<td><p>In1</p></td>
<td><p>Out</p></td>
</tr>
<tr class="row-even"><td><p>0</p></td>
<td><p>0</p></td>
<td><p>0</p></td>
</tr>
<tr class="row-odd"><td><p>0</p></td>
<td><p>1</p></td>
<td><p>1</p></td>
</tr>
<tr class="row-even"><td><p>1</p></td>
<td><p>0</p></td>
<td><p>1</p></td>
</tr>
<tr class="row-odd"><td><p>1</p></td>
<td><p>1</p></td>
<td><p>1</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id169">
<h5><a class="toc-backref" href="#id1794">Example:</a><a class="headerlink" href="#id169" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="ow">or</span> <span class="n">i32</span> <span class="mi">4</span><span class="p">,</span> <span class="o">%</span><span class="n">var</span> <span class="p">;</span> <span class="n">yields</span> <span class="n">i32</span><span class="p">:</span><span class="n">result</span> <span class="o">=</span> <span class="mi">4</span> <span class="o">|</span> <span class="o">%</span><span class="n">var</span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="ow">or</span> <span class="n">i32</span> <span class="mi">15</span><span class="p">,</span> <span class="mi">40</span> <span class="p">;</span> <span class="n">yields</span> <span class="n">i32</span><span class="p">:</span><span class="n">result</span> <span class="o">=</span> <span class="mi">47</span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="ow">or</span> <span class="n">i32</span> <span class="mi">4</span><span class="p">,</span> <span class="mi">8</span> <span class="p">;</span> <span class="n">yields</span> <span class="n">i32</span><span class="p">:</span><span class="n">result</span> <span class="o">=</span> <span class="mi">12</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="xor-instruction">
<span id="i-xor"></span><h4><a class="toc-backref" href="#id1795">‘<code class="docutils literal notranslate"><span class="pre">xor</span></code>’ Instruction</a><a class="headerlink" href="#xor-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id170">
<h5><a class="toc-backref" href="#id1796">Syntax:</a><a class="headerlink" href="#id170" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">xor</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id171">
<h5><a class="toc-backref" href="#id1797">Overview:</a><a class="headerlink" href="#id171" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">xor</span></code>’ instruction returns the bitwise logical exclusive or of
its two operands. The <code class="docutils literal notranslate"><span class="pre">xor</span></code> is used to implement the “one’s
complement” operation, which is the “~” operator in C.</p>
</div>
<div class="section" id="id172">
<h5><a class="toc-backref" href="#id1798">Arguments:</a><a class="headerlink" href="#id172" title="Permalink to this headline">¶</a></h5>
<p>The two arguments to the ‘<code class="docutils literal notranslate"><span class="pre">xor</span></code>’ instruction must be
<a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of integer values. Both
arguments must have identical types.</p>
</div>
<div class="section" id="id173">
<h5><a class="toc-backref" href="#id1799">Semantics:</a><a class="headerlink" href="#id173" title="Permalink to this headline">¶</a></h5>
<p>The truth table used for the ‘<code class="docutils literal notranslate"><span class="pre">xor</span></code>’ instruction is:</p>
<table class="docutils align-default">
<colgroup>
<col style="width: 33%" />
<col style="width: 33%" />
<col style="width: 33%" />
</colgroup>
<tbody>
<tr class="row-odd"><td><p>In0</p></td>
<td><p>In1</p></td>
<td><p>Out</p></td>
</tr>
<tr class="row-even"><td><p>0</p></td>
<td><p>0</p></td>
<td><p>0</p></td>
</tr>
<tr class="row-odd"><td><p>0</p></td>
<td><p>1</p></td>
<td><p>1</p></td>
</tr>
<tr class="row-even"><td><p>1</p></td>
<td><p>0</p></td>
<td><p>1</p></td>
</tr>
<tr class="row-odd"><td><p>1</p></td>
<td><p>1</p></td>
<td><p>0</p></td>
</tr>
</tbody>
</table>
</div>
<div class="section" id="id174">
<h5><a class="toc-backref" href="#id1800">Example:</a><a class="headerlink" href="#id174" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = xor i32 4, %var ; yields i32:result = 4 ^ %var
<result> = xor i32 15, 40 ; yields i32:result = 39
<result> = xor i32 4, 8 ; yields i32:result = 12
<result> = xor i32 %V, -1 ; yields i32:result = ~%V
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="vector-operations">
<h3><a class="toc-backref" href="#id1801">Vector Operations</a><a class="headerlink" href="#vector-operations" title="Permalink to this headline">¶</a></h3>
<p>LLVM supports several instructions to represent vector operations in a
target-independent manner. These instructions cover the element-access
and vector-specific operations needed to process vectors effectively.
While LLVM does directly support these vector operations, many
sophisticated algorithms will want to use target-specific intrinsics to
take full advantage of a specific target.</p>
<div class="section" id="extractelement-instruction">
<span id="i-extractelement"></span><h4><a class="toc-backref" href="#id1802">‘<code class="docutils literal notranslate"><span class="pre">extractelement</span></code>’ Instruction</a><a class="headerlink" href="#extractelement-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id175">
<h5><a class="toc-backref" href="#id1803">Syntax:</a><a class="headerlink" href="#id175" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">extractelement</span> <span class="o"><</span><span class="n">n</span> <span class="n">x</span> <span class="o"><</span><span class="n">ty</span><span class="o">>></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">ty2</span><span class="o">></span> <span class="o"><</span><span class="n">idx</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">extractelement</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="n">n</span> <span class="n">x</span> <span class="o"><</span><span class="n">ty</span><span class="o">>></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">ty2</span><span class="o">></span> <span class="o"><</span><span class="n">idx</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span>
</pre></div>
</div>
</div>
<div class="section" id="id176">
<h5><a class="toc-backref" href="#id1804">Overview:</a><a class="headerlink" href="#id176" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">extractelement</span></code>’ instruction extracts a single scalar element
from a vector at a specified index.</p>
</div>
<div class="section" id="id177">
<h5><a class="toc-backref" href="#id1805">Arguments:</a><a class="headerlink" href="#id177" title="Permalink to this headline">¶</a></h5>
<p>The first operand of an ‘<code class="docutils literal notranslate"><span class="pre">extractelement</span></code>’ instruction is a value of
<a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> type. The second operand is an index indicating
the position from which to extract the element. The index may be a
variable of any integer type.</p>
</div>
<div class="section" id="id178">
<h5><a class="toc-backref" href="#id1806">Semantics:</a><a class="headerlink" href="#id178" title="Permalink to this headline">¶</a></h5>
<p>The result is a scalar of the same type as the element type of <code class="docutils literal notranslate"><span class="pre">val</span></code>.
Its value is the value at position <code class="docutils literal notranslate"><span class="pre">idx</span></code> of <code class="docutils literal notranslate"><span class="pre">val</span></code>. If <code class="docutils literal notranslate"><span class="pre">idx</span></code>
exceeds the length of <code class="docutils literal notranslate"><span class="pre">val</span></code> for a fixed-length vector, the result is a
<a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a>. For a scalable vector, if the value
of <code class="docutils literal notranslate"><span class="pre">idx</span></code> exceeds the runtime length of the vector, the result is a
<a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a>.</p>
</div>
<div class="section" id="id179">
<h5><a class="toc-backref" href="#id1807">Example:</a><a class="headerlink" href="#id179" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = extractelement <4 x i32> %vec, i32 0 ; yields i32
</pre></div>
</div>
</div>
</div>
<div class="section" id="insertelement-instruction">
<span id="i-insertelement"></span><h4><a class="toc-backref" href="#id1808">‘<code class="docutils literal notranslate"><span class="pre">insertelement</span></code>’ Instruction</a><a class="headerlink" href="#insertelement-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id180">
<h5><a class="toc-backref" href="#id1809">Syntax:</a><a class="headerlink" href="#id180" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">insertelement</span> <span class="o"><</span><span class="n">n</span> <span class="n">x</span> <span class="o"><</span><span class="n">ty</span><span class="o">>></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">elt</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">ty2</span><span class="o">></span> <span class="o"><</span><span class="n">idx</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="o"><</span><span class="n">n</span> <span class="n">x</span> <span class="o"><</span><span class="n">ty</span><span class="o">>></span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">insertelement</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="n">n</span> <span class="n">x</span> <span class="o"><</span><span class="n">ty</span><span class="o">>></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">elt</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">ty2</span><span class="o">></span> <span class="o"><</span><span class="n">idx</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="n">n</span> <span class="n">x</span> <span class="o"><</span><span class="n">ty</span><span class="o">>></span>
</pre></div>
</div>
</div>
<div class="section" id="id181">
<h5><a class="toc-backref" href="#id1810">Overview:</a><a class="headerlink" href="#id181" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">insertelement</span></code>’ instruction inserts a scalar element into a
vector at a specified index.</p>
</div>
<div class="section" id="id182">
<h5><a class="toc-backref" href="#id1811">Arguments:</a><a class="headerlink" href="#id182" title="Permalink to this headline">¶</a></h5>
<p>The first operand of an ‘<code class="docutils literal notranslate"><span class="pre">insertelement</span></code>’ instruction is a value of
<a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> type. The second operand is a scalar value whose
type must equal the element type of the first operand. The third operand
is an index indicating the position at which to insert the value. The
index may be a variable of any integer type.</p>
</div>
<div class="section" id="id183">
<h5><a class="toc-backref" href="#id1812">Semantics:</a><a class="headerlink" href="#id183" title="Permalink to this headline">¶</a></h5>
<p>The result is a vector of the same type as <code class="docutils literal notranslate"><span class="pre">val</span></code>. Its element values
are those of <code class="docutils literal notranslate"><span class="pre">val</span></code> except at position <code class="docutils literal notranslate"><span class="pre">idx</span></code>, where it gets the value
<code class="docutils literal notranslate"><span class="pre">elt</span></code>. If <code class="docutils literal notranslate"><span class="pre">idx</span></code> exceeds the length of <code class="docutils literal notranslate"><span class="pre">val</span></code> for a fixed-length vector,
the result is a <a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a>. For a scalable vector,
if the value of <code class="docutils literal notranslate"><span class="pre">idx</span></code> exceeds the runtime length of the vector, the result
is a <a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a>.</p>
</div>
<div class="section" id="id184">
<h5><a class="toc-backref" href="#id1813">Example:</a><a class="headerlink" href="#id184" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = insertelement <4 x i32> %vec, i32 1, i32 0 ; yields <4 x i32>
</pre></div>
</div>
</div>
</div>
<div class="section" id="shufflevector-instruction">
<span id="i-shufflevector"></span><h4><a class="toc-backref" href="#id1814">‘<code class="docutils literal notranslate"><span class="pre">shufflevector</span></code>’ Instruction</a><a class="headerlink" href="#shufflevector-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id185">
<h5><a class="toc-backref" href="#id1815">Syntax:</a><a class="headerlink" href="#id185" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">shufflevector</span> <span class="o"><</span><span class="n">n</span> <span class="n">x</span> <span class="o"><</span><span class="n">ty</span><span class="o">>></span> <span class="o"><</span><span class="n">v1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">n</span> <span class="n">x</span> <span class="o"><</span><span class="n">ty</span><span class="o">>></span> <span class="o"><</span><span class="n">v2</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">m</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="o"><</span><span class="n">m</span> <span class="n">x</span> <span class="o"><</span><span class="n">ty</span><span class="o">>></span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">shufflevector</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="n">n</span> <span class="n">x</span> <span class="o"><</span><span class="n">ty</span><span class="o">>></span> <span class="o"><</span><span class="n">v1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="n">n</span> <span class="n">x</span> <span class="o"><</span><span class="n">ty</span><span class="o">>></span> <span class="n">v2</span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="n">m</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="n">m</span> <span class="n">x</span> <span class="o"><</span><span class="n">ty</span><span class="o">>></span>
</pre></div>
</div>
</div>
<div class="section" id="id186">
<h5><a class="toc-backref" href="#id1816">Overview:</a><a class="headerlink" href="#id186" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">shufflevector</span></code>’ instruction constructs a permutation of elements
from two input vectors, returning a vector with the same element type as
the input and length that is the same as the shuffle mask.</p>
</div>
<div class="section" id="id187">
<h5><a class="toc-backref" href="#id1817">Arguments:</a><a class="headerlink" href="#id187" title="Permalink to this headline">¶</a></h5>
<p>The first two operands of a ‘<code class="docutils literal notranslate"><span class="pre">shufflevector</span></code>’ instruction are vectors
with the same type. The third argument is a shuffle mask vector constant
whose element type is <code class="docutils literal notranslate"><span class="pre">i32</span></code>. The mask vector elements must be constant
integers or <code class="docutils literal notranslate"><span class="pre">undef</span></code> values. The result of the instruction is a vector
whose length is the same as the shuffle mask and whose element type is the
same as the element type of the first two operands.</p>
</div>
<div class="section" id="id188">
<h5><a class="toc-backref" href="#id1818">Semantics:</a><a class="headerlink" href="#id188" title="Permalink to this headline">¶</a></h5>
<p>The elements of the two input vectors are numbered from left to right
across both of the vectors. For each element of the result vector, the
shuffle mask selects an element from one of the input vectors to copy
to the result. Non-negative elements in the mask represent an index
into the concatenated pair of input vectors.</p>
<p>If the shuffle mask is undefined, the result vector is undefined. If
the shuffle mask selects an undefined element from one of the input
vectors, the resulting element is undefined. An undefined element
in the mask vector specifies that the resulting element is undefined.
An undefined element in the mask vector prevents a poisoned vector
element from propagating.</p>
<p>For scalable vectors, the only valid mask values at present are
<code class="docutils literal notranslate"><span class="pre">zeroinitializer</span></code> and <code class="docutils literal notranslate"><span class="pre">undef</span></code>, since we cannot write all indices as
literals for a vector with a length unknown at compile time.</p>
</div>
<div class="section" id="id189">
<h5><a class="toc-backref" href="#id1819">Example:</a><a class="headerlink" href="#id189" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = shufflevector <4 x i32> %v1, <4 x i32> %v2,
<4 x i32> <i32 0, i32 4, i32 1, i32 5> ; yields <4 x i32>
<result> = shufflevector <4 x i32> %v1, <4 x i32> undef,
<4 x i32> <i32 0, i32 1, i32 2, i32 3> ; yields <4 x i32> - Identity shuffle.
<result> = shufflevector <8 x i32> %v1, <8 x i32> undef,
<4 x i32> <i32 0, i32 1, i32 2, i32 3> ; yields <4 x i32>
<result> = shufflevector <4 x i32> %v1, <4 x i32> %v2,
<8 x i32> <i32 0, i32 1, i32 2, i32 3, i32 4, i32 5, i32 6, i32 7 > ; yields <8 x i32>
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="aggregate-operations">
<h3><a class="toc-backref" href="#id1820">Aggregate Operations</a><a class="headerlink" href="#aggregate-operations" title="Permalink to this headline">¶</a></h3>
<p>LLVM supports several instructions for working with
<a class="reference internal" href="#t-aggregate"><span class="std std-ref">aggregate</span></a> values.</p>
<div class="section" id="extractvalue-instruction">
<span id="i-extractvalue"></span><h4><a class="toc-backref" href="#id1821">‘<code class="docutils literal notranslate"><span class="pre">extractvalue</span></code>’ Instruction</a><a class="headerlink" href="#extractvalue-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id190">
<h5><a class="toc-backref" href="#id1822">Syntax:</a><a class="headerlink" href="#id190" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">extractvalue</span> <span class="o"><</span><span class="n">aggregate</span> <span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">idx</span><span class="o">></span><span class="p">{,</span> <span class="o"><</span><span class="n">idx</span><span class="o">></span><span class="p">}</span><span class="o">*</span>
</pre></div>
</div>
</div>
<div class="section" id="id191">
<h5><a class="toc-backref" href="#id1823">Overview:</a><a class="headerlink" href="#id191" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">extractvalue</span></code>’ instruction extracts the value of a member field
from an <a class="reference internal" href="#t-aggregate"><span class="std std-ref">aggregate</span></a> value.</p>
</div>
<div class="section" id="id192">
<h5><a class="toc-backref" href="#id1824">Arguments:</a><a class="headerlink" href="#id192" title="Permalink to this headline">¶</a></h5>
<p>The first operand of an ‘<code class="docutils literal notranslate"><span class="pre">extractvalue</span></code>’ instruction is a value of
<a class="reference internal" href="#t-struct"><span class="std std-ref">struct</span></a> or <a class="reference internal" href="#t-array"><span class="std std-ref">array</span></a> type. The other operands are
constant indices to specify which value to extract in a similar manner
as indices in a ‘<code class="docutils literal notranslate"><span class="pre">getelementptr</span></code>’ instruction.</p>
<p>The major differences to <code class="docutils literal notranslate"><span class="pre">getelementptr</span></code> indexing are:</p>
<ul class="simple">
<li><p>Since the value being indexed is not a pointer, the first index is
omitted and assumed to be zero.</p></li>
<li><p>At least one index must be specified.</p></li>
<li><p>Not only struct indices but also array indices must be in bounds.</p></li>
</ul>
</div>
<div class="section" id="id193">
<h5><a class="toc-backref" href="#id1825">Semantics:</a><a class="headerlink" href="#id193" title="Permalink to this headline">¶</a></h5>
<p>The result is the value at the position in the aggregate specified by
the index operands.</p>
</div>
<div class="section" id="id194">
<h5><a class="toc-backref" href="#id1826">Example:</a><a class="headerlink" href="#id194" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = extractvalue {i32, float} %agg, 0 ; yields i32
</pre></div>
</div>
</div>
</div>
<div class="section" id="insertvalue-instruction">
<span id="i-insertvalue"></span><h4><a class="toc-backref" href="#id1827">‘<code class="docutils literal notranslate"><span class="pre">insertvalue</span></code>’ Instruction</a><a class="headerlink" href="#insertvalue-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id195">
<h5><a class="toc-backref" href="#id1828">Syntax:</a><a class="headerlink" href="#id195" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">insertvalue</span> <span class="o"><</span><span class="n">aggregate</span> <span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">elt</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">idx</span><span class="o">></span><span class="p">{,</span> <span class="o"><</span><span class="n">idx</span><span class="o">></span><span class="p">}</span><span class="o">*</span> <span class="p">;</span> <span class="n">yields</span> <span class="o"><</span><span class="n">aggregate</span> <span class="nb">type</span><span class="o">></span>
</pre></div>
</div>
</div>
<div class="section" id="id196">
<h5><a class="toc-backref" href="#id1829">Overview:</a><a class="headerlink" href="#id196" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">insertvalue</span></code>’ instruction inserts a value into a member field in
an <a class="reference internal" href="#t-aggregate"><span class="std std-ref">aggregate</span></a> value.</p>
</div>
<div class="section" id="id197">
<h5><a class="toc-backref" href="#id1830">Arguments:</a><a class="headerlink" href="#id197" title="Permalink to this headline">¶</a></h5>
<p>The first operand of an ‘<code class="docutils literal notranslate"><span class="pre">insertvalue</span></code>’ instruction is a value of
<a class="reference internal" href="#t-struct"><span class="std std-ref">struct</span></a> or <a class="reference internal" href="#t-array"><span class="std std-ref">array</span></a> type. The second operand is
a first-class value to insert. The following operands are constant
indices indicating the position at which to insert the value in a
similar manner as indices in a ‘<code class="docutils literal notranslate"><span class="pre">extractvalue</span></code>’ instruction. The value
to insert must have the same type as the value identified by the
indices.</p>
</div>
<div class="section" id="id198">
<h5><a class="toc-backref" href="#id1831">Semantics:</a><a class="headerlink" href="#id198" title="Permalink to this headline">¶</a></h5>
<p>The result is an aggregate of the same type as <code class="docutils literal notranslate"><span class="pre">val</span></code>. Its value is
that of <code class="docutils literal notranslate"><span class="pre">val</span></code> except that the value at the position specified by the
indices is that of <code class="docutils literal notranslate"><span class="pre">elt</span></code>.</p>
</div>
<div class="section" id="id199">
<h5><a class="toc-backref" href="#id1832">Example:</a><a class="headerlink" href="#id199" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%agg1</span> <span class="p">=</span> <span class="k">insertvalue</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="k">float</span><span class="p">}</span> <span class="k">undef</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">,</span> <span class="m">0</span> <span class="c">; yields {i32 1, float undef}</span>
<span class="nv">%agg2</span> <span class="p">=</span> <span class="k">insertvalue</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="k">float</span><span class="p">}</span> <span class="nv">%agg1</span><span class="p">,</span> <span class="k">float</span> <span class="nv">%val</span><span class="p">,</span> <span class="m">1</span> <span class="c">; yields {i32 1, float %val}</span>
<span class="nv">%agg3</span> <span class="p">=</span> <span class="k">insertvalue</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="p">{</span><span class="k">float</span><span class="p">}}</span> <span class="k">undef</span><span class="p">,</span> <span class="k">float</span> <span class="nv">%val</span><span class="p">,</span> <span class="m">1</span><span class="p">,</span> <span class="m">0</span> <span class="c">; yields {i32 undef, {float %val}}</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="memory-access-and-addressing-operations">
<span id="memoryops"></span><h3><a class="toc-backref" href="#id1833">Memory Access and Addressing Operations</a><a class="headerlink" href="#memory-access-and-addressing-operations" title="Permalink to this headline">¶</a></h3>
<p>A key design point of an SSA-based representation is how it represents
memory. In LLVM, no memory locations are in SSA form, which makes things
very simple. This section describes how to read, write, and allocate
memory in LLVM.</p>
<div class="section" id="alloca-instruction">
<span id="i-alloca"></span><h4><a class="toc-backref" href="#id1834">‘<code class="docutils literal notranslate"><span class="pre">alloca</span></code>’ Instruction</a><a class="headerlink" href="#alloca-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id200">
<h5><a class="toc-backref" href="#id1835">Syntax:</a><a class="headerlink" href="#id200" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">alloca</span> <span class="p">[</span><span class="n">inalloca</span><span class="p">]</span> <span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="p">[,</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">NumElements</span><span class="o">></span><span class="p">]</span> <span class="p">[,</span> <span class="n">align</span> <span class="o"><</span><span class="n">alignment</span><span class="o">></span><span class="p">]</span> <span class="p">[,</span> <span class="n">addrspace</span><span class="p">(</span><span class="o"><</span><span class="n">num</span><span class="o">></span><span class="p">)]</span> <span class="p">;</span> <span class="n">yields</span> <span class="nb">type</span> <span class="n">addrspace</span><span class="p">(</span><span class="n">num</span><span class="p">)</span><span class="o">*</span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id201">
<h5><a class="toc-backref" href="#id1836">Overview:</a><a class="headerlink" href="#id201" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">alloca</span></code>’ instruction allocates memory on the stack frame of the
currently executing function, to be automatically released when this
function returns to its caller. If the address space is not explicitly
specified, the object is allocated in the alloca address space from the
<a class="reference internal" href="#langref-datalayout"><span class="std std-ref">datalayout string</span></a>.</p>
</div>
<div class="section" id="id202">
<h5><a class="toc-backref" href="#id1837">Arguments:</a><a class="headerlink" href="#id202" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">alloca</span></code>’ instruction allocates <code class="docutils literal notranslate"><span class="pre">sizeof(<type>)*NumElements</span></code>
bytes of memory on the runtime stack, returning a pointer of the
appropriate type to the program. If “NumElements” is specified, it is
the number of elements allocated, otherwise “NumElements” is defaulted
to be one. If a constant alignment is specified, the value result of the
allocation is guaranteed to be aligned to at least that boundary. The
alignment may not be greater than <code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre"><<</span> <span class="pre">29</span></code>. If not specified, or if
zero, the target can choose to align the allocation on any convenient
boundary compatible with the type.</p>
<p>‘<code class="docutils literal notranslate"><span class="pre">type</span></code>’ may be any sized type.</p>
</div>
<div class="section" id="id203">
<h5><a class="toc-backref" href="#id1838">Semantics:</a><a class="headerlink" href="#id203" title="Permalink to this headline">¶</a></h5>
<p>Memory is allocated; a pointer is returned. The allocated memory is
uninitialized, and loading from uninitialized memory produces an undefined
value. The operation itself is undefined if there is insufficient stack
space for the allocation.’<code class="docutils literal notranslate"><span class="pre">alloca</span></code>’d memory is automatically released
when the function returns. The ‘<code class="docutils literal notranslate"><span class="pre">alloca</span></code>’ instruction is commonly used
to represent automatic variables that must have an address available. When
the function returns (either with the <code class="docutils literal notranslate"><span class="pre">ret</span></code> or <code class="docutils literal notranslate"><span class="pre">resume</span></code> instructions),
the memory is reclaimed. Allocating zero bytes is legal, but the returned
pointer may not be unique. The order in which memory is allocated (ie.,
which way the stack grows) is not specified.</p>
<p>Note that ‘<code class="docutils literal notranslate"><span class="pre">alloca</span></code>’ outside of the alloca address space from the
<a class="reference internal" href="#langref-datalayout"><span class="std std-ref">datalayout string</span></a> is meaningful only if the
target has assigned it a semantics.</p>
<p>If the returned pointer is used by <a class="reference internal" href="#int-lifestart"><span class="std std-ref">llvm.lifetime.start</span></a>,
the returned object is initially dead.
See <a class="reference internal" href="#int-lifestart"><span class="std std-ref">llvm.lifetime.start</span></a> and
<a class="reference internal" href="#int-lifeend"><span class="std std-ref">llvm.lifetime.end</span></a> for the precise semantics of
lifetime-manipulating intrinsics.</p>
</div>
<div class="section" id="id204">
<h5><a class="toc-backref" href="#id1839">Example:</a><a class="headerlink" href="#id204" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%ptr</span> <span class="p">=</span> <span class="k">alloca</span> <span class="k">i32</span> <span class="c">; yields i32*:ptr</span>
<span class="nv">%ptr</span> <span class="p">=</span> <span class="k">alloca</span> <span class="k">i32</span><span class="p">,</span> <span class="k">i32</span> <span class="m">4</span> <span class="c">; yields i32*:ptr</span>
<span class="nv">%ptr</span> <span class="p">=</span> <span class="k">alloca</span> <span class="k">i32</span><span class="p">,</span> <span class="k">i32</span> <span class="m">4</span><span class="p">,</span> <span class="k">align</span> <span class="m">1024</span> <span class="c">; yields i32*:ptr</span>
<span class="nv">%ptr</span> <span class="p">=</span> <span class="k">alloca</span> <span class="k">i32</span><span class="p">,</span> <span class="k">align</span> <span class="m">1024</span> <span class="c">; yields i32*:ptr</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="load-instruction">
<span id="i-load"></span><h4><a class="toc-backref" href="#id1840">‘<code class="docutils literal notranslate"><span class="pre">load</span></code>’ Instruction</a><a class="headerlink" href="#load-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id205">
<h5><a class="toc-backref" href="#id1841">Syntax:</a><a class="headerlink" href="#id205" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><result> = load [volatile] <ty>, <ty>* <pointer>[, align <alignment>][, !nontemporal !<nontemp_node>][, !invariant.load !<empty_node>][, !invariant.group !<empty_node>][, !nonnull !<empty_node>][, !dereferenceable !<deref_bytes_node>][, !dereferenceable_or_null !<deref_bytes_node>][, !align !<align_node>][, !noundef !<empty_node>]
<result> = load atomic [volatile] <ty>, <ty>* <pointer> [syncscope("<target-scope>")] <ordering>, align <alignment> [, !invariant.group !<empty_node>]
!<nontemp_node> = !{ i32 1 }
!<empty_node> = !{}
!<deref_bytes_node> = !{ i64 <dereferenceable_bytes> }
!<align_node> = !{ i64 <value_alignment> }
</pre></div>
</div>
</div>
<div class="section" id="id206">
<h5><a class="toc-backref" href="#id1842">Overview:</a><a class="headerlink" href="#id206" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">load</span></code>’ instruction is used to read from memory.</p>
</div>
<div class="section" id="id207">
<h5><a class="toc-backref" href="#id1843">Arguments:</a><a class="headerlink" href="#id207" title="Permalink to this headline">¶</a></h5>
<p>The argument to the <code class="docutils literal notranslate"><span class="pre">load</span></code> instruction specifies the memory address from which
to load. The type specified must be a <a class="reference internal" href="#t-firstclass"><span class="std std-ref">first class</span></a> type of
known size (i.e. not containing an <a class="reference internal" href="#t-opaque"><span class="std std-ref">opaque structural type</span></a>). If
the <code class="docutils literal notranslate"><span class="pre">load</span></code> is marked as <code class="docutils literal notranslate"><span class="pre">volatile</span></code>, then the optimizer is not allowed to
modify the number or order of execution of this <code class="docutils literal notranslate"><span class="pre">load</span></code> with other
<a class="reference internal" href="#volatile"><span class="std std-ref">volatile operations</span></a>.</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">load</span></code> is marked as <code class="docutils literal notranslate"><span class="pre">atomic</span></code>, it takes an extra <a class="reference internal" href="#ordering"><span class="std std-ref">ordering</span></a> and optional <code class="docutils literal notranslate"><span class="pre">syncscope("<target-scope>")</span></code> argument. The
<code class="docutils literal notranslate"><span class="pre">release</span></code> and <code class="docutils literal notranslate"><span class="pre">acq_rel</span></code> orderings are not valid on <code class="docutils literal notranslate"><span class="pre">load</span></code> instructions.
Atomic loads produce <a class="reference internal" href="#memmodel"><span class="std std-ref">defined</span></a> results when they may see
multiple atomic stores. The type of the pointee must be an integer, pointer, or
floating-point type whose bit width is a power of two greater than or equal to
eight and less than or equal to a target-specific size limit. <code class="docutils literal notranslate"><span class="pre">align</span></code> must be
explicitly specified on atomic loads, and the load has undefined behavior if the
alignment is not set to a value which is at least the size in bytes of the
pointee. <code class="docutils literal notranslate"><span class="pre">!nontemporal</span></code> does not have any defined semantics for atomic loads.</p>
<p>The optional constant <code class="docutils literal notranslate"><span class="pre">align</span></code> argument specifies the alignment of the
operation (that is, the alignment of the memory address). A value of 0
or an omitted <code class="docutils literal notranslate"><span class="pre">align</span></code> argument means that the operation has the ABI
alignment for the target. It is the responsibility of the code emitter
to ensure that the alignment information is correct. Overestimating the
alignment results in undefined behavior. Underestimating the alignment
may produce less efficient code. An alignment of 1 is always safe. The
maximum possible alignment is <code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre"><<</span> <span class="pre">29</span></code>. An alignment value higher
than the size of the loaded type implies memory up to the alignment
value bytes can be safely loaded without trapping in the default
address space. Access of the high bytes can interfere with debugging
tools, so should not be accessed if the function has the
<code class="docutils literal notranslate"><span class="pre">sanitize_thread</span></code> or <code class="docutils literal notranslate"><span class="pre">sanitize_address</span></code> attributes.</p>
<p>The optional <code class="docutils literal notranslate"><span class="pre">!nontemporal</span></code> metadata must reference a single
metadata name <code class="docutils literal notranslate"><span class="pre"><nontemp_node></span></code> corresponding to a metadata node with one
<code class="docutils literal notranslate"><span class="pre">i32</span></code> entry of value 1. The existence of the <code class="docutils literal notranslate"><span class="pre">!nontemporal</span></code>
metadata on the instruction tells the optimizer and code generator
that this load is not expected to be reused in the cache. The code
generator may select special instructions to save cache bandwidth, such
as the <code class="docutils literal notranslate"><span class="pre">MOVNT</span></code> instruction on x86.</p>
<p>The optional <code class="docutils literal notranslate"><span class="pre">!invariant.load</span></code> metadata must reference a single
metadata name <code class="docutils literal notranslate"><span class="pre"><empty_node></span></code> corresponding to a metadata node with no
entries. If a load instruction tagged with the <code class="docutils literal notranslate"><span class="pre">!invariant.load</span></code>
metadata is executed, the memory location referenced by the load has
to contain the same value at all points in the program where the
memory location is dereferenceable; otherwise, the behavior is
undefined.</p>
<dl class="simple">
<dt>The optional <code class="docutils literal notranslate"><span class="pre">!invariant.group</span></code> metadata must reference a single metadata name</dt><dd><p><code class="docutils literal notranslate"><span class="pre"><empty_node></span></code> corresponding to a metadata node with no entries.
See <code class="docutils literal notranslate"><span class="pre">invariant.group</span></code> metadata <a class="reference internal" href="#md-invariant-group"><span class="std std-ref">invariant.group</span></a>.</p>
</dd>
</dl>
<p>The optional <code class="docutils literal notranslate"><span class="pre">!nonnull</span></code> metadata must reference a single
metadata name <code class="docutils literal notranslate"><span class="pre"><empty_node></span></code> corresponding to a metadata node with no
entries. The existence of the <code class="docutils literal notranslate"><span class="pre">!nonnull</span></code> metadata on the
instruction tells the optimizer that the value loaded is known to
never be null. If the value is null at runtime, the behavior is undefined.
This is analogous to the <code class="docutils literal notranslate"><span class="pre">nonnull</span></code> attribute on parameters and return
values. This metadata can only be applied to loads of a pointer type.</p>
<p>The optional <code class="docutils literal notranslate"><span class="pre">!dereferenceable</span></code> metadata must reference a single metadata
name <code class="docutils literal notranslate"><span class="pre"><deref_bytes_node></span></code> corresponding to a metadata node with one <code class="docutils literal notranslate"><span class="pre">i64</span></code>
entry.
See <code class="docutils literal notranslate"><span class="pre">dereferenceable</span></code> metadata <a class="reference internal" href="#md-dereferenceable"><span class="std std-ref">dereferenceable</span></a>.</p>
<p>The optional <code class="docutils literal notranslate"><span class="pre">!dereferenceable_or_null</span></code> metadata must reference a single
metadata name <code class="docutils literal notranslate"><span class="pre"><deref_bytes_node></span></code> corresponding to a metadata node with one
<code class="docutils literal notranslate"><span class="pre">i64</span></code> entry.
See <code class="docutils literal notranslate"><span class="pre">dereferenceable_or_null</span></code> metadata <a class="reference internal" href="#md-dereferenceable-or-null"><span class="std std-ref">dereferenceable_or_null</span></a>.</p>
<p>The optional <code class="docutils literal notranslate"><span class="pre">!align</span></code> metadata must reference a single metadata name
<code class="docutils literal notranslate"><span class="pre"><align_node></span></code> corresponding to a metadata node with one <code class="docutils literal notranslate"><span class="pre">i64</span></code> entry.
The existence of the <code class="docutils literal notranslate"><span class="pre">!align</span></code> metadata on the instruction tells the
optimizer that the value loaded is known to be aligned to a boundary specified
by the integer value in the metadata node. The alignment must be a power of 2.
This is analogous to the ‘’align’’ attribute on parameters and return values.
This metadata can only be applied to loads of a pointer type. If the returned
value is not appropriately aligned at runtime, the behavior is undefined.</p>
<p>The optional <code class="docutils literal notranslate"><span class="pre">!noundef</span></code> metadata must reference a single metadata name
<code class="docutils literal notranslate"><span class="pre"><empty_node></span></code> corresponding to a node with no entries. The existence of
<code class="docutils literal notranslate"><span class="pre">!noundef</span></code> metadata on the instruction tells the optimizer that the value
loaded is known to be <a class="reference internal" href="#welldefinedvalues"><span class="std std-ref">well defined</span></a>.
If the value isn’t well defined, the behavior is undefined.</p>
</div>
<div class="section" id="id208">
<h5><a class="toc-backref" href="#id1844">Semantics:</a><a class="headerlink" href="#id208" title="Permalink to this headline">¶</a></h5>
<p>The location of memory pointed to is loaded. If the value being loaded
is of scalar type then the number of bytes read does not exceed the
minimum number of bytes needed to hold all bits of the type. For
example, loading an <code class="docutils literal notranslate"><span class="pre">i24</span></code> reads at most three bytes. When loading a
value of a type like <code class="docutils literal notranslate"><span class="pre">i20</span></code> with a size that is not an integral number
of bytes, the result is undefined if the value was not originally
written using a store of the same type.
If the value being loaded is of aggregate type, the bytes that correspond to
padding may be accessed but are ignored, because it is impossible to observe
padding from the loaded aggregate value.
If <code class="docutils literal notranslate"><span class="pre"><pointer></span></code> is not a well-defined value, the behavior is undefined.</p>
</div>
<div class="section" id="id209">
<h5><a class="toc-backref" href="#id1845">Examples:</a><a class="headerlink" href="#id209" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%ptr</span> <span class="p">=</span> <span class="k">alloca</span> <span class="k">i32</span> <span class="c">; yields i32*:ptr</span>
<span class="k">store</span> <span class="k">i32</span> <span class="m">3</span><span class="p">,</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%ptr</span> <span class="c">; yields void</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">%ptr</span> <span class="c">; yields i32:val = i32 3</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="store-instruction">
<span id="i-store"></span><h4><a class="toc-backref" href="#id1846">‘<code class="docutils literal notranslate"><span class="pre">store</span></code>’ Instruction</a><a class="headerlink" href="#store-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id210">
<h5><a class="toc-backref" href="#id1847">Syntax:</a><a class="headerlink" href="#id210" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>store [volatile] <ty> <value>, <ty>* <pointer>[, align <alignment>][, !nontemporal !<nontemp_node>][, !invariant.group !<empty_node>] ; yields void
store atomic [volatile] <ty> <value>, <ty>* <pointer> [syncscope("<target-scope>")] <ordering>, align <alignment> [, !invariant.group !<empty_node>] ; yields void
!<nontemp_node> = !{ i32 1 }
!<empty_node> = !{}
</pre></div>
</div>
</div>
<div class="section" id="id211">
<h5><a class="toc-backref" href="#id1848">Overview:</a><a class="headerlink" href="#id211" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">store</span></code>’ instruction is used to write to memory.</p>
</div>
<div class="section" id="id212">
<h5><a class="toc-backref" href="#id1849">Arguments:</a><a class="headerlink" href="#id212" title="Permalink to this headline">¶</a></h5>
<p>There are two arguments to the <code class="docutils literal notranslate"><span class="pre">store</span></code> instruction: a value to store and an
address at which to store it. The type of the <code class="docutils literal notranslate"><span class="pre"><pointer></span></code> operand must be a
pointer to the <a class="reference internal" href="#t-firstclass"><span class="std std-ref">first class</span></a> type of the <code class="docutils literal notranslate"><span class="pre"><value></span></code>
operand. If the <code class="docutils literal notranslate"><span class="pre">store</span></code> is marked as <code class="docutils literal notranslate"><span class="pre">volatile</span></code>, then the optimizer is not
allowed to modify the number or order of execution of this <code class="docutils literal notranslate"><span class="pre">store</span></code> with other
<a class="reference internal" href="#volatile"><span class="std std-ref">volatile operations</span></a>. Only values of <a class="reference internal" href="#t-firstclass"><span class="std std-ref">first class</span></a> types of known size (i.e. not containing an <a class="reference internal" href="#t-opaque"><span class="std std-ref">opaque
structural type</span></a>) can be stored.</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">store</span></code> is marked as <code class="docutils literal notranslate"><span class="pre">atomic</span></code>, it takes an extra <a class="reference internal" href="#ordering"><span class="std std-ref">ordering</span></a> and optional <code class="docutils literal notranslate"><span class="pre">syncscope("<target-scope>")</span></code> argument. The
<code class="docutils literal notranslate"><span class="pre">acquire</span></code> and <code class="docutils literal notranslate"><span class="pre">acq_rel</span></code> orderings aren’t valid on <code class="docutils literal notranslate"><span class="pre">store</span></code> instructions.
Atomic loads produce <a class="reference internal" href="#memmodel"><span class="std std-ref">defined</span></a> results when they may see
multiple atomic stores. The type of the pointee must be an integer, pointer, or
floating-point type whose bit width is a power of two greater than or equal to
eight and less than or equal to a target-specific size limit. <code class="docutils literal notranslate"><span class="pre">align</span></code> must be
explicitly specified on atomic stores, and the store has undefined behavior if
the alignment is not set to a value which is at least the size in bytes of the
pointee. <code class="docutils literal notranslate"><span class="pre">!nontemporal</span></code> does not have any defined semantics for atomic stores.</p>
<p>The optional constant <code class="docutils literal notranslate"><span class="pre">align</span></code> argument specifies the alignment of the
operation (that is, the alignment of the memory address). A value of 0
or an omitted <code class="docutils literal notranslate"><span class="pre">align</span></code> argument means that the operation has the ABI
alignment for the target. It is the responsibility of the code emitter
to ensure that the alignment information is correct. Overestimating the
alignment results in undefined behavior. Underestimating the
alignment may produce less efficient code. An alignment of 1 is always
safe. The maximum possible alignment is <code class="docutils literal notranslate"><span class="pre">1</span> <span class="pre"><<</span> <span class="pre">29</span></code>. An alignment
value higher than the size of the stored type implies memory up to the
alignment value bytes can be stored to without trapping in the default
address space. Storing to the higher bytes however may result in data
races if another thread can access the same address. Introducing a
data race is not allowed. Storing to the extra bytes is not allowed
even in situations where a data race is known to not exist if the
function has the <code class="docutils literal notranslate"><span class="pre">sanitize_address</span></code> attribute.</p>
<p>The optional <code class="docutils literal notranslate"><span class="pre">!nontemporal</span></code> metadata must reference a single metadata
name <code class="docutils literal notranslate"><span class="pre"><nontemp_node></span></code> corresponding to a metadata node with one <code class="docutils literal notranslate"><span class="pre">i32</span></code> entry
of value 1. The existence of the <code class="docutils literal notranslate"><span class="pre">!nontemporal</span></code> metadata on the instruction
tells the optimizer and code generator that this load is not expected to
be reused in the cache. The code generator may select special
instructions to save cache bandwidth, such as the <code class="docutils literal notranslate"><span class="pre">MOVNT</span></code> instruction on
x86.</p>
<p>The optional <code class="docutils literal notranslate"><span class="pre">!invariant.group</span></code> metadata must reference a
single metadata name <code class="docutils literal notranslate"><span class="pre"><empty_node></span></code>. See <code class="docutils literal notranslate"><span class="pre">invariant.group</span></code> metadata.</p>
</div>
<div class="section" id="id213">
<h5><a class="toc-backref" href="#id1850">Semantics:</a><a class="headerlink" href="#id213" title="Permalink to this headline">¶</a></h5>
<p>The contents of memory are updated to contain <code class="docutils literal notranslate"><span class="pre"><value></span></code> at the
location specified by the <code class="docutils literal notranslate"><span class="pre"><pointer></span></code> operand. If <code class="docutils literal notranslate"><span class="pre"><value></span></code> is
of scalar type then the number of bytes written does not exceed the
minimum number of bytes needed to hold all bits of the type. For
example, storing an <code class="docutils literal notranslate"><span class="pre">i24</span></code> writes at most three bytes. When writing a
value of a type like <code class="docutils literal notranslate"><span class="pre">i20</span></code> with a size that is not an integral number
of bytes, it is unspecified what happens to the extra bits that do not
belong to the type, but they will typically be overwritten.
If <code class="docutils literal notranslate"><span class="pre"><value></span></code> is of aggregate type, padding is filled with
<a class="reference internal" href="#undefvalues"><span class="std std-ref">undef</span></a>.
If <code class="docutils literal notranslate"><span class="pre"><pointer></span></code> is not a well-defined value, the behavior is undefined.</p>
</div>
<div class="section" id="id214">
<h5><a class="toc-backref" href="#id1851">Example:</a><a class="headerlink" href="#id214" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%ptr</span> <span class="p">=</span> <span class="k">alloca</span> <span class="k">i32</span> <span class="c">; yields i32*:ptr</span>
<span class="k">store</span> <span class="k">i32</span> <span class="m">3</span><span class="p">,</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%ptr</span> <span class="c">; yields void</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">%ptr</span> <span class="c">; yields i32:val = i32 3</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="fence-instruction">
<span id="i-fence"></span><h4><a class="toc-backref" href="#id1852">‘<code class="docutils literal notranslate"><span class="pre">fence</span></code>’ Instruction</a><a class="headerlink" href="#fence-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id215">
<h5><a class="toc-backref" href="#id1853">Syntax:</a><a class="headerlink" href="#id215" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">fence</span> <span class="p">[</span><span class="n">syncscope</span><span class="p">(</span><span class="s2">"<target-scope>"</span><span class="p">)]</span> <span class="o"><</span><span class="n">ordering</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">void</span>
</pre></div>
</div>
</div>
<div class="section" id="id216">
<h5><a class="toc-backref" href="#id1854">Overview:</a><a class="headerlink" href="#id216" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">fence</span></code>’ instruction is used to introduce happens-before edges
between operations.</p>
</div>
<div class="section" id="id217">
<h5><a class="toc-backref" href="#id1855">Arguments:</a><a class="headerlink" href="#id217" title="Permalink to this headline">¶</a></h5>
<p>‘<code class="docutils literal notranslate"><span class="pre">fence</span></code>’ instructions take an <a class="reference internal" href="#ordering"><span class="std std-ref">ordering</span></a> argument which
defines what <em>synchronizes-with</em> edges they add. They can only be given
<code class="docutils literal notranslate"><span class="pre">acquire</span></code>, <code class="docutils literal notranslate"><span class="pre">release</span></code>, <code class="docutils literal notranslate"><span class="pre">acq_rel</span></code>, and <code class="docutils literal notranslate"><span class="pre">seq_cst</span></code> orderings.</p>
</div>
<div class="section" id="id218">
<h5><a class="toc-backref" href="#id1856">Semantics:</a><a class="headerlink" href="#id218" title="Permalink to this headline">¶</a></h5>
<p>A fence A which has (at least) <code class="docutils literal notranslate"><span class="pre">release</span></code> ordering semantics
<em>synchronizes with</em> a fence B with (at least) <code class="docutils literal notranslate"><span class="pre">acquire</span></code> ordering
semantics if and only if there exist atomic operations X and Y, both
operating on some atomic object M, such that A is sequenced before X, X
modifies M (either directly or through some side effect of a sequence
headed by X), Y is sequenced before B, and Y observes M. This provides a
<em>happens-before</em> dependency between A and B. Rather than an explicit
<code class="docutils literal notranslate"><span class="pre">fence</span></code>, one (but not both) of the atomic operations X or Y might
provide a <code class="docutils literal notranslate"><span class="pre">release</span></code> or <code class="docutils literal notranslate"><span class="pre">acquire</span></code> (resp.) ordering constraint and
still <em>synchronize-with</em> the explicit <code class="docutils literal notranslate"><span class="pre">fence</span></code> and establish the
<em>happens-before</em> edge.</p>
<p>A <code class="docutils literal notranslate"><span class="pre">fence</span></code> which has <code class="docutils literal notranslate"><span class="pre">seq_cst</span></code> ordering, in addition to having both
<code class="docutils literal notranslate"><span class="pre">acquire</span></code> and <code class="docutils literal notranslate"><span class="pre">release</span></code> semantics specified above, participates in
the global program order of other <code class="docutils literal notranslate"><span class="pre">seq_cst</span></code> operations and/or fences.</p>
<p>A <code class="docutils literal notranslate"><span class="pre">fence</span></code> instruction can also take an optional
“<a class="reference internal" href="#syncscope"><span class="std std-ref">syncscope</span></a>” argument.</p>
</div>
<div class="section" id="id219">
<h5><a class="toc-backref" href="#id1857">Example:</a><a class="headerlink" href="#id219" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>fence acquire ; yields void
fence syncscope("singlethread") seq_cst ; yields void
fence syncscope("agent") seq_cst ; yields void
</pre></div>
</div>
</div>
</div>
<div class="section" id="cmpxchg-instruction">
<span id="i-cmpxchg"></span><h4><a class="toc-backref" href="#id1858">‘<code class="docutils literal notranslate"><span class="pre">cmpxchg</span></code>’ Instruction</a><a class="headerlink" href="#cmpxchg-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id220">
<h5><a class="toc-backref" href="#id1859">Syntax:</a><a class="headerlink" href="#id220" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">cmpxchg</span> <span class="p">[</span><span class="n">weak</span><span class="p">]</span> <span class="p">[</span><span class="n">volatile</span><span class="p">]</span> <span class="o"><</span><span class="n">ty</span><span class="o">>*</span> <span class="o"><</span><span class="n">pointer</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">cmp</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">new</span><span class="o">></span> <span class="p">[</span><span class="n">syncscope</span><span class="p">(</span><span class="s2">"<target-scope>"</span><span class="p">)]</span> <span class="o"><</span><span class="n">success</span> <span class="n">ordering</span><span class="o">></span> <span class="o"><</span><span class="n">failure</span> <span class="n">ordering</span><span class="o">></span><span class="p">[,</span> <span class="n">align</span> <span class="o"><</span><span class="n">alignment</span><span class="o">></span><span class="p">]</span> <span class="p">;</span> <span class="n">yields</span> <span class="p">{</span> <span class="n">ty</span><span class="p">,</span> <span class="n">i1</span> <span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="id221">
<h5><a class="toc-backref" href="#id1860">Overview:</a><a class="headerlink" href="#id221" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">cmpxchg</span></code>’ instruction is used to atomically modify memory. It
loads a value in memory and compares it to a given value. If they are
equal, it tries to store a new value into the memory.</p>
</div>
<div class="section" id="id222">
<h5><a class="toc-backref" href="#id1861">Arguments:</a><a class="headerlink" href="#id222" title="Permalink to this headline">¶</a></h5>
<p>There are three arguments to the ‘<code class="docutils literal notranslate"><span class="pre">cmpxchg</span></code>’ instruction: an address
to operate on, a value to compare to the value currently be at that
address, and a new value to place at that address if the compared values
are equal. The type of ‘<cmp>’ must be an integer or pointer type whose
bit width is a power of two greater than or equal to eight and less
than or equal to a target-specific size limit. ‘<cmp>’ and ‘<new>’ must
have the same type, and the type of ‘<pointer>’ must be a pointer to
that type. If the <code class="docutils literal notranslate"><span class="pre">cmpxchg</span></code> is marked as <code class="docutils literal notranslate"><span class="pre">volatile</span></code>, then the
optimizer is not allowed to modify the number or order of execution of
this <code class="docutils literal notranslate"><span class="pre">cmpxchg</span></code> with other <a class="reference internal" href="#volatile"><span class="std std-ref">volatile operations</span></a>.</p>
<p>The success and failure <a class="reference internal" href="#ordering"><span class="std std-ref">ordering</span></a> arguments specify how this
<code class="docutils literal notranslate"><span class="pre">cmpxchg</span></code> synchronizes with other atomic operations. Both ordering parameters
must be at least <code class="docutils literal notranslate"><span class="pre">monotonic</span></code>, the failure ordering cannot be either
<code class="docutils literal notranslate"><span class="pre">release</span></code> or <code class="docutils literal notranslate"><span class="pre">acq_rel</span></code>.</p>
<p>A <code class="docutils literal notranslate"><span class="pre">cmpxchg</span></code> instruction can also take an optional
“<a class="reference internal" href="#syncscope"><span class="std std-ref">syncscope</span></a>” argument.</p>
<p>The instruction can take an optional <code class="docutils literal notranslate"><span class="pre">align</span></code> attribute.
The alignment must be a power of two greater or equal to the size of the
<cite><value></cite> type. If unspecified, the alignment is assumed to be equal to the
size of the ‘<value>’ type. Note that this default alignment assumption is
different from the alignment used for the load/store instructions when align
isn’t specified.</p>
<p>The pointer passed into cmpxchg must have alignment greater than or
equal to the size in memory of the operand.</p>
</div>
<div class="section" id="id223">
<h5><a class="toc-backref" href="#id1862">Semantics:</a><a class="headerlink" href="#id223" title="Permalink to this headline">¶</a></h5>
<p>The contents of memory at the location specified by the ‘<code class="docutils literal notranslate"><span class="pre"><pointer></span></code>’ operand
is read and compared to ‘<code class="docutils literal notranslate"><span class="pre"><cmp></span></code>’; if the values are equal, ‘<code class="docutils literal notranslate"><span class="pre"><new></span></code>’ is
written to the location. The original value at the location is returned,
together with a flag indicating success (true) or failure (false).</p>
<p>If the cmpxchg operation is marked as <code class="docutils literal notranslate"><span class="pre">weak</span></code> then a spurious failure is
permitted: the operation may not write <code class="docutils literal notranslate"><span class="pre"><new></span></code> even if the comparison
matched.</p>
<p>If the cmpxchg operation is strong (the default), the i1 value is 1 if and only
if the value loaded equals <code class="docutils literal notranslate"><span class="pre">cmp</span></code>.</p>
<p>A successful <code class="docutils literal notranslate"><span class="pre">cmpxchg</span></code> is a read-modify-write instruction for the purpose of
identifying release sequences. A failed <code class="docutils literal notranslate"><span class="pre">cmpxchg</span></code> is equivalent to an atomic
load with an ordering parameter determined the second ordering parameter.</p>
</div>
<div class="section" id="id224">
<h5><a class="toc-backref" href="#id1863">Example:</a><a class="headerlink" href="#id224" 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">%orig</span> <span class="p">=</span> <span class="k">load</span> <span class="k">atomic</span> <span class="k">i32</span><span class="p">,</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%ptr</span> <span class="k">unordered</span><span class="p">,</span> <span class="k">align</span> <span class="m">4</span> <span class="c">; yields i32</span>
<span class="k">br</span> <span class="k">label</span> <span class="nv">%loop</span>
<span class="nl">loop:</span>
<span class="nv">%cmp</span> <span class="p">=</span> <span class="k">phi</span> <span class="k">i32</span> <span class="p">[</span> <span class="nv">%orig</span><span class="p">,</span> <span class="nv">%entry</span> <span class="p">],</span> <span class="p">[</span><span class="nv">%value_loaded</span><span class="p">,</span> <span class="nv">%loop</span><span class="p">]</span>
<span class="nv">%squared</span> <span class="p">=</span> <span class="k">mul</span> <span class="k">i32</span> <span class="nv">%cmp</span><span class="p">,</span> <span class="nv">%cmp</span>
<span class="nv">%val_success</span> <span class="p">=</span> <span class="k">cmpxchg</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%ptr</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%cmp</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%squared</span> <span class="k">acq_rel</span> <span class="k">monotonic</span> <span class="c">; yields { i32, i1 }</span>
<span class="nv">%value_loaded</span> <span class="p">=</span> <span class="k">extractvalue</span> <span class="p">{</span> <span class="k">i32</span><span class="p">,</span> <span class="k">i1</span> <span class="p">}</span> <span class="nv">%val_success</span><span class="p">,</span> <span class="m">0</span>
<span class="nv">%success</span> <span class="p">=</span> <span class="k">extractvalue</span> <span class="p">{</span> <span class="k">i32</span><span class="p">,</span> <span class="k">i1</span> <span class="p">}</span> <span class="nv">%val_success</span><span class="p">,</span> <span class="m">1</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%success</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%done</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%loop</span>
<span class="nl">done:</span>
<span class="p">...</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="atomicrmw-instruction">
<span id="i-atomicrmw"></span><h4><a class="toc-backref" href="#id1864">‘<code class="docutils literal notranslate"><span class="pre">atomicrmw</span></code>’ Instruction</a><a class="headerlink" href="#atomicrmw-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id225">
<h5><a class="toc-backref" href="#id1865">Syntax:</a><a class="headerlink" href="#id225" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">atomicrmw</span> <span class="p">[</span><span class="n">volatile</span><span class="p">]</span> <span class="o"><</span><span class="n">operation</span><span class="o">></span> <span class="o"><</span><span class="n">ty</span><span class="o">>*</span> <span class="o"><</span><span class="n">pointer</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span> <span class="p">[</span><span class="n">syncscope</span><span class="p">(</span><span class="s2">"<target-scope>"</span><span class="p">)]</span> <span class="o"><</span><span class="n">ordering</span><span class="o">></span><span class="p">[,</span> <span class="n">align</span> <span class="o"><</span><span class="n">alignment</span><span class="o">></span><span class="p">]</span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span>
</pre></div>
</div>
</div>
<div class="section" id="id226">
<h5><a class="toc-backref" href="#id1866">Overview:</a><a class="headerlink" href="#id226" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">atomicrmw</span></code>’ instruction is used to atomically modify memory.</p>
</div>
<div class="section" id="id227">
<h5><a class="toc-backref" href="#id1867">Arguments:</a><a class="headerlink" href="#id227" title="Permalink to this headline">¶</a></h5>
<p>There are three arguments to the ‘<code class="docutils literal notranslate"><span class="pre">atomicrmw</span></code>’ instruction: an
operation to apply, an address whose value to modify, an argument to the
operation. The operation must be one of the following keywords:</p>
<ul class="simple">
<li><p>xchg</p></li>
<li><p>add</p></li>
<li><p>sub</p></li>
<li><p>and</p></li>
<li><p>nand</p></li>
<li><p>or</p></li>
<li><p>xor</p></li>
<li><p>max</p></li>
<li><p>min</p></li>
<li><p>umax</p></li>
<li><p>umin</p></li>
<li><p>fadd</p></li>
<li><p>fsub</p></li>
</ul>
<p>For most of these operations, the type of ‘<value>’ must be an integer
type whose bit width is a power of two greater than or equal to eight
and less than or equal to a target-specific size limit. For xchg, this
may also be a floating point type with the same size constraints as
integers. For fadd/fsub, this must be a floating point type. The
type of the ‘<code class="docutils literal notranslate"><span class="pre"><pointer></span></code>’ operand must be a pointer to that type. If
the <code class="docutils literal notranslate"><span class="pre">atomicrmw</span></code> is marked as <code class="docutils literal notranslate"><span class="pre">volatile</span></code>, then the optimizer is not
allowed to modify the number or order of execution of this
<code class="docutils literal notranslate"><span class="pre">atomicrmw</span></code> with other <a class="reference internal" href="#volatile"><span class="std std-ref">volatile operations</span></a>.</p>
<p>The instruction can take an optional <code class="docutils literal notranslate"><span class="pre">align</span></code> attribute.
The alignment must be a power of two greater or equal to the size of the
<cite><value></cite> type. If unspecified, the alignment is assumed to be equal to the
size of the ‘<value>’ type. Note that this default alignment assumption is
different from the alignment used for the load/store instructions when align
isn’t specified.</p>
<p>A <code class="docutils literal notranslate"><span class="pre">atomicrmw</span></code> instruction can also take an optional
“<a class="reference internal" href="#syncscope"><span class="std std-ref">syncscope</span></a>” argument.</p>
</div>
<div class="section" id="id228">
<h5><a class="toc-backref" href="#id1868">Semantics:</a><a class="headerlink" href="#id228" title="Permalink to this headline">¶</a></h5>
<p>The contents of memory at the location specified by the ‘<code class="docutils literal notranslate"><span class="pre"><pointer></span></code>’
operand are atomically read, modified, and written back. The original
value at the location is returned. The modification is specified by the
operation argument:</p>
<ul class="simple">
<li><p>xchg: <code class="docutils literal notranslate"><span class="pre">*ptr</span> <span class="pre">=</span> <span class="pre">val</span></code></p></li>
<li><p>add: <code class="docutils literal notranslate"><span class="pre">*ptr</span> <span class="pre">=</span> <span class="pre">*ptr</span> <span class="pre">+</span> <span class="pre">val</span></code></p></li>
<li><p>sub: <code class="docutils literal notranslate"><span class="pre">*ptr</span> <span class="pre">=</span> <span class="pre">*ptr</span> <span class="pre">-</span> <span class="pre">val</span></code></p></li>
<li><p>and: <code class="docutils literal notranslate"><span class="pre">*ptr</span> <span class="pre">=</span> <span class="pre">*ptr</span> <span class="pre">&</span> <span class="pre">val</span></code></p></li>
<li><p>nand: <code class="docutils literal notranslate"><span class="pre">*ptr</span> <span class="pre">=</span> <span class="pre">~(*ptr</span> <span class="pre">&</span> <span class="pre">val)</span></code></p></li>
<li><p>or: <code class="docutils literal notranslate"><span class="pre">*ptr</span> <span class="pre">=</span> <span class="pre">*ptr</span> <span class="pre">|</span> <span class="pre">val</span></code></p></li>
<li><p>xor: <code class="docutils literal notranslate"><span class="pre">*ptr</span> <span class="pre">=</span> <span class="pre">*ptr</span> <span class="pre">^</span> <span class="pre">val</span></code></p></li>
<li><p>max: <code class="docutils literal notranslate"><span class="pre">*ptr</span> <span class="pre">=</span> <span class="pre">*ptr</span> <span class="pre">></span> <span class="pre">val</span> <span class="pre">?</span> <span class="pre">*ptr</span> <span class="pre">:</span> <span class="pre">val</span></code> (using a signed comparison)</p></li>
<li><p>min: <code class="docutils literal notranslate"><span class="pre">*ptr</span> <span class="pre">=</span> <span class="pre">*ptr</span> <span class="pre"><</span> <span class="pre">val</span> <span class="pre">?</span> <span class="pre">*ptr</span> <span class="pre">:</span> <span class="pre">val</span></code> (using a signed comparison)</p></li>
<li><p>umax: <code class="docutils literal notranslate"><span class="pre">*ptr</span> <span class="pre">=</span> <span class="pre">*ptr</span> <span class="pre">></span> <span class="pre">val</span> <span class="pre">?</span> <span class="pre">*ptr</span> <span class="pre">:</span> <span class="pre">val</span></code> (using an unsigned comparison)</p></li>
<li><p>umin: <code class="docutils literal notranslate"><span class="pre">*ptr</span> <span class="pre">=</span> <span class="pre">*ptr</span> <span class="pre"><</span> <span class="pre">val</span> <span class="pre">?</span> <span class="pre">*ptr</span> <span class="pre">:</span> <span class="pre">val</span></code> (using an unsigned comparison)</p></li>
<li><p>fadd: <code class="docutils literal notranslate"><span class="pre">*ptr</span> <span class="pre">=</span> <span class="pre">*ptr</span> <span class="pre">+</span> <span class="pre">val</span></code> (using floating point arithmetic)</p></li>
<li><p>fsub: <code class="docutils literal notranslate"><span class="pre">*ptr</span> <span class="pre">=</span> <span class="pre">*ptr</span> <span class="pre">-</span> <span class="pre">val</span></code> (using floating point arithmetic)</p></li>
</ul>
</div>
<div class="section" id="id229">
<h5><a class="toc-backref" href="#id1869">Example:</a><a class="headerlink" href="#id229" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%old</span> <span class="p">=</span> <span class="k">atomicrmw</span> <span class="k">add</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%ptr</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span> <span class="k">acquire</span> <span class="c">; yields i32</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="getelementptr-instruction">
<span id="i-getelementptr"></span><h4><a class="toc-backref" href="#id1870">‘<code class="docutils literal notranslate"><span class="pre">getelementptr</span></code>’ Instruction</a><a class="headerlink" href="#getelementptr-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id230">
<h5><a class="toc-backref" href="#id1871">Syntax:</a><a class="headerlink" href="#id230" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">getelementptr</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">ty</span><span class="o">>*</span> <span class="o"><</span><span class="n">ptrval</span><span class="o">></span><span class="p">{,</span> <span class="p">[</span><span class="n">inrange</span><span class="p">]</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">idx</span><span class="o">></span><span class="p">}</span><span class="o">*</span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">getelementptr</span> <span class="n">inbounds</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">ty</span><span class="o">>*</span> <span class="o"><</span><span class="n">ptrval</span><span class="o">></span><span class="p">{,</span> <span class="p">[</span><span class="n">inrange</span><span class="p">]</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">idx</span><span class="o">></span><span class="p">}</span><span class="o">*</span>
<span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">getelementptr</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">ptr</span> <span class="n">vector</span><span class="o">></span> <span class="o"><</span><span class="n">ptrval</span><span class="o">></span><span class="p">,</span> <span class="p">[</span><span class="n">inrange</span><span class="p">]</span> <span class="o"><</span><span class="n">vector</span> <span class="n">index</span> <span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">idx</span><span class="o">></span>
</pre></div>
</div>
</div>
<div class="section" id="id231">
<h5><a class="toc-backref" href="#id1872">Overview:</a><a class="headerlink" href="#id231" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">getelementptr</span></code>’ instruction is used to get the address of a
subelement of an <a class="reference internal" href="#t-aggregate"><span class="std std-ref">aggregate</span></a> data structure. It performs
address calculation only and does not access memory. The instruction can also
be used to calculate a vector of such addresses.</p>
</div>
<div class="section" id="id232">
<h5><a class="toc-backref" href="#id1873">Arguments:</a><a class="headerlink" href="#id232" title="Permalink to this headline">¶</a></h5>
<p>The first argument is always a type used as the basis for the calculations.
The second argument is always a pointer or a vector of pointers, and is the
base address to start from. The remaining arguments are indices
that indicate which of the elements of the aggregate object are indexed.
The interpretation of each index is dependent on the type being indexed
into. The first index always indexes the pointer value given as the
second argument, the second index indexes a value of the type pointed to
(not necessarily the value directly pointed to, since the first index
can be non-zero), etc. The first type indexed into must be a pointer
value, subsequent types can be arrays, vectors, and structs. Note that
subsequent types being indexed into can never be pointers, since that
would require loading the pointer before continuing calculation.</p>
<p>The type of each index argument depends on the type it is indexing into.
When indexing into a (optionally packed) structure, only <code class="docutils literal notranslate"><span class="pre">i32</span></code> integer
<strong>constants</strong> are allowed (when using a vector of indices they must all
be the <strong>same</strong> <code class="docutils literal notranslate"><span class="pre">i32</span></code> integer constant). When indexing into an array,
pointer or vector, integers of any width are allowed, and they are not
required to be constant. These integers are treated as signed values
where relevant.</p>
<p>For example, let’s consider a C code fragment and how it gets compiled
to LLVM:</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="k">struct</span> <span class="nc">RT</span> <span class="p">{</span>
<span class="kt">char</span> <span class="n">A</span><span class="p">;</span>
<span class="kt">int</span> <span class="n">B</span><span class="p">[</span><span class="mi">10</span><span class="p">][</span><span class="mi">20</span><span class="p">];</span>
<span class="kt">char</span> <span class="n">C</span><span class="p">;</span>
<span class="p">};</span>
<span class="k">struct</span> <span class="nc">ST</span> <span class="p">{</span>
<span class="kt">int</span> <span class="n">X</span><span class="p">;</span>
<span class="kt">double</span> <span class="n">Y</span><span class="p">;</span>
<span class="k">struct</span> <span class="nc">RT</span> <span class="n">Z</span><span class="p">;</span>
<span class="p">};</span>
<span class="kt">int</span> <span class="o">*</span><span class="nf">foo</span><span class="p">(</span><span class="k">struct</span> <span class="nc">ST</span> <span class="o">*</span><span class="n">s</span><span class="p">)</span> <span class="p">{</span>
<span class="k">return</span> <span class="o">&</span><span class="n">s</span><span class="p">[</span><span class="mi">1</span><span class="p">].</span><span class="n">Z</span><span class="p">.</span><span class="n">B</span><span class="p">[</span><span class="mi">5</span><span class="p">][</span><span class="mi">13</span><span class="p">];</span>
<span class="p">}</span>
</pre></div>
</div>
<p>The LLVM code generated by Clang is:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%struct.RT</span> <span class="p">=</span> <span class="k">type</span> <span class="p">{</span> <span class="k">i8</span><span class="p">,</span> <span class="p">[</span><span class="m">10</span> <span class="k">x</span> <span class="p">[</span><span class="m">20</span> <span class="k">x</span> <span class="k">i32</span><span class="p">]],</span> <span class="k">i8</span> <span class="p">}</span>
<span class="nv">%struct.ST</span> <span class="p">=</span> <span class="k">type</span> <span class="p">{</span> <span class="k">i32</span><span class="p">,</span> <span class="k">double</span><span class="p">,</span> <span class="nv">%struct.RT</span> <span class="p">}</span>
<span class="k">define</span> <span class="k">i32</span><span class="p">*</span> <span class="vg">@foo</span><span class="p">(</span><span class="nv">%struct.ST</span><span class="p">*</span> <span class="nv">%s</span><span class="p">)</span> <span class="k">nounwind</span> <span class="k">uwtable</span> <span class="k">readnone</span> <span class="k">optsize</span> <span class="k">ssp</span> <span class="p">{</span>
<span class="nl">entry:</span>
<span class="nv">%arrayidx</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="k">inbounds</span> <span class="nv">%struct.ST</span><span class="p">,</span> <span class="nv">%struct.ST</span><span class="p">*</span> <span class="nv">%s</span><span class="p">,</span> <span class="k">i64</span> <span class="m">1</span><span class="p">,</span> <span class="k">i32</span> <span class="m">2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">,</span> <span class="k">i64</span> <span class="m">5</span><span class="p">,</span> <span class="k">i64</span> <span class="m">13</span>
<span class="k">ret</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%arrayidx</span>
<span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="id233">
<h5><a class="toc-backref" href="#id1874">Semantics:</a><a class="headerlink" href="#id233" title="Permalink to this headline">¶</a></h5>
<p>In the example above, the first index is indexing into the
‘<code class="docutils literal notranslate"><span class="pre">%struct.ST*</span></code>’ type, which is a pointer, yielding a ‘<code class="docutils literal notranslate"><span class="pre">%struct.ST</span></code>’
= ‘<code class="docutils literal notranslate"><span class="pre">{</span> <span class="pre">i32,</span> <span class="pre">double,</span> <span class="pre">%struct.RT</span> <span class="pre">}</span></code>’ type, a structure. The second index
indexes into the third element of the structure, yielding a
‘<code class="docutils literal notranslate"><span class="pre">%struct.RT</span></code>’ = ‘<code class="docutils literal notranslate"><span class="pre">{</span> <span class="pre">i8</span> <span class="pre">,</span> <span class="pre">[10</span> <span class="pre">x</span> <span class="pre">[20</span> <span class="pre">x</span> <span class="pre">i32]],</span> <span class="pre">i8</span> <span class="pre">}</span></code>’ type, another
structure. The third index indexes into the second element of the
structure, yielding a ‘<code class="docutils literal notranslate"><span class="pre">[10</span> <span class="pre">x</span> <span class="pre">[20</span> <span class="pre">x</span> <span class="pre">i32]]</span></code>’ type, an array. The two
dimensions of the array are subscripted into, yielding an ‘<code class="docutils literal notranslate"><span class="pre">i32</span></code>’
type. The ‘<code class="docutils literal notranslate"><span class="pre">getelementptr</span></code>’ instruction returns a pointer to this
element, thus computing a value of ‘<code class="docutils literal notranslate"><span class="pre">i32*</span></code>’ type.</p>
<p>Note that it is perfectly legal to index partially through a structure,
returning a pointer to an inner element. Because of this, the LLVM code
for the given testcase is equivalent to:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">define</span> <span class="k">i32</span><span class="p">*</span> <span class="vg">@foo</span><span class="p">(</span><span class="nv">%struct.ST</span><span class="p">*</span> <span class="nv">%s</span><span class="p">)</span> <span class="p">{</span>
<span class="nv">%t1</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="nv">%struct.ST</span><span class="p">,</span> <span class="nv">%struct.ST</span><span class="p">*</span> <span class="nv">%s</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span> <span class="c">; yields %struct.ST*:%t1</span>
<span class="nv">%t2</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="nv">%struct.ST</span><span class="p">,</span> <span class="nv">%struct.ST</span><span class="p">*</span> <span class="nv">%t1</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="c">; yields %struct.RT*:%t2</span>
<span class="nv">%t3</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="nv">%struct.RT</span><span class="p">,</span> <span class="nv">%struct.RT</span><span class="p">*</span> <span class="nv">%t2</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="c">; yields [10 x [20 x i32]]*:%t3</span>
<span class="nv">%t4</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="p">[</span><span class="m">10</span> <span class="k">x</span> <span class="p">[</span><span class="m">20</span> <span class="k">x</span> <span class="k">i32</span><span class="p">]],</span> <span class="p">[</span><span class="m">10</span> <span class="k">x</span> <span class="p">[</span><span class="m">20</span> <span class="k">x</span> <span class="k">i32</span><span class="p">]]*</span> <span class="nv">%t3</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">5</span> <span class="c">; yields [20 x i32]*:%t4</span>
<span class="nv">%t5</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="p">[</span><span class="m">20</span> <span class="k">x</span> <span class="k">i32</span><span class="p">],</span> <span class="p">[</span><span class="m">20</span> <span class="k">x</span> <span class="k">i32</span><span class="p">]*</span> <span class="nv">%t4</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">13</span> <span class="c">; yields i32*:%t5</span>
<span class="k">ret</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%t5</span>
<span class="p">}</span>
</pre></div>
</div>
<p>If the <code class="docutils literal notranslate"><span class="pre">inbounds</span></code> keyword is present, the result value of the
<code class="docutils literal notranslate"><span class="pre">getelementptr</span></code> is a <a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a> if one of the
following rules is violated:</p>
<ul class="simple">
<li><p>The base pointer has an <em>in bounds</em> address of an allocated object, which
means that it points into an allocated object, or to its end. The only
<em>in bounds</em> address for a null pointer in the default address-space is the
null pointer itself.</p></li>
<li><p>If the type of an index is larger than the pointer index type, the
truncation to the pointer index type preserves the signed value.</p></li>
<li><p>The multiplication of an index by the type size does not wrap the pointer
index type in a signed sense (<code class="docutils literal notranslate"><span class="pre">nsw</span></code>).</p></li>
<li><p>The successive addition of offsets (without adding the base address) does
not wrap the pointer index type in a signed sense (<code class="docutils literal notranslate"><span class="pre">nsw</span></code>).</p></li>
<li><p>The successive addition of the current address, interpreted as an unsigned
number, and an offset, interpreted as a signed number, does not wrap the
unsigned address space and remains <em>in bounds</em> of the allocated object.
As a corollary, if the added offset is non-negative, the addition does not
wrap in an unsigned sense (<code class="docutils literal notranslate"><span class="pre">nuw</span></code>).</p></li>
<li><p>In cases where the base is a vector of pointers, the <code class="docutils literal notranslate"><span class="pre">inbounds</span></code> keyword
applies to each of the computations element-wise.</p></li>
</ul>
<p>These rules are based on the assumption that no allocated object may cross
the unsigned address space boundary, and no allocated object may be larger
than half the pointer index type space.</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">inbounds</span></code> keyword is not present, the offsets are added to the
base address with silently-wrapping two’s complement arithmetic. If the
offsets have a different width from the pointer, they are sign-extended
or truncated to the width of the pointer. The result value of the
<code class="docutils literal notranslate"><span class="pre">getelementptr</span></code> may be outside the object pointed to by the base
pointer. The result value may not necessarily be used to access memory
though, even if it happens to point into allocated storage. See the
<a class="reference internal" href="#pointeraliasing"><span class="std std-ref">Pointer Aliasing Rules</span></a> section for more
information.</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">inrange</span></code> keyword is present before any index, loading from or
storing to any pointer derived from the <code class="docutils literal notranslate"><span class="pre">getelementptr</span></code> has undefined
behavior if the load or store would access memory outside of the bounds of
the element selected by the index marked as <code class="docutils literal notranslate"><span class="pre">inrange</span></code>. The result of a
pointer comparison or <code class="docutils literal notranslate"><span class="pre">ptrtoint</span></code> (including <code class="docutils literal notranslate"><span class="pre">ptrtoint</span></code>-like operations
involving memory) involving a pointer derived from a <code class="docutils literal notranslate"><span class="pre">getelementptr</span></code> with
the <code class="docutils literal notranslate"><span class="pre">inrange</span></code> keyword is undefined, with the exception of comparisons
in the case where both operands are in the range of the element selected
by the <code class="docutils literal notranslate"><span class="pre">inrange</span></code> keyword, inclusive of the address one past the end of
that element. Note that the <code class="docutils literal notranslate"><span class="pre">inrange</span></code> keyword is currently only allowed
in constant <code class="docutils literal notranslate"><span class="pre">getelementptr</span></code> expressions.</p>
<p>The getelementptr instruction is often confusing. For some more insight
into how it works, see <a class="reference internal" href="GetElementPtr.html"><span class="doc">the getelementptr FAQ</span></a>.</p>
</div>
<div class="section" id="id234">
<h5><a class="toc-backref" href="#id1875">Example:</a><a class="headerlink" href="#id234" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="c">; yields [12 x i8]*:aptr</span>
<span class="nv">%aptr</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="p">[</span><span class="m">12</span> <span class="k">x</span> <span class="k">i8</span><span class="p">]},</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="p">[</span><span class="m">12</span> <span class="k">x</span> <span class="k">i8</span><span class="p">]}*</span> <span class="nv">%saptr</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">1</span>
<span class="c">; yields i8*:vptr</span>
<span class="nv">%vptr</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="p"><</span><span class="m">2</span> <span class="k">x</span> <span class="k">i8</span><span class="p">>},</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="p"><</span><span class="m">2</span> <span class="k">x</span> <span class="k">i8</span><span class="p">>}*</span> <span class="nv">%svptr</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">1</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span>
<span class="c">; yields i8*:eptr</span>
<span class="nv">%eptr</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="p">[</span><span class="m">12</span> <span class="k">x</span> <span class="k">i8</span><span class="p">],</span> <span class="p">[</span><span class="m">12</span> <span class="k">x</span> <span class="k">i8</span><span class="p">]*</span> <span class="nv">%aptr</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">1</span>
<span class="c">; yields i32*:iptr</span>
<span class="nv">%iptr</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="p">[</span><span class="m">10</span> <span class="k">x</span> <span class="k">i32</span><span class="p">],</span> <span class="p">[</span><span class="m">10</span> <span class="k">x</span> <span class="k">i32</span><span class="p">]*</span> <span class="vg">@arr</span><span class="p">,</span> <span class="k">i16</span> <span class="m">0</span><span class="p">,</span> <span class="k">i16</span> <span class="m">0</span>
</pre></div>
</div>
</div>
<div class="section" id="vector-of-pointers">
<h5><a class="toc-backref" href="#id1876">Vector of pointers:</a><a class="headerlink" href="#vector-of-pointers" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">getelementptr</span></code> returns a vector of pointers, instead of a single address,
when one or more of its arguments is a vector. In such cases, all vector
arguments should have the same number of elements, and every scalar argument
will be effectively broadcast into a vector during address calculation.</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="c">; All arguments are vectors:</span>
<span class="c">; A[i] = ptrs[i] + offsets[i]*sizeof(i8)</span>
<span class="nv">%A</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="k">i8</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i8</span><span class="p">*></span> <span class="nv">%ptrs</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i64</span><span class="p">></span> <span class="nv">%offsets</span>
<span class="c">; Add the same scalar offset to each pointer of a vector:</span>
<span class="c">; A[i] = ptrs[i] + offset*sizeof(i8)</span>
<span class="nv">%A</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="k">i8</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i8</span><span class="p">*></span> <span class="nv">%ptrs</span><span class="p">,</span> <span class="k">i64</span> <span class="nv">%offset</span>
<span class="c">; Add distinct offsets to the same pointer:</span>
<span class="c">; A[i] = ptr + offsets[i]*sizeof(i8)</span>
<span class="nv">%A</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="k">i8</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%ptr</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i64</span><span class="p">></span> <span class="nv">%offsets</span>
<span class="c">; In all cases described above the type of the result is <4 x i8*></span>
</pre></div>
</div>
<p>The two following instructions are equivalent:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="k">getelementptr</span> <span class="nv">%struct.ST</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="nv">%struct.ST</span><span class="p">*></span> <span class="nv">%s</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i64</span><span class="p">></span> <span class="nv">%ind1</span><span class="p">,</span>
<span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="p"><</span><span class="k">i32</span> <span class="m">2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">2</span><span class="p">>,</span>
<span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="p"><</span><span class="k">i32</span> <span class="m">1</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">>,</span>
<span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%ind4</span><span class="p">,</span>
<span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i64</span><span class="p">></span> <span class="p"><</span><span class="k">i64</span> <span class="m">13</span><span class="p">,</span> <span class="k">i64</span> <span class="m">13</span><span class="p">,</span> <span class="k">i64</span> <span class="m">13</span><span class="p">,</span> <span class="k">i64</span> <span class="m">13</span><span class="p">></span>
<span class="k">getelementptr</span> <span class="nv">%struct.ST</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="nv">%struct.ST</span><span class="p">*></span> <span class="nv">%s</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i64</span><span class="p">></span> <span class="nv">%ind1</span><span class="p">,</span>
<span class="k">i32</span> <span class="m">2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%ind4</span><span class="p">,</span> <span class="k">i64</span> <span class="m">13</span>
</pre></div>
</div>
<p>Let’s look at the C code, where the vector version of <code class="docutils literal notranslate"><span class="pre">getelementptr</span></code>
makes sense:</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="c1">// Let's assume that we vectorize the following loop:</span>
<span class="kt">double</span> <span class="o">*</span><span class="n">A</span><span class="p">,</span> <span class="o">*</span><span class="n">B</span><span class="p">;</span> <span class="kt">int</span> <span class="o">*</span><span class="n">C</span><span class="p">;</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">size</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">A</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="n">B</span><span class="p">[</span><span class="n">C</span><span class="p">[</span><span class="n">i</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="c">; get pointers for 8 elements from array B</span>
<span class="nv">%ptrs</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="k">double</span><span class="p">,</span> <span class="k">double</span><span class="p">*</span> <span class="nv">%B</span><span class="p">,</span> <span class="p"><</span><span class="m">8</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%C</span>
<span class="c">; load 8 elements from array B into A</span>
<span class="nv">%A</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">8</span> <span class="k">x</span> <span class="k">double</span><span class="p">></span> <span class="vg">@llvm.masked.gather.v8f64.v8p0f64</span><span class="p">(<</span><span class="m">8</span> <span class="k">x</span> <span class="k">double</span><span class="p">*></span> <span class="nv">%ptrs</span><span class="p">,</span>
<span class="k">i32</span> <span class="m">8</span><span class="p">,</span> <span class="p"><</span><span class="m">8</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">8</span> <span class="k">x</span> <span class="k">double</span><span class="p">></span> <span class="nv">%passthru</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="conversion-operations">
<h3><a class="toc-backref" href="#id1877">Conversion Operations</a><a class="headerlink" href="#conversion-operations" title="Permalink to this headline">¶</a></h3>
<p>The instructions in this category are the conversion instructions
(casting) which all take a single operand and a type. They perform
various bit conversions on the operand.</p>
<div class="section" id="trunc-to-instruction">
<span id="i-trunc"></span><h4><a class="toc-backref" href="#id1878">‘<code class="docutils literal notranslate"><span class="pre">trunc</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a><a class="headerlink" href="#trunc-to-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id235">
<h5><a class="toc-backref" href="#id1879">Syntax:</a><a class="headerlink" href="#id235" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">trunc</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span> <span class="n">to</span> <span class="o"><</span><span class="n">ty2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty2</span>
</pre></div>
</div>
</div>
<div class="section" id="id236">
<h5><a class="toc-backref" href="#id1880">Overview:</a><a class="headerlink" href="#id236" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">trunc</span></code>’ instruction truncates its operand to the type <code class="docutils literal notranslate"><span class="pre">ty2</span></code>.</p>
</div>
<div class="section" id="id237">
<h5><a class="toc-backref" href="#id1881">Arguments:</a><a class="headerlink" href="#id237" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">trunc</span></code>’ instruction takes a value to trunc, and a type to trunc
it to. Both types must be of <a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> types, or vectors
of the same number of integers. The bit size of the <code class="docutils literal notranslate"><span class="pre">value</span></code> must be
larger than the bit size of the destination type, <code class="docutils literal notranslate"><span class="pre">ty2</span></code>. Equal sized
types are not allowed.</p>
</div>
<div class="section" id="id238">
<h5><a class="toc-backref" href="#id1882">Semantics:</a><a class="headerlink" href="#id238" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">trunc</span></code>’ instruction truncates the high order bits in <code class="docutils literal notranslate"><span class="pre">value</span></code>
and converts the remaining bits to <code class="docutils literal notranslate"><span class="pre">ty2</span></code>. Since the source size must
be larger than the destination size, <code class="docutils literal notranslate"><span class="pre">trunc</span></code> cannot be a <em>no-op cast</em>.
It will always truncate bits.</p>
</div>
<div class="section" id="id239">
<h5><a class="toc-backref" href="#id1883">Example:</a><a class="headerlink" href="#id239" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%X</span> <span class="p">=</span> <span class="k">trunc</span> <span class="k">i32</span> <span class="m">257</span> <span class="k">to</span> <span class="k">i8</span> <span class="c">; yields i8:1</span>
<span class="nv">%Y</span> <span class="p">=</span> <span class="k">trunc</span> <span class="k">i32</span> <span class="m">123</span> <span class="k">to</span> <span class="k">i1</span> <span class="c">; yields i1:true</span>
<span class="nv">%Z</span> <span class="p">=</span> <span class="k">trunc</span> <span class="k">i32</span> <span class="m">122</span> <span class="k">to</span> <span class="k">i1</span> <span class="c">; yields i1:false</span>
<span class="nv">%W</span> <span class="p">=</span> <span class="k">trunc</span> <span class="p"><</span><span class="m">2</span> <span class="k">x</span> <span class="k">i16</span><span class="p">></span> <span class="p"><</span><span class="k">i16</span> <span class="m">8</span><span class="p">,</span> <span class="k">i16</span> <span class="m">7</span><span class="p">></span> <span class="k">to</span> <span class="p"><</span><span class="m">2</span> <span class="k">x</span> <span class="k">i8</span><span class="p">></span> <span class="c">; yields <i8 8, i8 7></span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="zext-to-instruction">
<span id="i-zext"></span><h4><a class="toc-backref" href="#id1884">‘<code class="docutils literal notranslate"><span class="pre">zext</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a><a class="headerlink" href="#zext-to-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id240">
<h5><a class="toc-backref" href="#id1885">Syntax:</a><a class="headerlink" href="#id240" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">zext</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span> <span class="n">to</span> <span class="o"><</span><span class="n">ty2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty2</span>
</pre></div>
</div>
</div>
<div class="section" id="id241">
<h5><a class="toc-backref" href="#id1886">Overview:</a><a class="headerlink" href="#id241" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">zext</span></code>’ instruction zero extends its operand to type <code class="docutils literal notranslate"><span class="pre">ty2</span></code>.</p>
</div>
<div class="section" id="id242">
<h5><a class="toc-backref" href="#id1887">Arguments:</a><a class="headerlink" href="#id242" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">zext</span></code>’ instruction takes a value to cast, and a type to cast it
to. Both types must be of <a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> types, or vectors of
the same number of integers. The bit size of the <code class="docutils literal notranslate"><span class="pre">value</span></code> must be
smaller than the bit size of the destination type, <code class="docutils literal notranslate"><span class="pre">ty2</span></code>.</p>
</div>
<div class="section" id="id243">
<h5><a class="toc-backref" href="#id1888">Semantics:</a><a class="headerlink" href="#id243" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">zext</span></code> fills the high order bits of the <code class="docutils literal notranslate"><span class="pre">value</span></code> with zero bits
until it reaches the size of the destination type, <code class="docutils literal notranslate"><span class="pre">ty2</span></code>.</p>
<p>When zero extending from i1, the result will always be either 0 or 1.</p>
</div>
<div class="section" id="id244">
<h5><a class="toc-backref" href="#id1889">Example:</a><a class="headerlink" href="#id244" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%X</span> <span class="p">=</span> <span class="k">zext</span> <span class="k">i32</span> <span class="m">257</span> <span class="k">to</span> <span class="k">i64</span> <span class="c">; yields i64:257</span>
<span class="nv">%Y</span> <span class="p">=</span> <span class="k">zext</span> <span class="k">i1</span> <span class="k">true</span> <span class="k">to</span> <span class="k">i32</span> <span class="c">; yields i32:1</span>
<span class="nv">%Z</span> <span class="p">=</span> <span class="k">zext</span> <span class="p"><</span><span class="m">2</span> <span class="k">x</span> <span class="k">i16</span><span class="p">></span> <span class="p"><</span><span class="k">i16</span> <span class="m">8</span><span class="p">,</span> <span class="k">i16</span> <span class="m">7</span><span class="p">></span> <span class="k">to</span> <span class="p"><</span><span class="m">2</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="c">; yields <i32 8, i32 7></span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="sext-to-instruction">
<span id="i-sext"></span><h4><a class="toc-backref" href="#id1890">‘<code class="docutils literal notranslate"><span class="pre">sext</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a><a class="headerlink" href="#sext-to-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id245">
<h5><a class="toc-backref" href="#id1891">Syntax:</a><a class="headerlink" href="#id245" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">sext</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span> <span class="n">to</span> <span class="o"><</span><span class="n">ty2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty2</span>
</pre></div>
</div>
</div>
<div class="section" id="id246">
<h5><a class="toc-backref" href="#id1892">Overview:</a><a class="headerlink" href="#id246" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">sext</span></code>’ sign extends <code class="docutils literal notranslate"><span class="pre">value</span></code> to the type <code class="docutils literal notranslate"><span class="pre">ty2</span></code>.</p>
</div>
<div class="section" id="id247">
<h5><a class="toc-backref" href="#id1893">Arguments:</a><a class="headerlink" href="#id247" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">sext</span></code>’ instruction takes a value to cast, and a type to cast it
to. Both types must be of <a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> types, or vectors of
the same number of integers. The bit size of the <code class="docutils literal notranslate"><span class="pre">value</span></code> must be
smaller than the bit size of the destination type, <code class="docutils literal notranslate"><span class="pre">ty2</span></code>.</p>
</div>
<div class="section" id="id248">
<h5><a class="toc-backref" href="#id1894">Semantics:</a><a class="headerlink" href="#id248" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">sext</span></code>’ instruction performs a sign extension by copying the sign
bit (highest order bit) of the <code class="docutils literal notranslate"><span class="pre">value</span></code> until it reaches the bit size
of the type <code class="docutils literal notranslate"><span class="pre">ty2</span></code>.</p>
<p>When sign extending from i1, the extension always results in -1 or 0.</p>
</div>
<div class="section" id="id249">
<h5><a class="toc-backref" href="#id1895">Example:</a><a class="headerlink" href="#id249" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%X</span> <span class="p">=</span> <span class="k">sext</span> <span class="k">i8</span> <span class="m">-1</span> <span class="k">to</span> <span class="k">i16</span> <span class="c">; yields i16 :65535</span>
<span class="nv">%Y</span> <span class="p">=</span> <span class="k">sext</span> <span class="k">i1</span> <span class="k">true</span> <span class="k">to</span> <span class="k">i32</span> <span class="c">; yields i32:-1</span>
<span class="nv">%Z</span> <span class="p">=</span> <span class="k">sext</span> <span class="p"><</span><span class="m">2</span> <span class="k">x</span> <span class="k">i16</span><span class="p">></span> <span class="p"><</span><span class="k">i16</span> <span class="m">8</span><span class="p">,</span> <span class="k">i16</span> <span class="m">7</span><span class="p">></span> <span class="k">to</span> <span class="p"><</span><span class="m">2</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="c">; yields <i32 8, i32 7></span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="fptrunc-to-instruction">
<h4><a class="toc-backref" href="#id1896">‘<code class="docutils literal notranslate"><span class="pre">fptrunc</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a><a class="headerlink" href="#fptrunc-to-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id250">
<h5><a class="toc-backref" href="#id1897">Syntax:</a><a class="headerlink" href="#id250" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">fptrunc</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span> <span class="n">to</span> <span class="o"><</span><span class="n">ty2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty2</span>
</pre></div>
</div>
</div>
<div class="section" id="id251">
<h5><a class="toc-backref" href="#id1898">Overview:</a><a class="headerlink" href="#id251" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">fptrunc</span></code>’ instruction truncates <code class="docutils literal notranslate"><span class="pre">value</span></code> to type <code class="docutils literal notranslate"><span class="pre">ty2</span></code>.</p>
</div>
<div class="section" id="id252">
<h5><a class="toc-backref" href="#id1899">Arguments:</a><a class="headerlink" href="#id252" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">fptrunc</span></code>’ instruction takes a <a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a>
value to cast and a <a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> type to cast it to.
The size of <code class="docutils literal notranslate"><span class="pre">value</span></code> must be larger than the size of <code class="docutils literal notranslate"><span class="pre">ty2</span></code>. This
implies that <code class="docutils literal notranslate"><span class="pre">fptrunc</span></code> cannot be used to make a <em>no-op cast</em>.</p>
</div>
<div class="section" id="id253">
<h5><a class="toc-backref" href="#id1900">Semantics:</a><a class="headerlink" href="#id253" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">fptrunc</span></code>’ instruction casts a <code class="docutils literal notranslate"><span class="pre">value</span></code> from a larger
<a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> type to a smaller <a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> type.
This instruction is assumed to execute in the default <a class="reference internal" href="#floatenv"><span class="std std-ref">floating-point
environment</span></a>.</p>
</div>
<div class="section" id="id254">
<h5><a class="toc-backref" href="#id1901">Example:</a><a class="headerlink" href="#id254" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%X</span> <span class="p">=</span> <span class="k">fptrunc</span> <span class="k">double</span> <span class="m">16777217.0</span> <span class="k">to</span> <span class="k">float</span> <span class="c">; yields float:16777216.0</span>
<span class="nv">%Y</span> <span class="p">=</span> <span class="k">fptrunc</span> <span class="k">double</span> <span class="m">1.0E+300</span> <span class="k">to</span> <span class="k">half</span> <span class="c">; yields half:+infinity</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="fpext-to-instruction">
<h4><a class="toc-backref" href="#id1902">‘<code class="docutils literal notranslate"><span class="pre">fpext</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a><a class="headerlink" href="#fpext-to-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id255">
<h5><a class="toc-backref" href="#id1903">Syntax:</a><a class="headerlink" href="#id255" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">fpext</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span> <span class="n">to</span> <span class="o"><</span><span class="n">ty2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty2</span>
</pre></div>
</div>
</div>
<div class="section" id="id256">
<h5><a class="toc-backref" href="#id1904">Overview:</a><a class="headerlink" href="#id256" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">fpext</span></code>’ extends a floating-point <code class="docutils literal notranslate"><span class="pre">value</span></code> to a larger floating-point
value.</p>
</div>
<div class="section" id="id257">
<h5><a class="toc-backref" href="#id1905">Arguments:</a><a class="headerlink" href="#id257" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">fpext</span></code>’ instruction takes a <a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a>
<code class="docutils literal notranslate"><span class="pre">value</span></code> to cast, and a <a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> type to cast it
to. The source type must be smaller than the destination type.</p>
</div>
<div class="section" id="id258">
<h5><a class="toc-backref" href="#id1906">Semantics:</a><a class="headerlink" href="#id258" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">fpext</span></code>’ instruction extends the <code class="docutils literal notranslate"><span class="pre">value</span></code> from a smaller
<a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> type to a larger <a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> type. The <code class="docutils literal notranslate"><span class="pre">fpext</span></code> cannot be used to make a
<em>no-op cast</em> because it always changes bits. Use <code class="docutils literal notranslate"><span class="pre">bitcast</span></code> to make a
<em>no-op cast</em> for a floating-point cast.</p>
</div>
<div class="section" id="id259">
<h5><a class="toc-backref" href="#id1907">Example:</a><a class="headerlink" href="#id259" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%X</span> <span class="p">=</span> <span class="k">fpext</span> <span class="k">float</span> <span class="m">3.125</span> <span class="k">to</span> <span class="k">double</span> <span class="c">; yields double:3.125000e+00</span>
<span class="nv">%Y</span> <span class="p">=</span> <span class="k">fpext</span> <span class="k">double</span> <span class="nv">%X</span> <span class="k">to</span> <span class="k">fp128</span> <span class="c">; yields fp128:0xL00000000000000004000900000000000</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="fptoui-to-instruction">
<h4><a class="toc-backref" href="#id1908">‘<code class="docutils literal notranslate"><span class="pre">fptoui</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a><a class="headerlink" href="#fptoui-to-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id260">
<h5><a class="toc-backref" href="#id1909">Syntax:</a><a class="headerlink" href="#id260" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">fptoui</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span> <span class="n">to</span> <span class="o"><</span><span class="n">ty2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty2</span>
</pre></div>
</div>
</div>
<div class="section" id="id261">
<h5><a class="toc-backref" href="#id1910">Overview:</a><a class="headerlink" href="#id261" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">fptoui</span></code>’ converts a floating-point <code class="docutils literal notranslate"><span class="pre">value</span></code> to its unsigned
integer equivalent of type <code class="docutils literal notranslate"><span class="pre">ty2</span></code>.</p>
</div>
<div class="section" id="id262">
<h5><a class="toc-backref" href="#id1911">Arguments:</a><a class="headerlink" href="#id262" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">fptoui</span></code>’ instruction takes a value to cast, which must be a
scalar or vector <a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> value, and a type to
cast it to <code class="docutils literal notranslate"><span class="pre">ty2</span></code>, which must be an <a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> type. If
<code class="docutils literal notranslate"><span class="pre">ty</span></code> is a vector floating-point type, <code class="docutils literal notranslate"><span class="pre">ty2</span></code> must be a vector integer
type with the same number of elements as <code class="docutils literal notranslate"><span class="pre">ty</span></code></p>
</div>
<div class="section" id="id263">
<h5><a class="toc-backref" href="#id1912">Semantics:</a><a class="headerlink" href="#id263" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">fptoui</span></code>’ instruction converts its <a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> operand into the nearest (rounding towards zero)
unsigned integer value. If the value cannot fit in <code class="docutils literal notranslate"><span class="pre">ty2</span></code>, the result
is a <a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a>.</p>
</div>
<div class="section" id="id264">
<h5><a class="toc-backref" href="#id1913">Example:</a><a class="headerlink" href="#id264" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%X</span> <span class="p">=</span> <span class="k">fptoui</span> <span class="k">double</span> <span class="m">123.0</span> <span class="k">to</span> <span class="k">i32</span> <span class="c">; yields i32:123</span>
<span class="nv">%Y</span> <span class="p">=</span> <span class="k">fptoui</span> <span class="k">float</span> <span class="m">1.0E+300</span> <span class="k">to</span> <span class="k">i1</span> <span class="c">; yields undefined:1</span>
<span class="nv">%Z</span> <span class="p">=</span> <span class="k">fptoui</span> <span class="k">float</span> <span class="m">1.04E+17</span> <span class="k">to</span> <span class="k">i8</span> <span class="c">; yields undefined:1</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="fptosi-to-instruction">
<h4><a class="toc-backref" href="#id1914">‘<code class="docutils literal notranslate"><span class="pre">fptosi</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a><a class="headerlink" href="#fptosi-to-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id265">
<h5><a class="toc-backref" href="#id1915">Syntax:</a><a class="headerlink" href="#id265" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">fptosi</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span> <span class="n">to</span> <span class="o"><</span><span class="n">ty2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty2</span>
</pre></div>
</div>
</div>
<div class="section" id="id266">
<h5><a class="toc-backref" href="#id1916">Overview:</a><a class="headerlink" href="#id266" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">fptosi</span></code>’ instruction converts <a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a>
<code class="docutils literal notranslate"><span class="pre">value</span></code> to type <code class="docutils literal notranslate"><span class="pre">ty2</span></code>.</p>
</div>
<div class="section" id="id267">
<h5><a class="toc-backref" href="#id1917">Arguments:</a><a class="headerlink" href="#id267" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">fptosi</span></code>’ instruction takes a value to cast, which must be a
scalar or vector <a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> value, and a type to
cast it to <code class="docutils literal notranslate"><span class="pre">ty2</span></code>, which must be an <a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> type. If
<code class="docutils literal notranslate"><span class="pre">ty</span></code> is a vector floating-point type, <code class="docutils literal notranslate"><span class="pre">ty2</span></code> must be a vector integer
type with the same number of elements as <code class="docutils literal notranslate"><span class="pre">ty</span></code></p>
</div>
<div class="section" id="id268">
<h5><a class="toc-backref" href="#id1918">Semantics:</a><a class="headerlink" href="#id268" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">fptosi</span></code>’ instruction converts its <a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> operand into the nearest (rounding towards zero)
signed integer value. If the value cannot fit in <code class="docutils literal notranslate"><span class="pre">ty2</span></code>, the result
is a <a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a>.</p>
</div>
<div class="section" id="id269">
<h5><a class="toc-backref" href="#id1919">Example:</a><a class="headerlink" href="#id269" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%X</span> <span class="p">=</span> <span class="k">fptosi</span> <span class="k">double</span> <span class="m">-123.0</span> <span class="k">to</span> <span class="k">i32</span> <span class="c">; yields i32:-123</span>
<span class="nv">%Y</span> <span class="p">=</span> <span class="k">fptosi</span> <span class="k">float</span> <span class="m">1.0E-247</span> <span class="k">to</span> <span class="k">i1</span> <span class="c">; yields undefined:1</span>
<span class="nv">%Z</span> <span class="p">=</span> <span class="k">fptosi</span> <span class="k">float</span> <span class="m">1.04E+17</span> <span class="k">to</span> <span class="k">i8</span> <span class="c">; yields undefined:1</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="uitofp-to-instruction">
<h4><a class="toc-backref" href="#id1920">‘<code class="docutils literal notranslate"><span class="pre">uitofp</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a><a class="headerlink" href="#uitofp-to-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id270">
<h5><a class="toc-backref" href="#id1921">Syntax:</a><a class="headerlink" href="#id270" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">uitofp</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span> <span class="n">to</span> <span class="o"><</span><span class="n">ty2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty2</span>
</pre></div>
</div>
</div>
<div class="section" id="id271">
<h5><a class="toc-backref" href="#id1922">Overview:</a><a class="headerlink" href="#id271" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">uitofp</span></code>’ instruction regards <code class="docutils literal notranslate"><span class="pre">value</span></code> as an unsigned integer
and converts that value to the <code class="docutils literal notranslate"><span class="pre">ty2</span></code> type.</p>
</div>
<div class="section" id="id272">
<h5><a class="toc-backref" href="#id1923">Arguments:</a><a class="headerlink" href="#id272" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">uitofp</span></code>’ instruction takes a value to cast, which must be a
scalar or vector <a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> value, and a type to cast it to
<code class="docutils literal notranslate"><span class="pre">ty2</span></code>, which must be an <a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> type. If
<code class="docutils literal notranslate"><span class="pre">ty</span></code> is a vector integer type, <code class="docutils literal notranslate"><span class="pre">ty2</span></code> must be a vector floating-point
type with the same number of elements as <code class="docutils literal notranslate"><span class="pre">ty</span></code></p>
</div>
<div class="section" id="id273">
<h5><a class="toc-backref" href="#id1924">Semantics:</a><a class="headerlink" href="#id273" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">uitofp</span></code>’ instruction interprets its operand as an unsigned
integer quantity and converts it to the corresponding floating-point
value. If the value cannot be exactly represented, it is rounded using
the default rounding mode.</p>
</div>
<div class="section" id="id274">
<h5><a class="toc-backref" href="#id1925">Example:</a><a class="headerlink" href="#id274" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%X</span> <span class="p">=</span> <span class="k">uitofp</span> <span class="k">i32</span> <span class="m">257</span> <span class="k">to</span> <span class="k">float</span> <span class="c">; yields float:257.0</span>
<span class="nv">%Y</span> <span class="p">=</span> <span class="k">uitofp</span> <span class="k">i8</span> <span class="m">-1</span> <span class="k">to</span> <span class="k">double</span> <span class="c">; yields double:255.0</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="sitofp-to-instruction">
<h4><a class="toc-backref" href="#id1926">‘<code class="docutils literal notranslate"><span class="pre">sitofp</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a><a class="headerlink" href="#sitofp-to-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id275">
<h5><a class="toc-backref" href="#id1927">Syntax:</a><a class="headerlink" href="#id275" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">sitofp</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span> <span class="n">to</span> <span class="o"><</span><span class="n">ty2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty2</span>
</pre></div>
</div>
</div>
<div class="section" id="id276">
<h5><a class="toc-backref" href="#id1928">Overview:</a><a class="headerlink" href="#id276" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">sitofp</span></code>’ instruction regards <code class="docutils literal notranslate"><span class="pre">value</span></code> as a signed integer and
converts that value to the <code class="docutils literal notranslate"><span class="pre">ty2</span></code> type.</p>
</div>
<div class="section" id="id277">
<h5><a class="toc-backref" href="#id1929">Arguments:</a><a class="headerlink" href="#id277" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">sitofp</span></code>’ instruction takes a value to cast, which must be a
scalar or vector <a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> value, and a type to cast it to
<code class="docutils literal notranslate"><span class="pre">ty2</span></code>, which must be an <a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> type. If
<code class="docutils literal notranslate"><span class="pre">ty</span></code> is a vector integer type, <code class="docutils literal notranslate"><span class="pre">ty2</span></code> must be a vector floating-point
type with the same number of elements as <code class="docutils literal notranslate"><span class="pre">ty</span></code></p>
</div>
<div class="section" id="id278">
<h5><a class="toc-backref" href="#id1930">Semantics:</a><a class="headerlink" href="#id278" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">sitofp</span></code>’ instruction interprets its operand as a signed integer
quantity and converts it to the corresponding floating-point value. If the
value cannot be exactly represented, it is rounded using the default rounding
mode.</p>
</div>
<div class="section" id="id279">
<h5><a class="toc-backref" href="#id1931">Example:</a><a class="headerlink" href="#id279" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%X</span> <span class="p">=</span> <span class="k">sitofp</span> <span class="k">i32</span> <span class="m">257</span> <span class="k">to</span> <span class="k">float</span> <span class="c">; yields float:257.0</span>
<span class="nv">%Y</span> <span class="p">=</span> <span class="k">sitofp</span> <span class="k">i8</span> <span class="m">-1</span> <span class="k">to</span> <span class="k">double</span> <span class="c">; yields double:-1.0</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="ptrtoint-to-instruction">
<span id="i-ptrtoint"></span><h4><a class="toc-backref" href="#id1932">‘<code class="docutils literal notranslate"><span class="pre">ptrtoint</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a><a class="headerlink" href="#ptrtoint-to-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id280">
<h5><a class="toc-backref" href="#id1933">Syntax:</a><a class="headerlink" href="#id280" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">ptrtoint</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span> <span class="n">to</span> <span class="o"><</span><span class="n">ty2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty2</span>
</pre></div>
</div>
</div>
<div class="section" id="id281">
<h5><a class="toc-backref" href="#id1934">Overview:</a><a class="headerlink" href="#id281" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">ptrtoint</span></code>’ instruction converts the pointer or a vector of
pointers <code class="docutils literal notranslate"><span class="pre">value</span></code> to the integer (or vector of integers) type <code class="docutils literal notranslate"><span class="pre">ty2</span></code>.</p>
</div>
<div class="section" id="id282">
<h5><a class="toc-backref" href="#id1935">Arguments:</a><a class="headerlink" href="#id282" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">ptrtoint</span></code>’ instruction takes a <code class="docutils literal notranslate"><span class="pre">value</span></code> to cast, which must be
a value of type <a class="reference internal" href="#t-pointer"><span class="std std-ref">pointer</span></a> or a vector of pointers, and a
type to cast it to <code class="docutils literal notranslate"><span class="pre">ty2</span></code>, which must be an <a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> or
a vector of integers type.</p>
</div>
<div class="section" id="id283">
<h5><a class="toc-backref" href="#id1936">Semantics:</a><a class="headerlink" href="#id283" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">ptrtoint</span></code>’ instruction converts <code class="docutils literal notranslate"><span class="pre">value</span></code> to integer type
<code class="docutils literal notranslate"><span class="pre">ty2</span></code> by interpreting the pointer value as an integer and either
truncating or zero extending that value to the size of the integer type.
If <code class="docutils literal notranslate"><span class="pre">value</span></code> is smaller than <code class="docutils literal notranslate"><span class="pre">ty2</span></code> then a zero extension is done. If
<code class="docutils literal notranslate"><span class="pre">value</span></code> is larger than <code class="docutils literal notranslate"><span class="pre">ty2</span></code> then a truncation is done. If they are
the same size, then nothing is done (<em>no-op cast</em>) other than a type
change.</p>
</div>
<div class="section" id="id284">
<h5><a class="toc-backref" href="#id1937">Example:</a><a class="headerlink" href="#id284" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%X</span> <span class="p">=</span> <span class="k">ptrtoint</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%P</span> <span class="k">to</span> <span class="k">i8</span> <span class="c">; yields truncation on 32-bit architecture</span>
<span class="nv">%Y</span> <span class="p">=</span> <span class="k">ptrtoint</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%P</span> <span class="k">to</span> <span class="k">i64</span> <span class="c">; yields zero extension on 32-bit architecture</span>
<span class="nv">%Z</span> <span class="p">=</span> <span class="k">ptrtoint</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">*></span> <span class="nv">%P</span> <span class="k">to</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i64</span><span class="p">></span><span class="c">; yields vector zero extension for a vector of addresses on 32-bit architecture</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="inttoptr-to-instruction">
<span id="i-inttoptr"></span><h4><a class="toc-backref" href="#id1938">‘<code class="docutils literal notranslate"><span class="pre">inttoptr</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a><a class="headerlink" href="#inttoptr-to-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id285">
<h5><a class="toc-backref" href="#id1939">Syntax:</a><a class="headerlink" href="#id285" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><result> = inttoptr <ty> <value> to <ty2>[, !dereferenceable !<deref_bytes_node>][, !dereferenceable_or_null !<deref_bytes_node>] ; yields ty2
</pre></div>
</div>
</div>
<div class="section" id="id286">
<h5><a class="toc-backref" href="#id1940">Overview:</a><a class="headerlink" href="#id286" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">inttoptr</span></code>’ instruction converts an integer <code class="docutils literal notranslate"><span class="pre">value</span></code> to a
pointer type, <code class="docutils literal notranslate"><span class="pre">ty2</span></code>.</p>
</div>
<div class="section" id="id287">
<h5><a class="toc-backref" href="#id1941">Arguments:</a><a class="headerlink" href="#id287" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">inttoptr</span></code>’ instruction takes an <a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> value to
cast, and a type to cast it to, which must be a <a class="reference internal" href="#t-pointer"><span class="std std-ref">pointer</span></a>
type.</p>
<p>The optional <code class="docutils literal notranslate"><span class="pre">!dereferenceable</span></code> metadata must reference a single metadata
name <code class="docutils literal notranslate"><span class="pre"><deref_bytes_node></span></code> corresponding to a metadata node with one <code class="docutils literal notranslate"><span class="pre">i64</span></code>
entry.
See <code class="docutils literal notranslate"><span class="pre">dereferenceable</span></code> metadata.</p>
<p>The optional <code class="docutils literal notranslate"><span class="pre">!dereferenceable_or_null</span></code> metadata must reference a single
metadata name <code class="docutils literal notranslate"><span class="pre"><deref_bytes_node></span></code> corresponding to a metadata node with one
<code class="docutils literal notranslate"><span class="pre">i64</span></code> entry.
See <code class="docutils literal notranslate"><span class="pre">dereferenceable_or_null</span></code> metadata.</p>
</div>
<div class="section" id="id288">
<h5><a class="toc-backref" href="#id1942">Semantics:</a><a class="headerlink" href="#id288" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">inttoptr</span></code>’ instruction converts <code class="docutils literal notranslate"><span class="pre">value</span></code> to type <code class="docutils literal notranslate"><span class="pre">ty2</span></code> by
applying either a zero extension or a truncation depending on the size
of the integer <code class="docutils literal notranslate"><span class="pre">value</span></code>. If <code class="docutils literal notranslate"><span class="pre">value</span></code> is larger than the size of a
pointer then a truncation is done. If <code class="docutils literal notranslate"><span class="pre">value</span></code> is smaller than the size
of a pointer then a zero extension is done. If they are the same size,
nothing is done (<em>no-op cast</em>).</p>
</div>
<div class="section" id="id289">
<h5><a class="toc-backref" href="#id1943">Example:</a><a class="headerlink" href="#id289" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%X</span> <span class="p">=</span> <span class="k">inttoptr</span> <span class="k">i32</span> <span class="m">255</span> <span class="k">to</span> <span class="k">i32</span><span class="p">*</span> <span class="c">; yields zero extension on 64-bit architecture</span>
<span class="nv">%Y</span> <span class="p">=</span> <span class="k">inttoptr</span> <span class="k">i32</span> <span class="m">255</span> <span class="k">to</span> <span class="k">i32</span><span class="p">*</span> <span class="c">; yields no-op on 32-bit architecture</span>
<span class="nv">%Z</span> <span class="p">=</span> <span class="k">inttoptr</span> <span class="k">i64</span> <span class="m">0</span> <span class="k">to</span> <span class="k">i32</span><span class="p">*</span> <span class="c">; yields truncation on 32-bit architecture</span>
<span class="nv">%Z</span> <span class="p">=</span> <span class="k">inttoptr</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%G</span> <span class="k">to</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i8</span><span class="p">*></span><span class="c">; yields truncation of vector G to four pointers</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="bitcast-to-instruction">
<span id="i-bitcast"></span><h4><a class="toc-backref" href="#id1944">‘<code class="docutils literal notranslate"><span class="pre">bitcast</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a><a class="headerlink" href="#bitcast-to-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id290">
<h5><a class="toc-backref" href="#id1945">Syntax:</a><a class="headerlink" href="#id290" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">bitcast</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span> <span class="n">to</span> <span class="o"><</span><span class="n">ty2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty2</span>
</pre></div>
</div>
</div>
<div class="section" id="id291">
<h5><a class="toc-backref" href="#id1946">Overview:</a><a class="headerlink" href="#id291" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">bitcast</span></code>’ instruction converts <code class="docutils literal notranslate"><span class="pre">value</span></code> to type <code class="docutils literal notranslate"><span class="pre">ty2</span></code> without
changing any bits.</p>
</div>
<div class="section" id="id292">
<h5><a class="toc-backref" href="#id1947">Arguments:</a><a class="headerlink" href="#id292" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">bitcast</span></code>’ instruction takes a value to cast, which must be a
non-aggregate first class value, and a type to cast it to, which must
also be a non-aggregate <a class="reference internal" href="#t-firstclass"><span class="std std-ref">first class</span></a> type. The
bit sizes of <code class="docutils literal notranslate"><span class="pre">value</span></code> and the destination type, <code class="docutils literal notranslate"><span class="pre">ty2</span></code>, must be
identical. If the source type is a pointer, the destination type must
also be a pointer of the same size. This instruction supports bitwise
conversion of vectors to integers and to vectors of other types (as
long as they have the same size).</p>
</div>
<div class="section" id="id293">
<h5><a class="toc-backref" href="#id1948">Semantics:</a><a class="headerlink" href="#id293" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">bitcast</span></code>’ instruction converts <code class="docutils literal notranslate"><span class="pre">value</span></code> to type <code class="docutils literal notranslate"><span class="pre">ty2</span></code>. It
is always a <em>no-op cast</em> because no bits change with this
conversion. The conversion is done as if the <code class="docutils literal notranslate"><span class="pre">value</span></code> had been stored
to memory and read back as type <code class="docutils literal notranslate"><span class="pre">ty2</span></code>. Pointer (or vector of
pointers) types may only be converted to other pointer (or vector of
pointers) types with the same address space through this instruction.
To convert pointers to other types, use the <a class="reference internal" href="#i-inttoptr"><span class="std std-ref">inttoptr</span></a>
or <a class="reference internal" href="#i-ptrtoint"><span class="std std-ref">ptrtoint</span></a> instructions first.</p>
<p>There is a caveat for bitcasts involving vector types in relation to
endianess. For example <code class="docutils literal notranslate"><span class="pre">bitcast</span> <span class="pre"><2</span> <span class="pre">x</span> <span class="pre">i8></span> <span class="pre"><value></span> <span class="pre">to</span> <span class="pre">i16</span></code> puts element zero
of the vector in the least significant bits of the i16 for little-endian while
element zero ends up in the most significant bits for big-endian.</p>
</div>
<div class="section" id="id294">
<h5><a class="toc-backref" href="#id1949">Example:</a><a class="headerlink" href="#id294" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>%X = bitcast i8 255 to i8 ; yields i8 :-1
%Y = bitcast i32* %x to sint* ; yields sint*:%x
%Z = bitcast <2 x int> %V to i64; ; yields i64: %V (depends on endianess)
%Z = bitcast <2 x i32*> %V to <2 x i64*> ; yields <2 x i64*>
</pre></div>
</div>
</div>
</div>
<div class="section" id="addrspacecast-to-instruction">
<span id="i-addrspacecast"></span><h4><a class="toc-backref" href="#id1950">‘<code class="docutils literal notranslate"><span class="pre">addrspacecast</span> <span class="pre">..</span> <span class="pre">to</span></code>’ Instruction</a><a class="headerlink" href="#addrspacecast-to-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id295">
<h5><a class="toc-backref" href="#id1951">Syntax:</a><a class="headerlink" href="#id295" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">addrspacecast</span> <span class="o"><</span><span class="n">pty</span><span class="o">></span> <span class="o"><</span><span class="n">ptrval</span><span class="o">></span> <span class="n">to</span> <span class="o"><</span><span class="n">pty2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">pty2</span>
</pre></div>
</div>
</div>
<div class="section" id="id296">
<h5><a class="toc-backref" href="#id1952">Overview:</a><a class="headerlink" href="#id296" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">addrspacecast</span></code>’ instruction converts <code class="docutils literal notranslate"><span class="pre">ptrval</span></code> from <code class="docutils literal notranslate"><span class="pre">pty</span></code> in
address space <code class="docutils literal notranslate"><span class="pre">n</span></code> to type <code class="docutils literal notranslate"><span class="pre">pty2</span></code> in address space <code class="docutils literal notranslate"><span class="pre">m</span></code>.</p>
</div>
<div class="section" id="id297">
<h5><a class="toc-backref" href="#id1953">Arguments:</a><a class="headerlink" href="#id297" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">addrspacecast</span></code>’ instruction takes a pointer or vector of pointer value
to cast and a pointer type to cast it to, which must have a different
address space.</p>
</div>
<div class="section" id="id298">
<h5><a class="toc-backref" href="#id1954">Semantics:</a><a class="headerlink" href="#id298" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">addrspacecast</span></code>’ instruction converts the pointer value
<code class="docutils literal notranslate"><span class="pre">ptrval</span></code> to type <code class="docutils literal notranslate"><span class="pre">pty2</span></code>. It can be a <em>no-op cast</em> or a complex
value modification, depending on the target and the address space
pair. Pointer conversions within the same address space must be
performed with the <code class="docutils literal notranslate"><span class="pre">bitcast</span></code> instruction. Note that if the address space
conversion is legal then both result and operand refer to the same memory
location.</p>
</div>
<div class="section" id="id299">
<h5><a class="toc-backref" href="#id1955">Example:</a><a class="headerlink" href="#id299" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%X</span> <span class="p">=</span> <span class="k">addrspacecast</span> <span class="k">i32</span><span class="p">*</span> <span class="nv">%x</span> <span class="k">to</span> <span class="k">i32</span> <span class="k">addrspace</span><span class="p">(</span><span class="m">1</span><span class="p">)*</span> <span class="c">; yields i32 addrspace(1)*:%x</span>
<span class="nv">%Y</span> <span class="p">=</span> <span class="k">addrspacecast</span> <span class="k">i32</span> <span class="k">addrspace</span><span class="p">(</span><span class="m">1</span><span class="p">)*</span> <span class="nv">%y</span> <span class="k">to</span> <span class="k">i64</span> <span class="k">addrspace</span><span class="p">(</span><span class="m">2</span><span class="p">)*</span> <span class="c">; yields i64 addrspace(2)*:%y</span>
<span class="nv">%Z</span> <span class="p">=</span> <span class="k">addrspacecast</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">*></span> <span class="nv">%z</span> <span class="k">to</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span> <span class="k">addrspace</span><span class="p">(</span><span class="m">3</span><span class="p">)*></span> <span class="c">; yields <4 x float addrspace(3)*>:%z</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="other-operations">
<span id="otherops"></span><h3><a class="toc-backref" href="#id1956">Other Operations</a><a class="headerlink" href="#other-operations" title="Permalink to this headline">¶</a></h3>
<p>The instructions in this category are the “miscellaneous” instructions,
which defy better classification.</p>
<div class="section" id="icmp-instruction">
<span id="i-icmp"></span><h4><a class="toc-backref" href="#id1957">‘<code class="docutils literal notranslate"><span class="pre">icmp</span></code>’ Instruction</a><a class="headerlink" href="#icmp-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id300">
<h5><a class="toc-backref" href="#id1958">Syntax:</a><a class="headerlink" href="#id300" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">icmp</span> <span class="o"><</span><span class="n">cond</span><span class="o">></span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">i1</span> <span class="ow">or</span> <span class="o"><</span><span class="n">N</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id301">
<h5><a class="toc-backref" href="#id1959">Overview:</a><a class="headerlink" href="#id301" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">icmp</span></code>’ instruction returns a boolean value or a vector of
boolean values based on comparison of its two integer, integer vector,
pointer, or pointer vector operands.</p>
</div>
<div class="section" id="id302">
<h5><a class="toc-backref" href="#id1960">Arguments:</a><a class="headerlink" href="#id302" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">icmp</span></code>’ instruction takes three operands. The first operand is
the condition code indicating the kind of comparison to perform. It is
not a value, just a keyword. The possible condition codes are:</p>
<ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">eq</span></code>: equal</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ne</span></code>: not equal</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ugt</span></code>: unsigned greater than</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">uge</span></code>: unsigned greater or equal</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ult</span></code>: unsigned less than</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ule</span></code>: unsigned less or equal</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sgt</span></code>: signed greater than</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sge</span></code>: signed greater or equal</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">slt</span></code>: signed less than</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sle</span></code>: signed less or equal</p></li>
</ol>
<p>The remaining two arguments must be <a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> or
<a class="reference internal" href="#t-pointer"><span class="std std-ref">pointer</span></a> or integer <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> typed. They
must also be identical types.</p>
</div>
<div class="section" id="id303">
<h5><a class="toc-backref" href="#id1961">Semantics:</a><a class="headerlink" href="#id303" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">icmp</span></code>’ compares <code class="docutils literal notranslate"><span class="pre">op1</span></code> and <code class="docutils literal notranslate"><span class="pre">op2</span></code> according to the condition
code given as <code class="docutils literal notranslate"><span class="pre">cond</span></code>. The comparison performed always yields either an
<a class="reference internal" href="#t-integer"><span class="std std-ref">i1</span></a> or vector of <code class="docutils literal notranslate"><span class="pre">i1</span></code> result, as follows:</p>
<ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">eq</span></code>: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if the operands are equal, <code class="docutils literal notranslate"><span class="pre">false</span></code>
otherwise. No sign interpretation is necessary or performed.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ne</span></code>: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if the operands are unequal, <code class="docutils literal notranslate"><span class="pre">false</span></code>
otherwise. No sign interpretation is necessary or performed.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ugt</span></code>: interprets the operands as unsigned values and yields
<code class="docutils literal notranslate"><span class="pre">true</span></code> if <code class="docutils literal notranslate"><span class="pre">op1</span></code> is greater than <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">uge</span></code>: interprets the operands as unsigned values and yields
<code class="docutils literal notranslate"><span class="pre">true</span></code> if <code class="docutils literal notranslate"><span class="pre">op1</span></code> is greater than or equal to <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ult</span></code>: interprets the operands as unsigned values and yields
<code class="docutils literal notranslate"><span class="pre">true</span></code> if <code class="docutils literal notranslate"><span class="pre">op1</span></code> is less than <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ule</span></code>: interprets the operands as unsigned values and yields
<code class="docutils literal notranslate"><span class="pre">true</span></code> if <code class="docutils literal notranslate"><span class="pre">op1</span></code> is less than or equal to <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sgt</span></code>: interprets the operands as signed values and yields <code class="docutils literal notranslate"><span class="pre">true</span></code>
if <code class="docutils literal notranslate"><span class="pre">op1</span></code> is greater than <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sge</span></code>: interprets the operands as signed values and yields <code class="docutils literal notranslate"><span class="pre">true</span></code>
if <code class="docutils literal notranslate"><span class="pre">op1</span></code> is greater than or equal to <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">slt</span></code>: interprets the operands as signed values and yields <code class="docutils literal notranslate"><span class="pre">true</span></code>
if <code class="docutils literal notranslate"><span class="pre">op1</span></code> is less than <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">sle</span></code>: interprets the operands as signed values and yields <code class="docutils literal notranslate"><span class="pre">true</span></code>
if <code class="docutils literal notranslate"><span class="pre">op1</span></code> is less than or equal to <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
</ol>
<p>If the operands are <a class="reference internal" href="#t-pointer"><span class="std std-ref">pointer</span></a> typed, the pointer values
are compared as if they were integers.</p>
<p>If the operands are integer vectors, then they are compared element by
element. The result is an <code class="docutils literal notranslate"><span class="pre">i1</span></code> vector with the same number of elements
as the values being compared. Otherwise, the result is an <code class="docutils literal notranslate"><span class="pre">i1</span></code>.</p>
</div>
<div class="section" id="id304">
<h5><a class="toc-backref" href="#id1962">Example:</a><a class="headerlink" href="#id304" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = icmp eq i32 4, 5 ; yields: result=false
<result> = icmp ne float* %X, %X ; yields: result=false
<result> = icmp ult i16 4, 5 ; yields: result=true
<result> = icmp sgt i16 4, 5 ; yields: result=false
<result> = icmp ule i16 -4, 5 ; yields: result=false
<result> = icmp sge i16 4, 5 ; yields: result=false
</pre></div>
</div>
</div>
</div>
<div class="section" id="fcmp-instruction">
<span id="i-fcmp"></span><h4><a class="toc-backref" href="#id1963">‘<code class="docutils literal notranslate"><span class="pre">fcmp</span></code>’ Instruction</a><a class="headerlink" href="#fcmp-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id305">
<h5><a class="toc-backref" href="#id1964">Syntax:</a><a class="headerlink" href="#id305" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">fcmp</span> <span class="p">[</span><span class="n">fast</span><span class="o">-</span><span class="n">math</span> <span class="n">flags</span><span class="p">]</span><span class="o">*</span> <span class="o"><</span><span class="n">cond</span><span class="o">></span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">i1</span> <span class="ow">or</span> <span class="o"><</span><span class="n">N</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id306">
<h5><a class="toc-backref" href="#id1965">Overview:</a><a class="headerlink" href="#id306" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">fcmp</span></code>’ instruction returns a boolean value or vector of boolean
values based on comparison of its operands.</p>
<p>If the operands are floating-point scalars, then the result type is a
boolean (<a class="reference internal" href="#t-integer"><span class="std std-ref">i1</span></a>).</p>
<p>If the operands are floating-point vectors, then the result type is a
vector of boolean with the same number of elements as the operands being
compared.</p>
</div>
<div class="section" id="id307">
<h5><a class="toc-backref" href="#id1966">Arguments:</a><a class="headerlink" href="#id307" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">fcmp</span></code>’ instruction takes three operands. The first operand is
the condition code indicating the kind of comparison to perform. It is
not a value, just a keyword. The possible condition codes are:</p>
<ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">false</span></code>: no comparison, always returns false</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">oeq</span></code>: ordered and equal</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ogt</span></code>: ordered and greater than</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">oge</span></code>: ordered and greater than or equal</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">olt</span></code>: ordered and less than</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ole</span></code>: ordered and less than or equal</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">one</span></code>: ordered and not equal</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ord</span></code>: ordered (no nans)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ueq</span></code>: unordered or equal</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ugt</span></code>: unordered or greater than</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">uge</span></code>: unordered or greater than or equal</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ult</span></code>: unordered or less than</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ule</span></code>: unordered or less than or equal</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">une</span></code>: unordered or not equal</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">uno</span></code>: unordered (either nans)</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">true</span></code>: no comparison, always returns true</p></li>
</ol>
<p><em>Ordered</em> means that neither operand is a QNAN while <em>unordered</em> means
that either operand may be a QNAN.</p>
<p>Each of <code class="docutils literal notranslate"><span class="pre">val1</span></code> and <code class="docutils literal notranslate"><span class="pre">val2</span></code> arguments must be either a <a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> type or a <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of floating-point type.
They must have identical types.</p>
</div>
<div class="section" id="id308">
<h5><a class="toc-backref" href="#id1967">Semantics:</a><a class="headerlink" href="#id308" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">fcmp</span></code>’ instruction compares <code class="docutils literal notranslate"><span class="pre">op1</span></code> and <code class="docutils literal notranslate"><span class="pre">op2</span></code> according to the
condition code given as <code class="docutils literal notranslate"><span class="pre">cond</span></code>. If the operands are vectors, then the
vectors are compared element by element. Each comparison performed
always yields an <a class="reference internal" href="#t-integer"><span class="std std-ref">i1</span></a> result, as follows:</p>
<ol class="arabic simple">
<li><p><code class="docutils literal notranslate"><span class="pre">false</span></code>: always yields <code class="docutils literal notranslate"><span class="pre">false</span></code>, regardless of operands.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">oeq</span></code>: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if both operands are not a QNAN and <code class="docutils literal notranslate"><span class="pre">op1</span></code>
is equal to <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ogt</span></code>: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if both operands are not a QNAN and <code class="docutils literal notranslate"><span class="pre">op1</span></code>
is greater than <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">oge</span></code>: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if both operands are not a QNAN and <code class="docutils literal notranslate"><span class="pre">op1</span></code>
is greater than or equal to <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">olt</span></code>: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if both operands are not a QNAN and <code class="docutils literal notranslate"><span class="pre">op1</span></code>
is less than <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ole</span></code>: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if both operands are not a QNAN and <code class="docutils literal notranslate"><span class="pre">op1</span></code>
is less than or equal to <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">one</span></code>: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if both operands are not a QNAN and <code class="docutils literal notranslate"><span class="pre">op1</span></code>
is not equal to <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ord</span></code>: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if both operands are not a QNAN.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ueq</span></code>: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if either operand is a QNAN or <code class="docutils literal notranslate"><span class="pre">op1</span></code> is
equal to <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ugt</span></code>: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if either operand is a QNAN or <code class="docutils literal notranslate"><span class="pre">op1</span></code> is
greater than <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">uge</span></code>: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if either operand is a QNAN or <code class="docutils literal notranslate"><span class="pre">op1</span></code> is
greater than or equal to <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ult</span></code>: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if either operand is a QNAN or <code class="docutils literal notranslate"><span class="pre">op1</span></code> is
less than <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">ule</span></code>: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if either operand is a QNAN or <code class="docutils literal notranslate"><span class="pre">op1</span></code> is
less than or equal to <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">une</span></code>: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if either operand is a QNAN or <code class="docutils literal notranslate"><span class="pre">op1</span></code> is
not equal to <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">uno</span></code>: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if either operand is a QNAN.</p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">true</span></code>: always yields <code class="docutils literal notranslate"><span class="pre">true</span></code>, regardless of operands.</p></li>
</ol>
<p>The <code class="docutils literal notranslate"><span class="pre">fcmp</span></code> instruction can also optionally take any number of
<a class="reference internal" href="#fastmath"><span class="std std-ref">fast-math flags</span></a>, which are optimization hints to enable
otherwise unsafe floating-point optimizations.</p>
<p>Any set of fast-math flags are legal on an <code class="docutils literal notranslate"><span class="pre">fcmp</span></code> instruction, but the
only flags that have any effect on its semantics are those that allow
assumptions to be made about the values of input arguments; namely
<code class="docutils literal notranslate"><span class="pre">nnan</span></code>, <code class="docutils literal notranslate"><span class="pre">ninf</span></code>, and <code class="docutils literal notranslate"><span class="pre">reassoc</span></code>. See <a class="reference internal" href="#fastmath"><span class="std std-ref">Fast-Math Flags</span></a> for more information.</p>
</div>
<div class="section" id="id309">
<h5><a class="toc-backref" href="#id1968">Example:</a><a class="headerlink" href="#id309" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span><result> = fcmp oeq float 4.0, 5.0 ; yields: result=false
<result> = fcmp one float 4.0, 5.0 ; yields: result=true
<result> = fcmp olt float 4.0, 5.0 ; yields: result=true
<result> = fcmp ueq double 1.0, 2.0 ; yields: result=false
</pre></div>
</div>
</div>
</div>
<div class="section" id="phi-instruction">
<span id="i-phi"></span><h4><a class="toc-backref" href="#id1969">‘<code class="docutils literal notranslate"><span class="pre">phi</span></code>’ Instruction</a><a class="headerlink" href="#phi-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id310">
<h5><a class="toc-backref" href="#id1970">Syntax:</a><a class="headerlink" href="#id310" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">phi</span> <span class="p">[</span><span class="n">fast</span><span class="o">-</span><span class="n">math</span><span class="o">-</span><span class="n">flags</span><span class="p">]</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="p">[</span> <span class="o"><</span><span class="n">val0</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">label0</span><span class="o">></span><span class="p">],</span> <span class="o">...</span>
</pre></div>
</div>
</div>
<div class="section" id="id311">
<h5><a class="toc-backref" href="#id1971">Overview:</a><a class="headerlink" href="#id311" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">phi</span></code>’ instruction is used to implement the φ node in the SSA
graph representing the function.</p>
</div>
<div class="section" id="id312">
<h5><a class="toc-backref" href="#id1972">Arguments:</a><a class="headerlink" href="#id312" title="Permalink to this headline">¶</a></h5>
<p>The type of the incoming values is specified with the first type field.
After this, the ‘<code class="docutils literal notranslate"><span class="pre">phi</span></code>’ instruction takes a list of pairs as
arguments, with one pair for each predecessor basic block of the current
block. Only values of <a class="reference internal" href="#t-firstclass"><span class="std std-ref">first class</span></a> type may be used as
the value arguments to the PHI node. Only labels may be used as the
label arguments.</p>
<p>There must be no non-phi instructions between the start of a basic block
and the PHI instructions: i.e. PHI instructions must be first in a basic
block.</p>
<p>For the purposes of the SSA form, the use of each incoming value is
deemed to occur on the edge from the corresponding predecessor block to
the current block (but after any definition of an ‘<code class="docutils literal notranslate"><span class="pre">invoke</span></code>’
instruction’s return value on the same edge).</p>
<p>The optional <code class="docutils literal notranslate"><span class="pre">fast-math-flags</span></code> marker indicates that the phi has one
or more <a class="reference internal" href="#fastmath"><span class="std std-ref">fast-math-flags</span></a>. These are optimization hints
to enable otherwise unsafe floating-point optimizations. Fast-math-flags
are only valid for phis that return a floating-point scalar or vector
type, or an array (nested to any depth) of floating-point scalar or vector
types.</p>
</div>
<div class="section" id="id313">
<h5><a class="toc-backref" href="#id1973">Semantics:</a><a class="headerlink" href="#id313" title="Permalink to this headline">¶</a></h5>
<p>At runtime, the ‘<code class="docutils literal notranslate"><span class="pre">phi</span></code>’ instruction logically takes on the value
specified by the pair corresponding to the predecessor basic block that
executed just prior to the current block.</p>
</div>
<div class="section" id="id314">
<h5><a class="toc-backref" href="#id1974">Example:</a><a class="headerlink" href="#id314" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nl">Loop:</span> <span class="c">; Infinite loop that counts from 0 on up...</span>
<span class="nv">%indvar</span> <span class="p">=</span> <span class="k">phi</span> <span class="k">i32</span> <span class="p">[</span> <span class="m">0</span><span class="p">,</span> <span class="nv">%LoopHeader</span> <span class="p">],</span> <span class="p">[</span> <span class="nv">%nextindvar</span><span class="p">,</span> <span class="nv">%Loop</span> <span class="p">]</span>
<span class="nv">%nextindvar</span> <span class="p">=</span> <span class="k">add</span> <span class="k">i32</span> <span class="nv">%indvar</span><span class="p">,</span> <span class="m">1</span>
<span class="k">br</span> <span class="k">label</span> <span class="nv">%Loop</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="select-instruction">
<span id="i-select"></span><h4><a class="toc-backref" href="#id1975">‘<code class="docutils literal notranslate"><span class="pre">select</span></code>’ Instruction</a><a class="headerlink" href="#select-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id315">
<h5><a class="toc-backref" href="#id1976">Syntax:</a><a class="headerlink" href="#id315" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">select</span> <span class="p">[</span><span class="n">fast</span><span class="o">-</span><span class="n">math</span> <span class="n">flags</span><span class="p">]</span> <span class="n">selty</span> <span class="o"><</span><span class="n">cond</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">val1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">ty</span><span class="o">></span> <span class="o"><</span><span class="n">val2</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span>
<span class="n">selty</span> <span class="ow">is</span> <span class="n">either</span> <span class="n">i1</span> <span class="ow">or</span> <span class="p">{</span><span class="o"><</span><span class="n">N</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span><span class="p">}</span>
</pre></div>
</div>
</div>
<div class="section" id="id316">
<h5><a class="toc-backref" href="#id1977">Overview:</a><a class="headerlink" href="#id316" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">select</span></code>’ instruction is used to choose one value based on a
condition, without IR-level branching.</p>
</div>
<div class="section" id="id317">
<h5><a class="toc-backref" href="#id1978">Arguments:</a><a class="headerlink" href="#id317" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">select</span></code>’ instruction requires an ‘i1’ value or a vector of ‘i1’
values indicating the condition, and two values of the same <a class="reference internal" href="#t-firstclass"><span class="std std-ref">first
class</span></a> type.</p>
<ol class="arabic simple">
<li><p>The optional <code class="docutils literal notranslate"><span class="pre">fast-math</span> <span class="pre">flags</span></code> marker indicates that the select has one or more
<a class="reference internal" href="#fastmath"><span class="std std-ref">fast-math flags</span></a>. These are optimization hints to enable
otherwise unsafe floating-point optimizations. Fast-math flags are only valid
for selects that return a floating-point scalar or vector type, or an array
(nested to any depth) of floating-point scalar or vector types.</p></li>
</ol>
</div>
<div class="section" id="id318">
<h5><a class="toc-backref" href="#id1979">Semantics:</a><a class="headerlink" href="#id318" title="Permalink to this headline">¶</a></h5>
<p>If the condition is an i1 and it evaluates to 1, the instruction returns
the first value argument; otherwise, it returns the second value
argument.</p>
<p>If the condition is a vector of i1, then the value arguments must be
vectors of the same size, and the selection is done element by element.</p>
<p>If the condition is an i1 and the value arguments are vectors of the
same size, then an entire vector is selected.</p>
</div>
<div class="section" id="id319">
<h5><a class="toc-backref" href="#id1980">Example:</a><a class="headerlink" href="#id319" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%X</span> <span class="p">=</span> <span class="k">select</span> <span class="k">i1</span> <span class="k">true</span><span class="p">,</span> <span class="k">i8</span> <span class="m">17</span><span class="p">,</span> <span class="k">i8</span> <span class="m">42</span> <span class="c">; yields i8:17</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="freeze-instruction">
<span id="i-freeze"></span><h4><a class="toc-backref" href="#id1981">‘<code class="docutils literal notranslate"><span class="pre">freeze</span></code>’ Instruction</a><a class="headerlink" href="#freeze-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id320">
<h5><a class="toc-backref" href="#id1982">Syntax:</a><a class="headerlink" href="#id320" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="n">freeze</span> <span class="n">ty</span> <span class="o"><</span><span class="n">val</span><span class="o">></span> <span class="p">;</span> <span class="n">yields</span> <span class="n">ty</span><span class="p">:</span><span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id321">
<h5><a class="toc-backref" href="#id1983">Overview:</a><a class="headerlink" href="#id321" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">freeze</span></code>’ instruction is used to stop propagation of
<a class="reference internal" href="#undefvalues"><span class="std std-ref">undef</span></a> and <a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison</span></a> values.</p>
</div>
<div class="section" id="id322">
<h5><a class="toc-backref" href="#id1984">Arguments:</a><a class="headerlink" href="#id322" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">freeze</span></code>’ instruction takes a single argument.</p>
</div>
<div class="section" id="id323">
<h5><a class="toc-backref" href="#id1985">Semantics:</a><a class="headerlink" href="#id323" title="Permalink to this headline">¶</a></h5>
<p>If the argument is <code class="docutils literal notranslate"><span class="pre">undef</span></code> or <code class="docutils literal notranslate"><span class="pre">poison</span></code>, ‘<code class="docutils literal notranslate"><span class="pre">freeze</span></code>’ returns an
arbitrary, but fixed, value of type ‘<code class="docutils literal notranslate"><span class="pre">ty</span></code>’.
Otherwise, this instruction is a no-op and returns the input argument.
All uses of a value returned by the same ‘<code class="docutils literal notranslate"><span class="pre">freeze</span></code>’ instruction are
guaranteed to always observe the same value, while different ‘<code class="docutils literal notranslate"><span class="pre">freeze</span></code>’
instructions may yield different values.</p>
<p>While <code class="docutils literal notranslate"><span class="pre">undef</span></code> and <code class="docutils literal notranslate"><span class="pre">poison</span></code> pointers can be frozen, the result is a
non-dereferenceable pointer. See the
<a class="reference internal" href="#pointeraliasing"><span class="std std-ref">Pointer Aliasing Rules</span></a> section for more information.
If an aggregate value or vector is frozen, the operand is frozen element-wise.
The padding of an aggregate isn’t considered, since it isn’t visible
without storing it into memory and loading it with a different type.</p>
</div>
<div class="section" id="id324">
<h5><a class="toc-backref" href="#id1986">Example:</a><a class="headerlink" href="#id324" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>%w = i32 undef
%x = freeze i32 %w
%y = add i32 %w, %w ; undef
%z = add i32 %x, %x ; even number because all uses of %x observe
; the same value
%x2 = freeze i32 %w
%cmp = icmp eq i32 %x, %x2 ; can be true or false
; example with vectors
%v = <2 x i32> <i32 undef, i32 poison>
%a = extractelement <2 x i32> %v, i32 0 ; undef
%b = extractelement <2 x i32> %v, i32 1 ; poison
%add = add i32 %a, %a ; undef
%v.fr = freeze <2 x i32> %v ; element-wise freeze
%d = extractelement <2 x i32> %v.fr, i32 0 ; not undef
%add.f = add i32 %d, %d ; even number
; branching on frozen value
%poison = add nsw i1 %k, undef ; poison
%c = freeze i1 %poison
br i1 %c, label %foo, label %bar ; non-deterministic branch to %foo or %bar
</pre></div>
</div>
</div>
</div>
<div class="section" id="call-instruction">
<span id="i-call"></span><h4><a class="toc-backref" href="#id1987">‘<code class="docutils literal notranslate"><span class="pre">call</span></code>’ Instruction</a><a class="headerlink" href="#call-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id325">
<h5><a class="toc-backref" href="#id1988">Syntax:</a><a class="headerlink" href="#id325" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">result</span><span class="o">></span> <span class="o">=</span> <span class="p">[</span><span class="n">tail</span> <span class="o">|</span> <span class="n">musttail</span> <span class="o">|</span> <span class="n">notail</span> <span class="p">]</span> <span class="n">call</span> <span class="p">[</span><span class="n">fast</span><span class="o">-</span><span class="n">math</span> <span class="n">flags</span><span class="p">]</span> <span class="p">[</span><span class="n">cconv</span><span class="p">]</span> <span class="p">[</span><span class="n">ret</span> <span class="n">attrs</span><span class="p">]</span> <span class="p">[</span><span class="n">addrspace</span><span class="p">(</span><span class="o"><</span><span class="n">num</span><span class="o">></span><span class="p">)]</span>
<span class="o"><</span><span class="n">ty</span><span class="o">>|<</span><span class="n">fnty</span><span class="o">></span> <span class="o"><</span><span class="n">fnptrval</span><span class="o">></span><span class="p">(</span><span class="o"><</span><span class="n">function</span> <span class="n">args</span><span class="o">></span><span class="p">)</span> <span class="p">[</span><span class="n">fn</span> <span class="n">attrs</span><span class="p">]</span> <span class="p">[</span> <span class="n">operand</span> <span class="n">bundles</span> <span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="id326">
<h5><a class="toc-backref" href="#id1989">Overview:</a><a class="headerlink" href="#id326" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">call</span></code>’ instruction represents a simple function call.</p>
</div>
<div class="section" id="id327">
<h5><a class="toc-backref" href="#id1990">Arguments:</a><a class="headerlink" href="#id327" title="Permalink to this headline">¶</a></h5>
<p>This instruction requires several arguments:</p>
<ol class="arabic">
<li><p>The optional <code class="docutils literal notranslate"><span class="pre">tail</span></code> and <code class="docutils literal notranslate"><span class="pre">musttail</span></code> markers indicate that the optimizers
should perform tail call optimization. The <code class="docutils literal notranslate"><span class="pre">tail</span></code> marker is a hint that
<a class="reference external" href="CodeGenerator.html#sibcallopt">can be ignored</a>. The <code class="docutils literal notranslate"><span class="pre">musttail</span></code> marker
means that the call must be tail call optimized in order for the program to
be correct. The <code class="docutils literal notranslate"><span class="pre">musttail</span></code> marker provides these guarantees:</p>
<ol class="arabic simple">
<li><p>The call will not cause unbounded stack growth if it is part of a
recursive cycle in the call graph.</p></li>
<li><p>Arguments with the <a class="reference internal" href="#attr-inalloca"><span class="std std-ref">inalloca</span></a> or
<a class="reference internal" href="#attr-preallocated"><span class="std std-ref">preallocated</span></a> attribute are forwarded in place.</p></li>
<li><p>If the musttail call appears in a function with the <code class="docutils literal notranslate"><span class="pre">"thunk"</span></code> attribute
and the caller and callee both have varargs, than any unprototyped
arguments in register or memory are forwarded to the callee. Similarly,
the return value of the callee is returned to the caller’s caller, even
if a void return type is in use.</p></li>
</ol>
<p>Both markers imply that the callee does not access allocas from the caller.
The <code class="docutils literal notranslate"><span class="pre">tail</span></code> marker additionally implies that the callee does not access
varargs from the caller. Calls marked <code class="docutils literal notranslate"><span class="pre">musttail</span></code> must obey the following
additional rules:</p>
<ul class="simple">
<li><p>The call must immediately precede a <a class="reference internal" href="#i-ret"><span class="std std-ref">ret</span></a> instruction,
or a pointer bitcast followed by a ret instruction.</p></li>
<li><p>The ret instruction must return the (possibly bitcasted) value
produced by the call, undef, or void.</p></li>
<li><p>The calling conventions of the caller and callee must match.</p></li>
<li><p>The callee must be varargs iff the caller is varargs. Bitcasting a
non-varargs function to the appropriate varargs type is legal so
long as the non-varargs prefixes obey the other rules.</p></li>
<li><p>The return type must not undergo automatic conversion to an <cite>sret</cite> pointer.</p></li>
</ul>
</li>
</ol>
<blockquote>
<div><p>In addition, if the calling convention is not <cite>swifttailcc</cite> or <cite>tailcc</cite>:</p>
<blockquote>
<div><ul class="simple">
<li><p>All ABI-impacting function attributes, such as sret, byval, inreg,
returned, and inalloca, must match.</p></li>
<li><p>The caller and callee prototypes must match. Pointer types of parameters
or return types may differ in pointee type, but not in address space.</p></li>
</ul>
</div></blockquote>
<p>On the other hand, if the calling convention is <cite>swifttailcc</cite> or <cite>swiftcc</cite>:</p>
<blockquote>
<div><ul class="simple">
<li><p>Only these ABI-impacting attributes attributes are allowed: sret, byval,
swiftself, and swiftasync.</p></li>
<li><p>Prototypes are not required to match.</p></li>
</ul>
<p>Tail call optimization for calls marked <code class="docutils literal notranslate"><span class="pre">tail</span></code> is guaranteed to occur if
the following conditions are met:</p>
<ul class="simple">
<li><p>Caller and callee both have the calling convention <code class="docutils literal notranslate"><span class="pre">fastcc</span></code> or <code class="docutils literal notranslate"><span class="pre">tailcc</span></code>.</p></li>
<li><p>The call is in tail position (ret immediately follows call and ret
uses value of call or is void).</p></li>
<li><p>Option <code class="docutils literal notranslate"><span class="pre">-tailcallopt</span></code> is enabled,
<code class="docutils literal notranslate"><span class="pre">llvm::GuaranteedTailCallOpt</span></code> is <code class="docutils literal notranslate"><span class="pre">true</span></code>, or the calling convention
is <code class="docutils literal notranslate"><span class="pre">tailcc</span></code></p></li>
<li><p><a class="reference external" href="CodeGenerator.html#tailcallopt">Platform-specific constraints are
met.</a></p></li>
</ul>
</div></blockquote>
</div></blockquote>
<ol class="arabic simple">
<li><p>The optional <code class="docutils literal notranslate"><span class="pre">notail</span></code> marker indicates that the optimizers should not add
<code class="docutils literal notranslate"><span class="pre">tail</span></code> or <code class="docutils literal notranslate"><span class="pre">musttail</span></code> markers to the call. It is used to prevent tail
call optimization from being performed on the call.</p></li>
<li><p>The optional <code class="docutils literal notranslate"><span class="pre">fast-math</span> <span class="pre">flags</span></code> marker indicates that the call has one or more
<a class="reference internal" href="#fastmath"><span class="std std-ref">fast-math flags</span></a>, which are optimization hints to enable
otherwise unsafe floating-point optimizations. Fast-math flags are only valid
for calls that return a floating-point scalar or vector type, or an array
(nested to any depth) of floating-point scalar or vector types.</p></li>
<li><p>The optional “cconv” marker indicates which <a class="reference internal" href="#callingconv"><span class="std std-ref">calling
convention</span></a> the call should use. If none is
specified, the call defaults to using C calling conventions. The
calling convention of the call must match the calling convention of
the target function, or else the behavior is undefined.</p></li>
<li><p>The optional <a class="reference internal" href="#paramattrs"><span class="std std-ref">Parameter Attributes</span></a> list for return
values. Only ‘<code class="docutils literal notranslate"><span class="pre">zeroext</span></code>’, ‘<code class="docutils literal notranslate"><span class="pre">signext</span></code>’, and ‘<code class="docutils literal notranslate"><span class="pre">inreg</span></code>’ attributes
are valid here.</p></li>
<li><p>The optional addrspace attribute can be used to indicate the address space
of the called function. If it is not specified, the program address space
from the <a class="reference internal" href="#langref-datalayout"><span class="std std-ref">datalayout string</span></a> will be used.</p></li>
<li><p>‘<code class="docutils literal notranslate"><span class="pre">ty</span></code>’: the type of the call instruction itself which is also the
type of the return value. Functions that return no value are marked
<code class="docutils literal notranslate"><span class="pre">void</span></code>.</p></li>
<li><p>‘<code class="docutils literal notranslate"><span class="pre">fnty</span></code>’: shall be the signature of the function being called. The
argument types must match the types implied by this signature. This
type can be omitted if the function is not varargs.</p></li>
<li><p>‘<code class="docutils literal notranslate"><span class="pre">fnptrval</span></code>’: An LLVM value containing a pointer to a function to
be called. In most cases, this is a direct function call, but
indirect <code class="docutils literal notranslate"><span class="pre">call</span></code>’s are just as possible, calling an arbitrary pointer
to function value.</p></li>
<li><p>‘<code class="docutils literal notranslate"><span class="pre">function</span> <span class="pre">args</span></code>’: argument list whose types match the function
signature argument types and parameter attributes. All arguments must
be of <a class="reference internal" href="#t-firstclass"><span class="std std-ref">first class</span></a> type. If the function signature
indicates the function accepts a variable number of arguments, the
extra arguments can be specified.</p></li>
<li><p>The optional <a class="reference internal" href="#fnattrs"><span class="std std-ref">function attributes</span></a> list.</p></li>
<li><p>The optional <a class="reference internal" href="#opbundles"><span class="std std-ref">operand bundles</span></a> list.</p></li>
</ol>
</div>
<div class="section" id="id328">
<h5><a class="toc-backref" href="#id1991">Semantics:</a><a class="headerlink" href="#id328" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">call</span></code>’ instruction is used to cause control flow to transfer to
a specified function, with its incoming arguments bound to the specified
values. Upon a ‘<code class="docutils literal notranslate"><span class="pre">ret</span></code>’ instruction in the called function, control
flow continues with the instruction after the function call, and the
return value of the function is bound to the result argument.</p>
</div>
<div class="section" id="id329">
<h5><a class="toc-backref" href="#id1992">Example:</a><a class="headerlink" href="#id329" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%retval</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@test</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%argc</span><span class="p">)</span>
<span class="k">call</span> <span class="k">i32</span> <span class="p">(</span><span class="k">i8</span><span class="p">*,</span> <span class="p">...)*</span> <span class="vg">@printf</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%msg</span><span class="p">,</span> <span class="k">i32</span> <span class="m">12</span><span class="p">,</span> <span class="k">i8</span> <span class="m">42</span><span class="p">)</span> <span class="c">; yields i32</span>
<span class="nv">%X</span> <span class="p">=</span> <span class="k">tail</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@foo</span><span class="p">()</span> <span class="c">; yields i32</span>
<span class="nv">%Y</span> <span class="p">=</span> <span class="k">tail</span> <span class="k">call</span> <span class="k">fastcc</span> <span class="k">i32</span> <span class="vg">@foo</span><span class="p">()</span> <span class="c">; yields i32</span>
<span class="k">call</span> <span class="k">void</span> <span class="nv">%foo</span><span class="p">(</span><span class="k">i8</span> <span class="m">97</span> <span class="k">signext</span><span class="p">)</span>
<span class="nv">%struct.A</span> <span class="p">=</span> <span class="k">type</span> <span class="p">{</span> <span class="k">i32</span><span class="p">,</span> <span class="k">i8</span> <span class="p">}</span>
<span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="nv">%struct.A</span> <span class="vg">@foo</span><span class="p">()</span> <span class="c">; yields { i32, i8 }</span>
<span class="nv">%gr</span> <span class="p">=</span> <span class="k">extractvalue</span> <span class="nv">%struct.A</span> <span class="nv">%r</span><span class="p">,</span> <span class="m">0</span> <span class="c">; yields i32</span>
<span class="nv">%gr1</span> <span class="p">=</span> <span class="k">extractvalue</span> <span class="nv">%struct.A</span> <span class="nv">%r</span><span class="p">,</span> <span class="m">1</span> <span class="c">; yields i8</span>
<span class="nv">%Z</span> <span class="p">=</span> <span class="k">call</span> <span class="k">void</span> <span class="vg">@foo</span><span class="p">()</span> <span class="k">noreturn</span> <span class="c">; indicates that %foo never returns normally</span>
<span class="nv">%ZZ</span> <span class="p">=</span> <span class="k">call</span> <span class="k">zeroext</span> <span class="k">i32</span> <span class="vg">@bar</span><span class="p">()</span> <span class="c">; Return value is %zero extended</span>
</pre></div>
</div>
<p>llvm treats calls to some functions with names and arguments that match
the standard C99 library as being the C99 library functions, and may
perform optimizations or generate code for them under that assumption.
This is something we’d like to change in the future to provide better
support for freestanding environments and non-C-based languages.</p>
</div>
</div>
<div class="section" id="va-arg-instruction">
<span id="i-va-arg"></span><h4><a class="toc-backref" href="#id1993">‘<code class="docutils literal notranslate"><span class="pre">va_arg</span></code>’ Instruction</a><a class="headerlink" href="#va-arg-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id330">
<h5><a class="toc-backref" href="#id1994">Syntax:</a><a class="headerlink" href="#id330" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">resultval</span><span class="o">></span> <span class="o">=</span> <span class="n">va_arg</span> <span class="o"><</span><span class="n">va_list</span><span class="o">*></span> <span class="o"><</span><span class="n">arglist</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">argty</span><span class="o">></span>
</pre></div>
</div>
</div>
<div class="section" id="id331">
<h5><a class="toc-backref" href="#id1995">Overview:</a><a class="headerlink" href="#id331" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">va_arg</span></code>’ instruction is used to access arguments passed through
the “variable argument” area of a function call. It is used to implement
the <code class="docutils literal notranslate"><span class="pre">va_arg</span></code> macro in C.</p>
</div>
<div class="section" id="id332">
<h5><a class="toc-backref" href="#id1996">Arguments:</a><a class="headerlink" href="#id332" title="Permalink to this headline">¶</a></h5>
<p>This instruction takes a <code class="docutils literal notranslate"><span class="pre">va_list*</span></code> value and the type of the
argument. It returns a value of the specified argument type and
increments the <code class="docutils literal notranslate"><span class="pre">va_list</span></code> to point to the next argument. The actual
type of <code class="docutils literal notranslate"><span class="pre">va_list</span></code> is target specific.</p>
</div>
<div class="section" id="id333">
<h5><a class="toc-backref" href="#id1997">Semantics:</a><a class="headerlink" href="#id333" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">va_arg</span></code>’ instruction loads an argument of the specified type
from the specified <code class="docutils literal notranslate"><span class="pre">va_list</span></code> and causes the <code class="docutils literal notranslate"><span class="pre">va_list</span></code> to point to
the next argument. For more information, see the variable argument
handling <a class="reference internal" href="#int-varargs"><span class="std std-ref">Intrinsic Functions</span></a>.</p>
<p>It is legal for this instruction to be called in a function which does
not take a variable number of arguments, for example, the <code class="docutils literal notranslate"><span class="pre">vfprintf</span></code>
function.</p>
<p><code class="docutils literal notranslate"><span class="pre">va_arg</span></code> is an LLVM instruction instead of an <a class="reference internal" href="#intrinsics"><span class="std std-ref">intrinsic
function</span></a> because it takes a type as an argument.</p>
</div>
<div class="section" id="id334">
<h5><a class="toc-backref" href="#id1998">Example:</a><a class="headerlink" href="#id334" title="Permalink to this headline">¶</a></h5>
<p>See the <a class="reference internal" href="#int-varargs"><span class="std std-ref">variable argument processing</span></a> section.</p>
<p>Note that the code generator does not yet fully support va_arg on many
targets. Also, it does not currently support va_arg with aggregate
types on any target.</p>
</div>
</div>
<div class="section" id="landingpad-instruction">
<span id="i-landingpad"></span><h4><a class="toc-backref" href="#id1999">‘<code class="docutils literal notranslate"><span class="pre">landingpad</span></code>’ Instruction</a><a class="headerlink" href="#landingpad-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id335">
<h5><a class="toc-backref" href="#id2000">Syntax:</a><a class="headerlink" href="#id335" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">resultval</span><span class="o">></span> <span class="o">=</span> <span class="n">landingpad</span> <span class="o"><</span><span class="n">resultty</span><span class="o">></span> <span class="o"><</span><span class="n">clause</span><span class="o">>+</span>
<span class="o"><</span><span class="n">resultval</span><span class="o">></span> <span class="o">=</span> <span class="n">landingpad</span> <span class="o"><</span><span class="n">resultty</span><span class="o">></span> <span class="n">cleanup</span> <span class="o"><</span><span class="n">clause</span><span class="o">>*</span>
<span class="o"><</span><span class="n">clause</span><span class="o">></span> <span class="o">:=</span> <span class="n">catch</span> <span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span>
<span class="o"><</span><span class="n">clause</span><span class="o">></span> <span class="o">:=</span> <span class="nb">filter</span> <span class="o"><</span><span class="n">array</span> <span class="n">constant</span> <span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">array</span> <span class="n">constant</span><span class="o">></span>
</pre></div>
</div>
</div>
<div class="section" id="id336">
<h5><a class="toc-backref" href="#id2001">Overview:</a><a class="headerlink" href="#id336" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">landingpad</span></code>’ instruction is used by <a class="reference external" href="ExceptionHandling.html#overview">LLVM’s exception handling
system</a> to specify that a basic block
is a landing pad — one where the exception lands, and corresponds to the
code found in the <code class="docutils literal notranslate"><span class="pre">catch</span></code> portion of a <code class="docutils literal notranslate"><span class="pre">try</span></code>/<code class="docutils literal notranslate"><span class="pre">catch</span></code> sequence. It
defines values supplied by the <a class="reference internal" href="#personalityfn"><span class="std std-ref">personality function</span></a> upon
re-entry to the function. The <code class="docutils literal notranslate"><span class="pre">resultval</span></code> has the type <code class="docutils literal notranslate"><span class="pre">resultty</span></code>.</p>
</div>
<div class="section" id="id338">
<h5><a class="toc-backref" href="#id2002">Arguments:</a><a class="headerlink" href="#id338" title="Permalink to this headline">¶</a></h5>
<p>The optional
<code class="docutils literal notranslate"><span class="pre">cleanup</span></code> flag indicates that the landing pad block is a cleanup.</p>
<p>A <code class="docutils literal notranslate"><span class="pre">clause</span></code> begins with the clause type — <code class="docutils literal notranslate"><span class="pre">catch</span></code> or <code class="docutils literal notranslate"><span class="pre">filter</span></code> — and
contains the global variable representing the “type” that may be caught
or filtered respectively. Unlike the <code class="docutils literal notranslate"><span class="pre">catch</span></code> clause, the <code class="docutils literal notranslate"><span class="pre">filter</span></code>
clause takes an array constant as its argument. Use
“<code class="docutils literal notranslate"><span class="pre">[0</span> <span class="pre">x</span> <span class="pre">i8**]</span> <span class="pre">undef</span></code>” for a filter which cannot throw. The
‘<code class="docutils literal notranslate"><span class="pre">landingpad</span></code>’ instruction must contain <em>at least</em> one <code class="docutils literal notranslate"><span class="pre">clause</span></code> or
the <code class="docutils literal notranslate"><span class="pre">cleanup</span></code> flag.</p>
</div>
<div class="section" id="id339">
<h5><a class="toc-backref" href="#id2003">Semantics:</a><a class="headerlink" href="#id339" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">landingpad</span></code>’ instruction defines the values which are set by the
<a class="reference internal" href="#personalityfn"><span class="std std-ref">personality function</span></a> upon re-entry to the function, and
therefore the “result type” of the <code class="docutils literal notranslate"><span class="pre">landingpad</span></code> instruction. As with
calling conventions, how the personality function results are
represented in LLVM IR is target specific.</p>
<p>The clauses are applied in order from top to bottom. If two
<code class="docutils literal notranslate"><span class="pre">landingpad</span></code> instructions are merged together through inlining, the
clauses from the calling function are appended to the list of clauses.
When the call stack is being unwound due to an exception being thrown,
the exception is compared against each <code class="docutils literal notranslate"><span class="pre">clause</span></code> in turn. If it doesn’t
match any of the clauses, and the <code class="docutils literal notranslate"><span class="pre">cleanup</span></code> flag is not set, then
unwinding continues further up the call stack.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">landingpad</span></code> instruction has several restrictions:</p>
<ul class="simple">
<li><p>A landing pad block is a basic block which is the unwind destination
of an ‘<code class="docutils literal notranslate"><span class="pre">invoke</span></code>’ instruction.</p></li>
<li><p>A landing pad block must have a ‘<code class="docutils literal notranslate"><span class="pre">landingpad</span></code>’ instruction as its
first non-PHI instruction.</p></li>
<li><p>There can be only one ‘<code class="docutils literal notranslate"><span class="pre">landingpad</span></code>’ instruction within the landing
pad block.</p></li>
<li><p>A basic block that is not a landing pad block may not include a
‘<code class="docutils literal notranslate"><span class="pre">landingpad</span></code>’ instruction.</p></li>
</ul>
</div>
<div class="section" id="id340">
<h5><a class="toc-backref" href="#id2004">Example:</a><a class="headerlink" href="#id340" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="c">;; A landing pad which can catch an integer.</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">landingpad</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">catch</span> <span class="k">i8</span><span class="p">**</span> <span class="vg">@_ZTIi</span>
<span class="c">;; A landing pad that is a cleanup.</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">landingpad</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">cleanup</span>
<span class="c">;; A landing pad which can catch an integer and can only throw a double.</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">landingpad</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">catch</span> <span class="k">i8</span><span class="p">**</span> <span class="vg">@_ZTIi</span>
<span class="k">filter</span> <span class="p">[</span><span class="m">1</span> <span class="k">x</span> <span class="k">i8</span><span class="p">**]</span> <span class="p">[</span><span class="vg">@_ZTId</span><span class="p">]</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="catchpad-instruction">
<span id="i-catchpad"></span><h4><a class="toc-backref" href="#id2005">‘<code class="docutils literal notranslate"><span class="pre">catchpad</span></code>’ Instruction</a><a class="headerlink" href="#catchpad-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id341">
<h5><a class="toc-backref" href="#id2006">Syntax:</a><a class="headerlink" href="#id341" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">resultval</span><span class="o">></span> <span class="o">=</span> <span class="n">catchpad</span> <span class="n">within</span> <span class="o"><</span><span class="n">catchswitch</span><span class="o">></span> <span class="p">[</span><span class="o"><</span><span class="n">args</span><span class="o">>*</span><span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="id342">
<h5><a class="toc-backref" href="#id2007">Overview:</a><a class="headerlink" href="#id342" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">catchpad</span></code>’ instruction is used by <a class="reference external" href="ExceptionHandling.html#overview">LLVM’s exception handling
system</a> to specify that a basic block
begins a catch handler — one where a personality routine attempts to transfer
control to catch an exception.</p>
</div>
<div class="section" id="id344">
<h5><a class="toc-backref" href="#id2008">Arguments:</a><a class="headerlink" href="#id344" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">catchswitch</span></code> operand must always be a token produced by a
<a class="reference internal" href="#i-catchswitch"><span class="std std-ref">catchswitch</span></a> instruction in a predecessor block. This
ensures that each <code class="docutils literal notranslate"><span class="pre">catchpad</span></code> has exactly one predecessor block, and it always
terminates in a <code class="docutils literal notranslate"><span class="pre">catchswitch</span></code>.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">args</span></code> correspond to whatever information the personality routine
requires to know if this is an appropriate handler for the exception. Control
will transfer to the <code class="docutils literal notranslate"><span class="pre">catchpad</span></code> if this is the first appropriate handler for
the exception.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">resultval</span></code> has the type <a class="reference internal" href="#t-token"><span class="std std-ref">token</span></a> and is used to match the
<code class="docutils literal notranslate"><span class="pre">catchpad</span></code> to corresponding <a class="reference internal" href="#i-catchret"><span class="std std-ref">catchrets</span></a> and other nested EH
pads.</p>
</div>
<div class="section" id="id345">
<h5><a class="toc-backref" href="#id2009">Semantics:</a><a class="headerlink" href="#id345" title="Permalink to this headline">¶</a></h5>
<p>When the call stack is being unwound due to an exception being thrown, the
exception is compared against the <code class="docutils literal notranslate"><span class="pre">args</span></code>. If it doesn’t match, control will
not reach the <code class="docutils literal notranslate"><span class="pre">catchpad</span></code> instruction. The representation of <code class="docutils literal notranslate"><span class="pre">args</span></code> is
entirely target and personality function-specific.</p>
<p>Like the <a class="reference internal" href="#i-landingpad"><span class="std std-ref">landingpad</span></a> instruction, the <code class="docutils literal notranslate"><span class="pre">catchpad</span></code>
instruction must be the first non-phi of its parent basic block.</p>
<p>The meaning of the tokens produced and consumed by <code class="docutils literal notranslate"><span class="pre">catchpad</span></code> and other “pad”
instructions is described in the
<a class="reference external" href="ExceptionHandling.html#wineh">Windows exception handling documentation</a>.</p>
<p>When a <code class="docutils literal notranslate"><span class="pre">catchpad</span></code> has been “entered” but not yet “exited” (as
described in the <a class="reference external" href="ExceptionHandling.html#wineh-constraints">EH documentation</a>),
it is undefined behavior to execute a <a class="reference internal" href="#i-call"><span class="std std-ref">call</span></a> or <a class="reference internal" href="#i-invoke"><span class="std std-ref">invoke</span></a>
that does not carry an appropriate <a class="reference internal" href="#ob-funclet"><span class="std std-ref">“funclet” bundle</span></a>.</p>
</div>
<div class="section" id="id347">
<h5><a class="toc-backref" href="#id2010">Example:</a><a class="headerlink" href="#id347" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>dispatch:
%cs = catchswitch within none [label %handler0] unwind to caller
;; A catch block which can catch an integer.
handler0:
%tok = catchpad within %cs [i8** @_ZTIi]
</pre></div>
</div>
</div>
</div>
<div class="section" id="cleanuppad-instruction">
<span id="i-cleanuppad"></span><h4><a class="toc-backref" href="#id2011">‘<code class="docutils literal notranslate"><span class="pre">cleanuppad</span></code>’ Instruction</a><a class="headerlink" href="#cleanuppad-instruction" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id348">
<h5><a class="toc-backref" href="#id2012">Syntax:</a><a class="headerlink" href="#id348" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">resultval</span><span class="o">></span> <span class="o">=</span> <span class="n">cleanuppad</span> <span class="n">within</span> <span class="o"><</span><span class="n">parent</span><span class="o">></span> <span class="p">[</span><span class="o"><</span><span class="n">args</span><span class="o">>*</span><span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="id349">
<h5><a class="toc-backref" href="#id2013">Overview:</a><a class="headerlink" href="#id349" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">cleanuppad</span></code>’ instruction is used by <a class="reference external" href="ExceptionHandling.html#overview">LLVM’s exception handling
system</a> to specify that a basic block
is a cleanup block — one where a personality routine attempts to
transfer control to run cleanup actions.
The <code class="docutils literal notranslate"><span class="pre">args</span></code> correspond to whatever additional
information the <a class="reference internal" href="#personalityfn"><span class="std std-ref">personality function</span></a> requires to
execute the cleanup.
The <code class="docutils literal notranslate"><span class="pre">resultval</span></code> has the type <a class="reference internal" href="#t-token"><span class="std std-ref">token</span></a> and is used to
match the <code class="docutils literal notranslate"><span class="pre">cleanuppad</span></code> to corresponding <a class="reference internal" href="#i-cleanupret"><span class="std std-ref">cleanuprets</span></a>.
The <code class="docutils literal notranslate"><span class="pre">parent</span></code> argument is the token of the funclet that contains the
<code class="docutils literal notranslate"><span class="pre">cleanuppad</span></code> instruction. If the <code class="docutils literal notranslate"><span class="pre">cleanuppad</span></code> is not inside a funclet,
this operand may be the token <code class="docutils literal notranslate"><span class="pre">none</span></code>.</p>
</div>
<div class="section" id="id351">
<h5><a class="toc-backref" href="#id2014">Arguments:</a><a class="headerlink" href="#id351" title="Permalink to this headline">¶</a></h5>
<p>The instruction takes a list of arbitrary values which are interpreted
by the <a class="reference internal" href="#personalityfn"><span class="std std-ref">personality function</span></a>.</p>
</div>
<div class="section" id="id352">
<h5><a class="toc-backref" href="#id2015">Semantics:</a><a class="headerlink" href="#id352" title="Permalink to this headline">¶</a></h5>
<p>When the call stack is being unwound due to an exception being thrown,
the <a class="reference internal" href="#personalityfn"><span class="std std-ref">personality function</span></a> transfers control to the
<code class="docutils literal notranslate"><span class="pre">cleanuppad</span></code> with the aid of the personality-specific arguments.
As with calling conventions, how the personality function results are
represented in LLVM IR is target specific.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">cleanuppad</span></code> instruction has several restrictions:</p>
<ul class="simple">
<li><p>A cleanup block is a basic block which is the unwind destination of
an exceptional instruction.</p></li>
<li><p>A cleanup block must have a ‘<code class="docutils literal notranslate"><span class="pre">cleanuppad</span></code>’ instruction as its
first non-PHI instruction.</p></li>
<li><p>There can be only one ‘<code class="docutils literal notranslate"><span class="pre">cleanuppad</span></code>’ instruction within the
cleanup block.</p></li>
<li><p>A basic block that is not a cleanup block may not include a
‘<code class="docutils literal notranslate"><span class="pre">cleanuppad</span></code>’ instruction.</p></li>
</ul>
<p>When a <code class="docutils literal notranslate"><span class="pre">cleanuppad</span></code> has been “entered” but not yet “exited” (as
described in the <a class="reference external" href="ExceptionHandling.html#wineh-constraints">EH documentation</a>),
it is undefined behavior to execute a <a class="reference internal" href="#i-call"><span class="std std-ref">call</span></a> or <a class="reference internal" href="#i-invoke"><span class="std std-ref">invoke</span></a>
that does not carry an appropriate <a class="reference internal" href="#ob-funclet"><span class="std std-ref">“funclet” bundle</span></a>.</p>
</div>
<div class="section" id="id354">
<h5><a class="toc-backref" href="#id2016">Example:</a><a class="headerlink" href="#id354" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>%tok = cleanuppad within %cs []
</pre></div>
</div>
</div>
</div>
</div>
</div>
<div class="section" id="intrinsic-functions">
<span id="intrinsics"></span><h2><a class="toc-backref" href="#id2017">Intrinsic Functions</a><a class="headerlink" href="#intrinsic-functions" title="Permalink to this headline">¶</a></h2>
<p>LLVM supports the notion of an “intrinsic function”. These functions
have well known names and semantics and are required to follow certain
restrictions. Overall, these intrinsics represent an extension mechanism
for the LLVM language that does not require changing all of the
transformations in LLVM when adding to the language (or the bitcode
reader/writer, the parser, etc…).</p>
<p>Intrinsic function names must all start with an “<code class="docutils literal notranslate"><span class="pre">llvm.</span></code>” prefix. This
prefix is reserved in LLVM for intrinsic names; thus, function names may
not begin with this prefix. Intrinsic functions must always be external
functions: you cannot define the body of intrinsic functions. Intrinsic
functions may only be used in call or invoke instructions: it is illegal
to take the address of an intrinsic function. Additionally, because
intrinsic functions are part of the LLVM language, it is required if any
are added that they be documented here.</p>
<p>Some intrinsic functions can be overloaded, i.e., the intrinsic
represents a family of functions that perform the same operation but on
different data types. Because LLVM can represent over 8 million
different integer types, overloading is used commonly to allow an
intrinsic function to operate on any integer type. One or more of the
argument types or the result type can be overloaded to accept any
integer type. Argument types may also be defined as exactly matching a
previous argument’s type or the result type. This allows an intrinsic
function which accepts multiple arguments, but needs all of them to be
of the same type, to only be overloaded with respect to a single
argument or the result.</p>
<p>Overloaded intrinsics will have the names of its overloaded argument
types encoded into its function name, each preceded by a period. Only
those types which are overloaded result in a name suffix. Arguments
whose type is matched against another type do not. For example, the
<code class="docutils literal notranslate"><span class="pre">llvm.ctpop</span></code> function can take an integer of any width and returns an
integer of exactly the same integer width. This leads to a family of
functions such as <code class="docutils literal notranslate"><span class="pre">i8</span> <span class="pre">@llvm.ctpop.i8(i8</span> <span class="pre">%val)</span></code> and
<code class="docutils literal notranslate"><span class="pre">i29</span> <span class="pre">@llvm.ctpop.i29(i29</span> <span class="pre">%val)</span></code>. Only one type, the return type, is
overloaded, and only one type suffix is required. Because the argument’s
type is matched against the return type, it does not require its own
name suffix.</p>
<p><a class="reference internal" href="#t-opaque"><span class="std std-ref">Unnamed types</span></a> are encoded as <code class="docutils literal notranslate"><span class="pre">s_s</span></code>. Overloaded intrinsics
that depend on an unnamed type in one of its overloaded argument types get an
additional <code class="docutils literal notranslate"><span class="pre">.<number></span></code> suffix. This allows differentiating intrinsics with
different unnamed types as arguments. (For example:
<code class="docutils literal notranslate"><span class="pre">llvm.ssa.copy.p0s_s.2(%42*)</span></code>) The number is tracked in the LLVM module and
it ensures unique names in the module. While linking together two modules, it is
still possible to get a name clash. In that case one of the names will be
changed by getting a new number.</p>
<p>For target developers who are defining intrinsics for back-end code
generation, any intrinsic overloads based solely the distinction between
integer or floating point types should not be relied upon for correct
code generation. In such cases, the recommended approach for target
maintainers when defining intrinsics is to create separate integer and
FP intrinsics rather than rely on overloading. For example, if different
codegen is required for <code class="docutils literal notranslate"><span class="pre">llvm.target.foo(<4</span> <span class="pre">x</span> <span class="pre">i32>)</span></code> and
<code class="docutils literal notranslate"><span class="pre">llvm.target.foo(<4</span> <span class="pre">x</span> <span class="pre">float>)</span></code> then these should be split into
different intrinsics.</p>
<p>To learn how to add an intrinsic function, please see the <a class="reference external" href="ExtendingLLVM.html">Extending
LLVM Guide</a>.</p>
<div class="section" id="variable-argument-handling-intrinsics">
<span id="int-varargs"></span><h3><a class="toc-backref" href="#id2018">Variable Argument Handling Intrinsics</a><a class="headerlink" href="#variable-argument-handling-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>Variable argument support is defined in LLVM with the
<a class="reference internal" href="#i-va-arg"><span class="std std-ref">va_arg</span></a> instruction and these three intrinsic
functions. These functions are related to the similarly named macros
defined in the <code class="docutils literal notranslate"><span class="pre"><stdarg.h></span></code> header file.</p>
<p>All of these functions operate on arguments that use a target-specific
value type “<code class="docutils literal notranslate"><span class="pre">va_list</span></code>”. The LLVM assembly language reference manual
does not define what this type is, so all transformations should be
prepared to handle these functions regardless of the type used.</p>
<p>This example shows how the <a class="reference internal" href="#i-va-arg"><span class="std std-ref">va_arg</span></a> instruction and the
variable argument handling intrinsic functions are used.</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="c">; This struct is different for every platform. For most platforms,</span>
<span class="c">; it is merely an i8*.</span>
<span class="nv">%struct.va_list</span> <span class="p">=</span> <span class="k">type</span> <span class="p">{</span> <span class="k">i8</span><span class="p">*</span> <span class="p">}</span>
<span class="c">; For Unix x86_64 platforms, va_list is the following struct:</span>
<span class="c">; %struct.va_list = type { i32, i32, i8*, i8* }</span>
<span class="k">define</span> <span class="k">i32</span> <span class="vg">@test</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%X</span><span class="p">,</span> <span class="p">...)</span> <span class="p">{</span>
<span class="c">; Initialize variable argument processing</span>
<span class="nv">%ap</span> <span class="p">=</span> <span class="k">alloca</span> <span class="nv">%struct.va_list</span>
<span class="nv">%ap2</span> <span class="p">=</span> <span class="k">bitcast</span> <span class="nv">%struct.va_list</span><span class="p">*</span> <span class="nv">%ap</span> <span class="k">to</span> <span class="k">i8</span><span class="p">*</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@llvm.va_start</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%ap2</span><span class="p">)</span>
<span class="c">; Read a single integer argument</span>
<span class="nv">%tmp</span> <span class="p">=</span> <span class="k">va_arg</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%ap2</span><span class="p">,</span> <span class="k">i32</span>
<span class="c">; Demonstrate usage of llvm.va_copy and llvm.va_end</span>
<span class="nv">%aq</span> <span class="p">=</span> <span class="k">alloca</span> <span class="k">i8</span><span class="p">*</span>
<span class="nv">%aq2</span> <span class="p">=</span> <span class="k">bitcast</span> <span class="k">i8</span><span class="p">**</span> <span class="nv">%aq</span> <span class="k">to</span> <span class="k">i8</span><span class="p">*</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@llvm.va_copy</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%aq2</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%ap2</span><span class="p">)</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@llvm.va_end</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%aq2</span><span class="p">)</span>
<span class="c">; Stop processing of arguments.</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@llvm.va_end</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%ap2</span><span class="p">)</span>
<span class="k">ret</span> <span class="k">i32</span> <span class="nv">%tmp</span>
<span class="p">}</span>
<span class="k">declare</span> <span class="k">void</span> <span class="vg">@llvm.va_start</span><span class="p">(</span><span class="k">i8</span><span class="p">*)</span>
<span class="k">declare</span> <span class="k">void</span> <span class="vg">@llvm.va_copy</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">declare</span> <span class="k">void</span> <span class="vg">@llvm.va_end</span><span class="p">(</span><span class="k">i8</span><span class="p">*)</span>
</pre></div>
</div>
<div class="section" id="llvm-va-start-intrinsic">
<span id="int-va-start"></span><h4><a class="toc-backref" href="#id2019">‘<code class="docutils literal notranslate"><span class="pre">llvm.va_start</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-va-start-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id355">
<h5><a class="toc-backref" href="#id2020">Syntax:</a><a class="headerlink" href="#id355" 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">va_start</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">arglist</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id356">
<h5><a class="toc-backref" href="#id2021">Overview:</a><a class="headerlink" href="#id356" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.va_start</span></code>’ intrinsic initializes <code class="docutils literal notranslate"><span class="pre">*<arglist></span></code> for
subsequent use by <code class="docutils literal notranslate"><span class="pre">va_arg</span></code>.</p>
</div>
<div class="section" id="id357">
<h5><a class="toc-backref" href="#id2022">Arguments:</a><a class="headerlink" href="#id357" title="Permalink to this headline">¶</a></h5>
<p>The argument is a pointer to a <code class="docutils literal notranslate"><span class="pre">va_list</span></code> element to initialize.</p>
</div>
<div class="section" id="id358">
<h5><a class="toc-backref" href="#id2023">Semantics:</a><a class="headerlink" href="#id358" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.va_start</span></code>’ intrinsic works just like the <code class="docutils literal notranslate"><span class="pre">va_start</span></code> macro
available in C. In a target-dependent way, it initializes the
<code class="docutils literal notranslate"><span class="pre">va_list</span></code> element to which the argument points, so that the next call
to <code class="docutils literal notranslate"><span class="pre">va_arg</span></code> will produce the first variable argument passed to the
function. Unlike the C <code class="docutils literal notranslate"><span class="pre">va_start</span></code> macro, this intrinsic does not need
to know the last argument of the function as the compiler can figure
that out.</p>
</div>
</div>
<div class="section" id="llvm-va-end-intrinsic">
<h4><a class="toc-backref" href="#id2024">‘<code class="docutils literal notranslate"><span class="pre">llvm.va_end</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-va-end-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id359">
<h5><a class="toc-backref" href="#id2025">Syntax:</a><a class="headerlink" href="#id359" 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">va_end</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">arglist</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id360">
<h5><a class="toc-backref" href="#id2026">Overview:</a><a class="headerlink" href="#id360" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.va_end</span></code>’ intrinsic destroys <code class="docutils literal notranslate"><span class="pre">*<arglist></span></code>, which has been
initialized previously with <code class="docutils literal notranslate"><span class="pre">llvm.va_start</span></code> or <code class="docutils literal notranslate"><span class="pre">llvm.va_copy</span></code>.</p>
</div>
<div class="section" id="id361">
<h5><a class="toc-backref" href="#id2027">Arguments:</a><a class="headerlink" href="#id361" title="Permalink to this headline">¶</a></h5>
<p>The argument is a pointer to a <code class="docutils literal notranslate"><span class="pre">va_list</span></code> to destroy.</p>
</div>
<div class="section" id="id362">
<h5><a class="toc-backref" href="#id2028">Semantics:</a><a class="headerlink" href="#id362" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.va_end</span></code>’ intrinsic works just like the <code class="docutils literal notranslate"><span class="pre">va_end</span></code> macro
available in C. In a target-dependent way, it destroys the <code class="docutils literal notranslate"><span class="pre">va_list</span></code>
element to which the argument points. Calls to
<a class="reference internal" href="#int-va-start"><span class="std std-ref">llvm.va_start</span></a> and
<a class="reference internal" href="#int-va-copy"><span class="std std-ref">llvm.va_copy</span></a> must be matched exactly with calls to
<code class="docutils literal notranslate"><span class="pre">llvm.va_end</span></code>.</p>
</div>
</div>
<div class="section" id="llvm-va-copy-intrinsic">
<span id="int-va-copy"></span><h4><a class="toc-backref" href="#id2029">‘<code class="docutils literal notranslate"><span class="pre">llvm.va_copy</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-va-copy-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id363">
<h5><a class="toc-backref" href="#id2030">Syntax:</a><a class="headerlink" href="#id363" 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">va_copy</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">destarglist</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">srcarglist</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id364">
<h5><a class="toc-backref" href="#id2031">Overview:</a><a class="headerlink" href="#id364" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.va_copy</span></code>’ intrinsic copies the current argument position
from the source argument list to the destination argument list.</p>
</div>
<div class="section" id="id365">
<h5><a class="toc-backref" href="#id2032">Arguments:</a><a class="headerlink" href="#id365" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a pointer to a <code class="docutils literal notranslate"><span class="pre">va_list</span></code> element to initialize.
The second argument is a pointer to a <code class="docutils literal notranslate"><span class="pre">va_list</span></code> element to copy from.</p>
</div>
<div class="section" id="id366">
<h5><a class="toc-backref" href="#id2033">Semantics:</a><a class="headerlink" href="#id366" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.va_copy</span></code>’ intrinsic works just like the <code class="docutils literal notranslate"><span class="pre">va_copy</span></code> macro
available in C. In a target-dependent way, it copies the source
<code class="docutils literal notranslate"><span class="pre">va_list</span></code> element into the destination <code class="docutils literal notranslate"><span class="pre">va_list</span></code> element. This
intrinsic is necessary because the `` llvm.va_start`` intrinsic may be
arbitrarily complex and require, for example, memory allocation.</p>
</div>
</div>
</div>
<div class="section" id="accurate-garbage-collection-intrinsics">
<h3><a class="toc-backref" href="#id2034">Accurate Garbage Collection Intrinsics</a><a class="headerlink" href="#accurate-garbage-collection-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>LLVM’s support for <a class="reference external" href="GarbageCollection.html">Accurate Garbage Collection</a>
(GC) requires the frontend to generate code containing appropriate intrinsic
calls and select an appropriate GC strategy which knows how to lower these
intrinsics in a manner which is appropriate for the target collector.</p>
<p>These intrinsics allow identification of <a class="reference internal" href="#int-gcroot"><span class="std std-ref">GC roots on the
stack</span></a>, as well as garbage collector implementations that
require <a class="reference internal" href="#int-gcread"><span class="std std-ref">read</span></a> and <a class="reference internal" href="#int-gcwrite"><span class="std std-ref">write</span></a> barriers.
Frontends for type-safe garbage collected languages should generate
these intrinsics to make use of the LLVM garbage collectors. For more
details, see <a class="reference external" href="GarbageCollection.html">Garbage Collection with LLVM</a>.</p>
<p>LLVM provides an second experimental set of intrinsics for describing garbage
collection safepoints in compiled code. These intrinsics are an alternative
to the <code class="docutils literal notranslate"><span class="pre">llvm.gcroot</span></code> intrinsics, but are compatible with the ones for
<a class="reference internal" href="#int-gcread"><span class="std std-ref">read</span></a> and <a class="reference internal" href="#int-gcwrite"><span class="std std-ref">write</span></a> barriers. The
differences in approach are covered in the <a class="reference external" href="GarbageCollection.html">Garbage Collection with LLVM</a> documentation. The intrinsics themselves are
described in <a class="reference internal" href="Statepoints.html"><span class="doc">Garbage Collection Safepoints in LLVM</span></a>.</p>
<div class="section" id="llvm-gcroot-intrinsic">
<span id="int-gcroot"></span><h4><a class="toc-backref" href="#id2035">‘<code class="docutils literal notranslate"><span class="pre">llvm.gcroot</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-gcroot-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id368">
<h5><a class="toc-backref" href="#id2036">Syntax:</a><a class="headerlink" href="#id368" 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">gcroot</span><span class="p">(</span><span class="n">i8</span><span class="o">**</span> <span class="o">%</span><span class="n">ptrloc</span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o">%</span><span class="n">metadata</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id369">
<h5><a class="toc-backref" href="#id2037">Overview:</a><a class="headerlink" href="#id369" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.gcroot</span></code>’ intrinsic declares the existence of a GC root to
the code generator, and allows some metadata to be associated with it.</p>
</div>
<div class="section" id="id370">
<h5><a class="toc-backref" href="#id2038">Arguments:</a><a class="headerlink" href="#id370" title="Permalink to this headline">¶</a></h5>
<p>The first argument specifies the address of a stack object that contains
the root pointer. The second pointer (which must be either a constant or
a global value address) contains the meta-data to be associated with the
root.</p>
</div>
<div class="section" id="id371">
<h5><a class="toc-backref" href="#id2039">Semantics:</a><a class="headerlink" href="#id371" title="Permalink to this headline">¶</a></h5>
<p>At runtime, a call to this intrinsic stores a null pointer into the
“ptrloc” location. At compile-time, the code generator generates
information to allow the runtime to find the pointer at GC safe points.
The ‘<code class="docutils literal notranslate"><span class="pre">llvm.gcroot</span></code>’ intrinsic may only be used in a function which
<a class="reference internal" href="#gc"><span class="std std-ref">specifies a GC algorithm</span></a>.</p>
</div>
</div>
<div class="section" id="llvm-gcread-intrinsic">
<span id="int-gcread"></span><h4><a class="toc-backref" href="#id2040">‘<code class="docutils literal notranslate"><span class="pre">llvm.gcread</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-gcread-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id372">
<h5><a class="toc-backref" href="#id2041">Syntax:</a><a class="headerlink" href="#id372" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">gcread</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o">%</span><span class="n">ObjPtr</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="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id373">
<h5><a class="toc-backref" href="#id2042">Overview:</a><a class="headerlink" href="#id373" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.gcread</span></code>’ intrinsic identifies reads of references from heap
locations, allowing garbage collector implementations that require read
barriers.</p>
</div>
<div class="section" id="id374">
<h5><a class="toc-backref" href="#id2043">Arguments:</a><a class="headerlink" href="#id374" title="Permalink to this headline">¶</a></h5>
<p>The second argument is the address to read from, which should be an
address allocated from the garbage collector. The first object is a
pointer to the start of the referenced object, if needed by the language
runtime (otherwise null).</p>
</div>
<div class="section" id="id375">
<h5><a class="toc-backref" href="#id2044">Semantics:</a><a class="headerlink" href="#id375" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.gcread</span></code>’ intrinsic has the same semantics as a load
instruction, but may be replaced with substantially more complex code by
the garbage collector runtime, as needed. The ‘<code class="docutils literal notranslate"><span class="pre">llvm.gcread</span></code>’
intrinsic may only be used in a function which <a class="reference internal" href="#gc"><span class="std std-ref">specifies a GC
algorithm</span></a>.</p>
</div>
</div>
<div class="section" id="llvm-gcwrite-intrinsic">
<span id="int-gcwrite"></span><h4><a class="toc-backref" href="#id2045">‘<code class="docutils literal notranslate"><span class="pre">llvm.gcwrite</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-gcwrite-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id376">
<h5><a class="toc-backref" href="#id2046">Syntax:</a><a class="headerlink" href="#id376" 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">gcwrite</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o">%</span><span class="n">P1</span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o">%</span><span class="n">Obj</span><span class="p">,</span> <span class="n">i8</span><span class="o">**</span> <span class="o">%</span><span class="n">P2</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id377">
<h5><a class="toc-backref" href="#id2047">Overview:</a><a class="headerlink" href="#id377" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.gcwrite</span></code>’ intrinsic identifies writes of references to heap
locations, allowing garbage collector implementations that require write
barriers (such as generational or reference counting collectors).</p>
</div>
<div class="section" id="id378">
<h5><a class="toc-backref" href="#id2048">Arguments:</a><a class="headerlink" href="#id378" title="Permalink to this headline">¶</a></h5>
<p>The first argument is the reference to store, the second is the start of
the object to store it to, and the third is the address of the field of
Obj to store to. If the runtime does not require a pointer to the
object, Obj may be null.</p>
</div>
<div class="section" id="id379">
<h5><a class="toc-backref" href="#id2049">Semantics:</a><a class="headerlink" href="#id379" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.gcwrite</span></code>’ intrinsic has the same semantics as a store
instruction, but may be replaced with substantially more complex code by
the garbage collector runtime, as needed. The ‘<code class="docutils literal notranslate"><span class="pre">llvm.gcwrite</span></code>’
intrinsic may only be used in a function which <a class="reference internal" href="#gc"><span class="std std-ref">specifies a GC
algorithm</span></a>.</p>
</div>
</div>
<div class="section" id="llvm-experimental-gc-statepoint-intrinsic">
<span id="gc-statepoint"></span><h4><a class="toc-backref" href="#id2050">‘llvm.experimental.gc.statepoint’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-gc-statepoint-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id380">
<h5><a class="toc-backref" href="#id2051">Syntax:</a><a class="headerlink" href="#id380" 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">token</span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">gc</span><span class="o">.</span><span class="n">statepoint</span><span class="p">(</span><span class="n">i64</span> <span class="o"><</span><span class="nb">id</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">num</span> <span class="n">patch</span> <span class="nb">bytes</span><span class="o">></span><span class="p">,</span>
<span class="n">func_type</span> <span class="o"><</span><span class="n">target</span><span class="o">></span><span class="p">,</span>
<span class="n">i64</span> <span class="o"><</span><span class="c1">#call args>, i64 <flags>,</span>
<span class="o">...</span> <span class="p">(</span><span class="n">call</span> <span class="n">parameters</span><span class="p">),</span>
<span class="n">i64</span> <span class="mi">0</span><span class="p">,</span> <span class="n">i64</span> <span class="mi">0</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id381">
<h5><a class="toc-backref" href="#id2052">Overview:</a><a class="headerlink" href="#id381" title="Permalink to this headline">¶</a></h5>
<p>The statepoint intrinsic represents a call which is parse-able by the
runtime.</p>
</div>
<div class="section" id="operands">
<h5><a class="toc-backref" href="#id2053">Operands:</a><a class="headerlink" href="#operands" title="Permalink to this headline">¶</a></h5>
<p>The ‘id’ operand is a constant integer that is reported as the ID
field in the generated stackmap. LLVM does not interpret this
parameter in any way and its meaning is up to the statepoint user to
decide. Note that LLVM is free to duplicate code containing
statepoint calls, and this may transform IR that had a unique ‘id’ per
lexical call to statepoint to IR that does not.</p>
<p>If ‘num patch bytes’ is non-zero then the call instruction
corresponding to the statepoint is not emitted and LLVM emits ‘num
patch bytes’ bytes of nops in its place. LLVM will emit code to
prepare the function arguments and retrieve the function return value
in accordance to the calling convention; the former before the nop
sequence and the latter after the nop sequence. It is expected that
the user will patch over the ‘num patch bytes’ bytes of nops with a
calling sequence specific to their runtime before executing the
generated machine code. There are no guarantees with respect to the
alignment of the nop sequence. Unlike <a class="reference internal" href="StackMaps.html"><span class="doc">Stack maps and patch points in LLVM</span></a> statepoints do
not have a concept of shadow bytes. Note that semantically the
statepoint still represents a call or invoke to ‘target’, and the nop
sequence after patching is expected to represent an operation
equivalent to a call or invoke to ‘target’.</p>
<p>The ‘target’ operand is the function actually being called. The
target can be specified as either a symbolic LLVM function, or as an
arbitrary Value of appropriate function type. Note that the function
type must match the signature of the callee and the types of the ‘call
parameters’ arguments.</p>
<p>The ‘#call args’ operand is the number of arguments to the actual
call. It must exactly match the number of arguments passed in the
‘call parameters’ variable length section.</p>
<p>The ‘flags’ operand is used to specify extra information about the
statepoint. This is currently only used to mark certain statepoints
as GC transitions. This operand is a 64-bit integer with the following
layout, where bit 0 is the least significant bit:</p>
<blockquote>
<div><table class="docutils align-default">
<colgroup>
<col style="width: 12%" />
<col style="width: 88%" />
</colgroup>
<thead>
<tr class="row-odd"><th class="head"><p>Bit #</p></th>
<th class="head"><p>Usage</p></th>
</tr>
</thead>
<tbody>
<tr class="row-even"><td><p>0</p></td>
<td><p>Set if the statepoint is a GC transition, cleared
otherwise.</p></td>
</tr>
<tr class="row-odd"><td><p>1-63</p></td>
<td><p>Reserved for future use; must be cleared.</p></td>
</tr>
</tbody>
</table>
</div></blockquote>
<p>The ‘call parameters’ arguments are simply the arguments which need to
be passed to the call target. They will be lowered according to the
specified calling convention and otherwise handled like a normal call
instruction. The number of arguments must exactly match what is
specified in ‘# call args’. The types must match the signature of
‘target’.</p>
<p>The ‘call parameter’ attributes must be followed by two ‘i64 0’ constants.
These were originally the length prefixes for ‘gc transition parameter’ and
‘deopt parameter’ arguments, but the role of these parameter sets have been
entirely replaced with the corresponding operand bundles. In a future
revision, these now redundant arguments will be removed.</p>
</div>
<div class="section" id="id382">
<h5><a class="toc-backref" href="#id2054">Semantics:</a><a class="headerlink" href="#id382" title="Permalink to this headline">¶</a></h5>
<p>A statepoint is assumed to read and write all memory. As a result,
memory operations can not be reordered past a statepoint. It is
illegal to mark a statepoint as being either ‘readonly’ or ‘readnone’.</p>
<p>Note that legal IR can not perform any memory operation on a ‘gc
pointer’ argument of the statepoint in a location statically reachable
from the statepoint. Instead, the explicitly relocated value (from a
<code class="docutils literal notranslate"><span class="pre">gc.relocate</span></code>) must be used.</p>
</div>
</div>
<div class="section" id="llvm-experimental-gc-result-intrinsic">
<h4><a class="toc-backref" href="#id2055">‘llvm.experimental.gc.result’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-gc-result-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id383">
<h5><a class="toc-backref" href="#id2056">Syntax:</a><a class="headerlink" href="#id383" 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="nb">type</span><span class="o">*</span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">gc</span><span class="o">.</span><span class="n">result</span><span class="p">(</span><span class="n">token</span> <span class="o">%</span><span class="n">statepoint_token</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id384">
<h5><a class="toc-backref" href="#id2057">Overview:</a><a class="headerlink" href="#id384" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">gc.result</span></code> extracts the result of the original call instruction
which was replaced by the <code class="docutils literal notranslate"><span class="pre">gc.statepoint</span></code>. The <code class="docutils literal notranslate"><span class="pre">gc.result</span></code>
intrinsic is actually a family of three intrinsics due to an
implementation limitation. Other than the type of the return value,
the semantics are the same.</p>
</div>
<div class="section" id="id385">
<h5><a class="toc-backref" href="#id2058">Operands:</a><a class="headerlink" href="#id385" title="Permalink to this headline">¶</a></h5>
<p>The first and only argument is the <code class="docutils literal notranslate"><span class="pre">gc.statepoint</span></code> which starts
the safepoint sequence of which this <code class="docutils literal notranslate"><span class="pre">gc.result</span></code> is a part.
Despite the typing of this as a generic token, <em>only</em> the value defined
by a <code class="docutils literal notranslate"><span class="pre">gc.statepoint</span></code> is legal here.</p>
</div>
<div class="section" id="id386">
<h5><a class="toc-backref" href="#id2059">Semantics:</a><a class="headerlink" href="#id386" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">gc.result</span></code> represents the return value of the call target of
the <code class="docutils literal notranslate"><span class="pre">statepoint</span></code>. The type of the <code class="docutils literal notranslate"><span class="pre">gc.result</span></code> must exactly match
the type of the target. If the call target returns void, there will
be no <code class="docutils literal notranslate"><span class="pre">gc.result</span></code>.</p>
<p>A <code class="docutils literal notranslate"><span class="pre">gc.result</span></code> is modeled as a ‘readnone’ pure function. It has no
side effects since it is just a projection of the return value of the
previous call represented by the <code class="docutils literal notranslate"><span class="pre">gc.statepoint</span></code>.</p>
</div>
</div>
<div class="section" id="llvm-experimental-gc-relocate-intrinsic">
<h4><a class="toc-backref" href="#id2060">‘llvm.experimental.gc.relocate’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-gc-relocate-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id387">
<h5><a class="toc-backref" href="#id2061">Syntax:</a><a class="headerlink" href="#id387" 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="o"><</span><span class="n">pointer</span> <span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">gc</span><span class="o">.</span><span class="n">relocate</span><span class="p">(</span><span class="n">token</span> <span class="o">%</span><span class="n">statepoint_token</span><span class="p">,</span>
<span class="n">i32</span> <span class="o">%</span><span class="n">base_offset</span><span class="p">,</span>
<span class="n">i32</span> <span class="o">%</span><span class="n">pointer_offset</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id388">
<h5><a class="toc-backref" href="#id2062">Overview:</a><a class="headerlink" href="#id388" title="Permalink to this headline">¶</a></h5>
<p>A <code class="docutils literal notranslate"><span class="pre">gc.relocate</span></code> returns the potentially relocated value of a pointer
at the safepoint.</p>
</div>
<div class="section" id="id389">
<h5><a class="toc-backref" href="#id2063">Operands:</a><a class="headerlink" href="#id389" title="Permalink to this headline">¶</a></h5>
<p>The first argument is the <code class="docutils literal notranslate"><span class="pre">gc.statepoint</span></code> which starts the
safepoint sequence of which this <code class="docutils literal notranslate"><span class="pre">gc.relocation</span></code> is a part.
Despite the typing of this as a generic token, <em>only</em> the value defined
by a <code class="docutils literal notranslate"><span class="pre">gc.statepoint</span></code> is legal here.</p>
<p>The second and third arguments are both indices into operands of the
corresponding statepoint’s <a class="reference internal" href="#ob-gc-live"><span class="std std-ref">gc-live</span></a> operand bundle.</p>
<p>The second argument is an index which specifies the allocation for the pointer
being relocated. The associated value must be within the object with which the
pointer being relocated is associated. The optimizer is free to change <em>which</em>
interior derived pointer is reported, provided that it does not replace an
actual base pointer with another interior derived pointer. Collectors are
allowed to rely on the base pointer operand remaining an actual base pointer if
so constructed.</p>
<p>The third argument is an index which specify the (potentially) derived pointer
being relocated. It is legal for this index to be the same as the second
argument if-and-only-if a base pointer is being relocated.</p>
</div>
<div class="section" id="id390">
<h5><a class="toc-backref" href="#id2064">Semantics:</a><a class="headerlink" href="#id390" title="Permalink to this headline">¶</a></h5>
<p>The return value of <code class="docutils literal notranslate"><span class="pre">gc.relocate</span></code> is the potentially relocated value
of the pointer specified by its arguments. It is unspecified how the
value of the returned pointer relates to the argument to the
<code class="docutils literal notranslate"><span class="pre">gc.statepoint</span></code> other than that a) it points to the same source
language object with the same offset, and b) the ‘based-on’
relationship of the newly relocated pointers is a projection of the
unrelocated pointers. In particular, the integer value of the pointer
returned is unspecified.</p>
<p>A <code class="docutils literal notranslate"><span class="pre">gc.relocate</span></code> is modeled as a <code class="docutils literal notranslate"><span class="pre">readnone</span></code> pure function. It has no
side effects since it is just a way to extract information about work
done during the actual call modeled by the <code class="docutils literal notranslate"><span class="pre">gc.statepoint</span></code>.</p>
</div>
</div>
<div class="section" id="llvm-experimental-gc-get-pointer-base-intrinsic">
<span id="gc-get-pointer-base"></span><h4><a class="toc-backref" href="#id2065">‘llvm.experimental.gc.get.pointer.base’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-gc-get-pointer-base-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id391">
<h5><a class="toc-backref" href="#id2066">Syntax:</a><a class="headerlink" href="#id391" 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="o"><</span><span class="n">pointer</span> <span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">gc</span><span class="o">.</span><span class="n">get</span><span class="o">.</span><span class="n">pointer</span><span class="o">.</span><span class="n">base</span><span class="p">(</span>
<span class="o"><</span><span class="n">pointer</span> <span class="nb">type</span><span class="o">></span> <span class="n">readnone</span> <span class="n">nocapture</span> <span class="o">%</span><span class="n">derived_ptr</span><span class="p">)</span>
<span class="n">nounwind</span> <span class="n">readnone</span> <span class="n">willreturn</span>
</pre></div>
</div>
</div>
<div class="section" id="id392">
<h5><a class="toc-backref" href="#id2067">Overview:</a><a class="headerlink" href="#id392" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">gc.get.pointer.base</span></code> for a derived pointer returns its base pointer.</p>
</div>
<div class="section" id="id393">
<h5><a class="toc-backref" href="#id2068">Operands:</a><a class="headerlink" href="#id393" title="Permalink to this headline">¶</a></h5>
<p>The only argument is a pointer which is based on some object with
an unknown offset from the base of said object.</p>
</div>
<div class="section" id="id394">
<h5><a class="toc-backref" href="#id2069">Semantics:</a><a class="headerlink" href="#id394" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic is used in the abstract machine model for GC to represent
the base pointer for an arbitrary derived pointer.</p>
<p>This intrinsic is inlined by the <a class="reference internal" href="Statepoints.html#rewritestatepointsforgc"><span class="std std-ref">RewriteStatepointsForGC</span></a> pass by
replacing all uses of this callsite with the offset of a derived pointer from
its base pointer value. The replacement is done as part of the lowering to the
explicit statepoint model.</p>
<p>The return pointer type must be the same as the type of the parameter.</p>
</div>
</div>
<div class="section" id="llvm-experimental-gc-get-pointer-offset-intrinsic">
<h4><a class="toc-backref" href="#id2070">‘llvm.experimental.gc.get.pointer.offset’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-gc-get-pointer-offset-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id395">
<h5><a class="toc-backref" href="#id2071">Syntax:</a><a class="headerlink" href="#id395" 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">i64</span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">gc</span><span class="o">.</span><span class="n">get</span><span class="o">.</span><span class="n">pointer</span><span class="o">.</span><span class="n">offset</span><span class="p">(</span>
<span class="o"><</span><span class="n">pointer</span> <span class="nb">type</span><span class="o">></span> <span class="n">readnone</span> <span class="n">nocapture</span> <span class="o">%</span><span class="n">derived_ptr</span><span class="p">)</span>
<span class="n">nounwind</span> <span class="n">readnone</span> <span class="n">willreturn</span>
</pre></div>
</div>
</div>
<div class="section" id="id396">
<h5><a class="toc-backref" href="#id2072">Overview:</a><a class="headerlink" href="#id396" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">gc.get.pointer.offset</span></code> for a derived pointer returns the offset from its
base pointer.</p>
</div>
<div class="section" id="id397">
<h5><a class="toc-backref" href="#id2073">Operands:</a><a class="headerlink" href="#id397" title="Permalink to this headline">¶</a></h5>
<p>The only argument is a pointer which is based on some object with
an unknown offset from the base of said object.</p>
</div>
<div class="section" id="id398">
<h5><a class="toc-backref" href="#id2074">Semantics:</a><a class="headerlink" href="#id398" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic is used in the abstract machine model for GC to represent
the offset of an arbitrary derived pointer from its base pointer.</p>
<p>This intrinsic is inlined by the <a class="reference internal" href="Statepoints.html#rewritestatepointsforgc"><span class="std std-ref">RewriteStatepointsForGC</span></a> pass by
replacing all uses of this callsite with the offset of a derived pointer from
its base pointer value. The replacement is done as part of the lowering to the
explicit statepoint model.</p>
<p>Basically this call calculates difference between the derived pointer and its
base pointer (see <a class="reference internal" href="#gc-get-pointer-base"><span class="std std-ref">‘llvm.experimental.gc.get.pointer.base’ Intrinsic</span></a>) both ptrtoint casted. But
this cast done outside the <a class="reference internal" href="Statepoints.html#rewritestatepointsforgc"><span class="std std-ref">RewriteStatepointsForGC</span></a> pass could result
in the pointers lost for further lowering from the abstract model to the
explicit physical one.</p>
</div>
</div>
</div>
<div class="section" id="code-generator-intrinsics">
<h3><a class="toc-backref" href="#id2075">Code Generator Intrinsics</a><a class="headerlink" href="#code-generator-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>These intrinsics are provided by LLVM to expose special features that
may only be implemented with code generator support.</p>
<div class="section" id="llvm-returnaddress-intrinsic">
<h4><a class="toc-backref" href="#id2076">‘<code class="docutils literal notranslate"><span class="pre">llvm.returnaddress</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-returnaddress-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id399">
<h5><a class="toc-backref" href="#id2077">Syntax:</a><a class="headerlink" href="#id399" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">returnaddress</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">level</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id400">
<h5><a class="toc-backref" href="#id2078">Overview:</a><a class="headerlink" href="#id400" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.returnaddress</span></code>’ intrinsic attempts to compute a
target-specific value indicating the return address of the current
function or one of its callers.</p>
</div>
<div class="section" id="id401">
<h5><a class="toc-backref" href="#id2079">Arguments:</a><a class="headerlink" href="#id401" title="Permalink to this headline">¶</a></h5>
<p>The argument to this intrinsic indicates which function to return the
address for. Zero indicates the calling function, one indicates its
caller, etc. The argument is <strong>required</strong> to be a constant integer
value.</p>
</div>
<div class="section" id="id402">
<h5><a class="toc-backref" href="#id2080">Semantics:</a><a class="headerlink" href="#id402" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.returnaddress</span></code>’ intrinsic either returns a pointer
indicating the return address of the specified call frame, or zero if it
cannot be identified. The value returned by this intrinsic is likely to
be incorrect or 0 for arguments other than zero, so it should only be
used for debugging purposes.</p>
<p>Note that calling this intrinsic does not prevent function inlining or
other aggressive transformations, so the value returned may not be that
of the obvious source-language caller.</p>
</div>
</div>
<div class="section" id="llvm-addressofreturnaddress-intrinsic">
<h4><a class="toc-backref" href="#id2081">‘<code class="docutils literal notranslate"><span class="pre">llvm.addressofreturnaddress</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-addressofreturnaddress-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id403">
<h5><a class="toc-backref" href="#id2082">Syntax:</a><a class="headerlink" href="#id403" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">addressofreturnaddress</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="id404">
<h5><a class="toc-backref" href="#id2083">Overview:</a><a class="headerlink" href="#id404" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.addressofreturnaddress</span></code>’ intrinsic returns a target-specific
pointer to the place in the stack frame where the return address of the
current function is stored.</p>
</div>
<div class="section" id="id405">
<h5><a class="toc-backref" href="#id2084">Semantics:</a><a class="headerlink" href="#id405" title="Permalink to this headline">¶</a></h5>
<p>Note that calling this intrinsic does not prevent function inlining or
other aggressive transformations, so the value returned may not be that
of the obvious source-language caller.</p>
<p>This intrinsic is only implemented for x86 and aarch64.</p>
</div>
</div>
<div class="section" id="llvm-sponentry-intrinsic">
<h4><a class="toc-backref" href="#id2085">‘<code class="docutils literal notranslate"><span class="pre">llvm.sponentry</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-sponentry-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id406">
<h5><a class="toc-backref" href="#id2086">Syntax:</a><a class="headerlink" href="#id406" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sponentry</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="id407">
<h5><a class="toc-backref" href="#id2087">Overview:</a><a class="headerlink" href="#id407" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.sponentry</span></code>’ intrinsic returns the stack pointer value at
the entry of the current function calling this intrinsic.</p>
</div>
<div class="section" id="id408">
<h5><a class="toc-backref" href="#id2088">Semantics:</a><a class="headerlink" href="#id408" title="Permalink to this headline">¶</a></h5>
<p>Note this intrinsic is only verified on AArch64.</p>
</div>
</div>
<div class="section" id="llvm-frameaddress-intrinsic">
<h4><a class="toc-backref" href="#id2089">‘<code class="docutils literal notranslate"><span class="pre">llvm.frameaddress</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-frameaddress-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id409">
<h5><a class="toc-backref" href="#id2090">Syntax:</a><a class="headerlink" href="#id409" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">frameaddress</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">level</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id410">
<h5><a class="toc-backref" href="#id2091">Overview:</a><a class="headerlink" href="#id410" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.frameaddress</span></code>’ intrinsic attempts to return the
target-specific frame pointer value for the specified stack frame.</p>
</div>
<div class="section" id="id411">
<h5><a class="toc-backref" href="#id2092">Arguments:</a><a class="headerlink" href="#id411" title="Permalink to this headline">¶</a></h5>
<p>The argument to this intrinsic indicates which function to return the
frame pointer for. Zero indicates the calling function, one indicates
its caller, etc. The argument is <strong>required</strong> to be a constant integer
value.</p>
</div>
<div class="section" id="id412">
<h5><a class="toc-backref" href="#id2093">Semantics:</a><a class="headerlink" href="#id412" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.frameaddress</span></code>’ intrinsic either returns a pointer
indicating the frame address of the specified call frame, or zero if it
cannot be identified. The value returned by this intrinsic is likely to
be incorrect or 0 for arguments other than zero, so it should only be
used for debugging purposes.</p>
<p>Note that calling this intrinsic does not prevent function inlining or
other aggressive transformations, so the value returned may not be that
of the obvious source-language caller.</p>
</div>
</div>
<div class="section" id="llvm-swift-async-context-addr-intrinsic">
<h4><a class="toc-backref" href="#id2094">‘<code class="docutils literal notranslate"><span class="pre">llvm.swift.async.context.addr</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-swift-async-context-addr-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id413">
<h5><a class="toc-backref" href="#id2095">Syntax:</a><a class="headerlink" href="#id413" 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">i8</span><span class="o">**</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">swift</span><span class="o">.</span><span class="k">async</span><span class="o">.</span><span class="n">context</span><span class="o">.</span><span class="n">addr</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="id414">
<h5><a class="toc-backref" href="#id2096">Overview:</a><a class="headerlink" href="#id414" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.swift.async.context.addr</span></code>’ intrinsic returns a pointer to
the part of the extended frame record containing the asynchronous
context of a Swift execution.</p>
</div>
<div class="section" id="id415">
<h5><a class="toc-backref" href="#id2097">Semantics:</a><a class="headerlink" href="#id415" title="Permalink to this headline">¶</a></h5>
<p>If the caller has a <code class="docutils literal notranslate"><span class="pre">swiftasync</span></code> parameter, that argument will initially
be stored at the returned address. If not, it will be initialized to null.</p>
</div>
</div>
<div class="section" id="llvm-localescape-and-llvm-localrecover-intrinsics">
<h4><a class="toc-backref" href="#id2098">‘<code class="docutils literal notranslate"><span class="pre">llvm.localescape</span></code>’ and ‘<code class="docutils literal notranslate"><span class="pre">llvm.localrecover</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-localescape-and-llvm-localrecover-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id416">
<h5><a class="toc-backref" href="#id2099">Syntax:</a><a class="headerlink" href="#id416" 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">localescape</span><span class="p">(</span><span class="o">...</span><span class="p">)</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">localrecover</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o">%</span><span class="n">func</span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o">%</span><span class="n">fp</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">idx</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id417">
<h5><a class="toc-backref" href="#id2100">Overview:</a><a class="headerlink" href="#id417" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.localescape</span></code>’ intrinsic escapes offsets of a collection of static
allocas, and the ‘<code class="docutils literal notranslate"><span class="pre">llvm.localrecover</span></code>’ intrinsic applies those offsets to a
live frame pointer to recover the address of the allocation. The offset is
computed during frame layout of the caller of <code class="docutils literal notranslate"><span class="pre">llvm.localescape</span></code>.</p>
</div>
<div class="section" id="id418">
<h5><a class="toc-backref" href="#id2101">Arguments:</a><a class="headerlink" href="#id418" title="Permalink to this headline">¶</a></h5>
<p>All arguments to ‘<code class="docutils literal notranslate"><span class="pre">llvm.localescape</span></code>’ must be pointers to static allocas or
casts of static allocas. Each function can only call ‘<code class="docutils literal notranslate"><span class="pre">llvm.localescape</span></code>’
once, and it can only do so from the entry block.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">func</span></code> argument to ‘<code class="docutils literal notranslate"><span class="pre">llvm.localrecover</span></code>’ must be a constant
bitcasted pointer to a function defined in the current module. The code
generator cannot determine the frame allocation offset of functions defined in
other modules.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">fp</span></code> argument to ‘<code class="docutils literal notranslate"><span class="pre">llvm.localrecover</span></code>’ must be a frame pointer of a
call frame that is currently live. The return value of ‘<code class="docutils literal notranslate"><span class="pre">llvm.localaddress</span></code>’
is one way to produce such a value, but various runtimes also expose a suitable
pointer in platform-specific ways.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">idx</span></code> argument to ‘<code class="docutils literal notranslate"><span class="pre">llvm.localrecover</span></code>’ indicates which alloca passed to
‘<code class="docutils literal notranslate"><span class="pre">llvm.localescape</span></code>’ to recover. It is zero-indexed.</p>
</div>
<div class="section" id="id419">
<h5><a class="toc-backref" href="#id2102">Semantics:</a><a class="headerlink" href="#id419" title="Permalink to this headline">¶</a></h5>
<p>These intrinsics allow a group of functions to share access to a set of local
stack allocations of a one parent function. The parent function may call the
‘<code class="docutils literal notranslate"><span class="pre">llvm.localescape</span></code>’ intrinsic once from the function entry block, and the
child functions can use ‘<code class="docutils literal notranslate"><span class="pre">llvm.localrecover</span></code>’ to access the escaped allocas.
The ‘<code class="docutils literal notranslate"><span class="pre">llvm.localescape</span></code>’ intrinsic blocks inlining, as inlining changes where
the escaped allocas are allocated, which would break attempts to use
‘<code class="docutils literal notranslate"><span class="pre">llvm.localrecover</span></code>’.</p>
</div>
</div>
<div class="section" id="llvm-seh-try-begin-and-llvm-seh-try-end-intrinsics">
<h4><a class="toc-backref" href="#id2103">‘<code class="docutils literal notranslate"><span class="pre">llvm.seh.try.begin</span></code>’ and ‘<code class="docutils literal notranslate"><span class="pre">llvm.seh.try.end</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-seh-try-begin-and-llvm-seh-try-end-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id420">
<h5><a class="toc-backref" href="#id2104">Syntax:</a><a class="headerlink" href="#id420" 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">seh</span><span class="o">.</span><span class="k">try</span><span class="o">.</span><span class="n">begin</span><span class="p">()</span>
<span class="n">declare</span> <span class="n">void</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">seh</span><span class="o">.</span><span class="k">try</span><span class="o">.</span><span class="n">end</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="id421">
<h5><a class="toc-backref" href="#id2105">Overview:</a><a class="headerlink" href="#id421" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.seh.try.begin</span></code>’ and ‘<code class="docutils literal notranslate"><span class="pre">llvm.seh.try.end</span></code>’ intrinsics mark
the boundary of a _try region for Windows SEH Asynchrous Exception Handling.</p>
</div>
<div class="section" id="id422">
<h5><a class="toc-backref" href="#id2106">Semantics:</a><a class="headerlink" href="#id422" title="Permalink to this headline">¶</a></h5>
<p>When a C-function is compiled with Windows SEH Asynchrous Exception option,
-feh_asynch (aka MSVC -EHa), these two intrinsics are injected to mark _try
boundary and to prevent potential exceptions from being moved across boundary.
Any set of operations can then be confined to the region by reading their leaf
inputs via volatile loads and writing their root outputs via volatile stores.</p>
</div>
</div>
<div class="section" id="llvm-seh-scope-begin-and-llvm-seh-scope-end-intrinsics">
<h4><a class="toc-backref" href="#id2107">‘<code class="docutils literal notranslate"><span class="pre">llvm.seh.scope.begin</span></code>’ and ‘<code class="docutils literal notranslate"><span class="pre">llvm.seh.scope.end</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-seh-scope-begin-and-llvm-seh-scope-end-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id423">
<h5><a class="toc-backref" href="#id2108">Syntax:</a><a class="headerlink" href="#id423" 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">seh</span><span class="o">.</span><span class="n">scope</span><span class="o">.</span><span class="n">begin</span><span class="p">()</span>
<span class="n">declare</span> <span class="n">void</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">seh</span><span class="o">.</span><span class="n">scope</span><span class="o">.</span><span class="n">end</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="id424">
<h5><a class="toc-backref" href="#id2109">Overview:</a><a class="headerlink" href="#id424" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.seh.scope.begin</span></code>’ and ‘<code class="docutils literal notranslate"><span class="pre">llvm.seh.scope.end</span></code>’ intrinsics mark
the boundary of a CPP object lifetime for Windows SEH Asynchrous Exception
Handling (MSVC option -EHa).</p>
</div>
<div class="section" id="id425">
<h5><a class="toc-backref" href="#id2110">Semantics:</a><a class="headerlink" href="#id425" title="Permalink to this headline">¶</a></h5>
<p>LLVM’s ordinary exception-handling representation associates EH cleanups and
handlers only with <code class="docutils literal notranslate"><span class="pre">invoke``s,</span> <span class="pre">which</span> <span class="pre">normally</span> <span class="pre">correspond</span> <span class="pre">only</span> <span class="pre">to</span> <span class="pre">call</span> <span class="pre">sites.</span>  <span class="pre">To</span>
<span class="pre">support</span> <span class="pre">arbitrary</span> <span class="pre">faulting</span> <span class="pre">instructions,</span> <span class="pre">it</span> <span class="pre">must</span> <span class="pre">be</span> <span class="pre">possible</span> <span class="pre">to</span> <span class="pre">recover</span> <span class="pre">the</span> <span class="pre">current</span>
<span class="pre">EH</span> <span class="pre">scope</span> <span class="pre">for</span> <span class="pre">any</span> <span class="pre">instruction.</span>  <span class="pre">Turning</span> <span class="pre">every</span> <span class="pre">operation</span> <span class="pre">in</span> <span class="pre">LLVM</span> <span class="pre">that</span> <span class="pre">could</span> <span class="pre">fault</span>
<span class="pre">into</span> <span class="pre">an</span> <span class="pre">``invoke</span></code> of a new, potentially-throwing intrinsic would require adding a
large number of intrinsics, impede optimization of those operations, and make
compilation slower by introducing many extra basic blocks. These intrinsics can
be used instead to mark the region protected by a cleanup, such as for a local
C++ object with a non-trivial destructor. <code class="docutils literal notranslate"><span class="pre">llvm.seh.scope.begin</span></code> is used to mark
the start of the region; it is always called with <code class="docutils literal notranslate"><span class="pre">invoke</span></code>, with the unwind block
being the desired unwind destination for any potentially-throwing instructions
within the region. <cite>llvm.seh.scope.end</cite> is used to mark when the scope ends
and the EH cleanup is no longer required (e.g. because the destructor is being
called).</p>
</div>
</div>
<div class="section" id="llvm-read-register-llvm-read-volatile-register-and-llvm-write-register-intrinsics">
<span id="int-write-register"></span><span id="int-read-volatile-register"></span><span id="int-read-register"></span><h4><a class="toc-backref" href="#id2111">‘<code class="docutils literal notranslate"><span class="pre">llvm.read_register</span></code>’, ‘<code class="docutils literal notranslate"><span class="pre">llvm.read_volatile_register</span></code>’, and ‘<code class="docutils literal notranslate"><span class="pre">llvm.write_register</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-read-register-llvm-read-volatile-register-and-llvm-write-register-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id426">
<h5><a class="toc-backref" href="#id2112">Syntax:</a><a class="headerlink" href="#id426" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>declare i32 @llvm.read_register.i32(metadata)
declare i64 @llvm.read_register.i64(metadata)
declare i32 @llvm.read_volatile_register.i32(metadata)
declare i64 @llvm.read_volatile_register.i64(metadata)
declare void @llvm.write_register.i32(metadata, i32 @value)
declare void @llvm.write_register.i64(metadata, i64 @value)
!0 = !{!"sp\00"}
</pre></div>
</div>
</div>
<div class="section" id="id427">
<h5><a class="toc-backref" href="#id2113">Overview:</a><a class="headerlink" href="#id427" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.read_register</span></code>’, ‘<code class="docutils literal notranslate"><span class="pre">llvm.read_volatile_register</span></code>’, and
‘<code class="docutils literal notranslate"><span class="pre">llvm.write_register</span></code>’ intrinsics provide access to the named register.
The register must be valid on the architecture being compiled to. The type
needs to be compatible with the register being read.</p>
</div>
<div class="section" id="id428">
<h5><a class="toc-backref" href="#id2114">Semantics:</a><a class="headerlink" href="#id428" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.read_register</span></code>’ and ‘<code class="docutils literal notranslate"><span class="pre">llvm.read_volatile_register</span></code>’ intrinsics
return the current value of the register, where possible. The
‘<code class="docutils literal notranslate"><span class="pre">llvm.write_register</span></code>’ intrinsic sets the current value of the register,
where possible.</p>
<p>A call to ‘<code class="docutils literal notranslate"><span class="pre">llvm.read_volatile_register</span></code>’ is assumed to have side-effects
and possibly return a different value each time (e.g. for a timer register).</p>
<p>This is useful to implement named register global variables that need
to always be mapped to a specific register, as is common practice on
bare-metal programs including OS kernels.</p>
<p>The compiler doesn’t check for register availability or use of the used
register in surrounding code, including inline assembly. Because of that,
allocatable registers are not supported.</p>
<p>Warning: So far it only works with the stack pointer on selected
architectures (ARM, AArch64, PowerPC and x86_64). Significant amount of
work is needed to support other registers and even more so, allocatable
registers.</p>
</div>
</div>
<div class="section" id="llvm-stacksave-intrinsic">
<span id="int-stacksave"></span><h4><a class="toc-backref" href="#id2115">‘<code class="docutils literal notranslate"><span class="pre">llvm.stacksave</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-stacksave-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id429">
<h5><a class="toc-backref" href="#id2116">Syntax:</a><a class="headerlink" href="#id429" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">stacksave</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="id430">
<h5><a class="toc-backref" href="#id2117">Overview:</a><a class="headerlink" href="#id430" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.stacksave</span></code>’ intrinsic is used to remember the current state
of the function stack, for use with
<a class="reference internal" href="#int-stackrestore"><span class="std std-ref">llvm.stackrestore</span></a>. This is useful for
implementing language features like scoped automatic variable sized
arrays in C99.</p>
</div>
<div class="section" id="id431">
<h5><a class="toc-backref" href="#id2118">Semantics:</a><a class="headerlink" href="#id431" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic returns an opaque pointer value that can be passed to
<a class="reference internal" href="#int-stackrestore"><span class="std std-ref">llvm.stackrestore</span></a>. When an
<code class="docutils literal notranslate"><span class="pre">llvm.stackrestore</span></code> intrinsic is executed with a value saved from
<code class="docutils literal notranslate"><span class="pre">llvm.stacksave</span></code>, it effectively restores the state of the stack to
the state it was in when the <code class="docutils literal notranslate"><span class="pre">llvm.stacksave</span></code> intrinsic executed. In
practice, this pops any <a class="reference internal" href="#i-alloca"><span class="std std-ref">alloca</span></a> blocks from the stack that
were allocated after the <code class="docutils literal notranslate"><span class="pre">llvm.stacksave</span></code> was executed.</p>
</div>
</div>
<div class="section" id="llvm-stackrestore-intrinsic">
<span id="int-stackrestore"></span><h4><a class="toc-backref" href="#id2119">‘<code class="docutils literal notranslate"><span class="pre">llvm.stackrestore</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-stackrestore-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id432">
<h5><a class="toc-backref" href="#id2120">Syntax:</a><a class="headerlink" href="#id432" 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">stackrestore</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="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id433">
<h5><a class="toc-backref" href="#id2121">Overview:</a><a class="headerlink" href="#id433" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.stackrestore</span></code>’ intrinsic is used to restore the state of
the function stack to the state it was in when the corresponding
<a class="reference internal" href="#int-stacksave"><span class="std std-ref">llvm.stacksave</span></a> intrinsic executed. This is
useful for implementing language features like scoped automatic variable
sized arrays in C99.</p>
</div>
<div class="section" id="id434">
<h5><a class="toc-backref" href="#id2122">Semantics:</a><a class="headerlink" href="#id434" title="Permalink to this headline">¶</a></h5>
<p>See the description for <a class="reference internal" href="#int-stacksave"><span class="std std-ref">llvm.stacksave</span></a>.</p>
</div>
</div>
<div class="section" id="llvm-get-dynamic-area-offset-intrinsic">
<span id="int-get-dynamic-area-offset"></span><h4><a class="toc-backref" href="#id2123">‘<code class="docutils literal notranslate"><span class="pre">llvm.get.dynamic.area.offset</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-get-dynamic-area-offset-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id435">
<h5><a class="toc-backref" href="#id2124">Syntax:</a><a class="headerlink" href="#id435" 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">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">get</span><span class="o">.</span><span class="n">dynamic</span><span class="o">.</span><span class="n">area</span><span class="o">.</span><span class="n">offset</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">get</span><span class="o">.</span><span class="n">dynamic</span><span class="o">.</span><span class="n">area</span><span class="o">.</span><span class="n">offset</span><span class="o">.</span><span class="n">i64</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="id436">
<h5><a class="toc-backref" href="#id2125">Overview:</a><a class="headerlink" href="#id436" title="Permalink to this headline">¶</a></h5>
<blockquote>
<div><p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.get.dynamic.area.offset.*</span></code>’ intrinsic family is used to
get the offset from native stack pointer to the address of the most
recent dynamic alloca on the caller’s stack. These intrinsics are
intended for use in combination with
<a class="reference internal" href="#int-stacksave"><span class="std std-ref">llvm.stacksave</span></a> to get a
pointer to the most recent dynamic alloca. This is useful, for example,
for AddressSanitizer’s stack unpoisoning routines.</p>
</div></blockquote>
</div>
<div class="section" id="id437">
<h5><a class="toc-backref" href="#id2126">Semantics:</a><a class="headerlink" href="#id437" title="Permalink to this headline">¶</a></h5>
<blockquote>
<div><p>These intrinsics return a non-negative integer value that can be used to
get the address of the most recent dynamic alloca, allocated by <a class="reference internal" href="#i-alloca"><span class="std std-ref">alloca</span></a>
on the caller’s stack. In particular, for targets where stack grows downwards,
adding this offset to the native stack pointer would get the address of the most
recent dynamic alloca. For targets where stack grows upwards, the situation is a bit more
complicated, because subtracting this value from stack pointer would get the address
one past the end of the most recent dynamic alloca.</p>
<p>Although for most targets <cite>llvm.get.dynamic.area.offset <int_get_dynamic_area_offset></cite>
returns just a zero, for others, such as PowerPC and PowerPC64, it returns a
compile-time-known constant value.</p>
<p>The return value type of <a class="reference internal" href="#int-get-dynamic-area-offset"><span class="std std-ref">llvm.get.dynamic.area.offset</span></a>
must match the target’s default address space’s (address space 0) pointer type.</p>
</div></blockquote>
</div>
</div>
<div class="section" id="llvm-prefetch-intrinsic">
<h4><a class="toc-backref" href="#id2127">‘<code class="docutils literal notranslate"><span class="pre">llvm.prefetch</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-prefetch-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id438">
<h5><a class="toc-backref" href="#id2128">Syntax:</a><a class="headerlink" href="#id438" 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">prefetch</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">address</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">rw</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">locality</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">cache</span> <span class="nb">type</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id439">
<h5><a class="toc-backref" href="#id2129">Overview:</a><a class="headerlink" href="#id439" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.prefetch</span></code>’ intrinsic is a hint to the code generator to
insert a prefetch instruction if supported; otherwise, it is a noop.
Prefetches have no effect on the behavior of the program but can change
its performance characteristics.</p>
</div>
<div class="section" id="id440">
<h5><a class="toc-backref" href="#id2130">Arguments:</a><a class="headerlink" href="#id440" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">address</span></code> is the address to be prefetched, <code class="docutils literal notranslate"><span class="pre">rw</span></code> is the specifier
determining if the fetch should be for a read (0) or write (1), and
<code class="docutils literal notranslate"><span class="pre">locality</span></code> is a temporal locality specifier ranging from (0) - no
locality, to (3) - extremely local keep in cache. The <code class="docutils literal notranslate"><span class="pre">cache</span> <span class="pre">type</span></code>
specifies whether the prefetch is performed on the data (1) or
instruction (0) cache. The <code class="docutils literal notranslate"><span class="pre">rw</span></code>, <code class="docutils literal notranslate"><span class="pre">locality</span></code> and <code class="docutils literal notranslate"><span class="pre">cache</span> <span class="pre">type</span></code>
arguments must be constant integers.</p>
</div>
<div class="section" id="id441">
<h5><a class="toc-backref" href="#id2131">Semantics:</a><a class="headerlink" href="#id441" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic does not modify the behavior of the program. In
particular, prefetches cannot trap and do not produce a value. On
targets that support this intrinsic, the prefetch can provide hints to
the processor cache for better performance.</p>
</div>
</div>
<div class="section" id="llvm-pcmarker-intrinsic">
<h4><a class="toc-backref" href="#id2132">‘<code class="docutils literal notranslate"><span class="pre">llvm.pcmarker</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-pcmarker-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id442">
<h5><a class="toc-backref" href="#id2133">Syntax:</a><a class="headerlink" href="#id442" 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">pcmarker</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="nb">id</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id443">
<h5><a class="toc-backref" href="#id2134">Overview:</a><a class="headerlink" href="#id443" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.pcmarker</span></code>’ intrinsic is a method to export a Program
Counter (PC) in a region of code to simulators and other tools. The
method is target specific, but it is expected that the marker will use
exported symbols to transmit the PC of the marker. The marker makes no
guarantees that it will remain with any specific instruction after
optimizations. It is possible that the presence of a marker will inhibit
optimizations. The intended use is to be inserted after optimizations to
allow correlations of simulation runs.</p>
</div>
<div class="section" id="id444">
<h5><a class="toc-backref" href="#id2135">Arguments:</a><a class="headerlink" href="#id444" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">id</span></code> is a numerical id identifying the marker.</p>
</div>
<div class="section" id="id445">
<h5><a class="toc-backref" href="#id2136">Semantics:</a><a class="headerlink" href="#id445" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic does not modify the behavior of the program. Backends
that do not support this intrinsic may ignore it.</p>
</div>
</div>
<div class="section" id="llvm-readcyclecounter-intrinsic">
<h4><a class="toc-backref" href="#id2137">‘<code class="docutils literal notranslate"><span class="pre">llvm.readcyclecounter</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-readcyclecounter-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id446">
<h5><a class="toc-backref" href="#id2138">Syntax:</a><a class="headerlink" href="#id446" 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">i64</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">readcyclecounter</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="id447">
<h5><a class="toc-backref" href="#id2139">Overview:</a><a class="headerlink" href="#id447" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.readcyclecounter</span></code>’ intrinsic provides access to the cycle
counter register (or similar low latency, high accuracy clocks) on those
targets that support it. On X86, it should map to RDTSC. On Alpha, it
should map to RPCC. As the backing counters overflow quickly (on the
order of 9 seconds on alpha), this should only be used for small
timings.</p>
</div>
<div class="section" id="id448">
<h5><a class="toc-backref" href="#id2140">Semantics:</a><a class="headerlink" href="#id448" title="Permalink to this headline">¶</a></h5>
<p>When directly supported, reading the cycle counter should not modify any
memory. Implementations are allowed to either return an application
specific value or a system wide value. On backends without support, this
is lowered to a constant 0.</p>
<p>Note that runtime support may be conditional on the privilege-level code is
running at and the host platform.</p>
</div>
</div>
<div class="section" id="llvm-clear-cache-intrinsic">
<h4><a class="toc-backref" href="#id2141">‘<code class="docutils literal notranslate"><span class="pre">llvm.clear_cache</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-clear-cache-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id449">
<h5><a class="toc-backref" href="#id2142">Syntax:</a><a class="headerlink" href="#id449" 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">clear_cache</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>
</pre></div>
</div>
</div>
<div class="section" id="id450">
<h5><a class="toc-backref" href="#id2143">Overview:</a><a class="headerlink" href="#id450" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.clear_cache</span></code>’ intrinsic ensures visibility of modifications
in the specified range to the execution unit of the processor. On
targets with non-unified instruction and data cache, the implementation
flushes the instruction cache.</p>
</div>
<div class="section" id="id451">
<h5><a class="toc-backref" href="#id2144">Semantics:</a><a class="headerlink" href="#id451" title="Permalink to this headline">¶</a></h5>
<p>On platforms with coherent instruction and data caches (e.g. x86), this
intrinsic is a nop. On platforms with non-coherent instruction and data
cache (e.g. ARM, MIPS), the intrinsic is lowered either to appropriate
instructions or a system call, if cache flushing requires special
privileges.</p>
<p>The default behavior is to emit a call to <code class="docutils literal notranslate"><span class="pre">__clear_cache</span></code> from the run
time library.</p>
<p>This intrinsic does <em>not</em> empty the instruction pipeline. Modifications
of the current function are outside the scope of the intrinsic.</p>
</div>
</div>
<div class="section" id="llvm-instrprof-increment-intrinsic">
<h4><a class="toc-backref" href="#id2145">‘<code class="docutils literal notranslate"><span class="pre">llvm.instrprof.increment</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-instrprof-increment-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id452">
<h5><a class="toc-backref" href="#id2146">Syntax:</a><a class="headerlink" href="#id452" 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">instrprof</span><span class="o">.</span><span class="n">increment</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">name</span><span class="o">></span><span class="p">,</span> <span class="n">i64</span> <span class="o"><</span><span class="nb">hash</span><span class="o">></span><span class="p">,</span>
<span class="n">i32</span> <span class="o"><</span><span class="n">num</span><span class="o">-</span><span class="n">counters</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">index</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id453">
<h5><a class="toc-backref" href="#id2147">Overview:</a><a class="headerlink" href="#id453" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.instrprof.increment</span></code>’ intrinsic can be emitted by a
frontend for use with instrumentation based profiling. These will be
lowered by the <code class="docutils literal notranslate"><span class="pre">-instrprof</span></code> pass to generate execution counts of a
program at runtime.</p>
</div>
<div class="section" id="id454">
<h5><a class="toc-backref" href="#id2148">Arguments:</a><a class="headerlink" href="#id454" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a pointer to a global variable containing the
name of the entity being instrumented. This should generally be the
(mangled) function name for a set of counters.</p>
<p>The second argument is a hash value that can be used by the consumer
of the profile data to detect changes to the instrumented source, and
the third is the number of counters associated with <code class="docutils literal notranslate"><span class="pre">name</span></code>. It is an
error if <code class="docutils literal notranslate"><span class="pre">hash</span></code> or <code class="docutils literal notranslate"><span class="pre">num-counters</span></code> differ between two instances of
<code class="docutils literal notranslate"><span class="pre">instrprof.increment</span></code> that refer to the same name.</p>
<p>The last argument refers to which of the counters for <code class="docutils literal notranslate"><span class="pre">name</span></code> should
be incremented. It should be a value between 0 and <code class="docutils literal notranslate"><span class="pre">num-counters</span></code>.</p>
</div>
<div class="section" id="id455">
<h5><a class="toc-backref" href="#id2149">Semantics:</a><a class="headerlink" href="#id455" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic represents an increment of a profiling counter. It will
cause the <code class="docutils literal notranslate"><span class="pre">-instrprof</span></code> pass to generate the appropriate data
structures and the code to increment the appropriate value, in a
format that can be written out by a compiler runtime and consumed via
the <code class="docutils literal notranslate"><span class="pre">llvm-profdata</span></code> tool.</p>
</div>
</div>
<div class="section" id="llvm-instrprof-increment-step-intrinsic">
<h4><a class="toc-backref" href="#id2150">‘<code class="docutils literal notranslate"><span class="pre">llvm.instrprof.increment.step</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-instrprof-increment-step-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id456">
<h5><a class="toc-backref" href="#id2151">Syntax:</a><a class="headerlink" href="#id456" 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">instrprof</span><span class="o">.</span><span class="n">increment</span><span class="o">.</span><span class="n">step</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">name</span><span class="o">></span><span class="p">,</span> <span class="n">i64</span> <span class="o"><</span><span class="nb">hash</span><span class="o">></span><span class="p">,</span>
<span class="n">i32</span> <span class="o"><</span><span class="n">num</span><span class="o">-</span><span class="n">counters</span><span class="o">></span><span class="p">,</span>
<span class="n">i32</span> <span class="o"><</span><span class="n">index</span><span class="o">></span><span class="p">,</span> <span class="n">i64</span> <span class="o"><</span><span class="n">step</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id457">
<h5><a class="toc-backref" href="#id2152">Overview:</a><a class="headerlink" href="#id457" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.instrprof.increment.step</span></code>’ intrinsic is an extension to
the ‘<code class="docutils literal notranslate"><span class="pre">llvm.instrprof.increment</span></code>’ intrinsic with an additional fifth
argument to specify the step of the increment.</p>
</div>
<div class="section" id="id458">
<h5><a class="toc-backref" href="#id2153">Arguments:</a><a class="headerlink" href="#id458" title="Permalink to this headline">¶</a></h5>
<p>The first four arguments are the same as ‘<code class="docutils literal notranslate"><span class="pre">llvm.instrprof.increment</span></code>’
intrinsic.</p>
<p>The last argument specifies the value of the increment of the counter variable.</p>
</div>
<div class="section" id="id459">
<h5><a class="toc-backref" href="#id2154">Semantics:</a><a class="headerlink" href="#id459" title="Permalink to this headline">¶</a></h5>
<p>See description of ‘<code class="docutils literal notranslate"><span class="pre">llvm.instrprof.increment</span></code>’ intrinsic.</p>
</div>
</div>
<div class="section" id="llvm-instrprof-value-profile-intrinsic">
<h4><a class="toc-backref" href="#id2155">‘<code class="docutils literal notranslate"><span class="pre">llvm.instrprof.value.profile</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-instrprof-value-profile-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id460">
<h5><a class="toc-backref" href="#id2156">Syntax:</a><a class="headerlink" href="#id460" 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">instrprof</span><span class="o">.</span><span class="n">value</span><span class="o">.</span><span class="n">profile</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">name</span><span class="o">></span><span class="p">,</span> <span class="n">i64</span> <span class="o"><</span><span class="nb">hash</span><span class="o">></span><span class="p">,</span>
<span class="n">i64</span> <span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">value_kind</span><span class="o">></span><span class="p">,</span>
<span class="n">i32</span> <span class="o"><</span><span class="n">index</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id461">
<h5><a class="toc-backref" href="#id2157">Overview:</a><a class="headerlink" href="#id461" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.instrprof.value.profile</span></code>’ intrinsic can be emitted by a
frontend for use with instrumentation based profiling. This will be
lowered by the <code class="docutils literal notranslate"><span class="pre">-instrprof</span></code> pass to find out the target values,
instrumented expressions take in a program at runtime.</p>
</div>
<div class="section" id="id462">
<h5><a class="toc-backref" href="#id2158">Arguments:</a><a class="headerlink" href="#id462" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a pointer to a global variable containing the
name of the entity being instrumented. <code class="docutils literal notranslate"><span class="pre">name</span></code> should generally be the
(mangled) function name for a set of counters.</p>
<p>The second argument is a hash value that can be used by the consumer
of the profile data to detect changes to the instrumented source. It
is an error if <code class="docutils literal notranslate"><span class="pre">hash</span></code> differs between two instances of
<code class="docutils literal notranslate"><span class="pre">llvm.instrprof.*</span></code> that refer to the same name.</p>
<p>The third argument is the value of the expression being profiled. The profiled
expression’s value should be representable as an unsigned 64-bit value. The
fourth argument represents the kind of value profiling that is being done. The
supported value profiling kinds are enumerated through the
<code class="docutils literal notranslate"><span class="pre">InstrProfValueKind</span></code> type declared in the
<code class="docutils literal notranslate"><span class="pre"><include/llvm/ProfileData/InstrProf.h></span></code> header file. The last argument is the
index of the instrumented expression within <code class="docutils literal notranslate"><span class="pre">name</span></code>. It should be >= 0.</p>
</div>
<div class="section" id="id463">
<h5><a class="toc-backref" href="#id2159">Semantics:</a><a class="headerlink" href="#id463" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic represents the point where a call to a runtime routine
should be inserted for value profiling of target expressions. <code class="docutils literal notranslate"><span class="pre">-instrprof</span></code>
pass will generate the appropriate data structures and replace the
<code class="docutils literal notranslate"><span class="pre">llvm.instrprof.value.profile</span></code> intrinsic with the call to the profile
runtime library with proper arguments.</p>
</div>
</div>
<div class="section" id="llvm-thread-pointer-intrinsic">
<h4><a class="toc-backref" href="#id2160">‘<code class="docutils literal notranslate"><span class="pre">llvm.thread.pointer</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-thread-pointer-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id464">
<h5><a class="toc-backref" href="#id2161">Syntax:</a><a class="headerlink" href="#id464" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">thread</span><span class="o">.</span><span class="n">pointer</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="id465">
<h5><a class="toc-backref" href="#id2162">Overview:</a><a class="headerlink" href="#id465" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.thread.pointer</span></code>’ intrinsic returns the value of the thread
pointer.</p>
</div>
<div class="section" id="id466">
<h5><a class="toc-backref" href="#id2163">Semantics:</a><a class="headerlink" href="#id466" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.thread.pointer</span></code>’ intrinsic returns a pointer to the TLS area
for the current thread. The exact semantics of this value are target
specific: it may point to the start of TLS area, to the end, or somewhere
in the middle. Depending on the target, this intrinsic may read a register,
call a helper function, read from an alternate memory space, or perform
other operations necessary to locate the TLS area. Not all targets support
this intrinsic.</p>
</div>
</div>
<div class="section" id="llvm-call-preallocated-setup-intrinsic">
<h4><a class="toc-backref" href="#id2164">‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.setup</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-call-preallocated-setup-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id467">
<h5><a class="toc-backref" href="#id2165">Syntax:</a><a class="headerlink" href="#id467" 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">token</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">call</span><span class="o">.</span><span class="n">preallocated</span><span class="o">.</span><span class="n">setup</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">num_args</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id468">
<h5><a class="toc-backref" href="#id2166">Overview:</a><a class="headerlink" href="#id468" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.setup</span></code>’ intrinsic returns a token which can
be used with a call’s <code class="docutils literal notranslate"><span class="pre">"preallocated"</span></code> operand bundle to indicate that
certain arguments are allocated and initialized before the call.</p>
</div>
<div class="section" id="id469">
<h5><a class="toc-backref" href="#id2167">Semantics:</a><a class="headerlink" href="#id469" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.setup</span></code>’ intrinsic returns a token which is
associated with at most one call. The token can be passed to
‘<code class="docutils literal notranslate"><span class="pre">@llvm.call.preallocated.arg</span></code>’ to get a pointer to get that
corresponding argument. The token must be the parameter to a
<code class="docutils literal notranslate"><span class="pre">"preallocated"</span></code> operand bundle for the corresponding call.</p>
<p>Nested calls to ‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.setup</span></code>’ are allowed, but must
be properly nested. e.g.</p>
<p>:: code-block:: llvm</p>
<blockquote>
<div><p>%t1 = call token @llvm.call.preallocated.setup(i32 0)
%t2 = call token @llvm.call.preallocated.setup(i32 0)
call void foo() [“preallocated”(token %t2)]
call void foo() [“preallocated”(token %t1)]</p>
</div></blockquote>
<p>is allowed, but not</p>
<p>:: code-block:: llvm</p>
<blockquote>
<div><p>%t1 = call token @llvm.call.preallocated.setup(i32 0)
%t2 = call token @llvm.call.preallocated.setup(i32 0)
call void foo() [“preallocated”(token %t1)]
call void foo() [“preallocated”(token %t2)]</p>
</div></blockquote>
</div>
</div>
<div class="section" id="llvm-call-preallocated-arg-intrinsic">
<span id="int-call-preallocated-arg"></span><h4><a class="toc-backref" href="#id2168">‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.arg</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-call-preallocated-arg-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id470">
<h5><a class="toc-backref" href="#id2169">Syntax:</a><a class="headerlink" href="#id470" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">call</span><span class="o">.</span><span class="n">preallocated</span><span class="o">.</span><span class="n">arg</span><span class="p">(</span><span class="n">token</span> <span class="o">%</span><span class="n">setup_token</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">arg_index</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id471">
<h5><a class="toc-backref" href="#id2170">Overview:</a><a class="headerlink" href="#id471" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.arg</span></code>’ intrinsic returns a pointer to the
corresponding preallocated argument for the preallocated call.</p>
</div>
<div class="section" id="id472">
<h5><a class="toc-backref" href="#id2171">Semantics:</a><a class="headerlink" href="#id472" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.arg</span></code>’ intrinsic returns a pointer to the
<code class="docutils literal notranslate"><span class="pre">%arg_index``th</span> <span class="pre">argument</span> <span class="pre">with</span> <span class="pre">the</span> <span class="pre">``preallocated</span></code> attribute for
the call associated with the <code class="docutils literal notranslate"><span class="pre">%setup_token</span></code>, which must be from
‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.setup</span></code>’.</p>
<p>A call to ‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.arg</span></code>’ must have a call site
<code class="docutils literal notranslate"><span class="pre">preallocated</span></code> attribute. The type of the <code class="docutils literal notranslate"><span class="pre">preallocated</span></code> attribute must
match the type used by the <code class="docutils literal notranslate"><span class="pre">preallocated</span></code> attribute of the corresponding
argument at the preallocated call. The type is used in the case that an
<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.setup</span></code> does not have a corresponding call (e.g. due
to DCE), where otherwise we cannot know how large the arguments are.</p>
<p>It is undefined behavior if this is called with a token from an
‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.setup</span></code>’ if another
‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.setup</span></code>’ has already been called or if the
preallocated call corresponding to the ‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.setup</span></code>’
has already been called.</p>
</div>
</div>
<div class="section" id="llvm-call-preallocated-teardown-intrinsic">
<span id="int-call-preallocated-teardown"></span><h4><a class="toc-backref" href="#id2172">‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.teardown</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-call-preallocated-teardown-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id473">
<h5><a class="toc-backref" href="#id2173">Syntax:</a><a class="headerlink" href="#id473" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">call</span><span class="o">.</span><span class="n">preallocated</span><span class="o">.</span><span class="n">teardown</span><span class="p">(</span><span class="n">token</span> <span class="o">%</span><span class="n">setup_token</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id474">
<h5><a class="toc-backref" href="#id2174">Overview:</a><a class="headerlink" href="#id474" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.teardown</span></code>’ intrinsic cleans up the stack
created by a ‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.setup</span></code>’.</p>
</div>
<div class="section" id="id475">
<h5><a class="toc-backref" href="#id2175">Semantics:</a><a class="headerlink" href="#id475" title="Permalink to this headline">¶</a></h5>
<p>The token argument must be a ‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.setup</span></code>’.</p>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.teardown</span></code>’ intrinsic cleans up the stack
allocated by the corresponding ‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.setup</span></code>’. Exactly
one of this or the preallocated call must be called to prevent stack leaks.
It is undefined behavior to call both a ‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.teardown</span></code>’
and the preallocated call for a given ‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.setup</span></code>’.</p>
<p>For example, if the stack is allocated for a preallocated call by a
‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.setup</span></code>’, then an initializer function called on an
allocated argument throws an exception, there should be a
‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.teardown</span></code>’ in the exception handler to prevent
stack leaks.</p>
<p>Following the nesting rules in ‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.setup</span></code>’, nested
calls to ‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.setup</span></code>’ and
‘<code class="docutils literal notranslate"><span class="pre">llvm.call.preallocated.teardown</span></code>’ are allowed but must be properly
nested.</p>
</div>
<div class="section" id="id476">
<h5><a class="toc-backref" href="#id2176">Example:</a><a class="headerlink" href="#id476" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span> %cs = call token @llvm.call.preallocated.setup(i32 1)
%x = call i8* @llvm.call.preallocated.arg(token %cs, i32 0) preallocated(i32)
%y = bitcast i8* %x to i32*
invoke void @constructor(i32* %y) to label %conta unwind label %contb
conta:
call void @foo1(i32* preallocated(i32) %y) ["preallocated"(token %cs)]
ret void
contb:
%s = catchswitch within none [label %catch] unwind to caller
catch:
%p = catchpad within %s []
call void @llvm.call.preallocated.teardown(token %cs)
ret void
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="standard-c-c-library-intrinsics">
<h3><a class="toc-backref" href="#id2177">Standard C/C++ Library Intrinsics</a><a class="headerlink" href="#standard-c-c-library-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>LLVM provides intrinsics for a few important standard C/C++ library
functions. These intrinsics allow source-language front-ends to pass
information about the alignment of the pointer arguments to the code
generator, providing opportunity for more efficient code generation.</p>
<div class="section" id="llvm-abs-intrinsic">
<h4><a class="toc-backref" href="#id2178">‘<code class="docutils literal notranslate"><span class="pre">llvm.abs.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-abs-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id477">
<h5><a class="toc-backref" href="#id2179">Syntax:</a><a class="headerlink" href="#id477" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.abs</span></code> on any
integer bit width or any vector of integer elements.</p>
<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">abs</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">src</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">is_int_min_poison</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">abs</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">src</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">is_int_min_poison</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id478">
<h5><a class="toc-backref" href="#id2180">Overview:</a><a class="headerlink" href="#id478" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.abs</span></code>’ family of intrinsic functions returns the absolute value
of an argument.</p>
</div>
<div class="section" id="id479">
<h5><a class="toc-backref" href="#id2181">Arguments:</a><a class="headerlink" href="#id479" title="Permalink to this headline">¶</a></h5>
<p>The first argument is the value for which the absolute value is to be returned.
This argument may be of any integer type or a vector with integer element type.
The return type must match the first argument type.</p>
<p>The second argument must be a constant and is a flag to indicate whether the
result value of the ‘<code class="docutils literal notranslate"><span class="pre">llvm.abs</span></code>’ intrinsic is a
<a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a> if the argument is statically or dynamically
an <code class="docutils literal notranslate"><span class="pre">INT_MIN</span></code> value.</p>
</div>
<div class="section" id="id480">
<h5><a class="toc-backref" href="#id2182">Semantics:</a><a class="headerlink" href="#id480" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.abs</span></code>’ intrinsic returns the magnitude (always positive) of the
argument or each element of a vector argument.”. If the argument is <code class="docutils literal notranslate"><span class="pre">INT_MIN</span></code>,
then the result is also <code class="docutils literal notranslate"><span class="pre">INT_MIN</span></code> if <code class="docutils literal notranslate"><span class="pre">is_int_min_poison</span> <span class="pre">==</span> <span class="pre">0</span></code> and
<code class="docutils literal notranslate"><span class="pre">poison</span></code> otherwise.</p>
</div>
</div>
<div class="section" id="llvm-smax-intrinsic">
<h4><a class="toc-backref" href="#id2183">‘<code class="docutils literal notranslate"><span class="pre">llvm.smax.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-smax-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id481">
<h5><a class="toc-backref" href="#id2184">Syntax:</a><a class="headerlink" href="#id481" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">@llvm.smax</span></code> on any
integer bit width or any vector of integer elements.</p>
<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">smax</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">smax</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id482">
<h5><a class="toc-backref" href="#id2185">Overview:</a><a class="headerlink" href="#id482" title="Permalink to this headline">¶</a></h5>
<p>Return the larger of <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> comparing the values as signed integers.
Vector intrinsics operate on a per-element basis. The larger element of <code class="docutils literal notranslate"><span class="pre">%a</span></code>
and <code class="docutils literal notranslate"><span class="pre">%b</span></code> at a given index is returned for that index.</p>
</div>
<div class="section" id="id483">
<h5><a class="toc-backref" href="#id2186">Arguments:</a><a class="headerlink" href="#id483" title="Permalink to this headline">¶</a></h5>
<p>The arguments (<code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code>) may be of any integer type or a vector with
integer element type. The argument types must match each other, and the return
type must match the argument type.</p>
</div>
</div>
<div class="section" id="llvm-smin-intrinsic">
<h4><a class="toc-backref" href="#id2187">‘<code class="docutils literal notranslate"><span class="pre">llvm.smin.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-smin-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id484">
<h5><a class="toc-backref" href="#id2188">Syntax:</a><a class="headerlink" href="#id484" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">@llvm.smin</span></code> on any
integer bit width or any vector of integer elements.</p>
<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">smin</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">smin</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id485">
<h5><a class="toc-backref" href="#id2189">Overview:</a><a class="headerlink" href="#id485" title="Permalink to this headline">¶</a></h5>
<p>Return the smaller of <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> comparing the values as signed integers.
Vector intrinsics operate on a per-element basis. The smaller element of <code class="docutils literal notranslate"><span class="pre">%a</span></code>
and <code class="docutils literal notranslate"><span class="pre">%b</span></code> at a given index is returned for that index.</p>
</div>
<div class="section" id="id486">
<h5><a class="toc-backref" href="#id2190">Arguments:</a><a class="headerlink" href="#id486" title="Permalink to this headline">¶</a></h5>
<p>The arguments (<code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code>) may be of any integer type or a vector with
integer element type. The argument types must match each other, and the return
type must match the argument type.</p>
</div>
</div>
<div class="section" id="llvm-umax-intrinsic">
<h4><a class="toc-backref" href="#id2191">‘<code class="docutils literal notranslate"><span class="pre">llvm.umax.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-umax-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id487">
<h5><a class="toc-backref" href="#id2192">Syntax:</a><a class="headerlink" href="#id487" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">@llvm.umax</span></code> on any
integer bit width or any vector of integer elements.</p>
<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">umax</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">umax</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id488">
<h5><a class="toc-backref" href="#id2193">Overview:</a><a class="headerlink" href="#id488" title="Permalink to this headline">¶</a></h5>
<p>Return the larger of <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> comparing the values as unsigned
integers. Vector intrinsics operate on a per-element basis. The larger element
of <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> at a given index is returned for that index.</p>
</div>
<div class="section" id="id489">
<h5><a class="toc-backref" href="#id2194">Arguments:</a><a class="headerlink" href="#id489" title="Permalink to this headline">¶</a></h5>
<p>The arguments (<code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code>) may be of any integer type or a vector with
integer element type. The argument types must match each other, and the return
type must match the argument type.</p>
</div>
</div>
<div class="section" id="llvm-umin-intrinsic">
<h4><a class="toc-backref" href="#id2195">‘<code class="docutils literal notranslate"><span class="pre">llvm.umin.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-umin-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id490">
<h5><a class="toc-backref" href="#id2196">Syntax:</a><a class="headerlink" href="#id490" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">@llvm.umin</span></code> on any
integer bit width or any vector of integer elements.</p>
<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">umin</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">umin</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id491">
<h5><a class="toc-backref" href="#id2197">Overview:</a><a class="headerlink" href="#id491" title="Permalink to this headline">¶</a></h5>
<p>Return the smaller of <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> comparing the values as unsigned
integers. Vector intrinsics operate on a per-element basis. The smaller element
of <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> at a given index is returned for that index.</p>
</div>
<div class="section" id="id492">
<h5><a class="toc-backref" href="#id2198">Arguments:</a><a class="headerlink" href="#id492" title="Permalink to this headline">¶</a></h5>
<p>The arguments (<code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code>) may be of any integer type or a vector with
integer element type. The argument types must match each other, and the return
type must match the argument type.</p>
</div>
</div>
<div class="section" id="llvm-memcpy-intrinsic">
<span id="int-memcpy"></span><h4><a class="toc-backref" href="#id2199">‘<code class="docutils literal notranslate"><span class="pre">llvm.memcpy</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-memcpy-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id493">
<h5><a class="toc-backref" href="#id2200">Syntax:</a><a class="headerlink" href="#id493" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.memcpy</span></code> on any
integer bit width and for different address spaces. Not all targets
support all bit widths however.</p>
<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">memcpy</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">dest</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">src</span><span class="o">></span><span class="p">,</span>
<span class="n">i32</span> <span class="o"><</span><span class="nb">len</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">isvolatile</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">void</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">memcpy</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">dest</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">src</span><span class="o">></span><span class="p">,</span>
<span class="n">i64</span> <span class="o"><</span><span class="nb">len</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">isvolatile</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id494">
<h5><a class="toc-backref" href="#id2201">Overview:</a><a class="headerlink" href="#id494" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.memcpy.*</span></code>’ intrinsics copy a block of memory from the
source location to the destination location.</p>
<p>Note that, unlike the standard libc function, the <code class="docutils literal notranslate"><span class="pre">llvm.memcpy.*</span></code>
intrinsics do not return a value, takes extra isvolatile
arguments and the pointers can be in specified address spaces.</p>
</div>
<div class="section" id="id495">
<h5><a class="toc-backref" href="#id2202">Arguments:</a><a class="headerlink" href="#id495" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a pointer to the destination, the second is a
pointer to the source. The third argument is an integer argument
specifying the number of bytes to copy, and the fourth is a
boolean indicating a volatile access.</p>
<p>The <a class="reference internal" href="#attr-align"><span class="std std-ref">align</span></a> parameter attribute can be provided
for the first and second arguments.</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">isvolatile</span></code> parameter is <code class="docutils literal notranslate"><span class="pre">true</span></code>, the <code class="docutils literal notranslate"><span class="pre">llvm.memcpy</span></code> call is
a <a class="reference internal" href="#volatile"><span class="std std-ref">volatile operation</span></a>. The detailed access behavior is not
very cleanly specified and it is unwise to depend on it.</p>
</div>
<div class="section" id="id496">
<h5><a class="toc-backref" href="#id2203">Semantics:</a><a class="headerlink" href="#id496" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.memcpy.*</span></code>’ intrinsics copy a block of memory from the source
location to the destination location, which must either be equal or
non-overlapping. It copies “len” bytes of memory over. If the argument is known
to be aligned to some boundary, this can be specified as an attribute on the
argument.</p>
<p>If <code class="docutils literal notranslate"><span class="pre"><len></span></code> is 0, it is no-op modulo the behavior of attributes attached to
the arguments.
If <code class="docutils literal notranslate"><span class="pre"><len></span></code> is not a well-defined value, the behavior is undefined.
If <code class="docutils literal notranslate"><span class="pre"><len></span></code> is not zero, both <code class="docutils literal notranslate"><span class="pre"><dest></span></code> and <code class="docutils literal notranslate"><span class="pre"><src></span></code> should be well-defined,
otherwise the behavior is undefined.</p>
</div>
</div>
<div class="section" id="llvm-memcpy-inline-intrinsic">
<span id="int-memcpy-inline"></span><h4><a class="toc-backref" href="#id2204">‘<code class="docutils literal notranslate"><span class="pre">llvm.memcpy.inline</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-memcpy-inline-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id497">
<h5><a class="toc-backref" href="#id2205">Syntax:</a><a class="headerlink" href="#id497" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.memcpy.inline</span></code> on any
integer bit width and for different address spaces. Not all targets
support all bit widths however.</p>
<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">memcpy</span><span class="o">.</span><span class="n">inline</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">dest</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">src</span><span class="o">></span><span class="p">,</span>
<span class="n">i32</span> <span class="o"><</span><span class="nb">len</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">isvolatile</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">void</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">memcpy</span><span class="o">.</span><span class="n">inline</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">dest</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">src</span><span class="o">></span><span class="p">,</span>
<span class="n">i64</span> <span class="o"><</span><span class="nb">len</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">isvolatile</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id498">
<h5><a class="toc-backref" href="#id2206">Overview:</a><a class="headerlink" href="#id498" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.memcpy.inline.*</span></code>’ intrinsics copy a block of memory from the
source location to the destination location and guarantees that no external
functions are called.</p>
<p>Note that, unlike the standard libc function, the <code class="docutils literal notranslate"><span class="pre">llvm.memcpy.inline.*</span></code>
intrinsics do not return a value, takes extra isvolatile
arguments and the pointers can be in specified address spaces.</p>
</div>
<div class="section" id="id499">
<h5><a class="toc-backref" href="#id2207">Arguments:</a><a class="headerlink" href="#id499" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a pointer to the destination, the second is a
pointer to the source. The third argument is a constant integer argument
specifying the number of bytes to copy, and the fourth is a
boolean indicating a volatile access.</p>
<p>The <a class="reference internal" href="#attr-align"><span class="std std-ref">align</span></a> parameter attribute can be provided
for the first and second arguments.</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">isvolatile</span></code> parameter is <code class="docutils literal notranslate"><span class="pre">true</span></code>, the <code class="docutils literal notranslate"><span class="pre">llvm.memcpy.inline</span></code> call is
a <a class="reference internal" href="#volatile"><span class="std std-ref">volatile operation</span></a>. The detailed access behavior is not
very cleanly specified and it is unwise to depend on it.</p>
</div>
<div class="section" id="id500">
<h5><a class="toc-backref" href="#id2208">Semantics:</a><a class="headerlink" href="#id500" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.memcpy.inline.*</span></code>’ intrinsics copy a block of memory from the
source location to the destination location, which are not allowed to
overlap. It copies “len” bytes of memory over. If the argument is known
to be aligned to some boundary, this can be specified as an attribute on
the argument.
The behavior of ‘<code class="docutils literal notranslate"><span class="pre">llvm.memcpy.inline.*</span></code>’ is equivalent to the behavior of
‘<code class="docutils literal notranslate"><span class="pre">llvm.memcpy.*</span></code>’, but the generated code is guaranteed not to call any
external functions.</p>
</div>
</div>
<div class="section" id="llvm-memmove-intrinsic">
<span id="int-memmove"></span><h4><a class="toc-backref" href="#id2209">‘<code class="docutils literal notranslate"><span class="pre">llvm.memmove</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-memmove-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id501">
<h5><a class="toc-backref" href="#id2210">Syntax:</a><a class="headerlink" href="#id501" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use llvm.memmove on any integer
bit width and for different address space. Not all targets support all
bit widths however.</p>
<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">memmove</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">dest</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">src</span><span class="o">></span><span class="p">,</span>
<span class="n">i32</span> <span class="o"><</span><span class="nb">len</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">isvolatile</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">void</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">memmove</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">dest</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">src</span><span class="o">></span><span class="p">,</span>
<span class="n">i64</span> <span class="o"><</span><span class="nb">len</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">isvolatile</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id502">
<h5><a class="toc-backref" href="#id2211">Overview:</a><a class="headerlink" href="#id502" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.memmove.*</span></code>’ intrinsics move a block of memory from the
source location to the destination location. It is similar to the
‘<code class="docutils literal notranslate"><span class="pre">llvm.memcpy</span></code>’ intrinsic but allows the two memory locations to
overlap.</p>
<p>Note that, unlike the standard libc function, the <code class="docutils literal notranslate"><span class="pre">llvm.memmove.*</span></code>
intrinsics do not return a value, takes an extra isvolatile
argument and the pointers can be in specified address spaces.</p>
</div>
<div class="section" id="id503">
<h5><a class="toc-backref" href="#id2212">Arguments:</a><a class="headerlink" href="#id503" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a pointer to the destination, the second is a
pointer to the source. The third argument is an integer argument
specifying the number of bytes to copy, and the fourth is a
boolean indicating a volatile access.</p>
<p>The <a class="reference internal" href="#attr-align"><span class="std std-ref">align</span></a> parameter attribute can be provided
for the first and second arguments.</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">isvolatile</span></code> parameter is <code class="docutils literal notranslate"><span class="pre">true</span></code>, the <code class="docutils literal notranslate"><span class="pre">llvm.memmove</span></code> call
is a <a class="reference internal" href="#volatile"><span class="std std-ref">volatile operation</span></a>. The detailed access behavior is
not very cleanly specified and it is unwise to depend on it.</p>
</div>
<div class="section" id="id504">
<h5><a class="toc-backref" href="#id2213">Semantics:</a><a class="headerlink" href="#id504" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.memmove.*</span></code>’ intrinsics copy a block of memory from the
source location to the destination location, which may overlap. It
copies “len” bytes of memory over. If the argument is known to be
aligned to some boundary, this can be specified as an attribute on
the argument.</p>
<p>If <code class="docutils literal notranslate"><span class="pre"><len></span></code> is 0, it is no-op modulo the behavior of attributes attached to
the arguments.
If <code class="docutils literal notranslate"><span class="pre"><len></span></code> is not a well-defined value, the behavior is undefined.
If <code class="docutils literal notranslate"><span class="pre"><len></span></code> is not zero, both <code class="docutils literal notranslate"><span class="pre"><dest></span></code> and <code class="docutils literal notranslate"><span class="pre"><src></span></code> should be well-defined,
otherwise the behavior is undefined.</p>
</div>
</div>
<div class="section" id="llvm-memset-intrinsics">
<span id="int-memset"></span><h4><a class="toc-backref" href="#id2214">‘<code class="docutils literal notranslate"><span class="pre">llvm.memset.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-memset-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id505">
<h5><a class="toc-backref" href="#id2215">Syntax:</a><a class="headerlink" href="#id505" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use llvm.memset on any integer
bit width and for different address spaces. However, not all targets
support all bit widths.</p>
<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">memset</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">dest</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span>
<span class="n">i32</span> <span class="o"><</span><span class="nb">len</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">isvolatile</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">void</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">memset</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">dest</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span>
<span class="n">i64</span> <span class="o"><</span><span class="nb">len</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">isvolatile</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id506">
<h5><a class="toc-backref" href="#id2216">Overview:</a><a class="headerlink" href="#id506" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.memset.*</span></code>’ intrinsics fill a block of memory with a
particular byte value.</p>
<p>Note that, unlike the standard libc function, the <code class="docutils literal notranslate"><span class="pre">llvm.memset</span></code>
intrinsic does not return a value and takes an extra volatile
argument. Also, the destination can be in an arbitrary address space.</p>
</div>
<div class="section" id="id507">
<h5><a class="toc-backref" href="#id2217">Arguments:</a><a class="headerlink" href="#id507" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a pointer to the destination to fill, the second
is the byte value with which to fill it, the third argument is an
integer argument specifying the number of bytes to fill, and the fourth
is a boolean indicating a volatile access.</p>
<p>The <a class="reference internal" href="#attr-align"><span class="std std-ref">align</span></a> parameter attribute can be provided
for the first arguments.</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">isvolatile</span></code> parameter is <code class="docutils literal notranslate"><span class="pre">true</span></code>, the <code class="docutils literal notranslate"><span class="pre">llvm.memset</span></code> call is
a <a class="reference internal" href="#volatile"><span class="std std-ref">volatile operation</span></a>. The detailed access behavior is not
very cleanly specified and it is unwise to depend on it.</p>
</div>
<div class="section" id="id508">
<h5><a class="toc-backref" href="#id2218">Semantics:</a><a class="headerlink" href="#id508" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.memset.*</span></code>’ intrinsics fill “len” bytes of memory starting
at the destination location. If the argument is known to be
aligned to some boundary, this can be specified as an attribute on
the argument.</p>
<p>If <code class="docutils literal notranslate"><span class="pre"><len></span></code> is 0, it is no-op modulo the behavior of attributes attached to
the arguments.
If <code class="docutils literal notranslate"><span class="pre"><len></span></code> is not a well-defined value, the behavior is undefined.
If <code class="docutils literal notranslate"><span class="pre"><len></span></code> is not zero, both <code class="docutils literal notranslate"><span class="pre"><dest></span></code> and <code class="docutils literal notranslate"><span class="pre"><src></span></code> should be well-defined,
otherwise the behavior is undefined.</p>
</div>
</div>
<div class="section" id="llvm-sqrt-intrinsic">
<h4><a class="toc-backref" href="#id2219">‘<code class="docutils literal notranslate"><span class="pre">llvm.sqrt.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-sqrt-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id509">
<h5><a class="toc-backref" href="#id2220">Syntax:</a><a class="headerlink" href="#id509" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.sqrt</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sqrt</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sqrt</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sqrt</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sqrt</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sqrt</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id510">
<h5><a class="toc-backref" href="#id2221">Overview:</a><a class="headerlink" href="#id510" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.sqrt</span></code>’ intrinsics return the square root of the specified value.</p>
</div>
<div class="section" id="id511">
<h5><a class="toc-backref" href="#id2222">Arguments:</a><a class="headerlink" href="#id511" title="Permalink to this headline">¶</a></h5>
<p>The argument and return value are floating-point numbers of the same type.</p>
</div>
<div class="section" id="id512">
<h5><a class="toc-backref" href="#id2223">Semantics:</a><a class="headerlink" href="#id512" title="Permalink to this headline">¶</a></h5>
<p>Return the same value as a corresponding libm ‘<code class="docutils literal notranslate"><span class="pre">sqrt</span></code>’ function but without
trapping or setting <code class="docutils literal notranslate"><span class="pre">errno</span></code>. For types specified by IEEE-754, the result
matches a conforming libm implementation.</p>
<p>When specified with the fast-math-flag ‘afn’, the result may be approximated
using a less accurate calculation.</p>
</div>
</div>
<div class="section" id="llvm-powi-intrinsic">
<h4><a class="toc-backref" href="#id2224">‘<code class="docutils literal notranslate"><span class="pre">llvm.powi.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-powi-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id513">
<h5><a class="toc-backref" href="#id2225">Syntax:</a><a class="headerlink" href="#id513" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.powi</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<p>Generally, the only supported type for the exponent is the one matching
with the C type <code class="docutils literal notranslate"><span class="pre">int</span></code>.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">powi</span><span class="o">.</span><span class="n">f32</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">power</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">powi</span><span class="o">.</span><span class="n">f64</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">,</span> <span class="n">i16</span> <span class="o">%</span><span class="n">power</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">powi</span><span class="o">.</span><span class="n">f80</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">power</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">powi</span><span class="o">.</span><span class="n">f128</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">power</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">powi</span><span class="o">.</span><span class="n">ppcf128</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">power</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id514">
<h5><a class="toc-backref" href="#id2226">Overview:</a><a class="headerlink" href="#id514" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.powi.*</span></code>’ intrinsics return the first operand raised to the
specified (positive or negative) power. The order of evaluation of
multiplications is not defined. When a vector of floating-point type is
used, the second argument remains a scalar integer value.</p>
</div>
<div class="section" id="id515">
<h5><a class="toc-backref" href="#id2227">Arguments:</a><a class="headerlink" href="#id515" title="Permalink to this headline">¶</a></h5>
<p>The second argument is an integer power, and the first is a value to
raise to that power.</p>
</div>
<div class="section" id="id516">
<h5><a class="toc-backref" href="#id2228">Semantics:</a><a class="headerlink" href="#id516" title="Permalink to this headline">¶</a></h5>
<p>This function returns the first value raised to the second power with an
unspecified sequence of rounding operations.</p>
</div>
</div>
<div class="section" id="llvm-sin-intrinsic">
<h4><a class="toc-backref" href="#id2229">‘<code class="docutils literal notranslate"><span class="pre">llvm.sin.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-sin-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id517">
<h5><a class="toc-backref" href="#id2230">Syntax:</a><a class="headerlink" href="#id517" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.sin</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sin</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sin</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sin</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sin</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sin</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id518">
<h5><a class="toc-backref" href="#id2231">Overview:</a><a class="headerlink" href="#id518" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.sin.*</span></code>’ intrinsics return the sine of the operand.</p>
</div>
<div class="section" id="id519">
<h5><a class="toc-backref" href="#id2232">Arguments:</a><a class="headerlink" href="#id519" title="Permalink to this headline">¶</a></h5>
<p>The argument and return value are floating-point numbers of the same type.</p>
</div>
<div class="section" id="id520">
<h5><a class="toc-backref" href="#id2233">Semantics:</a><a class="headerlink" href="#id520" title="Permalink to this headline">¶</a></h5>
<p>Return the same value as a corresponding libm ‘<code class="docutils literal notranslate"><span class="pre">sin</span></code>’ function but without
trapping or setting <code class="docutils literal notranslate"><span class="pre">errno</span></code>.</p>
<p>When specified with the fast-math-flag ‘afn’, the result may be approximated
using a less accurate calculation.</p>
</div>
</div>
<div class="section" id="llvm-cos-intrinsic">
<h4><a class="toc-backref" href="#id2234">‘<code class="docutils literal notranslate"><span class="pre">llvm.cos.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-cos-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id521">
<h5><a class="toc-backref" href="#id2235">Syntax:</a><a class="headerlink" href="#id521" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.cos</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">cos</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">cos</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">cos</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">cos</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">cos</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id522">
<h5><a class="toc-backref" href="#id2236">Overview:</a><a class="headerlink" href="#id522" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.cos.*</span></code>’ intrinsics return the cosine of the operand.</p>
</div>
<div class="section" id="id523">
<h5><a class="toc-backref" href="#id2237">Arguments:</a><a class="headerlink" href="#id523" title="Permalink to this headline">¶</a></h5>
<p>The argument and return value are floating-point numbers of the same type.</p>
</div>
<div class="section" id="id524">
<h5><a class="toc-backref" href="#id2238">Semantics:</a><a class="headerlink" href="#id524" title="Permalink to this headline">¶</a></h5>
<p>Return the same value as a corresponding libm ‘<code class="docutils literal notranslate"><span class="pre">cos</span></code>’ function but without
trapping or setting <code class="docutils literal notranslate"><span class="pre">errno</span></code>.</p>
<p>When specified with the fast-math-flag ‘afn’, the result may be approximated
using a less accurate calculation.</p>
</div>
</div>
<div class="section" id="llvm-pow-intrinsic">
<h4><a class="toc-backref" href="#id2239">‘<code class="docutils literal notranslate"><span class="pre">llvm.pow.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-pow-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id525">
<h5><a class="toc-backref" href="#id2240">Syntax:</a><a class="headerlink" href="#id525" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.pow</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">pow</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">,</span> <span class="nb">float</span> <span class="o">%</span><span class="n">Power</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">pow</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">,</span> <span class="n">double</span> <span class="o">%</span><span class="n">Power</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">pow</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val</span><span class="p">,</span> <span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Power</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">pow</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">,</span> <span class="n">fp128</span> <span class="o">%</span><span class="n">Power</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">pow</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">,</span> <span class="n">ppc_fp128</span> <span class="n">Power</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id526">
<h5><a class="toc-backref" href="#id2241">Overview:</a><a class="headerlink" href="#id526" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.pow.*</span></code>’ intrinsics return the first operand raised to the
specified (positive or negative) power.</p>
</div>
<div class="section" id="id527">
<h5><a class="toc-backref" href="#id2242">Arguments:</a><a class="headerlink" href="#id527" title="Permalink to this headline">¶</a></h5>
<p>The arguments and return value are floating-point numbers of the same type.</p>
</div>
<div class="section" id="id528">
<h5><a class="toc-backref" href="#id2243">Semantics:</a><a class="headerlink" href="#id528" title="Permalink to this headline">¶</a></h5>
<p>Return the same value as a corresponding libm ‘<code class="docutils literal notranslate"><span class="pre">pow</span></code>’ function but without
trapping or setting <code class="docutils literal notranslate"><span class="pre">errno</span></code>.</p>
<p>When specified with the fast-math-flag ‘afn’, the result may be approximated
using a less accurate calculation.</p>
</div>
</div>
<div class="section" id="llvm-exp-intrinsic">
<h4><a class="toc-backref" href="#id2244">‘<code class="docutils literal notranslate"><span class="pre">llvm.exp.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-exp-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id529">
<h5><a class="toc-backref" href="#id2245">Syntax:</a><a class="headerlink" href="#id529" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.exp</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">exp</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">exp</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">exp</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">exp</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">exp</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id530">
<h5><a class="toc-backref" href="#id2246">Overview:</a><a class="headerlink" href="#id530" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.exp.*</span></code>’ intrinsics compute the base-e exponential of the specified
value.</p>
</div>
<div class="section" id="id531">
<h5><a class="toc-backref" href="#id2247">Arguments:</a><a class="headerlink" href="#id531" title="Permalink to this headline">¶</a></h5>
<p>The argument and return value are floating-point numbers of the same type.</p>
</div>
<div class="section" id="id532">
<h5><a class="toc-backref" href="#id2248">Semantics:</a><a class="headerlink" href="#id532" title="Permalink to this headline">¶</a></h5>
<p>Return the same value as a corresponding libm ‘<code class="docutils literal notranslate"><span class="pre">exp</span></code>’ function but without
trapping or setting <code class="docutils literal notranslate"><span class="pre">errno</span></code>.</p>
<p>When specified with the fast-math-flag ‘afn’, the result may be approximated
using a less accurate calculation.</p>
</div>
</div>
<div class="section" id="llvm-exp2-intrinsic">
<h4><a class="toc-backref" href="#id2249">‘<code class="docutils literal notranslate"><span class="pre">llvm.exp2.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-exp2-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id533">
<h5><a class="toc-backref" href="#id2250">Syntax:</a><a class="headerlink" href="#id533" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.exp2</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">exp2</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">exp2</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">exp2</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">exp2</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">exp2</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id534">
<h5><a class="toc-backref" href="#id2251">Overview:</a><a class="headerlink" href="#id534" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.exp2.*</span></code>’ intrinsics compute the base-2 exponential of the
specified value.</p>
</div>
<div class="section" id="id535">
<h5><a class="toc-backref" href="#id2252">Arguments:</a><a class="headerlink" href="#id535" title="Permalink to this headline">¶</a></h5>
<p>The argument and return value are floating-point numbers of the same type.</p>
</div>
<div class="section" id="id536">
<h5><a class="toc-backref" href="#id2253">Semantics:</a><a class="headerlink" href="#id536" title="Permalink to this headline">¶</a></h5>
<p>Return the same value as a corresponding libm ‘<code class="docutils literal notranslate"><span class="pre">exp2</span></code>’ function but without
trapping or setting <code class="docutils literal notranslate"><span class="pre">errno</span></code>.</p>
<p>When specified with the fast-math-flag ‘afn’, the result may be approximated
using a less accurate calculation.</p>
</div>
</div>
<div class="section" id="llvm-log-intrinsic">
<h4><a class="toc-backref" href="#id2254">‘<code class="docutils literal notranslate"><span class="pre">llvm.log.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-log-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id537">
<h5><a class="toc-backref" href="#id2255">Syntax:</a><a class="headerlink" href="#id537" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.log</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">log</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id538">
<h5><a class="toc-backref" href="#id2256">Overview:</a><a class="headerlink" href="#id538" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.log.*</span></code>’ intrinsics compute the base-e logarithm of the specified
value.</p>
</div>
<div class="section" id="id539">
<h5><a class="toc-backref" href="#id2257">Arguments:</a><a class="headerlink" href="#id539" title="Permalink to this headline">¶</a></h5>
<p>The argument and return value are floating-point numbers of the same type.</p>
</div>
<div class="section" id="id540">
<h5><a class="toc-backref" href="#id2258">Semantics:</a><a class="headerlink" href="#id540" title="Permalink to this headline">¶</a></h5>
<p>Return the same value as a corresponding libm ‘<code class="docutils literal notranslate"><span class="pre">log</span></code>’ function but without
trapping or setting <code class="docutils literal notranslate"><span class="pre">errno</span></code>.</p>
<p>When specified with the fast-math-flag ‘afn’, the result may be approximated
using a less accurate calculation.</p>
</div>
</div>
<div class="section" id="llvm-log10-intrinsic">
<h4><a class="toc-backref" href="#id2259">‘<code class="docutils literal notranslate"><span class="pre">llvm.log10.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-log10-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id541">
<h5><a class="toc-backref" href="#id2260">Syntax:</a><a class="headerlink" href="#id541" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.log10</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">log10</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">log10</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">log10</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">log10</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">log10</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id542">
<h5><a class="toc-backref" href="#id2261">Overview:</a><a class="headerlink" href="#id542" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.log10.*</span></code>’ intrinsics compute the base-10 logarithm of the
specified value.</p>
</div>
<div class="section" id="id543">
<h5><a class="toc-backref" href="#id2262">Arguments:</a><a class="headerlink" href="#id543" title="Permalink to this headline">¶</a></h5>
<p>The argument and return value are floating-point numbers of the same type.</p>
</div>
<div class="section" id="id544">
<h5><a class="toc-backref" href="#id2263">Semantics:</a><a class="headerlink" href="#id544" title="Permalink to this headline">¶</a></h5>
<p>Return the same value as a corresponding libm ‘<code class="docutils literal notranslate"><span class="pre">log10</span></code>’ function but without
trapping or setting <code class="docutils literal notranslate"><span class="pre">errno</span></code>.</p>
<p>When specified with the fast-math-flag ‘afn’, the result may be approximated
using a less accurate calculation.</p>
</div>
</div>
<div class="section" id="llvm-log2-intrinsic">
<h4><a class="toc-backref" href="#id2264">‘<code class="docutils literal notranslate"><span class="pre">llvm.log2.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-log2-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id545">
<h5><a class="toc-backref" href="#id2265">Syntax:</a><a class="headerlink" href="#id545" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.log2</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">log2</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">log2</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">log2</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">log2</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">log2</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id546">
<h5><a class="toc-backref" href="#id2266">Overview:</a><a class="headerlink" href="#id546" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.log2.*</span></code>’ intrinsics compute the base-2 logarithm of the specified
value.</p>
</div>
<div class="section" id="id547">
<h5><a class="toc-backref" href="#id2267">Arguments:</a><a class="headerlink" href="#id547" title="Permalink to this headline">¶</a></h5>
<p>The argument and return value are floating-point numbers of the same type.</p>
</div>
<div class="section" id="id548">
<h5><a class="toc-backref" href="#id2268">Semantics:</a><a class="headerlink" href="#id548" title="Permalink to this headline">¶</a></h5>
<p>Return the same value as a corresponding libm ‘<code class="docutils literal notranslate"><span class="pre">log2</span></code>’ function but without
trapping or setting <code class="docutils literal notranslate"><span class="pre">errno</span></code>.</p>
<p>When specified with the fast-math-flag ‘afn’, the result may be approximated
using a less accurate calculation.</p>
</div>
</div>
<div class="section" id="llvm-fma-intrinsic">
<span id="int-fma"></span><h4><a class="toc-backref" href="#id2269">‘<code class="docutils literal notranslate"><span class="pre">llvm.fma.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-fma-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id549">
<h5><a class="toc-backref" href="#id2270">Syntax:</a><a class="headerlink" href="#id549" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.fma</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">fma</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="nb">float</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="nb">float</span> <span class="o">%</span><span class="n">c</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">fma</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">double</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">double</span> <span class="o">%</span><span class="n">c</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">fma</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">x86_fp80</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">x86_fp80</span> <span class="o">%</span><span class="n">c</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">fma</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">fp128</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">fp128</span> <span class="o">%</span><span class="n">c</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">fma</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">c</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id550">
<h5><a class="toc-backref" href="#id2271">Overview:</a><a class="headerlink" href="#id550" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.fma.*</span></code>’ intrinsics perform the fused multiply-add operation.</p>
</div>
<div class="section" id="id551">
<h5><a class="toc-backref" href="#id2272">Arguments:</a><a class="headerlink" href="#id551" title="Permalink to this headline">¶</a></h5>
<p>The arguments and return value are floating-point numbers of the same type.</p>
</div>
<div class="section" id="id552">
<h5><a class="toc-backref" href="#id2273">Semantics:</a><a class="headerlink" href="#id552" title="Permalink to this headline">¶</a></h5>
<p>Return the same value as a corresponding libm ‘<code class="docutils literal notranslate"><span class="pre">fma</span></code>’ function but without
trapping or setting <code class="docutils literal notranslate"><span class="pre">errno</span></code>.</p>
<p>When specified with the fast-math-flag ‘afn’, the result may be approximated
using a less accurate calculation.</p>
</div>
</div>
<div class="section" id="llvm-fabs-intrinsic">
<h4><a class="toc-backref" href="#id2274">‘<code class="docutils literal notranslate"><span class="pre">llvm.fabs.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-fabs-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id553">
<h5><a class="toc-backref" href="#id2275">Syntax:</a><a class="headerlink" href="#id553" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.fabs</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">fabs</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">fabs</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">fabs</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">fabs</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">fabs</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id554">
<h5><a class="toc-backref" href="#id2276">Overview:</a><a class="headerlink" href="#id554" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.fabs.*</span></code>’ intrinsics return the absolute value of the
operand.</p>
</div>
<div class="section" id="id555">
<h5><a class="toc-backref" href="#id2277">Arguments:</a><a class="headerlink" href="#id555" title="Permalink to this headline">¶</a></h5>
<p>The argument and return value are floating-point numbers of the same
type.</p>
</div>
<div class="section" id="id556">
<h5><a class="toc-backref" href="#id2278">Semantics:</a><a class="headerlink" href="#id556" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">fabs</span></code> functions
would, and handles error conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-minnum-intrinsic">
<h4><a class="toc-backref" href="#id2279">‘<code class="docutils literal notranslate"><span class="pre">llvm.minnum.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-minnum-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id557">
<h5><a class="toc-backref" href="#id2280">Syntax:</a><a class="headerlink" href="#id557" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.minnum</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">minnum</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val0</span><span class="p">,</span> <span class="nb">float</span> <span class="o">%</span><span class="n">Val1</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">minnum</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val0</span><span class="p">,</span> <span class="n">double</span> <span class="o">%</span><span class="n">Val1</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">minnum</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val0</span><span class="p">,</span> <span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val1</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">minnum</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val0</span><span class="p">,</span> <span class="n">fp128</span> <span class="o">%</span><span class="n">Val1</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">minnum</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val0</span><span class="p">,</span> <span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val1</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id558">
<h5><a class="toc-backref" href="#id2281">Overview:</a><a class="headerlink" href="#id558" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.minnum.*</span></code>’ intrinsics return the minimum of the two
arguments.</p>
</div>
<div class="section" id="id559">
<h5><a class="toc-backref" href="#id2282">Arguments:</a><a class="headerlink" href="#id559" title="Permalink to this headline">¶</a></h5>
<p>The arguments and return value are floating-point numbers of the same
type.</p>
</div>
<div class="section" id="id560">
<h5><a class="toc-backref" href="#id2283">Semantics:</a><a class="headerlink" href="#id560" title="Permalink to this headline">¶</a></h5>
<p>Follows the IEEE-754 semantics for minNum, except for handling of
signaling NaNs. This match’s the behavior of libm’s fmin.</p>
<p>If either operand is a NaN, returns the other non-NaN operand. Returns
NaN only if both operands are NaN. The returned NaN is always
quiet. If the operands compare equal, returns a value that compares
equal to both operands. This means that fmin(+/-0.0, +/-0.0) could
return either -0.0 or 0.0.</p>
<p>Unlike the IEEE-754 2008 behavior, this does not distinguish between
signaling and quiet NaN inputs. If a target’s implementation follows
the standard and returns a quiet NaN if either input is a signaling
NaN, the intrinsic lowering is responsible for quieting the inputs to
correctly return the non-NaN input (e.g. by using the equivalent of
<code class="docutils literal notranslate"><span class="pre">llvm.canonicalize</span></code>).</p>
</div>
</div>
<div class="section" id="llvm-maxnum-intrinsic">
<h4><a class="toc-backref" href="#id2284">‘<code class="docutils literal notranslate"><span class="pre">llvm.maxnum.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-maxnum-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id561">
<h5><a class="toc-backref" href="#id2285">Syntax:</a><a class="headerlink" href="#id561" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.maxnum</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">maxnum</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val0</span><span class="p">,</span> <span class="nb">float</span> <span class="o">%</span><span class="n">Val1</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">maxnum</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val0</span><span class="p">,</span> <span class="n">double</span> <span class="o">%</span><span class="n">Val1</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">maxnum</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val0</span><span class="p">,</span> <span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val1</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">maxnum</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val0</span><span class="p">,</span> <span class="n">fp128</span> <span class="o">%</span><span class="n">Val1</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">maxnum</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val0</span><span class="p">,</span> <span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val1</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id562">
<h5><a class="toc-backref" href="#id2286">Overview:</a><a class="headerlink" href="#id562" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.maxnum.*</span></code>’ intrinsics return the maximum of the two
arguments.</p>
</div>
<div class="section" id="id563">
<h5><a class="toc-backref" href="#id2287">Arguments:</a><a class="headerlink" href="#id563" title="Permalink to this headline">¶</a></h5>
<p>The arguments and return value are floating-point numbers of the same
type.</p>
</div>
<div class="section" id="id564">
<h5><a class="toc-backref" href="#id2288">Semantics:</a><a class="headerlink" href="#id564" title="Permalink to this headline">¶</a></h5>
<p>Follows the IEEE-754 semantics for maxNum except for the handling of
signaling NaNs. This matches the behavior of libm’s fmax.</p>
<p>If either operand is a NaN, returns the other non-NaN operand. Returns
NaN only if both operands are NaN. The returned NaN is always
quiet. If the operands compare equal, returns a value that compares
equal to both operands. This means that fmax(+/-0.0, +/-0.0) could
return either -0.0 or 0.0.</p>
<p>Unlike the IEEE-754 2008 behavior, this does not distinguish between
signaling and quiet NaN inputs. If a target’s implementation follows
the standard and returns a quiet NaN if either input is a signaling
NaN, the intrinsic lowering is responsible for quieting the inputs to
correctly return the non-NaN input (e.g. by using the equivalent of
<code class="docutils literal notranslate"><span class="pre">llvm.canonicalize</span></code>).</p>
</div>
</div>
<div class="section" id="llvm-minimum-intrinsic">
<h4><a class="toc-backref" href="#id2289">‘<code class="docutils literal notranslate"><span class="pre">llvm.minimum.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-minimum-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id565">
<h5><a class="toc-backref" href="#id2290">Syntax:</a><a class="headerlink" href="#id565" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.minimum</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">minimum</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val0</span><span class="p">,</span> <span class="nb">float</span> <span class="o">%</span><span class="n">Val1</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">minimum</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val0</span><span class="p">,</span> <span class="n">double</span> <span class="o">%</span><span class="n">Val1</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">minimum</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val0</span><span class="p">,</span> <span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val1</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">minimum</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val0</span><span class="p">,</span> <span class="n">fp128</span> <span class="o">%</span><span class="n">Val1</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">minimum</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val0</span><span class="p">,</span> <span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val1</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id566">
<h5><a class="toc-backref" href="#id2291">Overview:</a><a class="headerlink" href="#id566" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.minimum.*</span></code>’ intrinsics return the minimum of the two
arguments, propagating NaNs and treating -0.0 as less than +0.0.</p>
</div>
<div class="section" id="id567">
<h5><a class="toc-backref" href="#id2292">Arguments:</a><a class="headerlink" href="#id567" title="Permalink to this headline">¶</a></h5>
<p>The arguments and return value are floating-point numbers of the same
type.</p>
</div>
<div class="section" id="id568">
<h5><a class="toc-backref" href="#id2293">Semantics:</a><a class="headerlink" href="#id568" title="Permalink to this headline">¶</a></h5>
<p>If either operand is a NaN, returns NaN. Otherwise returns the lesser
of the two arguments. -0.0 is considered to be less than +0.0 for this
intrinsic. Note that these are the semantics specified in the draft of
IEEE 754-2018.</p>
</div>
</div>
<div class="section" id="llvm-maximum-intrinsic">
<h4><a class="toc-backref" href="#id2294">‘<code class="docutils literal notranslate"><span class="pre">llvm.maximum.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-maximum-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id569">
<h5><a class="toc-backref" href="#id2295">Syntax:</a><a class="headerlink" href="#id569" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.maximum</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">maximum</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val0</span><span class="p">,</span> <span class="nb">float</span> <span class="o">%</span><span class="n">Val1</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">maximum</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val0</span><span class="p">,</span> <span class="n">double</span> <span class="o">%</span><span class="n">Val1</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">maximum</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val0</span><span class="p">,</span> <span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val1</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">maximum</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val0</span><span class="p">,</span> <span class="n">fp128</span> <span class="o">%</span><span class="n">Val1</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">maximum</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val0</span><span class="p">,</span> <span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val1</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id570">
<h5><a class="toc-backref" href="#id2296">Overview:</a><a class="headerlink" href="#id570" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.maximum.*</span></code>’ intrinsics return the maximum of the two
arguments, propagating NaNs and treating -0.0 as less than +0.0.</p>
</div>
<div class="section" id="id571">
<h5><a class="toc-backref" href="#id2297">Arguments:</a><a class="headerlink" href="#id571" title="Permalink to this headline">¶</a></h5>
<p>The arguments and return value are floating-point numbers of the same
type.</p>
</div>
<div class="section" id="id572">
<h5><a class="toc-backref" href="#id2298">Semantics:</a><a class="headerlink" href="#id572" title="Permalink to this headline">¶</a></h5>
<p>If either operand is a NaN, returns NaN. Otherwise returns the greater
of the two arguments. -0.0 is considered to be less than +0.0 for this
intrinsic. Note that these are the semantics specified in the draft of
IEEE 754-2018.</p>
</div>
</div>
<div class="section" id="llvm-copysign-intrinsic">
<h4><a class="toc-backref" href="#id2299">‘<code class="docutils literal notranslate"><span class="pre">llvm.copysign.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-copysign-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id573">
<h5><a class="toc-backref" href="#id2300">Syntax:</a><a class="headerlink" href="#id573" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.copysign</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">copysign</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Mag</span><span class="p">,</span> <span class="nb">float</span> <span class="o">%</span><span class="n">Sgn</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">copysign</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Mag</span><span class="p">,</span> <span class="n">double</span> <span class="o">%</span><span class="n">Sgn</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">copysign</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Mag</span><span class="p">,</span> <span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Sgn</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">copysign</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Mag</span><span class="p">,</span> <span class="n">fp128</span> <span class="o">%</span><span class="n">Sgn</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">copysign</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Mag</span><span class="p">,</span> <span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Sgn</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id574">
<h5><a class="toc-backref" href="#id2301">Overview:</a><a class="headerlink" href="#id574" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.copysign.*</span></code>’ intrinsics return a value with the magnitude of the
first operand and the sign of the second operand.</p>
</div>
<div class="section" id="id575">
<h5><a class="toc-backref" href="#id2302">Arguments:</a><a class="headerlink" href="#id575" title="Permalink to this headline">¶</a></h5>
<p>The arguments and return value are floating-point numbers of the same
type.</p>
</div>
<div class="section" id="id576">
<h5><a class="toc-backref" href="#id2303">Semantics:</a><a class="headerlink" href="#id576" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">copysign</span></code>
functions would, and handles error conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-floor-intrinsic">
<h4><a class="toc-backref" href="#id2304">‘<code class="docutils literal notranslate"><span class="pre">llvm.floor.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-floor-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id577">
<h5><a class="toc-backref" href="#id2305">Syntax:</a><a class="headerlink" href="#id577" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.floor</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">floor</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">floor</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">floor</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">floor</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">floor</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id578">
<h5><a class="toc-backref" href="#id2306">Overview:</a><a class="headerlink" href="#id578" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.floor.*</span></code>’ intrinsics return the floor of the operand.</p>
</div>
<div class="section" id="id579">
<h5><a class="toc-backref" href="#id2307">Arguments:</a><a class="headerlink" href="#id579" title="Permalink to this headline">¶</a></h5>
<p>The argument and return value are floating-point numbers of the same
type.</p>
</div>
<div class="section" id="id580">
<h5><a class="toc-backref" href="#id2308">Semantics:</a><a class="headerlink" href="#id580" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">floor</span></code> functions
would, and handles error conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-ceil-intrinsic">
<h4><a class="toc-backref" href="#id2309">‘<code class="docutils literal notranslate"><span class="pre">llvm.ceil.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-ceil-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id581">
<h5><a class="toc-backref" href="#id2310">Syntax:</a><a class="headerlink" href="#id581" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.ceil</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ceil</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ceil</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ceil</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ceil</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ceil</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id582">
<h5><a class="toc-backref" href="#id2311">Overview:</a><a class="headerlink" href="#id582" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.ceil.*</span></code>’ intrinsics return the ceiling of the operand.</p>
</div>
<div class="section" id="id583">
<h5><a class="toc-backref" href="#id2312">Arguments:</a><a class="headerlink" href="#id583" title="Permalink to this headline">¶</a></h5>
<p>The argument and return value are floating-point numbers of the same
type.</p>
</div>
<div class="section" id="id584">
<h5><a class="toc-backref" href="#id2313">Semantics:</a><a class="headerlink" href="#id584" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">ceil</span></code> functions
would, and handles error conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-trunc-intrinsic">
<h4><a class="toc-backref" href="#id2314">‘<code class="docutils literal notranslate"><span class="pre">llvm.trunc.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-trunc-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id585">
<h5><a class="toc-backref" href="#id2315">Syntax:</a><a class="headerlink" href="#id585" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.trunc</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">trunc</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">trunc</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">trunc</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">trunc</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">trunc</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id586">
<h5><a class="toc-backref" href="#id2316">Overview:</a><a class="headerlink" href="#id586" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.trunc.*</span></code>’ intrinsics returns the operand rounded to the
nearest integer not larger in magnitude than the operand.</p>
</div>
<div class="section" id="id587">
<h5><a class="toc-backref" href="#id2317">Arguments:</a><a class="headerlink" href="#id587" title="Permalink to this headline">¶</a></h5>
<p>The argument and return value are floating-point numbers of the same
type.</p>
</div>
<div class="section" id="id588">
<h5><a class="toc-backref" href="#id2318">Semantics:</a><a class="headerlink" href="#id588" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">trunc</span></code> functions
would, and handles error conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-rint-intrinsic">
<h4><a class="toc-backref" href="#id2319">‘<code class="docutils literal notranslate"><span class="pre">llvm.rint.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-rint-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id589">
<h5><a class="toc-backref" href="#id2320">Syntax:</a><a class="headerlink" href="#id589" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.rint</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">rint</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">rint</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">rint</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">rint</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">rint</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id590">
<h5><a class="toc-backref" href="#id2321">Overview:</a><a class="headerlink" href="#id590" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.rint.*</span></code>’ intrinsics returns the operand rounded to the
nearest integer. It may raise an inexact floating-point exception if the
operand isn’t an integer.</p>
</div>
<div class="section" id="id591">
<h5><a class="toc-backref" href="#id2322">Arguments:</a><a class="headerlink" href="#id591" title="Permalink to this headline">¶</a></h5>
<p>The argument and return value are floating-point numbers of the same
type.</p>
</div>
<div class="section" id="id592">
<h5><a class="toc-backref" href="#id2323">Semantics:</a><a class="headerlink" href="#id592" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">rint</span></code> functions
would, and handles error conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-nearbyint-intrinsic">
<h4><a class="toc-backref" href="#id2324">‘<code class="docutils literal notranslate"><span class="pre">llvm.nearbyint.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-nearbyint-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id593">
<h5><a class="toc-backref" href="#id2325">Syntax:</a><a class="headerlink" href="#id593" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.nearbyint</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">nearbyint</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">nearbyint</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">nearbyint</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">nearbyint</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">nearbyint</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id594">
<h5><a class="toc-backref" href="#id2326">Overview:</a><a class="headerlink" href="#id594" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.nearbyint.*</span></code>’ intrinsics returns the operand rounded to the
nearest integer.</p>
</div>
<div class="section" id="id595">
<h5><a class="toc-backref" href="#id2327">Arguments:</a><a class="headerlink" href="#id595" title="Permalink to this headline">¶</a></h5>
<p>The argument and return value are floating-point numbers of the same
type.</p>
</div>
<div class="section" id="id596">
<h5><a class="toc-backref" href="#id2328">Semantics:</a><a class="headerlink" href="#id596" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">nearbyint</span></code>
functions would, and handles error conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-round-intrinsic">
<h4><a class="toc-backref" href="#id2329">‘<code class="docutils literal notranslate"><span class="pre">llvm.round.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-round-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id597">
<h5><a class="toc-backref" href="#id2330">Syntax:</a><a class="headerlink" href="#id597" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.round</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">round</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">round</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">round</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">round</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">round</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id598">
<h5><a class="toc-backref" href="#id2331">Overview:</a><a class="headerlink" href="#id598" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.round.*</span></code>’ intrinsics returns the operand rounded to the
nearest integer.</p>
</div>
<div class="section" id="id599">
<h5><a class="toc-backref" href="#id2332">Arguments:</a><a class="headerlink" href="#id599" title="Permalink to this headline">¶</a></h5>
<p>The argument and return value are floating-point numbers of the same
type.</p>
</div>
<div class="section" id="id600">
<h5><a class="toc-backref" href="#id2333">Semantics:</a><a class="headerlink" href="#id600" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">round</span></code>
functions would, and handles error conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-roundeven-intrinsic">
<h4><a class="toc-backref" href="#id2334">‘<code class="docutils literal notranslate"><span class="pre">llvm.roundeven.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-roundeven-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id601">
<h5><a class="toc-backref" href="#id2335">Syntax:</a><a class="headerlink" href="#id601" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.roundeven</span></code> on any
floating-point or vector of floating-point type. Not all targets support
all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">roundeven</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">roundeven</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">x86_fp80</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">roundeven</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="n">x86_fp80</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">roundeven</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">ppc_fp128</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">roundeven</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">ppc_fp128</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id602">
<h5><a class="toc-backref" href="#id2336">Overview:</a><a class="headerlink" href="#id602" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.roundeven.*</span></code>’ intrinsics returns the operand rounded to the nearest
integer in floating-point format rounding halfway cases to even (that is, to the
nearest value that is an even integer).</p>
</div>
<div class="section" id="id603">
<h5><a class="toc-backref" href="#id2337">Arguments:</a><a class="headerlink" href="#id603" title="Permalink to this headline">¶</a></h5>
<p>The argument and return value are floating-point numbers of the same type.</p>
</div>
<div class="section" id="id604">
<h5><a class="toc-backref" href="#id2338">Semantics:</a><a class="headerlink" href="#id604" title="Permalink to this headline">¶</a></h5>
<p>This function implements IEEE-754 operation <code class="docutils literal notranslate"><span class="pre">roundToIntegralTiesToEven</span></code>. It
also behaves in the same way as C standard function <code class="docutils literal notranslate"><span class="pre">roundeven</span></code>, except that
it does not raise floating point exceptions.</p>
</div>
</div>
<div class="section" id="llvm-lround-intrinsic">
<h4><a class="toc-backref" href="#id2339">‘<code class="docutils literal notranslate"><span class="pre">llvm.lround.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-lround-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id605">
<h5><a class="toc-backref" href="#id2340">Syntax:</a><a class="headerlink" href="#id605" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.lround</span></code> on any
floating-point type. Not all targets support all types however.</p>
<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">lround</span><span class="o">.</span><span class="n">i32</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">lround</span><span class="o">.</span><span class="n">i32</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">lround</span><span class="o">.</span><span class="n">i32</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">lround</span><span class="o">.</span><span class="n">i32</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">lround</span><span class="o">.</span><span class="n">i32</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</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">lround</span><span class="o">.</span><span class="n">i64</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</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">lround</span><span class="o">.</span><span class="n">i64</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</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">lround</span><span class="o">.</span><span class="n">i64</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</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">lround</span><span class="o">.</span><span class="n">i64</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</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">lround</span><span class="o">.</span><span class="n">i64</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id606">
<h5><a class="toc-backref" href="#id2341">Overview:</a><a class="headerlink" href="#id606" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.lround.*</span></code>’ intrinsics return the operand rounded to the nearest
integer with ties away from zero.</p>
</div>
<div class="section" id="id607">
<h5><a class="toc-backref" href="#id2342">Arguments:</a><a class="headerlink" href="#id607" title="Permalink to this headline">¶</a></h5>
<p>The argument is a floating-point number and the return value is an integer
type.</p>
</div>
<div class="section" id="id608">
<h5><a class="toc-backref" href="#id2343">Semantics:</a><a class="headerlink" href="#id608" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">lround</span></code>
functions would, but without setting errno.</p>
</div>
</div>
<div class="section" id="llvm-llround-intrinsic">
<h4><a class="toc-backref" href="#id2344">‘<code class="docutils literal notranslate"><span class="pre">llvm.llround.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-llround-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id609">
<h5><a class="toc-backref" href="#id2345">Syntax:</a><a class="headerlink" href="#id609" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.llround</span></code> on any
floating-point type. Not all targets support all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i64</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">lround</span><span class="o">.</span><span class="n">i64</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</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">lround</span><span class="o">.</span><span class="n">i64</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</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">lround</span><span class="o">.</span><span class="n">i64</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</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">lround</span><span class="o">.</span><span class="n">i64</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</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">lround</span><span class="o">.</span><span class="n">i64</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id610">
<h5><a class="toc-backref" href="#id2346">Overview:</a><a class="headerlink" href="#id610" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.llround.*</span></code>’ intrinsics return the operand rounded to the nearest
integer with ties away from zero.</p>
</div>
<div class="section" id="id611">
<h5><a class="toc-backref" href="#id2347">Arguments:</a><a class="headerlink" href="#id611" title="Permalink to this headline">¶</a></h5>
<p>The argument is a floating-point number and the return value is an integer
type.</p>
</div>
<div class="section" id="id612">
<h5><a class="toc-backref" href="#id2348">Semantics:</a><a class="headerlink" href="#id612" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">llround</span></code>
functions would, but without setting errno.</p>
</div>
</div>
<div class="section" id="llvm-lrint-intrinsic">
<h4><a class="toc-backref" href="#id2349">‘<code class="docutils literal notranslate"><span class="pre">llvm.lrint.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-lrint-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id613">
<h5><a class="toc-backref" href="#id2350">Syntax:</a><a class="headerlink" href="#id613" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.lrint</span></code> on any
floating-point type. Not all targets support all types however.</p>
<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">lrint</span><span class="o">.</span><span class="n">i32</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">lrint</span><span class="o">.</span><span class="n">i32</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">lrint</span><span class="o">.</span><span class="n">i32</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">lrint</span><span class="o">.</span><span class="n">i32</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">lrint</span><span class="o">.</span><span class="n">i32</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</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">lrint</span><span class="o">.</span><span class="n">i64</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</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">lrint</span><span class="o">.</span><span class="n">i64</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</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">lrint</span><span class="o">.</span><span class="n">i64</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</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">lrint</span><span class="o">.</span><span class="n">i64</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</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">lrint</span><span class="o">.</span><span class="n">i64</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id614">
<h5><a class="toc-backref" href="#id2351">Overview:</a><a class="headerlink" href="#id614" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.lrint.*</span></code>’ intrinsics return the operand rounded to the nearest
integer.</p>
</div>
<div class="section" id="id615">
<h5><a class="toc-backref" href="#id2352">Arguments:</a><a class="headerlink" href="#id615" title="Permalink to this headline">¶</a></h5>
<p>The argument is a floating-point number and the return value is an integer
type.</p>
</div>
<div class="section" id="id616">
<h5><a class="toc-backref" href="#id2353">Semantics:</a><a class="headerlink" href="#id616" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">lrint</span></code>
functions would, but without setting errno.</p>
</div>
</div>
<div class="section" id="llvm-llrint-intrinsic">
<h4><a class="toc-backref" href="#id2354">‘<code class="docutils literal notranslate"><span class="pre">llvm.llrint.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-llrint-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id617">
<h5><a class="toc-backref" href="#id2355">Syntax:</a><a class="headerlink" href="#id617" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.llrint</span></code> on any
floating-point type. Not all targets support all types however.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i64</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">llrint</span><span class="o">.</span><span class="n">i64</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</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">llrint</span><span class="o">.</span><span class="n">i64</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</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">llrint</span><span class="o">.</span><span class="n">i64</span><span class="o">.</span><span class="n">f80</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">Val</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">llrint</span><span class="o">.</span><span class="n">i64</span><span class="o">.</span><span class="n">f128</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</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">llrint</span><span class="o">.</span><span class="n">i64</span><span class="o">.</span><span class="n">ppcf128</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">Val</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id618">
<h5><a class="toc-backref" href="#id2356">Overview:</a><a class="headerlink" href="#id618" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.llrint.*</span></code>’ intrinsics return the operand rounded to the nearest
integer.</p>
</div>
<div class="section" id="id619">
<h5><a class="toc-backref" href="#id2357">Arguments:</a><a class="headerlink" href="#id619" title="Permalink to this headline">¶</a></h5>
<p>The argument is a floating-point number and the return value is an integer
type.</p>
</div>
<div class="section" id="id620">
<h5><a class="toc-backref" href="#id2358">Semantics:</a><a class="headerlink" href="#id620" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">llrint</span></code>
functions would, but without setting errno.</p>
</div>
</div>
</div>
<div class="section" id="bit-manipulation-intrinsics">
<h3><a class="toc-backref" href="#id2359">Bit Manipulation Intrinsics</a><a class="headerlink" href="#bit-manipulation-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>LLVM provides intrinsics for a few important bit manipulation
operations. These allow efficient code generation for some algorithms.</p>
<div class="section" id="llvm-bitreverse-intrinsics">
<h4><a class="toc-backref" href="#id2360">‘<code class="docutils literal notranslate"><span class="pre">llvm.bitreverse.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-bitreverse-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id621">
<h5><a class="toc-backref" href="#id2361">Syntax:</a><a class="headerlink" href="#id621" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic function. You can use bitreverse on any
integer type.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">bitreverse</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o"><</span><span class="nb">id</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">bitreverse</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="nb">id</span><span class="o">></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">bitreverse</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o"><</span><span class="nb">id</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">bitreverse</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="nb">id</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id622">
<h5><a class="toc-backref" href="#id2362">Overview:</a><a class="headerlink" href="#id622" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.bitreverse</span></code>’ family of intrinsics is used to reverse the
bitpattern of an integer value or vector of integer values; for example
<code class="docutils literal notranslate"><span class="pre">0b10110110</span></code> becomes <code class="docutils literal notranslate"><span class="pre">0b01101101</span></code>.</p>
</div>
<div class="section" id="id623">
<h5><a class="toc-backref" href="#id2363">Semantics:</a><a class="headerlink" href="#id623" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.bitreverse.iN</span></code> intrinsic returns an iN value that has bit
<code class="docutils literal notranslate"><span class="pre">M</span></code> in the input moved to bit <code class="docutils literal notranslate"><span class="pre">N-M</span></code> in the output. The vector
intrinsics, such as <code class="docutils literal notranslate"><span class="pre">llvm.bitreverse.v4i32</span></code>, operate on a per-element
basis and the element order is not affected.</p>
</div>
</div>
<div class="section" id="llvm-bswap-intrinsics">
<h4><a class="toc-backref" href="#id2364">‘<code class="docutils literal notranslate"><span class="pre">llvm.bswap.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-bswap-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id624">
<h5><a class="toc-backref" href="#id2365">Syntax:</a><a class="headerlink" href="#id624" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic function. You can use bswap on any
integer type that is an even number of bytes (i.e. BitWidth % 16 == 0).</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">bswap</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o"><</span><span class="nb">id</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">bswap</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="nb">id</span><span class="o">></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">bswap</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o"><</span><span class="nb">id</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">bswap</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="nb">id</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id625">
<h5><a class="toc-backref" href="#id2366">Overview:</a><a class="headerlink" href="#id625" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.bswap</span></code>’ family of intrinsics is used to byte swap an integer
value or vector of integer values with an even number of bytes (positive
multiple of 16 bits).</p>
</div>
<div class="section" id="id626">
<h5><a class="toc-backref" href="#id2367">Semantics:</a><a class="headerlink" href="#id626" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.bswap.i16</span></code> intrinsic returns an i16 value that has the high
and low byte of the input i16 swapped. Similarly, the <code class="docutils literal notranslate"><span class="pre">llvm.bswap.i32</span></code>
intrinsic returns an i32 value that has the four bytes of the input i32
swapped, so that if the input bytes are numbered 0, 1, 2, 3 then the
returned i32 will have its bytes in 3, 2, 1, 0 order. The
<code class="docutils literal notranslate"><span class="pre">llvm.bswap.i48</span></code>, <code class="docutils literal notranslate"><span class="pre">llvm.bswap.i64</span></code> and other intrinsics extend this
concept to additional even-byte lengths (6 bytes, 8 bytes and more,
respectively). The vector intrinsics, such as <code class="docutils literal notranslate"><span class="pre">llvm.bswap.v4i32</span></code>,
operate on a per-element basis and the element order is not affected.</p>
</div>
</div>
<div class="section" id="llvm-ctpop-intrinsic">
<h4><a class="toc-backref" href="#id2368">‘<code class="docutils literal notranslate"><span class="pre">llvm.ctpop.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-ctpop-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id627">
<h5><a class="toc-backref" href="#id2369">Syntax:</a><a class="headerlink" href="#id627" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use llvm.ctpop on any integer
bit width, or on any vector with integer elements. Not all targets
support all bit widths or vector types, however.</p>
<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">ctpop</span><span class="o">.</span><span class="n">i8</span><span class="p">(</span><span class="n">i8</span> <span class="o"><</span><span class="n">src</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ctpop</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o"><</span><span class="n">src</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ctpop</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">src</span><span class="o">></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">ctpop</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o"><</span><span class="n">src</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i256</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ctpop</span><span class="o">.</span><span class="n">i256</span><span class="p">(</span><span class="n">i256</span> <span class="o"><</span><span class="n">src</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ctpop</span><span class="o">.</span><span class="n">v2i32</span><span class="p">(</span><span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">src</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id628">
<h5><a class="toc-backref" href="#id2370">Overview:</a><a class="headerlink" href="#id628" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.ctpop</span></code>’ family of intrinsics counts the number of bits set
in a value.</p>
</div>
<div class="section" id="id629">
<h5><a class="toc-backref" href="#id2371">Arguments:</a><a class="headerlink" href="#id629" title="Permalink to this headline">¶</a></h5>
<p>The only argument is the value to be counted. The argument may be of any
integer type, or a vector with integer elements. The return type must
match the argument type.</p>
</div>
<div class="section" id="id630">
<h5><a class="toc-backref" href="#id2372">Semantics:</a><a class="headerlink" href="#id630" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.ctpop</span></code>’ intrinsic counts the 1’s in a variable, or within
each element of a vector.</p>
</div>
</div>
<div class="section" id="llvm-ctlz-intrinsic">
<h4><a class="toc-backref" href="#id2373">‘<code class="docutils literal notranslate"><span class="pre">llvm.ctlz.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-ctlz-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id631">
<h5><a class="toc-backref" href="#id2374">Syntax:</a><a class="headerlink" href="#id631" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.ctlz</span></code> on any
integer bit width, or any vector whose elements are integers. Not all
targets support all bit widths or vector types, however.</p>
<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">ctlz</span><span class="o">.</span><span class="n">i8</span> <span class="p">(</span><span class="n">i8</span> <span class="o"><</span><span class="n">src</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">is_zero_undef</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ctlz</span><span class="o">.</span><span class="n">i16</span> <span class="p">(</span><span class="n">i16</span> <span class="o"><</span><span class="n">src</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">is_zero_undef</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ctlz</span><span class="o">.</span><span class="n">i32</span> <span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">src</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">is_zero_undef</span><span class="o">></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">ctlz</span><span class="o">.</span><span class="n">i64</span> <span class="p">(</span><span class="n">i64</span> <span class="o"><</span><span class="n">src</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">is_zero_undef</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i256</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ctlz</span><span class="o">.</span><span class="n">i256</span><span class="p">(</span><span class="n">i256</span> <span class="o"><</span><span class="n">src</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">is_zero_undef</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ctlz</span><span class="o">.</span><span class="n">v2i32</span><span class="p">(</span><span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">src</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">is_zero_undef</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id632">
<h5><a class="toc-backref" href="#id2375">Overview:</a><a class="headerlink" href="#id632" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.ctlz</span></code>’ family of intrinsic functions counts the number of
leading zeros in a variable.</p>
</div>
<div class="section" id="id633">
<h5><a class="toc-backref" href="#id2376">Arguments:</a><a class="headerlink" href="#id633" title="Permalink to this headline">¶</a></h5>
<p>The first argument is the value to be counted. This argument may be of
any integer type, or a vector with integer element type. The return
type must match the first argument type.</p>
<p>The second argument must be a constant and is a flag to indicate whether
the intrinsic should ensure that a zero as the first argument produces a
defined result. Historically some architectures did not provide a
defined result for zero values as efficiently, and many algorithms are
now predicated on avoiding zero-value inputs.</p>
</div>
<div class="section" id="id634">
<h5><a class="toc-backref" href="#id2377">Semantics:</a><a class="headerlink" href="#id634" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.ctlz</span></code>’ intrinsic counts the leading (most significant)
zeros in a variable, or within each element of the vector. If
<code class="docutils literal notranslate"><span class="pre">src</span> <span class="pre">==</span> <span class="pre">0</span></code> then the result is the size in bits of the type of <code class="docutils literal notranslate"><span class="pre">src</span></code>
if <code class="docutils literal notranslate"><span class="pre">is_zero_undef</span> <span class="pre">==</span> <span class="pre">0</span></code> and <code class="docutils literal notranslate"><span class="pre">undef</span></code> otherwise. For example,
<code class="docutils literal notranslate"><span class="pre">llvm.ctlz(i32</span> <span class="pre">2)</span> <span class="pre">=</span> <span class="pre">30</span></code>.</p>
</div>
</div>
<div class="section" id="llvm-cttz-intrinsic">
<h4><a class="toc-backref" href="#id2378">‘<code class="docutils literal notranslate"><span class="pre">llvm.cttz.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-cttz-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id635">
<h5><a class="toc-backref" href="#id2379">Syntax:</a><a class="headerlink" href="#id635" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.cttz</span></code> on any
integer bit width, or any vector of integer elements. Not all targets
support all bit widths or vector types, however.</p>
<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">cttz</span><span class="o">.</span><span class="n">i8</span> <span class="p">(</span><span class="n">i8</span> <span class="o"><</span><span class="n">src</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">is_zero_undef</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">cttz</span><span class="o">.</span><span class="n">i16</span> <span class="p">(</span><span class="n">i16</span> <span class="o"><</span><span class="n">src</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">is_zero_undef</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">cttz</span><span class="o">.</span><span class="n">i32</span> <span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">src</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">is_zero_undef</span><span class="o">></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">cttz</span><span class="o">.</span><span class="n">i64</span> <span class="p">(</span><span class="n">i64</span> <span class="o"><</span><span class="n">src</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">is_zero_undef</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i256</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">cttz</span><span class="o">.</span><span class="n">i256</span><span class="p">(</span><span class="n">i256</span> <span class="o"><</span><span class="n">src</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">is_zero_undef</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">cttz</span><span class="o">.</span><span class="n">v2i32</span><span class="p">(</span><span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">src</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">is_zero_undef</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id636">
<h5><a class="toc-backref" href="#id2380">Overview:</a><a class="headerlink" href="#id636" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.cttz</span></code>’ family of intrinsic functions counts the number of
trailing zeros.</p>
</div>
<div class="section" id="id637">
<h5><a class="toc-backref" href="#id2381">Arguments:</a><a class="headerlink" href="#id637" title="Permalink to this headline">¶</a></h5>
<p>The first argument is the value to be counted. This argument may be of
any integer type, or a vector with integer element type. The return
type must match the first argument type.</p>
<p>The second argument must be a constant and is a flag to indicate whether
the intrinsic should ensure that a zero as the first argument produces a
defined result. Historically some architectures did not provide a
defined result for zero values as efficiently, and many algorithms are
now predicated on avoiding zero-value inputs.</p>
</div>
<div class="section" id="id638">
<h5><a class="toc-backref" href="#id2382">Semantics:</a><a class="headerlink" href="#id638" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.cttz</span></code>’ intrinsic counts the trailing (least significant)
zeros in a variable, or within each element of a vector. If <code class="docutils literal notranslate"><span class="pre">src</span> <span class="pre">==</span> <span class="pre">0</span></code>
then the result is the size in bits of the type of <code class="docutils literal notranslate"><span class="pre">src</span></code> if
<code class="docutils literal notranslate"><span class="pre">is_zero_undef</span> <span class="pre">==</span> <span class="pre">0</span></code> and <code class="docutils literal notranslate"><span class="pre">undef</span></code> otherwise. For example,
<code class="docutils literal notranslate"><span class="pre">llvm.cttz(2)</span> <span class="pre">=</span> <span class="pre">1</span></code>.</p>
</div>
</div>
<div class="section" id="llvm-fshl-intrinsic">
<span id="int-overflow"></span><h4><a class="toc-backref" href="#id2383">‘<code class="docutils literal notranslate"><span class="pre">llvm.fshl.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-fshl-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id639">
<h5><a class="toc-backref" href="#id2384">Syntax:</a><a class="headerlink" href="#id639" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.fshl</span></code> on any
integer bit width or any vector of integer elements. Not all targets
support all bit widths or vector types, however.</p>
<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">fshl</span><span class="o">.</span><span class="n">i8</span> <span class="p">(</span><span class="n">i8</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i8</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i8</span> <span class="o">%</span><span class="n">c</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i67</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">fshl</span><span class="o">.</span><span class="n">i67</span><span class="p">(</span><span class="n">i67</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i67</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i67</span> <span class="o">%</span><span class="n">c</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">fshl</span><span class="o">.</span><span class="n">v2i32</span><span class="p">(</span><span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">c</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id640">
<h5><a class="toc-backref" href="#id2385">Overview:</a><a class="headerlink" href="#id640" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.fshl</span></code>’ family of intrinsic functions performs a funnel shift left:
the first two values are concatenated as { %a : %b } (%a is the most significant
bits of the wide value), the combined value is shifted left, and the most
significant bits are extracted to produce a result that is the same size as the
original arguments. If the first 2 arguments are identical, this is equivalent
to a rotate left operation. For vector types, the operation occurs for each
element of the vector. The shift argument is treated as an unsigned amount
modulo the element size of the arguments.</p>
</div>
<div class="section" id="id641">
<h5><a class="toc-backref" href="#id2386">Arguments:</a><a class="headerlink" href="#id641" title="Permalink to this headline">¶</a></h5>
<p>The first two arguments are the values to be concatenated. The third
argument is the shift amount. The arguments may be any integer type or a
vector with integer element type. All arguments and the return value must
have the same type.</p>
</div>
<div class="section" id="id642">
<h5><a class="toc-backref" href="#id2387">Example:</a><a class="headerlink" href="#id642" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>%r = call i8 @llvm.fshl.i8(i8 %x, i8 %y, i8 %z) ; %r = i8: msb_extract((concat(x, y) << (z % 8)), 8)
%r = call i8 @llvm.fshl.i8(i8 255, i8 0, i8 15) ; %r = i8: 128 (0b10000000)
%r = call i8 @llvm.fshl.i8(i8 15, i8 15, i8 11) ; %r = i8: 120 (0b01111000)
%r = call i8 @llvm.fshl.i8(i8 0, i8 255, i8 8) ; %r = i8: 0 (0b00000000)
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-fshr-intrinsic">
<h4><a class="toc-backref" href="#id2388">‘<code class="docutils literal notranslate"><span class="pre">llvm.fshr.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-fshr-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id643">
<h5><a class="toc-backref" href="#id2389">Syntax:</a><a class="headerlink" href="#id643" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.fshr</span></code> on any
integer bit width or any vector of integer elements. Not all targets
support all bit widths or vector types, however.</p>
<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">fshr</span><span class="o">.</span><span class="n">i8</span> <span class="p">(</span><span class="n">i8</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i8</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i8</span> <span class="o">%</span><span class="n">c</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i67</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">fshr</span><span class="o">.</span><span class="n">i67</span><span class="p">(</span><span class="n">i67</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i67</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i67</span> <span class="o">%</span><span class="n">c</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">fshr</span><span class="o">.</span><span class="n">v2i32</span><span class="p">(</span><span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">c</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id644">
<h5><a class="toc-backref" href="#id2390">Overview:</a><a class="headerlink" href="#id644" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.fshr</span></code>’ family of intrinsic functions performs a funnel shift right:
the first two values are concatenated as { %a : %b } (%a is the most significant
bits of the wide value), the combined value is shifted right, and the least
significant bits are extracted to produce a result that is the same size as the
original arguments. If the first 2 arguments are identical, this is equivalent
to a rotate right operation. For vector types, the operation occurs for each
element of the vector. The shift argument is treated as an unsigned amount
modulo the element size of the arguments.</p>
</div>
<div class="section" id="id645">
<h5><a class="toc-backref" href="#id2391">Arguments:</a><a class="headerlink" href="#id645" title="Permalink to this headline">¶</a></h5>
<p>The first two arguments are the values to be concatenated. The third
argument is the shift amount. The arguments may be any integer type or a
vector with integer element type. All arguments and the return value must
have the same type.</p>
</div>
<div class="section" id="id646">
<h5><a class="toc-backref" href="#id2392">Example:</a><a class="headerlink" href="#id646" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>%r = call i8 @llvm.fshr.i8(i8 %x, i8 %y, i8 %z) ; %r = i8: lsb_extract((concat(x, y) >> (z % 8)), 8)
%r = call i8 @llvm.fshr.i8(i8 255, i8 0, i8 15) ; %r = i8: 254 (0b11111110)
%r = call i8 @llvm.fshr.i8(i8 15, i8 15, i8 11) ; %r = i8: 225 (0b11100001)
%r = call i8 @llvm.fshr.i8(i8 0, i8 255, i8 8) ; %r = i8: 255 (0b11111111)
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="arithmetic-with-overflow-intrinsics">
<h3><a class="toc-backref" href="#id2393">Arithmetic with Overflow Intrinsics</a><a class="headerlink" href="#arithmetic-with-overflow-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>LLVM provides intrinsics for fast arithmetic overflow checking.</p>
<p>Each of these intrinsics returns a two-element struct. The first
element of this struct contains the result of the corresponding
arithmetic operation modulo 2<sup>n</sup>, where n is the bit width of
the result. Therefore, for example, the first element of the struct
returned by <code class="docutils literal notranslate"><span class="pre">llvm.sadd.with.overflow.i32</span></code> is always the same as the
result of a 32-bit <code class="docutils literal notranslate"><span class="pre">add</span></code> instruction with the same operands, where
the <code class="docutils literal notranslate"><span class="pre">add</span></code> is <em>not</em> modified by an <code class="docutils literal notranslate"><span class="pre">nsw</span></code> or <code class="docutils literal notranslate"><span class="pre">nuw</span></code> flag.</p>
<p>The second element of the result is an <code class="docutils literal notranslate"><span class="pre">i1</span></code> that is 1 if the
arithmetic operation overflowed and 0 otherwise. An operation
overflows if, for any values of its operands <code class="docutils literal notranslate"><span class="pre">A</span></code> and <code class="docutils literal notranslate"><span class="pre">B</span></code> and for
any <code class="docutils literal notranslate"><span class="pre">N</span></code> larger than the operands’ width, <code class="docutils literal notranslate"><span class="pre">ext(A</span> <span class="pre">op</span> <span class="pre">B)</span> <span class="pre">to</span> <span class="pre">iN</span></code> is
not equal to <code class="docutils literal notranslate"><span class="pre">(ext(A)</span> <span class="pre">to</span> <span class="pre">iN)</span> <span class="pre">op</span> <span class="pre">(ext(B)</span> <span class="pre">to</span> <span class="pre">iN)</span></code> where <code class="docutils literal notranslate"><span class="pre">ext</span></code> is
<code class="docutils literal notranslate"><span class="pre">sext</span></code> for signed overflow and <code class="docutils literal notranslate"><span class="pre">zext</span></code> for unsigned overflow, and
<code class="docutils literal notranslate"><span class="pre">op</span></code> is the underlying arithmetic operation.</p>
<p>The behavior of these intrinsics is well-defined for all argument
values.</p>
<div class="section" id="llvm-sadd-with-overflow-intrinsics">
<h4><a class="toc-backref" href="#id2394">‘<code class="docutils literal notranslate"><span class="pre">llvm.sadd.with.overflow.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-sadd-with-overflow-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id647">
<h5><a class="toc-backref" href="#id2395">Syntax:</a><a class="headerlink" href="#id647" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.sadd.with.overflow</span></code>
on any integer bit width or vectors of integers.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="p">{</span><span class="n">i16</span><span class="p">,</span> <span class="n">i1</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sadd</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i16</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="p">{</span><span class="n">i32</span><span class="p">,</span> <span class="n">i1</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sadd</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="p">{</span><span class="n">i64</span><span class="p">,</span> <span class="n">i1</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sadd</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="p">{</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sadd</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id648">
<h5><a class="toc-backref" href="#id2396">Overview:</a><a class="headerlink" href="#id648" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.sadd.with.overflow</span></code>’ family of intrinsic functions perform
a signed addition of the two arguments, and indicate whether an overflow
occurred during the signed summation.</p>
</div>
<div class="section" id="id649">
<h5><a class="toc-backref" href="#id2397">Arguments:</a><a class="headerlink" href="#id649" title="Permalink to this headline">¶</a></h5>
<p>The arguments (%a and %b) and the first element of the result structure
may be of integer types of any bit width, but they must have the same
bit width. The second element of the result structure must be of type
<code class="docutils literal notranslate"><span class="pre">i1</span></code>. <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> are the two values that will undergo signed
addition.</p>
</div>
<div class="section" id="id650">
<h5><a class="toc-backref" href="#id2398">Semantics:</a><a class="headerlink" href="#id650" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.sadd.with.overflow</span></code>’ family of intrinsic functions perform
a signed addition of the two variables. They return a structure — the
first element of which is the signed summation, and the second element
of which is a bit specifying if the signed summation resulted in an
overflow.</p>
</div>
<div class="section" id="id651">
<h5><a class="toc-backref" href="#id2399">Examples:</a><a class="headerlink" href="#id651" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="k">i1</span><span class="p">}</span> <span class="vg">@llvm.sadd.with.overflow.i32</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%a</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%b</span><span class="p">)</span>
<span class="nv">%sum</span> <span class="p">=</span> <span class="k">extractvalue</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="k">i1</span><span class="p">}</span> <span class="nv">%res</span><span class="p">,</span> <span class="m">0</span>
<span class="nv">%obit</span> <span class="p">=</span> <span class="k">extractvalue</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="k">i1</span><span class="p">}</span> <span class="nv">%res</span><span class="p">,</span> <span class="m">1</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%obit</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%overflow</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%normal</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-uadd-with-overflow-intrinsics">
<h4><a class="toc-backref" href="#id2400">‘<code class="docutils literal notranslate"><span class="pre">llvm.uadd.with.overflow.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-uadd-with-overflow-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id652">
<h5><a class="toc-backref" href="#id2401">Syntax:</a><a class="headerlink" href="#id652" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.uadd.with.overflow</span></code>
on any integer bit width or vectors of integers.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="p">{</span><span class="n">i16</span><span class="p">,</span> <span class="n">i1</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">uadd</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i16</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="p">{</span><span class="n">i32</span><span class="p">,</span> <span class="n">i1</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">uadd</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="p">{</span><span class="n">i64</span><span class="p">,</span> <span class="n">i1</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">uadd</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="p">{</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">uadd</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id653">
<h5><a class="toc-backref" href="#id2402">Overview:</a><a class="headerlink" href="#id653" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.uadd.with.overflow</span></code>’ family of intrinsic functions perform
an unsigned addition of the two arguments, and indicate whether a carry
occurred during the unsigned summation.</p>
</div>
<div class="section" id="id654">
<h5><a class="toc-backref" href="#id2403">Arguments:</a><a class="headerlink" href="#id654" title="Permalink to this headline">¶</a></h5>
<p>The arguments (%a and %b) and the first element of the result structure
may be of integer types of any bit width, but they must have the same
bit width. The second element of the result structure must be of type
<code class="docutils literal notranslate"><span class="pre">i1</span></code>. <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> are the two values that will undergo unsigned
addition.</p>
</div>
<div class="section" id="id655">
<h5><a class="toc-backref" href="#id2404">Semantics:</a><a class="headerlink" href="#id655" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.uadd.with.overflow</span></code>’ family of intrinsic functions perform
an unsigned addition of the two arguments. They return a structure — the
first element of which is the sum, and the second element of which is a
bit specifying if the unsigned summation resulted in a carry.</p>
</div>
<div class="section" id="id656">
<h5><a class="toc-backref" href="#id2405">Examples:</a><a class="headerlink" href="#id656" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="k">i1</span><span class="p">}</span> <span class="vg">@llvm.uadd.with.overflow.i32</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%a</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%b</span><span class="p">)</span>
<span class="nv">%sum</span> <span class="p">=</span> <span class="k">extractvalue</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="k">i1</span><span class="p">}</span> <span class="nv">%res</span><span class="p">,</span> <span class="m">0</span>
<span class="nv">%obit</span> <span class="p">=</span> <span class="k">extractvalue</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="k">i1</span><span class="p">}</span> <span class="nv">%res</span><span class="p">,</span> <span class="m">1</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%obit</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%carry</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%normal</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-ssub-with-overflow-intrinsics">
<h4><a class="toc-backref" href="#id2406">‘<code class="docutils literal notranslate"><span class="pre">llvm.ssub.with.overflow.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-ssub-with-overflow-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id657">
<h5><a class="toc-backref" href="#id2407">Syntax:</a><a class="headerlink" href="#id657" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.ssub.with.overflow</span></code>
on any integer bit width or vectors of integers.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="p">{</span><span class="n">i16</span><span class="p">,</span> <span class="n">i1</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ssub</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i16</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="p">{</span><span class="n">i32</span><span class="p">,</span> <span class="n">i1</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ssub</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="p">{</span><span class="n">i64</span><span class="p">,</span> <span class="n">i1</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ssub</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="p">{</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ssub</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id658">
<h5><a class="toc-backref" href="#id2408">Overview:</a><a class="headerlink" href="#id658" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.ssub.with.overflow</span></code>’ family of intrinsic functions perform
a signed subtraction of the two arguments, and indicate whether an
overflow occurred during the signed subtraction.</p>
</div>
<div class="section" id="id659">
<h5><a class="toc-backref" href="#id2409">Arguments:</a><a class="headerlink" href="#id659" title="Permalink to this headline">¶</a></h5>
<p>The arguments (%a and %b) and the first element of the result structure
may be of integer types of any bit width, but they must have the same
bit width. The second element of the result structure must be of type
<code class="docutils literal notranslate"><span class="pre">i1</span></code>. <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> are the two values that will undergo signed
subtraction.</p>
</div>
<div class="section" id="id660">
<h5><a class="toc-backref" href="#id2410">Semantics:</a><a class="headerlink" href="#id660" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.ssub.with.overflow</span></code>’ family of intrinsic functions perform
a signed subtraction of the two arguments. They return a structure — the
first element of which is the subtraction, and the second element of
which is a bit specifying if the signed subtraction resulted in an
overflow.</p>
</div>
<div class="section" id="id661">
<h5><a class="toc-backref" href="#id2411">Examples:</a><a class="headerlink" href="#id661" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="k">i1</span><span class="p">}</span> <span class="vg">@llvm.ssub.with.overflow.i32</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%a</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%b</span><span class="p">)</span>
<span class="nv">%sum</span> <span class="p">=</span> <span class="k">extractvalue</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="k">i1</span><span class="p">}</span> <span class="nv">%res</span><span class="p">,</span> <span class="m">0</span>
<span class="nv">%obit</span> <span class="p">=</span> <span class="k">extractvalue</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="k">i1</span><span class="p">}</span> <span class="nv">%res</span><span class="p">,</span> <span class="m">1</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%obit</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%overflow</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%normal</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-usub-with-overflow-intrinsics">
<h4><a class="toc-backref" href="#id2412">‘<code class="docutils literal notranslate"><span class="pre">llvm.usub.with.overflow.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-usub-with-overflow-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id662">
<h5><a class="toc-backref" href="#id2413">Syntax:</a><a class="headerlink" href="#id662" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.usub.with.overflow</span></code>
on any integer bit width or vectors of integers.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="p">{</span><span class="n">i16</span><span class="p">,</span> <span class="n">i1</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">usub</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i16</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="p">{</span><span class="n">i32</span><span class="p">,</span> <span class="n">i1</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">usub</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="p">{</span><span class="n">i64</span><span class="p">,</span> <span class="n">i1</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">usub</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="p">{</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">usub</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id663">
<h5><a class="toc-backref" href="#id2414">Overview:</a><a class="headerlink" href="#id663" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.usub.with.overflow</span></code>’ family of intrinsic functions perform
an unsigned subtraction of the two arguments, and indicate whether an
overflow occurred during the unsigned subtraction.</p>
</div>
<div class="section" id="id664">
<h5><a class="toc-backref" href="#id2415">Arguments:</a><a class="headerlink" href="#id664" title="Permalink to this headline">¶</a></h5>
<p>The arguments (%a and %b) and the first element of the result structure
may be of integer types of any bit width, but they must have the same
bit width. The second element of the result structure must be of type
<code class="docutils literal notranslate"><span class="pre">i1</span></code>. <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> are the two values that will undergo unsigned
subtraction.</p>
</div>
<div class="section" id="id665">
<h5><a class="toc-backref" href="#id2416">Semantics:</a><a class="headerlink" href="#id665" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.usub.with.overflow</span></code>’ family of intrinsic functions perform
an unsigned subtraction of the two arguments. They return a structure —
the first element of which is the subtraction, and the second element of
which is a bit specifying if the unsigned subtraction resulted in an
overflow.</p>
</div>
<div class="section" id="id666">
<h5><a class="toc-backref" href="#id2417">Examples:</a><a class="headerlink" href="#id666" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="k">i1</span><span class="p">}</span> <span class="vg">@llvm.usub.with.overflow.i32</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%a</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%b</span><span class="p">)</span>
<span class="nv">%sum</span> <span class="p">=</span> <span class="k">extractvalue</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="k">i1</span><span class="p">}</span> <span class="nv">%res</span><span class="p">,</span> <span class="m">0</span>
<span class="nv">%obit</span> <span class="p">=</span> <span class="k">extractvalue</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="k">i1</span><span class="p">}</span> <span class="nv">%res</span><span class="p">,</span> <span class="m">1</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%obit</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%overflow</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%normal</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-smul-with-overflow-intrinsics">
<h4><a class="toc-backref" href="#id2418">‘<code class="docutils literal notranslate"><span class="pre">llvm.smul.with.overflow.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-smul-with-overflow-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id667">
<h5><a class="toc-backref" href="#id2419">Syntax:</a><a class="headerlink" href="#id667" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.smul.with.overflow</span></code>
on any integer bit width or vectors of integers.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="p">{</span><span class="n">i16</span><span class="p">,</span> <span class="n">i1</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">smul</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i16</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="p">{</span><span class="n">i32</span><span class="p">,</span> <span class="n">i1</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">smul</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="p">{</span><span class="n">i64</span><span class="p">,</span> <span class="n">i1</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">smul</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="p">{</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">smul</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id668">
<h5><a class="toc-backref" href="#id2420">Overview:</a><a class="headerlink" href="#id668" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.smul.with.overflow</span></code>’ family of intrinsic functions perform
a signed multiplication of the two arguments, and indicate whether an
overflow occurred during the signed multiplication.</p>
</div>
<div class="section" id="id669">
<h5><a class="toc-backref" href="#id2421">Arguments:</a><a class="headerlink" href="#id669" title="Permalink to this headline">¶</a></h5>
<p>The arguments (%a and %b) and the first element of the result structure
may be of integer types of any bit width, but they must have the same
bit width. The second element of the result structure must be of type
<code class="docutils literal notranslate"><span class="pre">i1</span></code>. <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> are the two values that will undergo signed
multiplication.</p>
</div>
<div class="section" id="id670">
<h5><a class="toc-backref" href="#id2422">Semantics:</a><a class="headerlink" href="#id670" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.smul.with.overflow</span></code>’ family of intrinsic functions perform
a signed multiplication of the two arguments. They return a structure —
the first element of which is the multiplication, and the second element
of which is a bit specifying if the signed multiplication resulted in an
overflow.</p>
</div>
<div class="section" id="id671">
<h5><a class="toc-backref" href="#id2423">Examples:</a><a class="headerlink" href="#id671" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="k">i1</span><span class="p">}</span> <span class="vg">@llvm.smul.with.overflow.i32</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%a</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%b</span><span class="p">)</span>
<span class="nv">%sum</span> <span class="p">=</span> <span class="k">extractvalue</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="k">i1</span><span class="p">}</span> <span class="nv">%res</span><span class="p">,</span> <span class="m">0</span>
<span class="nv">%obit</span> <span class="p">=</span> <span class="k">extractvalue</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="k">i1</span><span class="p">}</span> <span class="nv">%res</span><span class="p">,</span> <span class="m">1</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%obit</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%overflow</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%normal</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-umul-with-overflow-intrinsics">
<h4><a class="toc-backref" href="#id2424">‘<code class="docutils literal notranslate"><span class="pre">llvm.umul.with.overflow.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-umul-with-overflow-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id672">
<h5><a class="toc-backref" href="#id2425">Syntax:</a><a class="headerlink" href="#id672" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.umul.with.overflow</span></code>
on any integer bit width or vectors of integers.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="p">{</span><span class="n">i16</span><span class="p">,</span> <span class="n">i1</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">umul</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i16</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="p">{</span><span class="n">i32</span><span class="p">,</span> <span class="n">i1</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">umul</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="p">{</span><span class="n">i64</span><span class="p">,</span> <span class="n">i1</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">umul</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="p">{</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">umul</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">overflow</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id673">
<h5><a class="toc-backref" href="#id2426">Overview:</a><a class="headerlink" href="#id673" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.umul.with.overflow</span></code>’ family of intrinsic functions perform
a unsigned multiplication of the two arguments, and indicate whether an
overflow occurred during the unsigned multiplication.</p>
</div>
<div class="section" id="id674">
<h5><a class="toc-backref" href="#id2427">Arguments:</a><a class="headerlink" href="#id674" title="Permalink to this headline">¶</a></h5>
<p>The arguments (%a and %b) and the first element of the result structure
may be of integer types of any bit width, but they must have the same
bit width. The second element of the result structure must be of type
<code class="docutils literal notranslate"><span class="pre">i1</span></code>. <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> are the two values that will undergo unsigned
multiplication.</p>
</div>
<div class="section" id="id675">
<h5><a class="toc-backref" href="#id2428">Semantics:</a><a class="headerlink" href="#id675" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.umul.with.overflow</span></code>’ family of intrinsic functions perform
an unsigned multiplication of the two arguments. They return a structure —
the first element of which is the multiplication, and the second
element of which is a bit specifying if the unsigned multiplication
resulted in an overflow.</p>
</div>
<div class="section" id="id676">
<h5><a class="toc-backref" href="#id2429">Examples:</a><a class="headerlink" href="#id676" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="k">i1</span><span class="p">}</span> <span class="vg">@llvm.umul.with.overflow.i32</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%a</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%b</span><span class="p">)</span>
<span class="nv">%sum</span> <span class="p">=</span> <span class="k">extractvalue</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="k">i1</span><span class="p">}</span> <span class="nv">%res</span><span class="p">,</span> <span class="m">0</span>
<span class="nv">%obit</span> <span class="p">=</span> <span class="k">extractvalue</span> <span class="p">{</span><span class="k">i32</span><span class="p">,</span> <span class="k">i1</span><span class="p">}</span> <span class="nv">%res</span><span class="p">,</span> <span class="m">1</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%obit</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%overflow</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%normal</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="saturation-arithmetic-intrinsics">
<h3><a class="toc-backref" href="#id2430">Saturation Arithmetic Intrinsics</a><a class="headerlink" href="#saturation-arithmetic-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>Saturation arithmetic is a version of arithmetic in which operations are
limited to a fixed range between a minimum and maximum value. If the result of
an operation is greater than the maximum value, the result is set (or
“clamped”) to this maximum. If it is below the minimum, it is clamped to this
minimum.</p>
<div class="section" id="llvm-sadd-sat-intrinsics">
<h4><a class="toc-backref" href="#id2431">‘<code class="docutils literal notranslate"><span class="pre">llvm.sadd.sat.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-sadd-sat-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id677">
<h5><a class="toc-backref" href="#id2432">Syntax</a><a class="headerlink" href="#id677" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.sadd.sat</span></code>
on any integer bit width or vectors of integers.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sadd</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i16</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sadd</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</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">sadd</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sadd</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id678">
<h5><a class="toc-backref" href="#id2433">Overview</a><a class="headerlink" href="#id678" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.sadd.sat</span></code>’ family of intrinsic functions perform signed
saturating addition on the 2 arguments.</p>
</div>
<div class="section" id="id679">
<h5><a class="toc-backref" href="#id2434">Arguments</a><a class="headerlink" href="#id679" title="Permalink to this headline">¶</a></h5>
<p>The arguments (%a and %b) and the result may be of integer types of any bit
width, but they must have the same bit width. <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> are the two
values that will undergo signed addition.</p>
</div>
<div class="section" id="id680">
<h5><a class="toc-backref" href="#id2435">Semantics:</a><a class="headerlink" href="#id680" title="Permalink to this headline">¶</a></h5>
<p>The maximum value this operation can clamp to is the largest signed value
representable by the bit width of the arguments. The minimum value is the
smallest signed value representable by this bit width.</p>
</div>
<div class="section" id="id681">
<h5><a class="toc-backref" href="#id2436">Examples</a><a class="headerlink" href="#id681" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.sadd.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">1</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">)</span> <span class="c">; %res = 3</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.sadd.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">5</span><span class="p">,</span> <span class="k">i4</span> <span class="m">6</span><span class="p">)</span> <span class="c">; %res = 7</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.sadd.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">-4</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">)</span> <span class="c">; %res = -2</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.sadd.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">-4</span><span class="p">,</span> <span class="k">i4</span> <span class="m">-5</span><span class="p">)</span> <span class="c">; %res = -8</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-uadd-sat-intrinsics">
<h4><a class="toc-backref" href="#id2437">‘<code class="docutils literal notranslate"><span class="pre">llvm.uadd.sat.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-uadd-sat-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id682">
<h5><a class="toc-backref" href="#id2438">Syntax</a><a class="headerlink" href="#id682" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.uadd.sat</span></code>
on any integer bit width or vectors of integers.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">uadd</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i16</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">uadd</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</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">uadd</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">uadd</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id683">
<h5><a class="toc-backref" href="#id2439">Overview</a><a class="headerlink" href="#id683" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.uadd.sat</span></code>’ family of intrinsic functions perform unsigned
saturating addition on the 2 arguments.</p>
</div>
<div class="section" id="id684">
<h5><a class="toc-backref" href="#id2440">Arguments</a><a class="headerlink" href="#id684" title="Permalink to this headline">¶</a></h5>
<p>The arguments (%a and %b) and the result may be of integer types of any bit
width, but they must have the same bit width. <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> are the two
values that will undergo unsigned addition.</p>
</div>
<div class="section" id="id685">
<h5><a class="toc-backref" href="#id2441">Semantics:</a><a class="headerlink" href="#id685" title="Permalink to this headline">¶</a></h5>
<p>The maximum value this operation can clamp to is the largest unsigned value
representable by the bit width of the arguments. Because this is an unsigned
operation, the result will never saturate towards zero.</p>
</div>
<div class="section" id="id686">
<h5><a class="toc-backref" href="#id2442">Examples</a><a class="headerlink" href="#id686" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.uadd.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">1</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">)</span> <span class="c">; %res = 3</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.uadd.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">5</span><span class="p">,</span> <span class="k">i4</span> <span class="m">6</span><span class="p">)</span> <span class="c">; %res = 11</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.uadd.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">8</span><span class="p">,</span> <span class="k">i4</span> <span class="m">8</span><span class="p">)</span> <span class="c">; %res = 15</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-ssub-sat-intrinsics">
<h4><a class="toc-backref" href="#id2443">‘<code class="docutils literal notranslate"><span class="pre">llvm.ssub.sat.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-ssub-sat-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id687">
<h5><a class="toc-backref" href="#id2444">Syntax</a><a class="headerlink" href="#id687" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.ssub.sat</span></code>
on any integer bit width or vectors of integers.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ssub</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i16</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ssub</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</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">ssub</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ssub</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id688">
<h5><a class="toc-backref" href="#id2445">Overview</a><a class="headerlink" href="#id688" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.ssub.sat</span></code>’ family of intrinsic functions perform signed
saturating subtraction on the 2 arguments.</p>
</div>
<div class="section" id="id689">
<h5><a class="toc-backref" href="#id2446">Arguments</a><a class="headerlink" href="#id689" title="Permalink to this headline">¶</a></h5>
<p>The arguments (%a and %b) and the result may be of integer types of any bit
width, but they must have the same bit width. <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> are the two
values that will undergo signed subtraction.</p>
</div>
<div class="section" id="id690">
<h5><a class="toc-backref" href="#id2447">Semantics:</a><a class="headerlink" href="#id690" title="Permalink to this headline">¶</a></h5>
<p>The maximum value this operation can clamp to is the largest signed value
representable by the bit width of the arguments. The minimum value is the
smallest signed value representable by this bit width.</p>
</div>
<div class="section" id="id691">
<h5><a class="toc-backref" href="#id2448">Examples</a><a class="headerlink" href="#id691" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.ssub.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i4</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = 1</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.ssub.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i4</span> <span class="m">6</span><span class="p">)</span> <span class="c">; %res = -4</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.ssub.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">-4</span><span class="p">,</span> <span class="k">i4</span> <span class="m">5</span><span class="p">)</span> <span class="c">; %res = -8</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.ssub.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">4</span><span class="p">,</span> <span class="k">i4</span> <span class="m">-5</span><span class="p">)</span> <span class="c">; %res = 7</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-usub-sat-intrinsics">
<h4><a class="toc-backref" href="#id2449">‘<code class="docutils literal notranslate"><span class="pre">llvm.usub.sat.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-usub-sat-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id692">
<h5><a class="toc-backref" href="#id2450">Syntax</a><a class="headerlink" href="#id692" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.usub.sat</span></code>
on any integer bit width or vectors of integers.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">usub</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i16</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">usub</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</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">usub</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">usub</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id693">
<h5><a class="toc-backref" href="#id2451">Overview</a><a class="headerlink" href="#id693" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.usub.sat</span></code>’ family of intrinsic functions perform unsigned
saturating subtraction on the 2 arguments.</p>
</div>
<div class="section" id="id694">
<h5><a class="toc-backref" href="#id2452">Arguments</a><a class="headerlink" href="#id694" title="Permalink to this headline">¶</a></h5>
<p>The arguments (%a and %b) and the result may be of integer types of any bit
width, but they must have the same bit width. <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> are the two
values that will undergo unsigned subtraction.</p>
</div>
<div class="section" id="id695">
<h5><a class="toc-backref" href="#id2453">Semantics:</a><a class="headerlink" href="#id695" title="Permalink to this headline">¶</a></h5>
<p>The minimum value this operation can clamp to is 0, which is the smallest
unsigned value representable by the bit width of the unsigned arguments.
Because this is an unsigned operation, the result will never saturate towards
the largest possible value representable by this bit width.</p>
</div>
<div class="section" id="id696">
<h5><a class="toc-backref" href="#id2454">Examples</a><a class="headerlink" href="#id696" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.usub.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i4</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = 1</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.usub.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i4</span> <span class="m">6</span><span class="p">)</span> <span class="c">; %res = 0</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-sshl-sat-intrinsics">
<h4><a class="toc-backref" href="#id2455">‘<code class="docutils literal notranslate"><span class="pre">llvm.sshl.sat.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-sshl-sat-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id697">
<h5><a class="toc-backref" href="#id2456">Syntax</a><a class="headerlink" href="#id697" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.sshl.sat</span></code>
on integers or vectors of integers of any bit width.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sshl</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i16</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sshl</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</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">sshl</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sshl</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id698">
<h5><a class="toc-backref" href="#id2457">Overview</a><a class="headerlink" href="#id698" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.sshl.sat</span></code>’ family of intrinsic functions perform signed
saturating left shift on the first argument.</p>
</div>
<div class="section" id="id699">
<h5><a class="toc-backref" href="#id2458">Arguments</a><a class="headerlink" href="#id699" title="Permalink to this headline">¶</a></h5>
<p>The arguments (<code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code>) and the result may be of integer types of any
bit width, but they must have the same bit width. <code class="docutils literal notranslate"><span class="pre">%a</span></code> is the value to be
shifted, and <code class="docutils literal notranslate"><span class="pre">%b</span></code> is the amount to shift by. If <code class="docutils literal notranslate"><span class="pre">b</span></code> is (statically or
dynamically) equal to or larger than the integer bit width of the arguments,
the result is a <a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a>. If the arguments are
vectors, each vector element of <code class="docutils literal notranslate"><span class="pre">a</span></code> is shifted by the corresponding shift
amount in <code class="docutils literal notranslate"><span class="pre">b</span></code>.</p>
</div>
<div class="section" id="id700">
<h5><a class="toc-backref" href="#id2459">Semantics:</a><a class="headerlink" href="#id700" title="Permalink to this headline">¶</a></h5>
<p>The maximum value this operation can clamp to is the largest signed value
representable by the bit width of the arguments. The minimum value is the
smallest signed value representable by this bit width.</p>
</div>
<div class="section" id="id701">
<h5><a class="toc-backref" href="#id2460">Examples</a><a class="headerlink" href="#id701" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.sshl.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i4</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = 4</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.sshl.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">)</span> <span class="c">; %res = 7</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.sshl.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">-5</span><span class="p">,</span> <span class="k">i4</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = -8</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.sshl.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">-1</span><span class="p">,</span> <span class="k">i4</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = -2</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-ushl-sat-intrinsics">
<h4><a class="toc-backref" href="#id2461">‘<code class="docutils literal notranslate"><span class="pre">llvm.ushl.sat.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-ushl-sat-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id702">
<h5><a class="toc-backref" href="#id2462">Syntax</a><a class="headerlink" href="#id702" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.ushl.sat</span></code>
on integers or vectors of integers of any bit width.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ushl</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i16</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ushl</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</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">ushl</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ushl</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id703">
<h5><a class="toc-backref" href="#id2463">Overview</a><a class="headerlink" href="#id703" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.ushl.sat</span></code>’ family of intrinsic functions perform unsigned
saturating left shift on the first argument.</p>
</div>
<div class="section" id="id704">
<h5><a class="toc-backref" href="#id2464">Arguments</a><a class="headerlink" href="#id704" title="Permalink to this headline">¶</a></h5>
<p>The arguments (<code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code>) and the result may be of integer types of any
bit width, but they must have the same bit width. <code class="docutils literal notranslate"><span class="pre">%a</span></code> is the value to be
shifted, and <code class="docutils literal notranslate"><span class="pre">%b</span></code> is the amount to shift by. If <code class="docutils literal notranslate"><span class="pre">b</span></code> is (statically or
dynamically) equal to or larger than the integer bit width of the arguments,
the result is a <a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a>. If the arguments are
vectors, each vector element of <code class="docutils literal notranslate"><span class="pre">a</span></code> is shifted by the corresponding shift
amount in <code class="docutils literal notranslate"><span class="pre">b</span></code>.</p>
</div>
<div class="section" id="id705">
<h5><a class="toc-backref" href="#id2465">Semantics:</a><a class="headerlink" href="#id705" title="Permalink to this headline">¶</a></h5>
<p>The maximum value this operation can clamp to is the largest unsigned value
representable by the bit width of the arguments.</p>
</div>
<div class="section" id="id706">
<h5><a class="toc-backref" href="#id2466">Examples</a><a class="headerlink" href="#id706" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.ushl.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i4</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = 4</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.ushl.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">3</span><span class="p">)</span> <span class="c">; %res = 15</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="fixed-point-arithmetic-intrinsics">
<h3><a class="toc-backref" href="#id2467">Fixed Point Arithmetic Intrinsics</a><a class="headerlink" href="#fixed-point-arithmetic-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>A fixed point number represents a real data type for a number that has a fixed
number of digits after a radix point (equivalent to the decimal point ‘.’).
The number of digits after the radix point is referred as the <cite>scale</cite>. These
are useful for representing fractional values to a specific precision. The
following intrinsics perform fixed point arithmetic operations on 2 operands
of the same scale, specified as the third argument.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.*mul.fix</span></code> family of intrinsic functions represents a multiplication
of fixed point numbers through scaled integers. Therefore, fixed point
multiplication can be represented as</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%result</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.smul.fix.i4</span><span class="p">(</span><span class="k">i4</span> <span class="nv">%a</span><span class="p">,</span> <span class="k">i4</span> <span class="nv">%b</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%scale</span><span class="p">)</span>
<span class="c">; Expands to</span>
<span class="nv">%a2</span> <span class="p">=</span> <span class="k">sext</span> <span class="k">i4</span> <span class="nv">%a</span> <span class="k">to</span> <span class="k">i8</span>
<span class="nv">%b2</span> <span class="p">=</span> <span class="k">sext</span> <span class="k">i4</span> <span class="nv">%b</span> <span class="k">to</span> <span class="k">i8</span>
<span class="nv">%mul</span> <span class="p">=</span> <span class="k">mul</span> <span class="k">nsw</span> <span class="k">nuw</span> <span class="k">i8</span> <span class="nv">%a</span><span class="p">,</span> <span class="nv">%b</span>
<span class="nv">%scale2</span> <span class="p">=</span> <span class="k">trunc</span> <span class="k">i32</span> <span class="nv">%scale</span> <span class="k">to</span> <span class="k">i8</span>
<span class="nv">%r</span> <span class="p">=</span> <span class="k">ashr</span> <span class="k">i8</span> <span class="nv">%mul</span><span class="p">,</span> <span class="k">i8</span> <span class="nv">%scale2</span> <span class="c">; this is for a target rounding down towards negative infinity</span>
<span class="nv">%result</span> <span class="p">=</span> <span class="k">trunc</span> <span class="k">i8</span> <span class="nv">%r</span> <span class="k">to</span> <span class="k">i4</span>
</pre></div>
</div>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.*div.fix</span></code> family of intrinsic functions represents a division of
fixed point numbers through scaled integers. Fixed point division can be
represented as:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%result</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.sdiv.fix.i4</span><span class="p">(</span><span class="k">i4</span> <span class="nv">%a</span><span class="p">,</span> <span class="k">i4</span> <span class="nv">%b</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%scale</span><span class="p">)</span>
<span class="c">; Expands to</span>
<span class="nv">%a2</span> <span class="p">=</span> <span class="k">sext</span> <span class="k">i4</span> <span class="nv">%a</span> <span class="k">to</span> <span class="k">i8</span>
<span class="nv">%b2</span> <span class="p">=</span> <span class="k">sext</span> <span class="k">i4</span> <span class="nv">%b</span> <span class="k">to</span> <span class="k">i8</span>
<span class="nv">%scale2</span> <span class="p">=</span> <span class="k">trunc</span> <span class="k">i32</span> <span class="nv">%scale</span> <span class="k">to</span> <span class="k">i8</span>
<span class="nv">%a3</span> <span class="p">=</span> <span class="k">shl</span> <span class="k">i8</span> <span class="nv">%a2</span><span class="p">,</span> <span class="nv">%scale2</span>
<span class="nv">%r</span> <span class="p">=</span> <span class="k">sdiv</span> <span class="k">i8</span> <span class="nv">%a3</span><span class="p">,</span> <span class="nv">%b2</span> <span class="c">; this is for a target rounding towards zero</span>
<span class="nv">%result</span> <span class="p">=</span> <span class="k">trunc</span> <span class="k">i8</span> <span class="nv">%r</span> <span class="k">to</span> <span class="k">i4</span>
</pre></div>
</div>
<p>For each of these functions, if the result cannot be represented exactly with
the provided scale, the result is rounded. Rounding is unspecified since
preferred rounding may vary for different targets. Rounding is specified
through a target hook. Different pipelines should legalize or optimize this
using the rounding specified by this hook if it is provided. Operations like
constant folding, instruction combining, KnownBits, and ValueTracking should
also use this hook, if provided, and not assume the direction of rounding. A
rounded result must always be within one unit of precision from the true
result. That is, the error between the returned result and the true result must
be less than 1/2^(scale).</p>
<div class="section" id="llvm-smul-fix-intrinsics">
<h4><a class="toc-backref" href="#id2468">‘<code class="docutils literal notranslate"><span class="pre">llvm.smul.fix.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-smul-fix-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id707">
<h5><a class="toc-backref" href="#id2469">Syntax</a><a class="headerlink" href="#id707" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.smul.fix</span></code>
on any integer bit width or vectors of integers.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">smul</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i16</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">smul</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</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">smul</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">smul</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id708">
<h5><a class="toc-backref" href="#id2470">Overview</a><a class="headerlink" href="#id708" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.smul.fix</span></code>’ family of intrinsic functions perform signed
fixed point multiplication on 2 arguments of the same scale.</p>
</div>
<div class="section" id="id709">
<h5><a class="toc-backref" href="#id2471">Arguments</a><a class="headerlink" href="#id709" title="Permalink to this headline">¶</a></h5>
<p>The arguments (%a and %b) and the result may be of integer types of any bit
width, but they must have the same bit width. The arguments may also work with
int vectors of the same length and int size. <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> are the two
values that will undergo signed fixed point multiplication. The argument
<code class="docutils literal notranslate"><span class="pre">%scale</span></code> represents the scale of both operands, and must be a constant
integer.</p>
</div>
<div class="section" id="id710">
<h5><a class="toc-backref" href="#id2472">Semantics:</a><a class="headerlink" href="#id710" title="Permalink to this headline">¶</a></h5>
<p>This operation performs fixed point multiplication on the 2 arguments of a
specified scale. The result will also be returned in the same scale specified
in the third argument.</p>
<p>If the result value cannot be precisely represented in the given scale, the
value is rounded up or down to the closest representable value. The rounding
direction is unspecified.</p>
<p>It is undefined behavior if the result value does not fit within the range of
the fixed point type.</p>
</div>
<div class="section" id="id711">
<h5><a class="toc-backref" href="#id2473">Examples</a><a class="headerlink" href="#id711" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.smul.fix.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">0</span><span class="p">)</span> <span class="c">; %res = 6 (2 x 3 = 6)</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.smul.fix.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = 3 (1.5 x 1 = 1.5)</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.smul.fix.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">-2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = -3 (1.5 x -1 = -1.5)</span>
<span class="c">; The result in the following could be rounded up to -2 or down to -2.5</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.smul.fix.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">-3</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = -5 (or -4) (1.5 x -1.5 = -2.25)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-umul-fix-intrinsics">
<h4><a class="toc-backref" href="#id2474">‘<code class="docutils literal notranslate"><span class="pre">llvm.umul.fix.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-umul-fix-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id712">
<h5><a class="toc-backref" href="#id2475">Syntax</a><a class="headerlink" href="#id712" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.umul.fix</span></code>
on any integer bit width or vectors of integers.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">umul</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i16</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">umul</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</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">umul</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">umul</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id713">
<h5><a class="toc-backref" href="#id2476">Overview</a><a class="headerlink" href="#id713" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.umul.fix</span></code>’ family of intrinsic functions perform unsigned
fixed point multiplication on 2 arguments of the same scale.</p>
</div>
<div class="section" id="id714">
<h5><a class="toc-backref" href="#id2477">Arguments</a><a class="headerlink" href="#id714" title="Permalink to this headline">¶</a></h5>
<p>The arguments (%a and %b) and the result may be of integer types of any bit
width, but they must have the same bit width. The arguments may also work with
int vectors of the same length and int size. <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> are the two
values that will undergo unsigned fixed point multiplication. The argument
<code class="docutils literal notranslate"><span class="pre">%scale</span></code> represents the scale of both operands, and must be a constant
integer.</p>
</div>
<div class="section" id="id715">
<h5><a class="toc-backref" href="#id2478">Semantics:</a><a class="headerlink" href="#id715" title="Permalink to this headline">¶</a></h5>
<p>This operation performs unsigned fixed point multiplication on the 2 arguments of a
specified scale. The result will also be returned in the same scale specified
in the third argument.</p>
<p>If the result value cannot be precisely represented in the given scale, the
value is rounded up or down to the closest representable value. The rounding
direction is unspecified.</p>
<p>It is undefined behavior if the result value does not fit within the range of
the fixed point type.</p>
</div>
<div class="section" id="id716">
<h5><a class="toc-backref" href="#id2479">Examples</a><a class="headerlink" href="#id716" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.umul.fix.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">0</span><span class="p">)</span> <span class="c">; %res = 6 (2 x 3 = 6)</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.umul.fix.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = 3 (1.5 x 1 = 1.5)</span>
<span class="c">; The result in the following could be rounded down to 3.5 or up to 4</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.umul.fix.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">15</span><span class="p">,</span> <span class="k">i4</span> <span class="m">1</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = 7 (or 8) (7.5 x 0.5 = 3.75)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-smul-fix-sat-intrinsics">
<h4><a class="toc-backref" href="#id2480">‘<code class="docutils literal notranslate"><span class="pre">llvm.smul.fix.sat.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-smul-fix-sat-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id717">
<h5><a class="toc-backref" href="#id2481">Syntax</a><a class="headerlink" href="#id717" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.smul.fix.sat</span></code>
on any integer bit width or vectors of integers.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">smul</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i16</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">smul</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</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">smul</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">smul</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id718">
<h5><a class="toc-backref" href="#id2482">Overview</a><a class="headerlink" href="#id718" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.smul.fix.sat</span></code>’ family of intrinsic functions perform signed
fixed point saturating multiplication on 2 arguments of the same scale.</p>
</div>
<div class="section" id="id719">
<h5><a class="toc-backref" href="#id2483">Arguments</a><a class="headerlink" href="#id719" title="Permalink to this headline">¶</a></h5>
<p>The arguments (%a and %b) and the result may be of integer types of any bit
width, but they must have the same bit width. <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> are the two
values that will undergo signed fixed point multiplication. The argument
<code class="docutils literal notranslate"><span class="pre">%scale</span></code> represents the scale of both operands, and must be a constant
integer.</p>
</div>
<div class="section" id="id720">
<h5><a class="toc-backref" href="#id2484">Semantics:</a><a class="headerlink" href="#id720" title="Permalink to this headline">¶</a></h5>
<p>This operation performs fixed point multiplication on the 2 arguments of a
specified scale. The result will also be returned in the same scale specified
in the third argument.</p>
<p>If the result value cannot be precisely represented in the given scale, the
value is rounded up or down to the closest representable value. The rounding
direction is unspecified.</p>
<p>The maximum value this operation can clamp to is the largest signed value
representable by the bit width of the first 2 arguments. The minimum value is the
smallest signed value representable by this bit width.</p>
</div>
<div class="section" id="id721">
<h5><a class="toc-backref" href="#id2485">Examples</a><a class="headerlink" href="#id721" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.smul.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">0</span><span class="p">)</span> <span class="c">; %res = 6 (2 x 3 = 6)</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.smul.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = 3 (1.5 x 1 = 1.5)</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.smul.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">-2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = -3 (1.5 x -1 = -1.5)</span>
<span class="c">; The result in the following could be rounded up to -2 or down to -2.5</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.smul.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">-3</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = -5 (or -4) (1.5 x -1.5 = -2.25)</span>
<span class="c">; Saturation</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.smul.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">7</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">0</span><span class="p">)</span> <span class="c">; %res = 7</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.smul.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">7</span><span class="p">,</span> <span class="k">i4</span> <span class="m">4</span><span class="p">,</span> <span class="k">i32</span> <span class="m">2</span><span class="p">)</span> <span class="c">; %res = 7</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.smul.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">-8</span><span class="p">,</span> <span class="k">i4</span> <span class="m">5</span><span class="p">,</span> <span class="k">i32</span> <span class="m">2</span><span class="p">)</span> <span class="c">; %res = -8</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.smul.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">-8</span><span class="p">,</span> <span class="k">i4</span> <span class="m">-2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = 7</span>
<span class="c">; Scale can affect the saturation result</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.smul.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i4</span> <span class="m">4</span><span class="p">,</span> <span class="k">i32</span> <span class="m">0</span><span class="p">)</span> <span class="c">; %res = 7 (2 x 4 -> clamped to 7)</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.smul.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i4</span> <span class="m">4</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = 4 (1 x 2 = 2)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-umul-fix-sat-intrinsics">
<h4><a class="toc-backref" href="#id2486">‘<code class="docutils literal notranslate"><span class="pre">llvm.umul.fix.sat.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-umul-fix-sat-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id722">
<h5><a class="toc-backref" href="#id2487">Syntax</a><a class="headerlink" href="#id722" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.umul.fix.sat</span></code>
on any integer bit width or vectors of integers.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">umul</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i16</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">umul</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</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">umul</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">umul</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id723">
<h5><a class="toc-backref" href="#id2488">Overview</a><a class="headerlink" href="#id723" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.umul.fix.sat</span></code>’ family of intrinsic functions perform unsigned
fixed point saturating multiplication on 2 arguments of the same scale.</p>
</div>
<div class="section" id="id724">
<h5><a class="toc-backref" href="#id2489">Arguments</a><a class="headerlink" href="#id724" title="Permalink to this headline">¶</a></h5>
<p>The arguments (%a and %b) and the result may be of integer types of any bit
width, but they must have the same bit width. <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> are the two
values that will undergo unsigned fixed point multiplication. The argument
<code class="docutils literal notranslate"><span class="pre">%scale</span></code> represents the scale of both operands, and must be a constant
integer.</p>
</div>
<div class="section" id="id725">
<h5><a class="toc-backref" href="#id2490">Semantics:</a><a class="headerlink" href="#id725" title="Permalink to this headline">¶</a></h5>
<p>This operation performs fixed point multiplication on the 2 arguments of a
specified scale. The result will also be returned in the same scale specified
in the third argument.</p>
<p>If the result value cannot be precisely represented in the given scale, the
value is rounded up or down to the closest representable value. The rounding
direction is unspecified.</p>
<p>The maximum value this operation can clamp to is the largest unsigned value
representable by the bit width of the first 2 arguments. The minimum value is the
smallest unsigned value representable by this bit width (zero).</p>
</div>
<div class="section" id="id726">
<h5><a class="toc-backref" href="#id2491">Examples</a><a class="headerlink" href="#id726" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.umul.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">0</span><span class="p">)</span> <span class="c">; %res = 6 (2 x 3 = 6)</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.umul.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = 3 (1.5 x 1 = 1.5)</span>
<span class="c">; The result in the following could be rounded down to 2 or up to 2.5</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.umul.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = 4 (or 5) (1.5 x 1.5 = 2.25)</span>
<span class="c">; Saturation</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.umul.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">8</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">0</span><span class="p">)</span> <span class="c">; %res = 15 (8 x 2 -> clamped to 15)</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.umul.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">8</span><span class="p">,</span> <span class="k">i4</span> <span class="m">8</span><span class="p">,</span> <span class="k">i32</span> <span class="m">2</span><span class="p">)</span> <span class="c">; %res = 15 (2 x 2 -> clamped to 3.75)</span>
<span class="c">; Scale can affect the saturation result</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.umul.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i4</span> <span class="m">4</span><span class="p">,</span> <span class="k">i32</span> <span class="m">0</span><span class="p">)</span> <span class="c">; %res = 7 (2 x 4 -> clamped to 7)</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.umul.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i4</span> <span class="m">4</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = 4 (1 x 2 = 2)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-sdiv-fix-intrinsics">
<h4><a class="toc-backref" href="#id2492">‘<code class="docutils literal notranslate"><span class="pre">llvm.sdiv.fix.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-sdiv-fix-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id727">
<h5><a class="toc-backref" href="#id2493">Syntax</a><a class="headerlink" href="#id727" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.sdiv.fix</span></code>
on any integer bit width or vectors of integers.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sdiv</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i16</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sdiv</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</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">sdiv</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sdiv</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id728">
<h5><a class="toc-backref" href="#id2494">Overview</a><a class="headerlink" href="#id728" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.sdiv.fix</span></code>’ family of intrinsic functions perform signed
fixed point division on 2 arguments of the same scale.</p>
</div>
<div class="section" id="id729">
<h5><a class="toc-backref" href="#id2495">Arguments</a><a class="headerlink" href="#id729" title="Permalink to this headline">¶</a></h5>
<p>The arguments (%a and %b) and the result may be of integer types of any bit
width, but they must have the same bit width. The arguments may also work with
int vectors of the same length and int size. <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> are the two
values that will undergo signed fixed point division. The argument
<code class="docutils literal notranslate"><span class="pre">%scale</span></code> represents the scale of both operands, and must be a constant
integer.</p>
</div>
<div class="section" id="id730">
<h5><a class="toc-backref" href="#id2496">Semantics:</a><a class="headerlink" href="#id730" title="Permalink to this headline">¶</a></h5>
<p>This operation performs fixed point division on the 2 arguments of a
specified scale. The result will also be returned in the same scale specified
in the third argument.</p>
<p>If the result value cannot be precisely represented in the given scale, the
value is rounded up or down to the closest representable value. The rounding
direction is unspecified.</p>
<p>It is undefined behavior if the result value does not fit within the range of
the fixed point type, or if the second argument is zero.</p>
</div>
<div class="section" id="id731">
<h5><a class="toc-backref" href="#id2497">Examples</a><a class="headerlink" href="#id731" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.sdiv.fix.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">6</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">0</span><span class="p">)</span> <span class="c">; %res = 3 (6 / 2 = 3)</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.sdiv.fix.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">6</span><span class="p">,</span> <span class="k">i4</span> <span class="m">4</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = 3 (3 / 2 = 1.5)</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.sdiv.fix.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">-2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = -3 (1.5 / -1 = -1.5)</span>
<span class="c">; The result in the following could be rounded up to 1 or down to 0.5</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.sdiv.fix.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">4</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = 2 (or 1) (1.5 / 2 = 0.75)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-udiv-fix-intrinsics">
<h4><a class="toc-backref" href="#id2498">‘<code class="docutils literal notranslate"><span class="pre">llvm.udiv.fix.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-udiv-fix-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id732">
<h5><a class="toc-backref" href="#id2499">Syntax</a><a class="headerlink" href="#id732" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.udiv.fix</span></code>
on any integer bit width or vectors of integers.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">udiv</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i16</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">udiv</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</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">udiv</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">udiv</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id733">
<h5><a class="toc-backref" href="#id2500">Overview</a><a class="headerlink" href="#id733" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.udiv.fix</span></code>’ family of intrinsic functions perform unsigned
fixed point division on 2 arguments of the same scale.</p>
</div>
<div class="section" id="id734">
<h5><a class="toc-backref" href="#id2501">Arguments</a><a class="headerlink" href="#id734" title="Permalink to this headline">¶</a></h5>
<p>The arguments (%a and %b) and the result may be of integer types of any bit
width, but they must have the same bit width. The arguments may also work with
int vectors of the same length and int size. <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> are the two
values that will undergo unsigned fixed point division. The argument
<code class="docutils literal notranslate"><span class="pre">%scale</span></code> represents the scale of both operands, and must be a constant
integer.</p>
</div>
<div class="section" id="id735">
<h5><a class="toc-backref" href="#id2502">Semantics:</a><a class="headerlink" href="#id735" title="Permalink to this headline">¶</a></h5>
<p>This operation performs fixed point division on the 2 arguments of a
specified scale. The result will also be returned in the same scale specified
in the third argument.</p>
<p>If the result value cannot be precisely represented in the given scale, the
value is rounded up or down to the closest representable value. The rounding
direction is unspecified.</p>
<p>It is undefined behavior if the result value does not fit within the range of
the fixed point type, or if the second argument is zero.</p>
</div>
<div class="section" id="id736">
<h5><a class="toc-backref" href="#id2503">Examples</a><a class="headerlink" href="#id736" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.udiv.fix.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">6</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">0</span><span class="p">)</span> <span class="c">; %res = 3 (6 / 2 = 3)</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.udiv.fix.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">6</span><span class="p">,</span> <span class="k">i4</span> <span class="m">4</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = 3 (3 / 2 = 1.5)</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.udiv.fix.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">1</span><span class="p">,</span> <span class="k">i4</span> <span class="m">-8</span><span class="p">,</span> <span class="k">i32</span> <span class="m">4</span><span class="p">)</span> <span class="c">; %res = 2 (0.0625 / 0.5 = 0.125)</span>
<span class="c">; The result in the following could be rounded up to 1 or down to 0.5</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.udiv.fix.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">4</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = 2 (or 1) (1.5 / 2 = 0.75)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-sdiv-fix-sat-intrinsics">
<h4><a class="toc-backref" href="#id2504">‘<code class="docutils literal notranslate"><span class="pre">llvm.sdiv.fix.sat.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-sdiv-fix-sat-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id737">
<h5><a class="toc-backref" href="#id2505">Syntax</a><a class="headerlink" href="#id737" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.sdiv.fix.sat</span></code>
on any integer bit width or vectors of integers.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sdiv</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i16</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sdiv</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</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">sdiv</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">sdiv</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id738">
<h5><a class="toc-backref" href="#id2506">Overview</a><a class="headerlink" href="#id738" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.sdiv.fix.sat</span></code>’ family of intrinsic functions perform signed
fixed point saturating division on 2 arguments of the same scale.</p>
</div>
<div class="section" id="id739">
<h5><a class="toc-backref" href="#id2507">Arguments</a><a class="headerlink" href="#id739" title="Permalink to this headline">¶</a></h5>
<p>The arguments (%a and %b) and the result may be of integer types of any bit
width, but they must have the same bit width. <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> are the two
values that will undergo signed fixed point division. The argument
<code class="docutils literal notranslate"><span class="pre">%scale</span></code> represents the scale of both operands, and must be a constant
integer.</p>
</div>
<div class="section" id="id740">
<h5><a class="toc-backref" href="#id2508">Semantics:</a><a class="headerlink" href="#id740" title="Permalink to this headline">¶</a></h5>
<p>This operation performs fixed point division on the 2 arguments of a
specified scale. The result will also be returned in the same scale specified
in the third argument.</p>
<p>If the result value cannot be precisely represented in the given scale, the
value is rounded up or down to the closest representable value. The rounding
direction is unspecified.</p>
<p>The maximum value this operation can clamp to is the largest signed value
representable by the bit width of the first 2 arguments. The minimum value is the
smallest signed value representable by this bit width.</p>
<p>It is undefined behavior if the second argument is zero.</p>
</div>
<div class="section" id="id741">
<h5><a class="toc-backref" href="#id2509">Examples</a><a class="headerlink" href="#id741" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.sdiv.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">6</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">0</span><span class="p">)</span> <span class="c">; %res = 3 (6 / 2 = 3)</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.sdiv.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">6</span><span class="p">,</span> <span class="k">i4</span> <span class="m">4</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = 3 (3 / 2 = 1.5)</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.sdiv.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">-2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = -3 (1.5 / -1 = -1.5)</span>
<span class="c">; The result in the following could be rounded up to 1 or down to 0.5</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.sdiv.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">4</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = 2 (or 1) (1.5 / 2 = 0.75)</span>
<span class="c">; Saturation</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.sdiv.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">-8</span><span class="p">,</span> <span class="k">i4</span> <span class="m">-1</span><span class="p">,</span> <span class="k">i32</span> <span class="m">0</span><span class="p">)</span> <span class="c">; %res = 7 (-8 / -1 = 8 => 7)</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.sdiv.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">4</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">2</span><span class="p">)</span> <span class="c">; %res = 7 (1 / 0.5 = 2 => 1.75)</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.sdiv.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">-4</span><span class="p">,</span> <span class="k">i4</span> <span class="m">1</span><span class="p">,</span> <span class="k">i32</span> <span class="m">2</span><span class="p">)</span> <span class="c">; %res = -8 (-1 / 0.25 = -4 => -2)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-udiv-fix-sat-intrinsics">
<h4><a class="toc-backref" href="#id2510">‘<code class="docutils literal notranslate"><span class="pre">llvm.udiv.fix.sat.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-udiv-fix-sat-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id742">
<h5><a class="toc-backref" href="#id2511">Syntax</a><a class="headerlink" href="#id742" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.udiv.fix.sat</span></code>
on any integer bit width or vectors of integers.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">udiv</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i16</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">udiv</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</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">udiv</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">udiv</span><span class="o">.</span><span class="n">fix</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">scale</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id743">
<h5><a class="toc-backref" href="#id2512">Overview</a><a class="headerlink" href="#id743" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.udiv.fix.sat</span></code>’ family of intrinsic functions perform unsigned
fixed point saturating division on 2 arguments of the same scale.</p>
</div>
<div class="section" id="id744">
<h5><a class="toc-backref" href="#id2513">Arguments</a><a class="headerlink" href="#id744" title="Permalink to this headline">¶</a></h5>
<p>The arguments (%a and %b) and the result may be of integer types of any bit
width, but they must have the same bit width. <code class="docutils literal notranslate"><span class="pre">%a</span></code> and <code class="docutils literal notranslate"><span class="pre">%b</span></code> are the two
values that will undergo unsigned fixed point division. The argument
<code class="docutils literal notranslate"><span class="pre">%scale</span></code> represents the scale of both operands, and must be a constant
integer.</p>
</div>
<div class="section" id="id745">
<h5><a class="toc-backref" href="#id2514">Semantics:</a><a class="headerlink" href="#id745" title="Permalink to this headline">¶</a></h5>
<p>This operation performs fixed point division on the 2 arguments of a
specified scale. The result will also be returned in the same scale specified
in the third argument.</p>
<p>If the result value cannot be precisely represented in the given scale, the
value is rounded up or down to the closest representable value. The rounding
direction is unspecified.</p>
<p>The maximum value this operation can clamp to is the largest unsigned value
representable by the bit width of the first 2 arguments. The minimum value is the
smallest unsigned value representable by this bit width (zero).</p>
<p>It is undefined behavior if the second argument is zero.</p>
</div>
<div class="section" id="id746">
<h5><a class="toc-backref" href="#id2515">Examples</a><a class="headerlink" href="#id746" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.udiv.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">6</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">0</span><span class="p">)</span> <span class="c">; %res = 3 (6 / 2 = 3)</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.udiv.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">6</span><span class="p">,</span> <span class="k">i4</span> <span class="m">4</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = 3 (3 / 2 = 1.5)</span>
<span class="c">; The result in the following could be rounded down to 0.5 or up to 1</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.udiv.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">3</span><span class="p">,</span> <span class="k">i4</span> <span class="m">4</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">)</span> <span class="c">; %res = 1 (or 2) (1.5 / 2 = 0.75)</span>
<span class="c">; Saturation</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i4</span> <span class="vg">@llvm.udiv.fix.sat.i4</span><span class="p">(</span><span class="k">i4</span> <span class="m">8</span><span class="p">,</span> <span class="k">i4</span> <span class="m">2</span><span class="p">,</span> <span class="k">i32</span> <span class="m">2</span><span class="p">)</span> <span class="c">; %res = 15 (2 / 0.5 = 4 => 3.75)</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="specialised-arithmetic-intrinsics">
<h3><a class="toc-backref" href="#id2516">Specialised Arithmetic Intrinsics</a><a class="headerlink" href="#specialised-arithmetic-intrinsics" title="Permalink to this headline">¶</a></h3>
<div class="section" id="llvm-canonicalize-intrinsic">
<span id="i-intr-llvm-canonicalize"></span><h4><a class="toc-backref" href="#id2517">‘<code class="docutils literal notranslate"><span class="pre">llvm.canonicalize.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-canonicalize-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id747">
<h5><a class="toc-backref" href="#id2518">Syntax:</a><a class="headerlink" href="#id747" 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="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">canonicalize</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">canonicalize</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">b</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id748">
<h5><a class="toc-backref" href="#id2519">Overview:</a><a class="headerlink" href="#id748" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.canonicalize.*</span></code>’ intrinsic returns the platform specific canonical
encoding of a floating-point number. This canonicalization is useful for
implementing certain numeric primitives such as frexp. The canonical encoding is
defined by IEEE-754-2008 to be:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mf">2.1</span><span class="o">.</span><span class="mi">8</span> <span class="n">canonical</span> <span class="n">encoding</span><span class="p">:</span> <span class="n">The</span> <span class="n">preferred</span> <span class="n">encoding</span> <span class="n">of</span> <span class="n">a</span> <span class="n">floating</span><span class="o">-</span><span class="n">point</span>
<span class="n">representation</span> <span class="ow">in</span> <span class="n">a</span> <span class="nb">format</span><span class="o">.</span> <span class="n">Applied</span> <span class="n">to</span> <span class="n">declets</span><span class="p">,</span> <span class="n">significands</span> <span class="n">of</span> <span class="n">finite</span>
<span class="n">numbers</span><span class="p">,</span> <span class="n">infinities</span><span class="p">,</span> <span class="ow">and</span> <span class="n">NaNs</span><span class="p">,</span> <span class="n">especially</span> <span class="ow">in</span> <span class="n">decimal</span> <span class="n">formats</span><span class="o">.</span>
</pre></div>
</div>
<p>This operation can also be considered equivalent to the IEEE-754-2008
conversion of a floating-point value to the same format. NaNs are handled
according to section 6.2.</p>
<p>Examples of non-canonical encodings:</p>
<ul class="simple">
<li><p>x87 pseudo denormals, pseudo NaNs, pseudo Infinity, Unnormals. These are
converted to a canonical representation per hardware-specific protocol.</p></li>
<li><p>Many normal decimal floating-point numbers have non-canonical alternative
encodings.</p></li>
<li><p>Some machines, like GPUs or ARMv7 NEON, do not support subnormal values.
These are treated as non-canonical encodings of zero and will be flushed to
a zero of the same sign by this operation.</p></li>
</ul>
<p>Note that per IEEE-754-2008 6.2, systems that support signaling NaNs with
default exception handling must signal an invalid exception, and produce a
quiet NaN result.</p>
<p>This function should always be implementable as multiplication by 1.0, provided
that the compiler does not constant fold the operation. Likewise, division by
1.0 and <code class="docutils literal notranslate"><span class="pre">llvm.minnum(x,</span> <span class="pre">x)</span></code> are possible implementations. Addition with
-0.0 is also sufficient provided that the rounding mode is not -Infinity.</p>
<p><code class="docutils literal notranslate"><span class="pre">@llvm.canonicalize</span></code> must preserve the equality relation. That is:</p>
<ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">(@llvm.canonicalize(x)</span> <span class="pre">==</span> <span class="pre">x)</span></code> is equivalent to <code class="docutils literal notranslate"><span class="pre">(x</span> <span class="pre">==</span> <span class="pre">x)</span></code></p></li>
<li><p><code class="docutils literal notranslate"><span class="pre">(@llvm.canonicalize(x)</span> <span class="pre">==</span> <span class="pre">@llvm.canonicalize(y))</span></code> is equivalent to
to <code class="docutils literal notranslate"><span class="pre">(x</span> <span class="pre">==</span> <span class="pre">y)</span></code></p></li>
</ul>
<p>Additionally, the sign of zero must be conserved:
<code class="docutils literal notranslate"><span class="pre">@llvm.canonicalize(-0.0)</span> <span class="pre">=</span> <span class="pre">-0.0</span></code> and <code class="docutils literal notranslate"><span class="pre">@llvm.canonicalize(+0.0)</span> <span class="pre">=</span> <span class="pre">+0.0</span></code></p>
<p>The payload bits of a NaN must be conserved, with two exceptions.
First, environments which use only a single canonical representation of NaN
must perform said canonicalization. Second, SNaNs must be quieted per the
usual methods.</p>
<p>The canonicalization operation may be optimized away if:</p>
<ul class="simple">
<li><p>The input is known to be canonical. For example, it was produced by a
floating-point operation that is required by the standard to be canonical.</p></li>
<li><p>The result is consumed only by (or fused with) other floating-point
operations. That is, the bits of the floating-point value are not examined.</p></li>
</ul>
</div>
</div>
<div class="section" id="llvm-fmuladd-intrinsic">
<h4><a class="toc-backref" href="#id2520">‘<code class="docutils literal notranslate"><span class="pre">llvm.fmuladd.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-fmuladd-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id749">
<h5><a class="toc-backref" href="#id2521">Syntax:</a><a class="headerlink" href="#id749" 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="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">fmuladd</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="nb">float</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="nb">float</span> <span class="o">%</span><span class="n">c</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">fmuladd</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="n">double</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="n">double</span> <span class="o">%</span><span class="n">c</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id750">
<h5><a class="toc-backref" href="#id2522">Overview:</a><a class="headerlink" href="#id750" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.fmuladd.*</span></code>’ intrinsic functions represent multiply-add
expressions that can be fused if the code generator determines that (a) the
target instruction set has support for a fused operation, and (b) that the
fused operation is more efficient than the equivalent, separate pair of mul
and add instructions.</p>
</div>
<div class="section" id="id751">
<h5><a class="toc-backref" href="#id2523">Arguments:</a><a class="headerlink" href="#id751" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.fmuladd.*</span></code>’ intrinsics each take three arguments: two
multiplicands, a and b, and an addend c.</p>
</div>
<div class="section" id="id752">
<h5><a class="toc-backref" href="#id2524">Semantics:</a><a class="headerlink" href="#id752" title="Permalink to this headline">¶</a></h5>
<p>The expression:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="mi">0</span> <span class="o">=</span> <span class="n">call</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">fmuladd</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="o">%</span><span class="n">c</span><span class="p">)</span>
</pre></div>
</div>
<p>is equivalent to the expression a * b + c, except that it is unspecified
whether rounding will be performed between the multiplication and addition
steps. Fusion is not guaranteed, even if the target platform supports it.
If a fused multiply-add is required, the corresponding
<a class="reference internal" href="#int-fma"><span class="std std-ref">llvm.fma</span></a> intrinsic function should be used instead.
This never sets errno, just as ‘<code class="docutils literal notranslate"><span class="pre">llvm.fma.*</span></code>’.</p>
</div>
<div class="section" id="id753">
<h5><a class="toc-backref" href="#id2525">Examples:</a><a class="headerlink" href="#id753" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r2</span> <span class="p">=</span> <span class="k">call</span> <span class="k">float</span> <span class="vg">@llvm.fmuladd.f32</span><span class="p">(</span><span class="k">float</span> <span class="nv">%a</span><span class="p">,</span> <span class="k">float</span> <span class="nv">%b</span><span class="p">,</span> <span class="k">float</span> <span class="nv">%c</span><span class="p">)</span> <span class="c">; yields float:r2 = (a * b) + c</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="hardware-loop-intrinsics">
<h3><a class="toc-backref" href="#id2526">Hardware-Loop Intrinsics</a><a class="headerlink" href="#hardware-loop-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>LLVM support several intrinsics to mark a loop as a hardware-loop. They are
hints to the backend which are required to lower these intrinsics further to target
specific instructions, or revert the hardware-loop to a normal loop if target
specific restriction are not met and a hardware-loop can’t be generated.</p>
<p>These intrinsics may be modified in the future and are not intended to be used
outside the backend. Thus, front-end and mid-level optimizations should not be
generating these intrinsics.</p>
<div class="section" id="llvm-set-loop-iterations-intrinsic">
<h4><a class="toc-backref" href="#id2527">‘<code class="docutils literal notranslate"><span class="pre">llvm.set.loop.iterations.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-set-loop-iterations-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id754">
<h5><a class="toc-backref" href="#id2528">Syntax:</a><a class="headerlink" href="#id754" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<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">set</span><span class="o">.</span><span class="n">loop</span><span class="o">.</span><span class="n">iterations</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">void</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">set</span><span class="o">.</span><span class="n">loop</span><span class="o">.</span><span class="n">iterations</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id755">
<h5><a class="toc-backref" href="#id2529">Overview:</a><a class="headerlink" href="#id755" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.set.loop.iterations.*</span></code>’ intrinsics are used to specify the
hardware-loop trip count. They are placed in the loop preheader basic block and
are marked as <code class="docutils literal notranslate"><span class="pre">IntrNoDuplicate</span></code> to avoid optimizers duplicating these
instructions.</p>
</div>
<div class="section" id="id756">
<h5><a class="toc-backref" href="#id2530">Arguments:</a><a class="headerlink" href="#id756" title="Permalink to this headline">¶</a></h5>
<p>The integer operand is the loop trip count of the hardware-loop, and thus
not e.g. the loop back-edge taken count.</p>
</div>
<div class="section" id="id757">
<h5><a class="toc-backref" href="#id2531">Semantics:</a><a class="headerlink" href="#id757" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.set.loop.iterations.*</span></code>’ intrinsics do not perform any arithmetic
on their operand. It’s a hint to the backend that can use this to set up the
hardware-loop count with a target specific instruction, usually a move of this
value to a special register or a hardware-loop instruction.</p>
</div>
</div>
<div class="section" id="llvm-start-loop-iterations-intrinsic">
<h4><a class="toc-backref" href="#id2532">‘<code class="docutils literal notranslate"><span class="pre">llvm.start.loop.iterations.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-start-loop-iterations-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id758">
<h5><a class="toc-backref" href="#id2533">Syntax:</a><a class="headerlink" href="#id758" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<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">start</span><span class="o">.</span><span class="n">loop</span><span class="o">.</span><span class="n">iterations</span><span class="o">.</span><span class="n">i32</span><span class="p">(</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">start</span><span class="o">.</span><span class="n">loop</span><span class="o">.</span><span class="n">iterations</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id759">
<h5><a class="toc-backref" href="#id2534">Overview:</a><a class="headerlink" href="#id759" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.start.loop.iterations.*</span></code>’ intrinsics are similar to the
‘<code class="docutils literal notranslate"><span class="pre">llvm.set.loop.iterations.*</span></code>’ intrinsics, used to specify the
hardware-loop trip count but also produce a value identical to the input
that can be used as the input to the loop. They are placed in the loop
preheader basic block and the output is expected to be the input to the
phi for the induction variable of the loop, decremented by the
‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.decrement.reg.*</span></code>’.</p>
</div>
<div class="section" id="id760">
<h5><a class="toc-backref" href="#id2535">Arguments:</a><a class="headerlink" href="#id760" title="Permalink to this headline">¶</a></h5>
<p>The integer operand is the loop trip count of the hardware-loop, and thus
not e.g. the loop back-edge taken count.</p>
</div>
<div class="section" id="id761">
<h5><a class="toc-backref" href="#id2536">Semantics:</a><a class="headerlink" href="#id761" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.start.loop.iterations.*</span></code>’ intrinsics do not perform any arithmetic
on their operand. It’s a hint to the backend that can use this to set up the
hardware-loop count with a target specific instruction, usually a move of this
value to a special register or a hardware-loop instruction.</p>
</div>
</div>
<div class="section" id="llvm-test-set-loop-iterations-intrinsic">
<h4><a class="toc-backref" href="#id2537">‘<code class="docutils literal notranslate"><span class="pre">llvm.test.set.loop.iterations.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-test-set-loop-iterations-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id762">
<h5><a class="toc-backref" href="#id2538">Syntax:</a><a class="headerlink" href="#id762" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<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">test</span><span class="o">.</span><span class="n">set</span><span class="o">.</span><span class="n">loop</span><span class="o">.</span><span class="n">iterations</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i1</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">test</span><span class="o">.</span><span class="n">set</span><span class="o">.</span><span class="n">loop</span><span class="o">.</span><span class="n">iterations</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id763">
<h5><a class="toc-backref" href="#id2539">Overview:</a><a class="headerlink" href="#id763" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.test.set.loop.iterations.*</span></code>’ intrinsics are used to specify the
the loop trip count, and also test that the given count is not zero, allowing
it to control entry to a while-loop. They are placed in the loop preheader’s
predecessor basic block, and are marked as <code class="docutils literal notranslate"><span class="pre">IntrNoDuplicate</span></code> to avoid
optimizers duplicating these instructions.</p>
</div>
<div class="section" id="id764">
<h5><a class="toc-backref" href="#id2540">Arguments:</a><a class="headerlink" href="#id764" title="Permalink to this headline">¶</a></h5>
<p>The integer operand is the loop trip count of the hardware-loop, and thus
not e.g. the loop back-edge taken count.</p>
</div>
<div class="section" id="id765">
<h5><a class="toc-backref" href="#id2541">Semantics:</a><a class="headerlink" href="#id765" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.test.set.loop.iterations.*</span></code>’ intrinsics do not perform any
arithmetic on their operand. It’s a hint to the backend that can use this to
set up the hardware-loop count with a target specific instruction, usually a
move of this value to a special register or a hardware-loop instruction.
The result is the conditional value of whether the given count is not zero.</p>
</div>
</div>
<div class="section" id="llvm-test-start-loop-iterations-intrinsic">
<h4><a class="toc-backref" href="#id2542">‘<code class="docutils literal notranslate"><span class="pre">llvm.test.start.loop.iterations.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-test-start-loop-iterations-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id766">
<h5><a class="toc-backref" href="#id2543">Syntax:</a><a class="headerlink" href="#id766" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="p">{</span><span class="n">i32</span><span class="p">,</span> <span class="n">i1</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">test</span><span class="o">.</span><span class="n">start</span><span class="o">.</span><span class="n">loop</span><span class="o">.</span><span class="n">iterations</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span><span class="p">)</span>
<span class="n">declare</span> <span class="p">{</span><span class="n">i64</span><span class="p">,</span> <span class="n">i1</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">test</span><span class="o">.</span><span class="n">start</span><span class="o">.</span><span class="n">loop</span><span class="o">.</span><span class="n">iterations</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id767">
<h5><a class="toc-backref" href="#id2544">Overview:</a><a class="headerlink" href="#id767" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.test.start.loop.iterations.*</span></code>’ intrinsics are similar to the
‘<code class="docutils literal notranslate"><span class="pre">llvm.test.set.loop.iterations.*</span></code>’ and ‘<code class="docutils literal notranslate"><span class="pre">llvm.start.loop.iterations.*</span></code>’
intrinsics, used to specify the hardware-loop trip count, but also produce a
value identical to the input that can be used as the input to the loop. The
second i1 output controls entry to a while-loop.</p>
</div>
<div class="section" id="id768">
<h5><a class="toc-backref" href="#id2545">Arguments:</a><a class="headerlink" href="#id768" title="Permalink to this headline">¶</a></h5>
<p>The integer operand is the loop trip count of the hardware-loop, and thus
not e.g. the loop back-edge taken count.</p>
</div>
<div class="section" id="id769">
<h5><a class="toc-backref" href="#id2546">Semantics:</a><a class="headerlink" href="#id769" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.test.start.loop.iterations.*</span></code>’ intrinsics do not perform any
arithmetic on their operand. It’s a hint to the backend that can use this to
set up the hardware-loop count with a target specific instruction, usually a
move of this value to a special register or a hardware-loop instruction.
The result is a pair of the input and a conditional value of whether the
given count is not zero.</p>
</div>
</div>
<div class="section" id="llvm-loop-decrement-reg-intrinsic">
<h4><a class="toc-backref" href="#id2547">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.decrement.reg.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-loop-decrement-reg-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id770">
<h5><a class="toc-backref" href="#id2548">Syntax:</a><a class="headerlink" href="#id770" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<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">loop</span><span class="o">.</span><span class="n">decrement</span><span class="o">.</span><span class="n">reg</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span><span class="p">,</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">loop</span><span class="o">.</span><span class="n">decrement</span><span class="o">.</span><span class="n">reg</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span><span class="p">,</span> <span class="n">i64</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id771">
<h5><a class="toc-backref" href="#id2549">Overview:</a><a class="headerlink" href="#id771" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.decrement.reg.*</span></code>’ intrinsics are used to lower the loop
iteration counter and return an updated value that will be used in the next
loop test check.</p>
</div>
<div class="section" id="id772">
<h5><a class="toc-backref" href="#id2550">Arguments:</a><a class="headerlink" href="#id772" title="Permalink to this headline">¶</a></h5>
<p>Both arguments must have identical integer types. The first operand is the
loop iteration counter. The second operand is the maximum number of elements
processed in an iteration.</p>
</div>
<div class="section" id="id773">
<h5><a class="toc-backref" href="#id2551">Semantics:</a><a class="headerlink" href="#id773" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.decrement.reg.*</span></code>’ intrinsics do an integer <code class="docutils literal notranslate"><span class="pre">SUB</span></code> of its
two operands, which is not allowed to wrap. They return the remaining number of
iterations still to be executed, and can be used together with a <code class="docutils literal notranslate"><span class="pre">PHI</span></code>,
<code class="docutils literal notranslate"><span class="pre">ICMP</span></code> and <code class="docutils literal notranslate"><span class="pre">BR</span></code> to control the number of loop iterations executed. Any
optimisations are allowed to treat it is a <code class="docutils literal notranslate"><span class="pre">SUB</span></code>, and it is supported by
SCEV, so it’s the backends responsibility to handle cases where it may be
optimised. These intrinsics are marked as <code class="docutils literal notranslate"><span class="pre">IntrNoDuplicate</span></code> to avoid
optimizers duplicating these instructions.</p>
</div>
</div>
<div class="section" id="llvm-loop-decrement-intrinsic">
<h4><a class="toc-backref" href="#id2552">‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.decrement.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-loop-decrement-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id774">
<h5><a class="toc-backref" href="#id2553">Syntax:</a><a class="headerlink" href="#id774" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<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">loop</span><span class="o">.</span><span class="n">decrement</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i1</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">loop</span><span class="o">.</span><span class="n">decrement</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id775">
<h5><a class="toc-backref" href="#id2554">Overview:</a><a class="headerlink" href="#id775" title="Permalink to this headline">¶</a></h5>
<p>The HardwareLoops pass allows the loop decrement value to be specified with an
option. It defaults to a loop decrement value of 1, but it can be an unsigned
integer value provided by this option. The ‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.decrement.*</span></code>’
intrinsics decrement the loop iteration counter with this value, and return a
false predicate if the loop should exit, and true otherwise.
This is emitted if the loop counter is not updated via a <code class="docutils literal notranslate"><span class="pre">PHI</span></code> node, which
can also be controlled with an option.</p>
</div>
<div class="section" id="id776">
<h5><a class="toc-backref" href="#id2555">Arguments:</a><a class="headerlink" href="#id776" title="Permalink to this headline">¶</a></h5>
<p>The integer argument is the loop decrement value used to decrement the loop
iteration counter.</p>
</div>
<div class="section" id="id777">
<h5><a class="toc-backref" href="#id2556">Semantics:</a><a class="headerlink" href="#id777" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.loop.decrement.*</span></code>’ intrinsics do a <code class="docutils literal notranslate"><span class="pre">SUB</span></code> of the loop iteration
counter with the given loop decrement value, and return false if the loop
should exit, this <code class="docutils literal notranslate"><span class="pre">SUB</span></code> is not allowed to wrap. The result is a condition
that is used by the conditional branch controlling the loop.</p>
</div>
</div>
</div>
<div class="section" id="vector-reduction-intrinsics">
<h3><a class="toc-backref" href="#id2557">Vector Reduction Intrinsics</a><a class="headerlink" href="#vector-reduction-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>Horizontal reductions of vectors can be expressed using the following
intrinsics. Each one takes a vector operand as an input and applies its
respective operation across all elements of the vector, returning a single
scalar result of the same element type.</p>
<div class="section" id="llvm-vector-reduce-add-intrinsic">
<span id="int-vector-reduce-add"></span><h4><a class="toc-backref" href="#id2558">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.add.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-vector-reduce-add-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id778">
<h5><a class="toc-backref" href="#id2559">Syntax:</a><a class="headerlink" href="#id778" 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">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">add</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</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">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">add</span><span class="o">.</span><span class="n">v2i64</span><span class="p">(</span><span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id779">
<h5><a class="toc-backref" href="#id2560">Overview:</a><a class="headerlink" href="#id779" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.add.*</span></code>’ intrinsics do an integer <code class="docutils literal notranslate"><span class="pre">ADD</span></code>
reduction of a vector, returning the result as a scalar. The return type matches
the element-type of the vector input.</p>
</div>
<div class="section" id="id780">
<h5><a class="toc-backref" href="#id2561">Arguments:</a><a class="headerlink" href="#id780" title="Permalink to this headline">¶</a></h5>
<p>The argument to this intrinsic must be a vector of integer values.</p>
</div>
</div>
<div class="section" id="llvm-vector-reduce-fadd-intrinsic">
<span id="int-vector-reduce-fadd"></span><h4><a class="toc-backref" href="#id2562">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.fadd.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-vector-reduce-fadd-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id781">
<h5><a class="toc-backref" href="#id2563">Syntax:</a><a class="headerlink" href="#id781" 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="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">fadd</span><span class="o">.</span><span class="n">v4f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">start_value</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">fadd</span><span class="o">.</span><span class="n">v2f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">start_value</span><span class="p">,</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id782">
<h5><a class="toc-backref" href="#id2564">Overview:</a><a class="headerlink" href="#id782" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.fadd.*</span></code>’ intrinsics do a floating-point
<code class="docutils literal notranslate"><span class="pre">ADD</span></code> reduction of a vector, returning the result as a scalar. The return type
matches the element-type of the vector input.</p>
<p>If the intrinsic call has the ‘reassoc’ flag set, then the reduction will not
preserve the associativity of an equivalent scalarized counterpart. Otherwise
the reduction will be <em>sequential</em>, thus implying that the operation respects
the associativity of a scalarized reduction. That is, the reduction begins with
the start value and performs an fadd operation with consecutively increasing
vector element indices. See the following pseudocode:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">float</span> <span class="n">sequential_fadd</span><span class="p">(</span><span class="n">start_value</span><span class="p">,</span> <span class="n">input_vector</span><span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">start_value</span>
<span class="k">for</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span> <span class="n">to</span> <span class="n">length</span><span class="p">(</span><span class="n">input_vector</span><span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">result</span> <span class="o">+</span> <span class="n">input_vector</span><span class="p">[</span><span class="n">i</span><span class="p">]</span>
<span class="k">return</span> <span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id783">
<h5><a class="toc-backref" href="#id2565">Arguments:</a><a class="headerlink" href="#id783" title="Permalink to this headline">¶</a></h5>
<p>The first argument to this intrinsic is a scalar start value for the reduction.
The type of the start value matches the element-type of the vector input.
The second argument must be a vector of floating-point values.</p>
<p>To ignore the start value, negative zero (<code class="docutils literal notranslate"><span class="pre">-0.0</span></code>) can be used, as it is
the neutral value of floating point addition.</p>
</div>
<div class="section" id="id784">
<h5><a class="toc-backref" href="#id2566">Examples:</a><a class="headerlink" href="#id784" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">unord</span> <span class="o">=</span> <span class="n">call</span> <span class="n">reassoc</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">fadd</span><span class="o">.</span><span class="n">v4f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">-</span><span class="mf">0.0</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o">%</span><span class="nb">input</span><span class="p">)</span> <span class="p">;</span> <span class="n">relaxed</span> <span class="n">reduction</span>
<span class="o">%</span><span class="nb">ord</span> <span class="o">=</span> <span class="n">call</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">fadd</span><span class="o">.</span><span class="n">v4f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">start_value</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o">%</span><span class="nb">input</span><span class="p">)</span> <span class="p">;</span> <span class="n">sequential</span> <span class="n">reduction</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vector-reduce-mul-intrinsic">
<span id="int-vector-reduce-mul"></span><h4><a class="toc-backref" href="#id2567">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.mul.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-vector-reduce-mul-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id785">
<h5><a class="toc-backref" href="#id2568">Syntax:</a><a class="headerlink" href="#id785" 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">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">mul</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</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">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">mul</span><span class="o">.</span><span class="n">v2i64</span><span class="p">(</span><span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id786">
<h5><a class="toc-backref" href="#id2569">Overview:</a><a class="headerlink" href="#id786" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.mul.*</span></code>’ intrinsics do an integer <code class="docutils literal notranslate"><span class="pre">MUL</span></code>
reduction of a vector, returning the result as a scalar. The return type matches
the element-type of the vector input.</p>
</div>
<div class="section" id="id787">
<h5><a class="toc-backref" href="#id2570">Arguments:</a><a class="headerlink" href="#id787" title="Permalink to this headline">¶</a></h5>
<p>The argument to this intrinsic must be a vector of integer values.</p>
</div>
</div>
<div class="section" id="llvm-vector-reduce-fmul-intrinsic">
<span id="int-vector-reduce-fmul"></span><h4><a class="toc-backref" href="#id2571">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.fmul.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-vector-reduce-fmul-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id788">
<h5><a class="toc-backref" href="#id2572">Syntax:</a><a class="headerlink" href="#id788" 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="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">fmul</span><span class="o">.</span><span class="n">v4f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">start_value</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">fmul</span><span class="o">.</span><span class="n">v2f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">start_value</span><span class="p">,</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id789">
<h5><a class="toc-backref" href="#id2573">Overview:</a><a class="headerlink" href="#id789" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.fmul.*</span></code>’ intrinsics do a floating-point
<code class="docutils literal notranslate"><span class="pre">MUL</span></code> reduction of a vector, returning the result as a scalar. The return type
matches the element-type of the vector input.</p>
<p>If the intrinsic call has the ‘reassoc’ flag set, then the reduction will not
preserve the associativity of an equivalent scalarized counterpart. Otherwise
the reduction will be <em>sequential</em>, thus implying that the operation respects
the associativity of a scalarized reduction. That is, the reduction begins with
the start value and performs an fmul operation with consecutively increasing
vector element indices. See the following pseudocode:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="nb">float</span> <span class="n">sequential_fmul</span><span class="p">(</span><span class="n">start_value</span><span class="p">,</span> <span class="n">input_vector</span><span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">start_value</span>
<span class="k">for</span> <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span> <span class="n">to</span> <span class="n">length</span><span class="p">(</span><span class="n">input_vector</span><span class="p">)</span>
<span class="n">result</span> <span class="o">=</span> <span class="n">result</span> <span class="o">*</span> <span class="n">input_vector</span><span class="p">[</span><span class="n">i</span><span class="p">]</span>
<span class="k">return</span> <span class="n">result</span>
</pre></div>
</div>
</div>
<div class="section" id="id790">
<h5><a class="toc-backref" href="#id2574">Arguments:</a><a class="headerlink" href="#id790" title="Permalink to this headline">¶</a></h5>
<p>The first argument to this intrinsic is a scalar start value for the reduction.
The type of the start value matches the element-type of the vector input.
The second argument must be a vector of floating-point values.</p>
<p>To ignore the start value, one (<code class="docutils literal notranslate"><span class="pre">1.0</span></code>) can be used, as it is the neutral
value of floating point multiplication.</p>
</div>
<div class="section" id="id791">
<h5><a class="toc-backref" href="#id2575">Examples:</a><a class="headerlink" href="#id791" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">unord</span> <span class="o">=</span> <span class="n">call</span> <span class="n">reassoc</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">fmul</span><span class="o">.</span><span class="n">v4f32</span><span class="p">(</span><span class="nb">float</span> <span class="mf">1.0</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o">%</span><span class="nb">input</span><span class="p">)</span> <span class="p">;</span> <span class="n">relaxed</span> <span class="n">reduction</span>
<span class="o">%</span><span class="nb">ord</span> <span class="o">=</span> <span class="n">call</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">fmul</span><span class="o">.</span><span class="n">v4f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">start_value</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o">%</span><span class="nb">input</span><span class="p">)</span> <span class="p">;</span> <span class="n">sequential</span> <span class="n">reduction</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vector-reduce-and-intrinsic">
<span id="int-vector-reduce-and"></span><h4><a class="toc-backref" href="#id2576">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.and.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-vector-reduce-and-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id792">
<h5><a class="toc-backref" href="#id2577">Syntax:</a><a class="headerlink" href="#id792" 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">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="ow">and</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id793">
<h5><a class="toc-backref" href="#id2578">Overview:</a><a class="headerlink" href="#id793" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.and.*</span></code>’ intrinsics do a bitwise <code class="docutils literal notranslate"><span class="pre">AND</span></code>
reduction of a vector, returning the result as a scalar. The return type matches
the element-type of the vector input.</p>
</div>
<div class="section" id="id794">
<h5><a class="toc-backref" href="#id2579">Arguments:</a><a class="headerlink" href="#id794" title="Permalink to this headline">¶</a></h5>
<p>The argument to this intrinsic must be a vector of integer values.</p>
</div>
</div>
<div class="section" id="llvm-vector-reduce-or-intrinsic">
<span id="int-vector-reduce-or"></span><h4><a class="toc-backref" href="#id2580">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.or.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-vector-reduce-or-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id795">
<h5><a class="toc-backref" href="#id2581">Syntax:</a><a class="headerlink" href="#id795" 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">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="ow">or</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id796">
<h5><a class="toc-backref" href="#id2582">Overview:</a><a class="headerlink" href="#id796" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.or.*</span></code>’ intrinsics do a bitwise <code class="docutils literal notranslate"><span class="pre">OR</span></code> reduction
of a vector, returning the result as a scalar. The return type matches the
element-type of the vector input.</p>
</div>
<div class="section" id="id797">
<h5><a class="toc-backref" href="#id2583">Arguments:</a><a class="headerlink" href="#id797" title="Permalink to this headline">¶</a></h5>
<p>The argument to this intrinsic must be a vector of integer values.</p>
</div>
</div>
<div class="section" id="llvm-vector-reduce-xor-intrinsic">
<span id="int-vector-reduce-xor"></span><h4><a class="toc-backref" href="#id2584">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.xor.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-vector-reduce-xor-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id798">
<h5><a class="toc-backref" href="#id2585">Syntax:</a><a class="headerlink" href="#id798" 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">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">xor</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id799">
<h5><a class="toc-backref" href="#id2586">Overview:</a><a class="headerlink" href="#id799" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.xor.*</span></code>’ intrinsics do a bitwise <code class="docutils literal notranslate"><span class="pre">XOR</span></code>
reduction of a vector, returning the result as a scalar. The return type matches
the element-type of the vector input.</p>
</div>
<div class="section" id="id800">
<h5><a class="toc-backref" href="#id2587">Arguments:</a><a class="headerlink" href="#id800" title="Permalink to this headline">¶</a></h5>
<p>The argument to this intrinsic must be a vector of integer values.</p>
</div>
</div>
<div class="section" id="llvm-vector-reduce-smax-intrinsic">
<span id="int-vector-reduce-smax"></span><h4><a class="toc-backref" href="#id2588">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.smax.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-vector-reduce-smax-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id801">
<h5><a class="toc-backref" href="#id2589">Syntax:</a><a class="headerlink" href="#id801" 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">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">smax</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id802">
<h5><a class="toc-backref" href="#id2590">Overview:</a><a class="headerlink" href="#id802" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.smax.*</span></code>’ intrinsics do a signed integer
<code class="docutils literal notranslate"><span class="pre">MAX</span></code> reduction of a vector, returning the result as a scalar. The return type
matches the element-type of the vector input.</p>
</div>
<div class="section" id="id803">
<h5><a class="toc-backref" href="#id2591">Arguments:</a><a class="headerlink" href="#id803" title="Permalink to this headline">¶</a></h5>
<p>The argument to this intrinsic must be a vector of integer values.</p>
</div>
</div>
<div class="section" id="llvm-vector-reduce-smin-intrinsic">
<span id="int-vector-reduce-smin"></span><h4><a class="toc-backref" href="#id2592">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.smin.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-vector-reduce-smin-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id804">
<h5><a class="toc-backref" href="#id2593">Syntax:</a><a class="headerlink" href="#id804" 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">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">smin</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id805">
<h5><a class="toc-backref" href="#id2594">Overview:</a><a class="headerlink" href="#id805" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.smin.*</span></code>’ intrinsics do a signed integer
<code class="docutils literal notranslate"><span class="pre">MIN</span></code> reduction of a vector, returning the result as a scalar. The return type
matches the element-type of the vector input.</p>
</div>
<div class="section" id="id806">
<h5><a class="toc-backref" href="#id2595">Arguments:</a><a class="headerlink" href="#id806" title="Permalink to this headline">¶</a></h5>
<p>The argument to this intrinsic must be a vector of integer values.</p>
</div>
</div>
<div class="section" id="llvm-vector-reduce-umax-intrinsic">
<span id="int-vector-reduce-umax"></span><h4><a class="toc-backref" href="#id2596">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.umax.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-vector-reduce-umax-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id807">
<h5><a class="toc-backref" href="#id2597">Syntax:</a><a class="headerlink" href="#id807" 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">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">umax</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id808">
<h5><a class="toc-backref" href="#id2598">Overview:</a><a class="headerlink" href="#id808" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.umax.*</span></code>’ intrinsics do an unsigned
integer <code class="docutils literal notranslate"><span class="pre">MAX</span></code> reduction of a vector, returning the result as a scalar. The
return type matches the element-type of the vector input.</p>
</div>
<div class="section" id="id809">
<h5><a class="toc-backref" href="#id2599">Arguments:</a><a class="headerlink" href="#id809" title="Permalink to this headline">¶</a></h5>
<p>The argument to this intrinsic must be a vector of integer values.</p>
</div>
</div>
<div class="section" id="llvm-vector-reduce-umin-intrinsic">
<span id="int-vector-reduce-umin"></span><h4><a class="toc-backref" href="#id2600">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.umin.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-vector-reduce-umin-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id810">
<h5><a class="toc-backref" href="#id2601">Syntax:</a><a class="headerlink" href="#id810" 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">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">umin</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id811">
<h5><a class="toc-backref" href="#id2602">Overview:</a><a class="headerlink" href="#id811" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.umin.*</span></code>’ intrinsics do an unsigned
integer <code class="docutils literal notranslate"><span class="pre">MIN</span></code> reduction of a vector, returning the result as a scalar. The
return type matches the element-type of the vector input.</p>
</div>
<div class="section" id="id812">
<h5><a class="toc-backref" href="#id2603">Arguments:</a><a class="headerlink" href="#id812" title="Permalink to this headline">¶</a></h5>
<p>The argument to this intrinsic must be a vector of integer values.</p>
</div>
</div>
<div class="section" id="llvm-vector-reduce-fmax-intrinsic">
<span id="int-vector-reduce-fmax"></span><h4><a class="toc-backref" href="#id2604">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.fmax.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-vector-reduce-fmax-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id813">
<h5><a class="toc-backref" href="#id2605">Syntax:</a><a class="headerlink" href="#id813" 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="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">fmax</span><span class="o">.</span><span class="n">v4f32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">fmax</span><span class="o">.</span><span class="n">v2f64</span><span class="p">(</span><span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id814">
<h5><a class="toc-backref" href="#id2606">Overview:</a><a class="headerlink" href="#id814" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.fmax.*</span></code>’ intrinsics do a floating-point
<code class="docutils literal notranslate"><span class="pre">MAX</span></code> reduction of a vector, returning the result as a scalar. The return type
matches the element-type of the vector input.</p>
<p>This instruction has the same comparison semantics as the ‘<code class="docutils literal notranslate"><span class="pre">llvm.maxnum.*</span></code>’
intrinsic. That is, the result will always be a number unless all elements of
the vector are NaN. For a vector with maximum element magnitude 0.0 and
containing both +0.0 and -0.0 elements, the sign of the result is unspecified.</p>
<p>If the intrinsic call has the <code class="docutils literal notranslate"><span class="pre">nnan</span></code> fast-math flag, then the operation can
assume that NaNs are not present in the input vector.</p>
</div>
<div class="section" id="id815">
<h5><a class="toc-backref" href="#id2607">Arguments:</a><a class="headerlink" href="#id815" title="Permalink to this headline">¶</a></h5>
<p>The argument to this intrinsic must be a vector of floating-point values.</p>
</div>
</div>
<div class="section" id="llvm-vector-reduce-fmin-intrinsic">
<span id="int-vector-reduce-fmin"></span><h4><a class="toc-backref" href="#id2608">‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.fmin.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-vector-reduce-fmin-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id816">
<h5><a class="toc-backref" href="#id2609">Syntax:</a><a class="headerlink" href="#id816" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">fmin</span><span class="o">.</span><span class="n">v4f32</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">fmin</span><span class="o">.</span><span class="n">v2f64</span><span class="p">(</span><span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id817">
<h5><a class="toc-backref" href="#id2610">Overview:</a><a class="headerlink" href="#id817" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vector.reduce.fmin.*</span></code>’ intrinsics do a floating-point
<code class="docutils literal notranslate"><span class="pre">MIN</span></code> reduction of a vector, returning the result as a scalar. The return type
matches the element-type of the vector input.</p>
<p>This instruction has the same comparison semantics as the ‘<code class="docutils literal notranslate"><span class="pre">llvm.minnum.*</span></code>’
intrinsic. That is, the result will always be a number unless all elements of
the vector are NaN. For a vector with minimum element magnitude 0.0 and
containing both +0.0 and -0.0 elements, the sign of the result is unspecified.</p>
<p>If the intrinsic call has the <code class="docutils literal notranslate"><span class="pre">nnan</span></code> fast-math flag, then the operation can
assume that NaNs are not present in the input vector.</p>
</div>
<div class="section" id="id818">
<h5><a class="toc-backref" href="#id2611">Arguments:</a><a class="headerlink" href="#id818" title="Permalink to this headline">¶</a></h5>
<p>The argument to this intrinsic must be a vector of floating-point values.</p>
</div>
</div>
<div class="section" id="llvm-experimental-vector-insert-intrinsic">
<h4><a class="toc-backref" href="#id2612">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.vector.insert</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-vector-insert-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id819">
<h5><a class="toc-backref" href="#id2613">Syntax:</a><a class="headerlink" href="#id819" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.experimental.vector.insert</span></code>
to insert a fixed-width vector into a scalable vector, but not the other way
around.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">insert</span><span class="o">.</span><span class="n">v4f32</span><span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o">%</span><span class="n">vec</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o">%</span><span class="n">subvec</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">idx</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">2</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">insert</span><span class="o">.</span><span class="n">v2f64</span><span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">2</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o">%</span><span class="n">vec</span><span class="p">,</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o">%</span><span class="n">subvec</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">idx</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id820">
<h5><a class="toc-backref" href="#id2614">Overview:</a><a class="headerlink" href="#id820" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.vector.insert.*</span></code>’ intrinsics insert a vector into another vector
starting from a given index. The return type matches the type of the vector we
insert into. Conceptually, this can be used to build a scalable vector out of
non-scalable vectors.</p>
</div>
<div class="section" id="id821">
<h5><a class="toc-backref" href="#id2615">Arguments:</a><a class="headerlink" href="#id821" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">vec</span></code> is the vector which <code class="docutils literal notranslate"><span class="pre">subvec</span></code> will be inserted into.
The <code class="docutils literal notranslate"><span class="pre">subvec</span></code> is the vector that will be inserted.</p>
<p><code class="docutils literal notranslate"><span class="pre">idx</span></code> represents the starting element number at which <code class="docutils literal notranslate"><span class="pre">subvec</span></code> will be
inserted. <code class="docutils literal notranslate"><span class="pre">idx</span></code> must be a constant multiple of <code class="docutils literal notranslate"><span class="pre">subvec</span></code>’s known minimum
vector length. If <code class="docutils literal notranslate"><span class="pre">subvec</span></code> is a scalable vector, <code class="docutils literal notranslate"><span class="pre">idx</span></code> is first scaled by
the runtime scaling factor of <code class="docutils literal notranslate"><span class="pre">subvec</span></code>. The elements of <code class="docutils literal notranslate"><span class="pre">vec</span></code> starting at
<code class="docutils literal notranslate"><span class="pre">idx</span></code> are overwritten with <code class="docutils literal notranslate"><span class="pre">subvec</span></code>. Elements <code class="docutils literal notranslate"><span class="pre">idx</span></code> through (<code class="docutils literal notranslate"><span class="pre">idx</span></code> +
num_elements(<code class="docutils literal notranslate"><span class="pre">subvec</span></code>) - 1) must be valid <code class="docutils literal notranslate"><span class="pre">vec</span></code> indices. If this condition
cannot be determined statically but is false at runtime, then the result vector
is undefined.</p>
</div>
</div>
<div class="section" id="llvm-experimental-vector-extract-intrinsic">
<h4><a class="toc-backref" href="#id2616">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.vector.extract</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-vector-extract-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id822">
<h5><a class="toc-backref" href="#id2617">Syntax:</a><a class="headerlink" href="#id822" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use
<code class="docutils literal notranslate"><span class="pre">llvm.experimental.vector.extract</span></code> to extract a fixed-width vector from a
scalable vector, but not the other way around.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">extract</span><span class="o">.</span><span class="n">v4f32</span><span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o">%</span><span class="n">vec</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">idx</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">extract</span><span class="o">.</span><span class="n">v2f64</span><span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">2</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o">%</span><span class="n">vec</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">idx</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id823">
<h5><a class="toc-backref" href="#id2618">Overview:</a><a class="headerlink" href="#id823" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.vector.extract.*</span></code>’ intrinsics extract a vector from
within another vector starting from a given index. The return type must be
explicitly specified. Conceptually, this can be used to decompose a scalable
vector into non-scalable parts.</p>
</div>
<div class="section" id="id824">
<h5><a class="toc-backref" href="#id2619">Arguments:</a><a class="headerlink" href="#id824" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">vec</span></code> is the vector from which we will extract a subvector.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">idx</span></code> specifies the starting element number within <code class="docutils literal notranslate"><span class="pre">vec</span></code> from which a
subvector is extracted. <code class="docutils literal notranslate"><span class="pre">idx</span></code> must be a constant multiple of the known-minimum
vector length of the result type. If the result type is a scalable vector,
<code class="docutils literal notranslate"><span class="pre">idx</span></code> is first scaled by the result type’s runtime scaling factor. Elements
<code class="docutils literal notranslate"><span class="pre">idx</span></code> through (<code class="docutils literal notranslate"><span class="pre">idx</span></code> + num_elements(result_type) - 1) must be valid vector
indices. If this condition cannot be determined statically but is false at
runtime, then the result vector is undefined. The <code class="docutils literal notranslate"><span class="pre">idx</span></code> parameter must be a
vector index constant type (for most targets this will be an integer pointer
type).</p>
</div>
</div>
<div class="section" id="llvm-experimental-vector-reverse-intrinsic">
<h4><a class="toc-backref" href="#id2620">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.vector.reverse</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-vector-reverse-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id825">
<h5><a class="toc-backref" href="#id2621">Syntax:</a><a class="headerlink" href="#id825" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i8</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reverse</span><span class="o">.</span><span class="n">v2i8</span><span class="p">(</span><span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i8</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">reverse</span><span class="o">.</span><span class="n">nxv4i32</span><span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id826">
<h5><a class="toc-backref" href="#id2622">Overview:</a><a class="headerlink" href="#id826" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.vector.reverse.*</span></code>’ intrinsics reverse a vector.
The intrinsic takes a single vector and returns a vector of matching type but
with the original lane order reversed. These intrinsics work for both fixed
and scalable vectors. While this intrinsic is marked as experimental the
recommended way to express reverse operations for fixed-width vectors is still
to use a shufflevector, as that may allow for more optimization opportunities.</p>
</div>
<div class="section" id="id827">
<h5><a class="toc-backref" href="#id2623">Arguments:</a><a class="headerlink" href="#id827" title="Permalink to this headline">¶</a></h5>
<p>The argument to this intrinsic must be a vector.</p>
</div>
</div>
<div class="section" id="llvm-experimental-vector-splice-intrinsic">
<h4><a class="toc-backref" href="#id2624">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.vector.splice</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-vector-splice-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id828">
<h5><a class="toc-backref" href="#id2625">Syntax:</a><a class="headerlink" href="#id828" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">splice</span><span class="o">.</span><span class="n">v2f64</span><span class="p">(</span><span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o">%</span><span class="n">vec1</span><span class="p">,</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o">%</span><span class="n">vec2</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">imm</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">vector</span><span class="o">.</span><span class="n">splice</span><span class="o">.</span><span class="n">nxv4i32</span><span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">vec1</span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">vec2</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">imm</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id829">
<h5><a class="toc-backref" href="#id2626">Overview:</a><a class="headerlink" href="#id829" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.vector.splice.*</span></code>’ intrinsics construct a vector by
concatenating elements from the first input vector with elements of the second
input vector, returning a vector of the same type as the input vectors. The
signed immediate, modulo the number of elements in the vector, is the index
into the first vector from which to extract the result value. This means
conceptually that for a positive immediate, a vector is extracted from
<code class="docutils literal notranslate"><span class="pre">concat(%vec1,</span> <span class="pre">%vec2)</span></code> starting at index <code class="docutils literal notranslate"><span class="pre">imm</span></code>, whereas for a negative
immediate, it extracts <code class="docutils literal notranslate"><span class="pre">-imm</span></code> trailing elements from the first vector, and
the remaining elements from <code class="docutils literal notranslate"><span class="pre">%vec2</span></code>.</p>
<p>These intrinsics work for both fixed and scalable vectors. While this intrinsic
is marked as experimental, the recommended way to express this operation for
fixed-width vectors is still to use a shufflevector, as that may allow for more
optimization opportunities.</p>
<p>For example:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>llvm.experimental.vector.splice(<A,B,C,D>, <E,F,G,H>, 1) ==> <B, C, D, E> ; index
llvm.experimental.vector.splice(<A,B,C,D>, <E,F,G,H>, -3) ==> <B, C, D, E> ; trailing elements
</pre></div>
</div>
</div>
<div class="section" id="id830">
<h5><a class="toc-backref" href="#id2627">Arguments:</a><a class="headerlink" href="#id830" title="Permalink to this headline">¶</a></h5>
<p>The first two operands are vectors with the same type. The third argument
<code class="docutils literal notranslate"><span class="pre">imm</span></code> is the start index, modulo VL, where VL is the runtime vector length of
the source/result vector. The <code class="docutils literal notranslate"><span class="pre">imm</span></code> is a signed integer constant in the range
<code class="docutils literal notranslate"><span class="pre">-VL</span> <span class="pre"><=</span> <span class="pre">imm</span> <span class="pre"><</span> <span class="pre">VL</span></code>. For values outside of this range the result is poison.</p>
</div>
</div>
<div class="section" id="llvm-experimental-stepvector-intrinsic">
<h4><a class="toc-backref" href="#id2628">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.stepvector</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-stepvector-intrinsic" title="Permalink to this headline">¶</a></h4>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.experimental.stepvector</span></code>
to generate a vector whose lane values comprise the linear sequence
<0, 1, 2, …>. It is primarily intended for scalable vectors.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">stepvector</span><span class="o">.</span><span class="n">nxv4i32</span><span class="p">()</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i16</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">stepvector</span><span class="o">.</span><span class="n">nxv8i16</span><span class="p">()</span>
</pre></div>
</div>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.stepvector</span></code>’ intrinsics are used to create vectors
of integers whose elements contain a linear sequence of values starting from 0
with a step of 1. This experimental intrinsic can only be used for vectors
with integer elements that are at least 8 bits in size. If the sequence value
exceeds the allowed limit for the element type then the result for that lane is
undefined.</p>
<p>These intrinsics work for both fixed and scalable vectors. While this intrinsic
is marked as experimental, the recommended way to express this operation for
fixed-width vectors is still to generate a constant vector instead.</p>
<div class="section" id="id831">
<h5><a class="toc-backref" href="#id2629">Arguments:</a><a class="headerlink" href="#id831" title="Permalink to this headline">¶</a></h5>
<p>None.</p>
</div>
</div>
</div>
<div class="section" id="matrix-intrinsics">
<h3><a class="toc-backref" href="#id2630">Matrix Intrinsics</a><a class="headerlink" href="#matrix-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>Operations on matrixes requiring shape information (like number of rows/columns
or the memory layout) can be expressed using the matrix intrinsics. These
intrinsics require matrix dimensions to be passed as immediate arguments, and
matrixes are passed and returned as vectors. This means that for a <code class="docutils literal notranslate"><span class="pre">R</span></code> x
<code class="docutils literal notranslate"><span class="pre">C</span></code> matrix, element <code class="docutils literal notranslate"><span class="pre">i</span></code> of column <code class="docutils literal notranslate"><span class="pre">j</span></code> is at index <code class="docutils literal notranslate"><span class="pre">j</span> <span class="pre">*</span> <span class="pre">R</span> <span class="pre">+</span> <span class="pre">i</span></code> in the
corresponding vector, with indices starting at 0. Currently column-major layout
is assumed. The intrinsics support both integer and floating point matrixes.</p>
<div class="section" id="llvm-matrix-transpose-intrinsic">
<h4><a class="toc-backref" href="#id2631">‘<code class="docutils literal notranslate"><span class="pre">llvm.matrix.transpose.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-matrix-transpose-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id832">
<h5><a class="toc-backref" href="#id2632">Syntax:</a><a class="headerlink" href="#id832" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">vectorty</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">matrix</span><span class="o">.</span><span class="n">transpose</span><span class="o">.*</span><span class="p">(</span><span class="n">vectorty</span> <span class="o">%</span><span class="n">In</span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">Rows</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">Cols</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id833">
<h5><a class="toc-backref" href="#id2633">Overview:</a><a class="headerlink" href="#id833" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.matrix.transpose.*</span></code>’ intrinsics treat <code class="docutils literal notranslate"><span class="pre">%In</span></code> as a <code class="docutils literal notranslate"><span class="pre"><Rows></span> <span class="pre">x</span>
<span class="pre"><Cols></span></code> matrix and return the transposed matrix in the result vector.</p>
</div>
<div class="section" id="id834">
<h5><a class="toc-backref" href="#id2634">Arguments:</a><a class="headerlink" href="#id834" title="Permalink to this headline">¶</a></h5>
<p>The first argument <code class="docutils literal notranslate"><span class="pre">%In</span></code> is a vector that corresponds to a <code class="docutils literal notranslate"><span class="pre"><Rows></span> <span class="pre">x</span>
<span class="pre"><Cols></span></code> matrix. Thus, arguments <code class="docutils literal notranslate"><span class="pre"><Rows></span></code> and <code class="docutils literal notranslate"><span class="pre"><Cols></span></code> correspond to the
number of rows and columns, respectively, and must be positive, constant
integers. The returned vector must have <code class="docutils literal notranslate"><span class="pre"><Rows></span> <span class="pre">*</span> <span class="pre"><Cols></span></code> elements, and have
the same float or integer element type as <code class="docutils literal notranslate"><span class="pre">%In</span></code>.</p>
</div>
</div>
<div class="section" id="llvm-matrix-multiply-intrinsic">
<h4><a class="toc-backref" href="#id2635">‘<code class="docutils literal notranslate"><span class="pre">llvm.matrix.multiply.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-matrix-multiply-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id835">
<h5><a class="toc-backref" href="#id2636">Syntax:</a><a class="headerlink" href="#id835" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">vectorty</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">matrix</span><span class="o">.</span><span class="n">multiply</span><span class="o">.*</span><span class="p">(</span><span class="n">vectorty</span> <span class="o">%</span><span class="n">A</span><span class="p">,</span> <span class="n">vectorty</span> <span class="o">%</span><span class="n">B</span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">OuterRows</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">Inner</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">OuterColumns</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id836">
<h5><a class="toc-backref" href="#id2637">Overview:</a><a class="headerlink" href="#id836" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.matrix.multiply.*</span></code>’ intrinsics treat <code class="docutils literal notranslate"><span class="pre">%A</span></code> as a <code class="docutils literal notranslate"><span class="pre"><OuterRows></span> <span class="pre">x</span>
<span class="pre"><Inner></span></code> matrix, <code class="docutils literal notranslate"><span class="pre">%B</span></code> as a <code class="docutils literal notranslate"><span class="pre"><Inner></span> <span class="pre">x</span> <span class="pre"><OuterColumns></span></code> matrix, and
multiplies them. The result matrix is returned in the result vector.</p>
</div>
<div class="section" id="id837">
<h5><a class="toc-backref" href="#id2638">Arguments:</a><a class="headerlink" href="#id837" title="Permalink to this headline">¶</a></h5>
<p>The first vector argument <code class="docutils literal notranslate"><span class="pre">%A</span></code> corresponds to a matrix with <code class="docutils literal notranslate"><span class="pre"><OuterRows></span> <span class="pre">*</span>
<span class="pre"><Inner></span></code> elements, and the second argument <code class="docutils literal notranslate"><span class="pre">%B</span></code> to a matrix with
<code class="docutils literal notranslate"><span class="pre"><Inner></span> <span class="pre">*</span> <span class="pre"><OuterColumns></span></code> elements. Arguments <code class="docutils literal notranslate"><span class="pre"><OuterRows></span></code>,
<code class="docutils literal notranslate"><span class="pre"><Inner></span></code> and <code class="docutils literal notranslate"><span class="pre"><OuterColumns></span></code> must be positive, constant integers. The
returned vector must have <code class="docutils literal notranslate"><span class="pre"><OuterRows></span> <span class="pre">*</span> <span class="pre"><OuterColumns></span></code> elements.
Vectors <code class="docutils literal notranslate"><span class="pre">%A</span></code>, <code class="docutils literal notranslate"><span class="pre">%B</span></code>, and the returned vector all have the same float or
integer element type.</p>
</div>
</div>
<div class="section" id="llvm-matrix-column-major-load-intrinsic">
<h4><a class="toc-backref" href="#id2639">‘<code class="docutils literal notranslate"><span class="pre">llvm.matrix.column.major.load.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-matrix-column-major-load-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id838">
<h5><a class="toc-backref" href="#id2640">Syntax:</a><a class="headerlink" href="#id838" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="n">vectorty</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">matrix</span><span class="o">.</span><span class="n">column</span><span class="o">.</span><span class="n">major</span><span class="o">.</span><span class="n">load</span><span class="o">.*</span><span class="p">(</span>
<span class="n">ptrty</span> <span class="o">%</span><span class="n">Ptr</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">Stride</span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">IsVolatile</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">Rows</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">Cols</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id839">
<h5><a class="toc-backref" href="#id2641">Overview:</a><a class="headerlink" href="#id839" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.matrix.column.major.load.*</span></code>’ intrinsics load a <code class="docutils literal notranslate"><span class="pre"><Rows></span> <span class="pre">x</span> <span class="pre"><Cols></span></code>
matrix using a stride of <code class="docutils literal notranslate"><span class="pre">%Stride</span></code> to compute the start address of the
different columns. The offset is computed using <code class="docutils literal notranslate"><span class="pre">%Stride</span></code>’s bitwidth. This
allows for convenient loading of sub matrixes. If <code class="docutils literal notranslate"><span class="pre"><IsVolatile></span></code> is true, the
intrinsic is considered a <a class="reference internal" href="#volatile"><span class="std std-ref">volatile memory access</span></a>. The result
matrix is returned in the result vector. If the <code class="docutils literal notranslate"><span class="pre">%Ptr</span></code> argument is known to
be aligned to some boundary, this can be specified as an attribute on the
argument.</p>
</div>
<div class="section" id="id840">
<h5><a class="toc-backref" href="#id2642">Arguments:</a><a class="headerlink" href="#id840" title="Permalink to this headline">¶</a></h5>
<p>The first argument <code class="docutils literal notranslate"><span class="pre">%Ptr</span></code> is a pointer type to the returned vector type, and
corresponds to the start address to load from. The second argument <code class="docutils literal notranslate"><span class="pre">%Stride</span></code>
is a positive, constant integer with <code class="docutils literal notranslate"><span class="pre">%Stride</span> <span class="pre">>=</span> <span class="pre"><Rows></span></code>. <code class="docutils literal notranslate"><span class="pre">%Stride</span></code> is used
to compute the column memory addresses. I.e., for a column <code class="docutils literal notranslate"><span class="pre">C</span></code>, its start
memory addresses is calculated with <code class="docutils literal notranslate"><span class="pre">%Ptr</span> <span class="pre">+</span> <span class="pre">C</span> <span class="pre">*</span> <span class="pre">%Stride</span></code>. The third Argument
<code class="docutils literal notranslate"><span class="pre"><IsVolatile></span></code> is a boolean value. The fourth and fifth arguments,
<code class="docutils literal notranslate"><span class="pre"><Rows></span></code> and <code class="docutils literal notranslate"><span class="pre"><Cols></span></code>, correspond to the number of rows and columns,
respectively, and must be positive, constant integers. The returned vector must
have <code class="docutils literal notranslate"><span class="pre"><Rows></span> <span class="pre">*</span> <span class="pre"><Cols></span></code> elements.</p>
<p>The <a class="reference internal" href="#attr-align"><span class="std std-ref">align</span></a> parameter attribute can be provided for the
<code class="docutils literal notranslate"><span class="pre">%Ptr</span></code> arguments.</p>
</div>
</div>
<div class="section" id="llvm-matrix-column-major-store-intrinsic">
<h4><a class="toc-backref" href="#id2643">‘<code class="docutils literal notranslate"><span class="pre">llvm.matrix.column.major.store.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-matrix-column-major-store-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id841">
<h5><a class="toc-backref" href="#id2644">Syntax:</a><a class="headerlink" href="#id841" 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">matrix</span><span class="o">.</span><span class="n">column</span><span class="o">.</span><span class="n">major</span><span class="o">.</span><span class="n">store</span><span class="o">.*</span><span class="p">(</span>
<span class="n">vectorty</span> <span class="o">%</span><span class="n">In</span><span class="p">,</span> <span class="n">ptrty</span> <span class="o">%</span><span class="n">Ptr</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">Stride</span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">IsVolatile</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">Rows</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">Cols</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id842">
<h5><a class="toc-backref" href="#id2645">Overview:</a><a class="headerlink" href="#id842" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.matrix.column.major.store.*</span></code>’ intrinsics store the <code class="docutils literal notranslate"><span class="pre"><Rows></span> <span class="pre">x</span>
<span class="pre"><Cols></span></code> matrix in <code class="docutils literal notranslate"><span class="pre">%In</span></code> to memory using a stride of <code class="docutils literal notranslate"><span class="pre">%Stride</span></code> between
columns. The offset is computed using <code class="docutils literal notranslate"><span class="pre">%Stride</span></code>’s bitwidth. If
<code class="docutils literal notranslate"><span class="pre"><IsVolatile></span></code> is true, the intrinsic is considered a
<a class="reference internal" href="#volatile"><span class="std std-ref">volatile memory access</span></a>.</p>
<p>If the <code class="docutils literal notranslate"><span class="pre">%Ptr</span></code> argument is known to be aligned to some boundary, this can be
specified as an attribute on the argument.</p>
</div>
<div class="section" id="id843">
<h5><a class="toc-backref" href="#id2646">Arguments:</a><a class="headerlink" href="#id843" title="Permalink to this headline">¶</a></h5>
<p>The first argument <code class="docutils literal notranslate"><span class="pre">%In</span></code> is a vector that corresponds to a <code class="docutils literal notranslate"><span class="pre"><Rows></span> <span class="pre">x</span>
<span class="pre"><Cols></span></code> matrix to be stored to memory. The second argument <code class="docutils literal notranslate"><span class="pre">%Ptr</span></code> is a
pointer to the vector type of <code class="docutils literal notranslate"><span class="pre">%In</span></code>, and is the start address of the matrix
in memory. The third argument <code class="docutils literal notranslate"><span class="pre">%Stride</span></code> is a positive, constant integer with
<code class="docutils literal notranslate"><span class="pre">%Stride</span> <span class="pre">>=</span> <span class="pre"><Rows></span></code>. <code class="docutils literal notranslate"><span class="pre">%Stride</span></code> is used to compute the column memory
addresses. I.e., for a column <code class="docutils literal notranslate"><span class="pre">C</span></code>, its start memory addresses is calculated
with <code class="docutils literal notranslate"><span class="pre">%Ptr</span> <span class="pre">+</span> <span class="pre">C</span> <span class="pre">*</span> <span class="pre">%Stride</span></code>. The fourth argument <code class="docutils literal notranslate"><span class="pre"><IsVolatile></span></code> is a boolean
value. The arguments <code class="docutils literal notranslate"><span class="pre"><Rows></span></code> and <code class="docutils literal notranslate"><span class="pre"><Cols></span></code> correspond to the number of rows
and columns, respectively, and must be positive, constant integers.</p>
<p>The <a class="reference internal" href="#attr-align"><span class="std std-ref">align</span></a> parameter attribute can be provided
for the <code class="docutils literal notranslate"><span class="pre">%Ptr</span></code> arguments.</p>
</div>
</div>
</div>
<div class="section" id="half-precision-floating-point-intrinsics">
<h3><a class="toc-backref" href="#id2647">Half Precision Floating-Point Intrinsics</a><a class="headerlink" href="#half-precision-floating-point-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>For most target platforms, half precision floating-point is a
storage-only format. This means that it is a dense encoding (in memory)
but does not support computation in the format.</p>
<p>This means that code must first load the half-precision floating-point
value as an i16, then convert it to float with
<a class="reference internal" href="#int-convert-from-fp16"><span class="std std-ref">llvm.convert.from.fp16</span></a>. Computation can
then be performed on the float value (including extending to double
etc). To store the value back to memory, it is first converted to float
if needed, then converted to i16 with
<a class="reference internal" href="#int-convert-to-fp16"><span class="std std-ref">llvm.convert.to.fp16</span></a>, then storing as an
i16 value.</p>
<div class="section" id="llvm-convert-to-fp16-intrinsic">
<span id="int-convert-to-fp16"></span><h4><a class="toc-backref" href="#id2648">‘<code class="docutils literal notranslate"><span class="pre">llvm.convert.to.fp16</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-convert-to-fp16-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id844">
<h5><a class="toc-backref" href="#id2649">Syntax:</a><a class="headerlink" href="#id844" 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">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">convert</span><span class="o">.</span><span class="n">to</span><span class="o">.</span><span class="n">fp16</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">convert</span><span class="o">.</span><span class="n">to</span><span class="o">.</span><span class="n">fp16</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id845">
<h5><a class="toc-backref" href="#id2650">Overview:</a><a class="headerlink" href="#id845" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.convert.to.fp16</span></code>’ intrinsic function performs a conversion from a
conventional floating-point type to half precision floating-point format.</p>
</div>
<div class="section" id="id846">
<h5><a class="toc-backref" href="#id2651">Arguments:</a><a class="headerlink" href="#id846" title="Permalink to this headline">¶</a></h5>
<p>The intrinsic function contains single argument - the value to be
converted.</p>
</div>
<div class="section" id="id847">
<h5><a class="toc-backref" href="#id2652">Semantics:</a><a class="headerlink" href="#id847" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.convert.to.fp16</span></code>’ intrinsic function performs a conversion from a
conventional floating-point format to half precision floating-point format. The
return value is an <code class="docutils literal notranslate"><span class="pre">i16</span></code> which contains the converted number.</p>
</div>
<div class="section" id="id848">
<h5><a class="toc-backref" href="#id2653">Examples:</a><a class="headerlink" href="#id848" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i16</span> <span class="vg">@llvm.convert.to.fp16.f32</span><span class="p">(</span><span class="k">float</span> <span class="nv">%a</span><span class="p">)</span>
<span class="k">store</span> <span class="k">i16</span> <span class="nv">%res</span><span class="p">,</span> <span class="k">i16</span><span class="p">*</span> <span class="vg">@x</span><span class="p">,</span> <span class="k">align</span> <span class="m">2</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-convert-from-fp16-intrinsic">
<span id="int-convert-from-fp16"></span><h4><a class="toc-backref" href="#id2654">‘<code class="docutils literal notranslate"><span class="pre">llvm.convert.from.fp16</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-convert-from-fp16-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id849">
<h5><a class="toc-backref" href="#id2655">Syntax:</a><a class="headerlink" href="#id849" 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="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">convert</span><span class="o">.</span><span class="n">from</span><span class="o">.</span><span class="n">fp16</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">convert</span><span class="o">.</span><span class="n">from</span><span class="o">.</span><span class="n">fp16</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">i16</span> <span class="o">%</span><span class="n">a</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id850">
<h5><a class="toc-backref" href="#id2656">Overview:</a><a class="headerlink" href="#id850" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.convert.from.fp16</span></code>’ intrinsic function performs a
conversion from half precision floating-point format to single precision
floating-point format.</p>
</div>
<div class="section" id="id851">
<h5><a class="toc-backref" href="#id2657">Arguments:</a><a class="headerlink" href="#id851" title="Permalink to this headline">¶</a></h5>
<p>The intrinsic function contains single argument - the value to be
converted.</p>
</div>
<div class="section" id="id852">
<h5><a class="toc-backref" href="#id2658">Semantics:</a><a class="headerlink" href="#id852" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.convert.from.fp16</span></code>’ intrinsic function performs a
conversion from half single precision floating-point format to single
precision floating-point format. The input half-float value is
represented by an <code class="docutils literal notranslate"><span class="pre">i16</span></code> value.</p>
</div>
<div class="section" id="id853">
<h5><a class="toc-backref" href="#id2659">Examples:</a><a class="headerlink" href="#id853" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%a</span> <span class="p">=</span> <span class="k">load</span> <span class="k">i16</span><span class="p">,</span> <span class="k">i16</span><span class="p">*</span> <span class="vg">@x</span><span class="p">,</span> <span class="k">align</span> <span class="m">2</span>
<span class="nv">%res</span> <span class="p">=</span> <span class="k">call</span> <span class="k">float</span> <span class="vg">@llvm.convert.from.fp16</span><span class="p">(</span><span class="k">i16</span> <span class="nv">%a</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="saturating-floating-point-to-integer-conversions">
<h3><a class="toc-backref" href="#id2660">Saturating floating-point to integer conversions</a><a class="headerlink" href="#saturating-floating-point-to-integer-conversions" title="Permalink to this headline">¶</a></h3>
<p>The <code class="docutils literal notranslate"><span class="pre">fptoui</span></code> and <code class="docutils literal notranslate"><span class="pre">fptosi</span></code> instructions return a
<a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a> if the rounded-towards-zero value is not
representable by the result type. These intrinsics provide an alternative
conversion, which will saturate towards the smallest and largest representable
integer values instead.</p>
<div class="section" id="llvm-fptoui-sat-intrinsic">
<h4><a class="toc-backref" href="#id2661">‘<code class="docutils literal notranslate"><span class="pre">llvm.fptoui.sat.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-fptoui-sat-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id854">
<h5><a class="toc-backref" href="#id2662">Syntax:</a><a class="headerlink" href="#id854" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.fptoui.sat</span></code> on any
floating-point argument type and any integer result type, or vectors thereof.
Not all targets may support all types, however.</p>
<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">fptoui</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i32</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">f</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i19</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">fptoui</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i19</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">f</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i100</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">fptoui</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">v4i100</span><span class="o">.</span><span class="n">v4f128</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">fp128</span><span class="o">></span> <span class="o">%</span><span class="n">f</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id855">
<h5><a class="toc-backref" href="#id2663">Overview:</a><a class="headerlink" href="#id855" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic converts the argument into an unsigned integer using saturating
semantics.</p>
</div>
<div class="section" id="id856">
<h5><a class="toc-backref" href="#id2664">Arguments:</a><a class="headerlink" href="#id856" title="Permalink to this headline">¶</a></h5>
<p>The argument may be any floating-point or vector of floating-point type. The
return value may be any integer or vector of integer type. The number of vector
elements in argument and return must be the same.</p>
</div>
<div class="section" id="id857">
<h5><a class="toc-backref" href="#id2665">Semantics:</a><a class="headerlink" href="#id857" title="Permalink to this headline">¶</a></h5>
<p>The conversion to integer is performed subject to the following rules:</p>
<ul class="simple">
<li><p>If the argument is any NaN, zero is returned.</p></li>
<li><p>If the argument is smaller than zero (this includes negative infinity),
zero is returned.</p></li>
<li><p>If the argument is larger than the largest representable unsigned integer of
the result type (this includes positive infinity), the largest representable
unsigned integer is returned.</p></li>
<li><p>Otherwise, the result of rounding the argument towards zero is returned.</p></li>
</ul>
</div>
<div class="section" id="id858">
<h5><a class="toc-backref" href="#id2666">Example:</a><a class="headerlink" href="#id858" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>%a = call i8 @llvm.fptoui.sat.i8.f32(float 123.9) ; yields i8: 123
%b = call i8 @llvm.fptoui.sat.i8.f32(float -5.7) ; yields i8: 0
%c = call i8 @llvm.fptoui.sat.i8.f32(float 377.0) ; yields i8: 255
%d = call i8 @llvm.fptoui.sat.i8.f32(float 0xFFF8000000000000) ; yields i8: 0
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-fptosi-sat-intrinsic">
<h4><a class="toc-backref" href="#id2667">‘<code class="docutils literal notranslate"><span class="pre">llvm.fptosi.sat.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-fptosi-sat-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id859">
<h5><a class="toc-backref" href="#id2668">Syntax:</a><a class="headerlink" href="#id859" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.fptosi.sat</span></code> on any
floating-point argument type and any integer result type, or vectors thereof.
Not all targets may support all types, however.</p>
<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">fptosi</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i32</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">f</span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i19</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">fptosi</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">i19</span><span class="o">.</span><span class="n">f64</span><span class="p">(</span><span class="n">double</span> <span class="o">%</span><span class="n">f</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i100</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">fptosi</span><span class="o">.</span><span class="n">sat</span><span class="o">.</span><span class="n">v4i100</span><span class="o">.</span><span class="n">v4f128</span><span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">fp128</span><span class="o">></span> <span class="o">%</span><span class="n">f</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id860">
<h5><a class="toc-backref" href="#id2669">Overview:</a><a class="headerlink" href="#id860" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic converts the argument into a signed integer using saturating
semantics.</p>
</div>
<div class="section" id="id861">
<h5><a class="toc-backref" href="#id2670">Arguments:</a><a class="headerlink" href="#id861" title="Permalink to this headline">¶</a></h5>
<p>The argument may be any floating-point or vector of floating-point type. The
return value may be any integer or vector of integer type. The number of vector
elements in argument and return must be the same.</p>
</div>
<div class="section" id="id862">
<h5><a class="toc-backref" href="#id2671">Semantics:</a><a class="headerlink" href="#id862" title="Permalink to this headline">¶</a></h5>
<p>The conversion to integer is performed subject to the following rules:</p>
<ul class="simple">
<li><p>If the argument is any NaN, zero is returned.</p></li>
<li><p>If the argument is smaller than the smallest representable signed integer of
the result type (this includes negative infinity), the smallest
representable signed integer is returned.</p></li>
<li><p>If the argument is larger than the largest representable signed integer of
the result type (this includes positive infinity), the largest representable
signed integer is returned.</p></li>
<li><p>Otherwise, the result of rounding the argument towards zero is returned.</p></li>
</ul>
</div>
<div class="section" id="id863">
<h5><a class="toc-backref" href="#id2672">Example:</a><a class="headerlink" href="#id863" title="Permalink to this headline">¶</a></h5>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>%a = call i8 @llvm.fptosi.sat.i8.f32(float 23.9) ; yields i8: 23
%b = call i8 @llvm.fptosi.sat.i8.f32(float -130.8) ; yields i8: -128
%c = call i8 @llvm.fptosi.sat.i8.f32(float 999.0) ; yields i8: 127
%d = call i8 @llvm.fptosi.sat.i8.f32(float 0xFFF8000000000000) ; yields i8: 0
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="debugger-intrinsics">
<span id="dbg-intrinsics"></span><h3><a class="toc-backref" href="#id2673">Debugger Intrinsics</a><a class="headerlink" href="#debugger-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>The LLVM debugger intrinsics (which all start with <code class="docutils literal notranslate"><span class="pre">llvm.dbg.</span></code>
prefix), are described in the <a class="reference external" href="SourceLevelDebugging.html#format-common-intrinsics">LLVM Source Level
Debugging</a>
document.</p>
</div>
<div class="section" id="exception-handling-intrinsics">
<h3><a class="toc-backref" href="#id2674">Exception Handling Intrinsics</a><a class="headerlink" href="#exception-handling-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>The LLVM exception handling intrinsics (which all start with
<code class="docutils literal notranslate"><span class="pre">llvm.eh.</span></code> prefix), are described in the <a class="reference external" href="ExceptionHandling.html#format-common-intrinsics">LLVM Exception
Handling</a> document.</p>
</div>
<div class="section" id="trampoline-intrinsics">
<span id="int-trampoline"></span><h3><a class="toc-backref" href="#id2675">Trampoline Intrinsics</a><a class="headerlink" href="#trampoline-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>These intrinsics make it possible to excise one parameter, marked with
the <a class="reference internal" href="#nest"><span class="std std-ref">nest</span></a> attribute, from a function. The result is a
callable function pointer lacking the nest parameter - the caller does
not need to provide a value for it. Instead, the value to use is stored
in advance in a “trampoline”, a block of memory usually allocated on the
stack, which also contains code to splice the nest value into the
argument list. This is used to implement the GCC nested function address
extension.</p>
<p>For example, if the function is <code class="docutils literal notranslate"><span class="pre">i32</span> <span class="pre">f(i8*</span> <span class="pre">nest</span> <span class="pre">%c,</span> <span class="pre">i32</span> <span class="pre">%x,</span> <span class="pre">i32</span> <span class="pre">%y)</span></code>
then the resulting function pointer has signature <code class="docutils literal notranslate"><span class="pre">i32</span> <span class="pre">(i32,</span> <span class="pre">i32)*</span></code>.
It can be created as follows:</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%tramp</span> <span class="p">=</span> <span class="k">alloca</span> <span class="p">[</span><span class="m">10</span> <span class="k">x</span> <span class="k">i8</span><span class="p">],</span> <span class="k">align</span> <span class="m">4</span> <span class="c">; size and alignment only correct for X86</span>
<span class="nv">%tramp1</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="p">[</span><span class="m">10</span> <span class="k">x</span> <span class="k">i8</span><span class="p">],</span> <span class="p">[</span><span class="m">10</span> <span class="k">x</span> <span class="k">i8</span><span class="p">]*</span> <span class="nv">%tramp</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">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@llvm.init.trampoline</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%tramp1</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="k">bitcast</span> <span class="p">(</span><span class="k">i32</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">i32</span><span class="p">)*</span> <span class="vg">@f</span> <span class="k">to</span> <span class="k">i8</span><span class="p">*),</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%nval</span><span class="p">)</span>
<span class="nv">%p</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span><span class="p">*</span> <span class="vg">@llvm.adjust.trampoline</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%tramp1</span><span class="p">)</span>
<span class="nv">%fp</span> <span class="p">=</span> <span class="k">bitcast</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%p</span> <span class="k">to</span> <span class="k">i32</span> <span class="p">(</span><span class="k">i32</span><span class="p">,</span> <span class="k">i32</span><span class="p">)*</span>
</pre></div>
</div>
<p>The call <code class="docutils literal notranslate"><span class="pre">%val</span> <span class="pre">=</span> <span class="pre">call</span> <span class="pre">i32</span> <span class="pre">%fp(i32</span> <span class="pre">%x,</span> <span class="pre">i32</span> <span class="pre">%y)</span></code> is then equivalent to
<code class="docutils literal notranslate"><span class="pre">%val</span> <span class="pre">=</span> <span class="pre">call</span> <span class="pre">i32</span> <span class="pre">%f(i8*</span> <span class="pre">%nval,</span> <span class="pre">i32</span> <span class="pre">%x,</span> <span class="pre">i32</span> <span class="pre">%y)</span></code>.</p>
<div class="section" id="llvm-init-trampoline-intrinsic">
<span id="int-it"></span><h4><a class="toc-backref" href="#id2676">‘<code class="docutils literal notranslate"><span class="pre">llvm.init.trampoline</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-init-trampoline-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id864">
<h5><a class="toc-backref" href="#id2677">Syntax:</a><a class="headerlink" href="#id864" 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">init</span><span class="o">.</span><span class="n">trampoline</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">tramp</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">func</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">nval</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id865">
<h5><a class="toc-backref" href="#id2678">Overview:</a><a class="headerlink" href="#id865" title="Permalink to this headline">¶</a></h5>
<p>This fills the memory pointed to by <code class="docutils literal notranslate"><span class="pre">tramp</span></code> with executable code,
turning it into a trampoline.</p>
</div>
<div class="section" id="id866">
<h5><a class="toc-backref" href="#id2679">Arguments:</a><a class="headerlink" href="#id866" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.init.trampoline</span></code> intrinsic takes three arguments, all
pointers. The <code class="docutils literal notranslate"><span class="pre">tramp</span></code> argument must point to a sufficiently large and
sufficiently aligned block of memory; this memory is written to by the
intrinsic. Note that the size and the alignment are target-specific -
LLVM currently provides no portable way of determining them, so a
front-end that generates this intrinsic needs to have some
target-specific knowledge. The <code class="docutils literal notranslate"><span class="pre">func</span></code> argument must hold a function
bitcast to an <code class="docutils literal notranslate"><span class="pre">i8*</span></code>.</p>
</div>
<div class="section" id="id867">
<h5><a class="toc-backref" href="#id2680">Semantics:</a><a class="headerlink" href="#id867" title="Permalink to this headline">¶</a></h5>
<p>The block of memory pointed to by <code class="docutils literal notranslate"><span class="pre">tramp</span></code> is filled with target
dependent code, turning it into a function. Then <code class="docutils literal notranslate"><span class="pre">tramp</span></code> needs to be
passed to <a class="reference internal" href="#int-at"><span class="std std-ref">llvm.adjust.trampoline</span></a> to get a pointer which can
be <a class="reference internal" href="#int-trampoline"><span class="std std-ref">bitcast (to a new function) and called</span></a>. The new
function’s signature is the same as that of <code class="docutils literal notranslate"><span class="pre">func</span></code> with any arguments
marked with the <code class="docutils literal notranslate"><span class="pre">nest</span></code> attribute removed. At most one such <code class="docutils literal notranslate"><span class="pre">nest</span></code>
argument is allowed, and it must be of pointer type. Calling the new
function is equivalent to calling <code class="docutils literal notranslate"><span class="pre">func</span></code> with the same argument list,
but with <code class="docutils literal notranslate"><span class="pre">nval</span></code> used for the missing <code class="docutils literal notranslate"><span class="pre">nest</span></code> argument. If, after
calling <code class="docutils literal notranslate"><span class="pre">llvm.init.trampoline</span></code>, the memory pointed to by <code class="docutils literal notranslate"><span class="pre">tramp</span></code> is
modified, then the effect of any later call to the returned function
pointer is undefined.</p>
</div>
</div>
<div class="section" id="llvm-adjust-trampoline-intrinsic">
<span id="int-at"></span><h4><a class="toc-backref" href="#id2681">‘<code class="docutils literal notranslate"><span class="pre">llvm.adjust.trampoline</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-adjust-trampoline-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id868">
<h5><a class="toc-backref" href="#id2682">Syntax:</a><a class="headerlink" href="#id868" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">adjust</span><span class="o">.</span><span class="n">trampoline</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">tramp</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id869">
<h5><a class="toc-backref" href="#id2683">Overview:</a><a class="headerlink" href="#id869" title="Permalink to this headline">¶</a></h5>
<p>This performs any required machine-specific adjustment to the address of
a trampoline (passed as <code class="docutils literal notranslate"><span class="pre">tramp</span></code>).</p>
</div>
<div class="section" id="id870">
<h5><a class="toc-backref" href="#id2684">Arguments:</a><a class="headerlink" href="#id870" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">tramp</span></code> must point to a block of memory which already has trampoline
code filled in by a previous call to
<a class="reference internal" href="#int-it"><span class="std std-ref">llvm.init.trampoline</span></a>.</p>
</div>
<div class="section" id="id871">
<h5><a class="toc-backref" href="#id2685">Semantics:</a><a class="headerlink" href="#id871" title="Permalink to this headline">¶</a></h5>
<p>On some architectures the address of the code to be executed needs to be
different than the address where the trampoline is actually stored. This
intrinsic returns the executable address corresponding to <code class="docutils literal notranslate"><span class="pre">tramp</span></code>
after performing the required machine specific adjustments. The pointer
returned can then be <a class="reference internal" href="#int-trampoline"><span class="std std-ref">bitcast and executed</span></a>.</p>
</div>
</div>
</div>
<div class="section" id="vector-predication-intrinsics">
<span id="int-vp"></span><h3><a class="toc-backref" href="#id2686">Vector Predication Intrinsics</a><a class="headerlink" href="#vector-predication-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>VP intrinsics are intended for predicated SIMD/vector code. A typical VP
operation takes a vector mask and an explicit vector length parameter as in:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">W</span> <span class="n">x</span> <span class="n">T</span><span class="o">></span> <span class="n">llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.<</span><span class="n">opcode</span><span class="o">>.*</span><span class="p">(</span><span class="o"><</span><span class="n">W</span> <span class="n">x</span> <span class="n">T</span><span class="o">></span> <span class="o">%</span><span class="n">x</span><span class="p">,</span> <span class="o"><</span><span class="n">W</span> <span class="n">x</span> <span class="n">T</span><span class="o">></span> <span class="o">%</span><span class="n">y</span><span class="p">,</span> <span class="o"><</span><span class="n">W</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o">%</span><span class="n">mask</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">evl</span><span class="p">)</span>
</pre></div>
</div>
<p>The vector mask parameter (%mask) always has a vector of <cite>i1</cite> type, for example
<cite><32 x i1></cite>. The explicit vector length parameter always has the type <cite>i32</cite> and
is an unsigned integer value. The explicit vector length parameter (%evl) is in
the range:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">0</span> <span class="o"><=</span> <span class="o">%</span><span class="n">evl</span> <span class="o"><=</span> <span class="n">W</span><span class="p">,</span> <span class="n">where</span> <span class="n">W</span> <span class="ow">is</span> <span class="n">the</span> <span class="n">number</span> <span class="n">of</span> <span class="n">vector</span> <span class="n">elements</span>
</pre></div>
</div>
<p>Note that for <a class="reference internal" href="#t-vector"><span class="std std-ref">scalable vector types</span></a> <code class="docutils literal notranslate"><span class="pre">W</span></code> is the runtime
length of the vector.</p>
<p>The VP intrinsic has undefined behavior if <code class="docutils literal notranslate"><span class="pre">%evl</span> <span class="pre">></span> <span class="pre">W</span></code>. The explicit vector
length (%evl) creates a mask, %EVLmask, with all elements <code class="docutils literal notranslate"><span class="pre">0</span> <span class="pre"><=</span> <span class="pre">i</span> <span class="pre"><</span> <span class="pre">%evl</span></code> set
to True, and all other lanes <code class="docutils literal notranslate"><span class="pre">%evl</span> <span class="pre"><=</span> <span class="pre">i</span> <span class="pre"><</span> <span class="pre">W</span></code> to False. A new mask %M is
calculated with an element-wise AND from %mask and %EVLmask:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">M</span> <span class="o">=</span> <span class="o">%</span><span class="n">mask</span> <span class="n">AND</span> <span class="o">%</span><span class="n">EVLmask</span>
</pre></div>
</div>
<p>A vector operation <code class="docutils literal notranslate"><span class="pre"><opcode></span></code> on vectors <code class="docutils literal notranslate"><span class="pre">A</span></code> and <code class="docutils literal notranslate"><span class="pre">B</span></code> calculates:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">A</span> <span class="o"><</span><span class="n">opcode</span><span class="o">></span> <span class="n">B</span> <span class="o">=</span> <span class="p">{</span> <span class="n">A</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o"><</span><span class="n">opcode</span><span class="o">></span> <span class="n">B</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="n">M</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="kc">True</span><span class="p">,</span> <span class="ow">and</span>
<span class="p">{</span> <span class="n">undef</span> <span class="n">otherwise</span>
</pre></div>
</div>
<div class="section" id="optimization-hint">
<h4><a class="toc-backref" href="#id2687">Optimization Hint</a><a class="headerlink" href="#optimization-hint" title="Permalink to this headline">¶</a></h4>
<p>Some targets, such as AVX512, do not support the %evl parameter in hardware.
The use of an effective %evl is discouraged for those targets. The function
<code class="docutils literal notranslate"><span class="pre">TargetTransformInfo::hasActiveVectorLength()</span></code> returns true when the target
has native support for %evl.</p>
</div>
<div class="section" id="llvm-vp-select-intrinsics">
<span id="int-vp-select"></span><h4><a class="toc-backref" href="#id2688">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.select.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-select-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id872">
<h5><a class="toc-backref" href="#id2689">Syntax:</a><a class="headerlink" href="#id872" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">select</span><span class="o">.</span><span class="n">v16i32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">condition</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">on_true</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">on_false</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">evl</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">select</span><span class="o">.</span><span class="n">nxv4i64</span> <span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">condition</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">on_true</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">on_false</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">evl</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id873">
<h5><a class="toc-backref" href="#id2690">Overview:</a><a class="headerlink" href="#id873" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.select</span></code>’ intrinsic is used to choose one value based on a
condition vector, without IR-level branching.</p>
</div>
<div class="section" id="id874">
<h5><a class="toc-backref" href="#id2691">Arguments:</a><a class="headerlink" href="#id874" title="Permalink to this headline">¶</a></h5>
<p>The first operand is a vector of <code class="docutils literal notranslate"><span class="pre">i1</span></code> and indicates the condition. The
second operand is the value that is selected where the condition vector is
true. The third operand is the value that is selected where the condition
vector is false. The vectors must be of the same size. The fourth operand is
the explicit vector length.</p>
<ol class="arabic simple">
<li><p>The optional <code class="docutils literal notranslate"><span class="pre">fast-math</span> <span class="pre">flags</span></code> marker indicates that the select has one or
more <a class="reference internal" href="#fastmath"><span class="std std-ref">fast-math flags</span></a>. These are optimization hints to
enable otherwise unsafe floating-point optimizations. Fast-math flags are
only valid for selects that return a floating-point scalar or vector type,
or an array (nested to any depth) of floating-point scalar or vector types.</p></li>
</ol>
</div>
<div class="section" id="id875">
<h5><a class="toc-backref" href="#id2692">Semantics:</a><a class="headerlink" href="#id875" title="Permalink to this headline">¶</a></h5>
<p>The intrinsic selects lanes from the second and third operand depending on a
condition vector.</p>
<p>All result lanes at positions greater or equal than <code class="docutils literal notranslate"><span class="pre">%evl</span></code> are undefined.
For all lanes below <code class="docutils literal notranslate"><span class="pre">%evl</span></code> where the condition vector is true the lane is
taken from the second operand. Otherwise, the lane is taken from the third
operand.</p>
</div>
<div class="section" id="id876">
<h5><a class="toc-backref" href="#id2693">Example:</a><a class="headerlink" href="#id876" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="vg">@llvm.vp.select.v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%cond</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%on_true</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%on_false</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">;;; Expansion.</span>
<span class="c">;; Any result is legal on lanes at and above %evl.</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%cond</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%on_true</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%on_false</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-add-intrinsics">
<span id="int-vp-add"></span><h4><a class="toc-backref" href="#id2694">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.add.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-add-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id877">
<h5><a class="toc-backref" href="#id2695">Syntax:</a><a class="headerlink" href="#id877" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">add</span><span class="o">.</span><span class="n">v16i32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">add</span><span class="o">.</span><span class="n">nxv4i32</span> <span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">add</span><span class="o">.</span><span class="n">v256i64</span> <span class="p">(</span><span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id878">
<h5><a class="toc-backref" href="#id2696">Overview:</a><a class="headerlink" href="#id878" title="Permalink to this headline">¶</a></h5>
<p>Predicated integer addition of two vectors of integers.</p>
</div>
<div class="section" id="id879">
<h5><a class="toc-backref" href="#id2697">Arguments:</a><a class="headerlink" href="#id879" title="Permalink to this headline">¶</a></h5>
<p>The first two operands and the result have the same vector of integer type. The
third operand is the vector mask and has the same number of elements as the
result vector type. The fourth operand is the explicit vector length of the
operation.</p>
</div>
<div class="section" id="id880">
<h5><a class="toc-backref" href="#id2698">Semantics:</a><a class="headerlink" href="#id880" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.add</span></code>’ intrinsic performs integer addition (<a class="reference internal" href="#i-add"><span class="std std-ref">add</span></a>)
of the first and second vector operand on each enabled lane. The result on
disabled lanes is undefined.</p>
</div>
<div class="section" id="id881">
<h5><a class="toc-backref" href="#id2699">Examples:</a><a class="headerlink" href="#id881" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="vg">@llvm.vp.add.v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%b</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">;; For all lanes below %evl, %r is lane-wise equivalent to %also.r</span>
<span class="nv">%t</span> <span class="p">=</span> <span class="k">add</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="nv">%b</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%t</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="k">undef</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-sub-intrinsics">
<span id="int-vp-sub"></span><h4><a class="toc-backref" href="#id2700">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.sub.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-sub-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id882">
<h5><a class="toc-backref" href="#id2701">Syntax:</a><a class="headerlink" href="#id882" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">sub</span><span class="o">.</span><span class="n">v16i32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">sub</span><span class="o">.</span><span class="n">nxv4i32</span> <span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">sub</span><span class="o">.</span><span class="n">v256i64</span> <span class="p">(</span><span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id883">
<h5><a class="toc-backref" href="#id2702">Overview:</a><a class="headerlink" href="#id883" title="Permalink to this headline">¶</a></h5>
<p>Predicated integer subtraction of two vectors of integers.</p>
</div>
<div class="section" id="id884">
<h5><a class="toc-backref" href="#id2703">Arguments:</a><a class="headerlink" href="#id884" title="Permalink to this headline">¶</a></h5>
<p>The first two operands and the result have the same vector of integer type. The
third operand is the vector mask and has the same number of elements as the
result vector type. The fourth operand is the explicit vector length of the
operation.</p>
</div>
<div class="section" id="id885">
<h5><a class="toc-backref" href="#id2704">Semantics:</a><a class="headerlink" href="#id885" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.sub</span></code>’ intrinsic performs integer subtraction
(<a class="reference internal" href="#i-sub"><span class="std std-ref">sub</span></a>) of the first and second vector operand on each enabled
lane. The result on disabled lanes is undefined.</p>
</div>
<div class="section" id="id886">
<h5><a class="toc-backref" href="#id2705">Examples:</a><a class="headerlink" href="#id886" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="vg">@llvm.vp.sub.v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%b</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">;; For all lanes below %evl, %r is lane-wise equivalent to %also.r</span>
<span class="nv">%t</span> <span class="p">=</span> <span class="k">sub</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="nv">%b</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%t</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="k">undef</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-mul-intrinsics">
<span id="int-vp-mul"></span><h4><a class="toc-backref" href="#id2706">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.mul.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-mul-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id887">
<h5><a class="toc-backref" href="#id2707">Syntax:</a><a class="headerlink" href="#id887" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">mul</span><span class="o">.</span><span class="n">v16i32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">mul</span><span class="o">.</span><span class="n">nxv46i32</span> <span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">mul</span><span class="o">.</span><span class="n">v256i64</span> <span class="p">(</span><span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id888">
<h5><a class="toc-backref" href="#id2708">Overview:</a><a class="headerlink" href="#id888" title="Permalink to this headline">¶</a></h5>
<p>Predicated integer multiplication of two vectors of integers.</p>
</div>
<div class="section" id="id889">
<h5><a class="toc-backref" href="#id2709">Arguments:</a><a class="headerlink" href="#id889" title="Permalink to this headline">¶</a></h5>
<p>The first two operands and the result have the same vector of integer type. The
third operand is the vector mask and has the same number of elements as the
result vector type. The fourth operand is the explicit vector length of the
operation.</p>
</div>
<div class="section" id="id890">
<h5><a class="toc-backref" href="#id2710">Semantics:</a><a class="headerlink" href="#id890" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.mul</span></code>’ intrinsic performs integer multiplication
(<a class="reference internal" href="#i-mul"><span class="std std-ref">mul</span></a>) of the first and second vector operand on each enabled
lane. The result on disabled lanes is undefined.</p>
</div>
<div class="section" id="id891">
<h5><a class="toc-backref" href="#id2711">Examples:</a><a class="headerlink" href="#id891" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="vg">@llvm.vp.mul.v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%b</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">;; For all lanes below %evl, %r is lane-wise equivalent to %also.r</span>
<span class="nv">%t</span> <span class="p">=</span> <span class="k">mul</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="nv">%b</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%t</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="k">undef</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-sdiv-intrinsics">
<span id="int-vp-sdiv"></span><h4><a class="toc-backref" href="#id2712">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.sdiv.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-sdiv-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id892">
<h5><a class="toc-backref" href="#id2713">Syntax:</a><a class="headerlink" href="#id892" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">sdiv</span><span class="o">.</span><span class="n">v16i32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">sdiv</span><span class="o">.</span><span class="n">nxv4i32</span> <span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">sdiv</span><span class="o">.</span><span class="n">v256i64</span> <span class="p">(</span><span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id893">
<h5><a class="toc-backref" href="#id2714">Overview:</a><a class="headerlink" href="#id893" title="Permalink to this headline">¶</a></h5>
<p>Predicated, signed division of two vectors of integers.</p>
</div>
<div class="section" id="id894">
<h5><a class="toc-backref" href="#id2715">Arguments:</a><a class="headerlink" href="#id894" title="Permalink to this headline">¶</a></h5>
<p>The first two operands and the result have the same vector of integer type. The
third operand is the vector mask and has the same number of elements as the
result vector type. The fourth operand is the explicit vector length of the
operation.</p>
</div>
<div class="section" id="id895">
<h5><a class="toc-backref" href="#id2716">Semantics:</a><a class="headerlink" href="#id895" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.sdiv</span></code>’ intrinsic performs signed division (<a class="reference internal" href="#i-sdiv"><span class="std std-ref">sdiv</span></a>)
of the first and second vector operand on each enabled lane. The result on
disabled lanes is undefined.</p>
</div>
<div class="section" id="id896">
<h5><a class="toc-backref" href="#id2717">Examples:</a><a class="headerlink" href="#id896" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="vg">@llvm.vp.sdiv.v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%b</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">;; For all lanes below %evl, %r is lane-wise equivalent to %also.r</span>
<span class="nv">%t</span> <span class="p">=</span> <span class="k">sdiv</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="nv">%b</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%t</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="k">undef</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-udiv-intrinsics">
<span id="int-vp-udiv"></span><h4><a class="toc-backref" href="#id2718">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.udiv.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-udiv-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id897">
<h5><a class="toc-backref" href="#id2719">Syntax:</a><a class="headerlink" href="#id897" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">udiv</span><span class="o">.</span><span class="n">v16i32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">udiv</span><span class="o">.</span><span class="n">nxv4i32</span> <span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">udiv</span><span class="o">.</span><span class="n">v256i64</span> <span class="p">(</span><span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id898">
<h5><a class="toc-backref" href="#id2720">Overview:</a><a class="headerlink" href="#id898" title="Permalink to this headline">¶</a></h5>
<p>Predicated, unsigned division of two vectors of integers.</p>
</div>
<div class="section" id="id899">
<h5><a class="toc-backref" href="#id2721">Arguments:</a><a class="headerlink" href="#id899" title="Permalink to this headline">¶</a></h5>
<p>The first two operands and the result have the same vector of integer type. The third operand is the vector mask and has the same number of elements as the result vector type. The fourth operand is the explicit vector length of the operation.</p>
</div>
<div class="section" id="id900">
<h5><a class="toc-backref" href="#id2722">Semantics:</a><a class="headerlink" href="#id900" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.udiv</span></code>’ intrinsic performs unsigned division
(<a class="reference internal" href="#i-udiv"><span class="std std-ref">udiv</span></a>) of the first and second vector operand on each enabled
lane. The result on disabled lanes is undefined.</p>
</div>
<div class="section" id="id901">
<h5><a class="toc-backref" href="#id2723">Examples:</a><a class="headerlink" href="#id901" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="vg">@llvm.vp.udiv.v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%b</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">;; For all lanes below %evl, %r is lane-wise equivalent to %also.r</span>
<span class="nv">%t</span> <span class="p">=</span> <span class="k">udiv</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="nv">%b</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%t</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="k">undef</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-srem-intrinsics">
<span id="int-vp-srem"></span><h4><a class="toc-backref" href="#id2724">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.srem.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-srem-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id902">
<h5><a class="toc-backref" href="#id2725">Syntax:</a><a class="headerlink" href="#id902" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">srem</span><span class="o">.</span><span class="n">v16i32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">srem</span><span class="o">.</span><span class="n">nxv4i32</span> <span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">srem</span><span class="o">.</span><span class="n">v256i64</span> <span class="p">(</span><span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id903">
<h5><a class="toc-backref" href="#id2726">Overview:</a><a class="headerlink" href="#id903" title="Permalink to this headline">¶</a></h5>
<p>Predicated computations of the signed remainder of two integer vectors.</p>
</div>
<div class="section" id="id904">
<h5><a class="toc-backref" href="#id2727">Arguments:</a><a class="headerlink" href="#id904" title="Permalink to this headline">¶</a></h5>
<p>The first two operands and the result have the same vector of integer type. The
third operand is the vector mask and has the same number of elements as the
result vector type. The fourth operand is the explicit vector length of the
operation.</p>
</div>
<div class="section" id="id905">
<h5><a class="toc-backref" href="#id2728">Semantics:</a><a class="headerlink" href="#id905" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.srem</span></code>’ intrinsic computes the remainder of the signed division
(<a class="reference internal" href="#i-srem"><span class="std std-ref">srem</span></a>) of the first and second vector operand on each enabled
lane. The result on disabled lanes is undefined.</p>
</div>
<div class="section" id="id906">
<h5><a class="toc-backref" href="#id2729">Examples:</a><a class="headerlink" href="#id906" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="vg">@llvm.vp.srem.v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%b</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">;; For all lanes below %evl, %r is lane-wise equivalent to %also.r</span>
<span class="nv">%t</span> <span class="p">=</span> <span class="k">srem</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="nv">%b</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%t</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="k">undef</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-urem-intrinsics">
<span id="int-vp-urem"></span><h4><a class="toc-backref" href="#id2730">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.urem.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-urem-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id907">
<h5><a class="toc-backref" href="#id2731">Syntax:</a><a class="headerlink" href="#id907" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">urem</span><span class="o">.</span><span class="n">v16i32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">urem</span><span class="o">.</span><span class="n">nxv4i32</span> <span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">urem</span><span class="o">.</span><span class="n">v256i64</span> <span class="p">(</span><span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id908">
<h5><a class="toc-backref" href="#id2732">Overview:</a><a class="headerlink" href="#id908" title="Permalink to this headline">¶</a></h5>
<p>Predicated computation of the unsigned remainder of two integer vectors.</p>
</div>
<div class="section" id="id909">
<h5><a class="toc-backref" href="#id2733">Arguments:</a><a class="headerlink" href="#id909" title="Permalink to this headline">¶</a></h5>
<p>The first two operands and the result have the same vector of integer type. The
third operand is the vector mask and has the same number of elements as the
result vector type. The fourth operand is the explicit vector length of the
operation.</p>
</div>
<div class="section" id="id910">
<h5><a class="toc-backref" href="#id2734">Semantics:</a><a class="headerlink" href="#id910" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.urem</span></code>’ intrinsic computes the remainder of the unsigned division
(<a class="reference internal" href="#i-urem"><span class="std std-ref">urem</span></a>) of the first and second vector operand on each enabled
lane. The result on disabled lanes is undefined.</p>
</div>
<div class="section" id="id911">
<h5><a class="toc-backref" href="#id2735">Examples:</a><a class="headerlink" href="#id911" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="vg">@llvm.vp.urem.v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%b</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">;; For all lanes below %evl, %r is lane-wise equivalent to %also.r</span>
<span class="nv">%t</span> <span class="p">=</span> <span class="k">urem</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="nv">%b</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%t</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="k">undef</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-ashr-intrinsics">
<span id="int-vp-ashr"></span><h4><a class="toc-backref" href="#id2736">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.ashr.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-ashr-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id912">
<h5><a class="toc-backref" href="#id2737">Syntax:</a><a class="headerlink" href="#id912" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">ashr</span><span class="o">.</span><span class="n">v16i32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">ashr</span><span class="o">.</span><span class="n">nxv4i32</span> <span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">ashr</span><span class="o">.</span><span class="n">v256i64</span> <span class="p">(</span><span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id913">
<h5><a class="toc-backref" href="#id2738">Overview:</a><a class="headerlink" href="#id913" title="Permalink to this headline">¶</a></h5>
<p>Vector-predicated arithmetic right-shift.</p>
</div>
<div class="section" id="id914">
<h5><a class="toc-backref" href="#id2739">Arguments:</a><a class="headerlink" href="#id914" title="Permalink to this headline">¶</a></h5>
<p>The first two operands and the result have the same vector of integer type. The
third operand is the vector mask and has the same number of elements as the
result vector type. The fourth operand is the explicit vector length of the
operation.</p>
</div>
<div class="section" id="id915">
<h5><a class="toc-backref" href="#id2740">Semantics:</a><a class="headerlink" href="#id915" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.ashr</span></code>’ intrinsic computes the arithmetic right shift
(<a class="reference internal" href="#i-ashr"><span class="std std-ref">ashr</span></a>) of the first operand by the second operand on each
enabled lane. The result on disabled lanes is undefined.</p>
</div>
<div class="section" id="id916">
<h5><a class="toc-backref" href="#id2741">Examples:</a><a class="headerlink" href="#id916" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="vg">@llvm.vp.ashr.v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%b</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">;; For all lanes below %evl, %r is lane-wise equivalent to %also.r</span>
<span class="nv">%t</span> <span class="p">=</span> <span class="k">ashr</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="nv">%b</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%t</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="k">undef</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-lshr-intrinsics">
<span id="int-vp-lshr"></span><h4><a class="toc-backref" href="#id2742">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.lshr.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-lshr-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id917">
<h5><a class="toc-backref" href="#id2743">Syntax:</a><a class="headerlink" href="#id917" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">lshr</span><span class="o">.</span><span class="n">v16i32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">lshr</span><span class="o">.</span><span class="n">nxv4i32</span> <span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">lshr</span><span class="o">.</span><span class="n">v256i64</span> <span class="p">(</span><span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id918">
<h5><a class="toc-backref" href="#id2744">Overview:</a><a class="headerlink" href="#id918" title="Permalink to this headline">¶</a></h5>
<p>Vector-predicated logical right-shift.</p>
</div>
<div class="section" id="id919">
<h5><a class="toc-backref" href="#id2745">Arguments:</a><a class="headerlink" href="#id919" title="Permalink to this headline">¶</a></h5>
<p>The first two operands and the result have the same vector of integer type. The
third operand is the vector mask and has the same number of elements as the
result vector type. The fourth operand is the explicit vector length of the
operation.</p>
</div>
<div class="section" id="id920">
<h5><a class="toc-backref" href="#id2746">Semantics:</a><a class="headerlink" href="#id920" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.lshr</span></code>’ intrinsic computes the logical right shift
(<a class="reference internal" href="#i-lshr"><span class="std std-ref">lshr</span></a>) of the first operand by the second operand on each
enabled lane. The result on disabled lanes is undefined.</p>
</div>
<div class="section" id="id921">
<h5><a class="toc-backref" href="#id2747">Examples:</a><a class="headerlink" href="#id921" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="vg">@llvm.vp.lshr.v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%b</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">;; For all lanes below %evl, %r is lane-wise equivalent to %also.r</span>
<span class="nv">%t</span> <span class="p">=</span> <span class="k">lshr</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="nv">%b</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%t</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="k">undef</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-shl-intrinsics">
<span id="int-vp-shl"></span><h4><a class="toc-backref" href="#id2748">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.shl.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-shl-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id922">
<h5><a class="toc-backref" href="#id2749">Syntax:</a><a class="headerlink" href="#id922" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">shl</span><span class="o">.</span><span class="n">v16i32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">shl</span><span class="o">.</span><span class="n">nxv4i32</span> <span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">shl</span><span class="o">.</span><span class="n">v256i64</span> <span class="p">(</span><span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id923">
<h5><a class="toc-backref" href="#id2750">Overview:</a><a class="headerlink" href="#id923" title="Permalink to this headline">¶</a></h5>
<p>Vector-predicated left shift.</p>
</div>
<div class="section" id="id924">
<h5><a class="toc-backref" href="#id2751">Arguments:</a><a class="headerlink" href="#id924" title="Permalink to this headline">¶</a></h5>
<p>The first two operands and the result have the same vector of integer type. The
third operand is the vector mask and has the same number of elements as the
result vector type. The fourth operand is the explicit vector length of the
operation.</p>
</div>
<div class="section" id="id925">
<h5><a class="toc-backref" href="#id2752">Semantics:</a><a class="headerlink" href="#id925" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.shl</span></code>’ intrinsic computes the left shift (<a class="reference internal" href="#i-shl"><span class="std std-ref">shl</span></a>) of
the first operand by the second operand on each enabled lane. The result on
disabled lanes is undefined.</p>
</div>
<div class="section" id="id926">
<h5><a class="toc-backref" href="#id2753">Examples:</a><a class="headerlink" href="#id926" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="vg">@llvm.vp.shl.v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%b</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">;; For all lanes below %evl, %r is lane-wise equivalent to %also.r</span>
<span class="nv">%t</span> <span class="p">=</span> <span class="k">shl</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="nv">%b</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%t</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="k">undef</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-or-intrinsics">
<span id="int-vp-or"></span><h4><a class="toc-backref" href="#id2754">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.or.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-or-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id927">
<h5><a class="toc-backref" href="#id2755">Syntax:</a><a class="headerlink" href="#id927" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="ow">or</span><span class="o">.</span><span class="n">v16i32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="ow">or</span><span class="o">.</span><span class="n">nxv4i32</span> <span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="ow">or</span><span class="o">.</span><span class="n">v256i64</span> <span class="p">(</span><span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id928">
<h5><a class="toc-backref" href="#id2756">Overview:</a><a class="headerlink" href="#id928" title="Permalink to this headline">¶</a></h5>
<p>Vector-predicated or.</p>
</div>
<div class="section" id="id929">
<h5><a class="toc-backref" href="#id2757">Arguments:</a><a class="headerlink" href="#id929" title="Permalink to this headline">¶</a></h5>
<p>The first two operands and the result have the same vector of integer type. The
third operand is the vector mask and has the same number of elements as the
result vector type. The fourth operand is the explicit vector length of the
operation.</p>
</div>
<div class="section" id="id930">
<h5><a class="toc-backref" href="#id2758">Semantics:</a><a class="headerlink" href="#id930" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.or</span></code>’ intrinsic performs a bitwise or (<a class="reference internal" href="#i-or"><span class="std std-ref">or</span></a>) of the
first two operands on each enabled lane. The result on disabled lanes is
undefined.</p>
</div>
<div class="section" id="id931">
<h5><a class="toc-backref" href="#id2759">Examples:</a><a class="headerlink" href="#id931" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="vg">@llvm.vp.or.v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%b</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">;; For all lanes below %evl, %r is lane-wise equivalent to %also.r</span>
<span class="nv">%t</span> <span class="p">=</span> <span class="k">or</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="nv">%b</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%t</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="k">undef</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-and-intrinsics">
<span id="int-vp-and"></span><h4><a class="toc-backref" href="#id2760">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.and.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-and-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id932">
<h5><a class="toc-backref" href="#id2761">Syntax:</a><a class="headerlink" href="#id932" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="ow">and</span><span class="o">.</span><span class="n">v16i32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="ow">and</span><span class="o">.</span><span class="n">nxv4i32</span> <span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="ow">and</span><span class="o">.</span><span class="n">v256i64</span> <span class="p">(</span><span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id933">
<h5><a class="toc-backref" href="#id2762">Overview:</a><a class="headerlink" href="#id933" title="Permalink to this headline">¶</a></h5>
<p>Vector-predicated and.</p>
</div>
<div class="section" id="id934">
<h5><a class="toc-backref" href="#id2763">Arguments:</a><a class="headerlink" href="#id934" title="Permalink to this headline">¶</a></h5>
<p>The first two operands and the result have the same vector of integer type. The
third operand is the vector mask and has the same number of elements as the
result vector type. The fourth operand is the explicit vector length of the
operation.</p>
</div>
<div class="section" id="id935">
<h5><a class="toc-backref" href="#id2764">Semantics:</a><a class="headerlink" href="#id935" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.and</span></code>’ intrinsic performs a bitwise and (<a class="reference internal" href="#i-or"><span class="std std-ref">and</span></a>) of
the first two operands on each enabled lane. The result on disabled lanes is
undefined.</p>
</div>
<div class="section" id="id936">
<h5><a class="toc-backref" href="#id2765">Examples:</a><a class="headerlink" href="#id936" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="vg">@llvm.vp.and.v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%b</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">;; For all lanes below %evl, %r is lane-wise equivalent to %also.r</span>
<span class="nv">%t</span> <span class="p">=</span> <span class="k">and</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="nv">%b</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%t</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="k">undef</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-xor-intrinsics">
<span id="int-vp-xor"></span><h4><a class="toc-backref" href="#id2766">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.xor.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-xor-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id937">
<h5><a class="toc-backref" href="#id2767">Syntax:</a><a class="headerlink" href="#id937" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">xor</span><span class="o">.</span><span class="n">v16i32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">xor</span><span class="o">.</span><span class="n">nxv4i32</span> <span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">xor</span><span class="o">.</span><span class="n">v256i64</span> <span class="p">(</span><span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id938">
<h5><a class="toc-backref" href="#id2768">Overview:</a><a class="headerlink" href="#id938" title="Permalink to this headline">¶</a></h5>
<p>Vector-predicated, bitwise xor.</p>
</div>
<div class="section" id="id939">
<h5><a class="toc-backref" href="#id2769">Arguments:</a><a class="headerlink" href="#id939" title="Permalink to this headline">¶</a></h5>
<p>The first two operands and the result have the same vector of integer type. The
third operand is the vector mask and has the same number of elements as the
result vector type. The fourth operand is the explicit vector length of the
operation.</p>
</div>
<div class="section" id="id940">
<h5><a class="toc-backref" href="#id2770">Semantics:</a><a class="headerlink" href="#id940" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.xor</span></code>’ intrinsic performs a bitwise xor (<a class="reference internal" href="#i-xor"><span class="std std-ref">xor</span></a>) of
the first two operands on each enabled lane.
The result on disabled lanes is undefined.</p>
</div>
<div class="section" id="id941">
<h5><a class="toc-backref" href="#id2771">Examples:</a><a class="headerlink" href="#id941" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="vg">@llvm.vp.xor.v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%b</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">;; For all lanes below %evl, %r is lane-wise equivalent to %also.r</span>
<span class="nv">%t</span> <span class="p">=</span> <span class="k">xor</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="nv">%b</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%t</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="k">undef</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-fadd-intrinsics">
<span id="int-vp-fadd"></span><h4><a class="toc-backref" href="#id2772">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.fadd.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-fadd-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id942">
<h5><a class="toc-backref" href="#id2773">Syntax:</a><a class="headerlink" href="#id942" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">fadd</span><span class="o">.</span><span class="n">v16f32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">fadd</span><span class="o">.</span><span class="n">nxv4f32</span> <span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">fadd</span><span class="o">.</span><span class="n">v256f64</span> <span class="p">(</span><span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id943">
<h5><a class="toc-backref" href="#id2774">Overview:</a><a class="headerlink" href="#id943" title="Permalink to this headline">¶</a></h5>
<p>Predicated floating-point addition of two vectors of floating-point values.</p>
</div>
<div class="section" id="id944">
<h5><a class="toc-backref" href="#id2775">Arguments:</a><a class="headerlink" href="#id944" title="Permalink to this headline">¶</a></h5>
<p>The first two operands and the result have the same vector of floating-point type. The
third operand is the vector mask and has the same number of elements as the
result vector type. The fourth operand is the explicit vector length of the
operation.</p>
</div>
<div class="section" id="id945">
<h5><a class="toc-backref" href="#id2776">Semantics:</a><a class="headerlink" href="#id945" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.fadd</span></code>’ intrinsic performs floating-point addition (<a class="reference internal" href="#i-fadd"><span class="std std-ref">add</span></a>)
of the first and second vector operand on each enabled lane. The result on
disabled lanes is undefined. The operation is performed in the default
floating-point environment.</p>
</div>
<div class="section" id="id946">
<h5><a class="toc-backref" href="#id2777">Examples:</a><a class="headerlink" href="#id946" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="vg">@llvm.vp.fadd.v4f32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%b</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">;; For all lanes below %evl, %r is lane-wise equivalent to %also.r</span>
<span class="nv">%t</span> <span class="p">=</span> <span class="k">fadd</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="nv">%b</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%t</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="k">undef</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-fsub-intrinsics">
<span id="int-vp-fsub"></span><h4><a class="toc-backref" href="#id2778">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.fsub.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-fsub-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id947">
<h5><a class="toc-backref" href="#id2779">Syntax:</a><a class="headerlink" href="#id947" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">fsub</span><span class="o">.</span><span class="n">v16f32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">fsub</span><span class="o">.</span><span class="n">nxv4f32</span> <span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">fsub</span><span class="o">.</span><span class="n">v256f64</span> <span class="p">(</span><span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id948">
<h5><a class="toc-backref" href="#id2780">Overview:</a><a class="headerlink" href="#id948" title="Permalink to this headline">¶</a></h5>
<p>Predicated floating-point subtraction of two vectors of floating-point values.</p>
</div>
<div class="section" id="id949">
<h5><a class="toc-backref" href="#id2781">Arguments:</a><a class="headerlink" href="#id949" title="Permalink to this headline">¶</a></h5>
<p>The first two operands and the result have the same vector of floating-point type. The
third operand is the vector mask and has the same number of elements as the
result vector type. The fourth operand is the explicit vector length of the
operation.</p>
</div>
<div class="section" id="id950">
<h5><a class="toc-backref" href="#id2782">Semantics:</a><a class="headerlink" href="#id950" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.fsub</span></code>’ intrinsic performs floating-point subtraction (<a class="reference internal" href="#i-fsub"><span class="std std-ref">add</span></a>)
of the first and second vector operand on each enabled lane. The result on
disabled lanes is undefined. The operation is performed in the default
floating-point environment.</p>
</div>
<div class="section" id="id951">
<h5><a class="toc-backref" href="#id2783">Examples:</a><a class="headerlink" href="#id951" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="vg">@llvm.vp.fsub.v4f32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%b</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">;; For all lanes below %evl, %r is lane-wise equivalent to %also.r</span>
<span class="nv">%t</span> <span class="p">=</span> <span class="k">fsub</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="nv">%b</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%t</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="k">undef</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-fmul-intrinsics">
<span id="int-vp-fmul"></span><h4><a class="toc-backref" href="#id2784">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.fmul.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-fmul-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id952">
<h5><a class="toc-backref" href="#id2785">Syntax:</a><a class="headerlink" href="#id952" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">fmul</span><span class="o">.</span><span class="n">v16f32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">fmul</span><span class="o">.</span><span class="n">nxv4f32</span> <span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">fmul</span><span class="o">.</span><span class="n">v256f64</span> <span class="p">(</span><span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id953">
<h5><a class="toc-backref" href="#id2786">Overview:</a><a class="headerlink" href="#id953" title="Permalink to this headline">¶</a></h5>
<p>Predicated floating-point multiplication of two vectors of floating-point values.</p>
</div>
<div class="section" id="id954">
<h5><a class="toc-backref" href="#id2787">Arguments:</a><a class="headerlink" href="#id954" title="Permalink to this headline">¶</a></h5>
<p>The first two operands and the result have the same vector of floating-point type. The
third operand is the vector mask and has the same number of elements as the
result vector type. The fourth operand is the explicit vector length of the
operation.</p>
</div>
<div class="section" id="id955">
<h5><a class="toc-backref" href="#id2788">Semantics:</a><a class="headerlink" href="#id955" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.fmul</span></code>’ intrinsic performs floating-point multiplication (<a class="reference internal" href="#i-fmul"><span class="std std-ref">add</span></a>)
of the first and second vector operand on each enabled lane. The result on
disabled lanes is undefined. The operation is performed in the default
floating-point environment.</p>
</div>
<div class="section" id="id956">
<h5><a class="toc-backref" href="#id2789">Examples:</a><a class="headerlink" href="#id956" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="vg">@llvm.vp.fmul.v4f32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%b</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">;; For all lanes below %evl, %r is lane-wise equivalent to %also.r</span>
<span class="nv">%t</span> <span class="p">=</span> <span class="k">fmul</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="nv">%b</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%t</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="k">undef</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-fdiv-intrinsics">
<span id="int-vp-fdiv"></span><h4><a class="toc-backref" href="#id2790">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.fdiv.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-fdiv-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id957">
<h5><a class="toc-backref" href="#id2791">Syntax:</a><a class="headerlink" href="#id957" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">fdiv</span><span class="o">.</span><span class="n">v16f32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">fdiv</span><span class="o">.</span><span class="n">nxv4f32</span> <span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">fdiv</span><span class="o">.</span><span class="n">v256f64</span> <span class="p">(</span><span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id958">
<h5><a class="toc-backref" href="#id2792">Overview:</a><a class="headerlink" href="#id958" title="Permalink to this headline">¶</a></h5>
<p>Predicated floating-point division of two vectors of floating-point values.</p>
</div>
<div class="section" id="id959">
<h5><a class="toc-backref" href="#id2793">Arguments:</a><a class="headerlink" href="#id959" title="Permalink to this headline">¶</a></h5>
<p>The first two operands and the result have the same vector of floating-point type. The
third operand is the vector mask and has the same number of elements as the
result vector type. The fourth operand is the explicit vector length of the
operation.</p>
</div>
<div class="section" id="id960">
<h5><a class="toc-backref" href="#id2794">Semantics:</a><a class="headerlink" href="#id960" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.fdiv</span></code>’ intrinsic performs floating-point division (<a class="reference internal" href="#i-fdiv"><span class="std std-ref">add</span></a>)
of the first and second vector operand on each enabled lane. The result on
disabled lanes is undefined. The operation is performed in the default
floating-point environment.</p>
</div>
<div class="section" id="id961">
<h5><a class="toc-backref" href="#id2795">Examples:</a><a class="headerlink" href="#id961" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="vg">@llvm.vp.fdiv.v4f32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%b</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">;; For all lanes below %evl, %r is lane-wise equivalent to %also.r</span>
<span class="nv">%t</span> <span class="p">=</span> <span class="k">fdiv</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="nv">%b</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%t</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="k">undef</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-frem-intrinsics">
<span id="int-vp-frem"></span><h4><a class="toc-backref" href="#id2796">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.frem.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-frem-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id962">
<h5><a class="toc-backref" href="#id2797">Syntax:</a><a class="headerlink" href="#id962" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">frem</span><span class="o">.</span><span class="n">v16f32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">frem</span><span class="o">.</span><span class="n">nxv4f32</span> <span class="p">(</span><span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">frem</span><span class="o">.</span><span class="n">v256f64</span> <span class="p">(</span><span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o"><</span><span class="n">left_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o"><</span><span class="n">right_op</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">256</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id963">
<h5><a class="toc-backref" href="#id2798">Overview:</a><a class="headerlink" href="#id963" title="Permalink to this headline">¶</a></h5>
<p>Predicated floating-point remainder of two vectors of floating-point values.</p>
</div>
<div class="section" id="id964">
<h5><a class="toc-backref" href="#id2799">Arguments:</a><a class="headerlink" href="#id964" title="Permalink to this headline">¶</a></h5>
<p>The first two operands and the result have the same vector of floating-point type. The
third operand is the vector mask and has the same number of elements as the
result vector type. The fourth operand is the explicit vector length of the
operation.</p>
</div>
<div class="section" id="id965">
<h5><a class="toc-backref" href="#id2800">Semantics:</a><a class="headerlink" href="#id965" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.frem</span></code>’ intrinsic performs floating-point remainder (<a class="reference internal" href="#i-frem"><span class="std std-ref">add</span></a>)
of the first and second vector operand on each enabled lane. The result on
disabled lanes is undefined. The operation is performed in the default
floating-point environment.</p>
</div>
<div class="section" id="id966">
<h5><a class="toc-backref" href="#id2801">Examples:</a><a class="headerlink" href="#id966" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="vg">@llvm.vp.frem.v4f32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%b</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">;; For all lanes below %evl, %r is lane-wise equivalent to %also.r</span>
<span class="nv">%t</span> <span class="p">=</span> <span class="k">frem</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="nv">%b</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%t</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="k">undef</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-reduce-add-intrinsics">
<span id="int-vp-reduce-add"></span><h4><a class="toc-backref" href="#id2802">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.add.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-reduce-add-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id967">
<h5><a class="toc-backref" href="#id2803">Syntax:</a><a class="headerlink" href="#id967" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<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">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">add</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">add</span><span class="o">.</span><span class="n">nxv8i16</span><span class="p">(</span><span class="n">i16</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i16</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id968">
<h5><a class="toc-backref" href="#id2804">Overview:</a><a class="headerlink" href="#id968" title="Permalink to this headline">¶</a></h5>
<p>Predicated integer <code class="docutils literal notranslate"><span class="pre">ADD</span></code> reduction of a vector and a scalar starting value,
returning the result as a scalar.</p>
</div>
<div class="section" id="id969">
<h5><a class="toc-backref" href="#id2805">Arguments:</a><a class="headerlink" href="#id969" title="Permalink to this headline">¶</a></h5>
<p>The first operand is the start value of the reduction, which must be a scalar
integer type equal to the result type. The second operand is the vector on
which the reduction is performed and must be a vector of integer values whose
element type is the result/start type. The third operand is the vector mask and
is a vector of boolean values with the same number of elements as the vector
operand. The fourth operand is the explicit vector length of the operation.</p>
</div>
<div class="section" id="id970">
<h5><a class="toc-backref" href="#id2806">Semantics:</a><a class="headerlink" href="#id970" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.add</span></code>’ intrinsic performs the integer <code class="docutils literal notranslate"><span class="pre">ADD</span></code> reduction
(<a class="reference internal" href="#int-vector-reduce-add"><span class="std std-ref">llvm.vector.reduce.add</span></a>) of the vector operand
<code class="docutils literal notranslate"><span class="pre">val</span></code> on each enabled lane, adding it to the scalar <code class="docutils literal notranslate"><span class="pre">start_value</span></code>. Disabled
lanes are treated as containing the neutral value <code class="docutils literal notranslate"><span class="pre">0</span></code> (i.e. having no effect
on the reduction operation). If the vector length is zero, the result is equal
to <code class="docutils literal notranslate"><span class="pre">start_value</span></code>.</p>
<p>To ignore the start value, the neutral value can be used.</p>
</div>
<div class="section" id="id971">
<h5><a class="toc-backref" href="#id2807">Examples:</a><a class="headerlink" href="#id971" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@llvm.vp.reduce.add.v4i32</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%start</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">; %r is equivalent to %also.r, where lanes greater than or equal to %evl</span>
<span class="c">; are treated as though %mask were false for those lanes.</span>
<span class="nv">%masked.a</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="k">zeroinitializer</span>
<span class="nv">%reduction</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@llvm.vector.reduce.add.v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%masked.a</span><span class="p">)</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">add</span> <span class="k">i32</span> <span class="nv">%reduction</span><span class="p">,</span> <span class="nv">%start</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-reduce-fadd-intrinsics">
<span id="int-vp-reduce-fadd"></span><h4><a class="toc-backref" href="#id2808">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.fadd.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-reduce-fadd-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id972">
<h5><a class="toc-backref" href="#id2809">Syntax:</a><a class="headerlink" href="#id972" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">fadd</span><span class="o">.</span><span class="n">v4f32</span><span class="p">(</span><span class="nb">float</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">fadd</span><span class="o">.</span><span class="n">nxv8f64</span><span class="p">(</span><span class="n">double</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id973">
<h5><a class="toc-backref" href="#id2810">Overview:</a><a class="headerlink" href="#id973" title="Permalink to this headline">¶</a></h5>
<p>Predicated floating-point <code class="docutils literal notranslate"><span class="pre">ADD</span></code> reduction of a vector and a scalar starting
value, returning the result as a scalar.</p>
</div>
<div class="section" id="id974">
<h5><a class="toc-backref" href="#id2811">Arguments:</a><a class="headerlink" href="#id974" title="Permalink to this headline">¶</a></h5>
<p>The first operand is the start value of the reduction, which must be a scalar
floating-point type equal to the result type. The second operand is the vector
on which the reduction is performed and must be a vector of floating-point
values whose element type is the result/start type. The third operand is the
vector mask and is a vector of boolean values with the same number of elements
as the vector operand. The fourth operand is the explicit vector length of the
operation.</p>
</div>
<div class="section" id="id975">
<h5><a class="toc-backref" href="#id2812">Semantics:</a><a class="headerlink" href="#id975" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.fadd</span></code>’ intrinsic performs the floating-point <code class="docutils literal notranslate"><span class="pre">ADD</span></code>
reduction (<a class="reference internal" href="#int-vector-reduce-fadd"><span class="std std-ref">llvm.vector.reduce.fadd</span></a>) of the
vector operand <code class="docutils literal notranslate"><span class="pre">val</span></code> on each enabled lane, adding it to the scalar
<code class="docutils literal notranslate"><span class="pre">start_value</span></code>. Disabled lanes are treated as containing the neutral value
<code class="docutils literal notranslate"><span class="pre">-0.0</span></code> (i.e. having no effect on the reduction operation). If no lanes are
enabled, the resulting value will be equal to <code class="docutils literal notranslate"><span class="pre">start_value</span></code>.</p>
<p>To ignore the start value, the neutral value can be used.</p>
<p>See the unpredicated version (<a class="reference internal" href="#int-vector-reduce-fadd"><span class="std std-ref">llvm.vector.reduce.fadd</span></a>) for more detail on the semantics of the reduction.</p>
</div>
<div class="section" id="id976">
<h5><a class="toc-backref" href="#id2813">Examples:</a><a class="headerlink" href="#id976" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="k">float</span> <span class="vg">@llvm.vp.reduce.fadd.v4f32</span><span class="p">(</span><span class="k">float</span> <span class="nv">%start</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">; %r is equivalent to %also.r, where lanes greater than or equal to %evl</span>
<span class="c">; are treated as though %mask were false for those lanes.</span>
<span class="nv">%masked.a</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="p"><</span><span class="k">float</span> <span class="m">-0.0</span><span class="p">,</span> <span class="k">float</span> <span class="m">-0.0</span><span class="p">,</span> <span class="k">float</span> <span class="m">-0.0</span><span class="p">,</span> <span class="k">float</span> <span class="m">-0.0</span><span class="p">></span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">call</span> <span class="k">float</span> <span class="vg">@llvm.vector.reduce.fadd.v4f32</span><span class="p">(</span><span class="k">float</span> <span class="nv">%start</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%masked.a</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-reduce-mul-intrinsics">
<span id="int-vp-reduce-mul"></span><h4><a class="toc-backref" href="#id2814">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.mul.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-reduce-mul-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id977">
<h5><a class="toc-backref" href="#id2815">Syntax:</a><a class="headerlink" href="#id977" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<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">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">mul</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">mul</span><span class="o">.</span><span class="n">nxv8i16</span><span class="p">(</span><span class="n">i16</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i16</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id978">
<h5><a class="toc-backref" href="#id2816">Overview:</a><a class="headerlink" href="#id978" title="Permalink to this headline">¶</a></h5>
<p>Predicated integer <code class="docutils literal notranslate"><span class="pre">MUL</span></code> reduction of a vector and a scalar starting value,
returning the result as a scalar.</p>
</div>
<div class="section" id="id979">
<h5><a class="toc-backref" href="#id2817">Arguments:</a><a class="headerlink" href="#id979" title="Permalink to this headline">¶</a></h5>
<p>The first operand is the start value of the reduction, which must be a scalar
integer type equal to the result type. The second operand is the vector on
which the reduction is performed and must be a vector of integer values whose
element type is the result/start type. The third operand is the vector mask and
is a vector of boolean values with the same number of elements as the vector
operand. The fourth operand is the explicit vector length of the operation.</p>
</div>
<div class="section" id="id980">
<h5><a class="toc-backref" href="#id2818">Semantics:</a><a class="headerlink" href="#id980" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.mul</span></code>’ intrinsic performs the integer <code class="docutils literal notranslate"><span class="pre">MUL</span></code> reduction
(<a class="reference internal" href="#int-vector-reduce-mul"><span class="std std-ref">llvm.vector.reduce.mul</span></a>) of the vector operand <code class="docutils literal notranslate"><span class="pre">val</span></code>
on each enabled lane, multiplying it by the scalar <code class="docutils literal notranslate"><span class="pre">start_value</span></code>. Disabled
lanes are treated as containing the neutral value <code class="docutils literal notranslate"><span class="pre">1</span></code> (i.e. having no effect
on the reduction operation). If the vector length is zero, the result is the
start value.</p>
<p>To ignore the start value, the neutral value can be used.</p>
</div>
<div class="section" id="id981">
<h5><a class="toc-backref" href="#id2819">Examples:</a><a class="headerlink" href="#id981" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@llvm.vp.reduce.mul.v4i32</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%start</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">; %r is equivalent to %also.r, where lanes greater than or equal to %evl</span>
<span class="c">; are treated as though %mask were false for those lanes.</span>
<span class="nv">%masked.a</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="p"><</span><span class="k">i32</span> <span class="m">1</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">,</span> <span class="k">i32</span> <span class="m">1</span><span class="p">></span>
<span class="nv">%reduction</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@llvm.vector.reduce.mul.v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%masked.a</span><span class="p">)</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">mul</span> <span class="k">i32</span> <span class="nv">%reduction</span><span class="p">,</span> <span class="nv">%start</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-reduce-fmul-intrinsics">
<span id="int-vp-reduce-fmul"></span><h4><a class="toc-backref" href="#id2820">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.fmul.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-reduce-fmul-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id982">
<h5><a class="toc-backref" href="#id2821">Syntax:</a><a class="headerlink" href="#id982" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">fmul</span><span class="o">.</span><span class="n">v4f32</span><span class="p">(</span><span class="nb">float</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">fmul</span><span class="o">.</span><span class="n">nxv8f64</span><span class="p">(</span><span class="n">double</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id983">
<h5><a class="toc-backref" href="#id2822">Overview:</a><a class="headerlink" href="#id983" title="Permalink to this headline">¶</a></h5>
<p>Predicated floating-point <code class="docutils literal notranslate"><span class="pre">MUL</span></code> reduction of a vector and a scalar starting
value, returning the result as a scalar.</p>
</div>
<div class="section" id="id984">
<h5><a class="toc-backref" href="#id2823">Arguments:</a><a class="headerlink" href="#id984" title="Permalink to this headline">¶</a></h5>
<p>The first operand is the start value of the reduction, which must be a scalar
floating-point type equal to the result type. The second operand is the vector
on which the reduction is performed and must be a vector of floating-point
values whose element type is the result/start type. The third operand is the
vector mask and is a vector of boolean values with the same number of elements
as the vector operand. The fourth operand is the explicit vector length of the
operation.</p>
</div>
<div class="section" id="id985">
<h5><a class="toc-backref" href="#id2824">Semantics:</a><a class="headerlink" href="#id985" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.fmul</span></code>’ intrinsic performs the floating-point <code class="docutils literal notranslate"><span class="pre">MUL</span></code>
reduction (<a class="reference internal" href="#int-vector-reduce-fmul"><span class="std std-ref">llvm.vector.reduce.fmul</span></a>) of the
vector operand <code class="docutils literal notranslate"><span class="pre">val</span></code> on each enabled lane, multiplying it by the scalar
<cite>start_value`</cite>. Disabled lanes are treated as containing the neutral value
<code class="docutils literal notranslate"><span class="pre">1.0</span></code> (i.e. having no effect on the reduction operation). If no lanes are
enabled, the resulting value will be equal to the starting value.</p>
<p>To ignore the start value, the neutral value can be used.</p>
<p>See the unpredicated version (<a class="reference internal" href="#int-vector-reduce-fmul"><span class="std std-ref">llvm.vector.reduce.fmul</span></a>) for more detail on the semantics.</p>
</div>
<div class="section" id="id986">
<h5><a class="toc-backref" href="#id2825">Examples:</a><a class="headerlink" href="#id986" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="k">float</span> <span class="vg">@llvm.vp.reduce.fmul.v4f32</span><span class="p">(</span><span class="k">float</span> <span class="nv">%start</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">; %r is equivalent to %also.r, where lanes greater than or equal to %evl</span>
<span class="c">; are treated as though %mask were false for those lanes.</span>
<span class="nv">%masked.a</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="p"><</span><span class="k">float</span> <span class="m">1.0</span><span class="p">,</span> <span class="k">float</span> <span class="m">1.0</span><span class="p">,</span> <span class="k">float</span> <span class="m">1.0</span><span class="p">,</span> <span class="k">float</span> <span class="m">1.0</span><span class="p">></span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">call</span> <span class="k">float</span> <span class="vg">@llvm.vector.reduce.fmul.v4f32</span><span class="p">(</span><span class="k">float</span> <span class="nv">%start</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">float</span><span class="p">></span> <span class="nv">%masked.a</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-reduce-and-intrinsics">
<span id="int-vp-reduce-and"></span><h4><a class="toc-backref" href="#id2826">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.and.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-reduce-and-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id987">
<h5><a class="toc-backref" href="#id2827">Syntax:</a><a class="headerlink" href="#id987" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<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">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="ow">and</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="ow">and</span><span class="o">.</span><span class="n">nxv8i16</span><span class="p">(</span><span class="n">i16</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i16</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id988">
<h5><a class="toc-backref" href="#id2828">Overview:</a><a class="headerlink" href="#id988" title="Permalink to this headline">¶</a></h5>
<p>Predicated integer <code class="docutils literal notranslate"><span class="pre">AND</span></code> reduction of a vector and a scalar starting value,
returning the result as a scalar.</p>
</div>
<div class="section" id="id989">
<h5><a class="toc-backref" href="#id2829">Arguments:</a><a class="headerlink" href="#id989" title="Permalink to this headline">¶</a></h5>
<p>The first operand is the start value of the reduction, which must be a scalar
integer type equal to the result type. The second operand is the vector on
which the reduction is performed and must be a vector of integer values whose
element type is the result/start type. The third operand is the vector mask and
is a vector of boolean values with the same number of elements as the vector
operand. The fourth operand is the explicit vector length of the operation.</p>
</div>
<div class="section" id="id990">
<h5><a class="toc-backref" href="#id2830">Semantics:</a><a class="headerlink" href="#id990" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.and</span></code>’ intrinsic performs the integer <code class="docutils literal notranslate"><span class="pre">AND</span></code> reduction
(<a class="reference internal" href="#int-vector-reduce-and"><span class="std std-ref">llvm.vector.reduce.and</span></a>) of the vector operand
<code class="docutils literal notranslate"><span class="pre">val</span></code> on each enabled lane, performing an ‘<code class="docutils literal notranslate"><span class="pre">and</span></code>’ of that with with the
scalar <code class="docutils literal notranslate"><span class="pre">start_value</span></code>. Disabled lanes are treated as containing the neutral
value <code class="docutils literal notranslate"><span class="pre">UINT_MAX</span></code>, or <code class="docutils literal notranslate"><span class="pre">-1</span></code> (i.e. having no effect on the reduction
operation). If the vector length is zero, the result is the start value.</p>
<p>To ignore the start value, the neutral value can be used.</p>
</div>
<div class="section" id="id991">
<h5><a class="toc-backref" href="#id2831">Examples:</a><a class="headerlink" href="#id991" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@llvm.vp.reduce.and.v4i32</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%start</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">; %r is equivalent to %also.r, where lanes greater than or equal to %evl</span>
<span class="c">; are treated as though %mask were false for those lanes.</span>
<span class="nv">%masked.a</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="p"><</span><span class="k">i32</span> <span class="m">-1</span><span class="p">,</span> <span class="k">i32</span> <span class="m">-1</span><span class="p">,</span> <span class="k">i32</span> <span class="m">-1</span><span class="p">,</span> <span class="k">i32</span> <span class="m">-1</span><span class="p">></span>
<span class="nv">%reduction</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@llvm.vector.reduce.and.v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%masked.a</span><span class="p">)</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">and</span> <span class="k">i32</span> <span class="nv">%reduction</span><span class="p">,</span> <span class="nv">%start</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-reduce-or-intrinsics">
<span id="int-vp-reduce-or"></span><h4><a class="toc-backref" href="#id2832">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.or.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-reduce-or-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id992">
<h5><a class="toc-backref" href="#id2833">Syntax:</a><a class="headerlink" href="#id992" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<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">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="ow">or</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="ow">or</span><span class="o">.</span><span class="n">nxv8i16</span><span class="p">(</span><span class="n">i16</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i16</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id993">
<h5><a class="toc-backref" href="#id2834">Overview:</a><a class="headerlink" href="#id993" title="Permalink to this headline">¶</a></h5>
<p>Predicated integer <code class="docutils literal notranslate"><span class="pre">OR</span></code> reduction of a vector and a scalar starting value,
returning the result as a scalar.</p>
</div>
<div class="section" id="id994">
<h5><a class="toc-backref" href="#id2835">Arguments:</a><a class="headerlink" href="#id994" title="Permalink to this headline">¶</a></h5>
<p>The first operand is the start value of the reduction, which must be a scalar
integer type equal to the result type. The second operand is the vector on
which the reduction is performed and must be a vector of integer values whose
element type is the result/start type. The third operand is the vector mask and
is a vector of boolean values with the same number of elements as the vector
operand. The fourth operand is the explicit vector length of the operation.</p>
</div>
<div class="section" id="id995">
<h5><a class="toc-backref" href="#id2836">Semantics:</a><a class="headerlink" href="#id995" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.or</span></code>’ intrinsic performs the integer <code class="docutils literal notranslate"><span class="pre">OR</span></code> reduction
(<a class="reference internal" href="#int-vector-reduce-or"><span class="std std-ref">llvm.vector.reduce.or</span></a>) of the vector operand
<code class="docutils literal notranslate"><span class="pre">val</span></code> on each enabled lane, performing an ‘<code class="docutils literal notranslate"><span class="pre">or</span></code>’ of that with the scalar
<code class="docutils literal notranslate"><span class="pre">start_value</span></code>. Disabled lanes are treated as containing the neutral value
<code class="docutils literal notranslate"><span class="pre">0</span></code> (i.e. having no effect on the reduction operation). If the vector length
is zero, the result is the start value.</p>
<p>To ignore the start value, the neutral value can be used.</p>
</div>
<div class="section" id="id996">
<h5><a class="toc-backref" href="#id2837">Examples:</a><a class="headerlink" href="#id996" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@llvm.vp.reduce.or.v4i32</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%start</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">; %r is equivalent to %also.r, where lanes greater than or equal to %evl</span>
<span class="c">; are treated as though %mask were false for those lanes.</span>
<span class="nv">%masked.a</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></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="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="p">></span>
<span class="nv">%reduction</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@llvm.vector.reduce.or.v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%masked.a</span><span class="p">)</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">or</span> <span class="k">i32</span> <span class="nv">%reduction</span><span class="p">,</span> <span class="nv">%start</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-reduce-xor-intrinsics">
<span id="int-vp-reduce-xor"></span><h4><a class="toc-backref" href="#id2838">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.xor.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-reduce-xor-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id997">
<h5><a class="toc-backref" href="#id2839">Syntax:</a><a class="headerlink" href="#id997" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<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">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">xor</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">xor</span><span class="o">.</span><span class="n">nxv8i16</span><span class="p">(</span><span class="n">i16</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i16</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id998">
<h5><a class="toc-backref" href="#id2840">Overview:</a><a class="headerlink" href="#id998" title="Permalink to this headline">¶</a></h5>
<p>Predicated integer <code class="docutils literal notranslate"><span class="pre">XOR</span></code> reduction of a vector and a scalar starting value,
returning the result as a scalar.</p>
</div>
<div class="section" id="id999">
<h5><a class="toc-backref" href="#id2841">Arguments:</a><a class="headerlink" href="#id999" title="Permalink to this headline">¶</a></h5>
<p>The first operand is the start value of the reduction, which must be a scalar
integer type equal to the result type. The second operand is the vector on
which the reduction is performed and must be a vector of integer values whose
element type is the result/start type. The third operand is the vector mask and
is a vector of boolean values with the same number of elements as the vector
operand. The fourth operand is the explicit vector length of the operation.</p>
</div>
<div class="section" id="id1000">
<h5><a class="toc-backref" href="#id2842">Semantics:</a><a class="headerlink" href="#id1000" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.xor</span></code>’ intrinsic performs the integer <code class="docutils literal notranslate"><span class="pre">XOR</span></code> reduction
(<a class="reference internal" href="#int-vector-reduce-xor"><span class="std std-ref">llvm.vector.reduce.xor</span></a>) of the vector operand
<code class="docutils literal notranslate"><span class="pre">val</span></code> on each enabled lane, performing an ‘<code class="docutils literal notranslate"><span class="pre">xor</span></code>’ of that with the scalar
<code class="docutils literal notranslate"><span class="pre">start_value</span></code>. Disabled lanes are treated as containing the neutral value
<code class="docutils literal notranslate"><span class="pre">0</span></code> (i.e. having no effect on the reduction operation). If the vector length
is zero, the result is the start value.</p>
<p>To ignore the start value, the neutral value can be used.</p>
</div>
<div class="section" id="id1001">
<h5><a class="toc-backref" href="#id2843">Examples:</a><a class="headerlink" href="#id1001" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@llvm.vp.reduce.xor.v4i32</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%start</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">; %r is equivalent to %also.r, where lanes greater than or equal to %evl</span>
<span class="c">; are treated as though %mask were false for those lanes.</span>
<span class="nv">%masked.a</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></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="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="p">></span>
<span class="nv">%reduction</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@llvm.vector.reduce.xor.v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%masked.a</span><span class="p">)</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">xor</span> <span class="k">i32</span> <span class="nv">%reduction</span><span class="p">,</span> <span class="nv">%start</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-reduce-smax-intrinsics">
<span id="int-vp-reduce-smax"></span><h4><a class="toc-backref" href="#id2844">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.smax.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-reduce-smax-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1002">
<h5><a class="toc-backref" href="#id2845">Syntax:</a><a class="headerlink" href="#id1002" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<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">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">smax</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">smax</span><span class="o">.</span><span class="n">nxv8i16</span><span class="p">(</span><span class="n">i16</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i16</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1003">
<h5><a class="toc-backref" href="#id2846">Overview:</a><a class="headerlink" href="#id1003" title="Permalink to this headline">¶</a></h5>
<p>Predicated signed-integer <code class="docutils literal notranslate"><span class="pre">MAX</span></code> reduction of a vector and a scalar starting
value, returning the result as a scalar.</p>
</div>
<div class="section" id="id1004">
<h5><a class="toc-backref" href="#id2847">Arguments:</a><a class="headerlink" href="#id1004" title="Permalink to this headline">¶</a></h5>
<p>The first operand is the start value of the reduction, which must be a scalar
integer type equal to the result type. The second operand is the vector on
which the reduction is performed and must be a vector of integer values whose
element type is the result/start type. The third operand is the vector mask and
is a vector of boolean values with the same number of elements as the vector
operand. The fourth operand is the explicit vector length of the operation.</p>
</div>
<div class="section" id="id1005">
<h5><a class="toc-backref" href="#id2848">Semantics:</a><a class="headerlink" href="#id1005" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.smax</span></code>’ intrinsic performs the signed-integer <code class="docutils literal notranslate"><span class="pre">MAX</span></code>
reduction (<a class="reference internal" href="#int-vector-reduce-smax"><span class="std std-ref">llvm.vector.reduce.smax</span></a>) of the
vector operand <code class="docutils literal notranslate"><span class="pre">val</span></code> on each enabled lane, and taking the maximum of that and
the scalar <code class="docutils literal notranslate"><span class="pre">start_value</span></code>. Disabled lanes are treated as containing the
neutral value <code class="docutils literal notranslate"><span class="pre">INT_MIN</span></code> (i.e. having no effect on the reduction operation).
If the vector length is zero, the result is the start value.</p>
<p>To ignore the start value, the neutral value can be used.</p>
</div>
<div class="section" id="id1006">
<h5><a class="toc-backref" href="#id2849">Examples:</a><a class="headerlink" href="#id1006" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span> <span class="vg">@llvm.vp.reduce.smax.v4i8</span><span class="p">(</span><span class="k">i8</span> <span class="nv">%start</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i8</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">; %r is equivalent to %also.r, where lanes greater than or equal to %evl</span>
<span class="c">; are treated as though %mask were false for those lanes.</span>
<span class="nv">%masked.a</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i8</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i8</span><span class="p">></span> <span class="p"><</span><span class="k">i8</span> <span class="m">-128</span><span class="p">,</span> <span class="k">i8</span> <span class="m">-128</span><span class="p">,</span> <span class="k">i8</span> <span class="m">-128</span><span class="p">,</span> <span class="k">i8</span> <span class="m">-128</span><span class="p">></span>
<span class="nv">%reduction</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span> <span class="vg">@llvm.vector.reduce.smax.v4i8</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i8</span><span class="p">></span> <span class="nv">%masked.a</span><span class="p">)</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span> <span class="vg">@llvm.smax.i8</span><span class="p">(</span><span class="k">i8</span> <span class="nv">%reduction</span><span class="p">,</span> <span class="k">i8</span> <span class="nv">%start</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-reduce-smin-intrinsics">
<span id="int-vp-reduce-smin"></span><h4><a class="toc-backref" href="#id2850">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.smin.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-reduce-smin-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1007">
<h5><a class="toc-backref" href="#id2851">Syntax:</a><a class="headerlink" href="#id1007" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<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">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">smin</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">smin</span><span class="o">.</span><span class="n">nxv8i16</span><span class="p">(</span><span class="n">i16</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i16</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1008">
<h5><a class="toc-backref" href="#id2852">Overview:</a><a class="headerlink" href="#id1008" title="Permalink to this headline">¶</a></h5>
<p>Predicated signed-integer <code class="docutils literal notranslate"><span class="pre">MIN</span></code> reduction of a vector and a scalar starting
value, returning the result as a scalar.</p>
</div>
<div class="section" id="id1009">
<h5><a class="toc-backref" href="#id2853">Arguments:</a><a class="headerlink" href="#id1009" title="Permalink to this headline">¶</a></h5>
<p>The first operand is the start value of the reduction, which must be a scalar
integer type equal to the result type. The second operand is the vector on
which the reduction is performed and must be a vector of integer values whose
element type is the result/start type. The third operand is the vector mask and
is a vector of boolean values with the same number of elements as the vector
operand. The fourth operand is the explicit vector length of the operation.</p>
</div>
<div class="section" id="id1010">
<h5><a class="toc-backref" href="#id2854">Semantics:</a><a class="headerlink" href="#id1010" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.smin</span></code>’ intrinsic performs the signed-integer <code class="docutils literal notranslate"><span class="pre">MIN</span></code>
reduction (<a class="reference internal" href="#int-vector-reduce-smin"><span class="std std-ref">llvm.vector.reduce.smin</span></a>) of the
vector operand <code class="docutils literal notranslate"><span class="pre">val</span></code> on each enabled lane, and taking the minimum of that and
the scalar <code class="docutils literal notranslate"><span class="pre">start_value</span></code>. Disabled lanes are treated as containing the
neutral value <code class="docutils literal notranslate"><span class="pre">INT_MAX</span></code> (i.e. having no effect on the reduction operation).
If the vector length is zero, the result is the start value.</p>
<p>To ignore the start value, the neutral value can be used.</p>
</div>
<div class="section" id="id1011">
<h5><a class="toc-backref" href="#id2855">Examples:</a><a class="headerlink" href="#id1011" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span> <span class="vg">@llvm.vp.reduce.smin.v4i8</span><span class="p">(</span><span class="k">i8</span> <span class="nv">%start</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i8</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">; %r is equivalent to %also.r, where lanes greater than or equal to %evl</span>
<span class="c">; are treated as though %mask were false for those lanes.</span>
<span class="nv">%masked.a</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i8</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i8</span><span class="p">></span> <span class="p"><</span><span class="k">i8</span> <span class="m">127</span><span class="p">,</span> <span class="k">i8</span> <span class="m">127</span><span class="p">,</span> <span class="k">i8</span> <span class="m">127</span><span class="p">,</span> <span class="k">i8</span> <span class="m">127</span><span class="p">></span>
<span class="nv">%reduction</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span> <span class="vg">@llvm.vector.reduce.smin.v4i8</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i8</span><span class="p">></span> <span class="nv">%masked.a</span><span class="p">)</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span> <span class="vg">@llvm.smin.i8</span><span class="p">(</span><span class="k">i8</span> <span class="nv">%reduction</span><span class="p">,</span> <span class="k">i8</span> <span class="nv">%start</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-reduce-umax-intrinsics">
<span id="int-vp-reduce-umax"></span><h4><a class="toc-backref" href="#id2856">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.umax.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-reduce-umax-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1012">
<h5><a class="toc-backref" href="#id2857">Syntax:</a><a class="headerlink" href="#id1012" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<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">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">umax</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">umax</span><span class="o">.</span><span class="n">nxv8i16</span><span class="p">(</span><span class="n">i16</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i16</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1013">
<h5><a class="toc-backref" href="#id2858">Overview:</a><a class="headerlink" href="#id1013" title="Permalink to this headline">¶</a></h5>
<p>Predicated unsigned-integer <code class="docutils literal notranslate"><span class="pre">MAX</span></code> reduction of a vector and a scalar starting
value, returning the result as a scalar.</p>
</div>
<div class="section" id="id1014">
<h5><a class="toc-backref" href="#id2859">Arguments:</a><a class="headerlink" href="#id1014" title="Permalink to this headline">¶</a></h5>
<p>The first operand is the start value of the reduction, which must be a scalar
integer type equal to the result type. The second operand is the vector on
which the reduction is performed and must be a vector of integer values whose
element type is the result/start type. The third operand is the vector mask and
is a vector of boolean values with the same number of elements as the vector
operand. The fourth operand is the explicit vector length of the operation.</p>
</div>
<div class="section" id="id1015">
<h5><a class="toc-backref" href="#id2860">Semantics:</a><a class="headerlink" href="#id1015" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.umax</span></code>’ intrinsic performs the unsigned-integer <code class="docutils literal notranslate"><span class="pre">MAX</span></code>
reduction (<a class="reference internal" href="#int-vector-reduce-umax"><span class="std std-ref">llvm.vector.reduce.umax</span></a>) of the
vector operand <code class="docutils literal notranslate"><span class="pre">val</span></code> on each enabled lane, and taking the maximum of that and
the scalar <code class="docutils literal notranslate"><span class="pre">start_value</span></code>. Disabled lanes are treated as containing the
neutral value <code class="docutils literal notranslate"><span class="pre">0</span></code> (i.e. having no effect on the reduction operation). If the
vector length is zero, the result is the start value.</p>
<p>To ignore the start value, the neutral value can be used.</p>
</div>
<div class="section" id="id1016">
<h5><a class="toc-backref" href="#id2861">Examples:</a><a class="headerlink" href="#id1016" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@llvm.vp.reduce.umax.v4i32</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%start</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">; %r is equivalent to %also.r, where lanes greater than or equal to %evl</span>
<span class="c">; are treated as though %mask were false for those lanes.</span>
<span class="nv">%masked.a</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></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="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="p">></span>
<span class="nv">%reduction</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@llvm.vector.reduce.umax.v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%masked.a</span><span class="p">)</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@llvm.umax.i32</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%reduction</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%start</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-reduce-umin-intrinsics">
<span id="int-vp-reduce-umin"></span><h4><a class="toc-backref" href="#id2862">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.umin.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-reduce-umin-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1017">
<h5><a class="toc-backref" href="#id2863">Syntax:</a><a class="headerlink" href="#id1017" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<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">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">umin</span><span class="o">.</span><span class="n">v4i32</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">umin</span><span class="o">.</span><span class="n">nxv8i16</span><span class="p">(</span><span class="n">i16</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i16</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1018">
<h5><a class="toc-backref" href="#id2864">Overview:</a><a class="headerlink" href="#id1018" title="Permalink to this headline">¶</a></h5>
<p>Predicated unsigned-integer <code class="docutils literal notranslate"><span class="pre">MIN</span></code> reduction of a vector and a scalar starting
value, returning the result as a scalar.</p>
</div>
<div class="section" id="id1019">
<h5><a class="toc-backref" href="#id2865">Arguments:</a><a class="headerlink" href="#id1019" title="Permalink to this headline">¶</a></h5>
<p>The first operand is the start value of the reduction, which must be a scalar
integer type equal to the result type. The second operand is the vector on
which the reduction is performed and must be a vector of integer values whose
element type is the result/start type. The third operand is the vector mask and
is a vector of boolean values with the same number of elements as the vector
operand. The fourth operand is the explicit vector length of the operation.</p>
</div>
<div class="section" id="id1020">
<h5><a class="toc-backref" href="#id2866">Semantics:</a><a class="headerlink" href="#id1020" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.umin</span></code>’ intrinsic performs the unsigned-integer <code class="docutils literal notranslate"><span class="pre">MIN</span></code>
reduction (<a class="reference internal" href="#int-vector-reduce-umin"><span class="std std-ref">llvm.vector.reduce.umin</span></a>) of the
vector operand <code class="docutils literal notranslate"><span class="pre">val</span></code> on each enabled lane, taking the minimum of that and the
scalar <code class="docutils literal notranslate"><span class="pre">start_value</span></code>. Disabled lanes are treated as containing the neutral
value <code class="docutils literal notranslate"><span class="pre">UINT_MAX</span></code>, or <code class="docutils literal notranslate"><span class="pre">-1</span></code> (i.e. having no effect on the reduction
operation). If the vector length is zero, the result is the start value.</p>
<p>To ignore the start value, the neutral value can be used.</p>
</div>
<div class="section" id="id1021">
<h5><a class="toc-backref" href="#id2867">Examples:</a><a class="headerlink" href="#id1021" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%r</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@llvm.vp.reduce.umin.v4i32</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%start</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%evl</span><span class="p">)</span>
<span class="c">; %r is equivalent to %also.r, where lanes greater than or equal to %evl</span>
<span class="c">; are treated as though %mask were false for those lanes.</span>
<span class="nv">%masked.a</span> <span class="p">=</span> <span class="k">select</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%a</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="p"><</span><span class="k">i32</span> <span class="m">-1</span><span class="p">,</span> <span class="k">i32</span> <span class="m">-1</span><span class="p">,</span> <span class="k">i32</span> <span class="m">-1</span><span class="p">,</span> <span class="k">i32</span> <span class="m">-1</span><span class="p">></span>
<span class="nv">%reduction</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@llvm.vector.reduce.umin.v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="nv">%masked.a</span><span class="p">)</span>
<span class="nv">%also.r</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i32</span> <span class="vg">@llvm.umin.i32</span><span class="p">(</span><span class="k">i32</span> <span class="nv">%reduction</span><span class="p">,</span> <span class="k">i32</span> <span class="nv">%start</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-reduce-fmax-intrinsics">
<span id="int-vp-reduce-fmax"></span><h4><a class="toc-backref" href="#id2868">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.fmax.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-reduce-fmax-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1022">
<h5><a class="toc-backref" href="#id2869">Syntax:</a><a class="headerlink" href="#id1022" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">fmax</span><span class="o">.</span><span class="n">v4f32</span><span class="p">(</span><span class="nb">float</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="nb">float</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">fmax</span><span class="o">.</span><span class="n">nxv8f64</span><span class="p">(</span><span class="n">double</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1023">
<h5><a class="toc-backref" href="#id2870">Overview:</a><a class="headerlink" href="#id1023" title="Permalink to this headline">¶</a></h5>
<p>Predicated floating-point <code class="docutils literal notranslate"><span class="pre">MAX</span></code> reduction of a vector and a scalar starting
value, returning the result as a scalar.</p>
</div>
<div class="section" id="id1024">
<h5><a class="toc-backref" href="#id2871">Arguments:</a><a class="headerlink" href="#id1024" title="Permalink to this headline">¶</a></h5>
<p>The first operand is the start value of the reduction, which must be a scalar
floating-point type equal to the result type. The second operand is the vector
on which the reduction is performed and must be a vector of floating-point
values whose element type is the result/start type. The third operand is the
vector mask and is a vector of boolean values with the same number of elements
as the vector operand. The fourth operand is the explicit vector length of the
operation.</p>
</div>
<div class="section" id="id1025">
<h5><a class="toc-backref" href="#id2872">Semantics:</a><a class="headerlink" href="#id1025" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.fmax</span></code>’ intrinsic performs the floating-point <code class="docutils literal notranslate"><span class="pre">MAX</span></code>
reduction (<a class="reference internal" href="#int-vector-reduce-fmax"><span class="std std-ref">llvm.vector.reduce.fmax</span></a>) of the
vector operand <code class="docutils literal notranslate"><span class="pre">val</span></code> on each enabled lane, taking the maximum of that and the
scalar <code class="docutils literal notranslate"><span class="pre">start_value</span></code>. Disabled lanes are treated as containing the neutral
value (i.e. having no effect on the reduction operation). If the vector length
is zero, the result is the start value.</p>
<p>The neutral value is dependent on the <a class="reference internal" href="#fastmath"><span class="std std-ref">fast-math flags</span></a>. If no
flags are set, the neutral value is <code class="docutils literal notranslate"><span class="pre">-QNAN</span></code>. If <code class="docutils literal notranslate"><span class="pre">nnan</span></code> and <code class="docutils literal notranslate"><span class="pre">ninf</span></code> are
both set, then the neutral value is the smallest floating-point value for the
result type. If only <code class="docutils literal notranslate"><span class="pre">nnan</span></code> is set then the neutral value is <code class="docutils literal notranslate"><span class="pre">-Infinity</span></code>.</p>
<p>This instruction has the same comparison semantics as the
<a class="reference internal" href="#int-vector-reduce-fmax"><span class="std std-ref">llvm.vector.reduce.fmax</span></a> intrinsic (and thus the
‘<code class="docutils literal notranslate"><span class="pre">llvm.maxnum.*</span></code>’ intrinsic). That is, the result will always be a number
unless all elements of the vector and the starting value are <code class="docutils literal notranslate"><span class="pre">NaN</span></code>. For a
vector with maximum element magnitude <code class="docutils literal notranslate"><span class="pre">0.0</span></code> and containing both <code class="docutils literal notranslate"><span class="pre">+0.0</span></code> and
<code class="docutils literal notranslate"><span class="pre">-0.0</span></code> elements, the sign of the result is unspecified.</p>
<p>To ignore the start value, the neutral value can be used.</p>
</div>
<div class="section" id="id1026">
<h5><a class="toc-backref" href="#id2873">Examples:</a><a class="headerlink" href="#id1026" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span>%r = call float @llvm.vp.reduce.fmax.v4f32(float %float, <4 x float> %a, <4 x i1> %mask, i32 %evl)
; %r is equivalent to %also.r, where lanes greater than or equal to %evl
; are treated as though %mask were false for those lanes.
%masked.a = select <4 x i1> %mask, <4 x float> %a, <4 x float> <float QNAN, float QNAN, float QNAN, float QNAN>
%reduction = call float @llvm.vector.reduce.fmax.v4f32(<4 x float> %masked.a)
%also.r = call float @llvm.maxnum.f32(float %reduction, float %start)
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-vp-reduce-fmin-intrinsics">
<span id="int-vp-reduce-fmin"></span><h4><a class="toc-backref" href="#id2874">‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.fmin.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-vp-reduce-fmin-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1027">
<h5><a class="toc-backref" href="#id2875">Syntax:</a><a class="headerlink" href="#id1027" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">fmin</span><span class="o">.</span><span class="n">v4f32</span><span class="p">(</span><span class="nb">float</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="nb">float</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">double</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">vp</span><span class="o">.</span><span class="n">reduce</span><span class="o">.</span><span class="n">fmin</span><span class="o">.</span><span class="n">nxv8f64</span><span class="p">(</span><span class="n">double</span> <span class="o"><</span><span class="n">start_value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">vector_length</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1028">
<h5><a class="toc-backref" href="#id2876">Overview:</a><a class="headerlink" href="#id1028" title="Permalink to this headline">¶</a></h5>
<p>Predicated floating-point <code class="docutils literal notranslate"><span class="pre">MIN</span></code> reduction of a vector and a scalar starting
value, returning the result as a scalar.</p>
</div>
<div class="section" id="id1029">
<h5><a class="toc-backref" href="#id2877">Arguments:</a><a class="headerlink" href="#id1029" title="Permalink to this headline">¶</a></h5>
<p>The first operand is the start value of the reduction, which must be a scalar
floating-point type equal to the result type. The second operand is the vector
on which the reduction is performed and must be a vector of floating-point
values whose element type is the result/start type. The third operand is the
vector mask and is a vector of boolean values with the same number of elements
as the vector operand. The fourth operand is the explicit vector length of the
operation.</p>
</div>
<div class="section" id="id1030">
<h5><a class="toc-backref" href="#id2878">Semantics:</a><a class="headerlink" href="#id1030" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.vp.reduce.fmin</span></code>’ intrinsic performs the floating-point <code class="docutils literal notranslate"><span class="pre">MIN</span></code>
reduction (<a class="reference internal" href="#int-vector-reduce-fmin"><span class="std std-ref">llvm.vector.reduce.fmin</span></a>) of the
vector operand <code class="docutils literal notranslate"><span class="pre">val</span></code> on each enabled lane, taking the minimum of that and the
scalar <code class="docutils literal notranslate"><span class="pre">start_value</span></code>. Disabled lanes are treated as containing the neutral
value (i.e. having no effect on the reduction operation). If the vector length
is zero, the result is the start value.</p>
<p>The neutral value is dependent on the <a class="reference internal" href="#fastmath"><span class="std std-ref">fast-math flags</span></a>. If no
flags are set, the neutral value is <code class="docutils literal notranslate"><span class="pre">+QNAN</span></code>. If <code class="docutils literal notranslate"><span class="pre">nnan</span></code> and <code class="docutils literal notranslate"><span class="pre">ninf</span></code> are
both set, then the neutral value is the largest floating-point value for the
result type. If only <code class="docutils literal notranslate"><span class="pre">nnan</span></code> is set then the neutral value is <code class="docutils literal notranslate"><span class="pre">+Infinity</span></code>.</p>
<p>This instruction has the same comparison semantics as the
<a class="reference internal" href="#int-vector-reduce-fmin"><span class="std std-ref">llvm.vector.reduce.fmin</span></a> intrinsic (and thus the
‘<code class="docutils literal notranslate"><span class="pre">llvm.minnum.*</span></code>’ intrinsic). That is, the result will always be a number
unless all elements of the vector and the starting value are <code class="docutils literal notranslate"><span class="pre">NaN</span></code>. For a
vector with maximum element magnitude <code class="docutils literal notranslate"><span class="pre">0.0</span></code> and containing both <code class="docutils literal notranslate"><span class="pre">+0.0</span></code> and
<code class="docutils literal notranslate"><span class="pre">-0.0</span></code> elements, the sign of the result is unspecified.</p>
<p>To ignore the start value, the neutral value can be used.</p>
</div>
<div class="section" id="id1031">
<h5><a class="toc-backref" href="#id2879">Examples:</a><a class="headerlink" href="#id1031" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span>%r = call float @llvm.vp.reduce.fmin.v4f32(float %start, <4 x float> %a, <4 x i1> %mask, i32 %evl)
; %r is equivalent to %also.r, where lanes greater than or equal to %evl
; are treated as though %mask were false for those lanes.
%masked.a = select <4 x i1> %mask, <4 x float> %a, <4 x float> <float QNAN, float QNAN, float QNAN, float QNAN>
%reduction = call float @llvm.vector.reduce.fmin.v4f32(<4 x float> %masked.a)
%also.r = call float @llvm.minnum.f32(float %reduction, float %start)
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-get-active-lane-mask-intrinsics">
<span id="int-get-active-lane-mask"></span><h4><a class="toc-backref" href="#id2880">‘<code class="docutils literal notranslate"><span class="pre">llvm.get.active.lane.mask.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-get-active-lane-mask-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1032">
<h5><a class="toc-backref" href="#id2881">Syntax:</a><a class="headerlink" href="#id1032" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">get</span><span class="o">.</span><span class="n">active</span><span class="o">.</span><span class="n">lane</span><span class="o">.</span><span class="n">mask</span><span class="o">.</span><span class="n">v4i1</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">base</span><span class="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">n</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">get</span><span class="o">.</span><span class="n">active</span><span class="o">.</span><span class="n">lane</span><span class="o">.</span><span class="n">mask</span><span class="o">.</span><span class="n">v8i1</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">base</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">n</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">get</span><span class="o">.</span><span class="n">active</span><span class="o">.</span><span class="n">lane</span><span class="o">.</span><span class="n">mask</span><span class="o">.</span><span class="n">v16i1</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">base</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">n</span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">vscale</span> <span class="n">x</span> <span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">get</span><span class="o">.</span><span class="n">active</span><span class="o">.</span><span class="n">lane</span><span class="o">.</span><span class="n">mask</span><span class="o">.</span><span class="n">nxv16i1</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o">%</span><span class="n">base</span><span class="p">,</span> <span class="n">i64</span> <span class="o">%</span><span class="n">n</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1033">
<h5><a class="toc-backref" href="#id2882">Overview:</a><a class="headerlink" href="#id1033" title="Permalink to this headline">¶</a></h5>
<p>Create a mask representing active and inactive vector lanes.</p>
</div>
<div class="section" id="id1034">
<h5><a class="toc-backref" href="#id2883">Arguments:</a><a class="headerlink" href="#id1034" title="Permalink to this headline">¶</a></h5>
<p>Both operands have the same scalar integer type. The result is a vector with
the i1 element type.</p>
</div>
<div class="section" id="id1035">
<h5><a class="toc-backref" href="#id2884">Semantics:</a><a class="headerlink" href="#id1035" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.get.active.lane.mask.*</span></code>’ intrinsics are semantically equivalent
to:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">m</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="n">icmp</span> <span class="n">ult</span> <span class="p">(</span><span class="o">%</span><span class="n">base</span> <span class="o">+</span> <span class="n">i</span><span class="p">),</span> <span class="o">%</span><span class="n">n</span>
</pre></div>
</div>
<p>where <code class="docutils literal notranslate"><span class="pre">%m</span></code> is a vector (mask) of active/inactive lanes with its elements
indexed by <code class="docutils literal notranslate"><span class="pre">i</span></code>, and <code class="docutils literal notranslate"><span class="pre">%base</span></code>, <code class="docutils literal notranslate"><span class="pre">%n</span></code> are the two arguments to
<code class="docutils literal notranslate"><span class="pre">llvm.get.active.lane.mask.*</span></code>, <code class="docutils literal notranslate"><span class="pre">%icmp</span></code> is an integer compare and <code class="docutils literal notranslate"><span class="pre">ult</span></code>
the unsigned less-than comparison operator. Overflow cannot occur in
<code class="docutils literal notranslate"><span class="pre">(%base</span> <span class="pre">+</span> <span class="pre">i)</span></code> and its comparison against <code class="docutils literal notranslate"><span class="pre">%n</span></code> as it is performed in integer
numbers and not in machine numbers. If <code class="docutils literal notranslate"><span class="pre">%n</span></code> is <code class="docutils literal notranslate"><span class="pre">0</span></code>, then the result is a
poison value. The above is equivalent to:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">m</span> <span class="o">=</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">get</span><span class="o">.</span><span class="n">active</span><span class="o">.</span><span class="n">lane</span><span class="o">.</span><span class="n">mask</span><span class="p">(</span><span class="o">%</span><span class="n">base</span><span class="p">,</span> <span class="o">%</span><span class="n">n</span><span class="p">)</span>
</pre></div>
</div>
<p>This can, for example, be emitted by the loop vectorizer in which case
<code class="docutils literal notranslate"><span class="pre">%base</span></code> is the first element of the vector induction variable (VIV) and
<code class="docutils literal notranslate"><span class="pre">%n</span></code> is the loop tripcount. Thus, these intrinsics perform an element-wise
less than comparison of VIV with the loop tripcount, producing a mask of
true/false values representing active/inactive vector lanes, except if the VIV
overflows in which case they return false in the lanes where the VIV overflows.
The arguments are scalar types to accommodate scalable vector types, for which
it is unknown what the type of the step vector needs to be that enumerate its
lanes without overflow.</p>
<p>This mask <code class="docutils literal notranslate"><span class="pre">%m</span></code> can e.g. be used in masked load/store instructions. These
intrinsics provide a hint to the backend. I.e., for a vector loop, the
back-edge taken count of the original scalar loop is explicit as the second
argument.</p>
</div>
<div class="section" id="id1036">
<h5><a class="toc-backref" href="#id2885">Examples:</a><a class="headerlink" href="#id1036" title="Permalink to this headline">¶</a></h5>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="nv">%active.lane.mask</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="vg">@llvm.get.active.lane.mask.v4i1.i64</span><span class="p">(</span><span class="k">i64</span> <span class="nv">%elem0</span><span class="p">,</span> <span class="k">i64</span> <span class="m">429</span><span class="p">)</span>
<span class="nv">%wide.masked.load</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="vg">@llvm.masked.load.v4i32.p0v4i32</span><span class="p">(<</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">>*</span> <span class="nv nv-Anonymous">%3</span><span class="p">,</span> <span class="k">i32</span> <span class="m">4</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%active.lane.mask</span><span class="p">,</span> <span class="p"><</span><span class="m">4</span> <span class="k">x</span> <span class="k">i32</span><span class="p">></span> <span class="k">undef</span><span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="masked-vector-load-and-store-intrinsics">
<span id="int-mload-mstore"></span><h3><a class="toc-backref" href="#id2886">Masked Vector Load and Store Intrinsics</a><a class="headerlink" href="#masked-vector-load-and-store-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>LLVM provides intrinsics for predicated vector load and store operations. The predicate is specified by a mask operand, which holds one bit per vector element, switching the associated vector lane on or off. The memory addresses corresponding to the “off” lanes are not accessed. When all bits of the mask are on, the intrinsic is identical to a regular vector load or store. When all bits are off, no memory is accessed.</p>
<div class="section" id="llvm-masked-load-intrinsics">
<span id="int-mload"></span><h4><a class="toc-backref" href="#id2887">‘<code class="docutils literal notranslate"><span class="pre">llvm.masked.load.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-masked-load-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1037">
<h5><a class="toc-backref" href="#id2888">Syntax:</a><a class="headerlink" href="#id1037" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. The loaded data is a vector of any integer, floating-point or pointer data type.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">masked</span><span class="o">.</span><span class="n">load</span><span class="o">.</span><span class="n">v16f32</span><span class="o">.</span><span class="n">p0v16f32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</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="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">passthru</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">masked</span><span class="o">.</span><span class="n">load</span><span class="o">.</span><span class="n">v2f64</span><span class="o">.</span><span class="n">p0v2f64</span> <span class="p">(</span><span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">double</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="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o"><</span><span class="n">passthru</span><span class="o">></span><span class="p">)</span>
<span class="p">;;</span> <span class="n">The</span> <span class="n">data</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">vector</span> <span class="n">of</span> <span class="n">pointers</span> <span class="n">to</span> <span class="n">double</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">double</span><span class="o">*></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">masked</span><span class="o">.</span><span class="n">load</span><span class="o">.</span><span class="n">v8p0f64</span><span class="o">.</span><span class="n">p0v8p0f64</span> <span class="p">(</span><span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">double</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="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">double</span><span class="o">*></span> <span class="o"><</span><span class="n">passthru</span><span class="o">></span><span class="p">)</span>
<span class="p">;;</span> <span class="n">The</span> <span class="n">data</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">vector</span> <span class="n">of</span> <span class="n">function</span> <span class="n">pointers</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i32</span> <span class="p">()</span><span class="o">*></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">masked</span><span class="o">.</span><span class="n">load</span><span class="o">.</span><span class="n">v8p0f_i32f</span><span class="o">.</span><span class="n">p0v8p0f_i32f</span> <span class="p">(</span><span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i32</span> <span class="p">()</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="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i32</span> <span class="p">()</span><span class="o">*></span> <span class="o"><</span><span class="n">passthru</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1038">
<h5><a class="toc-backref" href="#id2889">Overview:</a><a class="headerlink" href="#id1038" title="Permalink to this headline">¶</a></h5>
<p>Reads a vector from memory according to the provided mask. The mask holds a bit for each vector lane, and is used to prevent memory accesses to the masked-off lanes. The masked-off lanes in the result vector are taken from the corresponding lanes of the ‘<code class="docutils literal notranslate"><span class="pre">passthru</span></code>’ operand.</p>
</div>
<div class="section" id="id1039">
<h5><a class="toc-backref" href="#id2890">Arguments:</a><a class="headerlink" href="#id1039" title="Permalink to this headline">¶</a></h5>
<p>The first operand is the base pointer for the load. The second operand is the alignment of the source location. It must be a power of two constant integer value. The third operand, mask, is a vector of boolean values with the same number of elements as the return type. The fourth is a pass-through value that is used to fill the masked-off lanes of the result. The return type, underlying type of the base pointer and the type of the ‘<code class="docutils literal notranslate"><span class="pre">passthru</span></code>’ operand are the same vector types.</p>
</div>
<div class="section" id="id1040">
<h5><a class="toc-backref" href="#id2891">Semantics:</a><a class="headerlink" href="#id1040" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.masked.load</span></code>’ intrinsic is designed for conditional reading of selected vector elements in a single IR operation. It is useful for targets that support vector masked loads and allows vectorizing predicated basic blocks on these targets. Other targets may support this intrinsic differently, for example by lowering it into a sequence of branches that guard scalar load operations.
The result of this operation is equivalent to a regular vector load instruction followed by a ‘select’ between the loaded and the passthru values, predicated on the same mask. However, using this intrinsic prevents exceptions on memory access to masked-off lanes.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">res</span> <span class="o">=</span> <span class="n">call</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">masked</span><span class="o">.</span><span class="n">load</span><span class="o">.</span><span class="n">v16f32</span><span class="o">.</span><span class="n">p0v16f32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">>*</span> <span class="o">%</span><span class="n">ptr</span><span class="p">,</span> <span class="n">i32</span> <span class="mi">4</span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">>%</span><span class="n">mask</span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o">%</span><span class="n">passthru</span><span class="p">)</span>
<span class="p">;;</span> <span class="n">The</span> <span class="n">result</span> <span class="n">of</span> <span class="n">the</span> <span class="n">two</span> <span class="n">following</span> <span class="n">instructions</span> <span class="ow">is</span> <span class="n">identical</span> <span class="n">aside</span> <span class="kn">from</span> <span class="nn">potential</span> <span class="n">memory</span> <span class="n">access</span> <span class="n">exception</span>
<span class="o">%</span><span class="n">loadlal</span> <span class="o">=</span> <span class="n">load</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">>*</span> <span class="o">%</span><span class="n">ptr</span><span class="p">,</span> <span class="n">align</span> <span class="mi">4</span>
<span class="o">%</span><span class="n">res</span> <span class="o">=</span> <span class="n">select</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o">%</span><span class="n">mask</span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o">%</span><span class="n">loadlal</span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o">%</span><span class="n">passthru</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-masked-store-intrinsics">
<span id="int-mstore"></span><h4><a class="toc-backref" href="#id2892">‘<code class="docutils literal notranslate"><span class="pre">llvm.masked.store.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-masked-store-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1041">
<h5><a class="toc-backref" href="#id2893">Syntax:</a><a class="headerlink" href="#id1041" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. The data stored in memory is a vector of any integer, floating-point or pointer data type.</p>
<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">masked</span><span class="o">.</span><span class="n">store</span><span class="o">.</span><span class="n">v8i32</span><span class="o">.</span><span class="n">p0v8i32</span> <span class="p">(</span><span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i32</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="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">void</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">masked</span><span class="o">.</span><span class="n">store</span><span class="o">.</span><span class="n">v16f32</span><span class="o">.</span><span class="n">p0v16f32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</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="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">)</span>
<span class="p">;;</span> <span class="n">The</span> <span class="n">data</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">vector</span> <span class="n">of</span> <span class="n">pointers</span> <span class="n">to</span> <span class="n">double</span>
<span class="n">declare</span> <span class="n">void</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">masked</span><span class="o">.</span><span class="n">store</span><span class="o">.</span><span class="n">v8p0f64</span><span class="o">.</span><span class="n">p0v8p0f64</span> <span class="p">(</span><span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">double</span><span class="o">*></span> <span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">double</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="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">)</span>
<span class="p">;;</span> <span class="n">The</span> <span class="n">data</span> <span class="ow">is</span> <span class="n">a</span> <span class="n">vector</span> <span class="n">of</span> <span class="n">function</span> <span class="n">pointers</span>
<span class="n">declare</span> <span class="n">void</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">masked</span><span class="o">.</span><span class="n">store</span><span class="o">.</span><span class="n">v4p0f_i32f</span><span class="o">.</span><span class="n">p0v4p0f_i32f</span> <span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span> <span class="p">()</span><span class="o">*></span> <span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i32</span> <span class="p">()</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="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1042">
<h5><a class="toc-backref" href="#id2894">Overview:</a><a class="headerlink" href="#id1042" title="Permalink to this headline">¶</a></h5>
<p>Writes a vector to memory according to the provided mask. The mask holds a bit for each vector lane, and is used to prevent memory accesses to the masked-off lanes.</p>
</div>
<div class="section" id="id1043">
<h5><a class="toc-backref" href="#id2895">Arguments:</a><a class="headerlink" href="#id1043" title="Permalink to this headline">¶</a></h5>
<p>The first operand is the vector value to be written to memory. The second operand is the base pointer for the store, it has the same underlying type as the value operand. The third operand is the alignment of the destination location. It must be a power of two constant integer value. The fourth operand, mask, is a vector of boolean values. The types of the mask and the value operand must have the same number of vector elements.</p>
</div>
<div class="section" id="id1044">
<h5><a class="toc-backref" href="#id2896">Semantics:</a><a class="headerlink" href="#id1044" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.masked.store</span></code>’ intrinsics is designed for conditional writing of selected vector elements in a single IR operation. It is useful for targets that support vector masked store and allows vectorizing predicated basic blocks on these targets. Other targets may support this intrinsic differently, for example by lowering it into a sequence of branches that guard scalar store operations.
The result of this operation is equivalent to a load-modify-store sequence. However, using this intrinsic prevents exceptions and data races on memory access to masked-off lanes.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">call</span> <span class="n">void</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">masked</span><span class="o">.</span><span class="n">store</span><span class="o">.</span><span class="n">v16f32</span><span class="o">.</span><span class="n">p0v16f32</span><span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o">%</span><span class="n">value</span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">>*</span> <span class="o">%</span><span class="n">ptr</span><span class="p">,</span> <span class="n">i32</span> <span class="mi">4</span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o">%</span><span class="n">mask</span><span class="p">)</span>
<span class="p">;;</span> <span class="n">The</span> <span class="n">result</span> <span class="n">of</span> <span class="n">the</span> <span class="n">following</span> <span class="n">instructions</span> <span class="ow">is</span> <span class="n">identical</span> <span class="n">aside</span> <span class="kn">from</span> <span class="nn">potential</span> <span class="n">data</span> <span class="n">races</span> <span class="ow">and</span> <span class="n">memory</span> <span class="n">access</span> <span class="n">exceptions</span>
<span class="o">%</span><span class="n">oldval</span> <span class="o">=</span> <span class="n">load</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">>*</span> <span class="o">%</span><span class="n">ptr</span><span class="p">,</span> <span class="n">align</span> <span class="mi">4</span>
<span class="o">%</span><span class="n">res</span> <span class="o">=</span> <span class="n">select</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o">%</span><span class="n">mask</span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o">%</span><span class="n">value</span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o">%</span><span class="n">oldval</span>
<span class="n">store</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o">%</span><span class="n">res</span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">>*</span> <span class="o">%</span><span class="n">ptr</span><span class="p">,</span> <span class="n">align</span> <span class="mi">4</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="masked-vector-gather-and-scatter-intrinsics">
<h3><a class="toc-backref" href="#id2897">Masked Vector Gather and Scatter Intrinsics</a><a class="headerlink" href="#masked-vector-gather-and-scatter-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>LLVM provides intrinsics for vector gather and scatter operations. They are similar to <a class="reference internal" href="#int-mload-mstore"><span class="std std-ref">Masked Vector Load and Store</span></a>, except they are designed for arbitrary memory accesses, rather than sequential memory accesses. Gather and scatter also employ a mask operand, which holds one bit per vector element, switching the associated vector lane on or off. The memory addresses corresponding to the “off” lanes are not accessed. When all bits are off, no memory is accessed.</p>
<div class="section" id="llvm-masked-gather-intrinsics">
<span id="int-mgather"></span><h4><a class="toc-backref" href="#id2898">‘<code class="docutils literal notranslate"><span class="pre">llvm.masked.gather.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-masked-gather-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1045">
<h5><a class="toc-backref" href="#id2899">Syntax:</a><a class="headerlink" href="#id1045" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. The loaded data are multiple scalar values of any integer, floating-point or pointer data type gathered together into one vector.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">masked</span><span class="o">.</span><span class="n">gather</span><span class="o">.</span><span class="n">v16f32</span><span class="o">.</span><span class="n">v16p0f32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">*></span> <span class="o"><</span><span class="n">ptrs</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="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">passthru</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">masked</span><span class="o">.</span><span class="n">gather</span><span class="o">.</span><span class="n">v2f64</span><span class="o">.</span><span class="n">v2p1f64</span> <span class="p">(</span><span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">double</span> <span class="n">addrspace</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span><span class="o">*></span> <span class="o"><</span><span class="n">ptrs</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="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="o"><</span><span class="n">passthru</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="nb">float</span><span class="o">*></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">masked</span><span class="o">.</span><span class="n">gather</span><span class="o">.</span><span class="n">v8p0f32</span><span class="o">.</span><span class="n">v8p0p0f32</span> <span class="p">(</span><span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="nb">float</span><span class="o">**></span> <span class="o"><</span><span class="n">ptrs</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="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="nb">float</span><span class="o">*></span> <span class="o"><</span><span class="n">passthru</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1046">
<h5><a class="toc-backref" href="#id2900">Overview:</a><a class="headerlink" href="#id1046" title="Permalink to this headline">¶</a></h5>
<p>Reads scalar values from arbitrary memory locations and gathers them into one vector. The memory locations are provided in the vector of pointers ‘<code class="docutils literal notranslate"><span class="pre">ptrs</span></code>’. The memory is accessed according to the provided mask. The mask holds a bit for each vector lane, and is used to prevent memory accesses to the masked-off lanes. The masked-off lanes in the result vector are taken from the corresponding lanes of the ‘<code class="docutils literal notranslate"><span class="pre">passthru</span></code>’ operand.</p>
</div>
<div class="section" id="id1047">
<h5><a class="toc-backref" href="#id2901">Arguments:</a><a class="headerlink" href="#id1047" title="Permalink to this headline">¶</a></h5>
<p>The first operand is a vector of pointers which holds all memory addresses to read. The second operand is an alignment of the source addresses. It must be 0 or a power of two constant integer value. The third operand, mask, is a vector of boolean values with the same number of elements as the return type. The fourth is a pass-through value that is used to fill the masked-off lanes of the result. The return type, underlying type of the vector of pointers and the type of the ‘<code class="docutils literal notranslate"><span class="pre">passthru</span></code>’ operand are the same vector types.</p>
</div>
<div class="section" id="id1048">
<h5><a class="toc-backref" href="#id2902">Semantics:</a><a class="headerlink" href="#id1048" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.masked.gather</span></code>’ intrinsic is designed for conditional reading of multiple scalar values from arbitrary memory locations in a single IR operation. It is useful for targets that support vector masked gathers and allows vectorizing basic blocks with data and control divergence. Other targets may support this intrinsic differently, for example by lowering it into a sequence of scalar load operations.
The semantics of this operation are equivalent to a sequence of conditional scalar loads with subsequent gathering all loaded values into a single vector. The mask restricts memory access to certain lanes and facilitates vectorization of predicated basic blocks.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="n">res</span> <span class="o">=</span> <span class="n">call</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">masked</span><span class="o">.</span><span class="n">gather</span><span class="o">.</span><span class="n">v4f64</span><span class="o">.</span><span class="n">v4p0f64</span> <span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">double</span><span class="o">*></span> <span class="o">%</span><span class="n">ptrs</span><span class="p">,</span> <span class="n">i32</span> <span class="mi">8</span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">i1</span> <span class="n">true</span><span class="p">,</span> <span class="n">i1</span> <span class="n">true</span><span class="p">,</span> <span class="n">i1</span> <span class="n">true</span><span class="p">,</span> <span class="n">i1</span> <span class="n">true</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span> <span class="n">undef</span><span class="p">)</span>
<span class="p">;;</span> <span class="n">The</span> <span class="n">gather</span> <span class="k">with</span> <span class="nb">all</span><span class="o">-</span><span class="n">true</span> <span class="n">mask</span> <span class="ow">is</span> <span class="n">equivalent</span> <span class="n">to</span> <span class="n">the</span> <span class="n">following</span> <span class="n">instruction</span> <span class="n">sequence</span>
<span class="o">%</span><span class="n">ptr0</span> <span class="o">=</span> <span class="n">extractelement</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">double</span><span class="o">*></span> <span class="o">%</span><span class="n">ptrs</span><span class="p">,</span> <span class="n">i32</span> <span class="mi">0</span>
<span class="o">%</span><span class="n">ptr1</span> <span class="o">=</span> <span class="n">extractelement</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">double</span><span class="o">*></span> <span class="o">%</span><span class="n">ptrs</span><span class="p">,</span> <span class="n">i32</span> <span class="mi">1</span>
<span class="o">%</span><span class="n">ptr2</span> <span class="o">=</span> <span class="n">extractelement</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">double</span><span class="o">*></span> <span class="o">%</span><span class="n">ptrs</span><span class="p">,</span> <span class="n">i32</span> <span class="mi">2</span>
<span class="o">%</span><span class="n">ptr3</span> <span class="o">=</span> <span class="n">extractelement</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">double</span><span class="o">*></span> <span class="o">%</span><span class="n">ptrs</span><span class="p">,</span> <span class="n">i32</span> <span class="mi">3</span>
<span class="o">%</span><span class="n">val0</span> <span class="o">=</span> <span class="n">load</span> <span class="n">double</span><span class="p">,</span> <span class="n">double</span><span class="o">*</span> <span class="o">%</span><span class="n">ptr0</span><span class="p">,</span> <span class="n">align</span> <span class="mi">8</span>
<span class="o">%</span><span class="n">val1</span> <span class="o">=</span> <span class="n">load</span> <span class="n">double</span><span class="p">,</span> <span class="n">double</span><span class="o">*</span> <span class="o">%</span><span class="n">ptr1</span><span class="p">,</span> <span class="n">align</span> <span class="mi">8</span>
<span class="o">%</span><span class="n">val2</span> <span class="o">=</span> <span class="n">load</span> <span class="n">double</span><span class="p">,</span> <span class="n">double</span><span class="o">*</span> <span class="o">%</span><span class="n">ptr2</span><span class="p">,</span> <span class="n">align</span> <span class="mi">8</span>
<span class="o">%</span><span class="n">val3</span> <span class="o">=</span> <span class="n">load</span> <span class="n">double</span><span class="p">,</span> <span class="n">double</span><span class="o">*</span> <span class="o">%</span><span class="n">ptr3</span><span class="p">,</span> <span class="n">align</span> <span class="mi">8</span>
<span class="o">%</span><span class="n">vec0</span> <span class="o">=</span> <span class="n">insertelement</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">double</span><span class="o">></span><span class="n">undef</span><span class="p">,</span> <span class="o">%</span><span class="n">val0</span><span class="p">,</span> <span class="mi">0</span>
<span class="o">%</span><span class="n">vec01</span> <span class="o">=</span> <span class="n">insertelement</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">double</span><span class="o">>%</span><span class="n">vec0</span><span class="p">,</span> <span class="o">%</span><span class="n">val1</span><span class="p">,</span> <span class="mi">1</span>
<span class="o">%</span><span class="n">vec012</span> <span class="o">=</span> <span class="n">insertelement</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">double</span><span class="o">>%</span><span class="n">vec01</span><span class="p">,</span> <span class="o">%</span><span class="n">val2</span><span class="p">,</span> <span class="mi">2</span>
<span class="o">%</span><span class="n">vec0123</span> <span class="o">=</span> <span class="n">insertelement</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">double</span><span class="o">>%</span><span class="n">vec012</span><span class="p">,</span> <span class="o">%</span><span class="n">val3</span><span class="p">,</span> <span class="mi">3</span>
</pre></div>
</div>
</div>
</div>
<div class="section" id="llvm-masked-scatter-intrinsics">
<span id="int-mscatter"></span><h4><a class="toc-backref" href="#id2903">‘<code class="docutils literal notranslate"><span class="pre">llvm.masked.scatter.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-masked-scatter-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1049">
<h5><a class="toc-backref" href="#id2904">Syntax:</a><a class="headerlink" href="#id1049" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. The data stored in memory is a vector of any integer, floating-point or pointer data type. Each vector element is stored in an arbitrary memory address. Scatter with overlapping addresses is guaranteed to be ordered from least-significant to most-significant element.</p>
<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">masked</span><span class="o">.</span><span class="n">scatter</span><span class="o">.</span><span class="n">v8i32</span><span class="o">.</span><span class="n">v8p0i32</span> <span class="p">(</span><span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i32</span><span class="o">*></span> <span class="o"><</span><span class="n">ptrs</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="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">void</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">masked</span><span class="o">.</span><span class="n">scatter</span><span class="o">.</span><span class="n">v16f32</span><span class="o">.</span><span class="n">v16p1f32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span> <span class="n">addrspace</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span><span class="o">*></span> <span class="o"><</span><span class="n">ptrs</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="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">void</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">masked</span><span class="o">.</span><span class="n">scatter</span><span class="o">.</span><span class="n">v4p0f64</span><span class="o">.</span><span class="n">v4p0p0f64</span> <span class="p">(</span><span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">double</span><span class="o">*></span> <span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">double</span><span class="o">**></span> <span class="o"><</span><span class="n">ptrs</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="o"><</span><span class="mi">4</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1050">
<h5><a class="toc-backref" href="#id2905">Overview:</a><a class="headerlink" href="#id1050" title="Permalink to this headline">¶</a></h5>
<p>Writes each element from the value vector to the corresponding memory address. The memory addresses are represented as a vector of pointers. Writing is done according to the provided mask. The mask holds a bit for each vector lane, and is used to prevent memory accesses to the masked-off lanes.</p>
</div>
<div class="section" id="id1051">
<h5><a class="toc-backref" href="#id2906">Arguments:</a><a class="headerlink" href="#id1051" title="Permalink to this headline">¶</a></h5>
<p>The first operand is a vector value to be written to memory. The second operand is a vector of pointers, pointing to where the value elements should be stored. It has the same underlying type as the value operand. The third operand is an alignment of the destination addresses. It must be 0 or a power of two constant integer value. The fourth operand, mask, is a vector of boolean values. The types of the mask and the value operand must have the same number of vector elements.</p>
</div>
<div class="section" id="id1052">
<h5><a class="toc-backref" href="#id2907">Semantics:</a><a class="headerlink" href="#id1052" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.masked.scatter</span></code>’ intrinsics is designed for writing selected vector elements to arbitrary memory addresses in a single IR operation. The operation may be conditional, when not all bits in the mask are switched on. It is useful for targets that support vector masked scatter and allows vectorizing basic blocks with data and control divergence. Other targets may support this intrinsic differently, for example by lowering it into a sequence of branches that guard scalar store operations.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="p">;;</span> <span class="n">This</span> <span class="n">instruction</span> <span class="n">unconditionally</span> <span class="n">stores</span> <span class="n">data</span> <span class="n">vector</span> <span class="ow">in</span> <span class="n">multiple</span> <span class="n">addresses</span>
<span class="n">call</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">masked</span><span class="o">.</span><span class="n">scatter</span><span class="o">.</span><span class="n">v8i32</span><span class="o">.</span><span class="n">v8p0i32</span> <span class="p">(</span><span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">value</span><span class="p">,</span> <span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i32</span><span class="o">*></span> <span class="o">%</span><span class="n">ptrs</span><span class="p">,</span> <span class="n">i32</span> <span class="mi">4</span><span class="p">,</span> <span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">true</span><span class="p">,</span> <span class="n">true</span><span class="p">,</span> <span class="o">..</span> <span class="n">true</span><span class="o">></span><span class="p">)</span>
<span class="p">;;</span> <span class="n">It</span> <span class="ow">is</span> <span class="n">equivalent</span> <span class="n">to</span> <span class="n">a</span> <span class="nb">list</span> <span class="n">of</span> <span class="n">scalar</span> <span class="n">stores</span>
<span class="o">%</span><span class="n">val0</span> <span class="o">=</span> <span class="n">extractelement</span> <span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">value</span><span class="p">,</span> <span class="n">i32</span> <span class="mi">0</span>
<span class="o">%</span><span class="n">val1</span> <span class="o">=</span> <span class="n">extractelement</span> <span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">value</span><span class="p">,</span> <span class="n">i32</span> <span class="mi">1</span>
<span class="o">..</span>
<span class="o">%</span><span class="n">val7</span> <span class="o">=</span> <span class="n">extractelement</span> <span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o">%</span><span class="n">value</span><span class="p">,</span> <span class="n">i32</span> <span class="mi">7</span>
<span class="o">%</span><span class="n">ptr0</span> <span class="o">=</span> <span class="n">extractelement</span> <span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i32</span><span class="o">*></span> <span class="o">%</span><span class="n">ptrs</span><span class="p">,</span> <span class="n">i32</span> <span class="mi">0</span>
<span class="o">%</span><span class="n">ptr1</span> <span class="o">=</span> <span class="n">extractelement</span> <span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i32</span><span class="o">*></span> <span class="o">%</span><span class="n">ptrs</span><span class="p">,</span> <span class="n">i32</span> <span class="mi">1</span>
<span class="o">..</span>
<span class="o">%</span><span class="n">ptr7</span> <span class="o">=</span> <span class="n">extractelement</span> <span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i32</span><span class="o">*></span> <span class="o">%</span><span class="n">ptrs</span><span class="p">,</span> <span class="n">i32</span> <span class="mi">7</span>
<span class="p">;;</span> <span class="n">Note</span><span class="p">:</span> <span class="n">the</span> <span class="n">order</span> <span class="n">of</span> <span class="n">the</span> <span class="n">following</span> <span class="n">stores</span> <span class="ow">is</span> <span class="n">important</span> <span class="n">when</span> <span class="n">they</span> <span class="n">overlap</span><span class="p">:</span>
<span class="n">store</span> <span class="n">i32</span> <span class="o">%</span><span class="n">val0</span><span class="p">,</span> <span class="n">i32</span><span class="o">*</span> <span class="o">%</span><span class="n">ptr0</span><span class="p">,</span> <span class="n">align</span> <span class="mi">4</span>
<span class="n">store</span> <span class="n">i32</span> <span class="o">%</span><span class="n">val1</span><span class="p">,</span> <span class="n">i32</span><span class="o">*</span> <span class="o">%</span><span class="n">ptr1</span><span class="p">,</span> <span class="n">align</span> <span class="mi">4</span>
<span class="o">..</span>
<span class="n">store</span> <span class="n">i32</span> <span class="o">%</span><span class="n">val7</span><span class="p">,</span> <span class="n">i32</span><span class="o">*</span> <span class="o">%</span><span class="n">ptr7</span><span class="p">,</span> <span class="n">align</span> <span class="mi">4</span>
</pre></div>
</div>
</div>
</div>
</div>
<div class="section" id="masked-vector-expanding-load-and-compressing-store-intrinsics">
<h3><a class="toc-backref" href="#id2908">Masked Vector Expanding Load and Compressing Store Intrinsics</a><a class="headerlink" href="#masked-vector-expanding-load-and-compressing-store-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>LLVM provides intrinsics for expanding load and compressing store operations. Data selected from a vector according to a mask is stored in consecutive memory addresses (compressed store), and vice-versa (expanding load). These operations effective map to “if (cond.i) a[j++] = v.i” and “if (cond.i) v.i = a[j++]” patterns, respectively. Note that when the mask starts with ‘1’ bits followed by ‘0’ bits, these operations are identical to <a class="reference internal" href="#int-mstore"><span class="std std-ref">llvm.masked.store</span></a> and <a class="reference internal" href="#int-mload"><span class="std std-ref">llvm.masked.load</span></a>.</p>
<div class="section" id="llvm-masked-expandload-intrinsics">
<span id="int-expandload"></span><h4><a class="toc-backref" href="#id2909">‘<code class="docutils literal notranslate"><span class="pre">llvm.masked.expandload.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-masked-expandload-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1053">
<h5><a class="toc-backref" href="#id2910">Syntax:</a><a class="headerlink" href="#id1053" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. Several values of integer, floating point or pointer data type are loaded from consecutive memory addresses and stored into the elements of a vector according to the mask.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">masked</span><span class="o">.</span><span class="n">expandload</span><span class="o">.</span><span class="n">v16f32</span> <span class="p">(</span><span class="nb">float</span><span class="o">*</span> <span class="o"><</span><span class="n">ptr</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">passthru</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">masked</span><span class="o">.</span><span class="n">expandload</span><span class="o">.</span><span class="n">v2i64</span> <span class="p">(</span><span class="n">i64</span><span class="o">*</span> <span class="o"><</span><span class="n">ptr</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">2</span> <span class="n">x</span> <span class="n">i64</span><span class="o">></span> <span class="o"><</span><span class="n">passthru</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1054">
<h5><a class="toc-backref" href="#id2911">Overview:</a><a class="headerlink" href="#id1054" title="Permalink to this headline">¶</a></h5>
<p>Reads a number of scalar values sequentially from memory location provided in ‘<code class="docutils literal notranslate"><span class="pre">ptr</span></code>’ and spreads them in a vector. The ‘<code class="docutils literal notranslate"><span class="pre">mask</span></code>’ holds a bit for each vector lane. The number of elements read from memory is equal to the number of ‘1’ bits in the mask. The loaded elements are positioned in the destination vector according to the sequence of ‘1’ and ‘0’ bits in the mask. E.g., if the mask vector is ‘10010001’, “expandload” reads 3 values from memory addresses ptr, ptr+1, ptr+2 and places them in lanes 0, 3 and 7 accordingly. The masked-off lanes are filled by elements from the corresponding lanes of the ‘<code class="docutils literal notranslate"><span class="pre">passthru</span></code>’ operand.</p>
</div>
<div class="section" id="id1055">
<h5><a class="toc-backref" href="#id2912">Arguments:</a><a class="headerlink" href="#id1055" title="Permalink to this headline">¶</a></h5>
<p>The first operand is the base pointer for the load. It has the same underlying type as the element of the returned vector. The second operand, mask, is a vector of boolean values with the same number of elements as the return type. The third is a pass-through value that is used to fill the masked-off lanes of the result. The return type and the type of the ‘<code class="docutils literal notranslate"><span class="pre">passthru</span></code>’ operand have the same vector type.</p>
</div>
<div class="section" id="id1056">
<h5><a class="toc-backref" href="#id2913">Semantics:</a><a class="headerlink" href="#id1056" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.masked.expandload</span></code>’ intrinsic is designed for reading multiple scalar values from adjacent memory addresses into possibly non-adjacent vector lanes. It is useful for targets that support vector expanding loads and allows vectorizing loop with cross-iteration dependency like in the following example:</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="c1">// In this loop we load from B and spread the elements into array A.</span>
<span class="kt">double</span> <span class="o">*</span><span class="n">A</span><span class="p">,</span> <span class="n">B</span><span class="p">;</span> <span class="kt">int</span> <span class="o">*</span><span class="n">C</span><span class="p">;</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">size</span><span class="p">;</span> <span class="o">++</span><span class="n">i</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="n">C</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">A</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">=</span> <span class="n">B</span><span class="p">[</span><span class="n">j</span><span class="o">++</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="c">; Load several elements from array B and expand them in a vector.</span>
<span class="c">; The number of loaded elements is equal to the number of '1' elements in the Mask.</span>
<span class="nv">%Tmp</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">8</span> <span class="k">x</span> <span class="k">double</span><span class="p">></span> <span class="vg">@llvm.masked.expandload.v8f64</span><span class="p">(</span><span class="k">double</span><span class="p">*</span> <span class="nv">%Bptr</span><span class="p">,</span> <span class="p"><</span><span class="m">8</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%Mask</span><span class="p">,</span> <span class="p"><</span><span class="m">8</span> <span class="k">x</span> <span class="k">double</span><span class="p">></span> <span class="k">undef</span><span class="p">)</span>
<span class="c">; Store the result in A</span>
<span class="k">call</span> <span class="k">void</span> <span class="vg">@llvm.masked.store.v8f64.p0v8f64</span><span class="p">(<</span><span class="m">8</span> <span class="k">x</span> <span class="k">double</span><span class="p">></span> <span class="nv">%Tmp</span><span class="p">,</span> <span class="p"><</span><span class="m">8</span> <span class="k">x</span> <span class="k">double</span><span class="p">>*</span> <span class="nv">%Aptr</span><span class="p">,</span> <span class="k">i32</span> <span class="m">8</span><span class="p">,</span> <span class="p"><</span><span class="m">8</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%Mask</span><span class="p">)</span>
<span class="c">; %Bptr should be increased on each iteration according to the number of '1' elements in the Mask.</span>
<span class="nv">%MaskI</span> <span class="p">=</span> <span class="k">bitcast</span> <span class="p"><</span><span class="m">8</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%Mask</span> <span class="k">to</span> <span class="k">i8</span>
<span class="nv">%MaskIPopcnt</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span> <span class="vg">@llvm.ctpop.i8</span><span class="p">(</span><span class="k">i8</span> <span class="nv">%MaskI</span><span class="p">)</span>
<span class="nv">%MaskI64</span> <span class="p">=</span> <span class="k">zext</span> <span class="k">i8</span> <span class="nv">%MaskIPopcnt</span> <span class="k">to</span> <span class="k">i64</span>
<span class="nv">%BNextInd</span> <span class="p">=</span> <span class="k">add</span> <span class="k">i64</span> <span class="nv">%BInd</span><span class="p">,</span> <span class="nv">%MaskI64</span>
</pre></div>
</div>
<p>Other targets may support this intrinsic differently, for example, by lowering it into a sequence of conditional scalar load operations and shuffles.
If all mask elements are ‘1’, the intrinsic behavior is equivalent to the regular unmasked vector load.</p>
</div>
</div>
<div class="section" id="llvm-masked-compressstore-intrinsics">
<span id="int-compressstore"></span><h4><a class="toc-backref" href="#id2914">‘<code class="docutils literal notranslate"><span class="pre">llvm.masked.compressstore.*</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-masked-compressstore-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1057">
<h5><a class="toc-backref" href="#id2915">Syntax:</a><a class="headerlink" href="#id1057" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. A number of scalar values of integer, floating point or pointer data type are collected from an input vector and stored into adjacent memory addresses. A mask defines which elements to collect from the vector.</p>
<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">masked</span><span class="o">.</span><span class="n">compressstore</span><span class="o">.</span><span class="n">v8i32</span> <span class="p">(</span><span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i32</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span><span class="o">*</span> <span class="o"><</span><span class="n">ptr</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">8</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">void</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">masked</span><span class="o">.</span><span class="n">compressstore</span><span class="o">.</span><span class="n">v16f32</span> <span class="p">(</span><span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="nb">float</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">,</span> <span class="nb">float</span><span class="o">*</span> <span class="o"><</span><span class="n">ptr</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="mi">16</span> <span class="n">x</span> <span class="n">i1</span><span class="o">></span> <span class="o"><</span><span class="n">mask</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1058">
<h5><a class="toc-backref" href="#id2916">Overview:</a><a class="headerlink" href="#id1058" title="Permalink to this headline">¶</a></h5>
<p>Selects elements from input vector ‘<code class="docutils literal notranslate"><span class="pre">value</span></code>’ according to the ‘<code class="docutils literal notranslate"><span class="pre">mask</span></code>’. All selected elements are written into adjacent memory addresses starting at address ‘<cite>ptr</cite>’, from lower to higher. The mask holds a bit for each vector lane, and is used to select elements to be stored. The number of elements to be stored is equal to the number of active bits in the mask.</p>
</div>
<div class="section" id="id1059">
<h5><a class="toc-backref" href="#id2917">Arguments:</a><a class="headerlink" href="#id1059" title="Permalink to this headline">¶</a></h5>
<p>The first operand is the input vector, from which elements are collected and written to memory. The second operand is the base pointer for the store, it has the same underlying type as the element of the input vector operand. The third operand is the mask, a vector of boolean values. The mask and the input vector must have the same number of vector elements.</p>
</div>
<div class="section" id="id1060">
<h5><a class="toc-backref" href="#id2918">Semantics:</a><a class="headerlink" href="#id1060" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.masked.compressstore</span></code>’ intrinsic is designed for compressing data in memory. It allows to collect elements from possibly non-adjacent lanes of a vector and store them contiguously in memory in one IR operation. It is useful for targets that support compressing store operations and allows vectorizing loops with cross-iteration dependences like in the following example:</p>
<div class="highlight-c notranslate"><div class="highlight"><pre><span></span><span class="c1">// In this loop we load elements from A and store them consecutively in B</span>
<span class="kt">double</span> <span class="o">*</span><span class="n">A</span><span class="p">,</span> <span class="n">B</span><span class="p">;</span> <span class="kt">int</span> <span class="o">*</span><span class="n">C</span><span class="p">;</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">size</span><span class="p">;</span> <span class="o">++</span><span class="n">i</span><span class="p">)</span> <span class="p">{</span>
<span class="k">if</span> <span class="p">(</span><span class="n">C</span><span class="p">[</span><span class="n">i</span><span class="p">]</span> <span class="o">!=</span> <span class="mi">0</span><span class="p">)</span>
<span class="n">B</span><span class="p">[</span><span class="n">j</span><span class="o">++</span><span class="p">]</span> <span class="o">=</span> <span class="n">A</span><span class="p">[</span><span class="n">i</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="c">; Load elements from A.</span>
<span class="nv">%Tmp</span> <span class="p">=</span> <span class="k">call</span> <span class="p"><</span><span class="m">8</span> <span class="k">x</span> <span class="k">double</span><span class="p">></span> <span class="vg">@llvm.masked.load.v8f64.p0v8f64</span><span class="p">(<</span><span class="m">8</span> <span class="k">x</span> <span class="k">double</span><span class="p">>*</span> <span class="nv">%Aptr</span><span class="p">,</span> <span class="k">i32</span> <span class="m">8</span><span class="p">,</span> <span class="p"><</span><span class="m">8</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%Mask</span><span class="p">,</span> <span class="p"><</span><span class="m">8</span> <span class="k">x</span> <span class="k">double</span><span class="p">></span> <span class="k">undef</span><span class="p">)</span>
<span class="c">; Store all selected elements consecutively in array B</span>
<span class="k">call</span> <span class="p"><</span><span class="k">void</span><span class="p">></span> <span class="vg">@llvm.masked.compressstore.v8f64</span><span class="p">(<</span><span class="m">8</span> <span class="k">x</span> <span class="k">double</span><span class="p">></span> <span class="nv">%Tmp</span><span class="p">,</span> <span class="k">double</span><span class="p">*</span> <span class="nv">%Bptr</span><span class="p">,</span> <span class="p"><</span><span class="m">8</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%Mask</span><span class="p">)</span>
<span class="c">; %Bptr should be increased on each iteration according to the number of '1' elements in the Mask.</span>
<span class="nv">%MaskI</span> <span class="p">=</span> <span class="k">bitcast</span> <span class="p"><</span><span class="m">8</span> <span class="k">x</span> <span class="k">i1</span><span class="p">></span> <span class="nv">%Mask</span> <span class="k">to</span> <span class="k">i8</span>
<span class="nv">%MaskIPopcnt</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i8</span> <span class="vg">@llvm.ctpop.i8</span><span class="p">(</span><span class="k">i8</span> <span class="nv">%MaskI</span><span class="p">)</span>
<span class="nv">%MaskI64</span> <span class="p">=</span> <span class="k">zext</span> <span class="k">i8</span> <span class="nv">%MaskIPopcnt</span> <span class="k">to</span> <span class="k">i64</span>
<span class="nv">%BNextInd</span> <span class="p">=</span> <span class="k">add</span> <span class="k">i64</span> <span class="nv">%BInd</span><span class="p">,</span> <span class="nv">%MaskI64</span>
</pre></div>
</div>
<p>Other targets may support this intrinsic differently, for example, by lowering it into a sequence of branches that guard scalar store operations.</p>
</div>
</div>
</div>
<div class="section" id="memory-use-markers">
<h3><a class="toc-backref" href="#id2919">Memory Use Markers</a><a class="headerlink" href="#memory-use-markers" title="Permalink to this headline">¶</a></h3>
<p>This class of intrinsics provides information about the
<a class="reference internal" href="#objectlifetime"><span class="std std-ref">lifetime of memory objects</span></a> and ranges where variables
are immutable.</p>
<div class="section" id="llvm-lifetime-start-intrinsic">
<span id="int-lifestart"></span><h4><a class="toc-backref" href="#id2920">‘<code class="docutils literal notranslate"><span class="pre">llvm.lifetime.start</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-lifetime-start-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1061">
<h5><a class="toc-backref" href="#id2921">Syntax:</a><a class="headerlink" href="#id1061" 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">lifetime</span><span class="o">.</span><span class="n">start</span><span class="p">(</span><span class="n">i64</span> <span class="o"><</span><span class="n">size</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="n">nocapture</span> <span class="o"><</span><span class="n">ptr</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1062">
<h5><a class="toc-backref" href="#id2922">Overview:</a><a class="headerlink" href="#id1062" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.lifetime.start</span></code>’ intrinsic specifies the start of a memory
object’s lifetime.</p>
</div>
<div class="section" id="id1063">
<h5><a class="toc-backref" href="#id2923">Arguments:</a><a class="headerlink" href="#id1063" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a constant integer representing the size of the
object, or -1 if it is variable sized. The second argument is a pointer
to the object.</p>
</div>
<div class="section" id="id1064">
<h5><a class="toc-backref" href="#id2924">Semantics:</a><a class="headerlink" href="#id1064" title="Permalink to this headline">¶</a></h5>
<p>If <code class="docutils literal notranslate"><span class="pre">ptr</span></code> is a stack-allocated object and it points to the first byte of
the object, the object is initially marked as dead.
<code class="docutils literal notranslate"><span class="pre">ptr</span></code> is conservatively considered as a non-stack-allocated object if
the stack coloring algorithm that is used in the optimization pipeline cannot
conclude that <code class="docutils literal notranslate"><span class="pre">ptr</span></code> is a stack-allocated object.</p>
<p>After ‘<code class="docutils literal notranslate"><span class="pre">llvm.lifetime.start</span></code>’, the stack object that <code class="docutils literal notranslate"><span class="pre">ptr</span></code> points is marked
as alive and has an uninitialized value.
The stack object is marked as dead when either
<a class="reference internal" href="#int-lifeend"><span class="std std-ref">llvm.lifetime.end</span></a> to the alloca is executed or the
function returns.</p>
<p>After <a class="reference internal" href="#int-lifeend"><span class="std std-ref">llvm.lifetime.end</span></a> is called,
‘<code class="docutils literal notranslate"><span class="pre">llvm.lifetime.start</span></code>’ on the stack object can be called again.
The second ‘<code class="docutils literal notranslate"><span class="pre">llvm.lifetime.start</span></code>’ call marks the object as alive, but it
does not change the address of the object.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">ptr</span></code> is a non-stack-allocated object, it does not point to the first
byte of the object or it is a stack object that is already alive, it simply
fills all bytes of the object with <code class="docutils literal notranslate"><span class="pre">poison</span></code>.</p>
</div>
</div>
<div class="section" id="llvm-lifetime-end-intrinsic">
<span id="int-lifeend"></span><h4><a class="toc-backref" href="#id2925">‘<code class="docutils literal notranslate"><span class="pre">llvm.lifetime.end</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-lifetime-end-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1065">
<h5><a class="toc-backref" href="#id2926">Syntax:</a><a class="headerlink" href="#id1065" 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">lifetime</span><span class="o">.</span><span class="n">end</span><span class="p">(</span><span class="n">i64</span> <span class="o"><</span><span class="n">size</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="n">nocapture</span> <span class="o"><</span><span class="n">ptr</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1066">
<h5><a class="toc-backref" href="#id2927">Overview:</a><a class="headerlink" href="#id1066" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.lifetime.end</span></code>’ intrinsic specifies the end of a memory object’s
lifetime.</p>
</div>
<div class="section" id="id1067">
<h5><a class="toc-backref" href="#id2928">Arguments:</a><a class="headerlink" href="#id1067" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a constant integer representing the size of the
object, or -1 if it is variable sized. The second argument is a pointer
to the object.</p>
</div>
<div class="section" id="id1068">
<h5><a class="toc-backref" href="#id2929">Semantics:</a><a class="headerlink" href="#id1068" title="Permalink to this headline">¶</a></h5>
<p>If <code class="docutils literal notranslate"><span class="pre">ptr</span></code> is a stack-allocated object and it points to the first byte of the
object, the object is dead.
<code class="docutils literal notranslate"><span class="pre">ptr</span></code> is conservatively considered as a non-stack-allocated object if
the stack coloring algorithm that is used in the optimization pipeline cannot
conclude that <code class="docutils literal notranslate"><span class="pre">ptr</span></code> is a stack-allocated object.</p>
<p>Calling <code class="docutils literal notranslate"><span class="pre">llvm.lifetime.end</span></code> on an already dead alloca is no-op.</p>
<p>If <code class="docutils literal notranslate"><span class="pre">ptr</span></code> is a non-stack-allocated object or it does not point to the first
byte of the object, it is equivalent to simply filling all bytes of the object
with <code class="docutils literal notranslate"><span class="pre">poison</span></code>.</p>
</div>
</div>
<div class="section" id="llvm-invariant-start-intrinsic">
<h4><a class="toc-backref" href="#id2930">‘<code class="docutils literal notranslate"><span class="pre">llvm.invariant.start</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-invariant-start-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1069">
<h5><a class="toc-backref" href="#id2931">Syntax:</a><a class="headerlink" href="#id1069" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. The memory object can belong to any address space.</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">declare</span> <span class="p">{}</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">invariant</span><span class="o">.</span><span class="n">start</span><span class="o">.</span><span class="n">p0i8</span><span class="p">(</span><span class="n">i64</span> <span class="o"><</span><span class="n">size</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="n">nocapture</span> <span class="o"><</span><span class="n">ptr</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1070">
<h5><a class="toc-backref" href="#id2932">Overview:</a><a class="headerlink" href="#id1070" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.invariant.start</span></code>’ intrinsic specifies that the contents of
a memory object will not change.</p>
</div>
<div class="section" id="id1071">
<h5><a class="toc-backref" href="#id2933">Arguments:</a><a class="headerlink" href="#id1071" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a constant integer representing the size of the
object, or -1 if it is variable sized. The second argument is a pointer
to the object.</p>
</div>
<div class="section" id="id1072">
<h5><a class="toc-backref" href="#id2934">Semantics:</a><a class="headerlink" href="#id1072" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic indicates that until an <code class="docutils literal notranslate"><span class="pre">llvm.invariant.end</span></code> that uses
the return value, the referenced memory location is constant and
unchanging.</p>
</div>
</div>
<div class="section" id="llvm-invariant-end-intrinsic">
<h4><a class="toc-backref" href="#id2935">‘<code class="docutils literal notranslate"><span class="pre">llvm.invariant.end</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-invariant-end-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1073">
<h5><a class="toc-backref" href="#id2936">Syntax:</a><a class="headerlink" href="#id1073" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. The memory object can belong to any address space.</p>
<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">invariant</span><span class="o">.</span><span class="n">end</span><span class="o">.</span><span class="n">p0i8</span><span class="p">({}</span><span class="o">*</span> <span class="o"><</span><span class="n">start</span><span class="o">></span><span class="p">,</span> <span class="n">i64</span> <span class="o"><</span><span class="n">size</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="n">nocapture</span> <span class="o"><</span><span class="n">ptr</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1074">
<h5><a class="toc-backref" href="#id2937">Overview:</a><a class="headerlink" href="#id1074" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.invariant.end</span></code>’ intrinsic specifies that the contents of a
memory object are mutable.</p>
</div>
<div class="section" id="id1075">
<h5><a class="toc-backref" href="#id2938">Arguments:</a><a class="headerlink" href="#id1075" title="Permalink to this headline">¶</a></h5>
<p>The first argument is the matching <code class="docutils literal notranslate"><span class="pre">llvm.invariant.start</span></code> intrinsic.
The second argument is a constant integer representing the size of the
object, or -1 if it is variable sized and the third argument is a
pointer to the object.</p>
</div>
<div class="section" id="id1076">
<h5><a class="toc-backref" href="#id2939">Semantics:</a><a class="headerlink" href="#id1076" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic indicates that the memory is mutable again.</p>
</div>
</div>
<div class="section" id="llvm-launder-invariant-group-intrinsic">
<h4><a class="toc-backref" href="#id2940">‘<code class="docutils literal notranslate"><span class="pre">llvm.launder.invariant.group</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-launder-invariant-group-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1077">
<h5><a class="toc-backref" href="#id2941">Syntax:</a><a class="headerlink" href="#id1077" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. The memory object can belong to any address
space. The returned pointer must belong to the same address space as the
argument.</p>
<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">launder</span><span class="o">.</span><span class="n">invariant</span><span class="o">.</span><span class="n">group</span><span class="o">.</span><span class="n">p0i8</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>
</pre></div>
</div>
</div>
<div class="section" id="id1078">
<h5><a class="toc-backref" href="#id2942">Overview:</a><a class="headerlink" href="#id1078" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.launder.invariant.group</span></code>’ intrinsic can be used when an invariant
established by <code class="docutils literal notranslate"><span class="pre">invariant.group</span></code> metadata no longer holds, to obtain a new
pointer value that carries fresh invariant group information. It is an
experimental intrinsic, which means that its semantics might change in the
future.</p>
</div>
<div class="section" id="id1079">
<h5><a class="toc-backref" href="#id2943">Arguments:</a><a class="headerlink" href="#id1079" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.launder.invariant.group</span></code> takes only one argument, which is a pointer
to the memory.</p>
</div>
<div class="section" id="id1080">
<h5><a class="toc-backref" href="#id2944">Semantics:</a><a class="headerlink" href="#id1080" title="Permalink to this headline">¶</a></h5>
<p>Returns another pointer that aliases its argument but which is considered different
for the purposes of <code class="docutils literal notranslate"><span class="pre">load</span></code>/<code class="docutils literal notranslate"><span class="pre">store</span></code> <code class="docutils literal notranslate"><span class="pre">invariant.group</span></code> metadata.
It does not read any accessible memory and the execution can be speculated.</p>
</div>
</div>
<div class="section" id="llvm-strip-invariant-group-intrinsic">
<h4><a class="toc-backref" href="#id2945">‘<code class="docutils literal notranslate"><span class="pre">llvm.strip.invariant.group</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-strip-invariant-group-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1081">
<h5><a class="toc-backref" href="#id2946">Syntax:</a><a class="headerlink" href="#id1081" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. The memory object can belong to any address
space. The returned pointer must belong to the same address space as the
argument.</p>
<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">strip</span><span class="o">.</span><span class="n">invariant</span><span class="o">.</span><span class="n">group</span><span class="o">.</span><span class="n">p0i8</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>
</pre></div>
</div>
</div>
<div class="section" id="id1082">
<h5><a class="toc-backref" href="#id2947">Overview:</a><a class="headerlink" href="#id1082" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.strip.invariant.group</span></code>’ intrinsic can be used when an invariant
established by <code class="docutils literal notranslate"><span class="pre">invariant.group</span></code> metadata no longer holds, to obtain a new pointer
value that does not carry the invariant information. It is an experimental
intrinsic, which means that its semantics might change in the future.</p>
</div>
<div class="section" id="id1083">
<h5><a class="toc-backref" href="#id2948">Arguments:</a><a class="headerlink" href="#id1083" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.strip.invariant.group</span></code> takes only one argument, which is a pointer
to the memory.</p>
</div>
<div class="section" id="id1084">
<h5><a class="toc-backref" href="#id2949">Semantics:</a><a class="headerlink" href="#id1084" title="Permalink to this headline">¶</a></h5>
<p>Returns another pointer that aliases its argument but which has no associated
<code class="docutils literal notranslate"><span class="pre">invariant.group</span></code> metadata.
It does not read any memory and can be speculated.</p>
</div>
</div>
</div>
<div class="section" id="constrained-floating-point-intrinsics">
<span id="constrainedfp"></span><h3><a class="toc-backref" href="#id2950">Constrained Floating-Point Intrinsics</a><a class="headerlink" href="#constrained-floating-point-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>These intrinsics are used to provide special handling of floating-point
operations when specific rounding mode or floating-point exception behavior is
required. By default, LLVM optimization passes assume that the rounding mode is
round-to-nearest and that floating-point exceptions will not be monitored.
Constrained FP intrinsics are used to support non-default rounding modes and
accurately preserve exception behavior without compromising LLVM’s ability to
optimize FP code when the default behavior is used.</p>
<p>If any FP operation in a function is constrained then they all must be
constrained. This is required for correct LLVM IR. Optimizations that
move code around can create miscompiles if mixing of constrained and normal
operations is done. The correct way to mix constrained and less constrained
operations is to use the rounding mode and exception handling metadata to
mark constrained intrinsics as having LLVM’s default behavior.</p>
<p>Each of these intrinsics corresponds to a normal floating-point operation. The
data arguments and the return value are the same as the corresponding FP
operation.</p>
<p>The rounding mode argument is a metadata string specifying what
assumptions, if any, the optimizer can make when transforming constant
values. Some constrained FP intrinsics omit this argument. If required
by the intrinsic, this argument must be one of the following strings:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s2">"round.dynamic"</span>
<span class="s2">"round.tonearest"</span>
<span class="s2">"round.downward"</span>
<span class="s2">"round.upward"</span>
<span class="s2">"round.towardzero"</span>
<span class="s2">"round.tonearestaway"</span>
</pre></div>
</div>
<p>If this argument is “round.dynamic” optimization passes must assume that the
rounding mode is unknown and may change at runtime. No transformations that
depend on rounding mode may be performed in this case.</p>
<p>The other possible values for the rounding mode argument correspond to the
similarly named IEEE rounding modes. If the argument is any of these values
optimization passes may perform transformations as long as they are consistent
with the specified rounding mode.</p>
<p>For example, ‘x-0’->’x’ is not a valid transformation if the rounding mode is
“round.downward” or “round.dynamic” because if the value of ‘x’ is +0 then
‘x-0’ should evaluate to ‘-0’ when rounding downward. However, this
transformation is legal for all other rounding modes.</p>
<p>For values other than “round.dynamic” optimization passes may assume that the
actual runtime rounding mode (as defined in a target-specific manner) matches
the specified rounding mode, but this is not guaranteed. Using a specific
non-dynamic rounding mode which does not match the actual rounding mode at
runtime results in undefined behavior.</p>
<p>The exception behavior argument is a metadata string describing the floating
point exception semantics that required for the intrinsic. This argument
must be one of the following strings:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="s2">"fpexcept.ignore"</span>
<span class="s2">"fpexcept.maytrap"</span>
<span class="s2">"fpexcept.strict"</span>
</pre></div>
</div>
<p>If this argument is “fpexcept.ignore” optimization passes may assume that the
exception status flags will not be read and that floating-point exceptions will
be masked. This allows transformations to be performed that may change the
exception semantics of the original code. For example, FP operations may be
speculatively executed in this case whereas they must not be for either of the
other possible values of this argument.</p>
<p>If the exception behavior argument is “fpexcept.maytrap” optimization passes
must avoid transformations that may raise exceptions that would not have been
raised by the original code (such as speculatively executing FP operations), but
passes are not required to preserve all exceptions that are implied by the
original code. For example, exceptions may be potentially hidden by constant
folding.</p>
<p>If the exception behavior argument is “fpexcept.strict” all transformations must
strictly preserve the floating-point exception semantics of the original code.
Any FP exception that would have been raised by the original code must be raised
by the transformed code, and the transformed code must not raise any FP
exceptions that would not have been raised by the original code. This is the
exception behavior argument that will be used if the code being compiled reads
the FP exception status flags, but this mode can also be used with code that
unmasks FP exceptions.</p>
<p>The number and order of floating-point exceptions is NOT guaranteed. For
example, a series of FP operations that each may raise exceptions may be
vectorized into a single instruction that raises each unique exception a single
time.</p>
<p>Proper <a class="reference internal" href="#fnattrs"><span class="std std-ref">function attributes</span></a> usage is required for the
constrained intrinsics to function correctly.</p>
<p>All function <em>calls</em> done in a function that uses constrained floating
point intrinsics must have the <code class="docutils literal notranslate"><span class="pre">strictfp</span></code> attribute.</p>
<p>All function <em>definitions</em> that use constrained floating point intrinsics
must have the <code class="docutils literal notranslate"><span class="pre">strictfp</span></code> attribute.</p>
<div class="section" id="llvm-experimental-constrained-fadd-intrinsic">
<h4><a class="toc-backref" href="#id2951">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fadd</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-fadd-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1085">
<h5><a class="toc-backref" href="#id2952">Syntax:</a><a class="headerlink" href="#id1085" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">fadd</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op2</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1086">
<h5><a class="toc-backref" href="#id2953">Overview:</a><a class="headerlink" href="#id1086" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fadd</span></code>’ intrinsic returns the sum of its
two operands.</p>
</div>
<div class="section" id="id1087">
<h5><a class="toc-backref" href="#id2954">Arguments:</a><a class="headerlink" href="#id1087" title="Permalink to this headline">¶</a></h5>
<p>The first two arguments to the ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fadd</span></code>’
intrinsic must be <a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a>
of floating-point values. Both arguments must have identical types.</p>
<p>The third and fourth arguments specify the rounding mode and exception
behavior as described above.</p>
</div>
<div class="section" id="id1088">
<h5><a class="toc-backref" href="#id2955">Semantics:</a><a class="headerlink" href="#id1088" title="Permalink to this headline">¶</a></h5>
<p>The value produced is the floating-point sum of the two value operands and has
the same type as the operands.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-fsub-intrinsic">
<h4><a class="toc-backref" href="#id2956">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fsub</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-fsub-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1089">
<h5><a class="toc-backref" href="#id2957">Syntax:</a><a class="headerlink" href="#id1089" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">fsub</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op2</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1090">
<h5><a class="toc-backref" href="#id2958">Overview:</a><a class="headerlink" href="#id1090" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fsub</span></code>’ intrinsic returns the difference
of its two operands.</p>
</div>
<div class="section" id="id1091">
<h5><a class="toc-backref" href="#id2959">Arguments:</a><a class="headerlink" href="#id1091" title="Permalink to this headline">¶</a></h5>
<p>The first two arguments to the ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fsub</span></code>’
intrinsic must be <a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a>
of floating-point values. Both arguments must have identical types.</p>
<p>The third and fourth arguments specify the rounding mode and exception
behavior as described above.</p>
</div>
<div class="section" id="id1092">
<h5><a class="toc-backref" href="#id2960">Semantics:</a><a class="headerlink" href="#id1092" title="Permalink to this headline">¶</a></h5>
<p>The value produced is the floating-point difference of the two value operands
and has the same type as the operands.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-fmul-intrinsic">
<h4><a class="toc-backref" href="#id2961">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fmul</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-fmul-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1093">
<h5><a class="toc-backref" href="#id2962">Syntax:</a><a class="headerlink" href="#id1093" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">fmul</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op2</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1094">
<h5><a class="toc-backref" href="#id2963">Overview:</a><a class="headerlink" href="#id1094" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fmul</span></code>’ intrinsic returns the product of
its two operands.</p>
</div>
<div class="section" id="id1095">
<h5><a class="toc-backref" href="#id2964">Arguments:</a><a class="headerlink" href="#id1095" title="Permalink to this headline">¶</a></h5>
<p>The first two arguments to the ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fmul</span></code>’
intrinsic must be <a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a>
of floating-point values. Both arguments must have identical types.</p>
<p>The third and fourth arguments specify the rounding mode and exception
behavior as described above.</p>
</div>
<div class="section" id="id1096">
<h5><a class="toc-backref" href="#id2965">Semantics:</a><a class="headerlink" href="#id1096" title="Permalink to this headline">¶</a></h5>
<p>The value produced is the floating-point product of the two value operands and
has the same type as the operands.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-fdiv-intrinsic">
<h4><a class="toc-backref" href="#id2966">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fdiv</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-fdiv-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1097">
<h5><a class="toc-backref" href="#id2967">Syntax:</a><a class="headerlink" href="#id1097" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">fdiv</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op2</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1098">
<h5><a class="toc-backref" href="#id2968">Overview:</a><a class="headerlink" href="#id1098" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fdiv</span></code>’ intrinsic returns the quotient of
its two operands.</p>
</div>
<div class="section" id="id1099">
<h5><a class="toc-backref" href="#id2969">Arguments:</a><a class="headerlink" href="#id1099" title="Permalink to this headline">¶</a></h5>
<p>The first two arguments to the ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fdiv</span></code>’
intrinsic must be <a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a>
of floating-point values. Both arguments must have identical types.</p>
<p>The third and fourth arguments specify the rounding mode and exception
behavior as described above.</p>
</div>
<div class="section" id="id1100">
<h5><a class="toc-backref" href="#id2970">Semantics:</a><a class="headerlink" href="#id1100" title="Permalink to this headline">¶</a></h5>
<p>The value produced is the floating-point quotient of the two value operands and
has the same type as the operands.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-frem-intrinsic">
<h4><a class="toc-backref" href="#id2971">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.frem</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-frem-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1101">
<h5><a class="toc-backref" href="#id2972">Syntax:</a><a class="headerlink" href="#id1101" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">frem</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op2</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1102">
<h5><a class="toc-backref" href="#id2973">Overview:</a><a class="headerlink" href="#id1102" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.frem</span></code>’ intrinsic returns the remainder
from the division of its two operands.</p>
</div>
<div class="section" id="id1103">
<h5><a class="toc-backref" href="#id2974">Arguments:</a><a class="headerlink" href="#id1103" title="Permalink to this headline">¶</a></h5>
<p>The first two arguments to the ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.frem</span></code>’
intrinsic must be <a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a>
of floating-point values. Both arguments must have identical types.</p>
<p>The third and fourth arguments specify the rounding mode and exception
behavior as described above. The rounding mode argument has no effect, since
the result of frem is never rounded, but the argument is included for
consistency with the other constrained floating-point intrinsics.</p>
</div>
<div class="section" id="id1104">
<h5><a class="toc-backref" href="#id2975">Semantics:</a><a class="headerlink" href="#id1104" title="Permalink to this headline">¶</a></h5>
<p>The value produced is the floating-point remainder from the division of the two
value operands and has the same type as the operands. The remainder has the
same sign as the dividend.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-fma-intrinsic">
<h4><a class="toc-backref" href="#id2976">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fma</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-fma-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1105">
<h5><a class="toc-backref" href="#id2977">Syntax:</a><a class="headerlink" href="#id1105" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">fma</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op2</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op3</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1106">
<h5><a class="toc-backref" href="#id2978">Overview:</a><a class="headerlink" href="#id1106" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fma</span></code>’ intrinsic returns the result of a
fused-multiply-add operation on its operands.</p>
</div>
<div class="section" id="id1107">
<h5><a class="toc-backref" href="#id2979">Arguments:</a><a class="headerlink" href="#id1107" title="Permalink to this headline">¶</a></h5>
<p>The first three arguments to the ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fma</span></code>’
intrinsic must be <a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of floating-point values. All arguments must have identical types.</p>
<p>The fourth and fifth arguments specify the rounding mode and exception behavior
as described above.</p>
</div>
<div class="section" id="id1108">
<h5><a class="toc-backref" href="#id2980">Semantics:</a><a class="headerlink" href="#id1108" title="Permalink to this headline">¶</a></h5>
<p>The result produced is the product of the first two operands added to the third
operand computed with infinite precision, and then rounded to the target
precision.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-fptoui-intrinsic">
<h4><a class="toc-backref" href="#id2981">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fptoui</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-fptoui-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1109">
<h5><a class="toc-backref" href="#id2982">Syntax:</a><a class="headerlink" href="#id1109" 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="o"><</span><span class="n">ty2</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">fptoui</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1110">
<h5><a class="toc-backref" href="#id2983">Overview:</a><a class="headerlink" href="#id1110" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fptoui</span></code>’ intrinsic converts a
floating-point <code class="docutils literal notranslate"><span class="pre">value</span></code> to its unsigned integer equivalent of type <code class="docutils literal notranslate"><span class="pre">ty2</span></code>.</p>
</div>
<div class="section" id="id1111">
<h5><a class="toc-backref" href="#id2984">Arguments:</a><a class="headerlink" href="#id1111" title="Permalink to this headline">¶</a></h5>
<p>The first argument to the ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fptoui</span></code>’
intrinsic must be <a class="reference internal" href="#t-floating"><span class="std std-ref">floating point</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of floating point values.</p>
<p>The second argument specifies the exception behavior as described above.</p>
</div>
<div class="section" id="id1112">
<h5><a class="toc-backref" href="#id2985">Semantics:</a><a class="headerlink" href="#id1112" title="Permalink to this headline">¶</a></h5>
<p>The result produced is an unsigned integer converted from the floating
point operand. The value is truncated, so it is rounded towards zero.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-fptosi-intrinsic">
<h4><a class="toc-backref" href="#id2986">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fptosi</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-fptosi-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1113">
<h5><a class="toc-backref" href="#id2987">Syntax:</a><a class="headerlink" href="#id1113" 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="o"><</span><span class="n">ty2</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">fptosi</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1114">
<h5><a class="toc-backref" href="#id2988">Overview:</a><a class="headerlink" href="#id1114" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fptosi</span></code>’ intrinsic converts
<a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> <code class="docutils literal notranslate"><span class="pre">value</span></code> to type <code class="docutils literal notranslate"><span class="pre">ty2</span></code>.</p>
</div>
<div class="section" id="id1115">
<h5><a class="toc-backref" href="#id2989">Arguments:</a><a class="headerlink" href="#id1115" title="Permalink to this headline">¶</a></h5>
<p>The first argument to the ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fptosi</span></code>’
intrinsic must be <a class="reference internal" href="#t-floating"><span class="std std-ref">floating point</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of floating point values.</p>
<p>The second argument specifies the exception behavior as described above.</p>
</div>
<div class="section" id="id1116">
<h5><a class="toc-backref" href="#id2990">Semantics:</a><a class="headerlink" href="#id1116" title="Permalink to this headline">¶</a></h5>
<p>The result produced is a signed integer converted from the floating
point operand. The value is truncated, so it is rounded towards zero.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-uitofp-intrinsic">
<h4><a class="toc-backref" href="#id2991">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.uitofp</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-uitofp-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1117">
<h5><a class="toc-backref" href="#id2992">Syntax:</a><a class="headerlink" href="#id1117" 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="o"><</span><span class="n">ty2</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">uitofp</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1118">
<h5><a class="toc-backref" href="#id2993">Overview:</a><a class="headerlink" href="#id1118" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.uitofp</span></code>’ intrinsic converts an
unsigned integer <code class="docutils literal notranslate"><span class="pre">value</span></code> to a floating-point of type <code class="docutils literal notranslate"><span class="pre">ty2</span></code>.</p>
</div>
<div class="section" id="id1119">
<h5><a class="toc-backref" href="#id2994">Arguments:</a><a class="headerlink" href="#id1119" title="Permalink to this headline">¶</a></h5>
<p>The first argument to the ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.uitofp</span></code>’
intrinsic must be an <a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of integer values.</p>
<p>The second and third arguments specify the rounding mode and exception
behavior as described above.</p>
</div>
<div class="section" id="id1120">
<h5><a class="toc-backref" href="#id2995">Semantics:</a><a class="headerlink" href="#id1120" title="Permalink to this headline">¶</a></h5>
<p>An inexact floating-point exception will be raised if rounding is required.
Any result produced is a floating point value converted from the input
integer operand.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-sitofp-intrinsic">
<h4><a class="toc-backref" href="#id2996">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.sitofp</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-sitofp-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1121">
<h5><a class="toc-backref" href="#id2997">Syntax:</a><a class="headerlink" href="#id1121" 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="o"><</span><span class="n">ty2</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">sitofp</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1122">
<h5><a class="toc-backref" href="#id2998">Overview:</a><a class="headerlink" href="#id1122" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.sitofp</span></code>’ intrinsic converts a
signed integer <code class="docutils literal notranslate"><span class="pre">value</span></code> to a floating-point of type <code class="docutils literal notranslate"><span class="pre">ty2</span></code>.</p>
</div>
<div class="section" id="id1123">
<h5><a class="toc-backref" href="#id2999">Arguments:</a><a class="headerlink" href="#id1123" title="Permalink to this headline">¶</a></h5>
<p>The first argument to the ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.sitofp</span></code>’
intrinsic must be an <a class="reference internal" href="#t-integer"><span class="std std-ref">integer</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of integer values.</p>
<p>The second and third arguments specify the rounding mode and exception
behavior as described above.</p>
</div>
<div class="section" id="id1124">
<h5><a class="toc-backref" href="#id3000">Semantics:</a><a class="headerlink" href="#id1124" title="Permalink to this headline">¶</a></h5>
<p>An inexact floating-point exception will be raised if rounding is required.
Any result produced is a floating point value converted from the input
integer operand.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-fptrunc-intrinsic">
<h4><a class="toc-backref" href="#id3001">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fptrunc</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-fptrunc-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1125">
<h5><a class="toc-backref" href="#id3002">Syntax:</a><a class="headerlink" href="#id1125" 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="o"><</span><span class="n">ty2</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">fptrunc</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1126">
<h5><a class="toc-backref" href="#id3003">Overview:</a><a class="headerlink" href="#id1126" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fptrunc</span></code>’ intrinsic truncates <code class="docutils literal notranslate"><span class="pre">value</span></code>
to type <code class="docutils literal notranslate"><span class="pre">ty2</span></code>.</p>
</div>
<div class="section" id="id1127">
<h5><a class="toc-backref" href="#id3004">Arguments:</a><a class="headerlink" href="#id1127" title="Permalink to this headline">¶</a></h5>
<p>The first argument to the ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fptrunc</span></code>’
intrinsic must be <a class="reference internal" href="#t-floating"><span class="std std-ref">floating point</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of floating point values. This argument must be larger in size
than the result.</p>
<p>The second and third arguments specify the rounding mode and exception
behavior as described above.</p>
</div>
<div class="section" id="id1128">
<h5><a class="toc-backref" href="#id3005">Semantics:</a><a class="headerlink" href="#id1128" title="Permalink to this headline">¶</a></h5>
<p>The result produced is a floating point value truncated to be smaller in size
than the operand.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-fpext-intrinsic">
<h4><a class="toc-backref" href="#id3006">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fpext</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-fpext-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1129">
<h5><a class="toc-backref" href="#id3007">Syntax:</a><a class="headerlink" href="#id1129" 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="o"><</span><span class="n">ty2</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">fpext</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1130">
<h5><a class="toc-backref" href="#id3008">Overview:</a><a class="headerlink" href="#id1130" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fpext</span></code>’ intrinsic extends a
floating-point <code class="docutils literal notranslate"><span class="pre">value</span></code> to a larger floating-point value.</p>
</div>
<div class="section" id="id1131">
<h5><a class="toc-backref" href="#id3009">Arguments:</a><a class="headerlink" href="#id1131" title="Permalink to this headline">¶</a></h5>
<p>The first argument to the ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fpext</span></code>’
intrinsic must be <a class="reference internal" href="#t-floating"><span class="std std-ref">floating point</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a> of floating point values. This argument must be smaller in size
than the result.</p>
<p>The second argument specifies the exception behavior as described above.</p>
</div>
<div class="section" id="id1132">
<h5><a class="toc-backref" href="#id3010">Semantics:</a><a class="headerlink" href="#id1132" title="Permalink to this headline">¶</a></h5>
<p>The result produced is a floating point value extended to be larger in size
than the operand. All restrictions that apply to the fpext instruction also
apply to this intrinsic.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-fcmp-and-llvm-experimental-constrained-fcmps-intrinsics">
<h4><a class="toc-backref" href="#id3011">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fcmp</span></code>’ and ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fcmps</span></code>’ Intrinsics</a><a class="headerlink" href="#llvm-experimental-constrained-fcmp-and-llvm-experimental-constrained-fcmps-intrinsics" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1133">
<h5><a class="toc-backref" href="#id3012">Syntax:</a><a class="headerlink" href="#id1133" 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="o"><</span><span class="n">ty2</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">fcmp</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op2</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">condition</span> <span class="n">code</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="o"><</span><span class="n">ty2</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">fcmps</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op2</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">condition</span> <span class="n">code</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1134">
<h5><a class="toc-backref" href="#id3013">Overview:</a><a class="headerlink" href="#id1134" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fcmp</span></code>’ and
‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fcmps</span></code>’ intrinsics return a boolean
value or vector of boolean values based on comparison of its operands.</p>
<p>If the operands are floating-point scalars, then the result type is a
boolean (<a class="reference internal" href="#t-integer"><span class="std std-ref">i1</span></a>).</p>
<p>If the operands are floating-point vectors, then the result type is a
vector of boolean with the same number of elements as the operands being
compared.</p>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fcmp</span></code>’ intrinsic performs a quiet
comparison operation while the ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fcmps</span></code>’
intrinsic performs a signaling comparison operation.</p>
</div>
<div class="section" id="id1135">
<h5><a class="toc-backref" href="#id3014">Arguments:</a><a class="headerlink" href="#id1135" title="Permalink to this headline">¶</a></h5>
<p>The first two arguments to the ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fcmp</span></code>’
and ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fcmps</span></code>’ intrinsics must be
<a class="reference internal" href="#t-floating"><span class="std std-ref">floating-point</span></a> or <a class="reference internal" href="#t-vector"><span class="std std-ref">vector</span></a>
of floating-point values. Both arguments must have identical types.</p>
<p>The third argument is the condition code indicating the kind of comparison
to perform. It must be a metadata string with one of the following values:</p>
<ul class="simple">
<li><p>“<code class="docutils literal notranslate"><span class="pre">oeq</span></code>”: ordered and equal</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">ogt</span></code>”: ordered and greater than</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">oge</span></code>”: ordered and greater than or equal</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">olt</span></code>”: ordered and less than</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">ole</span></code>”: ordered and less than or equal</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">one</span></code>”: ordered and not equal</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">ord</span></code>”: ordered (no nans)</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">ueq</span></code>”: unordered or equal</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">ugt</span></code>”: unordered or greater than</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">uge</span></code>”: unordered or greater than or equal</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">ult</span></code>”: unordered or less than</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">ule</span></code>”: unordered or less than or equal</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">une</span></code>”: unordered or not equal</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">uno</span></code>”: unordered (either nans)</p></li>
</ul>
<p><em>Ordered</em> means that neither operand is a NAN while <em>unordered</em> means
that either operand may be a NAN.</p>
<p>The fourth argument specifies the exception behavior as described above.</p>
</div>
<div class="section" id="id1136">
<h5><a class="toc-backref" href="#id3015">Semantics:</a><a class="headerlink" href="#id1136" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">op1</span></code> and <code class="docutils literal notranslate"><span class="pre">op2</span></code> are compared according to the condition code given
as the third argument. If the operands are vectors, then the
vectors are compared element by element. Each comparison performed
always yields an <a class="reference internal" href="#t-integer"><span class="std std-ref">i1</span></a> result, as follows:</p>
<ul class="simple">
<li><p>“<code class="docutils literal notranslate"><span class="pre">oeq</span></code>”: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if both operands are not a NAN and <code class="docutils literal notranslate"><span class="pre">op1</span></code>
is equal to <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">ogt</span></code>”: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if both operands are not a NAN and <code class="docutils literal notranslate"><span class="pre">op1</span></code>
is greater than <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">oge</span></code>”: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if both operands are not a NAN and <code class="docutils literal notranslate"><span class="pre">op1</span></code>
is greater than or equal to <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">olt</span></code>”: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if both operands are not a NAN and <code class="docutils literal notranslate"><span class="pre">op1</span></code>
is less than <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">ole</span></code>”: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if both operands are not a NAN and <code class="docutils literal notranslate"><span class="pre">op1</span></code>
is less than or equal to <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">one</span></code>”: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if both operands are not a NAN and <code class="docutils literal notranslate"><span class="pre">op1</span></code>
is not equal to <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">ord</span></code>”: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if both operands are not a NAN.</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">ueq</span></code>”: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if either operand is a NAN or <code class="docutils literal notranslate"><span class="pre">op1</span></code> is
equal to <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">ugt</span></code>”: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if either operand is a NAN or <code class="docutils literal notranslate"><span class="pre">op1</span></code> is
greater than <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">uge</span></code>”: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if either operand is a NAN or <code class="docutils literal notranslate"><span class="pre">op1</span></code> is
greater than or equal to <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">ult</span></code>”: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if either operand is a NAN or <code class="docutils literal notranslate"><span class="pre">op1</span></code> is
less than <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">ule</span></code>”: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if either operand is a NAN or <code class="docutils literal notranslate"><span class="pre">op1</span></code> is
less than or equal to <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">une</span></code>”: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if either operand is a NAN or <code class="docutils literal notranslate"><span class="pre">op1</span></code> is
not equal to <code class="docutils literal notranslate"><span class="pre">op2</span></code>.</p></li>
<li><p>“<code class="docutils literal notranslate"><span class="pre">uno</span></code>”: yields <code class="docutils literal notranslate"><span class="pre">true</span></code> if either operand is a NAN.</p></li>
</ul>
<p>The quiet comparison operation performed by
‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fcmp</span></code>’ will only raise an exception
if either operand is a SNAN. The signaling comparison operation
performed by ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fcmps</span></code>’ will raise an
exception if either operand is a NAN (QNAN or SNAN). Such an exception
does not preclude a result being produced (e.g. exception might only
set a flag), therefore the distinction between ordered and unordered
comparisons is also relevant for the
‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fcmps</span></code>’ intrinsic.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-fmuladd-intrinsic">
<h4><a class="toc-backref" href="#id3016">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fmuladd</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-fmuladd-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1137">
<h5><a class="toc-backref" href="#id3017">Syntax:</a><a class="headerlink" href="#id1137" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">fmuladd</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op2</span><span class="o">></span><span class="p">,</span>
<span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op3</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1138">
<h5><a class="toc-backref" href="#id3018">Overview:</a><a class="headerlink" href="#id1138" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fmuladd</span></code>’ intrinsic represents
multiply-add expressions that can be fused if the code generator determines
that (a) the target instruction set has support for a fused operation,
and (b) that the fused operation is more efficient than the equivalent,
separate pair of mul and add instructions.</p>
</div>
<div class="section" id="id1139">
<h5><a class="toc-backref" href="#id3019">Arguments:</a><a class="headerlink" href="#id1139" title="Permalink to this headline">¶</a></h5>
<p>The first three arguments to the ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fmuladd</span></code>’
intrinsic must be floating-point or vector of floating-point values.
All three arguments must have identical types.</p>
<p>The fourth and fifth arguments specify the rounding mode and exception behavior
as described above.</p>
</div>
<div class="section" id="id1140">
<h5><a class="toc-backref" href="#id3020">Semantics:</a><a class="headerlink" href="#id1140" title="Permalink to this headline">¶</a></h5>
<p>The expression:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="mi">0</span> <span class="o">=</span> <span class="n">call</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">fmuladd</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span> <span class="o">%</span><span class="n">c</span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<p>is equivalent to the expression:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o">%</span><span class="mi">0</span> <span class="o">=</span> <span class="n">call</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">fmul</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="o">%</span><span class="n">a</span><span class="p">,</span> <span class="o">%</span><span class="n">b</span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
<span class="o">%</span><span class="mi">1</span> <span class="o">=</span> <span class="n">call</span> <span class="nb">float</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">fadd</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="o">%</span><span class="mi">0</span><span class="p">,</span> <span class="o">%</span><span class="n">c</span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
<p>except that it is unspecified whether rounding will be performed between the
multiplication and addition steps. Fusion is not guaranteed, even if the target
platform supports it.
If a fused multiply-add is required, the corresponding
<a class="reference internal" href="#int-fma"><span class="std std-ref">llvm.experimental.constrained.fma</span></a> intrinsic function should be
used instead.
This never sets errno, just as ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.fma.*</span></code>’.</p>
</div>
</div>
</div>
<div class="section" id="constrained-libm-equivalent-intrinsics">
<h3><a class="toc-backref" href="#id3021">Constrained libm-equivalent Intrinsics</a><a class="headerlink" href="#constrained-libm-equivalent-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>In addition to the basic floating-point operations for which constrained
intrinsics are described above, there are constrained versions of various
operations which provide equivalent behavior to a corresponding libm function.
These intrinsics allow the precise behavior of these operations with respect to
rounding mode and exception behavior to be controlled.</p>
<p>As with the basic constrained floating-point intrinsics, the rounding mode
and exception behavior arguments only control the behavior of the optimizer.
They do not change the runtime floating-point environment.</p>
<div class="section" id="llvm-experimental-constrained-sqrt-intrinsic">
<h4><a class="toc-backref" href="#id3022">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.sqrt</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-sqrt-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1141">
<h5><a class="toc-backref" href="#id3023">Syntax:</a><a class="headerlink" href="#id1141" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">sqrt</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1142">
<h5><a class="toc-backref" href="#id3024">Overview:</a><a class="headerlink" href="#id1142" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.sqrt</span></code>’ intrinsic returns the square root
of the specified value, returning the same value as the libm ‘<code class="docutils literal notranslate"><span class="pre">sqrt</span></code>’
functions would, but without setting <code class="docutils literal notranslate"><span class="pre">errno</span></code>.</p>
</div>
<div class="section" id="id1143">
<h5><a class="toc-backref" href="#id3025">Arguments:</a><a class="headerlink" href="#id1143" title="Permalink to this headline">¶</a></h5>
<p>The first argument and the return type are floating-point numbers of the same
type.</p>
<p>The second and third arguments specify the rounding mode and exception
behavior as described above.</p>
</div>
<div class="section" id="id1144">
<h5><a class="toc-backref" href="#id3026">Semantics:</a><a class="headerlink" href="#id1144" title="Permalink to this headline">¶</a></h5>
<p>This function returns the nonnegative square root of the specified value.
If the value is less than negative zero, a floating-point exception occurs
and the return value is architecture specific.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-pow-intrinsic">
<h4><a class="toc-backref" href="#id3027">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.pow</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-pow-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1145">
<h5><a class="toc-backref" href="#id3028">Syntax:</a><a class="headerlink" href="#id1145" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">pow</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op2</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1146">
<h5><a class="toc-backref" href="#id3029">Overview:</a><a class="headerlink" href="#id1146" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.pow</span></code>’ intrinsic returns the first operand
raised to the (positive or negative) power specified by the second operand.</p>
</div>
<div class="section" id="id1147">
<h5><a class="toc-backref" href="#id3030">Arguments:</a><a class="headerlink" href="#id1147" title="Permalink to this headline">¶</a></h5>
<p>The first two arguments and the return value are floating-point numbers of the
same type. The second argument specifies the power to which the first argument
should be raised.</p>
<p>The third and fourth arguments specify the rounding mode and exception
behavior as described above.</p>
</div>
<div class="section" id="id1148">
<h5><a class="toc-backref" href="#id3031">Semantics:</a><a class="headerlink" href="#id1148" title="Permalink to this headline">¶</a></h5>
<p>This function returns the first value raised to the second power,
returning the same values as the libm <code class="docutils literal notranslate"><span class="pre">pow</span></code> functions would, and
handles error conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-powi-intrinsic">
<h4><a class="toc-backref" href="#id3032">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.powi</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-powi-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1149">
<h5><a class="toc-backref" href="#id3033">Syntax:</a><a class="headerlink" href="#id1149" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">powi</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">op2</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1150">
<h5><a class="toc-backref" href="#id3034">Overview:</a><a class="headerlink" href="#id1150" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.powi</span></code>’ intrinsic returns the first operand
raised to the (positive or negative) power specified by the second operand. The
order of evaluation of multiplications is not defined. When a vector of
floating-point type is used, the second argument remains a scalar integer value.</p>
</div>
<div class="section" id="id1151">
<h5><a class="toc-backref" href="#id3035">Arguments:</a><a class="headerlink" href="#id1151" title="Permalink to this headline">¶</a></h5>
<p>The first argument and the return value are floating-point numbers of the same
type. The second argument is a 32-bit signed integer specifying the power to
which the first argument should be raised.</p>
<p>The third and fourth arguments specify the rounding mode and exception
behavior as described above.</p>
</div>
<div class="section" id="id1152">
<h5><a class="toc-backref" href="#id3036">Semantics:</a><a class="headerlink" href="#id1152" title="Permalink to this headline">¶</a></h5>
<p>This function returns the first value raised to the second power with an
unspecified sequence of rounding operations.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-sin-intrinsic">
<h4><a class="toc-backref" href="#id3037">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.sin</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-sin-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1153">
<h5><a class="toc-backref" href="#id3038">Syntax:</a><a class="headerlink" href="#id1153" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">sin</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1154">
<h5><a class="toc-backref" href="#id3039">Overview:</a><a class="headerlink" href="#id1154" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.sin</span></code>’ intrinsic returns the sine of the
first operand.</p>
</div>
<div class="section" id="id1155">
<h5><a class="toc-backref" href="#id3040">Arguments:</a><a class="headerlink" href="#id1155" title="Permalink to this headline">¶</a></h5>
<p>The first argument and the return type are floating-point numbers of the same
type.</p>
<p>The second and third arguments specify the rounding mode and exception
behavior as described above.</p>
</div>
<div class="section" id="id1156">
<h5><a class="toc-backref" href="#id3041">Semantics:</a><a class="headerlink" href="#id1156" title="Permalink to this headline">¶</a></h5>
<p>This function returns the sine of the specified operand, returning the
same values as the libm <code class="docutils literal notranslate"><span class="pre">sin</span></code> functions would, and handles error
conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-cos-intrinsic">
<h4><a class="toc-backref" href="#id3042">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.cos</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-cos-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1157">
<h5><a class="toc-backref" href="#id3043">Syntax:</a><a class="headerlink" href="#id1157" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">cos</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1158">
<h5><a class="toc-backref" href="#id3044">Overview:</a><a class="headerlink" href="#id1158" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.cos</span></code>’ intrinsic returns the cosine of the
first operand.</p>
</div>
<div class="section" id="id1159">
<h5><a class="toc-backref" href="#id3045">Arguments:</a><a class="headerlink" href="#id1159" title="Permalink to this headline">¶</a></h5>
<p>The first argument and the return type are floating-point numbers of the same
type.</p>
<p>The second and third arguments specify the rounding mode and exception
behavior as described above.</p>
</div>
<div class="section" id="id1160">
<h5><a class="toc-backref" href="#id3046">Semantics:</a><a class="headerlink" href="#id1160" title="Permalink to this headline">¶</a></h5>
<p>This function returns the cosine of the specified operand, returning the
same values as the libm <code class="docutils literal notranslate"><span class="pre">cos</span></code> functions would, and handles error
conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-exp-intrinsic">
<h4><a class="toc-backref" href="#id3047">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.exp</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-exp-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1161">
<h5><a class="toc-backref" href="#id3048">Syntax:</a><a class="headerlink" href="#id1161" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">exp</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1162">
<h5><a class="toc-backref" href="#id3049">Overview:</a><a class="headerlink" href="#id1162" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.exp</span></code>’ intrinsic computes the base-e
exponential of the specified value.</p>
</div>
<div class="section" id="id1163">
<h5><a class="toc-backref" href="#id3050">Arguments:</a><a class="headerlink" href="#id1163" title="Permalink to this headline">¶</a></h5>
<p>The first argument and the return value are floating-point numbers of the same
type.</p>
<p>The second and third arguments specify the rounding mode and exception
behavior as described above.</p>
</div>
<div class="section" id="id1164">
<h5><a class="toc-backref" href="#id3051">Semantics:</a><a class="headerlink" href="#id1164" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">exp</span></code> functions
would, and handles error conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-exp2-intrinsic">
<h4><a class="toc-backref" href="#id3052">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.exp2</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-exp2-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1165">
<h5><a class="toc-backref" href="#id3053">Syntax:</a><a class="headerlink" href="#id1165" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">exp2</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1166">
<h5><a class="toc-backref" href="#id3054">Overview:</a><a class="headerlink" href="#id1166" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.exp2</span></code>’ intrinsic computes the base-2
exponential of the specified value.</p>
</div>
<div class="section" id="id1167">
<h5><a class="toc-backref" href="#id3055">Arguments:</a><a class="headerlink" href="#id1167" title="Permalink to this headline">¶</a></h5>
<p>The first argument and the return value are floating-point numbers of the same
type.</p>
<p>The second and third arguments specify the rounding mode and exception
behavior as described above.</p>
</div>
<div class="section" id="id1168">
<h5><a class="toc-backref" href="#id3056">Semantics:</a><a class="headerlink" href="#id1168" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">exp2</span></code> functions
would, and handles error conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-log-intrinsic">
<h4><a class="toc-backref" href="#id3057">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.log</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-log-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1169">
<h5><a class="toc-backref" href="#id3058">Syntax:</a><a class="headerlink" href="#id1169" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">log</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1170">
<h5><a class="toc-backref" href="#id3059">Overview:</a><a class="headerlink" href="#id1170" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.log</span></code>’ intrinsic computes the base-e
logarithm of the specified value.</p>
</div>
<div class="section" id="id1171">
<h5><a class="toc-backref" href="#id3060">Arguments:</a><a class="headerlink" href="#id1171" title="Permalink to this headline">¶</a></h5>
<p>The first argument and the return value are floating-point numbers of the same
type.</p>
<p>The second and third arguments specify the rounding mode and exception
behavior as described above.</p>
</div>
<div class="section" id="id1172">
<h5><a class="toc-backref" href="#id3061">Semantics:</a><a class="headerlink" href="#id1172" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">log</span></code> functions
would, and handles error conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-log10-intrinsic">
<h4><a class="toc-backref" href="#id3062">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.log10</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-log10-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1173">
<h5><a class="toc-backref" href="#id3063">Syntax:</a><a class="headerlink" href="#id1173" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">log10</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1174">
<h5><a class="toc-backref" href="#id3064">Overview:</a><a class="headerlink" href="#id1174" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.log10</span></code>’ intrinsic computes the base-10
logarithm of the specified value.</p>
</div>
<div class="section" id="id1175">
<h5><a class="toc-backref" href="#id3065">Arguments:</a><a class="headerlink" href="#id1175" title="Permalink to this headline">¶</a></h5>
<p>The first argument and the return value are floating-point numbers of the same
type.</p>
<p>The second and third arguments specify the rounding mode and exception
behavior as described above.</p>
</div>
<div class="section" id="id1176">
<h5><a class="toc-backref" href="#id3066">Semantics:</a><a class="headerlink" href="#id1176" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">log10</span></code> functions
would, and handles error conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-log2-intrinsic">
<h4><a class="toc-backref" href="#id3067">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.log2</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-log2-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1177">
<h5><a class="toc-backref" href="#id3068">Syntax:</a><a class="headerlink" href="#id1177" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">log2</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1178">
<h5><a class="toc-backref" href="#id3069">Overview:</a><a class="headerlink" href="#id1178" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.log2</span></code>’ intrinsic computes the base-2
logarithm of the specified value.</p>
</div>
<div class="section" id="id1179">
<h5><a class="toc-backref" href="#id3070">Arguments:</a><a class="headerlink" href="#id1179" title="Permalink to this headline">¶</a></h5>
<p>The first argument and the return value are floating-point numbers of the same
type.</p>
<p>The second and third arguments specify the rounding mode and exception
behavior as described above.</p>
</div>
<div class="section" id="id1180">
<h5><a class="toc-backref" href="#id3071">Semantics:</a><a class="headerlink" href="#id1180" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">log2</span></code> functions
would, and handles error conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-rint-intrinsic">
<h4><a class="toc-backref" href="#id3072">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.rint</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-rint-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1181">
<h5><a class="toc-backref" href="#id3073">Syntax:</a><a class="headerlink" href="#id1181" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">rint</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1182">
<h5><a class="toc-backref" href="#id3074">Overview:</a><a class="headerlink" href="#id1182" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.rint</span></code>’ intrinsic returns the first
operand rounded to the nearest integer. It may raise an inexact floating-point
exception if the operand is not an integer.</p>
</div>
<div class="section" id="id1183">
<h5><a class="toc-backref" href="#id3075">Arguments:</a><a class="headerlink" href="#id1183" title="Permalink to this headline">¶</a></h5>
<p>The first argument and the return value are floating-point numbers of the same
type.</p>
<p>The second and third arguments specify the rounding mode and exception
behavior as described above.</p>
</div>
<div class="section" id="id1184">
<h5><a class="toc-backref" href="#id3076">Semantics:</a><a class="headerlink" href="#id1184" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">rint</span></code> functions
would, and handles error conditions in the same way. The rounding mode is
described, not determined, by the rounding mode argument. The actual rounding
mode is determined by the runtime floating-point environment. The rounding
mode argument is only intended as information to the compiler.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-lrint-intrinsic">
<h4><a class="toc-backref" href="#id3077">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.lrint</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-lrint-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1185">
<h5><a class="toc-backref" href="#id3078">Syntax:</a><a class="headerlink" href="#id1185" 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="o"><</span><span class="n">inttype</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">lrint</span><span class="p">(</span><span class="o"><</span><span class="n">fptype</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1186">
<h5><a class="toc-backref" href="#id3079">Overview:</a><a class="headerlink" href="#id1186" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.lrint</span></code>’ intrinsic returns the first
operand rounded to the nearest integer. An inexact floating-point exception
will be raised if the operand is not an integer. An invalid exception is
raised if the result is too large to fit into a supported integer type,
and in this case the result is undefined.</p>
</div>
<div class="section" id="id1187">
<h5><a class="toc-backref" href="#id3080">Arguments:</a><a class="headerlink" href="#id1187" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a floating-point number. The return value is an
integer type. Not all types are supported on all targets. The supported
types are the same as the <code class="docutils literal notranslate"><span class="pre">llvm.lrint</span></code> intrinsic and the <code class="docutils literal notranslate"><span class="pre">lrint</span></code>
libm functions.</p>
<p>The second and third arguments specify the rounding mode and exception
behavior as described above.</p>
</div>
<div class="section" id="id1188">
<h5><a class="toc-backref" href="#id3081">Semantics:</a><a class="headerlink" href="#id1188" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">lrint</span></code> functions
would, and handles error conditions in the same way.</p>
<p>The rounding mode is described, not determined, by the rounding mode
argument. The actual rounding mode is determined by the runtime floating-point
environment. The rounding mode argument is only intended as information
to the compiler.</p>
<p>If the runtime floating-point environment is using the default rounding mode
then the results will be the same as the llvm.lrint intrinsic.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-llrint-intrinsic">
<h4><a class="toc-backref" href="#id3082">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.llrint</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-llrint-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1189">
<h5><a class="toc-backref" href="#id3083">Syntax:</a><a class="headerlink" href="#id1189" 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="o"><</span><span class="n">inttype</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">llrint</span><span class="p">(</span><span class="o"><</span><span class="n">fptype</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1190">
<h5><a class="toc-backref" href="#id3084">Overview:</a><a class="headerlink" href="#id1190" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.llrint</span></code>’ intrinsic returns the first
operand rounded to the nearest integer. An inexact floating-point exception
will be raised if the operand is not an integer. An invalid exception is
raised if the result is too large to fit into a supported integer type,
and in this case the result is undefined.</p>
</div>
<div class="section" id="id1191">
<h5><a class="toc-backref" href="#id3085">Arguments:</a><a class="headerlink" href="#id1191" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a floating-point number. The return value is an
integer type. Not all types are supported on all targets. The supported
types are the same as the <code class="docutils literal notranslate"><span class="pre">llvm.llrint</span></code> intrinsic and the <code class="docutils literal notranslate"><span class="pre">llrint</span></code>
libm functions.</p>
<p>The second and third arguments specify the rounding mode and exception
behavior as described above.</p>
</div>
<div class="section" id="id1192">
<h5><a class="toc-backref" href="#id3086">Semantics:</a><a class="headerlink" href="#id1192" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">llrint</span></code> functions
would, and handles error conditions in the same way.</p>
<p>The rounding mode is described, not determined, by the rounding mode
argument. The actual rounding mode is determined by the runtime floating-point
environment. The rounding mode argument is only intended as information
to the compiler.</p>
<p>If the runtime floating-point environment is using the default rounding mode
then the results will be the same as the llvm.llrint intrinsic.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-nearbyint-intrinsic">
<h4><a class="toc-backref" href="#id3087">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.nearbyint</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-nearbyint-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1193">
<h5><a class="toc-backref" href="#id3088">Syntax:</a><a class="headerlink" href="#id1193" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">nearbyint</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">rounding</span> <span class="n">mode</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1194">
<h5><a class="toc-backref" href="#id3089">Overview:</a><a class="headerlink" href="#id1194" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.nearbyint</span></code>’ intrinsic returns the first
operand rounded to the nearest integer. It will not raise an inexact
floating-point exception if the operand is not an integer.</p>
</div>
<div class="section" id="id1195">
<h5><a class="toc-backref" href="#id3090">Arguments:</a><a class="headerlink" href="#id1195" title="Permalink to this headline">¶</a></h5>
<p>The first argument and the return value are floating-point numbers of the same
type.</p>
<p>The second and third arguments specify the rounding mode and exception
behavior as described above.</p>
</div>
<div class="section" id="id1196">
<h5><a class="toc-backref" href="#id3091">Semantics:</a><a class="headerlink" href="#id1196" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">nearbyint</span></code> functions
would, and handles error conditions in the same way. The rounding mode is
described, not determined, by the rounding mode argument. The actual rounding
mode is determined by the runtime floating-point environment. The rounding
mode argument is only intended as information to the compiler.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-maxnum-intrinsic">
<h4><a class="toc-backref" href="#id3092">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.maxnum</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-maxnum-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1197">
<h5><a class="toc-backref" href="#id3093">Syntax:</a><a class="headerlink" href="#id1197" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">maxnum</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op2</span><span class="o">></span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1198">
<h5><a class="toc-backref" href="#id3094">Overview:</a><a class="headerlink" href="#id1198" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.maxnum</span></code>’ intrinsic returns the maximum
of the two arguments.</p>
</div>
<div class="section" id="id1199">
<h5><a class="toc-backref" href="#id3095">Arguments:</a><a class="headerlink" href="#id1199" title="Permalink to this headline">¶</a></h5>
<p>The first two arguments and the return value are floating-point numbers
of the same type.</p>
<p>The third argument specifies the exception behavior as described above.</p>
</div>
<div class="section" id="id1200">
<h5><a class="toc-backref" href="#id3096">Semantics:</a><a class="headerlink" href="#id1200" title="Permalink to this headline">¶</a></h5>
<p>This function follows the IEEE-754 semantics for maxNum.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-minnum-intrinsic">
<h4><a class="toc-backref" href="#id3097">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.minnum</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-minnum-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1201">
<h5><a class="toc-backref" href="#id3098">Syntax:</a><a class="headerlink" href="#id1201" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">minnum</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op2</span><span class="o">></span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1202">
<h5><a class="toc-backref" href="#id3099">Overview:</a><a class="headerlink" href="#id1202" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.minnum</span></code>’ intrinsic returns the minimum
of the two arguments.</p>
</div>
<div class="section" id="id1203">
<h5><a class="toc-backref" href="#id3100">Arguments:</a><a class="headerlink" href="#id1203" title="Permalink to this headline">¶</a></h5>
<p>The first two arguments and the return value are floating-point numbers
of the same type.</p>
<p>The third argument specifies the exception behavior as described above.</p>
</div>
<div class="section" id="id1204">
<h5><a class="toc-backref" href="#id3101">Semantics:</a><a class="headerlink" href="#id1204" title="Permalink to this headline">¶</a></h5>
<p>This function follows the IEEE-754 semantics for minNum.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-maximum-intrinsic">
<h4><a class="toc-backref" href="#id3102">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.maximum</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-maximum-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1205">
<h5><a class="toc-backref" href="#id3103">Syntax:</a><a class="headerlink" href="#id1205" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">maximum</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op2</span><span class="o">></span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1206">
<h5><a class="toc-backref" href="#id3104">Overview:</a><a class="headerlink" href="#id1206" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.maximum</span></code>’ intrinsic returns the maximum
of the two arguments, propagating NaNs and treating -0.0 as less than +0.0.</p>
</div>
<div class="section" id="id1207">
<h5><a class="toc-backref" href="#id3105">Arguments:</a><a class="headerlink" href="#id1207" title="Permalink to this headline">¶</a></h5>
<p>The first two arguments and the return value are floating-point numbers
of the same type.</p>
<p>The third argument specifies the exception behavior as described above.</p>
</div>
<div class="section" id="id1208">
<h5><a class="toc-backref" href="#id3106">Semantics:</a><a class="headerlink" href="#id1208" title="Permalink to this headline">¶</a></h5>
<p>This function follows semantics specified in the draft of IEEE 754-2018.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-minimum-intrinsic">
<h4><a class="toc-backref" href="#id3107">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.minimum</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-minimum-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1209">
<h5><a class="toc-backref" href="#id3108">Syntax:</a><a class="headerlink" href="#id1209" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">minimum</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span> <span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op2</span><span class="o">></span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1210">
<h5><a class="toc-backref" href="#id3109">Overview:</a><a class="headerlink" href="#id1210" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.minimum</span></code>’ intrinsic returns the minimum
of the two arguments, propagating NaNs and treating -0.0 as less than +0.0.</p>
</div>
<div class="section" id="id1211">
<h5><a class="toc-backref" href="#id3110">Arguments:</a><a class="headerlink" href="#id1211" title="Permalink to this headline">¶</a></h5>
<p>The first two arguments and the return value are floating-point numbers
of the same type.</p>
<p>The third argument specifies the exception behavior as described above.</p>
</div>
<div class="section" id="id1212">
<h5><a class="toc-backref" href="#id3111">Semantics:</a><a class="headerlink" href="#id1212" title="Permalink to this headline">¶</a></h5>
<p>This function follows semantics specified in the draft of IEEE 754-2018.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-ceil-intrinsic">
<h4><a class="toc-backref" href="#id3112">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.ceil</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-ceil-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1213">
<h5><a class="toc-backref" href="#id3113">Syntax:</a><a class="headerlink" href="#id1213" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">ceil</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1214">
<h5><a class="toc-backref" href="#id3114">Overview:</a><a class="headerlink" href="#id1214" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.ceil</span></code>’ intrinsic returns the ceiling of the
first operand.</p>
</div>
<div class="section" id="id1215">
<h5><a class="toc-backref" href="#id3115">Arguments:</a><a class="headerlink" href="#id1215" title="Permalink to this headline">¶</a></h5>
<p>The first argument and the return value are floating-point numbers of the same
type.</p>
<p>The second argument specifies the exception behavior as described above.</p>
</div>
<div class="section" id="id1216">
<h5><a class="toc-backref" href="#id3116">Semantics:</a><a class="headerlink" href="#id1216" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">ceil</span></code> functions
would and handles error conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-floor-intrinsic">
<h4><a class="toc-backref" href="#id3117">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.floor</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-floor-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1217">
<h5><a class="toc-backref" href="#id3118">Syntax:</a><a class="headerlink" href="#id1217" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">floor</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1218">
<h5><a class="toc-backref" href="#id3119">Overview:</a><a class="headerlink" href="#id1218" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.floor</span></code>’ intrinsic returns the floor of the
first operand.</p>
</div>
<div class="section" id="id1219">
<h5><a class="toc-backref" href="#id3120">Arguments:</a><a class="headerlink" href="#id1219" title="Permalink to this headline">¶</a></h5>
<p>The first argument and the return value are floating-point numbers of the same
type.</p>
<p>The second argument specifies the exception behavior as described above.</p>
</div>
<div class="section" id="id1220">
<h5><a class="toc-backref" href="#id3121">Semantics:</a><a class="headerlink" href="#id1220" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">floor</span></code> functions
would and handles error conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-round-intrinsic">
<h4><a class="toc-backref" href="#id3122">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.round</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-round-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1221">
<h5><a class="toc-backref" href="#id3123">Syntax:</a><a class="headerlink" href="#id1221" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">round</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1222">
<h5><a class="toc-backref" href="#id3124">Overview:</a><a class="headerlink" href="#id1222" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.round</span></code>’ intrinsic returns the first
operand rounded to the nearest integer.</p>
</div>
<div class="section" id="id1223">
<h5><a class="toc-backref" href="#id3125">Arguments:</a><a class="headerlink" href="#id1223" title="Permalink to this headline">¶</a></h5>
<p>The first argument and the return value are floating-point numbers of the same
type.</p>
<p>The second argument specifies the exception behavior as described above.</p>
</div>
<div class="section" id="id1224">
<h5><a class="toc-backref" href="#id3126">Semantics:</a><a class="headerlink" href="#id1224" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">round</span></code> functions
would and handles error conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-roundeven-intrinsic">
<h4><a class="toc-backref" href="#id3127">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.roundeven</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-roundeven-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1225">
<h5><a class="toc-backref" href="#id3128">Syntax:</a><a class="headerlink" href="#id1225" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">roundeven</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1226">
<h5><a class="toc-backref" href="#id3129">Overview:</a><a class="headerlink" href="#id1226" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.roundeven</span></code>’ intrinsic returns the first
operand rounded to the nearest integer in floating-point format, rounding
halfway cases to even (that is, to the nearest value that is an even integer),
regardless of the current rounding direction.</p>
</div>
<div class="section" id="id1227">
<h5><a class="toc-backref" href="#id3130">Arguments:</a><a class="headerlink" href="#id1227" title="Permalink to this headline">¶</a></h5>
<p>The first argument and the return value are floating-point numbers of the same
type.</p>
<p>The second argument specifies the exception behavior as described above.</p>
</div>
<div class="section" id="id1228">
<h5><a class="toc-backref" href="#id3131">Semantics:</a><a class="headerlink" href="#id1228" title="Permalink to this headline">¶</a></h5>
<p>This function implements IEEE-754 operation <code class="docutils literal notranslate"><span class="pre">roundToIntegralTiesToEven</span></code>. It
also behaves in the same way as C standard function <code class="docutils literal notranslate"><span class="pre">roundeven</span></code> and can signal
the invalid operation exception for a SNAN operand.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-lround-intrinsic">
<h4><a class="toc-backref" href="#id3132">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.lround</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-lround-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1229">
<h5><a class="toc-backref" href="#id3133">Syntax:</a><a class="headerlink" href="#id1229" 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="o"><</span><span class="n">inttype</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">lround</span><span class="p">(</span><span class="o"><</span><span class="n">fptype</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1230">
<h5><a class="toc-backref" href="#id3134">Overview:</a><a class="headerlink" href="#id1230" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.lround</span></code>’ intrinsic returns the first
operand rounded to the nearest integer with ties away from zero. It will
raise an inexact floating-point exception if the operand is not an integer.
An invalid exception is raised if the result is too large to fit into a
supported integer type, and in this case the result is undefined.</p>
</div>
<div class="section" id="id1231">
<h5><a class="toc-backref" href="#id3135">Arguments:</a><a class="headerlink" href="#id1231" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a floating-point number. The return value is an
integer type. Not all types are supported on all targets. The supported
types are the same as the <code class="docutils literal notranslate"><span class="pre">llvm.lround</span></code> intrinsic and the <code class="docutils literal notranslate"><span class="pre">lround</span></code>
libm functions.</p>
<p>The second argument specifies the exception behavior as described above.</p>
</div>
<div class="section" id="id1232">
<h5><a class="toc-backref" href="#id3136">Semantics:</a><a class="headerlink" href="#id1232" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">lround</span></code> functions
would and handles error conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-llround-intrinsic">
<h4><a class="toc-backref" href="#id3137">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.llround</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-llround-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1233">
<h5><a class="toc-backref" href="#id3138">Syntax:</a><a class="headerlink" href="#id1233" 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="o"><</span><span class="n">inttype</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">llround</span><span class="p">(</span><span class="o"><</span><span class="n">fptype</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1234">
<h5><a class="toc-backref" href="#id3139">Overview:</a><a class="headerlink" href="#id1234" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.llround</span></code>’ intrinsic returns the first
operand rounded to the nearest integer with ties away from zero. It will
raise an inexact floating-point exception if the operand is not an integer.
An invalid exception is raised if the result is too large to fit into a
supported integer type, and in this case the result is undefined.</p>
</div>
<div class="section" id="id1235">
<h5><a class="toc-backref" href="#id3140">Arguments:</a><a class="headerlink" href="#id1235" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a floating-point number. The return value is an
integer type. Not all types are supported on all targets. The supported
types are the same as the <code class="docutils literal notranslate"><span class="pre">llvm.llround</span></code> intrinsic and the <code class="docutils literal notranslate"><span class="pre">llround</span></code>
libm functions.</p>
<p>The second argument specifies the exception behavior as described above.</p>
</div>
<div class="section" id="id1236">
<h5><a class="toc-backref" href="#id3141">Semantics:</a><a class="headerlink" href="#id1236" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">llround</span></code> functions
would and handles error conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-experimental-constrained-trunc-intrinsic">
<h4><a class="toc-backref" href="#id3142">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.trunc</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-constrained-trunc-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1237">
<h5><a class="toc-backref" href="#id3143">Syntax:</a><a class="headerlink" href="#id1237" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">constrained</span><span class="o">.</span><span class="n">trunc</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op1</span><span class="o">></span><span class="p">,</span>
<span class="n">metadata</span> <span class="o"><</span><span class="n">exception</span> <span class="n">behavior</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1238">
<h5><a class="toc-backref" href="#id3144">Overview:</a><a class="headerlink" href="#id1238" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.constrained.trunc</span></code>’ intrinsic returns the first
operand rounded to the nearest integer not larger in magnitude than the
operand.</p>
</div>
<div class="section" id="id1239">
<h5><a class="toc-backref" href="#id3145">Arguments:</a><a class="headerlink" href="#id1239" title="Permalink to this headline">¶</a></h5>
<p>The first argument and the return value are floating-point numbers of the same
type.</p>
<p>The second argument specifies the exception behavior as described above.</p>
</div>
<div class="section" id="id1240">
<h5><a class="toc-backref" href="#id3146">Semantics:</a><a class="headerlink" href="#id1240" title="Permalink to this headline">¶</a></h5>
<p>This function returns the same values as the libm <code class="docutils literal notranslate"><span class="pre">trunc</span></code> functions
would and handles error conditions in the same way.</p>
</div>
</div>
<div class="section" id="llvm-experimental-noalias-scope-decl-intrinsic">
<span id="int-experimental-noalias-scope-decl"></span><h4><a class="toc-backref" href="#id3147">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.noalias.scope.decl</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-noalias-scope-decl-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1241">
<h5><a class="toc-backref" href="#id3148">Syntax:</a><a class="headerlink" href="#id1241" title="Permalink to this headline">¶</a></h5>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span>declare void @llvm.experimental.noalias.scope.decl(metadata !id.scope.list)
</pre></div>
</div>
</div>
<div class="section" id="id1242">
<h5><a class="toc-backref" href="#id3149">Overview:</a><a class="headerlink" href="#id1242" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.experimental.noalias.scope.decl</span></code> intrinsic identifies where a
noalias scope is declared. When the intrinsic is duplicated, a decision must
also be made about the scope: depending on the reason of the duplication,
the scope might need to be duplicated as well.</p>
</div>
<div class="section" id="id1243">
<h5><a class="toc-backref" href="#id3150">Arguments:</a><a class="headerlink" href="#id1243" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">!id.scope.list</span></code> argument is metadata that is a list of <code class="docutils literal notranslate"><span class="pre">noalias</span></code>
metadata references. The format is identical to that required for <code class="docutils literal notranslate"><span class="pre">noalias</span></code>
metadata. This list must have exactly one element.</p>
</div>
<div class="section" id="id1244">
<h5><a class="toc-backref" href="#id3151">Semantics:</a><a class="headerlink" href="#id1244" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.experimental.noalias.scope.decl</span></code> intrinsic identifies where a
noalias scope is declared. When the intrinsic is duplicated, a decision must
also be made about the scope: depending on the reason of the duplication,
the scope might need to be duplicated as well.</p>
<p>For example, when the intrinsic is used inside a loop body, and that loop is
unrolled, the associated noalias scope must also be duplicated. Otherwise, the
noalias property it signifies would spill across loop iterations, whereas it
was only valid within a single iteration.</p>
<div class="highlight-llvm notranslate"><div class="highlight"><pre><span></span><span class="c">; This examples shows two possible positions for noalias.decl and how they impact the semantics:</span>
<span class="c">; If it is outside the loop (Version 1), then %a and %b are noalias across *all* iterations.</span>
<span class="c">; If it is inside the loop (Version 2), then %a and %b are noalias only within *one* iteration.</span>
<span class="k">declare</span> <span class="k">void</span> <span class="vg">@decl_in_loop</span><span class="p">(</span><span class="k">i8</span><span class="p">*</span> <span class="nv">%a.base</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%b.base</span><span class="p">)</span> <span class="p">{</span>
<span class="nl">entry:</span>
<span class="c">; call void @llvm.experimental.noalias.scope.decl(metadata !2) ; Version 1: noalias decl outside loop</span>
<span class="k">br</span> <span class="k">label</span> <span class="nv">%loop</span>
<span class="nl">loop:</span>
<span class="nv">%a</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="nv">%a.base</span><span class="p">,</span> <span class="nv">%entry</span> <span class="p">],</span> <span class="p">[</span> <span class="nv">%a.inc</span><span class="p">,</span> <span class="nv">%loop</span> <span class="p">]</span>
<span class="nv">%b</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="nv">%b.base</span><span class="p">,</span> <span class="nv">%entry</span> <span class="p">],</span> <span class="p">[</span> <span class="nv">%b.inc</span><span class="p">,</span> <span class="nv">%loop</span> <span class="p">]</span>
<span class="c">; call void @llvm.experimental.noalias.scope.decl(metadata !2) ; Version 2: noalias decl inside loop</span>
<span class="nv">%val</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">%a</span><span class="p">,</span> <span class="nv">!alias.scope</span> <span class="nv nv-Anonymous">!2</span>
<span class="k">store</span> <span class="k">i8</span> <span class="nv">%val</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%b</span><span class="p">,</span> <span class="nv">!noalias</span> <span class="nv nv-Anonymous">!2</span>
<span class="nv">%a.inc</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="k">inbounds</span> <span class="k">i8</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%a</span><span class="p">,</span> <span class="k">i64</span> <span class="m">1</span>
<span class="nv">%b.inc</span> <span class="p">=</span> <span class="k">getelementptr</span> <span class="k">inbounds</span> <span class="k">i8</span><span class="p">,</span> <span class="k">i8</span><span class="p">*</span> <span class="nv">%b</span><span class="p">,</span> <span class="k">i64</span> <span class="m">1</span>
<span class="nv">%cond</span> <span class="p">=</span> <span class="k">call</span> <span class="k">i1</span> <span class="vg">@cond</span><span class="p">()</span>
<span class="k">br</span> <span class="k">i1</span> <span class="nv">%cond</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%loop</span><span class="p">,</span> <span class="k">label</span> <span class="nv">%exit</span>
<span class="nl">exit:</span>
<span class="k">ret</span> <span class="k">void</span>
<span class="p">}</span>
<span class="nv nv-Anonymous">!0</span> <span class="p">=</span> <span class="p">!{</span><span class="nv nv-Anonymous">!0</span><span class="p">}</span> <span class="c">; domain</span>
<span class="nv nv-Anonymous">!1</span> <span class="p">=</span> <span class="p">!{</span><span class="nv nv-Anonymous">!1</span><span class="p">,</span> <span class="nv nv-Anonymous">!0</span><span class="p">}</span> <span class="c">; scope</span>
<span class="nv nv-Anonymous">!2</span> <span class="p">=</span> <span class="p">!{</span><span class="nv nv-Anonymous">!1</span><span class="p">}</span> <span class="c">; scope list</span>
</pre></div>
</div>
<p>Multiple calls to <cite>@llvm.experimental.noalias.scope.decl</cite> for the same scope
are possible, but one should never dominate another. Violations are pointed out
by the verifier as they indicate a problem in either a transformation pass or
the input.</p>
</div>
</div>
</div>
<div class="section" id="floating-point-environment-manipulation-intrinsics">
<h3><a class="toc-backref" href="#id3152">Floating Point Environment Manipulation intrinsics</a><a class="headerlink" href="#floating-point-environment-manipulation-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>These functions read or write floating point environment, such as rounding
mode or state of floating point exceptions. Altering the floating point
environment requires special care. See <a class="reference internal" href="#floatenv"><span class="std std-ref">Floating Point Environment</span></a>.</p>
<div class="section" id="llvm-flt-rounds-intrinsic">
<h4><a class="toc-backref" href="#id3153">‘<code class="docutils literal notranslate"><span class="pre">llvm.flt.rounds</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-flt-rounds-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1245">
<h5><a class="toc-backref" href="#id3154">Syntax:</a><a class="headerlink" href="#id1245" 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">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">flt</span><span class="o">.</span><span class="n">rounds</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="id1246">
<h5><a class="toc-backref" href="#id3155">Overview:</a><a class="headerlink" href="#id1246" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.flt.rounds</span></code>’ intrinsic reads the current rounding mode.</p>
</div>
<div class="section" id="id1247">
<h5><a class="toc-backref" href="#id3156">Semantics:</a><a class="headerlink" href="#id1247" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.flt.rounds</span></code>’ intrinsic returns the current rounding mode.
Encoding of the returned values is same as the result of <code class="docutils literal notranslate"><span class="pre">FLT_ROUNDS</span></code>,
specified by C standard:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="mi">0</span> <span class="o">-</span> <span class="n">toward</span> <span class="n">zero</span>
<span class="mi">1</span> <span class="o">-</span> <span class="n">to</span> <span class="n">nearest</span><span class="p">,</span> <span class="n">ties</span> <span class="n">to</span> <span class="n">even</span>
<span class="mi">2</span> <span class="o">-</span> <span class="n">toward</span> <span class="n">positive</span> <span class="n">infinity</span>
<span class="mi">3</span> <span class="o">-</span> <span class="n">toward</span> <span class="n">negative</span> <span class="n">infinity</span>
<span class="mi">4</span> <span class="o">-</span> <span class="n">to</span> <span class="n">nearest</span><span class="p">,</span> <span class="n">ties</span> <span class="n">away</span> <span class="kn">from</span> <span class="nn">zero</span>
</pre></div>
</div>
<p>Other values may be used to represent additional rounding modes, supported by a
target. These values are target-specific.</p>
</div>
</div>
<div class="section" id="llvm-set-rounding-intrinsic">
<h4><a class="toc-backref" href="#id3157">‘<code class="docutils literal notranslate"><span class="pre">llvm.set.rounding</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-set-rounding-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1248">
<h5><a class="toc-backref" href="#id3158">Syntax:</a><a class="headerlink" href="#id1248" 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">set</span><span class="o">.</span><span class="n">rounding</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1249">
<h5><a class="toc-backref" href="#id3159">Overview:</a><a class="headerlink" href="#id1249" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.set.rounding</span></code>’ intrinsic sets current rounding mode.</p>
</div>
<div class="section" id="id1250">
<h5><a class="toc-backref" href="#id3160">Arguments:</a><a class="headerlink" href="#id1250" title="Permalink to this headline">¶</a></h5>
<p>The argument is the required rounding mode. Encoding of rounding mode is
the same as used by ‘<code class="docutils literal notranslate"><span class="pre">llvm.flt.rounds</span></code>’.</p>
</div>
<div class="section" id="id1251">
<h5><a class="toc-backref" href="#id3161">Semantics:</a><a class="headerlink" href="#id1251" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.set.rounding</span></code>’ intrinsic sets the current rounding mode. It is
similar to C library function ‘fesetround’, however this intrinsic does not
return any value and uses platform-independent representation of IEEE rounding
modes.</p>
</div>
</div>
</div>
<div class="section" id="general-intrinsics">
<h3><a class="toc-backref" href="#id3162">General Intrinsics</a><a class="headerlink" href="#general-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>This class of intrinsics is designed to be generic and has no specific
purpose.</p>
<div class="section" id="llvm-var-annotation-intrinsic">
<h4><a class="toc-backref" href="#id3163">‘<code class="docutils literal notranslate"><span class="pre">llvm.var.annotation</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-var-annotation-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1252">
<h5><a class="toc-backref" href="#id3164">Syntax:</a><a class="headerlink" href="#id1252" 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">var</span><span class="o">.</span><span class="n">annotation</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="nb">int</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1253">
<h5><a class="toc-backref" href="#id3165">Overview:</a><a class="headerlink" href="#id1253" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.var.annotation</span></code>’ intrinsic.</p>
</div>
<div class="section" id="id1254">
<h5><a class="toc-backref" href="#id3166">Arguments:</a><a class="headerlink" href="#id1254" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a pointer to a value, the second is a pointer to a
global string, the third is a pointer to a global string which is the
source file name, and the last argument is the line number.</p>
</div>
<div class="section" id="id1255">
<h5><a class="toc-backref" href="#id3167">Semantics:</a><a class="headerlink" href="#id1255" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic allows annotation of local variables with arbitrary
strings. This can be useful for special purpose optimizations that want
to look for these annotations. These have no other defined use; they are
ignored by code generation and optimization.</p>
</div>
</div>
<div class="section" id="llvm-ptr-annotation-intrinsic">
<h4><a class="toc-backref" href="#id3168">‘<code class="docutils literal notranslate"><span class="pre">llvm.ptr.annotation.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-ptr-annotation-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1256">
<h5><a class="toc-backref" href="#id3169">Syntax:</a><a class="headerlink" href="#id1256" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use ‘<code class="docutils literal notranslate"><span class="pre">llvm.ptr.annotation</span></code>’ on a
pointer to an integer of any width. <em>NOTE</em> you must specify an address space for
the pointer. The identifier for the default address space is the integer
‘<code class="docutils literal notranslate"><span class="pre">0</span></code>’.</p>
<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">ptr</span><span class="o">.</span><span class="n">annotation</span><span class="o">.</span><span class="n">p</span><span class="o"><</span><span class="n">address</span> <span class="n">space</span><span class="o">></span><span class="n">i8</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="nb">int</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i16</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ptr</span><span class="o">.</span><span class="n">annotation</span><span class="o">.</span><span class="n">p</span><span class="o"><</span><span class="n">address</span> <span class="n">space</span><span class="o">></span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span><span class="o">*</span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="nb">int</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ptr</span><span class="o">.</span><span class="n">annotation</span><span class="o">.</span><span class="n">p</span><span class="o"><</span><span class="n">address</span> <span class="n">space</span><span class="o">></span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span><span class="o">*</span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="nb">int</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i64</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ptr</span><span class="o">.</span><span class="n">annotation</span><span class="o">.</span><span class="n">p</span><span class="o"><</span><span class="n">address</span> <span class="n">space</span><span class="o">></span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span><span class="o">*</span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="nb">int</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i256</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ptr</span><span class="o">.</span><span class="n">annotation</span><span class="o">.</span><span class="n">p</span><span class="o"><</span><span class="n">address</span> <span class="n">space</span><span class="o">></span><span class="n">i256</span><span class="p">(</span><span class="n">i256</span><span class="o">*</span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="nb">int</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1257">
<h5><a class="toc-backref" href="#id3170">Overview:</a><a class="headerlink" href="#id1257" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.ptr.annotation</span></code>’ intrinsic.</p>
</div>
<div class="section" id="id1258">
<h5><a class="toc-backref" href="#id3171">Arguments:</a><a class="headerlink" href="#id1258" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a pointer to an integer value of arbitrary bitwidth
(result of some expression), the second is a pointer to a global string, the
third is a pointer to a global string which is the source file name, and the
last argument is the line number. It returns the value of the first argument.</p>
</div>
<div class="section" id="id1259">
<h5><a class="toc-backref" href="#id3172">Semantics:</a><a class="headerlink" href="#id1259" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic allows annotation of a pointer to an integer with arbitrary
strings. This can be useful for special purpose optimizations that want to look
for these annotations. These have no other defined use; they are ignored by code
generation and optimization.</p>
</div>
</div>
<div class="section" id="llvm-annotation-intrinsic">
<h4><a class="toc-backref" href="#id3173">‘<code class="docutils literal notranslate"><span class="pre">llvm.annotation.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-annotation-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1260">
<h5><a class="toc-backref" href="#id3174">Syntax:</a><a class="headerlink" href="#id1260" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use ‘<code class="docutils literal notranslate"><span class="pre">llvm.annotation</span></code>’ on
any integer bit width.</p>
<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">annotation</span><span class="o">.</span><span class="n">i8</span><span class="p">(</span><span class="n">i8</span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="nb">int</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i16</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">annotation</span><span class="o">.</span><span class="n">i16</span><span class="p">(</span><span class="n">i16</span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="nb">int</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">annotation</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="nb">int</span><span class="o">></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">annotation</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="nb">int</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i256</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">annotation</span><span class="o">.</span><span class="n">i256</span><span class="p">(</span><span class="n">i256</span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">str</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="nb">int</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1261">
<h5><a class="toc-backref" href="#id3175">Overview:</a><a class="headerlink" href="#id1261" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.annotation</span></code>’ intrinsic.</p>
</div>
<div class="section" id="id1262">
<h5><a class="toc-backref" href="#id3176">Arguments:</a><a class="headerlink" href="#id1262" title="Permalink to this headline">¶</a></h5>
<p>The first argument is an integer value (result of some expression), the
second is a pointer to a global string, the third is a pointer to a
global string which is the source file name, and the last argument is
the line number. It returns the value of the first argument.</p>
</div>
<div class="section" id="id1263">
<h5><a class="toc-backref" href="#id3177">Semantics:</a><a class="headerlink" href="#id1263" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic allows annotations to be put on arbitrary expressions
with arbitrary strings. This can be useful for special purpose
optimizations that want to look for these annotations. These have no
other defined use; they are ignored by code generation and optimization.</p>
</div>
</div>
<div class="section" id="llvm-codeview-annotation-intrinsic">
<h4><a class="toc-backref" href="#id3178">‘<code class="docutils literal notranslate"><span class="pre">llvm.codeview.annotation</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-codeview-annotation-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1264">
<h5><a class="toc-backref" href="#id3179">Syntax:</a><a class="headerlink" href="#id1264" title="Permalink to this headline">¶</a></h5>
<p>This annotation emits a label at its program point and an associated
<code class="docutils literal notranslate"><span class="pre">S_ANNOTATION</span></code> codeview record with some additional string metadata. This is
used to implement MSVC’s <code class="docutils literal notranslate"><span class="pre">__annotation</span></code> intrinsic. It is marked
<code class="docutils literal notranslate"><span class="pre">noduplicate</span></code>, so calls to this intrinsic prevent inlining and should be
considered expensive.</p>
<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">codeview</span><span class="o">.</span><span class="n">annotation</span><span class="p">(</span><span class="n">metadata</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1265">
<h5><a class="toc-backref" href="#id3180">Arguments:</a><a class="headerlink" href="#id1265" title="Permalink to this headline">¶</a></h5>
<p>The argument should be an MDTuple containing any number of MDStrings.</p>
</div>
</div>
<div class="section" id="llvm-trap-intrinsic">
<h4><a class="toc-backref" href="#id3181">‘<code class="docutils literal notranslate"><span class="pre">llvm.trap</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-trap-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1266">
<h5><a class="toc-backref" href="#id3182">Syntax:</a><a class="headerlink" href="#id1266" 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">trap</span><span class="p">()</span> <span class="n">cold</span> <span class="n">noreturn</span> <span class="n">nounwind</span>
</pre></div>
</div>
</div>
<div class="section" id="id1267">
<h5><a class="toc-backref" href="#id3183">Overview:</a><a class="headerlink" href="#id1267" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.trap</span></code>’ intrinsic.</p>
</div>
<div class="section" id="id1268">
<h5><a class="toc-backref" href="#id3184">Arguments:</a><a class="headerlink" href="#id1268" title="Permalink to this headline">¶</a></h5>
<p>None.</p>
</div>
<div class="section" id="id1269">
<h5><a class="toc-backref" href="#id3185">Semantics:</a><a class="headerlink" href="#id1269" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic is lowered to the target dependent trap instruction. If
the target does not have a trap instruction, this intrinsic will be
lowered to a call of the <code class="docutils literal notranslate"><span class="pre">abort()</span></code> function.</p>
</div>
</div>
<div class="section" id="llvm-debugtrap-intrinsic">
<h4><a class="toc-backref" href="#id3186">‘<code class="docutils literal notranslate"><span class="pre">llvm.debugtrap</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-debugtrap-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1270">
<h5><a class="toc-backref" href="#id3187">Syntax:</a><a class="headerlink" href="#id1270" 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">debugtrap</span><span class="p">()</span> <span class="n">nounwind</span>
</pre></div>
</div>
</div>
<div class="section" id="id1271">
<h5><a class="toc-backref" href="#id3188">Overview:</a><a class="headerlink" href="#id1271" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.debugtrap</span></code>’ intrinsic.</p>
</div>
<div class="section" id="id1272">
<h5><a class="toc-backref" href="#id3189">Arguments:</a><a class="headerlink" href="#id1272" title="Permalink to this headline">¶</a></h5>
<p>None.</p>
</div>
<div class="section" id="id1273">
<h5><a class="toc-backref" href="#id3190">Semantics:</a><a class="headerlink" href="#id1273" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic is lowered to code which is intended to cause an
execution trap with the intention of requesting the attention of a
debugger.</p>
</div>
</div>
<div class="section" id="llvm-ubsantrap-intrinsic">
<h4><a class="toc-backref" href="#id3191">‘<code class="docutils literal notranslate"><span class="pre">llvm.ubsantrap</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-ubsantrap-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1274">
<h5><a class="toc-backref" href="#id3192">Syntax:</a><a class="headerlink" href="#id1274" 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">ubsantrap</span><span class="p">(</span><span class="n">i8</span> <span class="n">immarg</span><span class="p">)</span> <span class="n">cold</span> <span class="n">noreturn</span> <span class="n">nounwind</span>
</pre></div>
</div>
</div>
<div class="section" id="id1275">
<h5><a class="toc-backref" href="#id3193">Overview:</a><a class="headerlink" href="#id1275" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.ubsantrap</span></code>’ intrinsic.</p>
</div>
<div class="section" id="id1276">
<h5><a class="toc-backref" href="#id3194">Arguments:</a><a class="headerlink" href="#id1276" title="Permalink to this headline">¶</a></h5>
<p>An integer describing the kind of failure detected.</p>
</div>
<div class="section" id="id1277">
<h5><a class="toc-backref" href="#id3195">Semantics:</a><a class="headerlink" href="#id1277" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic is lowered to code which is intended to cause an execution trap,
embedding the argument into encoding of that trap somehow to discriminate
crashes if possible.</p>
<p>Equivalent to <code class="docutils literal notranslate"><span class="pre">@llvm.trap</span></code> for targets that do not support this behaviour.</p>
</div>
</div>
<div class="section" id="llvm-stackprotector-intrinsic">
<h4><a class="toc-backref" href="#id3196">‘<code class="docutils literal notranslate"><span class="pre">llvm.stackprotector</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-stackprotector-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1278">
<h5><a class="toc-backref" href="#id3197">Syntax:</a><a class="headerlink" href="#id1278" 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">stackprotector</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">guard</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">slot</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1279">
<h5><a class="toc-backref" href="#id3198">Overview:</a><a class="headerlink" href="#id1279" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.stackprotector</span></code> intrinsic takes the <code class="docutils literal notranslate"><span class="pre">guard</span></code> and stores it
onto the stack at <code class="docutils literal notranslate"><span class="pre">slot</span></code>. The stack slot is adjusted to ensure that it
is placed on the stack before local variables.</p>
</div>
<div class="section" id="id1280">
<h5><a class="toc-backref" href="#id3199">Arguments:</a><a class="headerlink" href="#id1280" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.stackprotector</span></code> intrinsic requires two pointer arguments.
The first argument is the value loaded from the stack guard
<code class="docutils literal notranslate"><span class="pre">@__stack_chk_guard</span></code>. The second variable is an <code class="docutils literal notranslate"><span class="pre">alloca</span></code> that has
enough space to hold the value of the guard.</p>
</div>
<div class="section" id="id1281">
<h5><a class="toc-backref" href="#id3200">Semantics:</a><a class="headerlink" href="#id1281" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic causes the prologue/epilogue inserter to force the position of
the <code class="docutils literal notranslate"><span class="pre">AllocaInst</span></code> stack slot to be before local variables on the stack. This is
to ensure that if a local variable on the stack is overwritten, it will destroy
the value of the guard. When the function exits, the guard on the stack is
checked against the original guard by <code class="docutils literal notranslate"><span class="pre">llvm.stackprotectorcheck</span></code>. If they are
different, then <code class="docutils literal notranslate"><span class="pre">llvm.stackprotectorcheck</span></code> causes the program to abort by
calling the <code class="docutils literal notranslate"><span class="pre">__stack_chk_fail()</span></code> function.</p>
</div>
</div>
<div class="section" id="llvm-stackguard-intrinsic">
<h4><a class="toc-backref" href="#id3201">‘<code class="docutils literal notranslate"><span class="pre">llvm.stackguard</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-stackguard-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1282">
<h5><a class="toc-backref" href="#id3202">Syntax:</a><a class="headerlink" href="#id1282" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">stackguard</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="id1283">
<h5><a class="toc-backref" href="#id3203">Overview:</a><a class="headerlink" href="#id1283" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.stackguard</span></code> intrinsic returns the system stack guard value.</p>
<p>It should not be generated by frontends, since it is only for internal usage.
The reason why we create this intrinsic is that we still support IR form Stack
Protector in FastISel.</p>
</div>
<div class="section" id="id1284">
<h5><a class="toc-backref" href="#id3204">Arguments:</a><a class="headerlink" href="#id1284" title="Permalink to this headline">¶</a></h5>
<p>None.</p>
</div>
<div class="section" id="id1285">
<h5><a class="toc-backref" href="#id3205">Semantics:</a><a class="headerlink" href="#id1285" title="Permalink to this headline">¶</a></h5>
<p>On some platforms, the value returned by this intrinsic remains unchanged
between loads in the same thread. On other platforms, it returns the same
global variable value, if any, e.g. <code class="docutils literal notranslate"><span class="pre">@__stack_chk_guard</span></code>.</p>
<p>Currently some platforms have IR-level customized stack guard loading (e.g.
X86 Linux) that is not handled by <code class="docutils literal notranslate"><span class="pre">llvm.stackguard()</span></code>, while they should be
in the future.</p>
</div>
</div>
<div class="section" id="llvm-objectsize-intrinsic">
<h4><a class="toc-backref" href="#id3206">‘<code class="docutils literal notranslate"><span class="pre">llvm.objectsize</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-objectsize-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1286">
<h5><a class="toc-backref" href="#id3207">Syntax:</a><a class="headerlink" href="#id1286" 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">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">objectsize</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">object</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="nb">min</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">nullunknown</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">dynamic</span><span class="o">></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">objectsize</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="nb">object</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="nb">min</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">nullunknown</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">dynamic</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1287">
<h5><a class="toc-backref" href="#id3208">Overview:</a><a class="headerlink" href="#id1287" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.objectsize</span></code> intrinsic is designed to provide information to the
optimizer to determine whether a) an operation (like memcpy) will overflow a
buffer that corresponds to an object, or b) that a runtime check for overflow
isn’t necessary. An object in this context means an allocation of a specific
class, structure, array, or other object.</p>
</div>
<div class="section" id="id1288">
<h5><a class="toc-backref" href="#id3209">Arguments:</a><a class="headerlink" href="#id1288" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.objectsize</span></code> intrinsic takes four arguments. The first argument is a
pointer to or into the <code class="docutils literal notranslate"><span class="pre">object</span></code>. The second argument determines whether
<code class="docutils literal notranslate"><span class="pre">llvm.objectsize</span></code> returns 0 (if true) or -1 (if false) when the object size is
unknown. The third argument controls how <code class="docutils literal notranslate"><span class="pre">llvm.objectsize</span></code> acts when <code class="docutils literal notranslate"><span class="pre">null</span></code>
in address space 0 is used as its pointer argument. If it’s <code class="docutils literal notranslate"><span class="pre">false</span></code>,
<code class="docutils literal notranslate"><span class="pre">llvm.objectsize</span></code> reports 0 bytes available when given <code class="docutils literal notranslate"><span class="pre">null</span></code>. Otherwise, if
the <code class="docutils literal notranslate"><span class="pre">null</span></code> is in a non-zero address space or if <code class="docutils literal notranslate"><span class="pre">true</span></code> is given for the
third argument of <code class="docutils literal notranslate"><span class="pre">llvm.objectsize</span></code>, we assume its size is unknown. The fourth
argument to <code class="docutils literal notranslate"><span class="pre">llvm.objectsize</span></code> determines if the value should be evaluated at
runtime.</p>
<p>The second, third, and fourth arguments only accept constants.</p>
</div>
<div class="section" id="id1289">
<h5><a class="toc-backref" href="#id3210">Semantics:</a><a class="headerlink" href="#id1289" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.objectsize</span></code> intrinsic is lowered to a value representing the size of
the object concerned. If the size cannot be determined, <code class="docutils literal notranslate"><span class="pre">llvm.objectsize</span></code>
returns <code class="docutils literal notranslate"><span class="pre">i32/i64</span> <span class="pre">-1</span> <span class="pre">or</span> <span class="pre">0</span></code> (depending on the <code class="docutils literal notranslate"><span class="pre">min</span></code> argument).</p>
</div>
</div>
<div class="section" id="llvm-expect-intrinsic">
<h4><a class="toc-backref" href="#id3211">‘<code class="docutils literal notranslate"><span class="pre">llvm.expect</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-expect-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1290">
<h5><a class="toc-backref" href="#id3212">Syntax:</a><a class="headerlink" href="#id1290" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.expect</span></code> on any
integer bit width.</p>
<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">expect</span><span class="o">.</span><span class="n">i1</span><span class="p">(</span><span class="n">i1</span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">expected_val</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">expect</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">expected_val</span><span class="o">></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">expect</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="n">i64</span> <span class="o"><</span><span class="n">expected_val</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1291">
<h5><a class="toc-backref" href="#id3213">Overview:</a><a class="headerlink" href="#id1291" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.expect</span></code> intrinsic provides information about expected (the
most probable) value of <code class="docutils literal notranslate"><span class="pre">val</span></code>, which can be used by optimizers.</p>
</div>
<div class="section" id="id1292">
<h5><a class="toc-backref" href="#id3214">Arguments:</a><a class="headerlink" href="#id1292" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.expect</span></code> intrinsic takes two arguments. The first argument is
a value. The second argument is an expected value.</p>
</div>
<div class="section" id="id1293">
<h5><a class="toc-backref" href="#id3215">Semantics:</a><a class="headerlink" href="#id1293" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic is lowered to the <code class="docutils literal notranslate"><span class="pre">val</span></code>.</p>
</div>
</div>
<div class="section" id="llvm-expect-with-probability-intrinsic">
<h4><a class="toc-backref" href="#id3216">‘<code class="docutils literal notranslate"><span class="pre">llvm.expect.with.probability</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-expect-with-probability-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1294">
<h5><a class="toc-backref" href="#id3217">Syntax:</a><a class="headerlink" href="#id1294" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic is similar to <code class="docutils literal notranslate"><span class="pre">llvm.expect</span></code>. This is an overloaded intrinsic.
You can use <code class="docutils literal notranslate"><span class="pre">llvm.expect.with.probability</span></code> on any integer bit width.</p>
<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">expect</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">probability</span><span class="o">.</span><span class="n">i1</span><span class="p">(</span><span class="n">i1</span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="n">i1</span> <span class="o"><</span><span class="n">expected_val</span><span class="o">></span><span class="p">,</span> <span class="n">double</span> <span class="o"><</span><span class="n">prob</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">i32</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">expect</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">probability</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="n">i32</span> <span class="o"><</span><span class="n">expected_val</span><span class="o">></span><span class="p">,</span> <span class="n">double</span> <span class="o"><</span><span class="n">prob</span><span class="o">></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">expect</span><span class="o">.</span><span class="k">with</span><span class="o">.</span><span class="n">probability</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i64</span> <span class="o"><</span><span class="n">val</span><span class="o">></span><span class="p">,</span> <span class="n">i64</span> <span class="o"><</span><span class="n">expected_val</span><span class="o">></span><span class="p">,</span> <span class="n">double</span> <span class="o"><</span><span class="n">prob</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1295">
<h5><a class="toc-backref" href="#id3218">Overview:</a><a class="headerlink" href="#id1295" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.expect.with.probability</span></code> intrinsic provides information about
expected value of <code class="docutils literal notranslate"><span class="pre">val</span></code> with probability(or confidence) <code class="docutils literal notranslate"><span class="pre">prob</span></code>, which can
be used by optimizers.</p>
</div>
<div class="section" id="id1296">
<h5><a class="toc-backref" href="#id3219">Arguments:</a><a class="headerlink" href="#id1296" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.expect.with.probability</span></code> intrinsic takes three arguments. The first
argument is a value. The second argument is an expected value. The third
argument is a probability.</p>
</div>
<div class="section" id="id1297">
<h5><a class="toc-backref" href="#id3220">Semantics:</a><a class="headerlink" href="#id1297" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic is lowered to the <code class="docutils literal notranslate"><span class="pre">val</span></code>.</p>
</div>
</div>
<div class="section" id="llvm-assume-intrinsic">
<span id="int-assume"></span><h4><a class="toc-backref" href="#id3221">‘<code class="docutils literal notranslate"><span class="pre">llvm.assume</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-assume-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1298">
<h5><a class="toc-backref" href="#id3222">Syntax:</a><a class="headerlink" href="#id1298" 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">assume</span><span class="p">(</span><span class="n">i1</span> <span class="o">%</span><span class="n">cond</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1299">
<h5><a class="toc-backref" href="#id3223">Overview:</a><a class="headerlink" href="#id1299" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.assume</span></code> allows the optimizer to assume that the provided
condition is true. This information can then be used in simplifying other parts
of the code.</p>
<p>More complex assumptions can be encoded as
<a class="reference internal" href="#assume-opbundles"><span class="std std-ref">assume operand bundles</span></a>.</p>
</div>
<div class="section" id="id1300">
<h5><a class="toc-backref" href="#id3224">Arguments:</a><a class="headerlink" href="#id1300" title="Permalink to this headline">¶</a></h5>
<p>The argument of the call is the condition which the optimizer may assume is
always true.</p>
</div>
<div class="section" id="id1301">
<h5><a class="toc-backref" href="#id3225">Semantics:</a><a class="headerlink" href="#id1301" title="Permalink to this headline">¶</a></h5>
<p>The intrinsic allows the optimizer to assume that the provided condition is
always true whenever the control flow reaches the intrinsic call. No code is
generated for this intrinsic, and instructions that contribute only to the
provided condition are not used for code generation. If the condition is
violated during execution, the behavior is undefined.</p>
<p>Note that the optimizer might limit the transformations performed on values
used by the <code class="docutils literal notranslate"><span class="pre">llvm.assume</span></code> intrinsic in order to preserve the instructions
only used to form the intrinsic’s input argument. This might prove undesirable
if the extra information provided by the <code class="docutils literal notranslate"><span class="pre">llvm.assume</span></code> intrinsic does not cause
sufficient overall improvement in code quality. For this reason,
<code class="docutils literal notranslate"><span class="pre">llvm.assume</span></code> should not be used to document basic mathematical invariants
that the optimizer can otherwise deduce or facts that are of little use to the
optimizer.</p>
</div>
</div>
<div class="section" id="llvm-ssa-copy-intrinsic">
<span id="int-ssa-copy"></span><h4><a class="toc-backref" href="#id3226">‘<code class="docutils literal notranslate"><span class="pre">llvm.ssa.copy</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-ssa-copy-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1302">
<h5><a class="toc-backref" href="#id3227">Syntax:</a><a class="headerlink" href="#id1302" 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="nb">type</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">ssa</span><span class="o">.</span><span class="n">copy</span><span class="p">(</span><span class="nb">type</span> <span class="o">%</span><span class="n">operand</span><span class="p">)</span> <span class="n">returned</span><span class="p">(</span><span class="mi">1</span><span class="p">)</span> <span class="n">readnone</span>
</pre></div>
</div>
</div>
<div class="section" id="id1303">
<h5><a class="toc-backref" href="#id3228">Arguments:</a><a class="headerlink" href="#id1303" title="Permalink to this headline">¶</a></h5>
<p>The first argument is an operand which is used as the returned value.</p>
</div>
<div class="section" id="id1304">
<h5><a class="toc-backref" href="#id3229">Overview:</a><a class="headerlink" href="#id1304" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.ssa.copy</span></code> intrinsic can be used to attach information to
operations by copying them and giving them new names. For example,
the PredicateInfo utility uses it to build Extended SSA form, and
attach various forms of information to operands that dominate specific
uses. It is not meant for general use, only for building temporary
renaming forms that require value splits at certain points.</p>
</div>
</div>
<div class="section" id="llvm-type-test-intrinsic">
<span id="type-test"></span><h4><a class="toc-backref" href="#id3230">‘<code class="docutils literal notranslate"><span class="pre">llvm.type.test</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-type-test-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1305">
<h5><a class="toc-backref" href="#id3231">Syntax:</a><a class="headerlink" href="#id1305" 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">i1</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">type</span><span class="o">.</span><span class="n">test</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="p">,</span> <span class="n">metadata</span> <span class="o">%</span><span class="nb">type</span><span class="p">)</span> <span class="n">nounwind</span> <span class="n">readnone</span>
</pre></div>
</div>
</div>
<div class="section" id="id1306">
<h5><a class="toc-backref" href="#id3232">Arguments:</a><a class="headerlink" href="#id1306" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a pointer to be tested. The second argument is a
metadata object representing a <a class="reference internal" href="TypeMetadata.html"><span class="doc">type identifier</span></a>.</p>
</div>
<div class="section" id="id1307">
<h5><a class="toc-backref" href="#id3233">Overview:</a><a class="headerlink" href="#id1307" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.type.test</span></code> intrinsic tests whether the given pointer is associated
with the given type identifier.</p>
</div>
</div>
<div class="section" id="llvm-type-checked-load-intrinsic">
<span id="type-checked-load"></span><h4><a class="toc-backref" href="#id3234">‘<code class="docutils literal notranslate"><span class="pre">llvm.type.checked.load</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-type-checked-load-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1308">
<h5><a class="toc-backref" href="#id3235">Syntax:</a><a class="headerlink" href="#id1308" 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="p">{</span><span class="n">i8</span><span class="o">*</span><span class="p">,</span> <span class="n">i1</span><span class="p">}</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">type</span><span class="o">.</span><span class="n">checked</span><span class="o">.</span><span class="n">load</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="p">,</span> <span class="n">i32</span> <span class="o">%</span><span class="n">offset</span><span class="p">,</span> <span class="n">metadata</span> <span class="o">%</span><span class="nb">type</span><span class="p">)</span> <span class="n">argmemonly</span> <span class="n">nounwind</span> <span class="n">readonly</span>
</pre></div>
</div>
</div>
<div class="section" id="id1309">
<h5><a class="toc-backref" href="#id3236">Arguments:</a><a class="headerlink" href="#id1309" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a pointer from which to load a function pointer. The
second argument is the byte offset from which to load the function pointer. The
third argument is a metadata object representing a <a class="reference internal" href="TypeMetadata.html"><span class="doc">type identifier</span></a>.</p>
</div>
<div class="section" id="id1310">
<h5><a class="toc-backref" href="#id3237">Overview:</a><a class="headerlink" href="#id1310" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.type.checked.load</span></code> intrinsic safely loads a function pointer from a
virtual table pointer using type metadata. This intrinsic is used to implement
control flow integrity in conjunction with virtual call optimization. The
virtual call optimization pass will optimize away <code class="docutils literal notranslate"><span class="pre">llvm.type.checked.load</span></code>
intrinsics associated with devirtualized calls, thereby removing the type
check in cases where it is not needed to enforce the control flow integrity
constraint.</p>
<p>If the given pointer is associated with a type metadata identifier, this
function returns true as the second element of its return value. (Note that
the function may also return true if the given pointer is not associated
with a type metadata identifier.) If the function’s return value’s second
element is true, the following rules apply to the first element:</p>
<ul class="simple">
<li><p>If the given pointer is associated with the given type metadata identifier,
it is the function pointer loaded from the given byte offset from the given
pointer.</p></li>
<li><p>If the given pointer is not associated with the given type metadata
identifier, it is one of the following (the choice of which is unspecified):</p>
<ol class="arabic simple">
<li><p>The function pointer that would have been loaded from an arbitrarily chosen
(through an unspecified mechanism) pointer associated with the type
metadata.</p></li>
<li><p>If the function has a non-void return type, a pointer to a function that
returns an unspecified value without causing side effects.</p></li>
</ol>
</li>
</ul>
<p>If the function’s return value’s second element is false, the value of the
first element is undefined.</p>
</div>
</div>
<div class="section" id="llvm-arithmetic-fence-intrinsic">
<h4><a class="toc-backref" href="#id3238">‘<code class="docutils literal notranslate"><span class="pre">llvm.arithmetic.fence</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-arithmetic-fence-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1311">
<h5><a class="toc-backref" href="#id3239">Syntax:</a><a class="headerlink" href="#id1311" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">arithmetic</span><span class="o">.</span><span class="n">fence</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="o"><</span><span class="n">op</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1312">
<h5><a class="toc-backref" href="#id3240">Overview:</a><a class="headerlink" href="#id1312" title="Permalink to this headline">¶</a></h5>
<p>The purpose of the <code class="docutils literal notranslate"><span class="pre">llvm.arithmetic.fence</span></code> intrinsic
is to prevent the optimizer from performing fast-math optimizations,
particularly reassociation,
between the argument and the expression that contains the argument.
It can be used to preserve the parentheses in the source language.</p>
</div>
<div class="section" id="id1313">
<h5><a class="toc-backref" href="#id3241">Arguments:</a><a class="headerlink" href="#id1313" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.arithmetic.fence</span></code> intrinsic takes only one argument.
The argument and the return value are floating-point numbers,
or vector floating-point numbers, of the same type.</p>
</div>
<div class="section" id="id1314">
<h5><a class="toc-backref" href="#id3242">Semantics:</a><a class="headerlink" href="#id1314" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic returns the value of its operand. The optimizer can optimize
the argument, but the optimizer cannot hoist any component of the operand
to the containing context, and the optimizer cannot move the calculation of
any expression in the containing context into the operand.</p>
</div>
</div>
<div class="section" id="llvm-donothing-intrinsic">
<h4><a class="toc-backref" href="#id3243">‘<code class="docutils literal notranslate"><span class="pre">llvm.donothing</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-donothing-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1315">
<h5><a class="toc-backref" href="#id3244">Syntax:</a><a class="headerlink" href="#id1315" 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">donothing</span><span class="p">()</span> <span class="n">nounwind</span> <span class="n">readnone</span>
</pre></div>
</div>
</div>
<div class="section" id="id1316">
<h5><a class="toc-backref" href="#id3245">Overview:</a><a class="headerlink" href="#id1316" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.donothing</span></code> intrinsic doesn’t perform any operation. It’s one of only
three intrinsics (besides <code class="docutils literal notranslate"><span class="pre">llvm.experimental.patchpoint</span></code> and
<code class="docutils literal notranslate"><span class="pre">llvm.experimental.gc.statepoint</span></code>) that can be called with an invoke
instruction.</p>
</div>
<div class="section" id="id1317">
<h5><a class="toc-backref" href="#id3246">Arguments:</a><a class="headerlink" href="#id1317" title="Permalink to this headline">¶</a></h5>
<p>None.</p>
</div>
<div class="section" id="id1318">
<h5><a class="toc-backref" href="#id3247">Semantics:</a><a class="headerlink" href="#id1318" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic does nothing, and it’s removed by optimizers and ignored
by codegen.</p>
</div>
</div>
<div class="section" id="llvm-experimental-deoptimize-intrinsic">
<h4><a class="toc-backref" href="#id3248">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.deoptimize</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-deoptimize-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1319">
<h5><a class="toc-backref" href="#id3249">Syntax:</a><a class="headerlink" href="#id1319" 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="nb">type</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">deoptimize</span><span class="p">(</span><span class="o">...</span><span class="p">)</span> <span class="p">[</span> <span class="s2">"deopt"</span><span class="p">(</span><span class="o">...</span><span class="p">)</span> <span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="id1320">
<h5><a class="toc-backref" href="#id3250">Overview:</a><a class="headerlink" href="#id1320" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic, together with <a class="reference internal" href="#deopt-opbundles"><span class="std std-ref">deoptimization operand bundles</span></a>, allow frontends to express transfer of control and
frame-local state from the currently executing (typically more specialized,
hence faster) version of a function into another (typically more generic, hence
slower) version.</p>
<p>In languages with a fully integrated managed runtime like Java and JavaScript
this intrinsic can be used to implement “uncommon trap” or “side exit” like
functionality. In unmanaged languages like C and C++, this intrinsic can be
used to represent the slow paths of specialized functions.</p>
</div>
<div class="section" id="id1321">
<h5><a class="toc-backref" href="#id3251">Arguments:</a><a class="headerlink" href="#id1321" title="Permalink to this headline">¶</a></h5>
<p>The intrinsic takes an arbitrary number of arguments, whose meaning is
decided by the <a class="reference internal" href="#deoptimize-lowering"><span class="std std-ref">lowering strategy</span></a>.</p>
</div>
<div class="section" id="id1322">
<h5><a class="toc-backref" href="#id3252">Semantics:</a><a class="headerlink" href="#id1322" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">@llvm.experimental.deoptimize</span></code> intrinsic executes an attached
deoptimization continuation (denoted using a <a class="reference internal" href="#deopt-opbundles"><span class="std std-ref">deoptimization
operand bundle</span></a>) and returns the value returned by
the deoptimization continuation. Defining the semantic properties of
the continuation itself is out of scope of the language reference –
as far as LLVM is concerned, the deoptimization continuation can
invoke arbitrary side effects, including reading from and writing to
the entire heap.</p>
<p>Deoptimization continuations expressed using <code class="docutils literal notranslate"><span class="pre">"deopt"</span></code> operand bundles always
continue execution to the end of the physical frame containing them, so all
calls to <code class="docutils literal notranslate"><span class="pre">@llvm.experimental.deoptimize</span></code> must be in “tail position”:</p>
<blockquote>
<div><ul class="simple">
<li><p><code class="docutils literal notranslate"><span class="pre">@llvm.experimental.deoptimize</span></code> cannot be invoked.</p></li>
<li><p>The call must immediately precede a <a class="reference internal" href="#i-ret"><span class="std std-ref">ret</span></a> instruction.</p></li>
<li><p>The <code class="docutils literal notranslate"><span class="pre">ret</span></code> instruction must return the value produced by the
<code class="docutils literal notranslate"><span class="pre">@llvm.experimental.deoptimize</span></code> call if there is one, or void.</p></li>
</ul>
</div></blockquote>
<p>Note that the above restrictions imply that the return type for a call to
<code class="docutils literal notranslate"><span class="pre">@llvm.experimental.deoptimize</span></code> will match the return type of its immediate
caller.</p>
<p>The inliner composes the <code class="docutils literal notranslate"><span class="pre">"deopt"</span></code> continuations of the caller into the
<code class="docutils literal notranslate"><span class="pre">"deopt"</span></code> continuations present in the inlinee, and also updates calls to this
intrinsic to return directly from the frame of the function it inlined into.</p>
<p>All declarations of <code class="docutils literal notranslate"><span class="pre">@llvm.experimental.deoptimize</span></code> must share the
same calling convention.</p>
</div>
<div class="section" id="lowering">
<span id="deoptimize-lowering"></span><h5><a class="toc-backref" href="#id3253">Lowering:</a><a class="headerlink" href="#lowering" title="Permalink to this headline">¶</a></h5>
<p>Calls to <code class="docutils literal notranslate"><span class="pre">@llvm.experimental.deoptimize</span></code> are lowered to calls to the
symbol <code class="docutils literal notranslate"><span class="pre">__llvm_deoptimize</span></code> (it is the frontend’s responsibility to
ensure that this symbol is defined). The call arguments to
<code class="docutils literal notranslate"><span class="pre">@llvm.experimental.deoptimize</span></code> are lowered as if they were formal
arguments of the specified types, and not as varargs.</p>
</div>
</div>
<div class="section" id="llvm-experimental-guard-intrinsic">
<h4><a class="toc-backref" href="#id3254">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.guard</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-guard-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1323">
<h5><a class="toc-backref" href="#id3255">Syntax:</a><a class="headerlink" href="#id1323" 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">experimental</span><span class="o">.</span><span class="n">guard</span><span class="p">(</span><span class="n">i1</span><span class="p">,</span> <span class="o">...</span><span class="p">)</span> <span class="p">[</span> <span class="s2">"deopt"</span><span class="p">(</span><span class="o">...</span><span class="p">)</span> <span class="p">]</span>
</pre></div>
</div>
</div>
<div class="section" id="id1324">
<h5><a class="toc-backref" href="#id3256">Overview:</a><a class="headerlink" href="#id1324" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic, together with <a class="reference internal" href="#deopt-opbundles"><span class="std std-ref">deoptimization operand bundles</span></a>, allows frontends to express guards or checks on
optimistic assumptions made during compilation. The semantics of
<code class="docutils literal notranslate"><span class="pre">@llvm.experimental.guard</span></code> is defined in terms of
<code class="docutils literal notranslate"><span class="pre">@llvm.experimental.deoptimize</span></code> – its body is defined to be
equivalent to:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>define void @llvm.experimental.guard(i1 %pred, <args...>) {
%realPred = and i1 %pred, undef
br i1 %realPred, label %continue, label %leave [, !make.implicit !{}]
leave:
call void @llvm.experimental.deoptimize(<args...>) [ "deopt"() ]
ret void
continue:
ret void
}
</pre></div>
</div>
<p>with the optional <code class="docutils literal notranslate"><span class="pre">[,</span> <span class="pre">!make.implicit</span> <span class="pre">!{}]</span></code> present if and only if it
is present on the call site. For more details on <code class="docutils literal notranslate"><span class="pre">!make.implicit</span></code>,
see <a class="reference internal" href="FaultMaps.html"><span class="doc">FaultMaps and implicit checks</span></a>.</p>
<p>In words, <code class="docutils literal notranslate"><span class="pre">@llvm.experimental.guard</span></code> executes the attached
<code class="docutils literal notranslate"><span class="pre">"deopt"</span></code> continuation if (but <strong>not</strong> only if) its first argument
is <code class="docutils literal notranslate"><span class="pre">false</span></code>. Since the optimizer is allowed to replace the <code class="docutils literal notranslate"><span class="pre">undef</span></code>
with an arbitrary value, it can optimize guard to fail “spuriously”,
i.e. without the original condition being false (hence the “not only
if”); and this allows for “check widening” type optimizations.</p>
<p><code class="docutils literal notranslate"><span class="pre">@llvm.experimental.guard</span></code> cannot be invoked.</p>
<p>After <code class="docutils literal notranslate"><span class="pre">@llvm.experimental.guard</span></code> was first added, a more general
formulation was found in <code class="docutils literal notranslate"><span class="pre">@llvm.experimental.widenable.condition</span></code>.
Support for <code class="docutils literal notranslate"><span class="pre">@llvm.experimental.guard</span></code> is slowly being rephrased in
terms of this alternate.</p>
</div>
</div>
<div class="section" id="llvm-experimental-widenable-condition-intrinsic">
<h4><a class="toc-backref" href="#id3257">‘<code class="docutils literal notranslate"><span class="pre">llvm.experimental.widenable.condition</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-experimental-widenable-condition-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1325">
<h5><a class="toc-backref" href="#id3258">Syntax:</a><a class="headerlink" href="#id1325" 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">i1</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">experimental</span><span class="o">.</span><span class="n">widenable</span><span class="o">.</span><span class="n">condition</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="id1326">
<h5><a class="toc-backref" href="#id3259">Overview:</a><a class="headerlink" href="#id1326" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic represents a “widenable condition” which is
boolean expressions with the following property: whether this
expression is <cite>true</cite> or <cite>false</cite>, the program is correct and
well-defined.</p>
<p>Together with <a class="reference internal" href="#deopt-opbundles"><span class="std std-ref">deoptimization operand bundles</span></a>,
<code class="docutils literal notranslate"><span class="pre">@llvm.experimental.widenable.condition</span></code> allows frontends to
express guards or checks on optimistic assumptions made during
compilation and represent them as branch instructions on special
conditions.</p>
<p>While this may appear similar in semantics to <cite>undef</cite>, it is very
different in that an invocation produces a particular, singular
value. It is also intended to be lowered late, and remain available
for specific optimizations and transforms that can benefit from its
special properties.</p>
</div>
<div class="section" id="id1327">
<h5><a class="toc-backref" href="#id3260">Arguments:</a><a class="headerlink" href="#id1327" title="Permalink to this headline">¶</a></h5>
<p>None.</p>
</div>
<div class="section" id="id1328">
<h5><a class="toc-backref" href="#id3261">Semantics:</a><a class="headerlink" href="#id1328" title="Permalink to this headline">¶</a></h5>
<p>The intrinsic <code class="docutils literal notranslate"><span class="pre">@llvm.experimental.widenable.condition()</span></code>
returns either <cite>true</cite> or <cite>false</cite>. For each evaluation of a call
to this intrinsic, the program must be valid and correct both if
it returns <cite>true</cite> and if it returns <cite>false</cite>. This allows
transformation passes to replace evaluations of this intrinsic
with either value whenever one is beneficial.</p>
<p>When used in a branch condition, it allows us to choose between
two alternative correct solutions for the same problem, like
in example below:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span> %cond = call i1 @llvm.experimental.widenable.condition()
br i1 %cond, label %solution_1, label %solution_2
label %fast_path:
; Apply memory-consuming but fast solution for a task.
label %slow_path:
; Cheap in memory but slow solution.
</pre></div>
</div>
<p>Whether the result of intrinsic’s call is <cite>true</cite> or <cite>false</cite>,
it should be correct to pick either solution. We can switch
between them by replacing the result of
<code class="docutils literal notranslate"><span class="pre">@llvm.experimental.widenable.condition</span></code> with different
<cite>i1</cite> expressions.</p>
<p>This is how it can be used to represent guards as widenable branches:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>block:
; Unguarded instructions
call void @llvm.experimental.guard(i1 %cond, <args...>) ["deopt"(<deopt_args...>)]
; Guarded instructions
</pre></div>
</div>
<p>Can be expressed in an alternative equivalent form of explicit branch using
<code class="docutils literal notranslate"><span class="pre">@llvm.experimental.widenable.condition</span></code>:</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>block:
; Unguarded instructions
%widenable_condition = call i1 @llvm.experimental.widenable.condition()
%guard_condition = and i1 %cond, %widenable_condition
br i1 %guard_condition, label %guarded, label %deopt
guarded:
; Guarded instructions
deopt:
call type @llvm.experimental.deoptimize(<args...>) [ "deopt"(<deopt_args...>) ]
</pre></div>
</div>
<p>So the block <cite>guarded</cite> is only reachable when <cite>%cond</cite> is <cite>true</cite>,
and it should be valid to go to the block <cite>deopt</cite> whenever <cite>%cond</cite>
is <cite>true</cite> or <cite>false</cite>.</p>
<p><code class="docutils literal notranslate"><span class="pre">@llvm.experimental.widenable.condition</span></code> will never throw, thus
it cannot be invoked.</p>
</div>
<div class="section" id="guard-widening">
<h5><a class="toc-backref" href="#id3262">Guard widening:</a><a class="headerlink" href="#guard-widening" title="Permalink to this headline">¶</a></h5>
<p>When <code class="docutils literal notranslate"><span class="pre">@llvm.experimental.widenable.condition()</span></code> is used in
condition of a guard represented as explicit branch, it is
legal to widen the guard’s condition with any additional
conditions.</p>
<p>Guard widening looks like replacement of</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>%widenable_cond = call i1 @llvm.experimental.widenable.condition()
%guard_cond = and i1 %cond, %widenable_cond
br i1 %guard_cond, label %guarded, label %deopt
</pre></div>
</div>
<p>with</p>
<div class="highlight-text notranslate"><div class="highlight"><pre><span></span>%widenable_cond = call i1 @llvm.experimental.widenable.condition()
%new_cond = and i1 %any_other_cond, %widenable_cond
%new_guard_cond = and i1 %cond, %new_cond
br i1 %new_guard_cond, label %guarded, label %deopt
</pre></div>
</div>
<p>for this branch. Here <cite>%any_other_cond</cite> is an arbitrarily chosen
well-defined <cite>i1</cite> value. By making guard widening, we may
impose stricter conditions on <cite>guarded</cite> block and bail to the
deopt when the new condition is not met.</p>
</div>
<div class="section" id="id1329">
<h5><a class="toc-backref" href="#id3263">Lowering:</a><a class="headerlink" href="#id1329" title="Permalink to this headline">¶</a></h5>
<p>Default lowering strategy is replacing the result of
call of <code class="docutils literal notranslate"><span class="pre">@llvm.experimental.widenable.condition</span></code> with
constant <cite>true</cite>. However it is always correct to replace
it with any other <cite>i1</cite> value. Any pass can
freely do it if it can benefit from non-default lowering.</p>
</div>
</div>
<div class="section" id="llvm-load-relative-intrinsic">
<h4><a class="toc-backref" href="#id3264">‘<code class="docutils literal notranslate"><span class="pre">llvm.load.relative</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-load-relative-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1330">
<h5><a class="toc-backref" href="#id3265">Syntax:</a><a class="headerlink" href="#id1330" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">load</span><span class="o">.</span><span class="n">relative</span><span class="o">.</span><span class="n">iN</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="p">,</span> <span class="n">iN</span> <span class="o">%</span><span class="n">offset</span><span class="p">)</span> <span class="n">argmemonly</span> <span class="n">nounwind</span> <span class="n">readonly</span>
</pre></div>
</div>
</div>
<div class="section" id="id1331">
<h5><a class="toc-backref" href="#id3266">Overview:</a><a class="headerlink" href="#id1331" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic loads a 32-bit value from the address <code class="docutils literal notranslate"><span class="pre">%ptr</span> <span class="pre">+</span> <span class="pre">%offset</span></code>,
adds <code class="docutils literal notranslate"><span class="pre">%ptr</span></code> to that value and returns it. The constant folder specifically
recognizes the form of this intrinsic and the constant initializers it may
load from; if a loaded constant initializer is known to have the form
<code class="docutils literal notranslate"><span class="pre">i32</span> <span class="pre">trunc(x</span> <span class="pre">-</span> <span class="pre">%ptr)</span></code>, the intrinsic call is folded to <code class="docutils literal notranslate"><span class="pre">x</span></code>.</p>
<p>LLVM provides that the calculation of such a constant initializer will
not overflow at link time under the medium code model if <code class="docutils literal notranslate"><span class="pre">x</span></code> is an
<code class="docutils literal notranslate"><span class="pre">unnamed_addr</span></code> function. However, it does not provide this guarantee for
a constant initializer folded into a function body. This intrinsic can be
used to avoid the possibility of overflows when loading from such a constant.</p>
</div>
</div>
<div class="section" id="llvm-sideeffect-intrinsic">
<span id="llvm-sideeffect"></span><h4><a class="toc-backref" href="#id3267">‘<code class="docutils literal notranslate"><span class="pre">llvm.sideeffect</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-sideeffect-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1332">
<h5><a class="toc-backref" href="#id3268">Syntax:</a><a class="headerlink" href="#id1332" 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">sideeffect</span><span class="p">()</span> <span class="n">inaccessiblememonly</span> <span class="n">nounwind</span>
</pre></div>
</div>
</div>
<div class="section" id="id1333">
<h5><a class="toc-backref" href="#id3269">Overview:</a><a class="headerlink" href="#id1333" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.sideeffect</span></code> intrinsic doesn’t perform any operation. Optimizers
treat it as having side effects, so it can be inserted into a loop to
indicate that the loop shouldn’t be assumed to terminate (which could
potentially lead to the loop being optimized away entirely), even if it’s
an infinite loop with no other side effects.</p>
</div>
<div class="section" id="id1334">
<h5><a class="toc-backref" href="#id3270">Arguments:</a><a class="headerlink" href="#id1334" title="Permalink to this headline">¶</a></h5>
<p>None.</p>
</div>
<div class="section" id="id1335">
<h5><a class="toc-backref" href="#id3271">Semantics:</a><a class="headerlink" href="#id1335" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic actually does nothing, but optimizers must assume that it
has externally observable side effects.</p>
</div>
</div>
<div class="section" id="llvm-is-constant-intrinsic">
<h4><a class="toc-backref" href="#id3272">‘<code class="docutils literal notranslate"><span class="pre">llvm.is.constant.*</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-is-constant-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1336">
<h5><a class="toc-backref" href="#id3273">Syntax:</a><a class="headerlink" href="#id1336" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use llvm.is.constant with any argument type.</p>
<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="ow">is</span><span class="o">.</span><span class="n">constant</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i32</span> <span class="o">%</span><span class="n">operand</span><span class="p">)</span> <span class="n">nounwind</span> <span class="n">readnone</span>
<span class="n">declare</span> <span class="n">i1</span> <span class="nd">@llvm</span><span class="o">.</span><span class="ow">is</span><span class="o">.</span><span class="n">constant</span><span class="o">.</span><span class="n">f32</span><span class="p">(</span><span class="nb">float</span> <span class="o">%</span><span class="n">operand</span><span class="p">)</span> <span class="n">nounwind</span> <span class="n">readnone</span>
<span class="n">declare</span> <span class="n">i1</span> <span class="nd">@llvm</span><span class="o">.</span><span class="ow">is</span><span class="o">.</span><span class="n">constant</span><span class="o">.</span><span class="n">TYPENAME</span><span class="p">(</span><span class="n">TYPE</span> <span class="o">%</span><span class="n">operand</span><span class="p">)</span> <span class="n">nounwind</span> <span class="n">readnone</span>
</pre></div>
</div>
</div>
<div class="section" id="id1337">
<h5><a class="toc-backref" href="#id3274">Overview:</a><a class="headerlink" href="#id1337" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.is.constant</span></code>’ intrinsic will return true if the argument
is known to be a manifest compile-time constant. It is guaranteed to
fold to either true or false before generating machine code.</p>
</div>
<div class="section" id="id1338">
<h5><a class="toc-backref" href="#id3275">Semantics:</a><a class="headerlink" href="#id1338" title="Permalink to this headline">¶</a></h5>
<p>This intrinsic generates no code. If its argument is known to be a
manifest compile-time constant value, then the intrinsic will be
converted to a constant true value. Otherwise, it will be converted to
a constant false value.</p>
<p>In particular, note that if the argument is a constant expression
which refers to a global (the address of which _is_ a constant, but
not manifest during the compile), then the intrinsic evaluates to
false.</p>
<p>The result also intentionally depends on the result of optimization
passes – e.g., the result can change depending on whether a
function gets inlined or not. A function’s parameters are
obviously not constant. However, a call like
<code class="docutils literal notranslate"><span class="pre">llvm.is.constant.i32(i32</span> <span class="pre">%param)</span></code> <em>can</em> return true after the
function is inlined, if the value passed to the function parameter was
a constant.</p>
<p>On the other hand, if constant folding is not run, it will never
evaluate to true, even in simple cases.</p>
</div>
</div>
<div class="section" id="llvm-ptrmask-intrinsic">
<span id="int-ptrmask"></span><h4><a class="toc-backref" href="#id3276">‘<code class="docutils literal notranslate"><span class="pre">llvm.ptrmask</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-ptrmask-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1339">
<h5><a class="toc-backref" href="#id3277">Syntax:</a><a class="headerlink" href="#id1339" 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">ptrty</span> <span class="n">llvm</span><span class="o">.</span><span class="n">ptrmask</span><span class="p">(</span><span class="n">ptrty</span> <span class="o">%</span><span class="n">ptr</span><span class="p">,</span> <span class="n">intty</span> <span class="o">%</span><span class="n">mask</span><span class="p">)</span> <span class="n">readnone</span> <span class="n">speculatable</span>
</pre></div>
</div>
</div>
<div class="section" id="id1340">
<h5><a class="toc-backref" href="#id3278">Arguments:</a><a class="headerlink" href="#id1340" title="Permalink to this headline">¶</a></h5>
<p>The first argument is a pointer. The second argument is an integer.</p>
</div>
<div class="section" id="id1341">
<h5><a class="toc-backref" href="#id3279">Overview:</a><a class="headerlink" href="#id1341" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.ptrmask</span></code> intrinsic masks out bits of the pointer according to a mask.
This allows stripping data from tagged pointers without converting them to an
integer (ptrtoint/inttoptr). As a consequence, we can preserve more information
to facilitate alias analysis and underlying-object detection.</p>
</div>
<div class="section" id="id1342">
<h5><a class="toc-backref" href="#id3280">Semantics:</a><a class="headerlink" href="#id1342" title="Permalink to this headline">¶</a></h5>
<p>The result of <code class="docutils literal notranslate"><span class="pre">ptrmask(ptr,</span> <span class="pre">mask)</span></code> is equivalent to
<code class="docutils literal notranslate"><span class="pre">getelementptr</span> <span class="pre">ptr,</span> <span class="pre">(ptrtoint(ptr)</span> <span class="pre">&</span> <span class="pre">mask)</span> <span class="pre">-</span> <span class="pre">ptrtoint(ptr)</span></code>. Both the returned
pointer and the first argument are based on the same underlying object (for more
information on the <em>based on</em> terminology see
<a class="reference internal" href="#pointeraliasing"><span class="std std-ref">the pointer aliasing rules</span></a>). If the bitwidth of the
mask argument does not match the pointer size of the target, the mask is
zero-extended or truncated accordingly.</p>
</div>
</div>
<div class="section" id="llvm-vscale-intrinsic">
<span id="int-vscale"></span><h4><a class="toc-backref" href="#id3281">‘<code class="docutils literal notranslate"><span class="pre">llvm.vscale</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-vscale-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1343">
<h5><a class="toc-backref" href="#id3282">Syntax:</a><a class="headerlink" href="#id1343" 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">i32</span> <span class="n">llvm</span><span class="o">.</span><span class="n">vscale</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="n">llvm</span><span class="o">.</span><span class="n">vscale</span><span class="o">.</span><span class="n">i64</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="id1344">
<h5><a class="toc-backref" href="#id3283">Overview:</a><a class="headerlink" href="#id1344" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">llvm.vscale</span></code> intrinsic returns the value for <code class="docutils literal notranslate"><span class="pre">vscale</span></code> in scalable
vectors such as <code class="docutils literal notranslate"><span class="pre"><vscale</span> <span class="pre">x</span> <span class="pre">16</span> <span class="pre">x</span> <span class="pre">i8></span></code>.</p>
</div>
<div class="section" id="id1345">
<h5><a class="toc-backref" href="#id3284">Semantics:</a><a class="headerlink" href="#id1345" title="Permalink to this headline">¶</a></h5>
<p><code class="docutils literal notranslate"><span class="pre">vscale</span></code> is a positive value that is constant throughout program
execution, but is unknown at compile time.
If the result value does not fit in the result type, then the result is
a <a class="reference internal" href="#poisonvalues"><span class="std std-ref">poison value</span></a>.</p>
</div>
</div>
</div>
<div class="section" id="stack-map-intrinsics">
<h3><a class="toc-backref" href="#id3285">Stack Map Intrinsics</a><a class="headerlink" href="#stack-map-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>LLVM provides experimental intrinsics to support runtime patching
mechanisms commonly desired in dynamic language JITs. These intrinsics
are described in <a class="reference internal" href="StackMaps.html"><span class="doc">Stack maps and patch points in LLVM</span></a>.</p>
</div>
<div class="section" id="element-wise-atomic-memory-intrinsics">
<h3><a class="toc-backref" href="#id3286">Element Wise Atomic Memory Intrinsics</a><a class="headerlink" href="#element-wise-atomic-memory-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>These intrinsics are similar to the standard library memory intrinsics except
that they perform memory transfer as a sequence of atomic memory accesses.</p>
<div class="section" id="llvm-memcpy-element-unordered-atomic-intrinsic">
<span id="int-memcpy-element-unordered-atomic"></span><h4><a class="toc-backref" href="#id3287">‘<code class="docutils literal notranslate"><span class="pre">llvm.memcpy.element.unordered.atomic</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-memcpy-element-unordered-atomic-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1346">
<h5><a class="toc-backref" href="#id3288">Syntax:</a><a class="headerlink" href="#id1346" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.memcpy.element.unordered.atomic</span></code> on
any integer bit width and for different address spaces. Not all targets
support all bit widths however.</p>
<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">memcpy</span><span class="o">.</span><span class="n">element</span><span class="o">.</span><span class="n">unordered</span><span class="o">.</span><span class="n">atomic</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">dest</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">src</span><span class="o">></span><span class="p">,</span>
<span class="n">i32</span> <span class="o"><</span><span class="nb">len</span><span class="o">></span><span class="p">,</span>
<span class="n">i32</span> <span class="o"><</span><span class="n">element_size</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">void</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">memcpy</span><span class="o">.</span><span class="n">element</span><span class="o">.</span><span class="n">unordered</span><span class="o">.</span><span class="n">atomic</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">dest</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">src</span><span class="o">></span><span class="p">,</span>
<span class="n">i64</span> <span class="o"><</span><span class="nb">len</span><span class="o">></span><span class="p">,</span>
<span class="n">i32</span> <span class="o"><</span><span class="n">element_size</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1347">
<h5><a class="toc-backref" href="#id3289">Overview:</a><a class="headerlink" href="#id1347" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.memcpy.element.unordered.atomic.*</span></code>’ intrinsic is a specialization of the
‘<code class="docutils literal notranslate"><span class="pre">llvm.memcpy.*</span></code>’ intrinsic. It differs in that the <code class="docutils literal notranslate"><span class="pre">dest</span></code> and <code class="docutils literal notranslate"><span class="pre">src</span></code> are treated
as arrays with elements that are exactly <code class="docutils literal notranslate"><span class="pre">element_size</span></code> bytes, and the copy between
buffers uses a sequence of <a class="reference internal" href="#ordering"><span class="std std-ref">unordered atomic</span></a> load/store operations
that are a positive integer multiple of the <code class="docutils literal notranslate"><span class="pre">element_size</span></code> in size.</p>
</div>
<div class="section" id="id1348">
<h5><a class="toc-backref" href="#id3290">Arguments:</a><a class="headerlink" href="#id1348" title="Permalink to this headline">¶</a></h5>
<p>The first three arguments are the same as they are in the <a class="reference internal" href="#int-memcpy"><span class="std std-ref">@llvm.memcpy</span></a>
intrinsic, with the added constraint that <code class="docutils literal notranslate"><span class="pre">len</span></code> is required to be a positive integer
multiple of the <code class="docutils literal notranslate"><span class="pre">element_size</span></code>. If <code class="docutils literal notranslate"><span class="pre">len</span></code> is not a positive integer multiple of
<code class="docutils literal notranslate"><span class="pre">element_size</span></code>, then the behaviour of the intrinsic is undefined.</p>
<p><code class="docutils literal notranslate"><span class="pre">element_size</span></code> must be a compile-time constant positive power of two no greater than
target-specific atomic access size limit.</p>
<p>For each of the input pointers <code class="docutils literal notranslate"><span class="pre">align</span></code> parameter attribute must be specified. It
must be a power of two no less than the <code class="docutils literal notranslate"><span class="pre">element_size</span></code>. Caller guarantees that
both the source and destination pointers are aligned to that boundary.</p>
</div>
<div class="section" id="id1349">
<h5><a class="toc-backref" href="#id3291">Semantics:</a><a class="headerlink" href="#id1349" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.memcpy.element.unordered.atomic.*</span></code>’ intrinsic copies <code class="docutils literal notranslate"><span class="pre">len</span></code> bytes of
memory from the source location to the destination location. These locations are not
allowed to overlap. The memory copy is performed as a sequence of load/store operations
where each access is guaranteed to be a multiple of <code class="docutils literal notranslate"><span class="pre">element_size</span></code> bytes wide and
aligned at an <code class="docutils literal notranslate"><span class="pre">element_size</span></code> boundary.</p>
<p>The order of the copy is unspecified. The same value may be read from the source
buffer many times, but only one write is issued to the destination buffer per
element. It is well defined to have concurrent reads and writes to both source and
destination provided those reads and writes are unordered atomic when specified.</p>
<p>This intrinsic does not provide any additional ordering guarantees over those
provided by a set of unordered loads from the source location and stores to the
destination.</p>
</div>
<div class="section" id="id1350">
<h5><a class="toc-backref" href="#id3292">Lowering:</a><a class="headerlink" href="#id1350" title="Permalink to this headline">¶</a></h5>
<p>In the most general case call to the ‘<code class="docutils literal notranslate"><span class="pre">llvm.memcpy.element.unordered.atomic.*</span></code>’ is
lowered to a call to the symbol <code class="docutils literal notranslate"><span class="pre">__llvm_memcpy_element_unordered_atomic_*</span></code>. Where ‘*’
is replaced with an actual element size. See <a class="reference internal" href="Statepoints.html#rewritestatepointsforgc-intrinsic-lowering"><span class="std std-ref">RewriteStatepointsForGC intrinsic
lowering</span></a> for details on GC specific
lowering.</p>
<p>Optimizer is allowed to inline memory copy when it’s profitable to do so.</p>
</div>
</div>
<div class="section" id="llvm-memmove-element-unordered-atomic-intrinsic">
<h4><a class="toc-backref" href="#id3293">‘<code class="docutils literal notranslate"><span class="pre">llvm.memmove.element.unordered.atomic</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-memmove-element-unordered-atomic-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1351">
<h5><a class="toc-backref" href="#id3294">Syntax:</a><a class="headerlink" href="#id1351" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use
<code class="docutils literal notranslate"><span class="pre">llvm.memmove.element.unordered.atomic</span></code> on any integer bit width and for
different address spaces. Not all targets support all bit widths however.</p>
<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">memmove</span><span class="o">.</span><span class="n">element</span><span class="o">.</span><span class="n">unordered</span><span class="o">.</span><span class="n">atomic</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">dest</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">src</span><span class="o">></span><span class="p">,</span>
<span class="n">i32</span> <span class="o"><</span><span class="nb">len</span><span class="o">></span><span class="p">,</span>
<span class="n">i32</span> <span class="o"><</span><span class="n">element_size</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">void</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">memmove</span><span class="o">.</span><span class="n">element</span><span class="o">.</span><span class="n">unordered</span><span class="o">.</span><span class="n">atomic</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">dest</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">src</span><span class="o">></span><span class="p">,</span>
<span class="n">i64</span> <span class="o"><</span><span class="nb">len</span><span class="o">></span><span class="p">,</span>
<span class="n">i32</span> <span class="o"><</span><span class="n">element_size</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1352">
<h5><a class="toc-backref" href="#id3295">Overview:</a><a class="headerlink" href="#id1352" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.memmove.element.unordered.atomic.*</span></code>’ intrinsic is a specialization
of the ‘<code class="docutils literal notranslate"><span class="pre">llvm.memmove.*</span></code>’ intrinsic. It differs in that the <code class="docutils literal notranslate"><span class="pre">dest</span></code> and
<code class="docutils literal notranslate"><span class="pre">src</span></code> are treated as arrays with elements that are exactly <code class="docutils literal notranslate"><span class="pre">element_size</span></code>
bytes, and the copy between buffers uses a sequence of
<a class="reference internal" href="#ordering"><span class="std std-ref">unordered atomic</span></a> load/store operations that are a positive
integer multiple of the <code class="docutils literal notranslate"><span class="pre">element_size</span></code> in size.</p>
</div>
<div class="section" id="id1353">
<h5><a class="toc-backref" href="#id3296">Arguments:</a><a class="headerlink" href="#id1353" title="Permalink to this headline">¶</a></h5>
<p>The first three arguments are the same as they are in the
<a class="reference internal" href="#int-memmove"><span class="std std-ref">@llvm.memmove</span></a> intrinsic, with the added constraint that
<code class="docutils literal notranslate"><span class="pre">len</span></code> is required to be a positive integer multiple of the <code class="docutils literal notranslate"><span class="pre">element_size</span></code>.
If <code class="docutils literal notranslate"><span class="pre">len</span></code> is not a positive integer multiple of <code class="docutils literal notranslate"><span class="pre">element_size</span></code>, then the
behaviour of the intrinsic is undefined.</p>
<p><code class="docutils literal notranslate"><span class="pre">element_size</span></code> must be a compile-time constant positive power of two no
greater than a target-specific atomic access size limit.</p>
<p>For each of the input pointers the <code class="docutils literal notranslate"><span class="pre">align</span></code> parameter attribute must be
specified. It must be a power of two no less than the <code class="docutils literal notranslate"><span class="pre">element_size</span></code>. Caller
guarantees that both the source and destination pointers are aligned to that
boundary.</p>
</div>
<div class="section" id="id1354">
<h5><a class="toc-backref" href="#id3297">Semantics:</a><a class="headerlink" href="#id1354" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.memmove.element.unordered.atomic.*</span></code>’ intrinsic copies <code class="docutils literal notranslate"><span class="pre">len</span></code> bytes
of memory from the source location to the destination location. These locations
are allowed to overlap. The memory copy is performed as a sequence of load/store
operations where each access is guaranteed to be a multiple of <code class="docutils literal notranslate"><span class="pre">element_size</span></code>
bytes wide and aligned at an <code class="docutils literal notranslate"><span class="pre">element_size</span></code> boundary.</p>
<p>The order of the copy is unspecified. The same value may be read from the source
buffer many times, but only one write is issued to the destination buffer per
element. It is well defined to have concurrent reads and writes to both source
and destination provided those reads and writes are unordered atomic when
specified.</p>
<p>This intrinsic does not provide any additional ordering guarantees over those
provided by a set of unordered loads from the source location and stores to the
destination.</p>
</div>
<div class="section" id="id1355">
<h5><a class="toc-backref" href="#id3298">Lowering:</a><a class="headerlink" href="#id1355" title="Permalink to this headline">¶</a></h5>
<p>In the most general case call to the
‘<code class="docutils literal notranslate"><span class="pre">llvm.memmove.element.unordered.atomic.*</span></code>’ is lowered to a call to the symbol
<code class="docutils literal notranslate"><span class="pre">__llvm_memmove_element_unordered_atomic_*</span></code>. Where ‘*’ is replaced with an
actual element size. See <a class="reference internal" href="Statepoints.html#rewritestatepointsforgc-intrinsic-lowering"><span class="std std-ref">RewriteStatepointsForGC intrinsic lowering</span></a> for details on GC specific
lowering.</p>
<p>The optimizer is allowed to inline the memory copy when it’s profitable to do so.</p>
</div>
</div>
<div class="section" id="llvm-memset-element-unordered-atomic-intrinsic">
<span id="int-memset-element-unordered-atomic"></span><h4><a class="toc-backref" href="#id3299">‘<code class="docutils literal notranslate"><span class="pre">llvm.memset.element.unordered.atomic</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-memset-element-unordered-atomic-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1356">
<h5><a class="toc-backref" href="#id3300">Syntax:</a><a class="headerlink" href="#id1356" title="Permalink to this headline">¶</a></h5>
<p>This is an overloaded intrinsic. You can use <code class="docutils literal notranslate"><span class="pre">llvm.memset.element.unordered.atomic</span></code> on
any integer bit width and for different address spaces. Not all targets
support all bit widths however.</p>
<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">memset</span><span class="o">.</span><span class="n">element</span><span class="o">.</span><span class="n">unordered</span><span class="o">.</span><span class="n">atomic</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">i32</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">dest</span><span class="o">></span><span class="p">,</span>
<span class="n">i8</span> <span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">,</span>
<span class="n">i32</span> <span class="o"><</span><span class="nb">len</span><span class="o">></span><span class="p">,</span>
<span class="n">i32</span> <span class="o"><</span><span class="n">element_size</span><span class="o">></span><span class="p">)</span>
<span class="n">declare</span> <span class="n">void</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">memset</span><span class="o">.</span><span class="n">element</span><span class="o">.</span><span class="n">unordered</span><span class="o">.</span><span class="n">atomic</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">i64</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span> <span class="o"><</span><span class="n">dest</span><span class="o">></span><span class="p">,</span>
<span class="n">i8</span> <span class="o"><</span><span class="n">value</span><span class="o">></span><span class="p">,</span>
<span class="n">i64</span> <span class="o"><</span><span class="nb">len</span><span class="o">></span><span class="p">,</span>
<span class="n">i32</span> <span class="o"><</span><span class="n">element_size</span><span class="o">></span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1357">
<h5><a class="toc-backref" href="#id3301">Overview:</a><a class="headerlink" href="#id1357" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.memset.element.unordered.atomic.*</span></code>’ intrinsic is a specialization of the
‘<code class="docutils literal notranslate"><span class="pre">llvm.memset.*</span></code>’ intrinsic. It differs in that the <code class="docutils literal notranslate"><span class="pre">dest</span></code> is treated as an array
with elements that are exactly <code class="docutils literal notranslate"><span class="pre">element_size</span></code> bytes, and the assignment to that array
uses uses a sequence of <a class="reference internal" href="#ordering"><span class="std std-ref">unordered atomic</span></a> store operations
that are a positive integer multiple of the <code class="docutils literal notranslate"><span class="pre">element_size</span></code> in size.</p>
</div>
<div class="section" id="id1358">
<h5><a class="toc-backref" href="#id3302">Arguments:</a><a class="headerlink" href="#id1358" title="Permalink to this headline">¶</a></h5>
<p>The first three arguments are the same as they are in the <a class="reference internal" href="#int-memset"><span class="std std-ref">@llvm.memset</span></a>
intrinsic, with the added constraint that <code class="docutils literal notranslate"><span class="pre">len</span></code> is required to be a positive integer
multiple of the <code class="docutils literal notranslate"><span class="pre">element_size</span></code>. If <code class="docutils literal notranslate"><span class="pre">len</span></code> is not a positive integer multiple of
<code class="docutils literal notranslate"><span class="pre">element_size</span></code>, then the behaviour of the intrinsic is undefined.</p>
<p><code class="docutils literal notranslate"><span class="pre">element_size</span></code> must be a compile-time constant positive power of two no greater than
target-specific atomic access size limit.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">dest</span></code> input pointer must have the <code class="docutils literal notranslate"><span class="pre">align</span></code> parameter attribute specified. It
must be a power of two no less than the <code class="docutils literal notranslate"><span class="pre">element_size</span></code>. Caller guarantees that
the destination pointer is aligned to that boundary.</p>
</div>
<div class="section" id="id1359">
<h5><a class="toc-backref" href="#id3303">Semantics:</a><a class="headerlink" href="#id1359" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.memset.element.unordered.atomic.*</span></code>’ intrinsic sets the <code class="docutils literal notranslate"><span class="pre">len</span></code> bytes of
memory starting at the destination location to the given <code class="docutils literal notranslate"><span class="pre">value</span></code>. The memory is
set with a sequence of store operations where each access is guaranteed to be a
multiple of <code class="docutils literal notranslate"><span class="pre">element_size</span></code> bytes wide and aligned at an <code class="docutils literal notranslate"><span class="pre">element_size</span></code> boundary.</p>
<p>The order of the assignment is unspecified. Only one write is issued to the
destination buffer per element. It is well defined to have concurrent reads and
writes to the destination provided those reads and writes are unordered atomic
when specified.</p>
<p>This intrinsic does not provide any additional ordering guarantees over those
provided by a set of unordered stores to the destination.</p>
</div>
<div class="section" id="id1360">
<h5><a class="toc-backref" href="#id3304">Lowering:</a><a class="headerlink" href="#id1360" title="Permalink to this headline">¶</a></h5>
<p>In the most general case call to the ‘<code class="docutils literal notranslate"><span class="pre">llvm.memset.element.unordered.atomic.*</span></code>’ is
lowered to a call to the symbol <code class="docutils literal notranslate"><span class="pre">__llvm_memset_element_unordered_atomic_*</span></code>. Where ‘*’
is replaced with an actual element size.</p>
<p>The optimizer is allowed to inline the memory assignment when it’s profitable to do so.</p>
</div>
</div>
</div>
<div class="section" id="objective-c-arc-runtime-intrinsics">
<h3><a class="toc-backref" href="#id3305">Objective-C ARC Runtime Intrinsics</a><a class="headerlink" href="#objective-c-arc-runtime-intrinsics" title="Permalink to this headline">¶</a></h3>
<p>LLVM provides intrinsics that lower to Objective-C ARC runtime entry points.
LLVM is aware of the semantics of these functions, and optimizes based on that
knowledge. You can read more about the details of Objective-C ARC <a class="reference external" href="https://clang.llvm.org/docs/AutomaticReferenceCounting.html">here</a>.</p>
<div class="section" id="llvm-objc-autorelease-intrinsic">
<h4><a class="toc-backref" href="#id3306">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.autorelease</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-objc-autorelease-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1361">
<h5><a class="toc-backref" href="#id3307">Syntax:</a><a class="headerlink" href="#id1361" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">objc</span><span class="o">.</span><span class="n">autorelease</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1362">
<h5><a class="toc-backref" href="#id3308">Lowering:</a><a class="headerlink" href="#id1362" title="Permalink to this headline">¶</a></h5>
<p>Lowers to a call to <a class="reference external" href="https://clang.llvm.org/docs/AutomaticReferenceCounting.html#arc-runtime-objc-autorelease">objc_autorelease</a>.</p>
</div>
</div>
<div class="section" id="llvm-objc-autoreleasepoolpop-intrinsic">
<h4><a class="toc-backref" href="#id3309">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.autoreleasePoolPop</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-objc-autoreleasepoolpop-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1363">
<h5><a class="toc-backref" href="#id3310">Syntax:</a><a class="headerlink" href="#id1363" 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">objc</span><span class="o">.</span><span class="n">autoreleasePoolPop</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1364">
<h5><a class="toc-backref" href="#id3311">Lowering:</a><a class="headerlink" href="#id1364" title="Permalink to this headline">¶</a></h5>
<p>Lowers to a call to <a class="reference external" href="https://clang.llvm.org/docs/AutomaticReferenceCounting.html#void-objc-autoreleasepoolpop-void-pool">objc_autoreleasePoolPop</a>.</p>
</div>
</div>
<div class="section" id="llvm-objc-autoreleasepoolpush-intrinsic">
<h4><a class="toc-backref" href="#id3312">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.autoreleasePoolPush</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-objc-autoreleasepoolpush-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1365">
<h5><a class="toc-backref" href="#id3313">Syntax:</a><a class="headerlink" href="#id1365" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">objc</span><span class="o">.</span><span class="n">autoreleasePoolPush</span><span class="p">()</span>
</pre></div>
</div>
</div>
<div class="section" id="id1366">
<h5><a class="toc-backref" href="#id3314">Lowering:</a><a class="headerlink" href="#id1366" title="Permalink to this headline">¶</a></h5>
<p>Lowers to a call to <a class="reference external" href="https://clang.llvm.org/docs/AutomaticReferenceCounting.html#void-objc-autoreleasepoolpush-void">objc_autoreleasePoolPush</a>.</p>
</div>
</div>
<div class="section" id="llvm-objc-autoreleasereturnvalue-intrinsic">
<h4><a class="toc-backref" href="#id3315">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.autoreleaseReturnValue</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-objc-autoreleasereturnvalue-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1367">
<h5><a class="toc-backref" href="#id3316">Syntax:</a><a class="headerlink" href="#id1367" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">objc</span><span class="o">.</span><span class="n">autoreleaseReturnValue</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1368">
<h5><a class="toc-backref" href="#id3317">Lowering:</a><a class="headerlink" href="#id1368" title="Permalink to this headline">¶</a></h5>
<p>Lowers to a call to <a class="reference external" href="https://clang.llvm.org/docs/AutomaticReferenceCounting.html#arc-runtime-objc-autoreleasereturnvalue">objc_autoreleaseReturnValue</a>.</p>
</div>
</div>
<div class="section" id="llvm-objc-copyweak-intrinsic">
<h4><a class="toc-backref" href="#id3318">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.copyWeak</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-objc-copyweak-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1369">
<h5><a class="toc-backref" href="#id3319">Syntax:</a><a class="headerlink" href="#id1369" 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">objc</span><span class="o">.</span><span class="n">copyWeak</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>
</pre></div>
</div>
</div>
<div class="section" id="id1370">
<h5><a class="toc-backref" href="#id3320">Lowering:</a><a class="headerlink" href="#id1370" title="Permalink to this headline">¶</a></h5>
<p>Lowers to a call to <a class="reference external" href="https://clang.llvm.org/docs/AutomaticReferenceCounting.html#void-objc-copyweak-id-dest-id-src">objc_copyWeak</a>.</p>
</div>
</div>
<div class="section" id="llvm-objc-destroyweak-intrinsic">
<h4><a class="toc-backref" href="#id3321">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.destroyWeak</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-objc-destroyweak-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1371">
<h5><a class="toc-backref" href="#id3322">Syntax:</a><a class="headerlink" href="#id1371" 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">objc</span><span class="o">.</span><span class="n">destroyWeak</span><span class="p">(</span><span class="n">i8</span><span class="o">**</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1372">
<h5><a class="toc-backref" href="#id3323">Lowering:</a><a class="headerlink" href="#id1372" title="Permalink to this headline">¶</a></h5>
<p>Lowers to a call to <a class="reference external" href="https://clang.llvm.org/docs/AutomaticReferenceCounting.html#void-objc-destroyweak-id-object">objc_destroyWeak</a>.</p>
</div>
</div>
<div class="section" id="llvm-objc-initweak-intrinsic">
<h4><a class="toc-backref" href="#id3324">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.initWeak</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-objc-initweak-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1373">
<h5><a class="toc-backref" href="#id3325">Syntax:</a><a class="headerlink" href="#id1373" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">objc</span><span class="o">.</span><span class="n">initWeak</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>
</pre></div>
</div>
</div>
<div class="section" id="id1374">
<h5><a class="toc-backref" href="#id3326">Lowering:</a><a class="headerlink" href="#id1374" title="Permalink to this headline">¶</a></h5>
<p>Lowers to a call to <a class="reference external" href="https://clang.llvm.org/docs/AutomaticReferenceCounting.html#arc-runtime-objc-initweak">objc_initWeak</a>.</p>
</div>
</div>
<div class="section" id="llvm-objc-loadweak-intrinsic">
<h4><a class="toc-backref" href="#id3327">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.loadWeak</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-objc-loadweak-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1375">
<h5><a class="toc-backref" href="#id3328">Syntax:</a><a class="headerlink" href="#id1375" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">objc</span><span class="o">.</span><span class="n">loadWeak</span><span class="p">(</span><span class="n">i8</span><span class="o">**</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1376">
<h5><a class="toc-backref" href="#id3329">Lowering:</a><a class="headerlink" href="#id1376" title="Permalink to this headline">¶</a></h5>
<p>Lowers to a call to <a class="reference external" href="https://clang.llvm.org/docs/AutomaticReferenceCounting.html#arc-runtime-objc-loadweak">objc_loadWeak</a>.</p>
</div>
</div>
<div class="section" id="llvm-objc-loadweakretained-intrinsic">
<h4><a class="toc-backref" href="#id3330">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.loadWeakRetained</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-objc-loadweakretained-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1377">
<h5><a class="toc-backref" href="#id3331">Syntax:</a><a class="headerlink" href="#id1377" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">objc</span><span class="o">.</span><span class="n">loadWeakRetained</span><span class="p">(</span><span class="n">i8</span><span class="o">**</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1378">
<h5><a class="toc-backref" href="#id3332">Lowering:</a><a class="headerlink" href="#id1378" title="Permalink to this headline">¶</a></h5>
<p>Lowers to a call to <a class="reference external" href="https://clang.llvm.org/docs/AutomaticReferenceCounting.html#arc-runtime-objc-loadweakretained">objc_loadWeakRetained</a>.</p>
</div>
</div>
<div class="section" id="llvm-objc-moveweak-intrinsic">
<h4><a class="toc-backref" href="#id3333">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.moveWeak</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-objc-moveweak-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1379">
<h5><a class="toc-backref" href="#id3334">Syntax:</a><a class="headerlink" href="#id1379" 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">objc</span><span class="o">.</span><span class="n">moveWeak</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>
</pre></div>
</div>
</div>
<div class="section" id="id1380">
<h5><a class="toc-backref" href="#id3335">Lowering:</a><a class="headerlink" href="#id1380" title="Permalink to this headline">¶</a></h5>
<p>Lowers to a call to <a class="reference external" href="https://clang.llvm.org/docs/AutomaticReferenceCounting.html#void-objc-moveweak-id-dest-id-src">objc_moveWeak</a>.</p>
</div>
</div>
<div class="section" id="llvm-objc-release-intrinsic">
<h4><a class="toc-backref" href="#id3336">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.release</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-objc-release-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1381">
<h5><a class="toc-backref" href="#id3337">Syntax:</a><a class="headerlink" href="#id1381" 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">objc</span><span class="o">.</span><span class="n">release</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1382">
<h5><a class="toc-backref" href="#id3338">Lowering:</a><a class="headerlink" href="#id1382" title="Permalink to this headline">¶</a></h5>
<p>Lowers to a call to <a class="reference external" href="https://clang.llvm.org/docs/AutomaticReferenceCounting.html#void-objc-release-id-value">objc_release</a>.</p>
</div>
</div>
<div class="section" id="llvm-objc-retain-intrinsic">
<h4><a class="toc-backref" href="#id3339">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.retain</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-objc-retain-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1383">
<h5><a class="toc-backref" href="#id3340">Syntax:</a><a class="headerlink" href="#id1383" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">objc</span><span class="o">.</span><span class="n">retain</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1384">
<h5><a class="toc-backref" href="#id3341">Lowering:</a><a class="headerlink" href="#id1384" title="Permalink to this headline">¶</a></h5>
<p>Lowers to a call to <a class="reference external" href="https://clang.llvm.org/docs/AutomaticReferenceCounting.html#arc-runtime-objc-retain">objc_retain</a>.</p>
</div>
</div>
<div class="section" id="llvm-objc-retainautorelease-intrinsic">
<h4><a class="toc-backref" href="#id3342">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.retainAutorelease</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-objc-retainautorelease-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1385">
<h5><a class="toc-backref" href="#id3343">Syntax:</a><a class="headerlink" href="#id1385" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">objc</span><span class="o">.</span><span class="n">retainAutorelease</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1386">
<h5><a class="toc-backref" href="#id3344">Lowering:</a><a class="headerlink" href="#id1386" title="Permalink to this headline">¶</a></h5>
<p>Lowers to a call to <a class="reference external" href="https://clang.llvm.org/docs/AutomaticReferenceCounting.html#arc-runtime-objc-retainautorelease">objc_retainAutorelease</a>.</p>
</div>
</div>
<div class="section" id="llvm-objc-retainautoreleasereturnvalue-intrinsic">
<h4><a class="toc-backref" href="#id3345">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.retainAutoreleaseReturnValue</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-objc-retainautoreleasereturnvalue-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1387">
<h5><a class="toc-backref" href="#id3346">Syntax:</a><a class="headerlink" href="#id1387" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">objc</span><span class="o">.</span><span class="n">retainAutoreleaseReturnValue</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1388">
<h5><a class="toc-backref" href="#id3347">Lowering:</a><a class="headerlink" href="#id1388" title="Permalink to this headline">¶</a></h5>
<p>Lowers to a call to <a class="reference external" href="https://clang.llvm.org/docs/AutomaticReferenceCounting.html#arc-runtime-objc-retainautoreleasereturnvalue">objc_retainAutoreleaseReturnValue</a>.</p>
</div>
</div>
<div class="section" id="llvm-objc-retainautoreleasedreturnvalue-intrinsic">
<h4><a class="toc-backref" href="#id3348">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.retainAutoreleasedReturnValue</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-objc-retainautoreleasedreturnvalue-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1389">
<h5><a class="toc-backref" href="#id3349">Syntax:</a><a class="headerlink" href="#id1389" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">objc</span><span class="o">.</span><span class="n">retainAutoreleasedReturnValue</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1390">
<h5><a class="toc-backref" href="#id3350">Lowering:</a><a class="headerlink" href="#id1390" title="Permalink to this headline">¶</a></h5>
<p>Lowers to a call to <a class="reference external" href="https://clang.llvm.org/docs/AutomaticReferenceCounting.html#arc-runtime-objc-retainautoreleasedreturnvalue">objc_retainAutoreleasedReturnValue</a>.</p>
</div>
</div>
<div class="section" id="llvm-objc-retainblock-intrinsic">
<h4><a class="toc-backref" href="#id3351">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.retainBlock</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-objc-retainblock-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1391">
<h5><a class="toc-backref" href="#id3352">Syntax:</a><a class="headerlink" href="#id1391" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">objc</span><span class="o">.</span><span class="n">retainBlock</span><span class="p">(</span><span class="n">i8</span><span class="o">*</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1392">
<h5><a class="toc-backref" href="#id3353">Lowering:</a><a class="headerlink" href="#id1392" title="Permalink to this headline">¶</a></h5>
<p>Lowers to a call to <a class="reference external" href="https://clang.llvm.org/docs/AutomaticReferenceCounting.html#arc-runtime-objc-retainblock">objc_retainBlock</a>.</p>
</div>
</div>
<div class="section" id="llvm-objc-storestrong-intrinsic">
<h4><a class="toc-backref" href="#id3354">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.storeStrong</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-objc-storestrong-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1393">
<h5><a class="toc-backref" href="#id3355">Syntax:</a><a class="headerlink" href="#id1393" 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">objc</span><span class="o">.</span><span class="n">storeStrong</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>
</pre></div>
</div>
</div>
<div class="section" id="id1394">
<h5><a class="toc-backref" href="#id3356">Lowering:</a><a class="headerlink" href="#id1394" title="Permalink to this headline">¶</a></h5>
<p>Lowers to a call to <a class="reference external" href="https://clang.llvm.org/docs/AutomaticReferenceCounting.html#void-objc-storestrong-id-object-id-value">objc_storeStrong</a>.</p>
</div>
</div>
<div class="section" id="llvm-objc-storeweak-intrinsic">
<h4><a class="toc-backref" href="#id3357">‘<code class="docutils literal notranslate"><span class="pre">llvm.objc.storeWeak</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-objc-storeweak-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1395">
<h5><a class="toc-backref" href="#id3358">Syntax:</a><a class="headerlink" href="#id1395" 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">i8</span><span class="o">*</span> <span class="nd">@llvm</span><span class="o">.</span><span class="n">objc</span><span class="o">.</span><span class="n">storeWeak</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>
</pre></div>
</div>
</div>
<div class="section" id="id1396">
<h5><a class="toc-backref" href="#id3359">Lowering:</a><a class="headerlink" href="#id1396" title="Permalink to this headline">¶</a></h5>
<p>Lowers to a call to <a class="reference external" href="https://clang.llvm.org/docs/AutomaticReferenceCounting.html#arc-runtime-objc-storeweak">objc_storeWeak</a>.</p>
</div>
</div>
<div class="section" id="preserving-debug-information-intrinsics">
<h4><a class="toc-backref" href="#id3360">Preserving Debug Information Intrinsics</a><a class="headerlink" href="#preserving-debug-information-intrinsics" title="Permalink to this headline">¶</a></h4>
<p>These intrinsics are used to carry certain debuginfo together with
IR-level operations. For example, it may be desirable to
know the structure/union name and the original user-level field
indices. Such information got lost in IR GetElementPtr instruction
since the IR types are different from debugInfo types and unions
are converted to structs in IR.</p>
</div>
<div class="section" id="llvm-preserve-array-access-index-intrinsic">
<h4><a class="toc-backref" href="#id3361">‘<code class="docutils literal notranslate"><span class="pre">llvm.preserve.array.access.index</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-preserve-array-access-index-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1397">
<h5><a class="toc-backref" href="#id3362">Syntax:</a><a class="headerlink" href="#id1397" 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="o"><</span><span class="n">ret_type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">preserve</span><span class="o">.</span><span class="n">array</span><span class="o">.</span><span class="n">access</span><span class="o">.</span><span class="n">index</span><span class="o">.</span><span class="n">p0s_union</span><span class="o">.</span><span class="n">anons</span><span class="o">.</span><span class="n">p0a10s_union</span><span class="o">.</span><span class="n">anons</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="n">base</span><span class="p">,</span>
<span class="n">i32</span> <span class="n">dim</span><span class="p">,</span>
<span class="n">i32</span> <span class="n">index</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1398">
<h5><a class="toc-backref" href="#id3363">Overview:</a><a class="headerlink" href="#id1398" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.preserve.array.access.index</span></code>’ intrinsic returns the getelementptr address
based on array base <code class="docutils literal notranslate"><span class="pre">base</span></code>, array dimension <code class="docutils literal notranslate"><span class="pre">dim</span></code> and the last access index <code class="docutils literal notranslate"><span class="pre">index</span></code>
into the array. The return type <code class="docutils literal notranslate"><span class="pre">ret_type</span></code> is a pointer type to the array element.
The array <code class="docutils literal notranslate"><span class="pre">dim</span></code> and <code class="docutils literal notranslate"><span class="pre">index</span></code> are preserved which is more robust than
getelementptr instruction which may be subject to compiler transformation.
The <code class="docutils literal notranslate"><span class="pre">llvm.preserve.access.index</span></code> type of metadata is attached to this call instruction
to provide array or pointer debuginfo type.
The metadata is a <code class="docutils literal notranslate"><span class="pre">DICompositeType</span></code> or <code class="docutils literal notranslate"><span class="pre">DIDerivedType</span></code> representing the
debuginfo version of <code class="docutils literal notranslate"><span class="pre">type</span></code>.</p>
</div>
<div class="section" id="id1399">
<h5><a class="toc-backref" href="#id3364">Arguments:</a><a class="headerlink" href="#id1399" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">base</span></code> is the array base address. The <code class="docutils literal notranslate"><span class="pre">dim</span></code> is the array dimension.
The <code class="docutils literal notranslate"><span class="pre">base</span></code> is a pointer if <code class="docutils literal notranslate"><span class="pre">dim</span></code> equals 0.
The <code class="docutils literal notranslate"><span class="pre">index</span></code> is the last access index into the array or pointer.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">base</span></code> argument must be annotated with an <a class="reference internal" href="#attr-elementtype"><span class="std std-ref">elementtype</span></a> attribute at the call-site. This attribute specifies the
getelementptr element type.</p>
</div>
<div class="section" id="id1400">
<h5><a class="toc-backref" href="#id3365">Semantics:</a><a class="headerlink" href="#id1400" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.preserve.array.access.index</span></code>’ intrinsic produces the same result
as a getelementptr with base <code class="docutils literal notranslate"><span class="pre">base</span></code> and access operands <code class="docutils literal notranslate"><span class="pre">{dim's</span> <span class="pre">0's,</span> <span class="pre">index}</span></code>.</p>
</div>
</div>
<div class="section" id="llvm-preserve-union-access-index-intrinsic">
<h4><a class="toc-backref" href="#id3366">‘<code class="docutils literal notranslate"><span class="pre">llvm.preserve.union.access.index</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-preserve-union-access-index-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1401">
<h5><a class="toc-backref" href="#id3367">Syntax:</a><a class="headerlink" href="#id1401" 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="o"><</span><span class="nb">type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">preserve</span><span class="o">.</span><span class="n">union</span><span class="o">.</span><span class="n">access</span><span class="o">.</span><span class="n">index</span><span class="o">.</span><span class="n">p0s_union</span><span class="o">.</span><span class="n">anons</span><span class="o">.</span><span class="n">p0s_union</span><span class="o">.</span><span class="n">anons</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="n">base</span><span class="p">,</span>
<span class="n">i32</span> <span class="n">di_index</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1402">
<h5><a class="toc-backref" href="#id3368">Overview:</a><a class="headerlink" href="#id1402" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.preserve.union.access.index</span></code>’ intrinsic carries the debuginfo field index
<code class="docutils literal notranslate"><span class="pre">di_index</span></code> and returns the <code class="docutils literal notranslate"><span class="pre">base</span></code> address.
The <code class="docutils literal notranslate"><span class="pre">llvm.preserve.access.index</span></code> type of metadata is attached to this call instruction
to provide union debuginfo type.
The metadata is a <code class="docutils literal notranslate"><span class="pre">DICompositeType</span></code> representing the debuginfo version of <code class="docutils literal notranslate"><span class="pre">type</span></code>.
The return type <code class="docutils literal notranslate"><span class="pre">type</span></code> is the same as the <code class="docutils literal notranslate"><span class="pre">base</span></code> type.</p>
</div>
<div class="section" id="id1403">
<h5><a class="toc-backref" href="#id3369">Arguments:</a><a class="headerlink" href="#id1403" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">base</span></code> is the union base address. The <code class="docutils literal notranslate"><span class="pre">di_index</span></code> is the field index in debuginfo.</p>
</div>
<div class="section" id="id1404">
<h5><a class="toc-backref" href="#id3370">Semantics:</a><a class="headerlink" href="#id1404" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.preserve.union.access.index</span></code>’ intrinsic returns the <code class="docutils literal notranslate"><span class="pre">base</span></code> address.</p>
</div>
</div>
<div class="section" id="llvm-preserve-struct-access-index-intrinsic">
<h4><a class="toc-backref" href="#id3371">‘<code class="docutils literal notranslate"><span class="pre">llvm.preserve.struct.access.index</span></code>’ Intrinsic</a><a class="headerlink" href="#llvm-preserve-struct-access-index-intrinsic" title="Permalink to this headline">¶</a></h4>
<div class="section" id="id1405">
<h5><a class="toc-backref" href="#id3372">Syntax:</a><a class="headerlink" href="#id1405" 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="o"><</span><span class="n">ret_type</span><span class="o">></span>
<span class="nd">@llvm</span><span class="o">.</span><span class="n">preserve</span><span class="o">.</span><span class="n">struct</span><span class="o">.</span><span class="n">access</span><span class="o">.</span><span class="n">index</span><span class="o">.</span><span class="n">p0i8</span><span class="o">.</span><span class="n">p0s_struct</span><span class="o">.</span><span class="n">anon</span><span class="o">.</span><span class="mi">0</span><span class="n">s</span><span class="p">(</span><span class="o"><</span><span class="nb">type</span><span class="o">></span> <span class="n">base</span><span class="p">,</span>
<span class="n">i32</span> <span class="n">gep_index</span><span class="p">,</span>
<span class="n">i32</span> <span class="n">di_index</span><span class="p">)</span>
</pre></div>
</div>
</div>
<div class="section" id="id1406">
<h5><a class="toc-backref" href="#id3373">Overview:</a><a class="headerlink" href="#id1406" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.preserve.struct.access.index</span></code>’ intrinsic returns the getelementptr address
based on struct base <code class="docutils literal notranslate"><span class="pre">base</span></code> and IR struct member index <code class="docutils literal notranslate"><span class="pre">gep_index</span></code>.
The <code class="docutils literal notranslate"><span class="pre">llvm.preserve.access.index</span></code> type of metadata is attached to this call instruction
to provide struct debuginfo type.
The metadata is a <code class="docutils literal notranslate"><span class="pre">DICompositeType</span></code> representing the debuginfo version of <code class="docutils literal notranslate"><span class="pre">type</span></code>.
The return type <code class="docutils literal notranslate"><span class="pre">ret_type</span></code> is a pointer type to the structure member.</p>
</div>
<div class="section" id="id1407">
<h5><a class="toc-backref" href="#id3374">Arguments:</a><a class="headerlink" href="#id1407" title="Permalink to this headline">¶</a></h5>
<p>The <code class="docutils literal notranslate"><span class="pre">base</span></code> is the structure base address. The <code class="docutils literal notranslate"><span class="pre">gep_index</span></code> is the struct member index
based on IR structures. The <code class="docutils literal notranslate"><span class="pre">di_index</span></code> is the struct member index based on debuginfo.</p>
<p>The <code class="docutils literal notranslate"><span class="pre">base</span></code> argument must be annotated with an <a class="reference internal" href="#attr-elementtype"><span class="std std-ref">elementtype</span></a> attribute at the call-site. This attribute specifies the
getelementptr element type.</p>
</div>
<div class="section" id="id1408">
<h5><a class="toc-backref" href="#id3375">Semantics:</a><a class="headerlink" href="#id1408" title="Permalink to this headline">¶</a></h5>
<p>The ‘<code class="docutils literal notranslate"><span class="pre">llvm.preserve.struct.access.index</span></code>’ intrinsic produces the same result
as a getelementptr with base <code class="docutils literal notranslate"><span class="pre">base</span></code> and access operands <code class="docutils literal notranslate"><span class="pre">{0,</span> <span class="pre">gep_index}</span></code>.</p>
</div>
</div>
</div>
</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="LibFuzzer.html" title="libFuzzer – a library for coverage-guided fuzz testing."
>next</a> |</li>
<li class="right" >
<a href="InAlloca.html" title="Design and Usage of the InAlloca Attribute"
>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="">LLVM Language Reference Manual</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>
|
