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
|
//===--- PullbackCloner.cpp - Pullback function generation ---*- C++ -*----===//
//
// This source file is part of the Swift.org open source project
//
// Copyright (c) 2019 - 2020 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See https://swift.org/LICENSE.txt for license information
// See https://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
//===----------------------------------------------------------------------===//
//
// This file defines a helper class for generating pullback functions for
// automatic differentiation.
//
//===----------------------------------------------------------------------===//
#include "swift/Basic/STLExtras.h"
#define DEBUG_TYPE "differentiation"
#include "swift/SILOptimizer/Differentiation/PullbackCloner.h"
#include "swift/SILOptimizer/Analysis/DifferentiableActivityAnalysis.h"
#include "swift/SILOptimizer/Differentiation/ADContext.h"
#include "swift/SILOptimizer/Differentiation/AdjointValue.h"
#include "swift/SILOptimizer/Differentiation/DifferentiationInvoker.h"
#include "swift/SILOptimizer/Differentiation/LinearMapInfo.h"
#include "swift/SILOptimizer/Differentiation/Thunk.h"
#include "swift/SILOptimizer/Differentiation/VJPCloner.h"
#include "swift/AST/Expr.h"
#include "swift/AST/PropertyWrappers.h"
#include "swift/AST/TypeCheckRequests.h"
#include "swift/SIL/InstructionUtils.h"
#include "swift/SIL/Projection.h"
#include "swift/SIL/TypeSubstCloner.h"
#include "swift/SILOptimizer/PassManager/PrettyStackTrace.h"
#include "swift/SILOptimizer/Utils/SILOptFunctionBuilder.h"
#include "llvm/ADT/DenseMap.h"
#include "llvm/ADT/SmallSet.h"
namespace swift {
class SILDifferentiabilityWitness;
class SILBasicBlock;
class SILFunction;
class SILInstruction;
namespace autodiff {
class ADContext;
class VJPCloner;
/// The implementation class for `PullbackCloner`.
///
/// The implementation class is a `SILInstructionVisitor`. Effectively, it acts
/// as a `SILCloner` that visits basic blocks in post-order and that visits
/// instructions per basic block in reverse order. This visitation order is
/// necessary for generating pullback functions, whose control flow graph is
/// ~a transposed version of the original function's control flow graph.
class PullbackCloner::Implementation final
: public SILInstructionVisitor<PullbackCloner::Implementation> {
public:
explicit Implementation(VJPCloner &vjpCloner);
private:
/// The parent VJP cloner.
VJPCloner &vjpCloner;
/// Dominance info for the original function.
DominanceInfo *domInfo = nullptr;
/// Post-dominance info for the original function.
PostDominanceInfo *postDomInfo = nullptr;
/// Post-order info for the original function.
PostOrderFunctionInfo *postOrderInfo = nullptr;
/// Mapping from original basic blocks to corresponding pullback basic blocks.
/// Pullback basic blocks always have the predecessor as the single argument.
llvm::DenseMap<SILBasicBlock *, SILBasicBlock *> pullbackBBMap;
/// Mapping from original basic blocks and original values to corresponding
/// adjoint values.
llvm::DenseMap<std::pair<SILBasicBlock *, SILValue>, AdjointValue> valueMap;
/// Mapping from original basic blocks and original values to corresponding
/// adjoint buffers.
llvm::DenseMap<std::pair<SILBasicBlock *, SILValue>, SILValue> bufferMap;
/// Mapping from pullback struct field declarations to pullback struct
/// elements destructured from the linear map basic block argument. In the
/// beginning of each pullback basic block, the block's pullback struct is
/// destructured into individual elements stored here.
llvm::DenseMap<SILBasicBlock*, SmallVector<SILValue, 4>> pullbackTupleElements;
/// Mapping from original basic blocks and successor basic blocks to
/// corresponding pullback trampoline basic blocks. Trampoline basic blocks
/// take additional arguments in addition to the predecessor enum argument.
llvm::DenseMap<std::pair<SILBasicBlock *, SILBasicBlock *>, SILBasicBlock *>
pullbackTrampolineBBMap;
/// Mapping from original basic blocks to dominated active values.
llvm::DenseMap<SILBasicBlock *, SmallVector<SILValue, 8>> activeValues;
/// Mapping from original basic blocks and original active values to
/// corresponding pullback block arguments.
llvm::DenseMap<std::pair<SILBasicBlock *, SILValue>, SILArgument *>
activeValuePullbackBBArgumentMap;
/// Mapping from original basic blocks to local temporary values to be cleaned
/// up. This is populated when pullback emission is run on one basic block and
/// cleaned before processing another basic block.
llvm::DenseMap<SILBasicBlock *, llvm::SmallSetVector<SILValue, 32>>
blockTemporaries;
/// The scope cloner.
ScopeCloner scopeCloner;
/// The main builder.
TangentBuilder builder;
/// An auxiliary local allocation builder.
TangentBuilder localAllocBuilder;
/// The original function's exit block.
SILBasicBlock *originalExitBlock = nullptr;
/// Stack buffers allocated for storing local adjoint values.
SmallVector<AllocStackInst *, 64> functionLocalAllocations;
/// A set used to remember local allocations that were destroyed.
llvm::SmallDenseSet<SILValue> destroyedLocalAllocations;
/// The seed arguments of the pullback function.
SmallVector<SILArgument *, 4> seeds;
/// The `AutoDiffLinearMapContext` object, if any.
SILValue contextValue = nullptr;
llvm::BumpPtrAllocator allocator;
bool errorOccurred = false;
ADContext &getContext() const { return vjpCloner.getContext(); }
SILModule &getModule() const { return getContext().getModule(); }
ASTContext &getASTContext() const { return getPullback().getASTContext(); }
SILFunction &getOriginal() const { return vjpCloner.getOriginal(); }
SILDifferentiabilityWitness *getWitness() const {
return vjpCloner.getWitness();
}
DifferentiationInvoker getInvoker() const { return vjpCloner.getInvoker(); }
LinearMapInfo &getPullbackInfo() const { return vjpCloner.getPullbackInfo(); }
const AutoDiffConfig &getConfig() const { return vjpCloner.getConfig(); }
const DifferentiableActivityInfo &getActivityInfo() const {
return vjpCloner.getActivityInfo();
}
//--------------------------------------------------------------------------//
// Pullback struct mapping
//--------------------------------------------------------------------------//
void initializePullbackTupleElements(SILBasicBlock *origBB,
SILInstructionResultArray values) {
auto *pbTupleTyple = getPullbackInfo().getLinearMapTupleType(origBB);
assert(pbTupleTyple->getNumElements() == values.size() &&
"The number of pullback tuple fields must equal the number of "
"pullback tuple element values");
auto res = pullbackTupleElements.insert({origBB, { values.begin(), values.end() }});
(void)res;
assert(res.second && "A pullback tuple element already exists!");
}
void initializePullbackTupleElements(SILBasicBlock *origBB,
const llvm::ArrayRef<SILArgument *> &values) {
auto *pbTupleTyple = getPullbackInfo().getLinearMapTupleType(origBB);
assert(pbTupleTyple->getNumElements() == values.size() &&
"The number of pullback tuple fields must equal the number of "
"pullback tuple element values");
auto res = pullbackTupleElements.insert({origBB, { values.begin(), values.end() }});
(void)res;
assert(res.second && "A pullback struct element already exists!");
}
/// Returns the pullback tuple element value corresponding to the given
/// original block and apply inst.
SILValue getPullbackTupleElement(ApplyInst *ai) {
unsigned idx = getPullbackInfo().lookUpLinearMapIndex(ai);
assert((idx > 0 || (idx == 0 && ai->getParentBlock()->isEntry())) &&
"impossible linear map index");
auto values = pullbackTupleElements.lookup(ai->getParentBlock());
assert(idx < values.size() &&
"pullback tuple element for this apply does not exist!");
return values[idx];
}
/// Returns the pullback tuple element value corresponding to the predecessor
/// for the given original block.
SILValue getPullbackPredTupleElement(SILBasicBlock *origBB) {
assert(!origBB->isEntry() && "no predecessors for entry block");
auto values = pullbackTupleElements.lookup(origBB);
assert(values.size() && "pullback tuple cannot be empty");
return values[0];
}
//--------------------------------------------------------------------------//
// Type transformer
//--------------------------------------------------------------------------//
/// Get the type lowering for the given AST type.
const Lowering::TypeLowering &getTypeLowering(Type type) {
auto pbGenSig =
getPullback().getLoweredFunctionType()->getSubstGenericSignature();
Lowering::AbstractionPattern pattern(pbGenSig,
type->getReducedType(pbGenSig));
return getPullback().getTypeLowering(pattern, type);
}
/// Remap any archetypes into the current function's context.
SILType remapType(SILType ty) {
if (ty.hasArchetype())
ty = ty.mapTypeOutOfContext();
auto remappedType = ty.getASTType()->getReducedType(
getPullback().getLoweredFunctionType()->getSubstGenericSignature());
auto remappedSILType =
SILType::getPrimitiveType(remappedType, ty.getCategory());
// FIXME: Sometimes getPullback() doesn't have a generic environment, in which
// case callers are apparently happy to receive an interface type.
if (getPullback().getGenericEnvironment())
return getPullback().mapTypeIntoContext(remappedSILType);
return remappedSILType;
}
std::optional<TangentSpace> getTangentSpace(CanType type) {
// Use witness generic signature to remap types.
type =
getWitness()->getDerivativeGenericSignature().getReducedType(
type);
return type->getAutoDiffTangentSpace(
LookUpConformanceInModule(getModule().getSwiftModule()));
}
/// Returns the tangent value category of the given value.
SILValueCategory getTangentValueCategory(SILValue v) {
// Tangent value category table:
//
// Let $L be a loadable type and $*A be an address-only type.
//
// Original type | Tangent type loadable? | Tangent value category and type
// --------------|------------------------|--------------------------------
// $L | loadable | object, $L' (no mismatch)
// $*A | loadable | address, $*L' (create a buffer)
// $L | address-only | address, $*A' (no alternative)
// $*A | address-only | address, $*A' (no alternative)
// TODO(https://github.com/apple/swift/issues/55523): Make "tangent value category" depend solely on whether the tangent type is loadable or address-only.
//
// For loadable tangent types, using symbolic adjoint values instead of
// concrete adjoint buffers is more efficient.
// Quick check: if the value has an address type, the tangent value category
// is currently always "address".
if (v->getType().isAddress())
return SILValueCategory::Address;
// If the value has an object type and the tangent type is not address-only,
// then the tangent value category is "object".
auto tanSpace = getTangentSpace(remapType(v->getType()).getASTType());
auto tanASTType = tanSpace->getCanonicalType();
if (v->getType().isObject() && getTypeLowering(tanASTType).isLoadable())
return SILValueCategory::Object;
// Otherwise, the tangent value category is "address".
return SILValueCategory::Address;
}
/// Assuming the given type conforms to `Differentiable` after remapping,
/// returns the associated tangent space type.
SILType getRemappedTangentType(SILType type) {
return SILType::getPrimitiveType(
getTangentSpace(remapType(type).getASTType())->getCanonicalType(),
type.getCategory());
}
/// Substitutes all replacement types of the given substitution map using the
/// pullback function's substitution map.
SubstitutionMap remapSubstitutionMap(SubstitutionMap substMap) {
return substMap.subst(getPullback().getForwardingSubstitutionMap());
}
//--------------------------------------------------------------------------//
// Temporary value management
//--------------------------------------------------------------------------//
/// Record a temporary value for cleanup before its block's terminator.
SILValue recordTemporary(SILValue value) {
assert(value->getType().isObject());
assert(value->getFunction() == &getPullback());
auto inserted = blockTemporaries[value->getParentBlock()].insert(value);
(void)inserted;
LLVM_DEBUG(getADDebugStream() << "Recorded temporary " << value);
assert(inserted && "Temporary already recorded?");
return value;
}
/// Clean up all temporary values for the given pullback block.
void cleanUpTemporariesForBlock(SILBasicBlock *bb, SILLocation loc) {
assert(bb->getParent() == &getPullback());
LLVM_DEBUG(getADDebugStream() << "Cleaning up temporaries for pullback bb"
<< bb->getDebugID() << '\n');
for (auto temp : blockTemporaries[bb])
builder.emitDestroyValueOperation(loc, temp);
blockTemporaries[bb].clear();
}
//--------------------------------------------------------------------------//
// Adjoint value factory methods
//--------------------------------------------------------------------------//
AdjointValue makeZeroAdjointValue(SILType type) {
return AdjointValue::createZero(allocator, remapType(type));
}
AdjointValue makeConcreteAdjointValue(SILValue value) {
return AdjointValue::createConcrete(allocator, value);
}
AdjointValue makeAggregateAdjointValue(SILType type,
ArrayRef<AdjointValue> elements) {
return AdjointValue::createAggregate(allocator, remapType(type), elements);
}
AdjointValue makeAddElementAdjointValue(AdjointValue baseAdjoint,
AdjointValue eltToAdd,
FieldLocator fieldLocator) {
auto *addElementValue =
new AddElementValue(baseAdjoint, eltToAdd, fieldLocator);
return AdjointValue::createAddElement(allocator, baseAdjoint.getType(),
addElementValue);
}
//--------------------------------------------------------------------------//
// Adjoint value materialization
//--------------------------------------------------------------------------//
/// Materializes an adjoint value. The type of the given adjoint value must be
/// loadable.
SILValue materializeAdjointDirect(AdjointValue val, SILLocation loc) {
assert(val.getType().isObject());
LLVM_DEBUG(getADDebugStream()
<< "Materializing adjoint for " << val << '\n');
SILValue result;
switch (val.getKind()) {
case AdjointValueKind::Zero:
result = recordTemporary(builder.emitZero(loc, val.getSwiftType()));
break;
case AdjointValueKind::Aggregate: {
SmallVector<SILValue, 8> elements;
for (auto i : range(val.getNumAggregateElements())) {
auto eltVal = materializeAdjointDirect(val.getAggregateElement(i), loc);
elements.push_back(builder.emitCopyValueOperation(loc, eltVal));
}
if (val.getType().is<TupleType>())
result = recordTemporary(
builder.createTuple(loc, val.getType(), elements));
else
result = recordTemporary(
builder.createStruct(loc, val.getType(), elements));
break;
}
case AdjointValueKind::Concrete:
result = val.getConcreteValue();
break;
case AdjointValueKind::AddElement: {
auto adjointSILType = val.getAddElementValue()->baseAdjoint.getType();
auto *baseAdjAlloc = builder.createAllocStack(loc, adjointSILType);
materializeAdjointIndirect(val, baseAdjAlloc, loc);
auto baseAdjConcrete = recordTemporary(builder.emitLoadValueOperation(
loc, baseAdjAlloc, LoadOwnershipQualifier::Take));
builder.createDeallocStack(loc, baseAdjAlloc);
result = baseAdjConcrete;
break;
}
}
if (auto debugInfo = val.getDebugInfo())
builder.createDebugValue(
debugInfo->first.getLocation(), result, debugInfo->second);
return result;
}
/// Materializes an adjoint value indirectly to a SIL buffer.
void materializeAdjointIndirect(AdjointValue val, SILValue destAddress,
SILLocation loc) {
assert(destAddress->getType().isAddress());
switch (val.getKind()) {
/// If adjoint value is a symbolic zero, emit a call to
/// `AdditiveArithmetic.zero`.
case AdjointValueKind::Zero:
builder.emitZeroIntoBuffer(loc, destAddress, IsInitialization);
break;
/// If adjoint value is a symbolic aggregate (tuple or struct), recursively
/// materialize the symbolic tuple or struct, filling the
/// buffer.
case AdjointValueKind::Aggregate: {
if (auto *tupTy = val.getSwiftType()->getAs<TupleType>()) {
for (auto idx : range(val.getNumAggregateElements())) {
auto eltTy = SILType::getPrimitiveAddressType(
tupTy->getElementType(idx)->getCanonicalType());
auto *eltBuf =
builder.createTupleElementAddr(loc, destAddress, idx, eltTy);
materializeAdjointIndirect(val.getAggregateElement(idx), eltBuf, loc);
}
} else if (auto *structDecl =
val.getSwiftType()->getStructOrBoundGenericStruct()) {
auto fieldIt = structDecl->getStoredProperties().begin();
for (unsigned i = 0; fieldIt != structDecl->getStoredProperties().end();
++fieldIt, ++i) {
auto eltBuf =
builder.createStructElementAddr(loc, destAddress, *fieldIt);
materializeAdjointIndirect(val.getAggregateElement(i), eltBuf, loc);
}
} else {
llvm_unreachable("Not an aggregate type");
}
break;
}
/// If adjoint value is concrete, it is already materialized. Store it in
/// the destination address.
case AdjointValueKind::Concrete: {
auto concreteVal = val.getConcreteValue();
auto copyOfConcreteVal = builder.emitCopyValueOperation(loc, concreteVal);
builder.emitStoreValueOperation(loc, copyOfConcreteVal, destAddress,
StoreOwnershipQualifier::Init);
break;
}
case AdjointValueKind::AddElement: {
auto baseAdjoint = val;
auto baseAdjointType = baseAdjoint.getType();
// Current adjoint may be made up of layers of `AddElement` adjoints.
// We can iteratively gather the list of elements to add instead of making
// recursive calls to `materializeAdjointIndirect`.
SmallVector<AddElementValue *, 4> addEltAdjValues;
do {
auto addElementValue = baseAdjoint.getAddElementValue();
addEltAdjValues.push_back(addElementValue);
baseAdjoint = addElementValue->baseAdjoint;
assert(baseAdjointType == baseAdjoint.getType());
} while (baseAdjoint.getKind() == AdjointValueKind::AddElement);
materializeAdjointIndirect(baseAdjoint, destAddress, loc);
for (auto *addElementValue : addEltAdjValues) {
auto eltToAdd = addElementValue->eltToAdd;
SILValue baseAdjEltAddr;
if (baseAdjoint.getType().is<TupleType>()) {
baseAdjEltAddr = builder.createTupleElementAddr(
loc, destAddress, addElementValue->getFieldIndex());
} else {
baseAdjEltAddr = builder.createStructElementAddr(
loc, destAddress, addElementValue->getFieldDecl());
}
auto eltToAddMaterialized = materializeAdjointDirect(eltToAdd, loc);
// Copy `eltToAddMaterialized` so we have a value with owned ownership
// semantics, required for using `eltToAddMaterialized` in a `store`
// instruction.
auto eltToAddMaterializedCopy =
builder.emitCopyValueOperation(loc, eltToAddMaterialized);
auto *eltToAddAlloc = builder.createAllocStack(loc, eltToAdd.getType());
builder.emitStoreValueOperation(loc, eltToAddMaterializedCopy,
eltToAddAlloc,
StoreOwnershipQualifier::Init);
builder.emitInPlaceAdd(loc, baseAdjEltAddr, eltToAddAlloc);
builder.createDestroyAddr(loc, eltToAddAlloc);
builder.createDeallocStack(loc, eltToAddAlloc);
}
break;
}
}
}
//--------------------------------------------------------------------------//
// Adjoint value mapping
//--------------------------------------------------------------------------//
/// Returns true if the given value in the original function has a
/// corresponding adjoint value.
bool hasAdjointValue(SILBasicBlock *origBB, SILValue originalValue) const {
assert(origBB->getParent() == &getOriginal());
assert(originalValue->getType().isObject());
return valueMap.count({origBB, originalValue});
}
/// Initializes the adjoint value for the original value. Asserts that the
/// original value does not already have an adjoint value.
void setAdjointValue(SILBasicBlock *origBB, SILValue originalValue,
AdjointValue adjointValue) {
LLVM_DEBUG(getADDebugStream()
<< "Setting adjoint value for " << originalValue);
assert(origBB->getParent() == &getOriginal());
assert(originalValue->getType().isObject());
assert(getTangentValueCategory(originalValue) == SILValueCategory::Object);
assert(adjointValue.getType().isObject());
assert(originalValue->getFunction() == &getOriginal());
// The adjoint value must be in the tangent space.
assert(adjointValue.getType() ==
getRemappedTangentType(originalValue->getType()));
// Try to assign a debug variable.
if (auto debugInfo = findDebugLocationAndVariable(originalValue)) {
LLVM_DEBUG({
auto &s = getADDebugStream();
s << "Found debug variable: \"" << debugInfo->second.Name
<< "\"\nLocation: ";
debugInfo->first.getLocation().print(s, getASTContext().SourceMgr);
s << '\n';
});
adjointValue.setDebugInfo(*debugInfo);
} else {
LLVM_DEBUG(getADDebugStream() << "No debug variable found.\n");
}
// Insert into dictionary.
auto insertion =
valueMap.try_emplace({origBB, originalValue}, adjointValue);
LLVM_DEBUG(getADDebugStream()
<< "The new adjoint value, replacing the existing one, is: "
<< insertion.first->getSecond() << '\n');
if (!insertion.second)
insertion.first->getSecond() = adjointValue;
}
/// Returns the adjoint value for a value in the original function.
///
/// This method first tries to find an existing entry in the adjoint value
/// mapping. If no entry exists, creates a zero adjoint value.
AdjointValue getAdjointValue(SILBasicBlock *origBB, SILValue originalValue) {
assert(origBB->getParent() == &getOriginal());
assert(originalValue->getType().isObject());
assert(getTangentValueCategory(originalValue) == SILValueCategory::Object);
assert(originalValue->getFunction() == &getOriginal());
auto insertion = valueMap.try_emplace(
{origBB, originalValue},
makeZeroAdjointValue(getRemappedTangentType(originalValue->getType())));
auto it = insertion.first;
return it->getSecond();
}
/// Adds `newAdjointValue` to the adjoint value for `originalValue` and sets
/// the sum as the new adjoint value.
void addAdjointValue(SILBasicBlock *origBB, SILValue originalValue,
AdjointValue newAdjointValue, SILLocation loc) {
assert(origBB->getParent() == &getOriginal());
assert(originalValue->getType().isObject());
assert(newAdjointValue.getType().isObject());
assert(originalValue->getFunction() == &getOriginal());
LLVM_DEBUG(getADDebugStream()
<< "Adding adjoint value for " << originalValue);
// The adjoint value must be in the tangent space.
assert(newAdjointValue.getType() ==
getRemappedTangentType(originalValue->getType()));
// Try to assign a debug variable.
if (auto debugInfo = findDebugLocationAndVariable(originalValue)) {
LLVM_DEBUG({
auto &s = getADDebugStream();
s << "Found debug variable: \"" << debugInfo->second.Name
<< "\"\nLocation: ";
debugInfo->first.getLocation().print(s, getASTContext().SourceMgr);
s << '\n';
});
newAdjointValue.setDebugInfo(*debugInfo);
} else {
LLVM_DEBUG(getADDebugStream() << "No debug variable found.\n");
}
auto insertion =
valueMap.try_emplace({origBB, originalValue}, newAdjointValue);
auto inserted = insertion.second;
if (inserted)
return;
// If adjoint already exists, accumulate the adjoint onto the existing
// adjoint.
auto it = insertion.first;
auto existingValue = it->getSecond();
valueMap.erase(it);
auto adjVal = accumulateAdjointsDirect(existingValue, newAdjointValue, loc);
// If the original value is the `Array` result of an
// `array.uninitialized_intrinsic` application, accumulate adjoint buffers
// for the array element addresses.
accumulateArrayLiteralElementAddressAdjoints(origBB, originalValue, adjVal,
loc);
setAdjointValue(origBB, originalValue, adjVal);
}
/// Get the pullback block argument corresponding to the given original block
/// and active value.
SILArgument *getActiveValuePullbackBlockArgument(SILBasicBlock *origBB,
SILValue activeValue) {
assert(getTangentValueCategory(activeValue) == SILValueCategory::Object);
assert(origBB->getParent() == &getOriginal());
auto pullbackBBArg =
activeValuePullbackBBArgumentMap[{origBB, activeValue}];
assert(pullbackBBArg);
assert(pullbackBBArg->getParent() == getPullbackBlock(origBB));
return pullbackBBArg;
}
//--------------------------------------------------------------------------//
// Adjoint value accumulation
//--------------------------------------------------------------------------//
/// Given two adjoint values, accumulates them and returns their sum.
AdjointValue accumulateAdjointsDirect(AdjointValue lhs, AdjointValue rhs,
SILLocation loc);
//--------------------------------------------------------------------------//
// Adjoint buffer mapping
//--------------------------------------------------------------------------//
/// If the given original value is an address projection, returns a
/// corresponding adjoint projection to be used as its adjoint buffer.
///
/// Helper function for `getAdjointBuffer`.
SILValue getAdjointProjection(SILBasicBlock *origBB, SILValue originalValue);
/// Returns the adjoint buffer for the original value.
///
/// This method first tries to find an existing entry in the adjoint buffer
/// mapping. If no entry exists, creates a zero adjoint buffer.
SILValue getAdjointBuffer(SILBasicBlock *origBB, SILValue originalValue) {
assert(getTangentValueCategory(originalValue) == SILValueCategory::Address);
assert(originalValue->getFunction() == &getOriginal());
auto insertion = bufferMap.try_emplace({origBB, originalValue}, SILValue());
if (!insertion.second) // not inserted
return insertion.first->getSecond();
// If the original buffer is a projection, return a corresponding projection
// into the adjoint buffer.
if (auto adjProj = getAdjointProjection(origBB, originalValue))
return (bufferMap[{origBB, originalValue}] = adjProj);
LLVM_DEBUG(getADDebugStream() << "Creating new adjoint buffer for "
<< originalValue
<< "in bb" << origBB->getDebugID() << '\n');
auto bufType = getRemappedTangentType(originalValue->getType());
// Set insertion point for local allocation builder: before the last local
// allocation, or at the start of the pullback function's entry if no local
// allocations exist yet.
auto debugInfo = findDebugLocationAndVariable(originalValue);
SILLocation loc = debugInfo ? debugInfo->first.getLocation()
: RegularLocation::getAutoGeneratedLocation();
llvm::SmallString<32> adjName;
auto *newBuf = createFunctionLocalAllocation(
bufType, loc, /*zeroInitialize*/ true,
swift::transform(debugInfo,
[&](AdjointValue::DebugInfo di) {
llvm::raw_svector_ostream adjNameStream(adjName);
SILDebugVariable &dv = di.second;
dv.ArgNo = 0;
adjNameStream << "derivative of '" << dv.Name << "'";
if (SILDebugLocation origBBLoc = origBB->front().getDebugLocation()) {
adjNameStream << " in scope at ";
origBBLoc.getLocation().print(adjNameStream, getASTContext().SourceMgr);
}
adjNameStream << " (scope #" << origBB->getDebugID() << ")";
dv.Name = adjName;
// We have no meaningful debug location, and the type is different.
dv.Scope = nullptr;
dv.Loc = {};
dv.Type = {};
dv.DIExpr = {};
return dv;
}));
return (insertion.first->getSecond() = newBuf);
}
/// Initializes the adjoint buffer for the original value. Asserts that the
/// original value does not already have an adjoint buffer.
void setAdjointBuffer(SILBasicBlock *origBB, SILValue originalValue,
SILValue adjointBuffer) {
assert(getTangentValueCategory(originalValue) == SILValueCategory::Address);
auto insertion =
bufferMap.try_emplace({origBB, originalValue}, adjointBuffer);
assert(insertion.second && "Adjoint buffer already exists");
(void)insertion;
}
/// Accumulates `rhsAddress` into the adjoint buffer corresponding to the
/// original value.
void addToAdjointBuffer(SILBasicBlock *origBB, SILValue originalValue,
SILValue rhsAddress, SILLocation loc) {
assert(getTangentValueCategory(originalValue) ==
SILValueCategory::Address &&
rhsAddress->getType().isAddress());
assert(originalValue->getFunction() == &getOriginal());
assert(rhsAddress->getFunction() == &getPullback());
auto adjointBuffer = getAdjointBuffer(origBB, originalValue);
LLVM_DEBUG(getADDebugStream() << "Adding"
<< rhsAddress << "to adjoint ("
<< adjointBuffer << ") of "
<< originalValue
<< "in bb" << origBB->getDebugID() << '\n');
builder.emitInPlaceAdd(loc, adjointBuffer, rhsAddress);
}
/// Returns a next insertion point for creating a local allocation: either
/// before the previous local allocation, or at the start of the pullback
/// entry if no local allocations exist.
///
/// Helper for `createFunctionLocalAllocation`.
SILBasicBlock::iterator getNextFunctionLocalAllocationInsertionPoint() {
// If there are no local allocations, insert at the pullback entry start.
if (functionLocalAllocations.empty())
return getPullback().getEntryBlock()->begin();
// Otherwise, insert before the last local allocation. Inserting before
// rather than after ensures that allocation and zero initialization
// instructions are grouped together.
auto lastLocalAlloc = functionLocalAllocations.back();
return lastLocalAlloc->getDefiningInstruction()->getIterator();
}
/// Creates and returns a local allocation with the given type.
///
/// Local allocations are created uninitialized in the pullback entry and
/// deallocated in the pullback exit. All local allocations not in
/// `destroyedLocalAllocations` are also destroyed in the pullback exit.
///
/// Helper for `getAdjointBuffer`.
AllocStackInst *createFunctionLocalAllocation(
SILType type, SILLocation loc, bool zeroInitialize = false,
std::optional<SILDebugVariable> varInfo = std::nullopt) {
// Set insertion point for local allocation builder: before the last local
// allocation, or at the start of the pullback function's entry if no local
// allocations exist yet.
localAllocBuilder.setInsertionPoint(
getPullback().getEntryBlock(),
getNextFunctionLocalAllocationInsertionPoint());
// Create and return local allocation.
auto *alloc = localAllocBuilder.createAllocStack(loc, type, varInfo);
functionLocalAllocations.push_back(alloc);
// Zero-initialize if requested.
if (zeroInitialize)
localAllocBuilder.emitZeroIntoBuffer(loc, alloc, IsInitialization);
return alloc;
}
//--------------------------------------------------------------------------//
// Optional differentiation
//--------------------------------------------------------------------------//
/// Given a `wrappedAdjoint` value of type `T.TangentVector` and `Optional<T>`
/// type, creates an `Optional<T>.TangentVector` buffer from it.
///
/// `wrappedAdjoint` may be an object or address value, both cases are
/// handled.
AllocStackInst *createOptionalAdjoint(SILBasicBlock *bb,
SILValue wrappedAdjoint,
SILType optionalTy);
/// Accumulate optional buffer from `wrappedAdjoint`.
void accumulateAdjointForOptionalBuffer(SILBasicBlock *bb,
SILValue optionalBuffer,
SILValue wrappedAdjoint);
/// Set optional value from `wrappedAdjoint`.
void setAdjointValueForOptional(SILBasicBlock *bb, SILValue optionalValue,
SILValue wrappedAdjoint);
//--------------------------------------------------------------------------//
// Array literal initialization differentiation
//--------------------------------------------------------------------------//
/// Given the adjoint value of an array initialized from an
/// `array.uninitialized_intrinsic` application and an array element index,
/// returns an `alloc_stack` containing the adjoint value of the array element
/// at the given index by applying `Array.TangentVector.subscript`.
AllocStackInst *getArrayAdjointElementBuffer(SILValue arrayAdjoint,
int eltIndex, SILLocation loc);
/// Given the adjoint value of an array initialized from an
/// `array.uninitialized_intrinsic` application, accumulates the adjoint
/// value's elements into the adjoint buffers of its element addresses.
void accumulateArrayLiteralElementAddressAdjoints(
SILBasicBlock *origBB, SILValue originalValue,
AdjointValue arrayAdjointValue, SILLocation loc);
//--------------------------------------------------------------------------//
// CFG mapping
//--------------------------------------------------------------------------//
SILBasicBlock *getPullbackBlock(SILBasicBlock *originalBlock) {
return pullbackBBMap.lookup(originalBlock);
}
SILBasicBlock *getPullbackTrampolineBlock(SILBasicBlock *originalBlock,
SILBasicBlock *successorBlock) {
return pullbackTrampolineBBMap.lookup({originalBlock, successorBlock});
}
//--------------------------------------------------------------------------//
// Debug info
//--------------------------------------------------------------------------//
const SILDebugScope *remapScope(const SILDebugScope *DS) {
return scopeCloner.getOrCreateClonedScope(DS);
}
//--------------------------------------------------------------------------//
// Debugging utilities
//--------------------------------------------------------------------------//
void printAdjointValueMapping() {
// Group original/adjoint values by basic block.
llvm::DenseMap<SILBasicBlock *, llvm::DenseMap<SILValue, AdjointValue>> tmp;
for (auto pair : valueMap) {
auto origPair = pair.first;
auto *origBB = origPair.first;
auto origValue = origPair.second;
auto adjValue = pair.second;
tmp[origBB].insert({origValue, adjValue});
}
// Print original/adjoint values per basic block.
auto &s = getADDebugStream() << "Adjoint value mapping:\n";
for (auto &origBB : getOriginal()) {
if (!pullbackBBMap.count(&origBB))
continue;
auto bbValueMap = tmp[&origBB];
s << "bb" << origBB.getDebugID();
s << " (size " << bbValueMap.size() << "):\n";
for (auto valuePair : bbValueMap) {
auto origValue = valuePair.first;
auto adjValue = valuePair.second;
s << "ORIG: " << origValue;
s << "ADJ: " << adjValue << '\n';
}
s << '\n';
}
}
void printAdjointBufferMapping() {
// Group original/adjoint buffers by basic block.
llvm::DenseMap<SILBasicBlock *, llvm::DenseMap<SILValue, SILValue>> tmp;
for (auto pair : bufferMap) {
auto origPair = pair.first;
auto *origBB = origPair.first;
auto origBuf = origPair.second;
auto adjBuf = pair.second;
tmp[origBB][origBuf] = adjBuf;
}
// Print original/adjoint buffers per basic block.
auto &s = getADDebugStream() << "Adjoint buffer mapping:\n";
for (auto &origBB : getOriginal()) {
if (!pullbackBBMap.count(&origBB))
continue;
auto bbBufferMap = tmp[&origBB];
s << "bb" << origBB.getDebugID();
s << " (size " << bbBufferMap.size() << "):\n";
for (auto valuePair : bbBufferMap) {
auto origBuf = valuePair.first;
auto adjBuf = valuePair.second;
s << "ORIG: " << origBuf;
s << "ADJ: " << adjBuf << '\n';
}
s << '\n';
}
}
public:
//--------------------------------------------------------------------------//
// Entry point
//--------------------------------------------------------------------------//
/// Performs pullback generation on the empty pullback function. Returns true
/// if any error occurs.
bool run();
/// Performs pullback generation on the empty pullback function, given that
/// the original function is a "semantic member accessor".
///
/// "Semantic member accessors" are attached to member properties that have a
/// corresponding tangent stored property in the parent `TangentVector` type.
/// These accessors have special-case pullback generation based on their
/// semantic behavior.
///
/// Returns true if any error occurs.
bool runForSemanticMemberAccessor();
bool runForSemanticMemberGetter();
bool runForSemanticMemberSetter();
/// If original result is non-varied, it will always have a zero derivative.
/// Skip full pullback generation and simply emit zero derivatives for wrt
/// parameters.
void emitZeroDerivativesForNonvariedResult(SILValue origNonvariedResult);
/// Public helper so that our users can get the underlying newly created
/// function.
SILFunction &getPullback() const { return vjpCloner.getPullback(); }
using TrampolineBlockSet = SmallPtrSet<SILBasicBlock *, 4>;
/// Determines the pullback successor block for a given original block and one
/// of its predecessors. When a trampoline block is necessary, emits code into
/// the trampoline block to trampoline the original block's active value's
/// adjoint values.
///
/// Populates `pullbackTrampolineBlockMap`, which maps active values' adjoint
/// values to the pullback successor blocks in which they are used. This
/// allows us to release those values in pullback successor blocks that do not
/// use them.
SILBasicBlock *
buildPullbackSuccessor(SILBasicBlock *origBB, SILBasicBlock *origPredBB,
llvm::SmallDenseMap<SILValue, TrampolineBlockSet>
&pullbackTrampolineBlockMap);
/// Emits pullback code in the corresponding pullback block.
void visitSILBasicBlock(SILBasicBlock *bb);
void visit(SILInstruction *inst) {
if (errorOccurred)
return;
LLVM_DEBUG(getADDebugStream()
<< "PullbackCloner visited:\n[ORIG]" << *inst);
#ifndef NDEBUG
auto beforeInsertion = std::prev(builder.getInsertionPoint());
#endif
SILInstructionVisitor::visit(inst);
LLVM_DEBUG({
auto &s = llvm::dbgs() << "[ADJ] Emitted in pullback (pb bb" <<
builder.getInsertionBB()->getDebugID() << "):\n";
auto afterInsertion = builder.getInsertionPoint();
for (auto it = ++beforeInsertion; it != afterInsertion; ++it)
s << *it;
});
}
/// Fallback instruction visitor for unhandled instructions.
/// Emit a general non-differentiability diagnostic.
void visitSILInstruction(SILInstruction *inst) {
LLVM_DEBUG(getADDebugStream()
<< "Unhandled instruction in PullbackCloner: " << *inst);
getContext().emitNondifferentiabilityError(
inst, getInvoker(), diag::autodiff_expression_not_differentiable_note);
errorOccurred = true;
}
/// Handle `apply` instruction.
/// Original: (y0, y1, ...) = apply @fn (x0, x1, ...)
/// Adjoint: (adj[x0], adj[x1], ...) += apply @fn_pullback (adj[y0], ...)
void visitApplyInst(ApplyInst *ai) {
assert(getPullbackInfo().shouldDifferentiateApplySite(ai));
// Skip `array.uninitialized_intrinsic` applications, which have special
// `store` and `copy_addr` support.
if (ArraySemanticsCall(ai, semantics::ARRAY_UNINITIALIZED_INTRINSIC))
return;
auto loc = ai->getLoc();
auto *bb = ai->getParent();
// Handle `array.finalize_intrinsic` applications.
// `array.finalize_intrinsic` semantically behaves like an identity
// function.
if (ArraySemanticsCall(ai, semantics::ARRAY_FINALIZE_INTRINSIC)) {
assert(ai->getNumArguments() == 1 &&
"Expected intrinsic to have one operand");
// Accumulate result's adjoint into argument's adjoint.
auto adjResult = getAdjointValue(bb, ai);
auto origArg = ai->getArgumentsWithoutIndirectResults().front();
addAdjointValue(bb, origArg, adjResult, loc);
return;
}
// Replace a call to a function with a call to its pullback.
auto &nestedApplyInfo = getContext().getNestedApplyInfo();
auto applyInfoLookup = nestedApplyInfo.find(ai);
// If no `NestedApplyInfo` was found, then this task doesn't need to be
// differentiated.
if (applyInfoLookup == nestedApplyInfo.end()) {
// Must not be active.
assert(!getActivityInfo().isActive(ai, getConfig()));
return;
}
auto applyInfo = applyInfoLookup->getSecond();
// Get the original result of the `apply` instruction.
SmallVector<SILValue, 8> origDirectResults;
forEachApplyDirectResult(ai, [&](SILValue directResult) {
origDirectResults.push_back(directResult);
});
SmallVector<SILValue, 8> origAllResults;
collectAllActualResultsInTypeOrder(ai, origDirectResults, origAllResults);
// Append semantic result arguments after original results.
for (auto paramIdx : applyInfo.config.parameterIndices->getIndices()) {
auto paramInfo = ai->getSubstCalleeConv().getParamInfoForSILArg(
ai->getNumIndirectResults() + paramIdx);
if (!paramInfo.isAutoDiffSemanticResult())
continue;
origAllResults.push_back(
ai->getArgumentsWithoutIndirectResults()[paramIdx]);
}
// Get callee pullback arguments.
SmallVector<SILValue, 8> args;
// Handle callee pullback indirect results.
// Create local allocations for these and destroy them after the call.
auto pullback = getPullbackTupleElement(ai);
auto pullbackType =
remapType(pullback->getType()).castTo<SILFunctionType>();
auto actualPullbackType = applyInfo.originalPullbackType
? *applyInfo.originalPullbackType
: pullbackType;
actualPullbackType = actualPullbackType->getUnsubstitutedType(getModule());
SmallVector<AllocStackInst *, 4> pullbackIndirectResults;
for (auto indRes : actualPullbackType->getIndirectFormalResults()) {
auto *alloc = builder.createAllocStack(
loc, remapType(indRes.getSILStorageInterfaceType()));
pullbackIndirectResults.push_back(alloc);
args.push_back(alloc);
}
// Collect callee pullback formal arguments.
for (auto resultIndex : applyInfo.config.resultIndices->getIndices()) {
assert(resultIndex < origAllResults.size());
auto origResult = origAllResults[resultIndex];
// Get the seed (i.e. adjoint value of the original result).
SILValue seed;
switch (getTangentValueCategory(origResult)) {
case SILValueCategory::Object:
seed = materializeAdjointDirect(getAdjointValue(bb, origResult), loc);
break;
case SILValueCategory::Address:
seed = getAdjointBuffer(bb, origResult);
break;
}
args.push_back(seed);
}
// If callee pullback was reabstracted in VJP, reabstract callee pullback.
if (applyInfo.originalPullbackType) {
SILOptFunctionBuilder fb(getContext().getTransform());
pullback = reabstractFunction(
builder, fb, loc, pullback, *applyInfo.originalPullbackType,
[this](SubstitutionMap subs) -> SubstitutionMap {
return this->remapSubstitutionMap(subs);
});
}
// Call the callee pullback.
auto *pullbackCall = builder.createApply(loc, pullback, SubstitutionMap(),
args);
builder.emitDestroyValueOperation(loc, pullback);
// Extract all results from `pullbackCall`.
SmallVector<SILValue, 8> dirResults;
extractAllElements(pullbackCall, builder, dirResults);
// Get all results in type-defined order.
SmallVector<SILValue, 8> allResults;
collectAllActualResultsInTypeOrder(pullbackCall, dirResults, allResults);
LLVM_DEBUG({
auto &s = getADDebugStream();
s << "All results of the nested pullback call:\n";
llvm::for_each(allResults, [&](SILValue v) { s << v; });
});
// Accumulate adjoints for original differentiation parameters.
auto allResultsIt = allResults.begin();
for (unsigned i : applyInfo.config.parameterIndices->getIndices()) {
auto origArg = ai->getArgument(ai->getNumIndirectResults() + i);
// Skip adjoint accumulation for semantic results arguments.
auto paramInfo = ai->getSubstCalleeConv().getParamInfoForSILArg(
ai->getNumIndirectResults() + i);
if (paramInfo.isAutoDiffSemanticResult())
continue;
auto tan = *allResultsIt++;
if (tan->getType().isAddress()) {
addToAdjointBuffer(bb, origArg, tan, loc);
} else {
if (origArg->getType().isAddress()) {
auto *tmpBuf = builder.createAllocStack(loc, tan->getType());
builder.emitStoreValueOperation(loc, tan, tmpBuf,
StoreOwnershipQualifier::Init);
addToAdjointBuffer(bb, origArg, tmpBuf, loc);
builder.emitDestroyAddrAndFold(loc, tmpBuf);
builder.createDeallocStack(loc, tmpBuf);
} else {
recordTemporary(tan);
addAdjointValue(bb, origArg, makeConcreteAdjointValue(tan), loc);
}
}
}
// Destroy unused pullback direct results. Needed for pullback results from
// VJPs extracted from `@differentiable` function callees, where the
// `@differentiable` function's differentiation parameter indices are a
// superset of the active `apply` parameter indices.
while (allResultsIt != allResults.end()) {
auto unusedPullbackDirectResult = *allResultsIt++;
if (unusedPullbackDirectResult->getType().isAddress())
continue;
builder.emitDestroyValueOperation(loc, unusedPullbackDirectResult);
}
// Destroy and deallocate pullback indirect results.
for (auto *alloc : llvm::reverse(pullbackIndirectResults)) {
builder.emitDestroyAddrAndFold(loc, alloc);
builder.createDeallocStack(loc, alloc);
}
}
void visitBeginApplyInst(BeginApplyInst *bai) {
// Diagnose `begin_apply` instructions.
// Coroutine differentiation is not yet supported.
getContext().emitNondifferentiabilityError(
bai, getInvoker(), diag::autodiff_coroutines_not_supported);
errorOccurred = true;
return;
}
/// Handle `struct` instruction.
/// Original: y = struct (x0, x1, x2, ...)
/// Adjoint: adj[x0] += struct_extract adj[y], #x0
/// adj[x1] += struct_extract adj[y], #x1
/// adj[x2] += struct_extract adj[y], #x2
/// ...
void visitStructInst(StructInst *si) {
auto *bb = si->getParent();
auto loc = si->getLoc();
auto *structDecl = si->getStructDecl();
switch (getTangentValueCategory(si)) {
case SILValueCategory::Object: {
auto av = getAdjointValue(bb, si);
switch (av.getKind()) {
case AdjointValueKind::Zero: {
for (auto *field : structDecl->getStoredProperties()) {
auto fv = si->getFieldValue(field);
addAdjointValue(
bb, fv,
makeZeroAdjointValue(getRemappedTangentType(fv->getType())), loc);
}
break;
}
case AdjointValueKind::Concrete: {
auto adjStruct = materializeAdjointDirect(std::move(av), loc);
auto *dti = builder.createDestructureStruct(si->getLoc(), adjStruct);
// Find the struct `TangentVector` type.
auto structTy = remapType(si->getType()).getASTType();
#ifndef NDEBUG
auto tangentVectorTy = getTangentSpace(structTy)->getCanonicalType();
assert(!getTypeLowering(tangentVectorTy).isAddressOnly());
assert(tangentVectorTy->getStructOrBoundGenericStruct());
#endif
// Accumulate adjoints for the fields of the `struct` operand.
unsigned fieldIndex = 0;
for (auto it = structDecl->getStoredProperties().begin();
it != structDecl->getStoredProperties().end();
++it, ++fieldIndex) {
VarDecl *field = *it;
if (field->getAttrs().hasAttribute<NoDerivativeAttr>())
continue;
// Find the corresponding field in the tangent space.
auto *tanField = getTangentStoredProperty(
getContext(), field, structTy, loc, getInvoker());
if (!tanField) {
errorOccurred = true;
return;
}
auto tanElt = dti->getResult(fieldIndex);
addAdjointValue(bb, si->getFieldValue(field),
makeConcreteAdjointValue(tanElt), si->getLoc());
}
break;
}
case AdjointValueKind::Aggregate: {
// Note: All user-called initializations go through the calls to the
// initializer, and synthesized initializers only have one level of
// struct formation which will not result into any aggregate adjoint
// values.
llvm_unreachable(
"Aggregate adjoint values should not occur for `struct` "
"instructions");
}
case AdjointValueKind::AddElement: {
llvm_unreachable(
"Adjoint of `StructInst` cannot be of kind `AddElement`");
}
}
break;
}
case SILValueCategory::Address: {
auto adjBuf = getAdjointBuffer(bb, si);
// Find the struct `TangentVector` type.
auto structTy = remapType(si->getType()).getASTType();
// Accumulate adjoints for the fields of the `struct` operand.
unsigned fieldIndex = 0;
for (auto it = structDecl->getStoredProperties().begin();
it != structDecl->getStoredProperties().end(); ++it, ++fieldIndex) {
VarDecl *field = *it;
if (field->getAttrs().hasAttribute<NoDerivativeAttr>())
continue;
// Find the corresponding field in the tangent space.
auto *tanField = getTangentStoredProperty(getContext(), field, structTy,
loc, getInvoker());
if (!tanField) {
errorOccurred = true;
return;
}
auto *adjFieldBuf =
builder.createStructElementAddr(loc, adjBuf, tanField);
auto fieldValue = si->getFieldValue(field);
switch (getTangentValueCategory(fieldValue)) {
case SILValueCategory::Object: {
auto adjField = builder.emitLoadValueOperation(
loc, adjFieldBuf, LoadOwnershipQualifier::Copy);
recordTemporary(adjField);
addAdjointValue(bb, fieldValue, makeConcreteAdjointValue(adjField),
loc);
break;
}
case SILValueCategory::Address: {
addToAdjointBuffer(bb, fieldValue, adjFieldBuf, loc);
break;
}
}
}
} break;
}
}
/// Handle `struct_extract` instruction.
/// Original: y = struct_extract x, #field
/// Adjoint: adj[x] += struct (0, ..., #field': adj[y], ..., 0)
/// ^~~~~~~
/// field in tangent space corresponding to #field
void visitStructExtractInst(StructExtractInst *sei) {
auto *bb = sei->getParent();
auto loc = getValidLocation(sei);
// Find the corresponding field in the tangent space.
auto structTy = remapType(sei->getOperand()->getType()).getASTType();
auto *tanField =
getTangentStoredProperty(getContext(), sei, structTy, getInvoker());
assert(tanField && "Invalid projections should have been diagnosed");
// Check the `struct_extract` operand's value tangent category.
switch (getTangentValueCategory(sei->getOperand())) {
case SILValueCategory::Object: {
auto tangentVectorTy = getTangentSpace(structTy)->getCanonicalType();
auto tangentVectorSILTy =
SILType::getPrimitiveObjectType(tangentVectorTy);
auto eltAdj = getAdjointValue(bb, sei);
switch (eltAdj.getKind()) {
case AdjointValueKind::Zero: {
addAdjointValue(bb, sei->getOperand(),
makeZeroAdjointValue(tangentVectorSILTy), loc);
break;
}
case AdjointValueKind::Aggregate:
case AdjointValueKind::Concrete:
case AdjointValueKind::AddElement: {
auto baseAdj = makeZeroAdjointValue(tangentVectorSILTy);
addAdjointValue(bb, sei->getOperand(),
makeAddElementAdjointValue(baseAdj, eltAdj, tanField),
loc);
break;
}
}
break;
}
case SILValueCategory::Address: {
auto adjBase = getAdjointBuffer(bb, sei->getOperand());
auto *adjBaseElt =
builder.createStructElementAddr(loc, adjBase, tanField);
// Check the `struct_extract`'s value tangent category.
switch (getTangentValueCategory(sei)) {
case SILValueCategory::Object: {
auto adjElt = getAdjointValue(bb, sei);
auto concreteAdjElt = materializeAdjointDirect(adjElt, loc);
auto concreteAdjEltCopy =
builder.emitCopyValueOperation(loc, concreteAdjElt);
auto *alloc = builder.createAllocStack(loc, adjElt.getType());
builder.emitStoreValueOperation(loc, concreteAdjEltCopy, alloc,
StoreOwnershipQualifier::Init);
builder.emitInPlaceAdd(loc, adjBaseElt, alloc);
builder.createDestroyAddr(loc, alloc);
builder.createDeallocStack(loc, alloc);
break;
}
case SILValueCategory::Address: {
auto adjElt = getAdjointBuffer(bb, sei);
builder.emitInPlaceAdd(loc, adjBaseElt, adjElt);
break;
}
}
break;
}
}
}
/// Handle `ref_element_addr` instruction.
/// Original: y = ref_element_addr x, <n>
/// Adjoint: adj[x] += struct (0, ..., #field': adj[y], ..., 0)
/// ^~~~~~~
/// field in tangent space corresponding to #field
void visitRefElementAddrInst(RefElementAddrInst *reai) {
auto *bb = reai->getParent();
auto loc = reai->getLoc();
auto adjBuf = getAdjointBuffer(bb, reai);
auto classOperand = reai->getOperand();
auto classType = remapType(reai->getOperand()->getType()).getASTType();
auto *tanField =
getTangentStoredProperty(getContext(), reai, classType, getInvoker());
assert(tanField && "Invalid projections should have been diagnosed");
switch (getTangentValueCategory(classOperand)) {
case SILValueCategory::Object: {
auto classTy = remapType(classOperand->getType()).getASTType();
auto tangentVectorTy = getTangentSpace(classTy)->getCanonicalType();
auto tangentVectorSILTy =
SILType::getPrimitiveObjectType(tangentVectorTy);
auto *tangentVectorDecl =
tangentVectorTy->getStructOrBoundGenericStruct();
// Accumulate adjoint for the `ref_element_addr` operand.
SmallVector<AdjointValue, 8> eltVals;
for (auto *field : tangentVectorDecl->getStoredProperties()) {
if (field == tanField) {
auto adjElt = builder.emitLoadValueOperation(
reai->getLoc(), adjBuf, LoadOwnershipQualifier::Copy);
eltVals.push_back(makeConcreteAdjointValue(adjElt));
recordTemporary(adjElt);
} else {
auto substMap = tangentVectorTy->getMemberSubstitutionMap(
field->getModuleContext(), field);
auto fieldTy = field->getInterfaceType().subst(substMap);
auto fieldSILTy = getTypeLowering(fieldTy).getLoweredType();
assert(fieldSILTy.isObject());
eltVals.push_back(makeZeroAdjointValue(fieldSILTy));
}
}
addAdjointValue(bb, classOperand,
makeAggregateAdjointValue(tangentVectorSILTy, eltVals),
loc);
break;
}
case SILValueCategory::Address: {
auto adjBufClass = getAdjointBuffer(bb, classOperand);
auto adjBufElt =
builder.createStructElementAddr(loc, adjBufClass, tanField);
builder.emitInPlaceAdd(loc, adjBufElt, adjBuf);
break;
}
}
}
/// Handle `tuple` instruction.
/// Original: y = tuple (x0, x1, x2, ...)
/// Adjoint: (adj[x0], adj[x1], adj[x2], ...) += destructure_tuple adj[y]
/// ^~~
/// excluding non-differentiable elements
void visitTupleInst(TupleInst *ti) {
auto *bb = ti->getParent();
auto loc = ti->getLoc();
switch (getTangentValueCategory(ti)) {
case SILValueCategory::Object: {
auto av = getAdjointValue(bb, ti);
switch (av.getKind()) {
case AdjointValueKind::Zero:
for (auto elt : ti->getElements()) {
if (!getTangentSpace(elt->getType().getASTType()))
continue;
addAdjointValue(
bb, elt,
makeZeroAdjointValue(getRemappedTangentType(elt->getType())),
loc);
}
break;
case AdjointValueKind::Concrete: {
auto adjVal = av.getConcreteValue();
auto adjValCopy = builder.emitCopyValueOperation(loc, adjVal);
SmallVector<SILValue, 4> adjElts;
if (!adjVal->getType().getAs<TupleType>()) {
recordTemporary(adjValCopy);
adjElts.push_back(adjValCopy);
} else {
auto *dti = builder.createDestructureTuple(loc, adjValCopy);
for (auto adjElt : dti->getResults())
recordTemporary(adjElt);
adjElts.append(dti->getResults().begin(), dti->getResults().end());
}
// Accumulate adjoints for `tuple` operands, skipping the
// non-`Differentiable` ones.
unsigned adjIndex = 0;
for (auto i : range(ti->getNumOperands())) {
if (!getTangentSpace(ti->getOperand(i)->getType().getASTType()))
continue;
auto adjElt = adjElts[adjIndex++];
addAdjointValue(bb, ti->getOperand(i),
makeConcreteAdjointValue(adjElt), loc);
}
break;
}
case AdjointValueKind::Aggregate: {
unsigned adjIndex = 0;
for (auto i : range(ti->getElements().size())) {
if (!getTangentSpace(ti->getElement(i)->getType().getASTType()))
continue;
addAdjointValue(bb, ti->getElement(i),
av.getAggregateElement(adjIndex++), loc);
}
break;
}
case AdjointValueKind::AddElement: {
llvm_unreachable(
"Adjoint of `TupleInst` cannot be of kind `AddElement`");
}
}
break;
}
case SILValueCategory::Address: {
auto adjBuf = getAdjointBuffer(bb, ti);
// Accumulate adjoints for `tuple` operands, skipping the
// non-`Differentiable` ones.
unsigned adjIndex = 0;
for (auto i : range(ti->getNumOperands())) {
if (!getTangentSpace(ti->getOperand(i)->getType().getASTType()))
continue;
auto adjBufElt =
builder.createTupleElementAddr(loc, adjBuf, adjIndex++);
auto adjElt = getAdjointBuffer(bb, ti->getOperand(i));
builder.emitInPlaceAdd(loc, adjElt, adjBufElt);
}
break;
}
}
}
/// Handle `tuple_extract` instruction.
/// Original: y = tuple_extract x, <n>
/// Adjoint: adj[x] += tuple (0, 0, ..., adj[y], ..., 0, 0)
/// ^~~~~~
/// n'-th element, where n' is tuple tangent space
/// index corresponding to n
void visitTupleExtractInst(TupleExtractInst *tei) {
auto *bb = tei->getParent();
auto loc = tei->getLoc();
auto tupleTanTy = getRemappedTangentType(tei->getOperand()->getType());
auto eltAdj = getAdjointValue(bb, tei);
switch (eltAdj.getKind()) {
case AdjointValueKind::Zero: {
addAdjointValue(bb, tei->getOperand(), makeZeroAdjointValue(tupleTanTy),
loc);
break;
}
case AdjointValueKind::Aggregate:
case AdjointValueKind::Concrete:
case AdjointValueKind::AddElement: {
auto tupleTy = tei->getTupleType();
auto tupleTanTupleTy = tupleTanTy.getAs<TupleType>();
if (!tupleTanTupleTy) {
addAdjointValue(bb, tei->getOperand(), eltAdj, loc);
break;
}
unsigned elements = 0;
for (unsigned i : range(tupleTy->getNumElements())) {
if (!getTangentSpace(
tupleTy->getElement(i).getType()->getCanonicalType()))
continue;
elements++;
}
if (elements == 1) {
addAdjointValue(bb, tei->getOperand(), eltAdj, loc);
} else {
auto baseAdj = makeZeroAdjointValue(tupleTanTy);
addAdjointValue(
bb, tei->getOperand(),
makeAddElementAdjointValue(baseAdj, eltAdj, tei->getFieldIndex()),
loc);
}
break;
}
}
}
/// Handle `destructure_tuple` instruction.
/// Original: (y0, ..., yn) = destructure_tuple x
/// Adjoint: adj[x].0 += adj[y0]
/// ...
/// adj[x].n += adj[yn]
void visitDestructureTupleInst(DestructureTupleInst *dti) {
auto *bb = dti->getParent();
auto loc = dti->getLoc();
auto tupleTanTy = getRemappedTangentType(dti->getOperand()->getType());
// Check the `destructure_tuple` operand's value tangent category.
switch (getTangentValueCategory(dti->getOperand())) {
case SILValueCategory::Object: {
SmallVector<AdjointValue, 8> adjValues;
for (auto origElt : dti->getResults()) {
// Skip non-`Differentiable` tuple elements.
if (!getTangentSpace(remapType(origElt->getType()).getASTType()))
continue;
adjValues.push_back(getAdjointValue(bb, origElt));
}
// Handle tuple tangent type.
// Add adjoints for every tuple element that has a tangent space.
if (tupleTanTy.is<TupleType>()) {
assert(adjValues.size() > 1);
addAdjointValue(bb, dti->getOperand(),
makeAggregateAdjointValue(tupleTanTy, adjValues), loc);
}
// Handle non-tuple tangent type.
// Add adjoint for the single tuple element that has a tangent space.
else {
assert(adjValues.size() == 1);
addAdjointValue(bb, dti->getOperand(), adjValues.front(), loc);
}
break;
}
case SILValueCategory::Address: {
auto adjBuf = getAdjointBuffer(bb, dti->getOperand());
unsigned adjIndex = 0;
for (auto origElt : dti->getResults()) {
// Skip non-`Differentiable` tuple elements.
if (!getTangentSpace(remapType(origElt->getType()).getASTType()))
continue;
// Handle tuple tangent type.
// Add adjoints for every tuple element that has a tangent space.
if (tupleTanTy.is<TupleType>()) {
auto adjEltBuf = getAdjointBuffer(bb, origElt);
auto adjBufElt =
builder.createTupleElementAddr(loc, adjBuf, adjIndex);
builder.emitInPlaceAdd(loc, adjBufElt, adjEltBuf);
}
// Handle non-tuple tangent type.
// Add adjoint for the single tuple element that has a tangent space.
else {
auto adjEltBuf = getAdjointBuffer(bb, origElt);
addToAdjointBuffer(bb, dti->getOperand(), adjEltBuf, loc);
}
++adjIndex;
}
break;
}
}
}
/// Handle `load` or `load_borrow` instruction
/// Original: y = load/load_borrow x
/// Adjoint: adj[x] += adj[y]
void visitLoadOperation(SingleValueInstruction *inst) {
assert(isa<LoadInst>(inst) || isa<LoadBorrowInst>(inst));
auto *bb = inst->getParent();
auto loc = inst->getLoc();
switch (getTangentValueCategory(inst)) {
case SILValueCategory::Object: {
auto adjVal = materializeAdjointDirect(getAdjointValue(bb, inst), loc);
// Allocate a local buffer and store the adjoint value. This buffer will
// be used for accumulation into the adjoint buffer.
auto adjBuf = builder.createAllocStack(loc, adjVal->getType(), {},
DoesNotHaveDynamicLifetime,
IsNotLexical, IsNotFromVarDecl,
DoesNotUseMoveableValueDebugInfo,
/* skipVarDeclAssert = */ true);
auto copy = builder.emitCopyValueOperation(loc, adjVal);
builder.emitStoreValueOperation(loc, copy, adjBuf,
StoreOwnershipQualifier::Init);
// Accumulate the adjoint value in the local buffer into the adjoint
// buffer.
addToAdjointBuffer(bb, inst->getOperand(0), adjBuf, loc);
builder.emitDestroyAddr(loc, adjBuf);
builder.createDeallocStack(loc, adjBuf);
break;
}
case SILValueCategory::Address: {
auto adjBuf = getAdjointBuffer(bb, inst);
addToAdjointBuffer(bb, inst->getOperand(0), adjBuf, loc);
break;
}
}
}
void visitLoadInst(LoadInst *li) { visitLoadOperation(li); }
void visitLoadBorrowInst(LoadBorrowInst *lbi) { visitLoadOperation(lbi); }
/// Handle `store` or `store_borrow` instruction.
/// Original: store/store_borrow x to y
/// Adjoint: adj[x] += load adj[y]; adj[y] = 0
void visitStoreOperation(SILBasicBlock *bb, SILLocation loc, SILValue origSrc,
SILValue origDest) {
auto adjBuf = getAdjointBuffer(bb, origDest);
switch (getTangentValueCategory(origSrc)) {
case SILValueCategory::Object: {
auto adjVal = builder.emitLoadValueOperation(
loc, adjBuf, LoadOwnershipQualifier::Take);
recordTemporary(adjVal);
addAdjointValue(bb, origSrc, makeConcreteAdjointValue(adjVal), loc);
builder.emitZeroIntoBuffer(loc, adjBuf, IsInitialization);
break;
}
case SILValueCategory::Address: {
addToAdjointBuffer(bb, origSrc, adjBuf, loc);
builder.emitZeroIntoBuffer(loc, adjBuf, IsNotInitialization);
break;
}
}
}
void visitStoreInst(StoreInst *si) {
visitStoreOperation(si->getParent(), si->getLoc(), si->getSrc(),
si->getDest());
}
void visitStoreBorrowInst(StoreBorrowInst *sbi) {
visitStoreOperation(sbi->getParent(), sbi->getLoc(), sbi->getSrc(),
sbi);
}
/// Handle `copy_addr` instruction.
/// Original: copy_addr x to y
/// Adjoint: adj[x] += adj[y]; adj[y] = 0
void visitCopyAddrInst(CopyAddrInst *cai) {
auto *bb = cai->getParent();
auto adjDest = getAdjointBuffer(bb, cai->getDest());
addToAdjointBuffer(bb, cai->getSrc(), adjDest, cai->getLoc());
builder.emitZeroIntoBuffer(cai->getLoc(), adjDest, IsNotInitialization);
}
/// Handle any ownership instruction that deals with values: copy_value,
/// move_value, begin_borrow.
/// Original: y = copy_value x
/// Adjoint: adj[x] += adj[y]
void visitValueOwnershipInst(SingleValueInstruction *svi) {
assert(svi->getNumOperands() == 1);
auto *bb = svi->getParent();
switch (getTangentValueCategory(svi)) {
case SILValueCategory::Object: {
auto adj = getAdjointValue(bb, svi);
addAdjointValue(bb, svi->getOperand(0), adj, svi->getLoc());
break;
}
case SILValueCategory::Address: {
auto adjDest = getAdjointBuffer(bb, svi);
addToAdjointBuffer(bb, svi->getOperand(0), adjDest, svi->getLoc());
builder.emitZeroIntoBuffer(svi->getLoc(), adjDest, IsNotInitialization);
break;
}
}
}
/// Handle `copy_value` instruction.
/// Original: y = copy_value x
/// Adjoint: adj[x] += adj[y]
void visitCopyValueInst(CopyValueInst *cvi) { visitValueOwnershipInst(cvi); }
/// Handle `begin_borrow` instruction.
/// Original: y = begin_borrow x
/// Adjoint: adj[x] += adj[y]
void visitBeginBorrowInst(BeginBorrowInst *bbi) {
visitValueOwnershipInst(bbi);
}
/// Handle `move_value` instruction.
/// Original: y = move_value x
/// Adjoint: adj[x] += adj[y]
void visitMoveValueInst(MoveValueInst *mvi) { visitValueOwnershipInst(mvi); }
void visitEndInitLetRefInst(EndInitLetRefInst *eir) { visitValueOwnershipInst(eir); }
/// Handle `begin_access` instruction.
/// Original: y = begin_access x
/// Adjoint: nothing
void visitBeginAccessInst(BeginAccessInst *bai) {
// Check for non-differentiable writes.
if (bai->getAccessKind() == SILAccessKind::Modify) {
if (isa<GlobalAddrInst>(bai->getSource())) {
getContext().emitNondifferentiabilityError(
bai, getInvoker(),
diag::autodiff_cannot_differentiate_writes_to_global_variables);
errorOccurred = true;
return;
}
if (isa<ProjectBoxInst>(bai->getSource())) {
getContext().emitNondifferentiabilityError(
bai, getInvoker(),
diag::autodiff_cannot_differentiate_writes_to_mutable_captures);
errorOccurred = true;
return;
}
}
}
/// Handle `unconditional_checked_cast_addr` instruction.
/// Original: y = unconditional_checked_cast_addr x
/// Adjoint: adj[x] += unconditional_checked_cast_addr adj[y]
void visitUnconditionalCheckedCastAddrInst(
UnconditionalCheckedCastAddrInst *uccai) {
auto *bb = uccai->getParent();
auto adjDest = getAdjointBuffer(bb, uccai->getDest());
auto adjSrc = getAdjointBuffer(bb, uccai->getSrc());
auto castBuf = builder.createAllocStack(uccai->getLoc(), adjSrc->getType());
builder.createUnconditionalCheckedCastAddr(
uccai->getLoc(), adjDest, adjDest->getType().getASTType(), castBuf,
adjSrc->getType().getASTType());
addToAdjointBuffer(bb, uccai->getSrc(), castBuf, uccai->getLoc());
builder.emitDestroyAddrAndFold(uccai->getLoc(), castBuf);
builder.createDeallocStack(uccai->getLoc(), castBuf);
builder.emitZeroIntoBuffer(uccai->getLoc(), adjDest, IsInitialization);
}
/// Handle a sequence of `init_enum_data_addr` and `inject_enum_addr`
/// instructions.
///
/// Original: y = init_enum_data_addr x
/// inject_enum_addr y
///
/// Adjoint: adj[x] += unchecked_take_enum_data_addr adj[y]
void visitInjectEnumAddrInst(InjectEnumAddrInst *inject) {
SILBasicBlock *bb = inject->getParent();
SILValue origEnum = inject->getOperand();
// Only `Optional`-typed operands are supported for now. Diagnose all other
// enum operand types.
auto *optionalEnumDecl = getASTContext().getOptionalDecl();
if (origEnum->getType().getEnumOrBoundGenericEnum() != optionalEnumDecl) {
LLVM_DEBUG(getADDebugStream()
<< "Unsupported enum type in PullbackCloner: " << *inject);
getContext().emitNondifferentiabilityError(
inject, getInvoker(),
diag::autodiff_expression_not_differentiable_note);
errorOccurred = true;
return;
}
InitEnumDataAddrInst *origData = nullptr;
for (auto use : origEnum->getUses()) {
if (auto *init = dyn_cast<InitEnumDataAddrInst>(use->getUser())) {
// We need a more complicated analysis when init_enum_data_addr and
// inject_enum_addr are in different blocks, or there is more than one
// such instruction. Bail out for now.
if (origData || init->getParent() != bb) {
LLVM_DEBUG(getADDebugStream()
<< "Could not find a matching init_enum_data_addr for: "
<< *inject);
getContext().emitNondifferentiabilityError(
inject, getInvoker(),
diag::autodiff_expression_not_differentiable_note);
errorOccurred = true;
return;
}
origData = init;
}
}
SILValue adjStruct = getAdjointBuffer(bb, origEnum);
StructDecl *adjStructDecl =
adjStruct->getType().getStructOrBoundGenericStruct();
VarDecl *adjOptVar = nullptr;
if (adjStructDecl) {
ArrayRef<VarDecl *> properties = adjStructDecl->getStoredProperties();
adjOptVar = properties.size() == 1 ? properties[0] : nullptr;
}
EnumDecl *adjOptDecl =
adjOptVar ? adjOptVar->getTypeInContext()->getEnumOrBoundGenericEnum()
: nullptr;
// Optional<T>.TangentVector should be a struct with a single
// Optional<T.TangentVector> property. This is an implementation detail of
// OptionalDifferentiation.swift
if (!adjOptDecl || adjOptDecl != optionalEnumDecl)
llvm_unreachable("Unexpected type of Optional.TangentVector");
SILLocation loc = origData->getLoc();
StructElementAddrInst *adjOpt =
builder.createStructElementAddr(loc, adjStruct, adjOptVar);
// unchecked_take_enum_data_addr is destructive, so copy
// Optional<T.TangentVector> to a new alloca.
AllocStackInst *adjOptCopy =
createFunctionLocalAllocation(adjOpt->getType(), loc);
builder.createCopyAddr(loc, adjOpt, adjOptCopy, IsNotTake,
IsInitialization);
EnumElementDecl *someElemDecl = getASTContext().getOptionalSomeDecl();
UncheckedTakeEnumDataAddrInst *adjData =
builder.createUncheckedTakeEnumDataAddr(loc, adjOptCopy, someElemDecl);
setAdjointBuffer(bb, origData, adjData);
// The Optional copy is invalidated, do not attempt to destroy it at the end
// of the pullback. The value returned from unchecked_take_enum_data_addr is
// destroyed in visitInitEnumDataAddrInst.
destroyedLocalAllocations.insert(adjOptCopy);
}
/// Handle `init_enum_data_addr` instruction.
/// Destroy the value returned from `unchecked_take_enum_data_addr`.
void visitInitEnumDataAddrInst(InitEnumDataAddrInst *init) {
auto bufIt = bufferMap.find({init->getParent(), SILValue(init)});
if (bufIt == bufferMap.end())
return;
SILValue adjData = bufIt->second;
builder.emitDestroyAddr(init->getLoc(), adjData);
}
/// Handle `unchecked_ref_cast` instruction.
/// Original: y = unchecked_ref_cast x
/// Adjoint: adj[x] += adj[y]
/// (assuming adj[x] and adj[y] have the same type)
void visitUncheckedRefCastInst(UncheckedRefCastInst *urci) {
auto *bb = urci->getParent();
assert(urci->getOperand()->getType().isObject());
assert(getRemappedTangentType(urci->getOperand()->getType()) ==
getRemappedTangentType(urci->getType()) &&
"Operand/result must have the same `TangentVector` type");
switch (getTangentValueCategory(urci)) {
case SILValueCategory::Object: {
auto adj = getAdjointValue(bb, urci);
addAdjointValue(bb, urci->getOperand(), adj, urci->getLoc());
break;
}
case SILValueCategory::Address: {
auto adjDest = getAdjointBuffer(bb, urci);
addToAdjointBuffer(bb, urci->getOperand(), adjDest, urci->getLoc());
builder.emitZeroIntoBuffer(urci->getLoc(), adjDest, IsNotInitialization);
break;
}
}
}
/// Handle `upcast` instruction.
/// Original: y = upcast x
/// Adjoint: adj[x] += adj[y]
/// (assuming adj[x] and adj[y] have the same type)
void visitUpcastInst(UpcastInst *ui) {
auto *bb = ui->getParent();
assert(ui->getOperand()->getType().isObject());
assert(getRemappedTangentType(ui->getOperand()->getType()) ==
getRemappedTangentType(ui->getType()) &&
"Operand/result must have the same `TangentVector` type");
switch (getTangentValueCategory(ui)) {
case SILValueCategory::Object: {
auto adj = getAdjointValue(bb, ui);
addAdjointValue(bb, ui->getOperand(), adj, ui->getLoc());
break;
}
case SILValueCategory::Address: {
auto adjDest = getAdjointBuffer(bb, ui);
addToAdjointBuffer(bb, ui->getOperand(), adjDest, ui->getLoc());
builder.emitZeroIntoBuffer(ui->getLoc(), adjDest, IsNotInitialization);
break;
}
}
}
/// Handle `unchecked_take_enum_data_addr` instruction.
/// Currently, only `Optional`-typed operands are supported.
/// Original: y = unchecked_take_enum_data_addr x : $*Enum, #Enum.Case
/// Adjoint: adj[x] += $Enum.TangentVector(adj[y])
void
visitUncheckedTakeEnumDataAddrInst(UncheckedTakeEnumDataAddrInst *utedai) {
auto *bb = utedai->getParent();
auto adjDest = getAdjointBuffer(bb, utedai);
auto enumTy = utedai->getOperand()->getType();
auto *optionalEnumDecl = getASTContext().getOptionalDecl();
// Only `Optional`-typed operands are supported for now. Diagnose all other
// enum operand types.
if (enumTy.getASTType().getEnumOrBoundGenericEnum() != optionalEnumDecl) {
LLVM_DEBUG(getADDebugStream()
<< "Unhandled instruction in PullbackCloner: " << *utedai);
getContext().emitNondifferentiabilityError(
utedai, getInvoker(),
diag::autodiff_expression_not_differentiable_note);
errorOccurred = true;
return;
}
accumulateAdjointForOptionalBuffer(bb, utedai->getOperand(), adjDest);
builder.emitZeroIntoBuffer(utedai->getLoc(), adjDest, IsNotInitialization);
}
#define NOT_DIFFERENTIABLE(INST, DIAG) void visit##INST##Inst(INST##Inst *inst);
#undef NOT_DIFFERENTIABLE
#define NO_ADJOINT(INST) \
void visit##INST##Inst(INST##Inst *inst) {}
// Terminators.
NO_ADJOINT(Return)
NO_ADJOINT(Branch)
NO_ADJOINT(CondBranch)
// Address projections.
NO_ADJOINT(StructElementAddr)
NO_ADJOINT(TupleElementAddr)
// Array literal initialization address projections.
NO_ADJOINT(PointerToAddress)
NO_ADJOINT(IndexAddr)
// Memory allocation/access.
NO_ADJOINT(AllocStack)
NO_ADJOINT(DeallocStack)
NO_ADJOINT(EndAccess)
// Debugging/reference counting instructions.
NO_ADJOINT(DebugValue)
NO_ADJOINT(RetainValue)
NO_ADJOINT(RetainValueAddr)
NO_ADJOINT(ReleaseValue)
NO_ADJOINT(ReleaseValueAddr)
NO_ADJOINT(StrongRetain)
NO_ADJOINT(StrongRelease)
NO_ADJOINT(UnownedRetain)
NO_ADJOINT(UnownedRelease)
NO_ADJOINT(StrongRetainUnowned)
NO_ADJOINT(DestroyValue)
NO_ADJOINT(DestroyAddr)
// Value ownership.
NO_ADJOINT(EndBorrow)
#undef NO_ADJOINT
};
PullbackCloner::Implementation::Implementation(VJPCloner &vjpCloner)
: vjpCloner(vjpCloner), scopeCloner(getPullback()),
builder(getPullback(), getContext()),
localAllocBuilder(getPullback(), getContext()) {
// Get dominance and post-order info for the original function.
auto &passManager = getContext().getPassManager();
auto *domAnalysis = passManager.getAnalysis<DominanceAnalysis>();
auto *postDomAnalysis = passManager.getAnalysis<PostDominanceAnalysis>();
auto *postOrderAnalysis = passManager.getAnalysis<PostOrderAnalysis>();
auto *original = &vjpCloner.getOriginal();
domInfo = domAnalysis->get(original);
postDomInfo = postDomAnalysis->get(original);
postOrderInfo = postOrderAnalysis->get(original);
// Initialize `originalExitBlock`.
auto origExitIt = original->findReturnBB();
assert(origExitIt != original->end() &&
"Functions without returns must have been diagnosed");
originalExitBlock = &*origExitIt;
localAllocBuilder.setCurrentDebugScope(
remapScope(originalExitBlock->getTerminator()->getDebugScope()));
}
PullbackCloner::PullbackCloner(VJPCloner &vjpCloner)
: impl(*new Implementation(vjpCloner)) {}
PullbackCloner::~PullbackCloner() { delete &impl; }
//--------------------------------------------------------------------------//
// Entry point
//--------------------------------------------------------------------------//
bool PullbackCloner::run() {
bool foundError = impl.run();
#ifndef NDEBUG
if (!foundError)
impl.getPullback().verify();
#endif
return foundError;
}
bool PullbackCloner::Implementation::run() {
PrettyStackTraceSILFunction trace("generating pullback for", &getOriginal());
auto &original = getOriginal();
auto &pullback = getPullback();
auto pbLoc = getPullback().getLocation();
LLVM_DEBUG(getADDebugStream() << "Running PullbackCloner on\n" << original);
// Collect original formal results.
SmallVector<SILValue, 8> origFormalResults;
collectAllFormalResultsInTypeOrder(original, origFormalResults);
for (auto resultIndex : getConfig().resultIndices->getIndices()) {
auto origResult = origFormalResults[resultIndex];
// If original result is non-varied, it will always have a zero derivative.
// Skip full pullback generation and simply emit zero derivatives for wrt
// parameters.
//
// NOTE(TF-876): This shortcut is currently necessary for functions
// returning non-varied result with >1 basic block where some basic blocks
// have no dominated active values; control flow differentiation does not
// handle this case. See TF-876 for context.
if (!getActivityInfo().isVaried(origResult, getConfig().parameterIndices)) {
emitZeroDerivativesForNonvariedResult(origResult);
return false;
}
}
// Collect dominated active values in original basic blocks.
// Adjoint values of dominated active values are passed as pullback block
// arguments.
DominanceOrder domOrder(original.getEntryBlock(), domInfo);
// Keep track of visited values.
SmallPtrSet<SILValue, 8> visited;
while (auto *bb = domOrder.getNext()) {
auto &bbActiveValues = activeValues[bb];
// If the current block has an immediate dominator, append the immediate
// dominator block's active values to the current block's active values.
if (auto *domNode = domInfo->getNode(bb)->getIDom()) {
auto &domBBActiveValues = activeValues[domNode->getBlock()];
bbActiveValues.append(domBBActiveValues.begin(), domBBActiveValues.end());
}
// If `v` is active and has not been visited, records it as an active value
// in the original basic block.
// For active values unsupported by differentiation, emits a diagnostic and
// returns true. Otherwise, returns false.
auto recordValueIfActive = [&](SILValue v) -> bool {
// If value is not active, skip.
if (!getActivityInfo().isActive(v, getConfig()))
return false;
// If active value has already been visited, skip.
if (visited.count(v))
return false;
// Mark active value as visited.
visited.insert(v);
// Diagnose unsupported active values.
auto type = v->getType();
// Do not emit remaining activity-related diagnostics for semantic member
// accessors, which have special-case pullback generation.
if (isSemanticMemberAccessor(&original))
return false;
// Diagnose active enum values. Differentiation of enum values requires
// special adjoint value handling and is not yet supported. Diagnose
// only the first active enum value to prevent too many diagnostics.
//
// Do not diagnose `Optional`-typed values, which will have special-case
// differentiation support.
if (auto *enumDecl = type.getEnumOrBoundGenericEnum()) {
if (!type.getASTType()->isOptional()) {
getContext().emitNondifferentiabilityError(
v, getInvoker(), diag::autodiff_enums_unsupported);
errorOccurred = true;
return true;
}
}
// Diagnose unsupported stored property projections.
if (isa<StructExtractInst>(v) || isa<RefElementAddrInst>(v) ||
isa<StructElementAddrInst>(v)) {
auto *inst = cast<SingleValueInstruction>(v);
assert(inst->getNumOperands() == 1);
auto baseType = remapType(inst->getOperand(0)->getType()).getASTType();
if (!getTangentStoredProperty(getContext(), inst, baseType,
getInvoker())) {
errorOccurred = true;
return true;
}
}
// Skip address projections.
// Address projections do not need their own adjoint buffers; they
// become projections into their adjoint base buffer.
if (Projection::isAddressProjection(v))
return false;
// Check that active values are differentiable. Otherwise we may crash
// later when tangent space is required, but not available.
if (!getTangentSpace(remapType(type).getASTType())) {
getContext().emitNondifferentiabilityError(
v, getInvoker(), diag::autodiff_expression_not_differentiable_note);
errorOccurred = true;
return true;
}
// Record active value.
bbActiveValues.push_back(v);
return false;
};
// Record all active values in the basic block.
for (auto *arg : bb->getArguments())
if (recordValueIfActive(arg))
return true;
for (auto &inst : *bb) {
for (auto op : inst.getOperandValues())
if (recordValueIfActive(op))
return true;
for (auto result : inst.getResults())
if (recordValueIfActive(result))
return true;
}
domOrder.pushChildren(bb);
}
// Create pullback blocks and arguments, visiting original blocks using BFS
// starting from the original exit block. Unvisited original basic blocks
// (e.g unreachable blocks) are not relevant for pullback generation and thus
// ignored.
// The original blocks in traversal order for pullback generation.
SmallVector<SILBasicBlock *, 8> originalBlocks;
// The workqueue used for bookkeeping during the breadth-first traversal.
BasicBlockWorkqueue workqueue = {originalExitBlock};
// Perform BFS from the original exit block.
{
while (auto *BB = workqueue.pop()) {
originalBlocks.push_back(BB);
for (auto *nextBB : BB->getPredecessorBlocks()) {
// If there is no linear map tuple for predecessor BB, then BB is
// unreachable from function entry. Do not run pullback cloner on it.
if (getPullbackInfo().getLinearMapTupleType(nextBB))
workqueue.pushIfNotVisited(nextBB);
}
}
}
for (auto *origBB : originalBlocks) {
auto *pullbackBB = pullback.createBasicBlock();
pullbackBBMap.insert({origBB, pullbackBB});
auto pbTupleLoweredType =
remapType(getPullbackInfo().getLinearMapTupleLoweredType(origBB));
// If the BB is the original exit, then the pullback block that we just
// created must be the pullback function's entry. For the pullback entry,
// create entry arguments and continue to the next block.
if (origBB == originalExitBlock) {
assert(pullbackBB->isEntry());
createEntryArguments(&pullback);
auto *origTerm = originalExitBlock->getTerminator();
builder.setCurrentDebugScope(remapScope(origTerm->getDebugScope()));
builder.setInsertionPoint(pullbackBB);
// Obtain the context object, if any, and the top-level subcontext, i.e.
// the main pullback struct.
if (getPullbackInfo().hasHeapAllocatedContext()) {
// The last argument is the context object (`Builtin.NativeObject`).
contextValue = pullbackBB->getArguments().back();
assert(contextValue->getType() ==
SILType::getNativeObjectType(getASTContext()));
// Load the pullback context.
auto subcontextAddr = emitProjectTopLevelSubcontext(
builder, pbLoc, contextValue, pbTupleLoweredType);
SILValue mainPullbackTuple = builder.createLoad(
pbLoc, subcontextAddr,
pbTupleLoweredType.isTrivial(getPullback()) ?
LoadOwnershipQualifier::Trivial : LoadOwnershipQualifier::Copy);
auto *dsi = builder.createDestructureTuple(pbLoc, mainPullbackTuple);
initializePullbackTupleElements(origBB, dsi->getAllResults());
} else {
// Obtain and destructure pullback struct elements.
unsigned numVals = pbTupleLoweredType.getAs<TupleType>()->getNumElements();
initializePullbackTupleElements(origBB,
pullbackBB->getArguments().take_back(numVals));
}
continue;
}
// Get all active values in the original block.
// If the original block has no active values, continue.
auto &bbActiveValues = activeValues[origBB];
if (bbActiveValues.empty())
continue;
// Otherwise, if the original block has active values:
// - For each active buffer in the original block, allocate a new local
// buffer in the pullback entry. (All adjoint buffers are allocated in
// the pullback entry and deallocated in the pullback exit.)
// - For each active value in the original block, add adjoint value
// arguments to the pullback block.
for (auto activeValue : bbActiveValues) {
// Handle the active value based on its value category.
switch (getTangentValueCategory(activeValue)) {
case SILValueCategory::Address: {
// Allocate and zero initialize a new local buffer using
// `getAdjointBuffer`.
builder.setCurrentDebugScope(
remapScope(originalExitBlock->getTerminator()->getDebugScope()));
builder.setInsertionPoint(pullback.getEntryBlock());
getAdjointBuffer(origBB, activeValue);
break;
}
case SILValueCategory::Object: {
// Create and register pullback block argument for the active value.
auto *pullbackArg = pullbackBB->createPhiArgument(
getRemappedTangentType(activeValue->getType()),
OwnershipKind::Owned);
activeValuePullbackBBArgumentMap[{origBB, activeValue}] = pullbackArg;
recordTemporary(pullbackArg);
break;
}
}
}
// Add a pullback tuple argument.
auto *pbTupleArg = pullbackBB->createPhiArgument(pbTupleLoweredType,
OwnershipKind::Owned);
// Destructure the pullback struct to get the elements.
builder.setCurrentDebugScope(
remapScope(origBB->getTerminator()->getDebugScope()));
builder.setInsertionPoint(pullbackBB);
auto *dsi = builder.createDestructureTuple(pbLoc, pbTupleArg);
initializePullbackTupleElements(origBB, dsi->getResults());
// - Create pullback trampoline blocks for each successor block of the
// original block. Pullback trampoline blocks only have a pullback
// struct argument. They branch from a pullback successor block to the
// pullback original block, passing adjoint values of active values.
for (auto *succBB : origBB->getSuccessorBlocks()) {
// Skip generating pullback block for original unreachable blocks.
if (!workqueue.isVisited(succBB))
continue;
auto *pullbackTrampolineBB = pullback.createBasicBlockBefore(pullbackBB);
pullbackTrampolineBBMap.insert({{origBB, succBB}, pullbackTrampolineBB});
// Get the enum element type (i.e. the pullback struct type). The enum
// element type may be boxed if the enum is indirect.
auto enumLoweredTy =
getPullbackInfo().getBranchingTraceEnumLoweredType(succBB);
auto *enumEltDecl =
getPullbackInfo().lookUpBranchingTraceEnumElement(origBB, succBB);
auto enumEltType = remapType(enumLoweredTy.getEnumElementType(
enumEltDecl, getModule(), TypeExpansionContext::minimal()));
pullbackTrampolineBB->createPhiArgument(enumEltType,
OwnershipKind::Owned);
}
}
auto *pullbackEntry = pullback.getEntryBlock();
auto pbTupleLoweredType =
remapType(getPullbackInfo().getLinearMapTupleLoweredType(originalExitBlock));
unsigned numVals = (getPullbackInfo().hasHeapAllocatedContext() ?
1 : pbTupleLoweredType.getAs<TupleType>()->getNumElements());
(void)numVals;
// The pullback function has type:
// `(seed0, seed1, ..., (exit_pb_tuple_el0, ..., )|context_obj) -> (d_arg0, ..., d_argn)`.
auto pbParamArgs = pullback.getArgumentsWithoutIndirectResults();
assert(getConfig().resultIndices->getNumIndices() == pbParamArgs.size() - numVals &&
pbParamArgs.size() >= 1);
// Assign adjoints for original result.
builder.setCurrentDebugScope(
remapScope(originalExitBlock->getTerminator()->getDebugScope()));
builder.setInsertionPoint(pullbackEntry,
getNextFunctionLocalAllocationInsertionPoint());
unsigned seedIndex = 0;
for (auto resultIndex : getConfig().resultIndices->getIndices()) {
auto origResult = origFormalResults[resultIndex];
auto *seed = pbParamArgs[seedIndex];
if (seed->getType().isAddress()) {
// If the seed argument is an `inout` parameter, assign it directly as
// the adjoint buffer of the original result.
auto seedParamInfo =
pullback.getLoweredFunctionType()->getParameters()[seedIndex];
if (seedParamInfo.isIndirectInOut()) {
setAdjointBuffer(originalExitBlock, origResult, seed);
}
// Otherwise, assign a copy of the seed argument as the adjoint buffer of
// the original result.
else {
auto *seedBufCopy =
createFunctionLocalAllocation(seed->getType(), pbLoc);
builder.createCopyAddr(pbLoc, seed, seedBufCopy, IsNotTake,
IsInitialization);
setAdjointBuffer(originalExitBlock, origResult, seedBufCopy);
LLVM_DEBUG(getADDebugStream()
<< "Assigned seed buffer " << *seedBufCopy
<< " as the adjoint of original indirect result "
<< origResult);
}
} else {
addAdjointValue(originalExitBlock, origResult, makeConcreteAdjointValue(seed),
pbLoc);
LLVM_DEBUG(getADDebugStream()
<< "Assigned seed " << *seed
<< " as the adjoint of original result " << origResult);
}
++seedIndex;
}
// If the original function is an accessor with special-case pullback
// generation logic, do special-case generation.
if (isSemanticMemberAccessor(&original)) {
if (runForSemanticMemberAccessor())
return true;
}
// Otherwise, perform standard pullback generation.
// Visit original blocks in post-order and perform differentiation
// in corresponding pullback blocks. If errors occurred, back out.
else {
for (auto *bb : originalBlocks) {
visitSILBasicBlock(bb);
if (errorOccurred)
return true;
}
}
// Prepare and emit a `return` in the pullback exit block.
auto *origEntry = getOriginal().getEntryBlock();
auto *pbExit = getPullbackBlock(origEntry);
builder.setCurrentDebugScope(pbExit->back().getDebugScope());
builder.setInsertionPoint(pbExit);
// This vector will contain all the materialized return elements.
SmallVector<SILValue, 8> retElts;
// This vector will contain all indirect parameter adjoint buffers.
SmallVector<SILValue, 4> indParamAdjoints;
// This vector will identify the locations where initialization is needed.
SmallBitVector outputsToInitialize;
auto conv = getOriginal().getConventions();
auto origParams = getOriginal().getArgumentsWithoutIndirectResults();
// Materializes the return element corresponding to the parameter
// `parameterIndex` into the `retElts` vector.
auto addRetElt = [&](unsigned parameterIndex) -> void {
auto origParam = origParams[parameterIndex];
switch (getTangentValueCategory(origParam)) {
case SILValueCategory::Object: {
auto pbVal = getAdjointValue(origEntry, origParam);
auto val = materializeAdjointDirect(pbVal, pbLoc);
auto newVal = builder.emitCopyValueOperation(pbLoc, val);
retElts.push_back(newVal);
break;
}
case SILValueCategory::Address: {
auto adjBuf = getAdjointBuffer(origEntry, origParam);
indParamAdjoints.push_back(adjBuf);
outputsToInitialize.push_back(
!conv.getParameters()[parameterIndex].isIndirectMutating());
break;
}
}
};
SmallVector<SILArgument *, 4> pullbackIndirectResults(
getPullback().getIndirectResults().begin(),
getPullback().getIndirectResults().end());
// Collect differentiation parameter adjoints.
// Do a first pass to collect non-inout values.
for (auto i : getConfig().parameterIndices->getIndices()) {
if (!conv.getParameters()[i].isAutoDiffSemanticResult()) {
addRetElt(i);
}
}
// Do a second pass for all inout parameters, however this is only necessary
// for functions with multiple basic blocks. For functions with a single
// basic block adjoint accumulation for those parameters is already done by
// per-instruction visitors.
if (getOriginal().size() > 1) {
const auto &pullbackConv = pullback.getConventions();
SmallVector<SILArgument *, 1> pullbackInOutArgs;
for (auto pullbackArg : enumerate(pullback.getArgumentsWithoutIndirectResults())) {
if (pullbackConv.getParameters()[pullbackArg.index()].isAutoDiffSemanticResult())
pullbackInOutArgs.push_back(pullbackArg.value());
}
unsigned pullbackInoutArgumentIdx = 0;
for (auto i : getConfig().parameterIndices->getIndices()) {
// Skip non-inout parameters.
if (!conv.getParameters()[i].isAutoDiffSemanticResult())
continue;
// For functions with multiple basic blocks, accumulation is needed
// for `inout` parameters because pullback basic blocks have different
// adjoint buffers.
pullbackIndirectResults.push_back(pullbackInOutArgs[pullbackInoutArgumentIdx++]);
addRetElt(i);
}
}
// Copy them to adjoint indirect results.
assert(indParamAdjoints.size() == pullbackIndirectResults.size() &&
"Indirect parameter adjoint count mismatch");
unsigned currentIndex = 0;
for (auto pair : zip(indParamAdjoints, pullbackIndirectResults)) {
auto source = std::get<0>(pair);
auto *dest = std::get<1>(pair);
if (outputsToInitialize[currentIndex]) {
builder.createCopyAddr(pbLoc, source, dest, IsTake, IsInitialization);
} else {
builder.createCopyAddr(pbLoc, source, dest, IsTake, IsNotInitialization);
}
currentIndex++;
// Prevent source buffer from being deallocated, since the underlying
// value is moved.
destroyedLocalAllocations.insert(source);
}
// Emit cleanups for all local values.
cleanUpTemporariesForBlock(pbExit, pbLoc);
// Deallocate local allocations.
for (auto alloc : functionLocalAllocations) {
// Assert that local allocations have at least one use.
// Buffers should not be allocated needlessly.
assert(!alloc->use_empty());
if (!destroyedLocalAllocations.count(alloc)) {
builder.emitDestroyAddrAndFold(pbLoc, alloc);
destroyedLocalAllocations.insert(alloc);
}
builder.createDeallocStack(pbLoc, alloc);
}
builder.createReturn(pbLoc, joinElements(retElts, builder, pbLoc));
#ifndef NDEBUG
bool leakFound = false;
// Ensure all temporaries have been cleaned up.
for (auto &bb : pullback) {
for (auto temp : blockTemporaries[&bb]) {
if (blockTemporaries[&bb].count(temp)) {
leakFound = true;
getADDebugStream() << "Found leaked temporary:\n" << temp;
}
}
}
// Ensure all local allocations have been cleaned up.
for (auto localAlloc : functionLocalAllocations) {
if (!destroyedLocalAllocations.count(localAlloc)) {
leakFound = true;
getADDebugStream() << "Found leaked local buffer:\n" << localAlloc;
}
}
assert(!leakFound && "Leaks found!");
#endif
LLVM_DEBUG(getADDebugStream()
<< "Generated pullback for " << original.getName() << ":\n"
<< pullback);
return errorOccurred;
}
void PullbackCloner::Implementation::emitZeroDerivativesForNonvariedResult(
SILValue origNonvariedResult) {
auto &pullback = getPullback();
auto pbLoc = getPullback().getLocation();
/*
// TODO(TF-788): Re-enable non-varied result warning.
// Emit fixit if original non-varied result has a valid source location.
auto startLoc = origNonvariedResult.getLoc().getStartSourceLoc();
auto endLoc = origNonvariedResult.getLoc().getEndSourceLoc();
if (startLoc.isValid() && endLoc.isValid()) {
getContext().diagnose(startLoc, diag::autodiff_nonvaried_result_fixit)
.fixItInsert(startLoc, "withoutDerivative(at:")
.fixItInsertAfter(endLoc, ")");
}
*/
LLVM_DEBUG(getADDebugStream() << getOriginal().getName()
<< " has non-varied result, returning zero"
" for all pullback results\n");
auto *pullbackEntry = pullback.createBasicBlock();
createEntryArguments(&pullback);
builder.setCurrentDebugScope(
remapScope(originalExitBlock->getTerminator()->getDebugScope()));
builder.setInsertionPoint(pullbackEntry);
// Destroy all owned arguments.
for (auto *arg : pullbackEntry->getArguments())
if (arg->getOwnershipKind() == OwnershipKind::Owned)
builder.emitDestroyOperation(pbLoc, arg);
// Return zero for each result.
SmallVector<SILValue, 4> directResults;
auto indirectResultIt = pullback.getIndirectResults().begin();
for (auto resultInfo : pullback.getLoweredFunctionType()->getResults()) {
auto resultType =
pullback.mapTypeIntoContext(resultInfo.getInterfaceType())
->getCanonicalType();
if (resultInfo.isFormalDirect())
directResults.push_back(builder.emitZero(pbLoc, resultType));
else
builder.emitZeroIntoBuffer(pbLoc, *indirectResultIt++, IsInitialization);
}
builder.createReturn(pbLoc, joinElements(directResults, builder, pbLoc));
LLVM_DEBUG(getADDebugStream()
<< "Generated pullback for " << getOriginal().getName() << ":\n"
<< pullback);
}
AllocStackInst *PullbackCloner::Implementation::createOptionalAdjoint(
SILBasicBlock *bb, SILValue wrappedAdjoint, SILType optionalTy) {
auto pbLoc = getPullback().getLocation();
// `Optional<T>`
optionalTy = remapType(optionalTy);
assert(optionalTy.getASTType()->isOptional());
// `T`
auto wrappedType = optionalTy.getOptionalObjectType();
// `T.TangentVector`
auto wrappedTanType = remapType(wrappedAdjoint->getType());
// `Optional<T.TangentVector>`
auto optionalOfWrappedTanType = SILType::getOptionalType(wrappedTanType);
// `Optional<T>.TangentVector`
auto optionalTanTy = getRemappedTangentType(optionalTy);
auto *optionalTanDecl = optionalTanTy.getNominalOrBoundGenericNominal();
// Look up the `Optional<T>.TangentVector.init` declaration.
auto initLookup =
optionalTanDecl->lookupDirect(DeclBaseName::createConstructor());
ConstructorDecl *constructorDecl = nullptr;
for (auto *candidate : initLookup) {
auto candidateModule = candidate->getModuleContext();
if (candidateModule->getName() ==
builder.getASTContext().Id_Differentiation ||
candidateModule->isStdlibModule()) {
assert(!constructorDecl && "Multiple `Optional.TangentVector.init`s");
constructorDecl = cast<ConstructorDecl>(candidate);
#ifdef NDEBUG
break;
#endif
}
}
assert(constructorDecl && "No `Optional.TangentVector.init`");
// Allocate a local buffer for the `Optional` adjoint value.
auto *optTanAdjBuf = builder.createAllocStack(pbLoc, optionalTanTy);
// Find `Optional<T.TangentVector>.some` EnumElementDecl.
auto someEltDecl = builder.getASTContext().getOptionalSomeDecl();
// Initialize an `Optional<T.TangentVector>` buffer from `wrappedAdjoint` as
// the input for `Optional<T>.TangentVector.init`.
auto *optArgBuf = builder.createAllocStack(pbLoc, optionalOfWrappedTanType);
if (optionalOfWrappedTanType.isLoadableOrOpaque(builder.getFunction())) {
// %enum = enum $Optional<T.TangentVector>, #Optional.some!enumelt,
// %wrappedAdjoint : $T
auto *enumInst = builder.createEnum(pbLoc, wrappedAdjoint, someEltDecl,
optionalOfWrappedTanType);
// store %enum to %optArgBuf
builder.emitStoreValueOperation(pbLoc, enumInst, optArgBuf,
StoreOwnershipQualifier::Init);
} else {
// %enumAddr = init_enum_data_addr %optArgBuf $Optional<T.TangentVector>,
// #Optional.some!enumelt
auto *enumAddr = builder.createInitEnumDataAddr(
pbLoc, optArgBuf, someEltDecl, wrappedTanType.getAddressType());
// copy_addr %wrappedAdjoint to [init] %enumAddr
builder.createCopyAddr(pbLoc, wrappedAdjoint, enumAddr, IsNotTake,
IsInitialization);
// inject_enum_addr %optArgBuf : $*Optional<T.TangentVector>,
// #Optional.some!enumelt
builder.createInjectEnumAddr(pbLoc, optArgBuf, someEltDecl);
}
// Apply `Optional<T>.TangentVector.init`.
SILOptFunctionBuilder fb(getContext().getTransform());
// %init_fn = function_ref @Optional<T>.TangentVector.init
auto *initFn = fb.getOrCreateFunction(pbLoc, SILDeclRef(constructorDecl),
NotForDefinition);
auto *initFnRef = builder.createFunctionRef(pbLoc, initFn);
auto *diffProto =
builder.getASTContext().getProtocol(KnownProtocolKind::Differentiable);
auto *swiftModule = getModule().getSwiftModule();
auto diffConf =
swiftModule->lookupConformance(wrappedType.getASTType(), diffProto);
assert(!diffConf.isInvalid() && "Missing conformance to `Differentiable`");
auto subMap = SubstitutionMap::get(
initFn->getLoweredFunctionType()->getSubstGenericSignature(),
ArrayRef<Type>(wrappedType.getASTType()), {diffConf});
// %metatype = metatype $Optional<T>.TangentVector.Type
auto metatypeType = CanMetatypeType::get(optionalTanTy.getASTType(),
MetatypeRepresentation::Thin);
auto metatypeSILType = SILType::getPrimitiveObjectType(metatypeType);
auto metatype = builder.createMetatype(pbLoc, metatypeSILType);
// apply %init_fn(%optTanAdjBuf, %optArgBuf, %metatype)
builder.createApply(pbLoc, initFnRef, subMap,
{optTanAdjBuf, optArgBuf, metatype});
builder.createDeallocStack(pbLoc, optArgBuf);
return optTanAdjBuf;
}
// Accumulate adjoint for the incoming `Optional` buffer.
void PullbackCloner::Implementation::accumulateAdjointForOptionalBuffer(
SILBasicBlock *bb, SILValue optionalBuffer, SILValue wrappedAdjoint) {
assert(getTangentValueCategory(optionalBuffer) == SILValueCategory::Address);
auto pbLoc = getPullback().getLocation();
// Allocate and initialize Optional<Wrapped>.TangentVector from
// Wrapped.TangentVector
AllocStackInst *optTanAdjBuf =
createOptionalAdjoint(bb, wrappedAdjoint, optionalBuffer->getType());
// Accumulate into optionalBuffer
addToAdjointBuffer(bb, optionalBuffer, optTanAdjBuf, pbLoc);
builder.emitDestroyAddr(pbLoc, optTanAdjBuf);
builder.createDeallocStack(pbLoc, optTanAdjBuf);
}
// Set the adjoint value for the incoming `Optional` value.
void PullbackCloner::Implementation::setAdjointValueForOptional(
SILBasicBlock *bb, SILValue optionalValue, SILValue wrappedAdjoint) {
assert(getTangentValueCategory(optionalValue) == SILValueCategory::Object);
auto pbLoc = getPullback().getLocation();
// Allocate and initialize Optional<Wrapped>.TangentVector from
// Wrapped.TangentVector
AllocStackInst *optTanAdjBuf =
createOptionalAdjoint(bb, wrappedAdjoint, optionalValue->getType());
auto optTanAdjVal = builder.emitLoadValueOperation(
pbLoc, optTanAdjBuf, LoadOwnershipQualifier::Take);
recordTemporary(optTanAdjVal);
builder.createDeallocStack(pbLoc, optTanAdjBuf);
setAdjointValue(bb, optionalValue, makeConcreteAdjointValue(optTanAdjVal));
}
SILBasicBlock *PullbackCloner::Implementation::buildPullbackSuccessor(
SILBasicBlock *origBB, SILBasicBlock *origPredBB,
SmallDenseMap<SILValue, TrampolineBlockSet> &pullbackTrampolineBlockMap) {
// Get the pullback block and optional pullback trampoline block of the
// predecessor block.
auto *pullbackBB = getPullbackBlock(origPredBB);
auto *pullbackTrampolineBB = getPullbackTrampolineBlock(origPredBB, origBB);
// If the predecessor block does not have a corresponding pullback
// trampoline block, then the pullback successor is the pullback block.
if (!pullbackTrampolineBB)
return pullbackBB;
// Otherwise, the pullback successor is the pullback trampoline block,
// which branches to the pullback block and propagates adjoint values of
// active values.
assert(pullbackTrampolineBB->getNumArguments() == 1);
auto loc = origBB->getParent()->getLocation();
SmallVector<SILValue, 8> trampolineArguments;
// Propagate adjoint values/buffers of active values/buffers to
// predecessor blocks.
auto &predBBActiveValues = activeValues[origPredBB];
llvm::SmallSet<std::pair<SILValue, SILValue>, 32> propagatedAdjoints;
for (auto activeValue : predBBActiveValues) {
LLVM_DEBUG(getADDebugStream()
<< "Propagating adjoint of active value " << activeValue
<< "from bb" << origBB->getDebugID()
<< " to predecessors' (bb" << origPredBB->getDebugID()
<< ") pullback blocks\n");
switch (getTangentValueCategory(activeValue)) {
case SILValueCategory::Object: {
auto activeValueAdj = getAdjointValue(origBB, activeValue);
auto concreteActiveValueAdj =
materializeAdjointDirect(activeValueAdj, loc);
if (!pullbackTrampolineBlockMap.count(concreteActiveValueAdj)) {
concreteActiveValueAdj =
builder.emitCopyValueOperation(loc, concreteActiveValueAdj);
setAdjointValue(origBB, activeValue,
makeConcreteAdjointValue(concreteActiveValueAdj));
}
auto insertion = pullbackTrampolineBlockMap.try_emplace(
concreteActiveValueAdj, TrampolineBlockSet());
auto &blockSet = insertion.first->getSecond();
blockSet.insert(pullbackTrampolineBB);
trampolineArguments.push_back(concreteActiveValueAdj);
// If the pullback block does not yet have a registered adjoint
// value for the active value, set the adjoint value to the
// forwarded adjoint value argument.
// TODO: Hoist this logic out of loop over predecessor blocks to
// remove the `hasAdjointValue` check.
if (!hasAdjointValue(origPredBB, activeValue)) {
auto *pullbackBBArg =
getActiveValuePullbackBlockArgument(origPredBB, activeValue);
auto forwardedArgAdj = makeConcreteAdjointValue(pullbackBBArg);
setAdjointValue(origPredBB, activeValue, forwardedArgAdj);
}
break;
}
case SILValueCategory::Address: {
// Propagate adjoint buffers using `copy_addr`.
auto adjBuf = getAdjointBuffer(origBB, activeValue);
auto predAdjBuf = getAdjointBuffer(origPredBB, activeValue);
if (propagatedAdjoints.insert({adjBuf, predAdjBuf}).second)
builder.createCopyAddr(loc, adjBuf, predAdjBuf, IsNotTake,
IsNotInitialization);
break;
}
}
}
// Propagate pullback struct argument.
TangentBuilder pullbackTrampolineBBBuilder(
pullbackTrampolineBB, getContext());
pullbackTrampolineBBBuilder.setCurrentDebugScope(
remapScope(origPredBB->getTerminator()->getDebugScope()));
auto *pullbackTrampolineBBArg = pullbackTrampolineBB->getArguments().front();
if (vjpCloner.getLoopInfo()->getLoopFor(origPredBB)) {
assert(pullbackTrampolineBBArg->getType() ==
SILType::getRawPointerType(getASTContext()));
auto pbTupleType =
remapType(getPullbackInfo().getLinearMapTupleLoweredType(origPredBB));
auto predPbTupleAddr = pullbackTrampolineBBBuilder.createPointerToAddress(
loc, pullbackTrampolineBBArg, pbTupleType.getAddressType(),
/*isStrict*/ true);
auto predPbStructVal = pullbackTrampolineBBBuilder.createLoad(
loc, predPbTupleAddr,
pbTupleType.isTrivial(getPullback()) ?
LoadOwnershipQualifier::Trivial : LoadOwnershipQualifier::Copy);
trampolineArguments.push_back(predPbStructVal);
} else {
trampolineArguments.push_back(pullbackTrampolineBBArg);
}
// Branch from pullback trampoline block to pullback block.
pullbackTrampolineBBBuilder.createBranch(loc, pullbackBB,
trampolineArguments);
return pullbackTrampolineBB;
}
void PullbackCloner::Implementation::visitSILBasicBlock(SILBasicBlock *bb) {
auto pbLoc = getPullback().getLocation();
// Get the corresponding pullback basic block.
auto *pbBB = getPullbackBlock(bb);
builder.setInsertionPoint(pbBB);
LLVM_DEBUG({
auto &s = getADDebugStream()
<< "Original bb" + std::to_string(bb->getDebugID())
<< ": To differentiate or not to differentiate?\n";
for (auto &inst : llvm::reverse(*bb)) {
s << (getPullbackInfo().shouldDifferentiateInstruction(&inst) ? "[x] "
: "[ ] ")
<< inst;
}
});
// Visit each instruction in reverse order.
for (auto &inst : llvm::reverse(*bb)) {
if (!getPullbackInfo().shouldDifferentiateInstruction(&inst))
continue;
// Differentiate instruction.
builder.setCurrentDebugScope(remapScope(inst.getDebugScope()));
visit(&inst);
if (errorOccurred)
return;
}
// Emit a branching terminator for the block.
// If the original block is the original entry, then the pullback block is
// the pullback exit. This is handled specially in
// `PullbackCloner::Implementation::run()`, so we leave the block
// non-terminated.
if (bb->isEntry())
return;
// Otherwise, add a `switch_enum` terminator for non-exit
// pullback blocks.
// 1. Get the pullback struct pullback block argument.
// 2. Extract the predecessor enum value from the pullback struct value.
auto *predEnum = getPullbackInfo().getBranchingTraceDecl(bb);
(void)predEnum;
auto predEnumVal = getPullbackPredTupleElement(bb);
// Propagate adjoint values from active basic block arguments to
// incoming values (predecessor terminator operands).
for (auto *bbArg : bb->getArguments()) {
if (!getActivityInfo().isActive(bbArg, getConfig()))
continue;
LLVM_DEBUG(getADDebugStream() << "Propagating adjoint value for active bb"
<< bb->getDebugID() << " argument: "
<< *bbArg);
// Get predecessor terminator operands.
SmallVector<std::pair<SILBasicBlock *, SILValue>, 4> incomingValues;
if (bbArg->getSingleTerminatorOperands(incomingValues)) {
// Returns true if the given terminator instruction is a `switch_enum` on
// an `Optional`-typed value. `switch_enum` instructions require
// special-case adjoint value propagation for the operand.
auto isSwitchEnumInstOnOptional =
[&ctx = getASTContext()](TermInst *termInst) {
if (!termInst)
return false;
if (auto *sei = dyn_cast<SwitchEnumInst>(termInst)) {
auto operandTy = sei->getOperand()->getType();
return operandTy.getASTType()->isOptional();
}
return false;
};
// Check the tangent value category of the active basic block argument.
switch (getTangentValueCategory(bbArg)) {
// If argument has a loadable tangent value category: materialize adjoint
// value of the argument, create a copy, and set the copy as the adjoint
// value of incoming values.
case SILValueCategory::Object: {
auto bbArgAdj = getAdjointValue(bb, bbArg);
auto concreteBBArgAdj = materializeAdjointDirect(bbArgAdj, pbLoc);
auto concreteBBArgAdjCopy =
builder.emitCopyValueOperation(pbLoc, concreteBBArgAdj);
for (auto pair : incomingValues) {
auto *predBB = std::get<0>(pair);
auto incomingValue = std::get<1>(pair);
// Handle `switch_enum` on `Optional`.
auto termInst = bbArg->getSingleTerminator();
if (isSwitchEnumInstOnOptional(termInst)) {
setAdjointValueForOptional(bb, incomingValue, concreteBBArgAdjCopy);
} else {
blockTemporaries[getPullbackBlock(predBB)].insert(
concreteBBArgAdjCopy);
setAdjointValue(predBB, incomingValue,
makeConcreteAdjointValue(concreteBBArgAdjCopy));
}
}
break;
}
// If argument has an address tangent value category: materialize adjoint
// value of the argument, create a copy, and set the copy as the adjoint
// value of incoming values.
case SILValueCategory::Address: {
auto bbArgAdjBuf = getAdjointBuffer(bb, bbArg);
for (auto pair : incomingValues) {
auto incomingValue = std::get<1>(pair);
// Handle `switch_enum` on `Optional`.
auto termInst = bbArg->getSingleTerminator();
if (isSwitchEnumInstOnOptional(termInst))
accumulateAdjointForOptionalBuffer(bb, incomingValue, bbArgAdjBuf);
else
addToAdjointBuffer(bb, incomingValue, bbArgAdjBuf, pbLoc);
}
break;
}
}
} else
llvm::report_fatal_error("do not know how to handle this incoming bb argument");
}
// 3. Build the pullback successor cases for the `switch_enum`
// instruction. The pullback successors correspond to the predecessors
// of the current original block.
SmallVector<std::pair<EnumElementDecl *, SILBasicBlock *>, 4>
pullbackSuccessorCases;
// A map from active values' adjoint values to the trampoline blocks that
// are using them.
SmallDenseMap<SILValue, TrampolineBlockSet> pullbackTrampolineBlockMap;
SmallDenseMap<SILBasicBlock *, SILBasicBlock *> origPredpullbackSuccBBMap;
for (auto *predBB : bb->getPredecessorBlocks()) {
// If there is no linear map tuple for predecessor BB, then BB is
// unreachable from function entry. There is no branch tracing enum for it
// as well, so we should not create any branching to it in the pullback.
if (!getPullbackInfo().getLinearMapTupleType(predBB))
continue;
auto *pullbackSuccBB =
buildPullbackSuccessor(bb, predBB, pullbackTrampolineBlockMap);
origPredpullbackSuccBBMap[predBB] = pullbackSuccBB;
auto *enumEltDecl =
getPullbackInfo().lookUpBranchingTraceEnumElement(predBB, bb);
pullbackSuccessorCases.push_back({enumEltDecl, pullbackSuccBB});
}
// Values are trampolined by only a subset of pullback successor blocks.
// Other successors blocks should destroy the value.
for (auto pair : pullbackTrampolineBlockMap) {
auto value = pair.getFirst();
// The set of trampoline BBs that are users of `value`.
auto &userTrampolineBBSet = pair.getSecond();
// For each pullback successor block that does not trampoline the value,
// release the value.
for (auto origPredPbSuccPair : origPredpullbackSuccBBMap) {
auto *origPred = origPredPbSuccPair.getFirst();
auto *pbSucc = origPredPbSuccPair.getSecond();
if (userTrampolineBBSet.count(pbSucc))
continue;
TangentBuilder pullbackSuccBuilder(pbSucc->begin(), getContext());
pullbackSuccBuilder.setCurrentDebugScope(
remapScope(origPred->getTerminator()->getDebugScope()));
pullbackSuccBuilder.emitDestroyValueOperation(pbLoc, value);
}
}
// Emit cleanups for all block-local temporaries.
cleanUpTemporariesForBlock(pbBB, pbLoc);
// Branch to pullback successor blocks.
assert(pullbackSuccessorCases.size() == predEnum->getNumElements());
builder.createSwitchEnum(pbLoc, predEnumVal, /*DefaultBB*/ nullptr,
pullbackSuccessorCases, std::nullopt,
ProfileCounter(), OwnershipKind::Owned);
}
//--------------------------------------------------------------------------//
// Member accessor pullback generation
//--------------------------------------------------------------------------//
bool PullbackCloner::Implementation::runForSemanticMemberAccessor() {
auto &original = getOriginal();
auto *accessor = cast<AccessorDecl>(original.getDeclContext()->getAsDecl());
switch (accessor->getAccessorKind()) {
case AccessorKind::Get:
case AccessorKind::DistributedGet:
return runForSemanticMemberGetter();
case AccessorKind::Set:
return runForSemanticMemberSetter();
// TODO(https://github.com/apple/swift/issues/55084): Support `modify` accessors.
default:
llvm_unreachable("Unsupported accessor kind; inconsistent with "
"`isSemanticMemberAccessor`?");
}
}
bool PullbackCloner::Implementation::runForSemanticMemberGetter() {
auto &original = getOriginal();
auto &pullback = getPullback();
auto pbLoc = getPullback().getLocation();
auto *accessor = cast<AccessorDecl>(original.getDeclContext()->getAsDecl());
assert(accessor->getAccessorKind() == AccessorKind::Get);
auto *origEntry = original.getEntryBlock();
auto *pbEntry = pullback.getEntryBlock();
builder.setCurrentDebugScope(
remapScope(origEntry->getScopeOfFirstNonMetaInstruction()));
builder.setInsertionPoint(pbEntry);
// Get getter argument and result values.
// Getter type: $(Self) -> Result
// Pullback type: $(Result') -> Self'
assert(original.getLoweredFunctionType()->getNumParameters() == 1);
assert(pullback.getLoweredFunctionType()->getNumParameters() == 1);
assert(pullback.getLoweredFunctionType()->getNumResults() == 1);
SILValue origSelf = original.getArgumentsWithoutIndirectResults().front();
SmallVector<SILValue, 8> origFormalResults;
collectAllFormalResultsInTypeOrder(original, origFormalResults);
assert(getConfig().resultIndices->getNumIndices() == 1 &&
"Getter should have one semantic result");
auto origResult = origFormalResults[*getConfig().resultIndices->begin()];
auto tangentVectorSILTy = pullback.getConventions().getResults().front()
.getSILStorageType(getModule(),
pullback.getLoweredFunctionType(),
TypeExpansionContext::minimal());
auto tangentVectorTy = tangentVectorSILTy.getASTType();
auto *tangentVectorDecl = tangentVectorTy->getStructOrBoundGenericStruct();
// Look up the corresponding field in the tangent space.
auto *origField = cast<VarDecl>(accessor->getStorage());
auto baseType = remapType(origSelf->getType()).getASTType();
auto *tanField = getTangentStoredProperty(getContext(), origField, baseType,
pbLoc, getInvoker());
if (!tanField) {
errorOccurred = true;
return true;
}
// Switch based on the base tangent struct's value category.
switch (getTangentValueCategory(origSelf)) {
case SILValueCategory::Object: {
auto adjResult = getAdjointValue(origEntry, origResult);
switch (adjResult.getKind()) {
case AdjointValueKind::Zero:
addAdjointValue(origEntry, origSelf,
makeZeroAdjointValue(tangentVectorSILTy), pbLoc);
break;
case AdjointValueKind::Concrete:
case AdjointValueKind::Aggregate: {
SmallVector<AdjointValue, 8> eltVals;
for (auto *field : tangentVectorDecl->getStoredProperties()) {
if (field == tanField) {
eltVals.push_back(adjResult);
} else {
auto substMap = tangentVectorTy->getMemberSubstitutionMap(
field->getModuleContext(), field);
auto fieldTy = field->getInterfaceType().subst(substMap);
auto fieldSILTy = getTypeLowering(fieldTy).getLoweredType();
assert(fieldSILTy.isObject());
eltVals.push_back(makeZeroAdjointValue(fieldSILTy));
}
}
addAdjointValue(origEntry, origSelf,
makeAggregateAdjointValue(tangentVectorSILTy, eltVals),
pbLoc);
break;
}
case AdjointValueKind::AddElement:
llvm_unreachable("Adjoint of an aggregate type's field cannot be of kind "
"`AddElement`");
}
break;
}
case SILValueCategory::Address: {
assert(pullback.getIndirectResults().size() == 1);
auto pbIndRes = pullback.getIndirectResults().front();
auto *adjSelf = createFunctionLocalAllocation(
pbIndRes->getType().getObjectType(), pbLoc);
setAdjointBuffer(origEntry, origSelf, adjSelf);
for (auto *field : tangentVectorDecl->getStoredProperties()) {
auto *adjSelfElt = builder.createStructElementAddr(pbLoc, adjSelf, field);
// Non-tangent fields get a zero.
if (field != tanField) {
builder.emitZeroIntoBuffer(pbLoc, adjSelfElt, IsInitialization);
continue;
}
// Switch based on the property's value category.
switch (getTangentValueCategory(origResult)) {
case SILValueCategory::Object: {
auto adjResult = getAdjointValue(origEntry, origResult);
auto adjResultValue = materializeAdjointDirect(adjResult, pbLoc);
auto adjResultValueCopy =
builder.emitCopyValueOperation(pbLoc, adjResultValue);
builder.emitStoreValueOperation(pbLoc, adjResultValueCopy, adjSelfElt,
StoreOwnershipQualifier::Init);
break;
}
case SILValueCategory::Address: {
auto adjResult = getAdjointBuffer(origEntry, origResult);
builder.createCopyAddr(pbLoc, adjResult, adjSelfElt, IsTake,
IsInitialization);
destroyedLocalAllocations.insert(adjResult);
break;
}
}
}
break;
}
}
return false;
}
bool PullbackCloner::Implementation::runForSemanticMemberSetter() {
auto &original = getOriginal();
auto &pullback = getPullback();
auto pbLoc = getPullback().getLocation();
auto *accessor = cast<AccessorDecl>(original.getDeclContext()->getAsDecl());
assert(accessor->getAccessorKind() == AccessorKind::Set);
auto *origEntry = original.getEntryBlock();
auto *pbEntry = pullback.getEntryBlock();
builder.setCurrentDebugScope(
remapScope(origEntry->getScopeOfFirstNonMetaInstruction()));
builder.setInsertionPoint(pbEntry);
// Get setter argument values.
// Setter type: $(inout Self, Argument) -> ()
// Pullback type (wrt self): $(inout Self') -> ()
// Pullback type (wrt both): $(inout Self') -> Argument'
assert(original.getLoweredFunctionType()->getNumParameters() == 2);
assert(pullback.getLoweredFunctionType()->getNumParameters() == 1);
assert(pullback.getLoweredFunctionType()->getNumResults() == 0 ||
pullback.getLoweredFunctionType()->getNumResults() == 1);
SILValue origArg = original.getArgumentsWithoutIndirectResults()[0];
SILValue origSelf = original.getArgumentsWithoutIndirectResults()[1];
// Look up the corresponding field in the tangent space.
auto *origField = cast<VarDecl>(accessor->getStorage());
auto baseType = remapType(origSelf->getType()).getASTType();
auto *tanField = getTangentStoredProperty(getContext(), origField, baseType,
pbLoc, getInvoker());
if (!tanField) {
errorOccurred = true;
return true;
}
auto adjSelf = getAdjointBuffer(origEntry, origSelf);
auto *adjSelfElt = builder.createStructElementAddr(pbLoc, adjSelf, tanField);
// Switch based on the property's value category.
switch (getTangentValueCategory(origArg)) {
case SILValueCategory::Object: {
auto adjArg = builder.emitLoadValueOperation(pbLoc, adjSelfElt,
LoadOwnershipQualifier::Take);
setAdjointValue(origEntry, origArg, makeConcreteAdjointValue(adjArg));
blockTemporaries[pbEntry].insert(adjArg);
break;
}
case SILValueCategory::Address: {
addToAdjointBuffer(origEntry, origArg, adjSelfElt, pbLoc);
builder.emitDestroyOperation(pbLoc, adjSelfElt);
break;
}
}
builder.emitZeroIntoBuffer(pbLoc, adjSelfElt, IsInitialization);
return false;
}
//--------------------------------------------------------------------------//
// Adjoint buffer mapping
//--------------------------------------------------------------------------//
SILValue PullbackCloner::Implementation::getAdjointProjection(
SILBasicBlock *origBB, SILValue originalProjection) {
// Handle `struct_element_addr`.
// Adjoint projection: a `struct_element_addr` into the base adjoint buffer.
if (auto *seai = dyn_cast<StructElementAddrInst>(originalProjection)) {
assert(!seai->getField()->getAttrs().hasAttribute<NoDerivativeAttr>() &&
"`@noDerivative` struct projections should never be active");
auto adjSource = getAdjointBuffer(origBB, seai->getOperand());
auto structType = remapType(seai->getOperand()->getType()).getASTType();
auto *tanField =
getTangentStoredProperty(getContext(), seai, structType, getInvoker());
assert(tanField && "Invalid projections should have been diagnosed");
return builder.createStructElementAddr(seai->getLoc(), adjSource, tanField);
}
// Handle `tuple_element_addr`.
// Adjoint projection: a `tuple_element_addr` into the base adjoint buffer.
if (auto *teai = dyn_cast<TupleElementAddrInst>(originalProjection)) {
auto source = teai->getOperand();
auto adjSource = getAdjointBuffer(origBB, source);
if (!adjSource->getType().is<TupleType>())
return adjSource;
auto origTupleTy = source->getType().castTo<TupleType>();
unsigned adjIndex = 0;
for (unsigned i : range(teai->getFieldIndex())) {
if (getTangentSpace(
origTupleTy->getElement(i).getType()->getCanonicalType()))
++adjIndex;
}
return builder.createTupleElementAddr(teai->getLoc(), adjSource, adjIndex);
}
// Handle `ref_element_addr`.
// Adjoint projection: a local allocation initialized with the corresponding
// field value from the class's base adjoint value.
if (auto *reai = dyn_cast<RefElementAddrInst>(originalProjection)) {
assert(!reai->getField()->getAttrs().hasAttribute<NoDerivativeAttr>() &&
"`@noDerivative` class projections should never be active");
auto loc = reai->getLoc();
// Get the class operand, stripping `begin_borrow`.
auto classOperand = stripBorrow(reai->getOperand());
auto classType = remapType(reai->getOperand()->getType()).getASTType();
auto *tanField =
getTangentStoredProperty(getContext(), reai->getField(), classType,
reai->getLoc(), getInvoker());
assert(tanField && "Invalid projections should have been diagnosed");
// Create a local allocation for the element adjoint buffer.
auto eltTanType = tanField->getValueInterfaceType()->getCanonicalType();
auto eltTanSILType =
remapType(SILType::getPrimitiveAddressType(eltTanType));
auto *eltAdjBuffer = createFunctionLocalAllocation(eltTanSILType, loc);
// Check the class operand's `TangentVector` value category.
switch (getTangentValueCategory(classOperand)) {
case SILValueCategory::Object: {
// Get the class operand's adjoint value. Currently, it must be a
// `TangentVector` struct.
auto adjClass =
materializeAdjointDirect(getAdjointValue(origBB, classOperand), loc);
builder.emitScopedBorrowOperation(
loc, adjClass, [&](SILValue borrowedAdjClass) {
// Initialize the element adjoint buffer with the base adjoint
// value.
auto *adjElt =
builder.createStructExtract(loc, borrowedAdjClass, tanField);
auto adjEltCopy = builder.emitCopyValueOperation(loc, adjElt);
builder.emitStoreValueOperation(loc, adjEltCopy, eltAdjBuffer,
StoreOwnershipQualifier::Init);
});
return eltAdjBuffer;
}
case SILValueCategory::Address: {
// Get the class operand's adjoint buffer. Currently, it must be a
// `TangentVector` struct.
auto adjClass = getAdjointBuffer(origBB, classOperand);
// Initialize the element adjoint buffer with the base adjoint buffer.
auto *adjElt = builder.createStructElementAddr(loc, adjClass, tanField);
builder.createCopyAddr(loc, adjElt, eltAdjBuffer, IsNotTake,
IsInitialization);
return eltAdjBuffer;
}
}
}
// Handle `begin_access`.
// Adjoint projection: the base adjoint buffer itself.
if (auto *bai = dyn_cast<BeginAccessInst>(originalProjection)) {
auto adjBase = getAdjointBuffer(origBB, bai->getOperand());
if (errorOccurred)
return (bufferMap[{origBB, originalProjection}] = SILValue());
// Return the base buffer's adjoint buffer.
return adjBase;
}
// Handle `array.uninitialized_intrinsic` application element addresses.
// Adjoint projection: a local allocation initialized by applying
// `Array.TangentVector.subscript` to the base array's adjoint value.
auto *ai =
getAllocateUninitializedArrayIntrinsicElementAddress(originalProjection);
auto *definingInst = dyn_cast_or_null<SingleValueInstruction>(
originalProjection->getDefiningInstruction());
bool isAllocateUninitializedArrayIntrinsicElementAddress =
ai && definingInst &&
(isa<PointerToAddressInst>(definingInst) ||
isa<IndexAddrInst>(definingInst));
if (isAllocateUninitializedArrayIntrinsicElementAddress) {
// Get the array element index of the result address.
int eltIndex = 0;
if (auto *iai = dyn_cast<IndexAddrInst>(definingInst)) {
auto *ili = cast<IntegerLiteralInst>(iai->getIndex());
eltIndex = ili->getValue().getLimitedValue();
}
// Get the array adjoint value.
SILValue arrayAdjoint;
assert(ai && "Expected `array.uninitialized_intrinsic` application");
for (auto use : ai->getUses()) {
auto *dti = dyn_cast<DestructureTupleInst>(use->getUser());
if (!dti)
continue;
assert(!arrayAdjoint && "Array adjoint already found");
// The first `destructure_tuple` result is the `Array` value.
auto arrayValue = dti->getResult(0);
arrayAdjoint = materializeAdjointDirect(
getAdjointValue(origBB, arrayValue), definingInst->getLoc());
}
assert(arrayAdjoint && "Array does not have adjoint value");
// Apply `Array.TangentVector.subscript` to get array element adjoint value.
auto *eltAdjBuffer =
getArrayAdjointElementBuffer(arrayAdjoint, eltIndex, ai->getLoc());
return eltAdjBuffer;
}
return SILValue();
}
//----------------------------------------------------------------------------//
// Adjoint value accumulation
//----------------------------------------------------------------------------//
AdjointValue PullbackCloner::Implementation::accumulateAdjointsDirect(
AdjointValue lhs, AdjointValue rhs, SILLocation loc) {
LLVM_DEBUG(getADDebugStream() << "Accumulating adjoint directly.\nLHS: "
<< lhs << "\nRHS: " << rhs << '\n');
switch (lhs.getKind()) {
// x
case AdjointValueKind::Concrete: {
auto lhsVal = lhs.getConcreteValue();
switch (rhs.getKind()) {
// x + y
case AdjointValueKind::Concrete: {
auto rhsVal = rhs.getConcreteValue();
auto sum = recordTemporary(builder.emitAdd(loc, lhsVal, rhsVal));
return makeConcreteAdjointValue(sum);
}
// x + 0 => x
case AdjointValueKind::Zero:
return lhs;
// x + (y, z) => (x.0 + y, x.1 + z)
case AdjointValueKind::Aggregate: {
SmallVector<AdjointValue, 8> newElements;
auto lhsTy = lhsVal->getType().getASTType();
auto lhsValCopy = builder.emitCopyValueOperation(loc, lhsVal);
if (lhsTy->is<TupleType>()) {
auto elts = builder.createDestructureTuple(loc, lhsValCopy);
llvm::for_each(elts->getResults(),
[this](SILValue result) { recordTemporary(result); });
for (auto i : indices(elts->getResults())) {
auto rhsElt = rhs.getAggregateElement(i);
newElements.push_back(accumulateAdjointsDirect(
makeConcreteAdjointValue(elts->getResult(i)), rhsElt, loc));
}
} else if (lhsTy->getStructOrBoundGenericStruct()) {
auto elts =
builder.createDestructureStruct(lhsVal.getLoc(), lhsValCopy);
llvm::for_each(elts->getResults(),
[this](SILValue result) { recordTemporary(result); });
for (unsigned i : indices(elts->getResults())) {
auto rhsElt = rhs.getAggregateElement(i);
newElements.push_back(accumulateAdjointsDirect(
makeConcreteAdjointValue(elts->getResult(i)), rhsElt, loc));
}
} else {
llvm_unreachable("Not an aggregate type");
}
return makeAggregateAdjointValue(lhsVal->getType(), newElements);
}
// x + (baseAdjoint, index, eltToAdd) => (x+baseAdjoint, index, eltToAdd)
case AdjointValueKind::AddElement: {
auto *addElementValue = rhs.getAddElementValue();
auto baseAdjoint = addElementValue->baseAdjoint;
auto eltToAdd = addElementValue->eltToAdd;
auto newBaseAdjoint = accumulateAdjointsDirect(lhs, baseAdjoint, loc);
return makeAddElementAdjointValue(newBaseAdjoint, eltToAdd,
addElementValue->fieldLocator);
}
}
}
// 0
case AdjointValueKind::Zero:
// 0 + x => x
return rhs;
// (x, y)
case AdjointValueKind::Aggregate: {
switch (rhs.getKind()) {
// (x, y) + z => (z.0 + x, z.1 + y)
case AdjointValueKind::Concrete:
return accumulateAdjointsDirect(rhs, lhs, loc);
// x + 0 => x
case AdjointValueKind::Zero:
return lhs;
// (x, y) + (z, w) => (x + z, y + w)
case AdjointValueKind::Aggregate: {
SmallVector<AdjointValue, 8> newElements;
for (auto i : range(lhs.getNumAggregateElements()))
newElements.push_back(accumulateAdjointsDirect(
lhs.getAggregateElement(i), rhs.getAggregateElement(i), loc));
return makeAggregateAdjointValue(lhs.getType(), newElements);
}
// (x.0, ..., x.n) + (baseAdjoint, index, eltToAdd) => (x + baseAdjoint,
// index, eltToAdd)
case AdjointValueKind::AddElement: {
auto *addElementValue = rhs.getAddElementValue();
auto baseAdjoint = addElementValue->baseAdjoint;
auto eltToAdd = addElementValue->eltToAdd;
auto newBaseAdjoint = accumulateAdjointsDirect(lhs, baseAdjoint, loc);
return makeAddElementAdjointValue(newBaseAdjoint, eltToAdd,
addElementValue->fieldLocator);
}
}
}
// (baseAdjoint, index, eltToAdd)
case AdjointValueKind::AddElement: {
switch (rhs.getKind()) {
case AdjointValueKind::Zero:
return lhs;
// (baseAdjoint, index, eltToAdd) + x => (x + baseAdjoint, index, eltToAdd)
case AdjointValueKind::Concrete:
// (baseAdjoint, index, eltToAdd) + (x.0, ..., x.n) => (x + baseAdjoint,
// index, eltToAdd)
case AdjointValueKind::Aggregate:
return accumulateAdjointsDirect(rhs, lhs, loc);
// (baseAdjoint1, index1, eltToAdd1) + (baseAdjoint2, index2, eltToAdd2)
// => ((baseAdjoint1 + baseAdjoint2, index1, eltToAdd1), index2, eltToAdd2)
case AdjointValueKind::AddElement: {
auto *addElementValueLhs = lhs.getAddElementValue();
auto baseAdjointLhs = addElementValueLhs->baseAdjoint;
auto eltToAddLhs = addElementValueLhs->eltToAdd;
auto *addElementValueRhs = rhs.getAddElementValue();
auto baseAdjointRhs = addElementValueRhs->baseAdjoint;
auto eltToAddRhs = addElementValueRhs->eltToAdd;
auto sumOfBaseAdjoints =
accumulateAdjointsDirect(baseAdjointLhs, baseAdjointRhs, loc);
auto newBaseAdjoint = makeAddElementAdjointValue(
sumOfBaseAdjoints, eltToAddLhs, addElementValueLhs->fieldLocator);
return makeAddElementAdjointValue(newBaseAdjoint, eltToAddRhs,
addElementValueRhs->fieldLocator);
}
}
}
}
llvm_unreachable("Invalid adjoint value kind"); // silences MSVC C4715
}
//----------------------------------------------------------------------------//
// Array literal initialization differentiation
//----------------------------------------------------------------------------//
void PullbackCloner::Implementation::
accumulateArrayLiteralElementAddressAdjoints(SILBasicBlock *origBB,
SILValue originalValue,
AdjointValue arrayAdjointValue,
SILLocation loc) {
// Return if the original value is not the `Array` result of an
// `array.uninitialized_intrinsic` application.
auto *dti = dyn_cast_or_null<DestructureTupleInst>(
originalValue->getDefiningInstruction());
if (!dti)
return;
if (!ArraySemanticsCall(dti->getOperand(),
semantics::ARRAY_UNINITIALIZED_INTRINSIC))
return;
if (originalValue != dti->getResult(0))
return;
// Accumulate the array's adjoint value into the adjoint buffers of its
// element addresses: `pointer_to_address` and `index_addr` instructions.
LLVM_DEBUG(getADDebugStream()
<< "Accumulating adjoint value for array literal into element "
"address adjoint buffers"
<< originalValue);
auto arrayAdjoint = materializeAdjointDirect(arrayAdjointValue, loc);
builder.setCurrentDebugScope(remapScope(dti->getDebugScope()));
builder.setInsertionPoint(arrayAdjoint->getParentBlock());
for (auto use : dti->getResult(1)->getUses()) {
auto *mdi = dyn_cast<MarkDependenceInst>(use->getUser());
assert(mdi && "Expected mark_dependence user");
auto *ptai =
dyn_cast_or_null<PointerToAddressInst>(getSingleNonDebugUser(mdi));
assert(ptai && "Expected pointer_to_address user");
auto adjBuf = getAdjointBuffer(origBB, ptai);
auto *eltAdjBuf = getArrayAdjointElementBuffer(arrayAdjoint, 0, loc);
builder.emitInPlaceAdd(loc, adjBuf, eltAdjBuf);
for (auto use : ptai->getUses()) {
if (auto *iai = dyn_cast<IndexAddrInst>(use->getUser())) {
auto *ili = cast<IntegerLiteralInst>(iai->getIndex());
auto eltIndex = ili->getValue().getLimitedValue();
auto adjBuf = getAdjointBuffer(origBB, iai);
auto *eltAdjBuf =
getArrayAdjointElementBuffer(arrayAdjoint, eltIndex, loc);
builder.emitInPlaceAdd(loc, adjBuf, eltAdjBuf);
}
}
}
}
AllocStackInst *PullbackCloner::Implementation::getArrayAdjointElementBuffer(
SILValue arrayAdjoint, int eltIndex, SILLocation loc) {
auto &ctx = builder.getASTContext();
auto arrayTanType = cast<StructType>(arrayAdjoint->getType().getASTType());
auto arrayType = arrayTanType->getParent()->castTo<BoundGenericStructType>();
auto eltTanType = arrayType->getGenericArgs().front()->getCanonicalType();
auto eltTanSILType = remapType(SILType::getPrimitiveAddressType(eltTanType));
// Get `function_ref` and generic signature of
// `Array.TangentVector.subscript.getter`.
auto *arrayTanStructDecl = arrayTanType->getStructOrBoundGenericStruct();
auto subscriptLookup =
arrayTanStructDecl->lookupDirect(DeclBaseName::createSubscript());
SubscriptDecl *subscriptDecl = nullptr;
for (auto *candidate : subscriptLookup) {
auto candidateModule = candidate->getModuleContext();
if (candidateModule->getName() == ctx.Id_Differentiation ||
candidateModule->isStdlibModule()) {
assert(!subscriptDecl && "Multiple `Array.TangentVector.subscript`s");
subscriptDecl = cast<SubscriptDecl>(candidate);
#ifdef NDEBUG
break;
#endif
}
}
assert(subscriptDecl && "No `Array.TangentVector.subscript`");
auto *subscriptGetterDecl =
subscriptDecl->getOpaqueAccessor(AccessorKind::Get);
assert(subscriptGetterDecl && "No `Array.TangentVector.subscript` getter");
SILOptFunctionBuilder fb(getContext().getTransform());
auto *subscriptGetterFn = fb.getOrCreateFunction(
loc, SILDeclRef(subscriptGetterDecl), NotForDefinition);
// %subscript_fn = function_ref @Array.TangentVector<T>.subscript.getter
auto *subscriptFnRef = builder.createFunctionRef(loc, subscriptGetterFn);
auto subscriptFnGenSig =
subscriptGetterFn->getLoweredFunctionType()->getSubstGenericSignature();
// Apply `Array.TangentVector.subscript.getter` to get array element adjoint
// buffer.
// %index_literal = integer_literal $Builtin.IntXX, <index>
auto builtinIntType =
SILType::getPrimitiveObjectType(ctx.getIntDecl()
->getStoredProperties()
.front()
->getInterfaceType()
->getCanonicalType());
auto *eltIndexLiteral =
builder.createIntegerLiteral(loc, builtinIntType, eltIndex);
auto intType = SILType::getPrimitiveObjectType(
ctx.getIntType()->getCanonicalType());
// %index_int = struct $Int (%index_literal)
auto *eltIndexInt = builder.createStruct(loc, intType, {eltIndexLiteral});
auto *swiftModule = getModule().getSwiftModule();
auto *diffProto = ctx.getProtocol(KnownProtocolKind::Differentiable);
auto diffConf = swiftModule->lookupConformance(eltTanType, diffProto);
assert(!diffConf.isInvalid() && "Missing conformance to `Differentiable`");
auto *addArithProto = ctx.getProtocol(KnownProtocolKind::AdditiveArithmetic);
auto addArithConf = swiftModule->lookupConformance(eltTanType, addArithProto);
assert(!addArithConf.isInvalid() &&
"Missing conformance to `AdditiveArithmetic`");
auto subMap = SubstitutionMap::get(subscriptFnGenSig, {eltTanType},
{addArithConf, diffConf});
// %elt_adj = alloc_stack $T.TangentVector
// Create and register a local allocation.
auto *eltAdjBuffer = createFunctionLocalAllocation(
eltTanSILType, loc, /*zeroInitialize*/ true);
// Immediately destroy the emitted zero value.
// NOTE: It is not efficient to emit a zero value then immediately destroy
// it. However, it was the easiest way to to avoid "lifetime mismatch in
// predecessors" memory lifetime verification errors for control flow
// differentiation.
// Perhaps we can avoid emitting a zero value if local allocations are created
// per pullback bb instead of all in the pullback entry: TF-1075.
builder.emitDestroyOperation(loc, eltAdjBuffer);
// apply %subscript_fn<T.TangentVector>(%elt_adj, %index_int, %array_adj)
builder.createApply(loc, subscriptFnRef, subMap,
{eltAdjBuffer, eltIndexInt, arrayAdjoint});
return eltAdjBuffer;
}
} // end namespace autodiff
} // end namespace swift
|