1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940
|
/* scheduler.c -*-C-*-
*
*************************************************************************
*
* @copyright
* Copyright (C) 2007-2013, Intel Corporation
* All rights reserved.
*
* @copyright
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* * Neither the name of Intel Corporation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* @copyright
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
* HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
* INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
* BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
* OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
* LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
* WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*
**************************************************************************/
/*
* Cilk scheduler
*/
#include "scheduler.h"
#include "bug.h"
#include "os.h"
#include "os_mutex.h"
#include "local_state.h"
#include "signal_node.h"
#include "full_frame.h"
#include "sysdep.h"
#include "except.h"
#include "cilk_malloc.h"
#include "pedigrees.h"
#include "record-replay.h"
#include <limits.h>
#include <string.h> /* memcpy */
#include <stdio.h> // sprintf
#include <stdlib.h> // malloc, free, abort
#ifdef _WIN32
# pragma warning(disable:1786) // disable warning: sprintf is deprecated
# include "sysdep-win.h"
# include "except-win32.h"
#endif // _WIN32
// ICL: Don't complain about conversion from pointer to same-sized integral
// type in __cilkrts_put_stack. That's why we're using ptrdiff_t
#ifdef _WIN32
# pragma warning(disable: 1684)
#endif
#include "cilk/cilk_api.h"
#include "frame_malloc.h"
#include "metacall_impl.h"
#include "reducer_impl.h"
#include "cilk-tbb-interop.h"
#include "cilk-ittnotify.h"
#include "stats.h"
// ICL: Don't complain about loss of precision in myrand
// I tried restoring the warning after the function, but it didn't
// suppress it
#ifdef _WIN32
# pragma warning(disable: 2259)
#endif
#ifndef _WIN32
# include <unistd.h>
#endif
#ifdef __VXWORKS__
// redeclare longjmp() with noreturn to stop warnings
extern __attribute__((noreturn))
void longjmp(jmp_buf, int);
#endif
//#define DEBUG_LOCKS 1
#ifdef DEBUG_LOCKS
// The currently executing worker must own this worker's lock
# define ASSERT_WORKER_LOCK_OWNED(w) \
{ \
__cilkrts_worker *tls_worker = __cilkrts_get_tls_worker(); \
CILK_ASSERT((w)->l->lock.owner == tls_worker); \
}
#else
# define ASSERT_WORKER_LOCK_OWNED(w)
#endif // DEBUG_LOCKS
// Options for the scheduler.
enum schedule_t { SCHEDULE_RUN,
SCHEDULE_WAIT,
SCHEDULE_EXIT };
// Return values for provably_good_steal()
enum provably_good_steal_t
{
ABANDON_EXECUTION, // Not the last child to the sync - attempt to steal work
CONTINUE_EXECUTION, // Last child to the sync - continue executing on this worker
WAIT_FOR_CONTINUE // The replay log indicates that this was the worker
// which continued. Loop until we are the last worker
// to the sync.
};
// Verify that "w" is the worker we are currently executing on.
// Because this check is expensive, this method is usually a no-op.
static inline void verify_current_wkr(__cilkrts_worker *w)
{
#if ((REDPAR_DEBUG >= 3) || (FIBER_DEBUG >= 1))
// Lookup the worker from TLS and compare to w.
__cilkrts_worker* tmp = __cilkrts_get_tls_worker();
if (w != tmp) {
fprintf(stderr, "Error. W=%d, actual worker =%d...\n",
w->self,
tmp->self);
}
CILK_ASSERT(w == tmp);
#endif
}
static enum schedule_t worker_runnable(__cilkrts_worker *w);
// Scheduling-fiber functions:
static void do_return_from_spawn (__cilkrts_worker *w,
full_frame *ff,
__cilkrts_stack_frame *sf);
static void do_sync (__cilkrts_worker *w,
full_frame *ff,
__cilkrts_stack_frame *sf);
// max is defined on Windows and VxWorks
#if (! defined(_WIN32)) && (! defined(__VXWORKS__))
// TBD: definition of max() for Linux.
# define max(a, b) ((a) < (b) ? (b) : (a))
#endif
void __cilkrts_dump_stats_to_stderr(global_state_t *g)
{
#ifdef CILK_PROFILE
int i;
for (i = 0; i < g->total_workers; ++i) {
// Print out statistics for each worker. We collected them,
// so why not print them out?
fprintf(stderr, "Stats for worker %d\n", i);
dump_stats_to_file(stderr, g->workers[i]->l->stats);
__cilkrts_accum_stats(&g->stats, g->workers[i]->l->stats);
}
// Also print out aggregate statistics.
dump_stats_to_file(stderr, &g->stats);
#endif
fprintf(stderr,
"CILK PLUS Thread Info: P=%d, Q=%d\n",
g->P,
g->Q);
fprintf(stderr,
"CILK PLUS RUNTIME MEMORY USAGE: %lld bytes",
(long long)g->frame_malloc.allocated_from_os);
#ifdef CILK_PROFILE
if (g->stats.stack_hwm)
fprintf(stderr, ", %ld stacks", g->stats.stack_hwm);
#endif
fputc('\n', stderr);
}
static void validate_worker(__cilkrts_worker *w)
{
/* check the magic numbers, for debugging purposes */
if (w->l->worker_magic_0 != WORKER_MAGIC_0 ||
w->l->worker_magic_1 != WORKER_MAGIC_1)
abort_because_rts_is_corrupted();
}
static void double_link(full_frame *left_ff, full_frame *right_ff)
{
if (left_ff)
left_ff->right_sibling = right_ff;
if (right_ff)
right_ff->left_sibling = left_ff;
}
/* add CHILD to the right of all children of PARENT */
static void push_child(full_frame *parent_ff, full_frame *child_ff)
{
double_link(parent_ff->rightmost_child, child_ff);
double_link(child_ff, 0);
parent_ff->rightmost_child = child_ff;
}
/* unlink CHILD from the list of all children of PARENT */
static void unlink_child(full_frame *parent_ff, full_frame *child_ff)
{
double_link(child_ff->left_sibling, child_ff->right_sibling);
if (!child_ff->right_sibling) {
/* this is the rightmost child -- update parent link */
CILK_ASSERT(parent_ff->rightmost_child == child_ff);
parent_ff->rightmost_child = child_ff->left_sibling;
}
child_ff->left_sibling = child_ff->right_sibling = 0; /* paranoia */
}
static void incjoin(full_frame *ff)
{
++ff->join_counter;
}
static int decjoin(full_frame *ff)
{
CILK_ASSERT(ff->join_counter > 0);
return (--ff->join_counter);
}
static int simulate_decjoin(full_frame *ff)
{
CILK_ASSERT(ff->join_counter > 0);
return (ff->join_counter - 1);
}
/*
* Pseudo-random generator defined by the congruence S' = 69070 * S
* mod (2^32 - 5). Marsaglia (CACM July 1993) says on page 107 that
* this is a ``good one''. There you go.
*
* The literature makes a big fuss about avoiding the division, but
* for us it is not worth the hassle.
*/
static const unsigned RNGMOD = ((1ULL << 32) - 5);
static const unsigned RNGMUL = 69070U;
static unsigned myrand(__cilkrts_worker *w)
{
unsigned state = w->l->rand_seed;
state = (unsigned)((RNGMUL * (unsigned long long)state) % RNGMOD);
w->l->rand_seed = state;
return state;
}
static void mysrand(__cilkrts_worker *w, unsigned seed)
{
seed %= RNGMOD;
seed += (seed == 0); /* 0 does not belong to the multiplicative
group. Use 1 instead */
w->l->rand_seed = seed;
}
/* W grabs its own lock */
void __cilkrts_worker_lock(__cilkrts_worker *w)
{
validate_worker(w);
CILK_ASSERT(w->l->do_not_steal == 0);
/* tell thieves to stay out of the way */
w->l->do_not_steal = 1;
__cilkrts_fence(); /* probably redundant */
__cilkrts_mutex_lock(w, &w->l->lock);
}
void __cilkrts_worker_unlock(__cilkrts_worker *w)
{
__cilkrts_mutex_unlock(w, &w->l->lock);
CILK_ASSERT(w->l->do_not_steal == 1);
/* The fence is probably redundant. Use a release
operation when supported (gcc and compatibile);
that is faster on x86 which serializes normal stores. */
#if defined __GNUC__ && (__GNUC__ * 10 + __GNUC_MINOR__ > 43 || __ICC >= 1110)
__sync_lock_release(&w->l->do_not_steal);
#else
w->l->do_not_steal = 0;
__cilkrts_fence(); /* store-store barrier, redundant on x86 */
#endif
}
/* try to acquire the lock of some *other* worker */
static int worker_trylock_other(__cilkrts_worker *w,
__cilkrts_worker *other)
{
int status = 0;
validate_worker(other);
/* This protocol guarantees that, after setting the DO_NOT_STEAL
flag, worker W can enter its critical section after waiting for
the thief currently in the critical section (if any) and at
most one other thief.
This requirement is overly paranoid, but it should protect us
against future nonsense from OS implementors.
*/
/* compete for the right to disturb OTHER */
if (__cilkrts_mutex_trylock(w, &other->l->steal_lock)) {
if (other->l->do_not_steal) {
/* leave it alone */
} else {
status = __cilkrts_mutex_trylock(w, &other->l->lock);
}
__cilkrts_mutex_unlock(w, &other->l->steal_lock);
}
return status;
}
static void worker_unlock_other(__cilkrts_worker *w,
__cilkrts_worker *other)
{
__cilkrts_mutex_unlock(w, &other->l->lock);
}
/* Lock macro Usage:
BEGIN_WITH_WORKER_LOCK(w) {
statement;
statement;
BEGIN_WITH_FRAME_LOCK(w, ff) {
statement;
statement;
} END_WITH_FRAME_LOCK(w, ff);
} END_WITH_WORKER_LOCK(w);
*/
#define BEGIN_WITH_WORKER_LOCK(w) __cilkrts_worker_lock(w); do
#define END_WITH_WORKER_LOCK(w) while (__cilkrts_worker_unlock(w), 0)
// TBD(jsukha): These are worker lock acquistions on
// a worker whose deque is empty. My conjecture is that we
// do not need to hold the worker lock at these points.
// I have left them in for now, however.
//
// #define REMOVE_POSSIBLY_OPTIONAL_LOCKS
#ifdef REMOVE_POSSIBLY_OPTIONAL_LOCKS
#define BEGIN_WITH_WORKER_LOCK_OPTIONAL(w) do
#define END_WITH_WORKER_LOCK_OPTIONAL(w) while (0)
#else
#define BEGIN_WITH_WORKER_LOCK_OPTIONAL(w) __cilkrts_worker_lock(w); do
#define END_WITH_WORKER_LOCK_OPTIONAL(w) while (__cilkrts_worker_unlock(w), 0)
#endif
#define BEGIN_WITH_FRAME_LOCK(w, ff) \
do { full_frame *_locked_ff = ff; __cilkrts_frame_lock(w, _locked_ff); do
#define END_WITH_FRAME_LOCK(w, ff) \
while (__cilkrts_frame_unlock(w, _locked_ff), 0); } while (0)
/* W becomes the owner of F and F can be stolen from W */
static void make_runnable(__cilkrts_worker *w, full_frame *ff)
{
w->l->frame_ff = ff;
/* CALL_STACK is invalid (the information is stored implicitly in W) */
ff->call_stack = 0;
}
/*
* The worker parameter is unused, except for print-debugging purposes.
*/
static void make_unrunnable(__cilkrts_worker *w,
full_frame *ff,
__cilkrts_stack_frame *sf,
int is_loot,
const char *why)
{
/* CALL_STACK becomes valid again */
ff->call_stack = sf;
if (sf) {
#if CILK_LIB_DEBUG
if (__builtin_expect(sf->flags & CILK_FRAME_EXITING, 0))
__cilkrts_bug("W%d suspending exiting frame %p/%p\n", w->self, ff, sf);
#endif
sf->flags |= CILK_FRAME_STOLEN | CILK_FRAME_SUSPENDED;
sf->worker = 0;
if (is_loot)
__cilkrts_put_stack(ff, sf);
/* perform any system-dependent action, such as saving the
state of the stack */
__cilkrts_make_unrunnable_sysdep(w, ff, sf, is_loot, why);
}
}
/* Push the next full frame to be made active in this worker and increment its
* join counter. __cilkrts_push_next_frame and pop_next_frame work on a
* one-element queue. This queue is used to communicate across the runtime
* from the code that wants to activate a frame to the code that can actually
* begin execution on that frame. They are asymetrical in that push
* increments the join counter but pop does not decrement it. Rather, a
* single push/pop combination makes a frame active and increments its join
* counter once. */
void __cilkrts_push_next_frame(__cilkrts_worker *w, full_frame *ff)
{
CILK_ASSERT(ff);
CILK_ASSERT(!w->l->next_frame_ff);
incjoin(ff);
w->l->next_frame_ff = ff;
}
/* Get the next full-frame to be made active in this worker. The join count
* of the full frame will have been incremented by the corresponding push
* event. See __cilkrts_push_next_frame, above.
*/
static full_frame *pop_next_frame(__cilkrts_worker *w)
{
full_frame *ff;
ff = w->l->next_frame_ff;
// Remove the frame from the next_frame field.
//
// If this is a user worker, then there is a chance that another worker
// from our team could push work into our next_frame (if it is the last
// worker doing work for this team). The other worker's setting of the
// next_frame could race with our setting of next_frame to NULL. This is
// the only possible race condition on next_frame. However, if next_frame
// has a non-NULL value, then it means the team still has work to do, and
// there is no chance of another team member populating next_frame. Thus,
// it is safe to set next_frame to NULL, if it was populated. There is no
// need for an atomic op.
if (NULL != ff) {
w->l->next_frame_ff = NULL;
}
return ff;
}
/*
* Identify the single worker that is allowed to cross a sync in this frame. A
* thief should call this function when it is the first to steal work from a
* user worker. "First to steal work" may mean that there has been parallelism
* in the user worker before, but the whole team sync'd, and this is the first
* steal after that.
*
* This should happen while holding the worker and frame lock.
*/
static void set_sync_master(__cilkrts_worker *w, full_frame *ff)
{
w->l->last_full_frame = ff;
ff->sync_master = w;
}
/*
* The sync that ends all parallelism for a particular user worker is about to
* be crossed. Decouple the worker and frame.
*
* No locks need to be held since the user worker isn't doing anything, and none
* of the system workers can steal from it. But unset_sync_master() should be
* called before the user worker knows about this work (i.e., before it is
* inserted into the w->l->next_frame_ff is set).
*/
static void unset_sync_master(__cilkrts_worker *w, full_frame *ff)
{
CILK_ASSERT(WORKER_USER == w->l->type);
CILK_ASSERT(ff->sync_master == w);
ff->sync_master = NULL;
w->l->last_full_frame = NULL;
}
/********************************************************************
* THE protocol:
********************************************************************/
/*
* This is a protocol for work stealing that minimizes the overhead on
* the victim.
*
* The protocol uses three shared pointers into the worker's deque:
* - T - the "tail"
* - H - the "head"
* - E - the "exception" NB: In this case, "exception" has nothing to do
* with C++ throw-catch exceptions -- it refers only to a non-normal return,
* i.e., a steal or similar scheduling exception.
*
* with H <= E, H <= T.
*
* Stack frames SF, where H <= E < T, are available for stealing.
*
* The worker operates on the T end of the stack. The frame being
* worked on is not on the stack. To make a continuation available for
* stealing the worker pushes a from onto the stack: stores *T++ = SF.
* To return, it pops the frame off the stack: obtains SF = *--T.
*
* After decrementing T, the condition E > T signals to the victim that
* it should invoke the runtime system's "THE" exception handler. The
* pointer E can become INFINITY, in which case the victim must invoke
* the THE exception handler as soon as possible.
*
* See "The implementation of the Cilk-5 multithreaded language", PLDI 1998,
* http://portal.acm.org/citation.cfm?doid=277652.277725, for more information
* on the THE protocol.
*/
/* the infinity value of E */
#define EXC_INFINITY ((__cilkrts_stack_frame **) (-1))
static void increment_E(__cilkrts_worker *victim)
{
__cilkrts_stack_frame *volatile *tmp;
// The currently executing worker must own the worker lock to touch
// victim->exc
ASSERT_WORKER_LOCK_OWNED(victim);
tmp = victim->exc;
if (tmp != EXC_INFINITY) {
/* On most x86 this pair of operations would be slightly faster
as an atomic exchange due to the implicit memory barrier in
an atomic instruction. */
victim->exc = tmp + 1;
__cilkrts_fence();
}
}
static void decrement_E(__cilkrts_worker *victim)
{
__cilkrts_stack_frame *volatile *tmp;
// The currently executing worker must own the worker lock to touch
// victim->exc
ASSERT_WORKER_LOCK_OWNED(victim);
tmp = victim->exc;
if (tmp != EXC_INFINITY) {
/* On most x86 this pair of operations would be slightly faster
as an atomic exchange due to the implicit memory barrier in
an atomic instruction. */
victim->exc = tmp - 1;
__cilkrts_fence(); /* memory fence not really necessary */
}
}
#if 0
/* for now unused, will be necessary if we implement abort */
static void signal_THE_exception(__cilkrts_worker *wparent)
{
wparent->exc = EXC_INFINITY;
__cilkrts_fence();
}
#endif
static void reset_THE_exception(__cilkrts_worker *w)
{
// The currently executing worker must own the worker lock to touch
// w->exc
ASSERT_WORKER_LOCK_OWNED(w);
w->exc = w->head;
__cilkrts_fence();
}
/* conditions under which victim->head can be stolen: */
static int can_steal_from(__cilkrts_worker *victim)
{
return ((victim->head < victim->tail) &&
(victim->head < victim->protected_tail));
}
/* Return TRUE if the frame can be stolen, false otherwise */
static int dekker_protocol(__cilkrts_worker *victim)
{
// increment_E and decrement_E are going to touch victim->exc. The
// currently executing worker must own victim's lock before they can
// modify it
ASSERT_WORKER_LOCK_OWNED(victim);
/* ASSERT(E >= H); */
increment_E(victim);
/* ASSERT(E >= H + 1); */
if (can_steal_from(victim)) {
/* success, we can steal victim->head and set H <- H + 1
in detach() */
return 1;
} else {
/* failure, restore previous state */
decrement_E(victim);
return 0;
}
}
/* Link PARENT and CHILD in the spawn tree */
static full_frame *make_child(__cilkrts_worker *w,
full_frame *parent_ff,
__cilkrts_stack_frame *child_sf,
cilk_fiber *fiber)
{
full_frame *child_ff = __cilkrts_make_full_frame(w, child_sf);
child_ff->parent = parent_ff;
push_child(parent_ff, child_ff);
//DBGPRINTF("%d- make_child - child_frame: %p, parent_frame: %p, child_sf: %p\n"
// " parent - parent: %p, left_sibling: %p, right_sibling: %p, rightmost_child: %p\n"
// " child - parent: %p, left_sibling: %p, right_sibling: %p, rightmost_child: %p\n",
// w->self, child, parent, child_sf,
// parent->parent, parent->left_sibling, parent->right_sibling, parent->rightmost_child,
// child->parent, child->left_sibling, child->right_sibling, child->rightmost_child);
CILK_ASSERT(parent_ff->call_stack);
child_ff->is_call_child = (fiber == NULL);
/* PLACEHOLDER_FIBER is used as non-null marker indicating that
child should be treated as a spawn child even though we have not
yet assigned a real fiber to its parent. */
if (fiber == PLACEHOLDER_FIBER)
fiber = NULL; /* Parent actually gets a null fiber, for now */
/* perform any system-dependent actions, such as capturing
parameter passing information */
/*__cilkrts_make_child_sysdep(child, parent);*/
/* Child gets reducer map and stack of parent.
Parent gets a new map and new stack. */
child_ff->fiber_self = parent_ff->fiber_self;
child_ff->sync_master = NULL;
if (child_ff->is_call_child) {
/* Cause segfault on any attempted access. The parent gets
the child map and stack when the child completes. */
parent_ff->fiber_self = 0;
} else {
parent_ff->fiber_self = fiber;
}
incjoin(parent_ff);
return child_ff;
}
static inline __cilkrts_stack_frame *__cilkrts_advance_frame(__cilkrts_stack_frame *sf)
{
__cilkrts_stack_frame *p = sf->call_parent;
sf->call_parent = 0;
return p;
}
/* w should be the currently executing worker.
* loot_sf is the youngest stack frame in the call stack being
* unrolled (i.e., the most deeply nested stack frame.)
*
* When this method is called for a steal, loot_sf should be on a
* victim worker which is different from w.
* For CILK_FORCE_REDUCE, the victim worker will equal w.
*
* Before execution, the __cilkrts_stack_frame's have pointers from
* older to younger, i.e., a __cilkrts_stack_frame points to parent.
*
* This method creates a full frame for each __cilkrts_stack_frame in
* the call stack, with each full frame also pointing to its parent.
*
* The method returns the full frame created for loot_sf, i.e., the
* youngest full frame.
*/
static full_frame *unroll_call_stack(__cilkrts_worker *w,
full_frame *ff,
__cilkrts_stack_frame *const loot_sf)
{
__cilkrts_stack_frame *sf = loot_sf;
__cilkrts_stack_frame *rev_sf = 0;
__cilkrts_stack_frame *t_sf;
CILK_ASSERT(sf);
/*CILK_ASSERT(sf->call_parent != sf);*/
/* The leafmost frame is unsynched. */
if (sf->worker != w)
sf->flags |= CILK_FRAME_UNSYNCHED;
/* Reverse the call stack to make a linked list ordered from parent
to child. sf->call_parent points to the child of SF instead of
the parent. */
do {
t_sf = (sf->flags & (CILK_FRAME_DETACHED|CILK_FRAME_STOLEN|CILK_FRAME_LAST))? 0 : sf->call_parent;
sf->call_parent = rev_sf;
rev_sf = sf;
sf = t_sf;
} while (sf);
sf = rev_sf;
/* Promote each stack frame to a full frame in order from parent
to child, following the reversed list we just built. */
make_unrunnable(w, ff, sf, sf == loot_sf, "steal 1");
/* T is the *child* of SF, because we have reversed the list */
for (t_sf = __cilkrts_advance_frame(sf); t_sf;
sf = t_sf, t_sf = __cilkrts_advance_frame(sf)) {
ff = make_child(w, ff, t_sf, NULL);
make_unrunnable(w, ff, t_sf, t_sf == loot_sf, "steal 2");
}
/* XXX What if the leafmost frame does not contain a sync
and this steal is from promote own deque? */
/*sf->flags |= CILK_FRAME_UNSYNCHED;*/
CILK_ASSERT(!sf->call_parent);
return ff;
}
/* detach the top of the deque frame from the VICTIM and install a new
CHILD frame in its place */
static void detach_for_steal(__cilkrts_worker *w,
__cilkrts_worker *victim,
cilk_fiber* fiber)
{
/* ASSERT: we own victim->lock */
full_frame *parent_ff, *child_ff, *loot_ff;
__cilkrts_stack_frame *volatile *h;
__cilkrts_stack_frame *sf;
w->l->team = victim->l->team;
CILK_ASSERT(w->l->frame_ff == 0 || w == victim);
h = victim->head;
CILK_ASSERT(*h);
victim->head = h + 1;
parent_ff = victim->l->frame_ff;
BEGIN_WITH_FRAME_LOCK(w, parent_ff) {
/* parent no longer referenced by victim */
decjoin(parent_ff);
/* obtain the victim call stack */
sf = *h;
/* perform system-dependent normalizations */
/*__cilkrts_normalize_call_stack_on_steal(sf);*/
/* unroll PARENT_FF with call stack SF, adopt the youngest
frame LOOT. If loot_ff == parent_ff, then we hold loot_ff->lock,
otherwise, loot_ff is newly created and we can modify it without
holding its lock. */
loot_ff = unroll_call_stack(w, parent_ff, sf);
#if REDPAR_DEBUG >= 3
fprintf(stderr, "[W=%d, victim=%d, desc=detach, parent_ff=%p, loot=%p]\n",
w->self, victim->self,
parent_ff, loot_ff);
#endif
if (WORKER_USER == victim->l->type &&
NULL == victim->l->last_full_frame) {
// Mark this looted frame as special: only the original user worker
// may cross the sync.
//
// This call is a shared access to
// victim->l->last_full_frame.
set_sync_master(victim, loot_ff);
}
/* LOOT is the next frame that the thief W is supposed to
run, unless the thief is stealing from itself, in which
case the thief W == VICTIM executes CHILD and nobody
executes LOOT. */
if (w == victim) {
/* Pretend that frame has been stolen */
loot_ff->call_stack->flags |= CILK_FRAME_UNSYNCHED;
loot_ff->simulated_stolen = 1;
}
else
__cilkrts_push_next_frame(w, loot_ff);
// After this "push_next_frame" call, w now owns loot_ff.
child_ff = make_child(w, loot_ff, 0, fiber);
BEGIN_WITH_FRAME_LOCK(w, child_ff) {
/* install child in the victim's work queue, taking
the parent_ff's place */
/* child is referenced by victim */
incjoin(child_ff);
// With this call, w is bestowing ownership of the newly
// created frame child_ff to the victim, and victim is
// giving up ownership of parent_ff.
//
// Worker w will either take ownership of parent_ff
// if parent_ff == loot_ff, or parent_ff will be
// suspended.
//
// Note that this call changes the victim->frame_ff
// while the victim may be executing.
make_runnable(victim, child_ff);
} END_WITH_FRAME_LOCK(w, child_ff);
} END_WITH_FRAME_LOCK(w, parent_ff);
}
/**
* @brief cilk_fiber_proc that resumes user code after a successful
* random steal.
* This function longjmps back into the user code whose state is
* stored in cilk_fiber_get_data(fiber)->resume_sf. The stack pointer
* is adjusted so that the code resumes on the specified fiber stack
* instead of its original stack.
*
* This method gets executed only on a fiber freshly allocated from a
* pool.
*
* @param fiber The fiber being used to resume user code.
* @param arg Unused.
*/
static
void fiber_proc_to_resume_user_code_for_random_steal(cilk_fiber *fiber)
{
cilk_fiber_data *data = cilk_fiber_get_data(fiber);
__cilkrts_stack_frame* sf = data->resume_sf;
full_frame *ff;
CILK_ASSERT(sf);
// When we pull the resume_sf out of the fiber to resume it, clear
// the old value.
data->resume_sf = NULL;
CILK_ASSERT(sf->worker == data->owner);
ff = sf->worker->l->frame_ff;
// For Win32, we need to overwrite the default exception handler
// in this function, so that when the OS exception handling code
// walks off the top of the current Cilk stack, it reaches our stub
// handler.
// Also, this function needs to be wrapped into a try-catch block
// so the compiler generates the appropriate exception information
// in this frame.
// TBD: IS THIS HANDLER IN THE WRONG PLACE? Can we longjmp out of
// this function (and does it matter?)
#if defined(_WIN32) && !defined(_WIN64)
install_exception_stub_handler();
__try
#endif
{
char* new_sp = sysdep_reset_jump_buffers_for_resume(fiber, ff, sf);
// Notify the Intel tools that we're stealing code
ITT_SYNC_ACQUIRED(sf->worker);
NOTIFY_ZC_INTRINSIC("cilk_continue", sf);
// TBD: We'd like to move TBB-interop methods into the fiber
// eventually.
cilk_fiber_invoke_tbb_stack_op(fiber, CILK_TBB_STACK_ADOPT);
sf->flags &= ~CILK_FRAME_SUSPENDED;
// longjmp to user code. Don't process exceptions here,
// because we are resuming a stolen frame.
sysdep_longjmp_to_sf(new_sp, sf, NULL);
/*NOTREACHED*/
// Intel's C compiler respects the preceding lint pragma
}
#if defined(_WIN32) && !defined(_WIN64)
__except (CILK_ASSERT(!"should not execute the the stub filter"),
EXCEPTION_EXECUTE_HANDLER)
{
// If we are here, that means something very wrong
// has happened in our exception processing...
CILK_ASSERT(! "should not be here!");
}
#endif
}
static void random_steal(__cilkrts_worker *w)
{
__cilkrts_worker *victim = NULL;
cilk_fiber *fiber = NULL;
int n;
int success = 0;
int32_t victim_id;
// Nothing's been stolen yet. When true, this will flag
// setup_for_execution_pedigree to increment the pedigree
w->l->work_stolen = 0;
/* If the user has disabled stealing (using the debugger) we fail */
if (__builtin_expect(w->g->stealing_disabled, 0))
return;
CILK_ASSERT(w->l->type == WORKER_SYSTEM || w->l->team == w);
/* If there is only one processor work can still be stolen.
There must be only one worker to prevent stealing. */
CILK_ASSERT(w->g->total_workers > 1);
/* pick random *other* victim */
n = myrand(w) % (w->g->total_workers - 1);
if (n >= w->self)
++n;
// If we're replaying a log, override the victim. -1 indicates that
// we've exhausted the list of things this worker stole when we recorded
// the log so just return. If we're not replaying a log,
// replay_get_next_recorded_victim() just returns the victim ID passed in.
n = replay_get_next_recorded_victim(w, n);
if (-1 == n)
return;
victim = w->g->workers[n];
START_INTERVAL(w, INTERVAL_FIBER_ALLOCATE) {
/* Verify that we can get a stack. If not, no need to continue. */
fiber = cilk_fiber_allocate(&w->l->fiber_pool);
} STOP_INTERVAL(w, INTERVAL_FIBER_ALLOCATE);
if (NULL == fiber) {
#if FIBER_DEBUG >= 2
fprintf(stderr, "w=%d: failed steal because we could not get a fiber\n",
w->self);
#endif
return;
}
/* do not steal from self */
CILK_ASSERT (victim != w);
/* Execute a quick check before engaging in the THE protocol.
Avoid grabbing locks if there is nothing to steal. */
if (!can_steal_from(victim)) {
NOTE_INTERVAL(w, INTERVAL_STEAL_FAIL_EMPTYQ);
START_INTERVAL(w, INTERVAL_FIBER_DEALLOCATE) {
int ref_count = cilk_fiber_remove_reference(fiber, &w->l->fiber_pool);
// Fibers we use when trying to steal should not be active,
// and thus should not have any other references.
CILK_ASSERT(0 == ref_count);
} STOP_INTERVAL(w, INTERVAL_FIBER_DEALLOCATE);
return;
}
/* Attempt to steal work from the victim */
if (worker_trylock_other(w, victim)) {
if (w->l->type == WORKER_USER && victim->l->team != w) {
// Fail to steal if this is a user worker and the victim is not
// on this team. If a user worker were allowed to steal work
// descended from another user worker, the former might not be
// done with its work by the time it was needed to resume and
// unbind. Therefore, user workers are not permitted to change
// teams.
// There is no race on the victim's team because the victim cannot
// change its team until it runs out of work to do, at which point
// it will try to take out its own lock, and this worker already
// holds it.
NOTE_INTERVAL(w, INTERVAL_STEAL_FAIL_USER_WORKER);
} else if (victim->l->frame_ff) {
// A successful steal will change victim->frame_ff, even
// though the victim may be executing. Thus, the lock on
// the victim's deque is also protecting victim->frame_ff.
if (dekker_protocol(victim)) {
int proceed_with_steal = 1; // optimistic
// If we're replaying a log, verify that this the correct frame
// to steal from the victim
if (! replay_match_victim_pedigree(w, victim))
{
// Abort the steal attempt. decrement_E(victim) to
// counter the increment_E(victim) done by the
// dekker protocol
decrement_E(victim);
proceed_with_steal = 0;
}
if (proceed_with_steal)
{
START_INTERVAL(w, INTERVAL_STEAL_SUCCESS) {
success = 1;
detach_for_steal(w, victim, fiber);
victim_id = victim->self;
#if REDPAR_DEBUG >= 1
fprintf(stderr, "Wkr %d stole from victim %d, fiber = %p\n",
w->self, victim->self, fiber);
#endif
// The use of victim->self contradicts our
// classification of the "self" field as
// local. But since this code is only for
// debugging, it is ok.
DBGPRINTF ("%d-%p: Stealing work from worker %d\n"
" sf: %p, call parent: %p\n",
w->self, GetCurrentFiber(), victim->self,
w->l->next_frame_ff->call_stack,
w->l->next_frame_ff->call_stack->call_parent);
} STOP_INTERVAL(w, INTERVAL_STEAL_SUCCESS);
} // end if(proceed_with_steal)
} else {
NOTE_INTERVAL(w, INTERVAL_STEAL_FAIL_DEKKER);
}
} else {
NOTE_INTERVAL(w, INTERVAL_STEAL_FAIL_EMPTYQ);
}
worker_unlock_other(w, victim);
} else {
NOTE_INTERVAL(w, INTERVAL_STEAL_FAIL_LOCK);
}
// Record whether work was stolen. When true, this will flag
// setup_for_execution_pedigree to increment the pedigree
w->l->work_stolen = success;
if (0 == success) {
// failed to steal work. Return the fiber to the pool.
START_INTERVAL(w, INTERVAL_FIBER_DEALLOCATE) {
int ref_count = cilk_fiber_remove_reference(fiber, &w->l->fiber_pool);
// Fibers we use when trying to steal should not be active,
// and thus should not have any other references.
CILK_ASSERT(0 == ref_count);
} STOP_INTERVAL(w, INTERVAL_FIBER_DEALLOCATE);
}
else
{
// Since our steal was successful, finish initialization of
// the fiber.
cilk_fiber_reset_state(fiber,
fiber_proc_to_resume_user_code_for_random_steal);
// Record the pedigree of the frame that w has stolen.
// record only if CILK_RECORD_LOG is set
replay_record_steal(w, victim_id);
}
}
/**
* At a provably good steal, we need to transfer the child reducer map
* from ff->children_reducer_map into v->reducer_map, where v is the
* worker that resumes execution of ff.
*
* Normally, we have v == w, where w is the currently executing
* worker. In the case where we are resuming a team leader on a user
* worker, however, v might differ from w.
* Thus, this, operation is a no-op, since we can't really move
* ff->children_reducer_map into w here.
*
* Instead, this work is done in setup_for_execution_reducers().
*/
static inline void provably_good_steal_reducers(__cilkrts_worker *w,
full_frame *ff)
{
// No-op.
}
/* at a provably good steal, incorporate the accumulated exceptions of
children into the parent's exception */
static void provably_good_steal_exceptions(__cilkrts_worker *w,
full_frame *ff)
{
// ASSERT: we own ff->lock
ff->pending_exception =
__cilkrts_merge_pending_exceptions(w,
ff->child_pending_exception,
ff->pending_exception);
ff->child_pending_exception = NULL;
}
/* At sync discard the frame's old stack and take the leftmost child's. */
static void provably_good_steal_stacks(__cilkrts_worker *w, full_frame *ff)
{
CILK_ASSERT(NULL == ff->fiber_self);
ff->fiber_self = ff->fiber_child;
ff->fiber_child = NULL;
}
static void __cilkrts_mark_synched(full_frame *ff)
{
ff->call_stack->flags &= ~CILK_FRAME_UNSYNCHED;
ff->simulated_stolen = 0;
}
static
enum provably_good_steal_t provably_good_steal(__cilkrts_worker *w,
full_frame *ff)
{
// ASSERT: we hold w->lock and ff->lock
enum provably_good_steal_t result = ABANDON_EXECUTION;
// If the current replay entry is a sync record matching the worker's
// pedigree, AND this isn't the last child to the sync, return
// WAIT_FOR_CONTINUE to indicate that the caller should loop until
// we find the right frame to steal and CONTINUE_EXECUTION is returned.
int match_found = replay_match_sync_pedigree(w);
if (match_found && (0 != simulate_decjoin(ff)))
return WAIT_FOR_CONTINUE;
START_INTERVAL(w, INTERVAL_PROVABLY_GOOD_STEAL) {
if (decjoin(ff) == 0) {
provably_good_steal_reducers(w, ff);
provably_good_steal_exceptions(w, ff);
provably_good_steal_stacks(w, ff);
__cilkrts_mark_synched(ff);
// If the original owner wants this frame back (to resume
// it on its original thread) pass it back now.
if (NULL != ff->sync_master) {
// The frame wants to go back and be executed by the original
// user thread. We can throw caution to the wind and push the
// frame straight onto its queue because the only way we have
// gotten to this point of being able to continue execution of
// the frame is if the original user worker is spinning without
// work.
unset_sync_master(w->l->team, ff);
__cilkrts_push_next_frame(w->l->team, ff);
// If this is the team leader we're not abandoning the work
if (w == w->l->team)
result = CONTINUE_EXECUTION;
} else {
__cilkrts_push_next_frame(w, ff);
result = CONTINUE_EXECUTION; // Continue working on this thread
}
// The __cilkrts_push_next_frame() call changes ownership
// of ff to the specified worker.
}
} STOP_INTERVAL(w, INTERVAL_PROVABLY_GOOD_STEAL);
// Only write a SYNC record if:
// - We're recording a log *AND*
// - We're the worker continuing from this sync
replay_record_sync(w, result == CONTINUE_EXECUTION);
// If we're replaying a log, and matched a sync from the log, mark the
// sync record seen if the sync isn't going to be abandoned.
replay_advance_from_sync (w, match_found, result == CONTINUE_EXECUTION);
return result;
}
static void unconditional_steal(__cilkrts_worker *w,
full_frame *ff)
{
// ASSERT: we hold ff->lock
START_INTERVAL(w, INTERVAL_UNCONDITIONAL_STEAL) {
decjoin(ff);
__cilkrts_push_next_frame(w, ff);
} STOP_INTERVAL(w, INTERVAL_UNCONDITIONAL_STEAL);
}
/* CHILD is about to die. Give its exceptions to a sibling or to the
parent. */
static inline void splice_exceptions_for_call(__cilkrts_worker *w,
full_frame *parent_ff,
full_frame *child_ff)
{
// ASSERT: We own parent_ff->lock
CILK_ASSERT(child_ff->is_call_child);
CILK_ASSERT(NULL == child_ff->right_pending_exception);
CILK_ASSERT(NULL == parent_ff->pending_exception);
parent_ff->pending_exception = child_ff->pending_exception;
child_ff->pending_exception = NULL;
}
/**
* Merge exceptions for a dying child.
*
* @param w The currently executing worker.
* @param ff The child frame that is dying.
* @param left_exception_ptr Pointer to the exception that is to our left.
*/
static inline
void splice_exceptions_for_spawn(__cilkrts_worker *w,
full_frame *ff,
struct pending_exception_info **left_exception_ptr)
{
// ASSERT: parent_ff == child_ff->parent.
// ASSERT: We own parent_ff->lock
// Merge current exception into the slot where the left
// exception should go.
*left_exception_ptr =
__cilkrts_merge_pending_exceptions(w,
*left_exception_ptr,
ff->pending_exception);
ff->pending_exception = NULL;
// Merge right exception into the slot where the left exception
// should go.
*left_exception_ptr =
__cilkrts_merge_pending_exceptions(w,
*left_exception_ptr,
ff->right_pending_exception);
ff->right_pending_exception = NULL;
}
static inline void splice_stacks_for_call(__cilkrts_worker *w,
full_frame *parent_ff,
full_frame *child_ff)
{
#if CILK_LIB_DEBUG
if (parent_ff->call_stack)
CILK_ASSERT(!(parent_ff->call_stack->flags & CILK_FRAME_MBZ));
#endif
/* A synched frame does not have accumulated child reducers. */
CILK_ASSERT(!child_ff->fiber_child);
CILK_ASSERT(child_ff->is_call_child);
/* An attached parent has no self fiber. It may have
accumulated child fibers or child owners, which should be
ignored until sync. */
CILK_ASSERT(!parent_ff->fiber_self);
parent_ff->fiber_self = child_ff->fiber_self;
child_ff->fiber_self = NULL;
}
static void finalize_child_for_call(__cilkrts_worker *w,
full_frame *parent_ff,
full_frame *child_ff)
{
// ASSERT: we hold w->lock and parent_ff->lock
START_INTERVAL(w, INTERVAL_FINALIZE_CHILD) {
CILK_ASSERT(child_ff->is_call_child);
CILK_ASSERT(child_ff->join_counter == 0);
CILK_ASSERT(!child_ff->rightmost_child);
CILK_ASSERT(child_ff == parent_ff->rightmost_child);
// CHILD is about to die.
// Splicing out reducers is a no-op for a call since
// w->reducer_map should already store the correct
// reducer map.
// ASSERT there are no maps left to reduce.
CILK_ASSERT(NULL == child_ff->children_reducer_map);
CILK_ASSERT(NULL == child_ff->right_reducer_map);
splice_exceptions_for_call(w, parent_ff, child_ff);
splice_stacks_for_call(w, parent_ff, child_ff);
/* remove CHILD from list of children of PARENT */
unlink_child(parent_ff, child_ff);
/* continue with the parent. */
unconditional_steal(w, parent_ff);
__cilkrts_destroy_full_frame(w, child_ff);
} STOP_INTERVAL(w, INTERVAL_FINALIZE_CHILD);
}
/**
* The invariant on ff->children_reducer_map is that when ff is
* synched and when we are about to resume execution of ff, at least
* one of ff->children_reducer_map and w->reducer_map must be NULL.
*
* Consider the two possibilities before resuming execution of ff:
*
* 1. Suppose ff is synched and suspended. Then either
*
* (a) ff->children_reducer_map stores the reducer map that w
* should use, where w is the worker resuming execution of ff,
* OR
* (b) w already has a user map, and ff->children_reducer_map is NULL.
*
* Case (a) happens when we are resuming execution of ff as a
* provably good steal. In this case, w->reducer_map should be
* NULL and ff->children_reducer_map is valid. To resume
* execution of ff on w, set w->reducer_map to
* ff->children_reducer_map.
*
* Case (b) occurs when we resume execution of ff because ff is a
* called child. Then, ff->children_reducer_map should be NULL,
* and w should already have a valid reducer map when resuming
* execution of ff. We resume execution of ff without changing
* w->reducer_map.
*
* 2. Suppose frame ff is not synched (i.e., it is active and might have
* active children). Then ff->children_reducer_map is the slot for
* storing the reducer map from ff's leftmost child, as in the reducer
* protocol. The runtime may resume execution of ff while it is not
* synched only because of a steal.
* In this case, while we are resuming ff, ff->children_reducer_map
* may be non-NULL (because one of ff's children has completed).
* We resume execution of ff without changing w->reducer_map.
*/
static void setup_for_execution_reducers(__cilkrts_worker *w,
full_frame *ff)
{
// We only need to move ff->children_reducer_map into
// w->reducer_map in case 1(a).
//
// First check whether ff is synched.
__cilkrts_stack_frame *sf = ff->call_stack;
if (!(sf->flags & CILK_FRAME_UNSYNCHED)) {
// In this case, ff is synched. (Case 1).
CILK_ASSERT(!ff->rightmost_child);
// Test whether we are in case 1(a) and have
// something to do. Note that if both
// ff->children_reducer_map and w->reducer_map are NULL, we
// can't distinguish between cases 1(a) and 1(b) here.
if (ff->children_reducer_map) {
// We are in Case 1(a).
CILK_ASSERT(!w->reducer_map);
w->reducer_map = ff->children_reducer_map;
ff->children_reducer_map = NULL;
}
}
}
static void setup_for_execution_exceptions(__cilkrts_worker *w,
full_frame *ff)
{
CILK_ASSERT(NULL == w->l->pending_exception);
w->l->pending_exception = ff->pending_exception;
ff->pending_exception = NULL;
}
#if 0 /* unused */
static void setup_for_execution_stack(__cilkrts_worker *w,
full_frame *ff)
{
}
#endif
/*
* setup_for_execution_pedigree
*
* Copies the pedigree information from the frame we're resuming to the
* worker. Increments the pedigree if this is work that has been stolen
* to match the increment on a return from a spawn helper.
*/
static void setup_for_execution_pedigree(__cilkrts_worker *w)
{
int pedigree_unsynched;
__cilkrts_stack_frame *sf = w->current_stack_frame;
CILK_ASSERT(NULL != sf);
// If this isn't an ABI 1 or later frame, there's no pedigree information
if (0 == CILK_FRAME_VERSION_VALUE(sf->flags))
return;
// Note whether the pedigree is unsynched and clear the flag before
// we forget
pedigree_unsynched = sf->flags & CILK_FRAME_SF_PEDIGREE_UNSYNCHED;
sf->flags &= ~CILK_FRAME_SF_PEDIGREE_UNSYNCHED;
// If we're just marshalling onto this worker, do not increment
// the rank since that wouldn't happen in a sequential execution
if (w->l->work_stolen || pedigree_unsynched)
{
if (w->l->work_stolen)
w->pedigree.rank = sf->parent_pedigree.rank + 1;
else
w->pedigree.rank = sf->parent_pedigree.rank;
}
w->pedigree.parent = sf->parent_pedigree.parent;
w->l->work_stolen = 0;
}
static void setup_for_execution(__cilkrts_worker *w,
full_frame *ff,
int is_return_from_call)
{
// ASSERT: We own w->lock and ff->lock || P == 1
setup_for_execution_reducers(w, ff);
setup_for_execution_exceptions(w, ff);
/*setup_for_execution_stack(w, ff);*/
ff->call_stack->worker = w;
w->current_stack_frame = ff->call_stack;
// If this is a return from a call, leave the pedigree alone
if (! is_return_from_call)
setup_for_execution_pedigree(w);
__cilkrts_setup_for_execution_sysdep(w, ff);
w->head = w->tail = w->l->ltq;
reset_THE_exception(w);
make_runnable(w, ff);
}
/*
* Called by the scheduling fiber, right before
* resuming a sf/ff for user code.
*
* This method associates the specified sf with the worker.
*
* It also asserts that w, ff, and sf all have the expected properties
* for resuming user code.
*/
void scheduling_fiber_prepare_to_resume_user_code(__cilkrts_worker *w,
full_frame *ff,
__cilkrts_stack_frame *sf)
{
w->current_stack_frame = sf;
sf->worker = w;
// Lots of debugging checks on the state of the fiber we might be
// resuming.
#if FIBER_DEBUG >= 1
# if FIBER_DEBUG >= 3
{
fprintf(stderr, "w=%d: ff=%p, sf=%p. about to resume user code\n",
w->self, ff, sf);
}
# endif
const int flags = sf->flags;
CILK_ASSERT(flags & CILK_FRAME_SUSPENDED);
CILK_ASSERT(!sf->call_parent);
CILK_ASSERT(w->head == w->tail);
/* A frame can not be resumed unless it was suspended. */
CILK_ASSERT(ff->sync_sp != NULL);
/* The leftmost frame has no allocated stack */
if (ff->simulated_stolen)
CILK_ASSERT(flags & CILK_FRAME_UNSYNCHED);
else if (flags & CILK_FRAME_UNSYNCHED)
/* XXX By coincidence sync_sp could be null. */
CILK_ASSERT(ff->fiber_self != NULL);
else
/* XXX This frame could be resumed unsynched on the leftmost stack */
CILK_ASSERT((ff->sync_master == 0 || ff->sync_master == w));
CILK_ASSERT(w->l->frame_ff == ff);
#endif
}
/**
* This method is the first method that should execute after we've
* switched to a scheduling fiber from user code.
*
* @param fiber The scheduling fiber for the current worker.
* @param wptr The current worker.
*/
static void enter_runtime_transition_proc(cilk_fiber *fiber)
{
// We can execute this method for one of three reasons:
// 1. Undo-detach finds parent stolen.
// 2. Sync suspends frame.
// 3. Return from Cilk entry point.
//
//
// In cases 1 and 2, the frame may be truly suspended or
// may be immediately executed by this worker after provably_good_steal.
//
//
// There is a fourth case, which can, but does not need to execute
// this function:
// 4. Starting up the scheduling loop on a user or
// system worker. In this case, we won't have
// a scheduling stack function to run.
__cilkrts_worker* w = cilk_fiber_get_owner(fiber);
if (w->l->post_suspend) {
// Run the continuation function passed to longjmp_into_runtime
run_scheduling_stack_fcn(w);
// After we have jumped into the runtime and run the
// scheduling function, any reducer map the worker had before entering the runtime
// should have already been saved into the appropriate full
// frame.
CILK_ASSERT(NULL == w->reducer_map);
// There shouldn't be any uncaught exceptions.
//
// In Windows, the OS catches any exceptions not caught by the
// user code. Thus, we are omitting the check on Windows.
//
// On Android, calling std::uncaught_exception with the stlport
// library causes a seg fault. Since we're not supporting
// exceptions there at this point, just don't do the check
//
// TBD: Is this check also safe to do on Windows?
CILKBUG_ASSERT_NO_UNCAUGHT_EXCEPTION();
}
}
/**
* Method called to jump back to executing user code.
*
* A normal return from the runtime back to resuming user code calls
* this method. A computation executed using force_reduce also calls
* this method to return to user code.
*
* This function should not contain any code that depends on a fiber.
* In a force-reduce case, the user worker may not have a fiber. In
* the force-reduce case, we call this method directly instead of
* calling @c user_code_resume_after_switch_into_runtime.
*/
static inline NORETURN
cilkrts_resume(__cilkrts_stack_frame *sf, full_frame *ff)
{
// Save the sync stack pointer, and do the bookkeeping
char* sync_sp = ff->sync_sp;
__cilkrts_take_stack(ff, sync_sp); // leaves ff->sync_sp null
sf->flags &= ~CILK_FRAME_SUSPENDED;
// Actually longjmp to the user code.
// We may have exceptions to deal with, since we are resuming
// a previous-suspended frame.
sysdep_longjmp_to_sf(sync_sp, sf, ff);
}
/**
* Called by the user-code fiber right before resuming a full frame
* (sf/ff).
*
* This method pulls sf/ff out of the worker, and then calls
* cilkrts_resume to jump to user code.
*/
static NORETURN
user_code_resume_after_switch_into_runtime(cilk_fiber *fiber)
{
__cilkrts_worker *w = cilk_fiber_get_owner(fiber);
__cilkrts_stack_frame *sf;
full_frame *ff;
sf = w->current_stack_frame;
ff = sf->worker->l->frame_ff;
#if FIBER_DEBUG >= 1
CILK_ASSERT(ff->fiber_self == fiber);
cilk_fiber_data *fdata = cilk_fiber_get_data(fiber);
DBGPRINTF ("%d-%p: resume_after_switch_into_runtime, fiber=%p\n",
w->self, w, fiber);
CILK_ASSERT(sf == fdata->resume_sf);
#endif
// Notify the Intel tools that we're stealing code
ITT_SYNC_ACQUIRED(sf->worker);
NOTIFY_ZC_INTRINSIC("cilk_continue", sf);
cilk_fiber_invoke_tbb_stack_op(fiber, CILK_TBB_STACK_ADOPT);
// Actually jump to user code.
cilkrts_resume(sf, ff);
}
/* The current stack is about to either be suspended or destroyed. This
* function will switch to the stack on which the scheduler is suspended and
* resume running the scheduler within function do_work(). Upon waking up,
* the scheduler will run the 'cont' function, using the supplied worker and
* frame.
*/
static NORETURN
longjmp_into_runtime(__cilkrts_worker *w,
scheduling_stack_fcn_t fcn,
__cilkrts_stack_frame *sf)
{
full_frame *ff, *ff2;
CILK_ASSERT(!w->l->post_suspend);
ff = w->l->frame_ff;
// If we've got only one worker, stealing shouldn't be possible.
// Assume that this is a steal or return from spawn in a force-reduce case.
// We don't have a scheduling stack to switch to, so call the continuation
// function directly.
if (1 == w->g->P) {
fcn(w, ff, sf);
/* The call to function c() will have pushed ff as the next frame. If
* this were a normal (non-forced-reduce) execution, there would have
* been a pop_next_frame call in a separate part of the runtime. We
* must call pop_next_frame here to complete the push/pop cycle. */
ff2 = pop_next_frame(w);
setup_for_execution(w, ff2, 0);
scheduling_fiber_prepare_to_resume_user_code(w, ff2, w->current_stack_frame);
cilkrts_resume(w->current_stack_frame, ff2);
// Suppress clang warning that the expression result is unused
#if defined(__clang__) && (! defined(__INTEL_COMPILER))
# pragma clang diagnostic push
# pragma clang diagnostic ignored "-Wunused-value"
#endif // __clang__
/* no return */
CILK_ASSERT(((void)"returned from __cilkrts_resume", 0));
#if defined(__clang__) && (! defined(__INTEL_COMPILER))
# pragma clang diagnostic pop
#endif // __clang__
}
w->l->post_suspend = fcn;
w->l->suspended_stack = sf;
ITT_SYNC_RELEASING(w);
ITT_SYNC_PREPARE(w);
#if FIBER_DEBUG >= 2
fprintf(stderr, "ThreadId=%p, W=%d: about to switch into runtime... w->l->frame_ff = %p, sf=%p\n",
cilkos_get_current_thread_id(),
w->self, w->l->frame_ff,
sf);
#endif
// Current fiber is either the (1) one we are about to free,
// or (2) it has been passed up to the parent.
cilk_fiber *current_fiber = ( w->l->fiber_to_free ?
w->l->fiber_to_free :
w->l->frame_ff->parent->fiber_child );
cilk_fiber_data* fdata = cilk_fiber_get_data(current_fiber);
CILK_ASSERT(NULL == w->l->frame_ff->fiber_self);
// Clear the sf in the current fiber for cleanliness, to prevent
// us from accidentally resuming a bad sf.
// Technically, resume_sf gets overwritten for a fiber when
// we are about to resume it anyway.
fdata->resume_sf = NULL;
CILK_ASSERT(fdata->owner == w);
// Set the function to execute immediately after switching to the
// scheduling fiber, but before freeing any fibers.
cilk_fiber_set_post_switch_proc(w->l->scheduling_fiber,
enter_runtime_transition_proc);
cilk_fiber_invoke_tbb_stack_op(current_fiber, CILK_TBB_STACK_ORPHAN);
if (w->l->fiber_to_free) {
// Case 1: we are freeing this fiber. We never
// resume this fiber again after jumping into the runtime.
w->l->fiber_to_free = NULL;
// Extra check. Normally, the fiber we are about to switch to
// should have a NULL owner.
CILK_ASSERT(NULL == cilk_fiber_get_data(w->l->scheduling_fiber)->owner);
#if FIBER_DEBUG >= 4
fprintf(stderr, "ThreadId=%p, W=%d: about to switch into runtime.. current_fiber = %p, deallcoate, switch to fiber %p\n",
cilkos_get_current_thread_id(),
w->self,
current_fiber, w->l->scheduling_fiber);
#endif
cilk_fiber_invoke_tbb_stack_op(current_fiber, CILK_TBB_STACK_RELEASE);
NOTE_INTERVAL(w, INTERVAL_DEALLOCATE_RESUME_OTHER);
cilk_fiber_remove_reference_from_self_and_resume_other(current_fiber,
&w->l->fiber_pool,
w->l->scheduling_fiber);
// We should never come back here!
CILK_ASSERT(0);
}
else {
// Case 2: We are passing the fiber to our parent because we
// are leftmost. We should come back later to
// resume execution of user code.
//
// If we are not freeing a fiber, there we must be
// returning from a spawn or processing an exception. The
// "sync" path always frees a fiber.
//
// We must be the leftmost child, and by left holder logic, we
// have already moved the current fiber into our parent full
// frame.
#if FIBER_DEBUG >= 2
fprintf(stderr, "ThreadId=%p, W=%d: about to suspend self into runtime.. current_fiber = %p, deallcoate, switch to fiber %p\n",
cilkos_get_current_thread_id(),
w->self,
current_fiber, w->l->scheduling_fiber);
#endif
NOTE_INTERVAL(w, INTERVAL_SUSPEND_RESUME_OTHER);
cilk_fiber_suspend_self_and_resume_other(current_fiber,
w->l->scheduling_fiber);
// Resuming this fiber returns control back to
// this function because our implementation uses OS fibers.
//
// On Unix, we could have the choice of passing the
// user_code_resume_after_switch_into_runtime as an extra "resume_proc"
// that resumes execution of user code instead of the
// jumping back here, and then jumping back to user code.
#if FIBER_DEBUG >= 2
CILK_ASSERT(fdata->owner == __cilkrts_get_tls_worker());
#endif
user_code_resume_after_switch_into_runtime(current_fiber);
}
}
/*
* Send a message to the children of the specified worker: run or wait.
*/
static void notify_children(__cilkrts_worker *w, unsigned int msg)
{
int child_num;
__cilkrts_worker *child;
int num_sys_workers = w->g->P - 1;
// If worker is "n", then its children are 2n + 1, and 2n + 2.
child_num = (w->self << 1) + 1;
if (child_num < num_sys_workers) {
child = w->g->workers[child_num];
CILK_ASSERT(child->l->signal_node);
signal_node_msg(child->l->signal_node, msg);
child_num++;
if (child_num < num_sys_workers) {
child = w->g->workers[child_num];
CILK_ASSERT(child->l->signal_node);
signal_node_msg(child->l->signal_node, msg);
}
}
}
/*
* Notify this worker's children that they need to wait.
*/
static void notify_children_wait(__cilkrts_worker *w)
{
notify_children(w, 0);
}
/*
* Notify this worker's children to run and start trying to steal.
*/
static void notify_children_run(__cilkrts_worker *w)
{
notify_children(w, 1);
}
/**
* A single "check" to find work, either on our queue or through a
* steal attempt. This method checks our local queue once, and
* performs one steal attempt.
*/
static full_frame* check_for_work(__cilkrts_worker *w)
{
full_frame *ff = NULL;
ff = pop_next_frame(w);
// If there is no work on the queue, try to steal some.
if (NULL == ff) {
START_INTERVAL(w, INTERVAL_STEALING) {
if (w->l->type != WORKER_USER && w->l->team != NULL) {
// At this point, the worker knows for certain that it has run
// out of work. Therefore, it loses its team affiliation. User
// workers never change teams, of course.
__cilkrts_worker_lock(w);
w->l->team = NULL;
__cilkrts_worker_unlock(w);
}
// If we are about to do a random steal, we should have no
// full frame...
CILK_ASSERT(NULL == w->l->frame_ff);
random_steal(w);
} STOP_INTERVAL(w, INTERVAL_STEALING);
// If the steal was successful, then the worker has populated its next
// frame with the work to resume.
ff = pop_next_frame(w);
if (NULL == ff) {
// Punish the worker for failing to steal.
// No quantum for you!
__cilkrts_yield();
w->l->steal_failure_count++;
} else {
// Reset steal_failure_count since there is obviously still work to
// be done.
w->l->steal_failure_count = 0;
}
}
return ff;
}
/**
* Keep stealing or looking on our queue.
*
* Returns either when a full frame is found, or NULL if the
* computation is done.
*/
static full_frame* search_until_work_found_or_done(__cilkrts_worker *w)
{
full_frame *ff = NULL;
// Find a full frame to execute (either through random stealing,
// or because we pull it off w's 1-element queue).
while (!ff) {
// Check worker state to figure out our next action.
switch (worker_runnable(w))
{
case SCHEDULE_RUN: // One attempt at checking for work.
ff = check_for_work(w);
break;
case SCHEDULE_WAIT: // go into wait-mode.
CILK_ASSERT(WORKER_SYSTEM == w->l->type);
// If we are about to wait, then we better not have
// a frame that we should execute...
CILK_ASSERT(NULL == w->l->next_frame_ff);
notify_children_wait(w);
signal_node_wait(w->l->signal_node);
// ...
// Runtime is waking up.
notify_children_run(w);
w->l->steal_failure_count = 0;
break;
case SCHEDULE_EXIT: // exit the scheduler.
CILK_ASSERT(WORKER_USER != w->l->type);
return NULL;
default:
CILK_ASSERT(0);
abort();
}
}
return ff;
}
/**
* The proc method for a scheduling fiber on a user worker.
*
* When a user worker jumps into the runtime, it jumps into this
* method by either starting it if the scheduling fiber has never run
* before, or resuming the fiber if it was previously suspended.
*/
COMMON_PORTABLE
void scheduler_fiber_proc_for_user_worker(cilk_fiber *fiber)
{
__cilkrts_worker* w = cilk_fiber_get_owner(fiber);
CILK_ASSERT(w);
// This must be a user worker
CILK_ASSERT(WORKER_USER == w->l->type);
// If we aren't the current worker, then something is very wrong
// here..
verify_current_wkr(w);
__cilkrts_run_scheduler_with_exceptions(w);
}
/**
* The body of the runtime scheduling loop. This function executes in
* 4 stages:
*
* 1. Transitions from the user code into the runtime by
* executing any scheduling-stack functions.
* 2. Looks for a full frame enqueued from a successful provably
* good steal.
* 3. If no full frame is found in step 2, steal until
* a frame is found or we are done. If we are done, finish
* the scheduling loop.
* 4. When a frame is found, setup to resume user code.
* In particular, suspend the current fiber and resume the
* user fiber to execute the frame.
*
* Returns a fiber object that we should switch to after completing
* the body of the loop, or NULL if we should continue executing on
* this fiber.
*
* @pre @c current_fiber should equal @c wptr->l->scheduling_fiber
*
* @param current_fiber The currently executing (scheduling_ fiber
* @param wptr The currently executing worker.
* @param return The next fiber we should switch to.
*/
static cilk_fiber* worker_scheduling_loop_body(cilk_fiber* current_fiber,
void* wptr)
{
__cilkrts_worker *w = (__cilkrts_worker*) wptr;
CILK_ASSERT(current_fiber == w->l->scheduling_fiber);
// Stage 1: Transition from executing user code to the runtime code.
// We don't need to do this call here any more, because
// every switch to the scheduling fiber should make this call
// using a post_switch_proc on the fiber.
//
// enter_runtime_transition_proc(w->l->scheduling_fiber, wptr);
// After Stage 1 is complete, w should no longer have
// an associated full frame.
CILK_ASSERT(NULL == w->l->frame_ff);
// Stage 2. First do a quick check of our 1-element queue.
full_frame *ff = pop_next_frame(w);
if (!ff) {
// Stage 3. We didn't find anything from our 1-element
// queue. Now go through the steal loop to find work.
ff = search_until_work_found_or_done(w);
if (!ff) {
CILK_ASSERT(w->g->work_done);
return NULL;
}
}
// Stage 4. Now that we have found a full frame to work on,
// actually execute it.
__cilkrts_stack_frame *sf;
// There shouldn't be any uncaught exceptions.
//
// In Windows, the OS catches any exceptions not caught by the
// user code. Thus, we are omitting the check on Windows.
//
// On Android, calling std::uncaught_exception with the stlport
// library causes a seg fault. Since we're not supporting
// exceptions there at this point, just don't do the check
CILKBUG_ASSERT_NO_UNCAUGHT_EXCEPTION();
BEGIN_WITH_WORKER_LOCK(w) {
CILK_ASSERT(!w->l->frame_ff);
BEGIN_WITH_FRAME_LOCK(w, ff) {
sf = ff->call_stack;
CILK_ASSERT(sf && !sf->call_parent);
setup_for_execution(w, ff, 0);
} END_WITH_FRAME_LOCK(w, ff);
} END_WITH_WORKER_LOCK(w);
/* run it */
//
// Prepare to run the full frame. To do so, we need to:
// (a) Execute some code on this fiber (the scheduling
// fiber) to set up data structures, and
// (b) Suspend the scheduling fiber, and resume the
// user-code fiber.
// Part (a). Set up data structures.
scheduling_fiber_prepare_to_resume_user_code(w, ff, sf);
cilk_fiber *other = w->l->frame_ff->fiber_self;
cilk_fiber_data* other_data = cilk_fiber_get_data(other);
cilk_fiber_data* current_fiber_data = cilk_fiber_get_data(current_fiber);
// I believe two cases are possible here, both of which
// should have other_data->resume_sf as NULL.
//
// 1. Resuming a fiber that was previously executing
// user code (i.e., a provably-good-steal).
// In this case, resume_sf should have been
// set to NULL when it was suspended.
//
// 2. Resuming code on a steal. In this case, since we
// grabbed a new fiber, resume_sf should be NULL.
CILK_ASSERT(NULL == other_data->resume_sf);
#if FIBER_DEBUG >= 2
fprintf(stderr, "W=%d: other fiber=%p, setting resume_sf to %p\n",
w->self, other, other_data->resume_sf);
#endif
// Update our own fiber's data.
current_fiber_data->resume_sf = NULL;
// The scheduling fiber should have the right owner from before.
CILK_ASSERT(current_fiber_data->owner == w);
other_data->resume_sf = sf;
#if FIBER_DEBUG >= 3
fprintf(stderr, "ThreadId=%p (about to suspend self resume other), W=%d: current_fiber=%p, other=%p, current_fiber->resume_sf = %p, other->resume_sf = %p\n",
cilkos_get_current_thread_id(),
w->self,
current_fiber, other,
current_fiber_data->resume_sf,
other_data->resume_sf);
#endif
return other;
}
/**
* This function is executed once by each worker, to initialize its
* scheduling loop.
*/
static void worker_scheduler_init_function(__cilkrts_worker *w)
{
// First, execute the startup tasks that must happen for all
// worker types.
ITT_SYNC_PREPARE(w);
/* Notify tools about the new worker. Inspector needs this, but we
don't want to confuse Cilkscreen with system threads. User threads
do this notification in bind_thread */
if (! w->g->under_ptool)
__cilkrts_cilkscreen_establish_worker(w);
// Seed the initial random number generator.
// If we forget to do this, then the worker always steals from 0.
// Programs will still execute correctly, but
// you may see a subtle performance bug...
mysrand(w, (w->self + 1));
// The startup work varies, depending on the worker type.
switch (w->l->type) {
case WORKER_USER:
// Stop working once we've entered the scheduler.
// For user workers, INTERVAL_IN_SCHEDULER counts the time
// since we called bind_thread.
break;
case WORKER_SYSTEM:
// If a system worker is starting, we must also be starting
// the runtime.
// Runtime begins in a wait-state and is woken up by the first user
// worker when the runtime is ready.
signal_node_wait(w->l->signal_node);
// ...
// Runtime is waking up.
notify_children_run(w);
w->l->steal_failure_count = 0;
// For system threads, count all the time this thread is
// alive in the scheduling loop.
START_INTERVAL(w, INTERVAL_IN_SCHEDULER);
START_INTERVAL(w, INTERVAL_WORKING);
break;
default:
__cilkrts_bug("Unknown worker %p of type %d entering scheduling loop\n",
w, w->l->type);
}
}
/**
* This function is executed once by each worker, to finish its
* scheduling loop.
*
* @note Currently, only system workers finish their loops. User
* workers will jump away to user code without exiting their
* scheduling loop.
*/
static void worker_scheduler_terminate_function(__cilkrts_worker *w)
{
// A user worker should never finish by falling through the
// scheduling loop.
CILK_ASSERT(WORKER_USER != w->l->type);
STOP_INTERVAL(w, INTERVAL_IN_RUNTIME);
STOP_INTERVAL(w, INTERVAL_IN_SCHEDULER);
}
/**
* The main scheduler function executed by a worker's scheduling
* fiber.
*
* This method is started by either a new system worker, or a user
* worker that has stalled and just been imported into the runtime.
*/
static void worker_scheduler_function(__cilkrts_worker *w)
{
worker_scheduler_init_function(w);
// The main scheduling loop body.
while (!w->g->work_done) {
// Set intervals. Now we are in the runtime instead of working.
START_INTERVAL(w, INTERVAL_IN_RUNTIME);
STOP_INTERVAL(w, INTERVAL_WORKING);
// Execute the "body" of the scheduling loop, and figure
// out the fiber to jump to next.
cilk_fiber* fiber_to_resume
= worker_scheduling_loop_body(w->l->scheduling_fiber, w);
if (fiber_to_resume) {
// Suspend the current fiber and resume next one.
NOTE_INTERVAL(w, INTERVAL_SUSPEND_RESUME_OTHER);
STOP_INTERVAL(w, INTERVAL_IN_RUNTIME);
START_INTERVAL(w, INTERVAL_WORKING);
cilk_fiber_suspend_self_and_resume_other(w->l->scheduling_fiber,
fiber_to_resume);
// Return here only when this (scheduling) fiber is
// resumed (i.e., this worker wants to reenter the runtime).
}
}
// Finish the scheduling loop.
worker_scheduler_terminate_function(w);
}
/*************************************************************
Forward declarations for reduction protocol.
*************************************************************/
static __cilkrts_worker*
execute_reductions_for_sync(__cilkrts_worker *w,
full_frame *ff,
__cilkrts_stack_frame *sf_at_sync);
static __cilkrts_worker*
execute_reductions_for_spawn_return(__cilkrts_worker *w,
full_frame *ff,
__cilkrts_stack_frame *returning_sf);
/*************************************************************
Scheduler functions that are callable by client code
*************************************************************/
static full_frame *disown(__cilkrts_worker *w,
full_frame *ff,
__cilkrts_stack_frame *sf,
const char *why)
{
CILK_ASSERT(ff);
make_unrunnable(w, ff, sf, sf != 0, why);
w->l->frame_ff = 0;
return ff->parent;
}
/**
* Called when ff is returning from a spawn, and we need to execute a
* reduction.
*
* @param w The currently executing worker.
* @param ff The full frame for w.
* @param returning_sf The stack frame for the spawn helper that is returning.
*
* Normally, by the time we gain control in the runtime, the worker
* has already popped off the __cilkrts_stack_frame "returning_sf"
* from its call chain.
*
* When we have only serial reductions, w->current_stack_frame is not
* needed any more, because w is about to enter the runtime scheduling
* loop anyway. Similarly, the frame "ff" is slated to be destroyed
* after the runtime finishes the return from spawn and splices ff out
* of the tree of full frames.
*
* To execute a parallel reduction, however, we still want
* w->current_stack_frame == returning_sf, and we are going to use the
* frame ff for a little bit longer.
*
* This method:
*
* 1. Puts returning_sf back as w's current stack frame.
* 2. Makes "ff" runnable again on w.
*/
static inline
void restore_frame_for_spawn_return_reduction(__cilkrts_worker *w,
full_frame *ff,
__cilkrts_stack_frame *returning_sf) {
#if REDPAR_DEBUG >= 2
CILK_ASSERT(returning_sf);
CILK_ASSERT(returning_sf->worker == w);
#endif
// Change w's current stack frame back to "returning_sf".
//
// Intuitively, w->current_stack_frame should be
// returning_sf->call_parent at this point.
//
// We can not assert this, however, because the pop of
// returning_sf from the call chain has already cleared
// returning_sf->call_parent. We don't want to restore the call
// parent of returning_sf, because its parent has been stolen, and
// the runtime assumes that steals break this link.
// We cannot assert call_parent is NULL either, since that's not true for
// Win64 exception handling
// CILK_ASSERT(returning_sf->call_parent == NULL);
w->current_stack_frame = returning_sf;
// Make the full frame "ff" runnable again, in preparation for
// executing the reduction.
make_runnable(w, ff);
}
NORETURN __cilkrts_c_sync(__cilkrts_worker *w,
__cilkrts_stack_frame *sf_at_sync)
{
full_frame *ff;
// Claim: This read of w->l->frame_ff can occur without
// holding the worker lock because when w has reached a sync
// and entered the runtime (because it stalls), w's deque is empty
// and no one else can steal and change w->l->frame_ff.
ff = w->l->frame_ff;
#ifdef _WIN32
__cilkrts_save_exception_state(w, ff);
#else
// Move any pending exceptions into the full frame
CILK_ASSERT(NULL == ff->pending_exception);
ff->pending_exception = w->l->pending_exception;
w->l->pending_exception = NULL;
#endif
w = execute_reductions_for_sync(w, ff, sf_at_sync);
#if FIBER_DEBUG >= 3
fprintf(stderr, "ThreadId=%p, w->self = %d. about to longjmp_into_runtim[c_sync] with ff=%p\n",
cilkos_get_current_thread_id(), w->self, ff);
#endif
longjmp_into_runtime(w, do_sync, sf_at_sync);
}
static void do_sync(__cilkrts_worker *w, full_frame *ff,
__cilkrts_stack_frame *sf)
{
//int abandoned = 1;
enum provably_good_steal_t steal_result = ABANDON_EXECUTION;
START_INTERVAL(w, INTERVAL_SYNC_CHECK) {
BEGIN_WITH_WORKER_LOCK_OPTIONAL(w) {
CILK_ASSERT(ff);
BEGIN_WITH_FRAME_LOCK(w, ff) {
CILK_ASSERT(sf->call_parent == 0);
CILK_ASSERT(sf->flags & CILK_FRAME_UNSYNCHED);
// Before switching into the scheduling fiber, we should have
// already taken care of deallocating the current
// fiber.
CILK_ASSERT(NULL == ff->fiber_self);
// Update the frame's pedigree information if this is an ABI 1
// or later frame
if (CILK_FRAME_VERSION_VALUE(sf->flags) >= 1)
{
sf->parent_pedigree.rank = w->pedigree.rank;
sf->parent_pedigree.parent = w->pedigree.parent;
// Note that the pedigree rank needs to be updated
// when setup_for_execution_pedigree runs
sf->flags |= CILK_FRAME_SF_PEDIGREE_UNSYNCHED;
}
/* the decjoin() occurs in provably_good_steal() */
steal_result = provably_good_steal(w, ff);
} END_WITH_FRAME_LOCK(w, ff);
// set w->l->frame_ff = NULL after checking abandoned
if (WAIT_FOR_CONTINUE != steal_result) {
w->l->frame_ff = NULL;
}
} END_WITH_WORKER_LOCK_OPTIONAL(w);
} STOP_INTERVAL(w, INTERVAL_SYNC_CHECK);
// Now, if we are in a replay situation and provably_good_steal() returned
// WAIT_FOR_CONTINUE, we should sleep, reacquire locks, call
// provably_good_steal(), and release locks until we get a value other
// than WAIT_FOR_CONTINUE from the function.
#ifdef CILK_RECORD_REPLAY
// We don't have to explicitly check for REPLAY_LOG below because
// steal_result can only be set to WAIT_FOR_CONTINUE during replay
while(WAIT_FOR_CONTINUE == steal_result)
{
__cilkrts_sleep();
BEGIN_WITH_WORKER_LOCK_OPTIONAL(w)
{
ff = w->l->frame_ff;
BEGIN_WITH_FRAME_LOCK(w, ff)
{
steal_result = provably_good_steal(w, ff);
} END_WITH_FRAME_LOCK(w, ff);
if (WAIT_FOR_CONTINUE != steal_result)
w->l->frame_ff = NULL;
} END_WITH_WORKER_LOCK_OPTIONAL(w);
}
#endif // CILK_RECORD_REPLAY
#ifdef ENABLE_NOTIFY_ZC_INTRINSIC
// If we can't make any further progress on this thread, tell Inspector
// that we're abandoning the work and will go find something else to do.
if (ABANDON_EXECUTION == steal_result)
{
NOTIFY_ZC_INTRINSIC("cilk_sync_abandon", 0);
}
#endif // defined ENABLE_NOTIFY_ZC_INTRINSIC
return; /* back to scheduler loop */
}
/* worker W completely promotes its own deque, simulating the case
where the whole deque is stolen. We use this mechanism to force
the allocation of new storage for reducers for race-detection
purposes. */
void __cilkrts_promote_own_deque(__cilkrts_worker *w)
{
// Remember the fiber we start this method on.
CILK_ASSERT(w->l->frame_ff);
cilk_fiber* starting_fiber = w->l->frame_ff->fiber_self;
BEGIN_WITH_WORKER_LOCK(w) {
while (dekker_protocol(w)) {
/* PLACEHOLDER_FIBER is used as non-null marker to tell detach()
and make_child() that this frame should be treated as a spawn
parent, even though we have not assigned it a stack. */
detach_for_steal(w, w, PLACEHOLDER_FIBER);
}
} END_WITH_WORKER_LOCK(w);
// TBD: The management of full frames and fibers is a bit
// sketchy here. We are promoting stack frames into full frames,
// and pretending they are stolen away, but no other worker is
// actually working on them. Some runtime invariants
// may be broken here.
//
// Technically, if we are simulating a steal from w
// w should get a new full frame, but
// keep the same fiber. A real thief would be taking the
// loot frame away, get a new fiber, and starting executing the
// loot frame.
//
// What should a fake thief do? Where does the frame go?
// In any case, we should be finishing the promotion process with
// the same fiber with.
CILK_ASSERT(w->l->frame_ff);
CILK_ASSERT(w->l->frame_ff->fiber_self == starting_fiber);
}
/* the client code calls this function after a spawn when the dekker
protocol fails. The function may either return or longjmp
into the rts
This function takes in a "returning_sf" argument which corresponds
to the __cilkrts_stack_frame that we are finishing (i.e., the
argument to __cilkrts_leave_frame).
*/
void __cilkrts_c_THE_exception_check(__cilkrts_worker *w,
__cilkrts_stack_frame *returning_sf)
{
full_frame *ff;
int stolen_p;
__cilkrts_stack_frame *saved_sf = NULL;
START_INTERVAL(w, INTERVAL_THE_EXCEPTION_CHECK);
BEGIN_WITH_WORKER_LOCK(w) {
ff = w->l->frame_ff;
CILK_ASSERT(ff);
/* This code is called only upon a normal return and never
upon an exceptional return. Assert that this is the
case. */
CILK_ASSERT(!w->l->pending_exception);
reset_THE_exception(w);
stolen_p = !(w->head < (w->tail + 1)); /* +1 because tail was
speculatively
decremented by the
compiled code */
if (stolen_p) {
/* XXX This will be charged to THE for accounting purposes */
__cilkrts_save_exception_state(w, ff);
// Save the value of the current stack frame.
saved_sf = w->current_stack_frame;
// Reverse the decrement from undo_detach.
// This update effectively resets the deque to be
// empty (i.e., changes w->tail back to equal w->head).
// We need to reset the deque to execute parallel
// reductions. When we have only serial reductions, it
// does not matter, since serial reductions do not
// change the deque.
w->tail++;
#if REDPAR_DEBUG > 1
// ASSERT our deque is empty.
CILK_ASSERT(w->head == w->tail);
#endif
}
} END_WITH_WORKER_LOCK(w);
STOP_INTERVAL(w, INTERVAL_THE_EXCEPTION_CHECK);
if (stolen_p)
{
w = execute_reductions_for_spawn_return(w, ff, returning_sf);
// "Mr. Policeman? My parent always told me that if I was in trouble
// I should ask a nice policeman for help. I can't find my parent
// anywhere..."
//
// Write a record to the replay log for an attempt to return to a stolen parent
replay_record_orphaned(w);
// Update the pedigree only after we've finished the
// reductions.
update_pedigree_on_leave_frame(w, returning_sf);
// Notify Inspector that the parent has been stolen and we're
// going to abandon this work and go do something else. This
// will match the cilk_leave_begin in the compiled code
NOTIFY_ZC_INTRINSIC("cilk_leave_stolen", saved_sf);
DBGPRINTF ("%d: longjmp_into_runtime from __cilkrts_c_THE_exception_check\n", w->self);
longjmp_into_runtime(w, do_return_from_spawn, 0);
DBGPRINTF ("%d: returned from longjmp_into_runtime from __cilkrts_c_THE_exception_check?!\n", w->self);
}
else
{
NOTE_INTERVAL(w, INTERVAL_THE_EXCEPTION_CHECK_USELESS);
return;
}
}
/* Return an exception to a stolen parent. */
NORETURN __cilkrts_exception_from_spawn(__cilkrts_worker *w,
__cilkrts_stack_frame *returning_sf)
{
full_frame *ff = w->l->frame_ff;
// This is almost the same as THE_exception_check, except
// the detach didn't happen, we don't need to undo the tail
// update.
CILK_ASSERT(w->head == w->tail);
w = execute_reductions_for_spawn_return(w, ff, returning_sf);
longjmp_into_runtime(w, do_return_from_spawn, 0);
CILK_ASSERT(0);
}
static void do_return_from_spawn(__cilkrts_worker *w,
full_frame *ff,
__cilkrts_stack_frame *sf)
{
full_frame *parent_ff;
enum provably_good_steal_t steal_result = ABANDON_EXECUTION;
BEGIN_WITH_WORKER_LOCK_OPTIONAL(w) {
CILK_ASSERT(ff);
CILK_ASSERT(!ff->is_call_child);
CILK_ASSERT(sf == NULL);
parent_ff = ff->parent;
BEGIN_WITH_FRAME_LOCK(w, ff) {
decjoin(ff);
} END_WITH_FRAME_LOCK(w, ff);
BEGIN_WITH_FRAME_LOCK(w, parent_ff) {
if (parent_ff->simulated_stolen)
unconditional_steal(w, parent_ff);
else
steal_result = provably_good_steal(w, parent_ff);
} END_WITH_FRAME_LOCK(w, parent_ff);
} END_WITH_WORKER_LOCK_OPTIONAL(w);
// Loop here in replay mode
#ifdef CILK_RECORD_REPLAY
// We don't have to explicitly check for REPLAY_LOG below because
// steal_result can only get set to WAIT_FOR_CONTINUE during replay.
// We also don't have to worry about the simulated_stolen flag
// because steal_result can only be set to WAIT_FOR_CONTINUE by
// provably_good_steal().
while(WAIT_FOR_CONTINUE == steal_result)
{
__cilkrts_sleep();
BEGIN_WITH_WORKER_LOCK_OPTIONAL(w)
{
BEGIN_WITH_FRAME_LOCK(w, parent_ff)
{
steal_result = provably_good_steal(w, parent_ff);
} END_WITH_FRAME_LOCK(w, parent_ff);
} END_WITH_WORKER_LOCK_OPTIONAL(w);
}
#endif // CILK_RECORD_REPLAY
// Cleanup the child frame.
__cilkrts_destroy_full_frame(w, ff);
return;
}
#ifdef _WIN32
/* migrate an exception across fibers. Call this function when an exception has
* been thrown and has to traverse across a steal. The exception has already
* been wrapped up, so all that remains is to longjmp() into the continuation,
* sync, and re-raise it.
*/
void __cilkrts_migrate_exception(__cilkrts_stack_frame *sf) {
__cilkrts_worker *w = sf->worker;
full_frame *ff;
BEGIN_WITH_WORKER_LOCK(w) {
ff = w->l->frame_ff;
reset_THE_exception(w);
/* there is no need to check for a steal because we wouldn't be here if
there weren't a steal. */
__cilkrts_save_exception_state(w, ff);
CILK_ASSERT(w->head == w->tail);
} END_WITH_WORKER_LOCK(w);
{
// TBD(jsukha): This function emulates the
// the "do_return_from_spawn" path.
w = execute_reductions_for_spawn_return(w, ff, sf);
}
longjmp_into_runtime(w, do_return_from_spawn, 0); /* does not return. */
CILK_ASSERT(! "Shouldn't be here...");
}
#endif
/* Pop a call stack from TAIL. Return the call stack, or NULL if the
queue is empty */
__cilkrts_stack_frame *__cilkrts_pop_tail(__cilkrts_worker *w)
{
__cilkrts_stack_frame *sf;
BEGIN_WITH_WORKER_LOCK(w) {
__cilkrts_stack_frame *volatile *tail = w->tail;
if (w->head < tail) {
--tail;
sf = *tail;
w->tail = tail;
} else {
sf = 0;
}
} END_WITH_WORKER_LOCK(w);
return sf;
}
#ifdef CILK_RECORD_REPLAY
__cilkrts_stack_frame *simulate_pop_tail(__cilkrts_worker *w)
{
__cilkrts_stack_frame *sf;
BEGIN_WITH_WORKER_LOCK(w) {
if (w->head < w->tail) {
sf = *(w->tail-1);
} else {
sf = 0;
}
} END_WITH_WORKER_LOCK(w);
return sf;
}
#endif
/* Return from a call, not a spawn. */
void __cilkrts_return(__cilkrts_worker *w)
{
full_frame *ff, *parent_ff;
START_INTERVAL(w, INTERVAL_RETURNING);
BEGIN_WITH_WORKER_LOCK_OPTIONAL(w) {
ff = w->l->frame_ff;
CILK_ASSERT(ff);
CILK_ASSERT(ff->join_counter == 1);
/* This path is not used to return from spawn. */
CILK_ASSERT(ff->is_call_child);
BEGIN_WITH_FRAME_LOCK(w, ff) {
// After this call, w->l->frame_ff != ff.
// Technically, w will "own" ff until ff is freed,
// however, because ff is a dying leaf full frame.
parent_ff = disown(w, ff, 0, "return");
decjoin(ff);
#ifdef _WIN32
__cilkrts_save_exception_state(w, ff);
#else
// Move the pending exceptions into the full frame
// This should always be NULL if this isn't a
// return with an exception
CILK_ASSERT(NULL == ff->pending_exception);
ff->pending_exception = w->l->pending_exception;
w->l->pending_exception = NULL;
#endif // _WIN32
} END_WITH_FRAME_LOCK(w, ff);
__cilkrts_fence(); /* redundant */
CILK_ASSERT(parent_ff);
BEGIN_WITH_FRAME_LOCK(w, parent_ff) {
finalize_child_for_call(w, parent_ff, ff);
} END_WITH_FRAME_LOCK(w, parent_ff);
ff = pop_next_frame(w);
/* ff will be non-null except when the parent frame is owned
by another worker.
CILK_ASSERT(ff)
*/
CILK_ASSERT(!w->l->frame_ff);
if (ff) {
BEGIN_WITH_FRAME_LOCK(w, ff) {
__cilkrts_stack_frame *sf = ff->call_stack;
CILK_ASSERT(sf && !sf->call_parent);
setup_for_execution(w, ff, 1);
} END_WITH_FRAME_LOCK(w, ff);
}
} END_WITH_WORKER_LOCK_OPTIONAL(w);
STOP_INTERVAL(w, INTERVAL_RETURNING);
}
static void __cilkrts_unbind_thread()
{
int stop_cilkscreen = 0;
global_state_t *g;
// Take out the global OS mutex to protect accesses to the table of workers
global_os_mutex_lock();
if (cilkg_is_published()) {
__cilkrts_worker *w = __cilkrts_get_tls_worker();
if (w) {
g = w->g;
// If there's only 1 worker, the counts will be stopped in
// __cilkrts_scheduler
if (g->P > 1)
{
STOP_INTERVAL(w, INTERVAL_WORKING);
STOP_INTERVAL(w, INTERVAL_IN_SCHEDULER);
}
__cilkrts_set_tls_worker(0);
if (w->self == -1) {
// This worker is an overflow worker. I.e., it was created on-
// demand when the global pool ran out of workers.
destroy_worker(w);
__cilkrts_free(w);
} else {
// This is a normal user worker and needs to be counted by the
// global state for the purposes of throttling system workers.
w->l->type = WORKER_FREE;
__cilkrts_leave_cilk(g);
}
stop_cilkscreen = (0 == g->Q);
}
}
global_os_mutex_unlock();
/* Turn off Cilkscreen. This needs to be done when we are NOT holding the
* os mutex. */
if (stop_cilkscreen)
__cilkrts_cilkscreen_disable_instrumentation();
}
/* special return from the initial frame */
void __cilkrts_c_return_from_initial(__cilkrts_worker *w)
{
struct cilkred_map *rm;
/* This is only called on a user thread worker. */
CILK_ASSERT(w->l->type == WORKER_USER);
#if REDPAR_DEBUG >= 3
fprintf(stderr, "[W=%d, desc=cilkrts_c_return_from_initial, ff=%p]\n",
w->self, w->l->frame_ff);
#endif
BEGIN_WITH_WORKER_LOCK_OPTIONAL(w) {
full_frame *ff = w->l->frame_ff;
CILK_ASSERT(ff);
CILK_ASSERT(ff->join_counter == 1);
w->l->frame_ff = 0;
CILK_ASSERT(ff->fiber_self);
// Save any TBB interop data for the next time this thread enters Cilk
cilk_fiber_tbb_interop_save_info_from_stack(ff->fiber_self);
// Deallocate cilk_fiber that mapped to the user stack. The stack
// itself does not get deallocated (of course) but our data
// structure becomes divorced from it.
#if FIBER_DEBUG >= 1
fprintf(stderr, "ThreadId=%p: w=%d: We are about to deallocate ff->fiber_self = %p here. w->l->scheduling_fiber = %p. w->l->type = %d\n",
cilkos_get_current_thread_id(),
w->self,
ff->fiber_self,
w->l->scheduling_fiber,
w->l->type);
#endif
// The fiber in ff is a user-code fiber. The fiber in
// w->l->scheduling_fiber is a scheduling fiber. These fibers should
// never be equal. When a user worker returns (and will unbind), we
// should destroy only the fiber in ff. The scheduling fiber will be
// re-used.
CILK_ASSERT(ff->fiber_self != w->l->scheduling_fiber);
START_INTERVAL(w, INTERVAL_FIBER_DEALLOCATE) {
// This fiber might not be deallocated here if there
// is a pending exception on Windows that refers
// to this fiber.
//
// First "suspend" the fiber, and then try to delete it.
cilk_fiber_deallocate_from_thread(ff->fiber_self);
} STOP_INTERVAL(w, INTERVAL_FIBER_DEALLOCATE);
ff->fiber_self = NULL;
/* Save reducer map into global_state object */
rm = w->reducer_map;
w->reducer_map = NULL;
#if REDPAR_DEBUG >= 3
fprintf(stderr, "W=%d, reducer_map_to_delete=%p, was in ff=%p\n",
w->self,
rm,
ff);
#endif
__cilkrts_destroy_full_frame(w, ff);
/* Work is never done. w->g->work_done = 1; __cilkrts_fence(); */
} END_WITH_WORKER_LOCK_OPTIONAL(w);
save_pedigree_leaf_from_user_worker(w);
// Workers can have NULL reducer maps now.
if (rm) {
__cilkrts_destroy_reducer_map(w, rm);
}
#if FIBER_DEBUG >= 1
__cilkrts_worker* tmp = w;
int tmp_id = w->self;
fprintf(stderr, "w=%d: We are about unbind thread (w= %p)\n",
w->self,
w);
#endif
w = NULL;
__cilkrts_unbind_thread();
#if FIBER_DEBUG >= 1
fprintf(stderr, "w=%p, %d: Finished unbind\n",
tmp, tmp_id);
#endif
/* Other workers will stop trying to steal if this was the last worker. */
return;
}
/*
* __cilkrts_restore_stealing
*
* Restore the protected_tail to a previous state, possibly allowing frames
* to be stolen. The dekker_protocol has been extended to steal only if
* head+1 is < protected_tail.
*/
void __cilkrts_restore_stealing(
__cilkrts_worker *w,
__cilkrts_stack_frame *volatile *saved_protected_tail)
{
/* On most x86 this pair of operations would be slightly faster
as an atomic exchange due to the implicit memory barrier in
an atomic instruction. */
w->protected_tail = saved_protected_tail;
__cilkrts_fence();
}
/*
* __cilkrts_disallow_stealing
*
* Move the protected_tail to NEW_PROTECTED_TAIL, preventing any
* frames from being stolen. If NEW_PROTECTED_TAIL is NULL, prevent
* stealing from the whole queue. The dekker_protocol has been
* extended to only steal if head+1 is also < protected_tail.
*/
__cilkrts_stack_frame *volatile *__cilkrts_disallow_stealing(
__cilkrts_worker *w,
__cilkrts_stack_frame *volatile *new_protected_tail)
{
__cilkrts_stack_frame *volatile *saved_protected_tail = w->protected_tail;
if (!new_protected_tail)
new_protected_tail = w->l->ltq;
if (w->protected_tail > new_protected_tail) {
w->protected_tail = new_protected_tail;
/* Issue a store-store barrier. The update to protected_tail
here must precede the update to tail in the next spawn.
On x86 this is probably not needed. */
#if defined __GNUC__ && __ICC >= 1200 && !(__MIC__ ||__MIC2__)
_mm_sfence();
#else
__cilkrts_fence();
#endif
}
return saved_protected_tail;
}
/*************************************************************
Initialization and startup
*************************************************************/
__cilkrts_worker *make_worker(global_state_t *g,
int self, __cilkrts_worker *w)
{
w->self = self;
w->g = g;
w->pedigree.rank = 0; // Initial rank is 0
w->pedigree.parent = NULL;
w->l = (local_state *)__cilkrts_malloc(sizeof(*w->l));
__cilkrts_frame_malloc_per_worker_init(w);
w->reducer_map = NULL;
w->current_stack_frame = NULL;
w->reserved = NULL;
w->l->worker_magic_0 = WORKER_MAGIC_0;
w->l->team = NULL;
w->l->type = WORKER_FREE;
__cilkrts_mutex_init(&w->l->lock);
__cilkrts_mutex_init(&w->l->steal_lock);
w->l->do_not_steal = 0;
w->l->frame_ff = 0;
w->l->next_frame_ff = 0;
w->l->last_full_frame = NULL;
w->l->ltq = (__cilkrts_stack_frame **)
__cilkrts_malloc(g->ltqsize * sizeof(*w->l->ltq));
w->ltq_limit = w->l->ltq + g->ltqsize;
w->head = w->tail = w->l->ltq;
cilk_fiber_pool_init(&w->l->fiber_pool,
&g->fiber_pool,
g->stack_size,
g->fiber_pool_size,
0, // alloc_max is 0. We don't allocate from the heap directly without checking the parent pool.
0);
#if FIBER_DEBUG >= 2
fprintf(stderr, "ThreadId=%p: Making w=%d (%p), pool = %p\n",
cilkos_get_current_thread_id(),
w->self, w,
&w->l->fiber_pool);
#endif
w->l->scheduling_fiber = NULL;
w->l->original_pedigree_leaf = NULL;
w->l->rand_seed = 0; /* the scheduler will overwrite this field */
w->l->post_suspend = 0;
w->l->suspended_stack = 0;
w->l->fiber_to_free = NULL;
w->l->pending_exception = NULL;
#if CILK_PROFILE
w->l->stats = __cilkrts_malloc(sizeof(statistics));
__cilkrts_init_stats(w->l->stats);
#else
w->l->stats = NULL;
#endif
w->l->steal_failure_count = 0;
w->l->work_stolen = 0;
// Initialize record/replay assuming we're doing neither
w->l->record_replay_fptr = NULL;
w->l->replay_list_root = NULL;
w->l->replay_list_entry = NULL;
w->l->signal_node = NULL;
// Nothing's been stolen yet
w->l->worker_magic_1 = WORKER_MAGIC_1;
/*w->parallelism_disabled = 0;*/
// Allow stealing all frames. Sets w->saved_protected_tail
__cilkrts_restore_stealing(w, w->ltq_limit);
__cilkrts_init_worker_sysdep(w);
reset_THE_exception(w);
return w;
}
void destroy_worker(__cilkrts_worker *w)
{
CILK_ASSERT (NULL == w->l->pending_exception);
// Deallocate the scheduling fiber
if (NULL != w->l->scheduling_fiber)
{
// The scheduling fiber is the main fiber for system workers and must
// be deallocated by the thread that created it. Thus, we can
// deallocate only free workers' (formerly user workers) scheduling
// fibers here.
CILK_ASSERT(WORKER_FREE == w->l->type);
#if FIBER_DEBUG >=1
fprintf(stderr, "ThreadId=%p, w=%p, %d, deallocating scheduling fiber = %p, \n",
cilkos_get_current_thread_id(),
w,
w->self,
w->l->scheduling_fiber);
#endif
int ref_count = cilk_fiber_remove_reference(w->l->scheduling_fiber, NULL);
// Scheduling fiber should never have extra references because of exceptions.
CILK_ASSERT(0 == ref_count);
w->l->scheduling_fiber = NULL;
}
#if CILK_PROFILE
if (w->l->stats) {
__cilkrts_free(w->l->stats);
}
#else
CILK_ASSERT(NULL == w->l->stats);
#endif
/* Free any cached fibers. */
cilk_fiber_pool_destroy(&w->l->fiber_pool);
__cilkrts_destroy_worker_sysdep(w);
if (w->l->signal_node) {
CILK_ASSERT(WORKER_SYSTEM == w->l->type);
signal_node_destroy(w->l->signal_node);
}
__cilkrts_free(w->l->ltq);
__cilkrts_mutex_destroy(0, &w->l->lock);
__cilkrts_mutex_destroy(0, &w->l->steal_lock);
__cilkrts_frame_malloc_per_worker_cleanup(w);
__cilkrts_free(w->l);
// The caller is responsible for freeing the worker memory
}
/*
* Make a worker into a system worker.
*/
static void make_worker_system(__cilkrts_worker *w) {
CILK_ASSERT(WORKER_FREE == w->l->type);
w->l->type = WORKER_SYSTEM;
w->l->signal_node = signal_node_create();
}
void __cilkrts_deinit_internal(global_state_t *g)
{
int i;
__cilkrts_worker *w;
// If there's no global state then we're done
if (NULL == g)
return;
#ifdef CILK_PROFILE
__cilkrts_dump_stats_to_stderr(g);
#endif
w = g->workers[0];
if (w->l->frame_ff) {
__cilkrts_destroy_full_frame(w, w->l->frame_ff);
w->l->frame_ff = 0;
}
// Release any resources used for record/replay
replay_term(g);
// Destroy any system dependent global state
__cilkrts_destroy_global_sysdep(g);
for (i = 0; i < g->total_workers; ++i)
destroy_worker(g->workers[i]);
// Free memory for all worker blocks which were allocated contiguously
__cilkrts_free(g->workers[0]);
__cilkrts_free(g->workers);
cilk_fiber_pool_destroy(&g->fiber_pool);
__cilkrts_frame_malloc_global_cleanup(g);
cilkg_deinit_global_state();
}
/*
* Wake the runtime by notifying the system workers that they can steal. The
* first user worker into the runtime should call this.
*/
static void wake_runtime(global_state_t *g)
{
__cilkrts_worker *root;
if (g->P > 1) {
// Send a message to the root node. The message will propagate.
root = g->workers[0];
CILK_ASSERT(root->l->signal_node);
signal_node_msg(root->l->signal_node, 1);
}
}
/*
* Put the runtime to sleep. The last user worker out of the runtime should
* call this. Like Dad always said, turn out the lights when nobody's in the
* room.
*/
static void sleep_runtime(global_state_t *g)
{
__cilkrts_worker *root;
if (g->P > 1) {
// Send a message to the root node. The message will propagate.
root = g->workers[0];
CILK_ASSERT(root->l->signal_node);
signal_node_msg(root->l->signal_node, 0);
}
}
/* Called when a user thread joins Cilk.
Global lock must be held. */
void __cilkrts_enter_cilk(global_state_t *g)
{
if (g->Q++ == 0) {
// If this is the first user thread to enter Cilk wake
// up all the workers.
wake_runtime(g);
}
}
/* Called when a user thread leaves Cilk.
Global lock must be held. */
void __cilkrts_leave_cilk(global_state_t *g)
{
if (--g->Q == 0) {
// Put the runtime to sleep.
sleep_runtime(g);
}
}
/*
* worker_runnable
*
* Return true if the worker should continue to try to steal. False, otherwise.
*/
NOINLINE
static enum schedule_t worker_runnable(__cilkrts_worker *w)
{
global_state_t *g = w->g;
/* If this worker has something to do, do it.
Otherwise the work would be lost. */
if (w->l->next_frame_ff)
return SCHEDULE_RUN;
// If Cilk has explicitly (by the user) been told to exit (i.e., by
// __cilkrts_end_cilk() -> __cilkrts_stop_workers(g)), then return 0.
if (g->work_done)
return SCHEDULE_EXIT;
if (0 == w->self) {
// This worker is the root node and is the only one that may query the
// global state to see if there are still any user workers in Cilk.
if (w->l->steal_failure_count > g->max_steal_failures) {
if (signal_node_should_wait(w->l->signal_node)) {
return SCHEDULE_WAIT;
} else {
// Reset the steal_failure_count since we have verified that
// user workers are still in Cilk.
w->l->steal_failure_count = 0;
}
}
} else if (WORKER_SYSTEM == w->l->type &&
signal_node_should_wait(w->l->signal_node)) {
// This worker has been notified by its parent that it should stop
// trying to steal.
return SCHEDULE_WAIT;
}
return SCHEDULE_RUN;
}
// Initialize the worker structs, but don't start the workers themselves.
static void init_workers(global_state_t *g)
{
int total_workers = g->total_workers;
int i;
struct CILK_ALIGNAS(256) buffered_worker {
__cilkrts_worker w;
char buf[64];
} *workers_memory;
/* not needed if only one worker */
cilk_fiber_pool_init(&g->fiber_pool,
NULL,
g->stack_size,
g->global_fiber_pool_size, // buffer_size
g->max_stacks, // maximum # to allocate
1);
cilk_fiber_pool_set_fiber_limit(&g->fiber_pool,
(g->max_stacks ? g->max_stacks : INT_MAX));
g->workers = (__cilkrts_worker **)
__cilkrts_malloc(total_workers * sizeof(*g->workers));
// Allocate 1 block of memory for workers to make life easier for tools
// like Inspector which run multithreaded and need to know the memory
// range for all the workers that will be accessed in a user's program
workers_memory = (struct buffered_worker*)
__cilkrts_malloc(sizeof(*workers_memory) * total_workers);
// Notify any tools that care (Cilkscreen and Inspector) that they should
// ignore memory allocated for the workers
__cilkrts_cilkscreen_ignore_block(&workers_memory[0],
&workers_memory[total_workers]);
// Initialize worker structs, including unused worker slots.
for (i = 0; i < total_workers; ++i) {
g->workers[i] = make_worker(g, i, &workers_memory[i].w);
}
// Set the workers in the first P - 1 slots to be system workers.
// Remaining worker structs already have type == 0.
for (i = 0; i < g->system_workers; ++i) {
make_worker_system(g->workers[i]);
}
}
void __cilkrts_init_internal(int start)
{
global_state_t *g = NULL;
if (cilkg_is_published()) {
g = cilkg_init_global_state();
}
else {
// We think the state has not been published yet.
// Grab the lock and try to initialize/publish.
global_os_mutex_lock();
if (cilkg_is_published()) {
// Some other thread must have snuck in and published.
g = cilkg_init_global_state();
}
else {
// Initialize and retrieve global state
g = cilkg_init_global_state();
// Set the scheduler pointer
g->scheduler = worker_scheduler_function;
// If we're running under a sequential P-Tool (Cilkscreen or
// Cilkview) then there's only one worker and we need to tell
// the tool about the extent of the stack
if (g->under_ptool)
__cilkrts_establish_c_stack();
init_workers(g);
// Initialize per-work record/replay logging
replay_init_workers(g);
// Initialize any system dependent global state
__cilkrts_init_global_sysdep(g);
cilkg_publish_global_state(g);
}
global_os_mutex_unlock();
}
CILK_ASSERT(g);
if (start && !g->workers_running)
{
// Acquire the global OS mutex while we're starting the workers
global_os_mutex_lock();
if (!g->workers_running)
// Start P - 1 system workers since P includes the first user
// worker.
__cilkrts_start_workers(g, g->P - 1);
global_os_mutex_unlock();
}
}
/************************************************************************
Methods for reducer protocol.
Reductions occur in two places:
A. A full frame "ff" is returning from a spawn with a stolen parent.
B. A full frame "ff" is stalling at a sync.
To support parallel reductions, reduction functions need to be
executed while control is on a user stack, before jumping into the
runtime. These reductions can not occur while holding a worker or
frame lock.
Before a worker w executes a reduction in either Case A or B, w's
deque is empty.
Since parallel reductions push work onto the deque, we must do extra
work to set up runtime data structures properly before reductions
begin to allow stealing. ( Normally, when we have only serial
reductions, once a worker w starts a reduction, its deque remains
empty until w either steals another frame or resumes a suspended
frame. Thus, we don't care about the state of the deque, since w
will reset its deque when setting up execution of a frame. )
To allow for parallel reductions, we coerce the runtime data
structures so that, from their perspective, it looks as though we
have spliced in an "execute_reductions()" function. Consider the
two cases for reductions:
Case A: Return from a spawn with a stolen parent.
Consider a spawned function g is returning on a worker w.
Assume:
- g was spawned from a parent function f.
- ff is the full frame for g's spawn helper
- sf be the __cilkrts_stack_frame for g's spawn helper.
We are conceptually splicing "execute_reductions()" so that it
occurs immediately before the spawn helper of g returns to f.
We do so by creating two different world views --- one for the
runtime data structures, and one for the actual control flow.
- Before reductions begin, the runtime data structures should
look as though the spawn helper of g is calling
"execute_reductions()", in terms of both the user stack and
worker deque. More precisely, w should satisfy the
following properties:
(a) w has ff as its full frame,
(b) w has sf as its __cilkrts_stack_frame, and
(c) w has an empty deque.
If the runtime satisfies these properties, then if w
encounters a spawn in a parallel reduction, it can push onto
a valid deque. Also, when a steal from w occurs, it will
build the correct tree of full frames when w is stolen from.
- In actual control flow, however, once the
"execute_reductions()" function returns, it is actually
returning to runtime code instead of g's spawn helper.
At the point a worker w began executing reductions, the
control flow / compiled code had already finished g's spawn
helper, and w was about to enter the runtime. With parallel
reductions, some worker v (which might be different from w)
is the one returning to the runtime.
The reduction logic consists of 4 steps:
A1. Restore runtime data structures to make it look as though
the spawn helper of g() is still the currently executing
frame for w.
A2. Execute reductions on the user stack. Reductions also
includes the logic for exceptions and stacks. Note that
reductions start on w, but may finish on a different
worker if there is parallelism in the reduce.
A3. Splice out ff from the tree of full frames.
A4. Jump into the runtime/scheduling stack and execute
"do_return_from_spawn". This method
(a) Frees the user stack we were just on if it is no longer needed.
(b) Decrement the join counter on ff->parent, and tries to do a
provably good steal.
(c) Clean up the full frame ff.
Case B: Stalling at a sync.
Consider a function g(), with full frame ff and
__cilkrts_stack_frame sf. Suppose g() stalls at a sync, and we
are executing reductions.
Conceptually, we are splicing in an "execute_reductions()"
function into g() as the last action that g() takes immediately
before it executes the cilk_sync.
The reduction logic for this case is similar to Case A.
B1. Restore the runtime data structures.
The main difference from Case A is that ff/sf is still a
frame that needs to be executed later (since it is stalling
at a cilk_sync). Thus, we also need to save the current
stack information into "ff" so that we can correctly resume
execution of "ff" after the sync.
B2. Execute reductions on the user stack.
B3. No frame to splice out of the tree.
B4. Jump into the runtime/scheduling stack and execute "do_sync".
This method:
(a) Frees the user stack we were just on if it is no longer needed.
(b) Tries to execute a provably good steal.
Finally, for the reducer protocol, we consider two reduction paths,
namely a "fast" and "slow" path. On a fast path, only trivial
merges of reducer maps happen (i.e., one or both of the maps are
NULL). Otherwise, on the slow path, a reduction actually needs to
happen.
*****************************************************************/
/**
* @brief Locations to store the result of a reduction.
*
* Struct storing pointers to the fields in our "left" sibling that we
* should update when splicing out a full frame or stalling at a sync.
*/
typedef struct {
/** A pointer to the location of our left reducer map. */
struct cilkred_map **map_ptr;
/** A pointer to the location of our left exception. */
struct pending_exception_info **exception_ptr;
} splice_left_ptrs;
/**
* For a full frame returning from a spawn, calculate the pointers to
* the maps and exceptions to my left.
*
* @param w The currently executing worker.
* @param ff Full frame that is dying
* @return Pointers to our "left" for reducers and exceptions.
*/
static inline
splice_left_ptrs compute_left_ptrs_for_spawn_return(__cilkrts_worker *w,
full_frame *ff)
{
// ASSERT: we hold the lock on ff->parent
splice_left_ptrs left_ptrs;
if (ff->left_sibling) {
left_ptrs.map_ptr = &ff->left_sibling->right_reducer_map;
left_ptrs.exception_ptr = &ff->left_sibling->right_pending_exception;
}
else {
full_frame *parent_ff = ff->parent;
left_ptrs.map_ptr = &parent_ff->children_reducer_map;
left_ptrs.exception_ptr = &parent_ff->child_pending_exception;
}
return left_ptrs;
}
/**
* For a full frame at a sync, calculate the pointers to the maps and
* exceptions to my left.
*
* @param w The currently executing worker.
* @param ff Full frame that is stalling at a sync.
* @return Pointers to our "left" for reducers and exceptions.
*/
static inline
splice_left_ptrs compute_left_ptrs_for_sync(__cilkrts_worker *w,
full_frame *ff)
{
// ASSERT: we hold the lock on ff
splice_left_ptrs left_ptrs;
// Figure out which map to the left we should merge into.
if (ff->rightmost_child) {
CILK_ASSERT(ff->rightmost_child->parent == ff);
left_ptrs.map_ptr = &(ff->rightmost_child->right_reducer_map);
left_ptrs.exception_ptr = &(ff->rightmost_child->right_pending_exception);
}
else {
// We have no children. Then, we should be the last
// worker at the sync... "left" is our child map.
left_ptrs.map_ptr = &(ff->children_reducer_map);
left_ptrs.exception_ptr = &(ff->child_pending_exception);
}
return left_ptrs;
}
/**
* After we have completed all reductions on a spawn return, call this
* method to finish up before jumping into the runtime.
*
* 1. Perform the "reduction" on stacks, i.e., execute the left
* holder logic to pass the leftmost stack up.
*
* w->l->fiber_to_free holds any stack that needs to be freed
* when control switches into the runtime fiber.
*
* 2. Unlink and remove child_ff from the tree of full frames.
*
* @param w The currently executing worker.
* @param parent_ff The parent of child_ff.
* @param child_ff The full frame returning from a spawn.
*/
static inline
void finish_spawn_return_on_user_stack(__cilkrts_worker *w,
full_frame *parent_ff,
full_frame *child_ff)
{
CILK_ASSERT(w->l->fiber_to_free == NULL);
// Execute left-holder logic for stacks.
if (child_ff->left_sibling || parent_ff->fiber_child) {
// Case where we are not the leftmost stack.
CILK_ASSERT(parent_ff->fiber_child != child_ff->fiber_self);
// Remember any fiber we need to free in the worker.
// After we jump into the runtime, we will actually do the
// free.
w->l->fiber_to_free = child_ff->fiber_self;
}
else {
// We are leftmost, pass stack/fiber up to parent.
// Thus, no stack/fiber to free.
parent_ff->fiber_child = child_ff->fiber_self;
w->l->fiber_to_free = NULL;
}
child_ff->fiber_self = NULL;
unlink_child(parent_ff, child_ff);
}
/**
* Executes any fast reductions necessary to splice ff out of the tree
* of full frames.
*
* This "fast" path performs only trivial merges of reducer maps,
* i.e,. when one of them is NULL.
* (See slow_path_reductions_for_spawn_return() for slow path.)
*
* Returns: 1 if we finished all reductions.
* Returns: 0 if there are still reductions to execute, and
* we should execute the slow path.
*
* This method assumes w holds the frame lock on parent_ff.
* After this method completes:
* 1. We have spliced ff out of the tree of full frames.
* 2. The reducer maps of child_ff have been deposited
* "left" according to the reducer protocol.
* 3. w->l->stack_to_free stores the stack
* that needs to be freed once we jump into the runtime.
*
* We have not, however, decremented the join counter on ff->parent.
* This prevents any other workers from resuming execution of the parent.
*
* @param w The currently executing worker.
* @param ff The full frame returning from a spawn.
* @return NULL if we finished all reductions.
* @return The address where the left map is stored (which should be passed to
* slow_path_reductions_for_spawn_return()) if there are
* still reductions to execute.
*/
struct cilkred_map**
fast_path_reductions_for_spawn_return(__cilkrts_worker *w,
full_frame *ff)
{
// ASSERT: we hold ff->parent->lock.
splice_left_ptrs left_ptrs;
CILK_ASSERT(NULL == w->l->pending_exception);
// Figure out the pointers to the left where I want
// to put reducers and exceptions.
left_ptrs = compute_left_ptrs_for_spawn_return(w, ff);
// Go ahead and merge exceptions while holding the lock.
splice_exceptions_for_spawn(w, ff, left_ptrs.exception_ptr);
// Now check if we have any reductions to perform.
//
// Consider all the cases of left, middle and right maps.
// 0. (-, -, -) : finish and return 1
// 1. (L, -, -) : finish and return 1
// 2. (-, M, -) : slide over to left, finish, and return 1.
// 3. (L, M, -) : return 0
// 4. (-, -, R) : slide over to left, finish, and return 1.
// 5. (L, -, R) : return 0
// 6. (-, M, R) : return 0
// 7. (L, M, R) : return 0
//
// In terms of code:
// L == *left_ptrs.map_ptr
// M == w->reducer_map
// R == f->right_reducer_map.
//
// The goal of the code below is to execute the fast path with
// as few branches and writes as possible.
int case_value = (*(left_ptrs.map_ptr) != NULL);
case_value += ((w->reducer_map != NULL) << 1);
case_value += ((ff->right_reducer_map != NULL) << 2);
// Fastest path is case_value == 0 or 1.
if (case_value >=2) {
switch (case_value) {
case 2:
*(left_ptrs.map_ptr) = w->reducer_map;
w->reducer_map = NULL;
return NULL;
break;
case 4:
*(left_ptrs.map_ptr) = ff->right_reducer_map;
ff->right_reducer_map = NULL;
return NULL;
default:
// If we have to execute the slow path, then
// return the pointer to the place to deposit the left
// map.
return left_ptrs.map_ptr;
}
}
// Do nothing
return NULL;
}
/**
* Executes any reductions necessary to splice "ff" frame out of
* the steal tree.
*
* This method executes the "slow" path for reductions on a spawn
* return, i.e., there are non-NULL maps that need to be merged
* together.
*
* This method should execute only if
* fast_path_reductions_for_spawn_return() returns a non-NULL
* left_map_ptr.
*
* Upon entry, left_map_ptr should be the location of the left map
* at the start of the reduction, as calculated by
* fast_path_reductions_for_spawn_return().
*
* After this method completes:
* 1. We have spliced ff out of the tree of full frames.
* 2. The reducer maps of child_ff have been deposited
* "left" according to the reducer protocol.
* 3. w->l->stack_to_free stores the stack
* that needs to be freed once we jump into the runtime.
* We have not, however, decremented the join counter on ff->parent,
* so no one can resume execution of the parent yet.
*
* WARNING:
* This method assumes the lock on ff->parent is held upon entry, and
* Upon exit, the worker that returns still holds a lock on ff->parent
* This method can, however, release and reacquire the lock on ff->parent.
*
* @param w The currently executing worker.
* @param ff The full frame returning from a spawn.
* @param left_map_ptr Pointer to our initial left map.
* @return The worker that this method returns on.
*/
static __cilkrts_worker*
slow_path_reductions_for_spawn_return(__cilkrts_worker *w,
full_frame *ff,
struct cilkred_map **left_map_ptr)
{
// CILK_ASSERT: w is holding frame lock on parent_ff.
#if REDPAR_DEBUG > 0
CILK_ASSERT(!ff->rightmost_child);
CILK_ASSERT(!ff->is_call_child);
#endif
// Loop invariant:
// When beginning this loop, we should
// 1. Be holding the lock on ff->parent.
// 2. left_map_ptr should be the address of the pointer to the left map.
// 3. All maps should be slid over left by one, if possible.
// 4. All exceptions should be merged so far.
while (1) {
// Slide middle map left if possible.
if (!(*left_map_ptr)) {
*left_map_ptr = w->reducer_map;
w->reducer_map = NULL;
}
// Slide right map to middle if possible.
if (!w->reducer_map) {
w->reducer_map = ff->right_reducer_map;
ff->right_reducer_map = NULL;
}
// Since we slid everything left by one,
// we are finished if there is no middle map.
if (!w->reducer_map) {
verify_current_wkr(w);
return w;
}
else {
struct cilkred_map* left_map;
struct cilkred_map* middle_map;
struct cilkred_map* right_map;
// Take all the maps from their respective locations.
// We can't leave them in place and execute a reduction because these fields
// might change once we release the lock.
left_map = *left_map_ptr;
*left_map_ptr = NULL;
middle_map = w->reducer_map;
w->reducer_map = NULL;
right_map = ff->right_reducer_map;
ff->right_reducer_map = NULL;
// WARNING!!! Lock release here.
// We have reductions to execute (and we can't hold locks).
__cilkrts_frame_unlock(w, ff->parent);
// Merge all reducers into the left map.
left_map = repeated_merge_reducer_maps(&w,
left_map,
middle_map);
verify_current_wkr(w);
left_map = repeated_merge_reducer_maps(&w,
left_map,
right_map);
verify_current_wkr(w);
CILK_ASSERT(NULL == w->reducer_map);
// Put the final answer back into w->reducer_map.
w->reducer_map = left_map;
// Save any exceptions generated because of the reduction
// process from the returning worker. These get merged
// the next time around the loop.
CILK_ASSERT(NULL == ff->pending_exception);
ff->pending_exception = w->l->pending_exception;
w->l->pending_exception = NULL;
// Lock ff->parent for the next loop around.
__cilkrts_frame_lock(w, ff->parent);
// Once we have the lock again, recompute who is to our
// left.
splice_left_ptrs left_ptrs;
left_ptrs = compute_left_ptrs_for_spawn_return(w, ff);
// Update the pointer for the left map.
left_map_ptr = left_ptrs.map_ptr;
// Splice the exceptions for spawn.
splice_exceptions_for_spawn(w, ff, left_ptrs.exception_ptr);
}
}
// We should never break out of this loop.
CILK_ASSERT(0);
return NULL;
}
/**
* Execute reductions when returning from a spawn whose parent has
* been stolen.
*
* Execution may start on w, but may finish on a different worker.
* This method acquires/releases the lock on ff->parent.
*
* @param w The currently executing worker.
* @param ff The full frame of the spawned function that is returning.
* @param returning_sf The __cilkrts_stack_frame for this returning function.
* @return The worker returning from this method.
*/
static __cilkrts_worker*
execute_reductions_for_spawn_return(__cilkrts_worker *w,
full_frame *ff,
__cilkrts_stack_frame *returning_sf)
{
// Step A1 from reducer protocol described above.
//
// Coerce the runtime into thinking that
// ff/returning_sf are still on the bottom of
// w's deque.
restore_frame_for_spawn_return_reduction(w, ff, returning_sf);
// Step A2 and A3: Execute reductions on user stack.
BEGIN_WITH_FRAME_LOCK(w, ff->parent) {
struct cilkred_map **left_map_ptr;
left_map_ptr = fast_path_reductions_for_spawn_return(w, ff);
// Pointer will be non-NULL if there are
// still reductions to execute.
if (left_map_ptr) {
// WARNING: This method call may release the lock
// on ff->parent and re-acquire it (possibly on a
// different worker).
// We can't hold locks while actually executing
// reduce functions.
w = slow_path_reductions_for_spawn_return(w,
ff,
left_map_ptr);
verify_current_wkr(w);
}
finish_spawn_return_on_user_stack(w, ff->parent, ff);
// WARNING: the use of this lock macro is deceptive.
// The worker may have changed here.
} END_WITH_FRAME_LOCK(w, ff->parent);
return w;
}
/**
* Execute fast "reductions" when ff stalls at a sync.
*
* @param w The currently executing worker.
* @param ff The full frame stalling at a sync.
* @return 1 if we are finished with all reductions after calling this method.
* @return 0 if we still need to execute the slow path reductions.
*/
static inline
int fast_path_reductions_for_sync(__cilkrts_worker *w,
full_frame *ff) {
// Return 0 if there is some reduction that needs to happen.
return !(w->reducer_map || ff->pending_exception);
}
/**
* Executes slow reductions when ff stalls at a sync.
* This method should execute only if
* fast_path_reductions_for_sync(w, ff) returned 0.
*
* After this method completes:
* 1. ff's current reducer map has been deposited into
* right_reducer_map of ff's rightmost child, or
* ff->children_reducer_map if ff has no children.
* 2. Similarly for ff's current exception.
* 3. Nothing to calculate for stacks --- if we are stalling
* we will always free a stack.
*
* This method may repeatedly acquire/release the lock on ff.
*
* @param w The currently executing worker.
* @param ff The full frame stalling at a sync.
* @return The worker returning from this method.
*/
static __cilkrts_worker*
slow_path_reductions_for_sync(__cilkrts_worker *w,
full_frame *ff)
{
struct cilkred_map *left_map;
struct cilkred_map *middle_map;
#if (REDPAR_DEBUG > 0)
CILK_ASSERT(ff);
CILK_ASSERT(w->head == w->tail);
#endif
middle_map = w->reducer_map;
w->reducer_map = NULL;
// Loop invariant: middle_map should be valid (the current map to reduce).
// left_map is junk.
// w->reducer_map == NULL.
while (1) {
BEGIN_WITH_FRAME_LOCK(w, ff) {
splice_left_ptrs left_ptrs = compute_left_ptrs_for_sync(w, ff);
// Grab the "left" map and store pointers to those locations.
left_map = *(left_ptrs.map_ptr);
*(left_ptrs.map_ptr) = NULL;
// Slide the maps in our struct left as far as possible.
if (!left_map) {
left_map = middle_map;
middle_map = NULL;
}
*(left_ptrs.exception_ptr) =
__cilkrts_merge_pending_exceptions(w,
*left_ptrs.exception_ptr,
ff->pending_exception);
ff->pending_exception = NULL;
// If there is no middle map, then we are done.
// Deposit left and return.
if (!middle_map) {
*(left_ptrs).map_ptr = left_map;
#if (REDPAR_DEBUG > 0)
CILK_ASSERT(NULL == w->reducer_map);
#endif
// Sanity check upon leaving the loop.
verify_current_wkr(w);
// Make sure to unlock before we return!
__cilkrts_frame_unlock(w, ff);
return w;
}
} END_WITH_FRAME_LOCK(w, ff);
// If we get here, we have a nontrivial reduction to execute.
middle_map = repeated_merge_reducer_maps(&w,
left_map,
middle_map);
verify_current_wkr(w);
// Save any exceptions generated because of the reduction
// process. These get merged the next time around the
// loop.
CILK_ASSERT(NULL == ff->pending_exception);
ff->pending_exception = w->l->pending_exception;
w->l->pending_exception = NULL;
}
// We should never break out of the loop above.
CILK_ASSERT(0);
return NULL;
}
/**
* Execute reductions when ff stalls at a sync.
*
* Execution starts on w, but may finish on a different worker.
* This method may acquire/release the lock on ff.
*
* @param w The currently executing worker.
* @param ff The full frame of the spawned function at the sync
* @param sf_at_sync The __cilkrts_stack_frame stalling at a sync
* @return The worker returning from this method.
*/
static __cilkrts_worker*
execute_reductions_for_sync(__cilkrts_worker *w,
full_frame *ff,
__cilkrts_stack_frame *sf_at_sync)
{
int finished_reductions;
// Step B1 from reducer protocol above:
// Restore runtime invariants.
//
// The following code for this step is almost equivalent to
// the following sequence:
// 1. disown(w, ff, sf_at_sync, "sync") (which itself
// calls make_unrunnable(w, ff, sf_at_sync))
// 2. make_runnable(w, ff, sf_at_sync).
//
// The "disown" will mark the frame "sf_at_sync"
// as stolen and suspended, and save its place on the stack,
// so it can be resumed after the sync.
//
// The difference is, that we don't want the disown to
// break the following connections yet, since we are
// about to immediately make sf/ff runnable again anyway.
// sf_at_sync->worker == w
// w->l->frame_ff == ff.
//
// These connections are needed for parallel reductions, since
// we will use sf / ff as the stack frame / full frame for
// executing any potential reductions.
//
// TBD: Can we refactor the disown / make_unrunnable code
// to avoid the code duplication here?
ff->call_stack = NULL;
// Normally, "make_unrunnable" would add CILK_FRAME_STOLEN and
// CILK_FRAME_SUSPENDED to sf_at_sync->flags and save the state of
// the stack so that a worker can resume the frame in the correct
// place.
//
// But on this path, CILK_FRAME_STOLEN should already be set.
// Also, we technically don't want to suspend the frame until
// the reduction finishes.
// We do, however, need to save the stack before
// we start any reductions, since the reductions might push more
// data onto the stack.
CILK_ASSERT(sf_at_sync->flags | CILK_FRAME_STOLEN);
__cilkrts_put_stack(ff, sf_at_sync);
__cilkrts_make_unrunnable_sysdep(w, ff, sf_at_sync, 1,
"execute_reductions_for_sync");
CILK_ASSERT(w->l->frame_ff == ff);
// Step B2: Execute reductions on user stack.
// Check if we have any "real" reductions to do.
finished_reductions = fast_path_reductions_for_sync(w, ff);
if (!finished_reductions) {
// Still have some real reductions to execute.
// Run them here.
// This method may acquire/release the lock on ff.
w = slow_path_reductions_for_sync(w, ff);
// The previous call may return on a different worker.
// than what we started on.
verify_current_wkr(w);
}
#if REDPAR_DEBUG >= 0
CILK_ASSERT(w->l->frame_ff == ff);
CILK_ASSERT(ff->call_stack == NULL);
#endif
// Now we suspend the frame ff (since we've
// finished the reductions). Roughly, we've split apart the
// "make_unrunnable" call here --- we've already saved the
// stack info earlier before the reductions execute.
// All that remains is to restore the call stack back into the
// full frame, and mark the frame as suspended.
ff->call_stack = sf_at_sync;
sf_at_sync->flags |= CILK_FRAME_SUSPENDED;
// At a nontrivial sync, we should always free the current fiber,
// because it can not be leftmost.
w->l->fiber_to_free = ff->fiber_self;
ff->fiber_self = NULL;
return w;
}
/*
Local Variables: **
c-file-style:"bsd" **
c-basic-offset:4 **
indent-tabs-mode:nil **
End: **
*/
|