/usr/include/trilinos/Tpetra_Distributor.hpp is in libtrilinos-tpetra-dev 12.12.1-5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 | // @HEADER
// ***********************************************************************
//
// Tpetra: Templated Linear Algebra Services Package
// Copyright (2008) Sandia Corporation
//
// Under the terms of Contract DE-AC04-94AL85000 with Sandia Corporation,
// the U.S. Government retains certain rights in this software.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// 1. Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//
// 2. 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.
//
// 3. Neither the name of the Corporation nor the names of the
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY SANDIA CORPORATION "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 SANDIA CORPORATION OR THE
// 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.
//
// Questions? Contact Michael A. Heroux (maherou@sandia.gov)
//
// ************************************************************************
// @HEADER
#ifndef TPETRA_DISTRIBUTOR_HPP
#define TPETRA_DISTRIBUTOR_HPP
#include "Tpetra_Util.hpp"
#include <Teuchos_as.hpp>
#include <Teuchos_Describable.hpp>
#include <Teuchos_ParameterListAcceptorDefaultBase.hpp>
#include <Teuchos_VerboseObject.hpp>
// If TPETRA_DISTRIBUTOR_TIMERS is defined, Distributor will time
// doPosts (both versions) and doWaits, and register those timers with
// Teuchos::TimeMonitor so that summarize() or report() will show
// results.
// #ifndef TPETRA_DISTRIBUTOR_TIMERS
// # define TPETRA_DISTRIBUTOR_TIMERS 1
// #endif // TPETRA_DISTRIBUTOR_TIMERS
#ifdef TPETRA_DISTRIBUTOR_TIMERS
# undef TPETRA_DISTRIBUTOR_TIMERS
#endif // TPETRA_DISTRIBUTOR_TIMERS
#include "KokkosCompat_View.hpp"
#include "Kokkos_Core.hpp"
#include "Kokkos_TeuchosCommAdapters.hpp"
namespace Tpetra {
namespace Details {
/// \brief The type of MPI send that Distributor should use.
///
/// This is an implementation detail of Distributor. Please do
/// not rely on these values in your code.
enum EDistributorSendType {
DISTRIBUTOR_ISEND, // Use MPI_Isend (Teuchos::isend)
DISTRIBUTOR_RSEND, // Use MPI_Rsend (Teuchos::readySend)
DISTRIBUTOR_SEND, // Use MPI_Send (Teuchos::send)
DISTRIBUTOR_SSEND // Use MPI_Ssend (Teuchos::ssend)
};
/// \brief Convert an EDistributorSendType enum value to a string.
///
/// This is an implementation detail of Distributor. Please do
/// not rely on this function in your code.
std::string
DistributorSendTypeEnumToString (EDistributorSendType sendType);
/// \brief Enum indicating how and whether a Distributor was initialized.
///
/// This is an implementation detail of Distributor. Please do
/// not rely on these values in your code.
enum EDistributorHowInitialized {
DISTRIBUTOR_NOT_INITIALIZED, // Not initialized yet
DISTRIBUTOR_INITIALIZED_BY_CREATE_FROM_SENDS, // By createFromSends
DISTRIBUTOR_INITIALIZED_BY_CREATE_FROM_RECVS, // By createFromRecvs
DISTRIBUTOR_INITIALIZED_BY_CREATE_FROM_SENDS_N_RECVS, // By createFromSendsAndRecvs
DISTRIBUTOR_INITIALIZED_BY_REVERSE, // By createReverseDistributor
DISTRIBUTOR_INITIALIZED_BY_COPY, // By copy constructor
};
/// \brief Convert an EDistributorHowInitialized enum value to a string.
///
/// This is an implementation detail of Distributor. Please do
/// not rely on this function in your code.
std::string
DistributorHowInitializedEnumToString (EDistributorHowInitialized how);
} // namespace Details
/// \brief Valid values for Distributor's "Send type" parameter.
///
/// This is mainly useful as an implementation detail of
/// Distributor. You may use it if you would like a programmatic
/// way to get all possible values of the "Send type" parameter of
/// Distributor.
Teuchos::Array<std::string> distributorSendTypes ();
/// \class Distributor
/// \brief Sets up and executes a communication plan for a Tpetra DistObject.
///
/// \note Most Tpetra users do not need to know about this class.
///
/// This class encapsulates the general information and
/// communication services needed for subclasses of \c DistObject
/// (such as CrsMatrix and MultiVector) to do data redistribution
/// (Import and Export) operations. It is an implementation detail
/// of Import and Export; in particular; it actually does the
/// communication.
///
/// Here is the typical way to use this class:
/// 1. Create a Distributor. (The constructor is inexpensive.)
/// 2. Set up the Distributor once, using one of the two "plan
/// creation" methods: either createFromSends(), or
/// createFromRecvs(). This may be more expensive and
/// communication-intensive than Step 3.
/// 3. Communicate the data by calling doPostsAndWaits() (forward
/// mode), or doReversePostsAndWaits() (reverse mode). You may
/// do this multiple times with the same Distributor instance.
///
/// Step 2 is expensive, but you can amortize its cost over multiple
/// uses of the Distributor for communication (Step 3). You may
/// also separate out "posts" (invoking nonblocking communication)
/// and "waits" (waiting for that communication to complete), by
/// calling doPosts() (resp. doReversePosts()), then doWaits()
/// (resp. doReverseWaits()). This is useful if you have local work
/// to do between the posts and waits, because it may overlap
/// communication with computation. Whether it actually <i>does</i>
/// overlap, depends on both the MPI implementation and your choice
/// of parameters for the Distributor.
///
/// Instances of Distributor take the following parameters that
/// control communication and debug output:
/// - "Barrier between receives and sends" (<tt>bool</tt>):
/// Whether to execute a barrier between receives and sends in
/// do[Reverse]Posts(). A barrier is required for correctness
/// when the "Send type" parameter is "Rsend". Otherwise, a
/// barrier is correct and may be useful for debugging, but not
/// recommended, since it introduces useless synchronization.
/// - "Send type" (<tt>std::string</tt>): When using MPI, the
/// variant of MPI_Send to use in do[Reverse]Posts(). Valid
/// values include "Isend", "Rsend", "Send", and "Ssend". The
/// default is "Send". (The receive type is always MPI_Irecv, a
/// nonblocking receive. Since we post receives first before
/// sends, this prevents deadlock, even if MPI_Send blocks and
/// does not buffer.)
/// - "Debug" (\c bool): If true, print copious debugging output on
/// all processes in the Distributor's communicator. This is
/// useful only for debugging Distributor and other Tpetra classes
/// that use it (like Import and Export). If the Distributor was
/// created using one of the constructors that takes a
/// Teuchos::FancyOStream, it will write debugging output to that
/// stream. Otherwise, it will write debugging output to stderr.
/// Currently, the "Debug" parameter overrides "VerboseObject"
/// (see below).
/// - "VerboseObject" (sublist): Optional sublist for controlling
/// behavior of Distributor as a Teuchos::VerboseObject. This is
/// currently useful only for debugging. This sublist takes
/// optional parameters "Verbosity Level" (std::string) and
/// "Output File" (std::string). "Verbosity Level" has six valid
/// values: "VERB_DEFAULT", "VERB_NONE", "VERB_LOW",
/// "VERB_MEDIUM", "VERB_HIGH", and "VERB_EXTREME", with
/// increasing verbosity starting with "VERB_NONE". "Output File"
/// is the name of a file to use for output; "none" means don't
/// open a file, but write to the default output stream.
class Distributor :
public Teuchos::Describable,
public Teuchos::ParameterListAcceptorDefaultBase {
public:
//! @name Constructors and destructor
//@{
/// \brief Construct using the specified communicator and default parameters.
///
/// \param comm [in] Communicator used by the Distributor. MUST
/// be nonnull.
///
/// The constructor doesn't actually set up the distribution
/// pattern. You need to call one of the "gather / scatter
/// 'constructors'" to do that.
explicit Distributor (const Teuchos::RCP<const Teuchos::Comm<int> >& comm);
/// \brief Construct using the specified communicator and default
/// parameters, with an output stream
///
/// \param comm [in] Communicator used by the Distributor. MUST
/// be nonnull.
/// \param out [in/out] Output stream (for debugging output). If
/// null, the default is \c std::cerr.
///
/// The constructor doesn't actually set up the distribution
/// pattern. You need to call one of the "gather / scatter
/// 'constructors'" to do that.
Distributor (const Teuchos::RCP<const Teuchos::Comm<int> >& comm,
const Teuchos::RCP<Teuchos::FancyOStream>& out);
/// \brief Construct using the specified communicator and ParameterList.
///
/// \param comm [in] Communicator used by the Distributor. MUST
/// be nonnull.
/// \param plist [in/out] List of parameters controlling how the
/// Distributor performs communication, and specifying debug
/// options. If null, all parameters take their default values.
/// Please see the class documentation for a list of all
/// accepted parameters and their default values.
///
/// The constructor doesn't actually set up the distribution
/// pattern. You need to call one of the "gather / scatter
/// 'constructors'" to do that.
Distributor (const Teuchos::RCP<const Teuchos::Comm<int> >& comm,
const Teuchos::RCP<Teuchos::ParameterList>& plist);
/// \brief Construct using the specified communicator and
/// ParameterList, with an output stream
///
/// \param comm [in] Communicator used by the Distributor. MUST
/// be nonnull.
/// \param out [in/out] Output stream (for debugging output). If
/// null, the default is \c std::cerr.
/// \param plist [in/out] List of parameters controlling how the
/// Distributor performs communication, and specifying debug
/// options. If null, all parameters take their default values.
/// Please see the class documentation for a list of all
/// accepted parameters and their default values.
///
/// The constructor doesn't actually set up the distribution
/// pattern. You need to call one of the "gather / scatter
/// 'constructors'" to do that.
Distributor (const Teuchos::RCP<const Teuchos::Comm<int> >& comm,
const Teuchos::RCP<Teuchos::FancyOStream>& out,
const Teuchos::RCP<Teuchos::ParameterList>& plist);
//! Copy constructor.
Distributor (const Distributor& distributor);
//! Destructor (virtual for memory safety).
virtual ~Distributor ();
/// \brief Swap the contents of rhs with those of *this.
///
/// This is useful in Import's setUnion() method. It avoids the
/// overhead of copying arrays, since it can use std::swap on the
/// arrays.
void swap (Distributor& rhs);
//@}
//! @name Implementation of ParameterListAcceptorDefaultBase
//@{
/// \brief Set Distributor parameters.
///
/// Please see the class documentation for a list of all accepted
/// parameters and their default values.
void setParameterList (const Teuchos::RCP<Teuchos::ParameterList>& plist);
/// \brief List of valid Distributor parameters.
///
/// Please see the class documentation for a list of all accepted
/// parameters and their default values.
Teuchos::RCP<const Teuchos::ParameterList> getValidParameters () const;
//@}
//! \name Gather / scatter "constructors"
//@{
/// \brief Set up Distributor using list of process ranks to which
/// this process will send.
///
/// Take a list of process ranks and construct a plan for
/// efficiently scattering to those processes. Return the number
/// of processes which will send me (the calling process) data.
///
/// \param exportProcIDs [in] List of ranks of the processes that
/// will get the exported data. If there is a process rank
/// greater than or equal to the number of processes, all
/// processes will throw an <tt>std::runtime_error</tt>
/// exception. Process ranks less than zero are ignored; their
/// placement corresponds to null sends in any future
/// exports. That is, if <tt>exportProcIDs[0] == -1</tt>, then
/// the corresponding position in the export array is ignored
/// during a call to doPosts() or doPostsAndWaits(). For this
/// reason, a negative entry is sufficient to break contiguity.
///
/// \return Number of imports this process will be receiving.
size_t createFromSends (const Teuchos::ArrayView<const int>& exportProcIDs);
/// \brief Set up Distributor using list of process ranks from which to receive.
///
/// Take a list of process ranks and construct a plan for
/// efficiently scattering to those processes. Return the number
/// and list of IDs being sent by me (the calling process).
///
/// Import invokes this method in order to create a Distributor
/// from a list of receive neighbors and IDs. A common use case
/// for this process is setting up sends and receives for the
/// remote entries of the source vector in a distributed sparse
/// matrix-vector multiply. The Mantevo HPCCG miniapp shows an
/// annotated and simplified version of this process for that
/// special case.
///
/// \param remoteIDs [in] List of remote IDs wanted.
///
/// \param remoteProcIDs [in] The ranks of the process that will
/// send the remote IDs listed in \c remoteIDs. Process ranks
/// less than zero are ignored; their placement corresponds to
/// null sends in any future exports. If there is a process
/// rank greater than or equal to the number of processes, all
/// processes will throw an <tt>std::runtime_error</tt>
/// exception.
///
/// \param exportIDs [out] List of IDs that need to be sent from
/// this process.
///
/// \param exportProcIDs [out] The ranks of the processes that
/// will get the exported IDs in \c exportIDs.
///
/// The \c exportGIDs and \c exportProcIDs arrays are resized by
/// the Distributor, which is why they are passed in as a nonconst
/// Teuchos::Array reference.
template <class Ordinal>
void
createFromRecvs (const Teuchos::ArrayView<const Ordinal>& remoteIDs,
const Teuchos::ArrayView<const int>& remoteProcIDs,
Teuchos::Array<Ordinal>& exportIDs,
Teuchos::Array<int>& exportProcIDs);
/// \brief Set up Distributor using list of process ranks to which
/// to send, and list of process ranks from which to receive.
///
/// \param exportProcIDs [in] List of process ranks to which this
/// process must send a message.
/// \param remoteProcIDs [in] List of process ranks from which
/// this process must receive a message.
void
createFromSendsAndRecvs (const Teuchos::ArrayView<const int>& exportProcIDs,
const Teuchos::ArrayView<const int>& remoteProcIDs);
//@}
//! @name Attribute accessor methods
//@{
/// \brief The number of processes from which we will receive data.
///
/// The count does <i>not</i> include the calling process.
size_t getNumReceives() const;
/// \brief The number of processes to which we will send data.
///
/// The count does <i>not</i> include the calling process.
size_t getNumSends() const;
//! Whether the calling process will send or receive messages to itself.
bool hasSelfMessage() const;
//! Maximum number of values this process will send to another single process.
size_t getMaxSendLength() const;
//! Total number of values this process will receive from other processes.
size_t getTotalReceiveLength() const;
/// \brief Ranks of the processes sending values to this process.
///
/// This is a nonpersisting view. It will last only as long as
/// this Distributor instance does.
Teuchos::ArrayView<const int> getProcsFrom() const;
/// \brief Ranks of the processes to which this process will send values.
///
/// This is a nonpersisting view. It will last only as long as
/// this Distributor instance does.
Teuchos::ArrayView<const int> getProcsTo() const;
/// \brief Number of values this process will receive from each process.
///
/// This process will receive <tt>getLengthsFrom[i]</tt> values
/// from process <tt>getProcsFrom[i]</tt>.
///
/// This is a nonpersisting view. It will last only as long as
/// this Distributor instance does.
Teuchos::ArrayView<const size_t> getLengthsFrom() const;
/// \brief Number of values this process will send to each process.
///
/// This process will send <tt>getLengthsTo[i]</tt> values to
/// process <tt>getProcsTo[i]</tt>.
///
/// This is a nonpersisting view. It will last only as long as
/// this Distributor instance does.
Teuchos::ArrayView<const size_t> getLengthsTo() const;
/// \brief Return an enum indicating whether and how a Distributor was initialized.
///
/// This is an implementation detail of Tpetra. Please do not
/// call this method or rely on it existing in your code.
Details::EDistributorHowInitialized howInitialized () const {
return howInitialized_;
}
//@}
//! @name Reverse communication methods
//@{
/// \brief A reverse communication plan Distributor.
///
/// The first time this method is called, it creates a Distributor
/// with the reverse communication plan of <tt>*this</tt>. On
/// subsequent calls, it returns the cached reverse Distributor.
///
/// Most users do not need to call this method. If you invoke
/// doReversePosts() or doReversePostsAndWaits(), the reverse
/// Distributor will be created automatically if it does not yet
/// exist.
Teuchos::RCP<Distributor> getReverse() const;
//@}
//! @name Methods for executing a communication plan
//@{
/// \brief Execute the (forward) communication plan.
///
/// Call this version of the method when you have the same number
/// of Packets for each LID (local ID) to send or receive.
///
/// \tparam Packet The type of data to send and receive.
///
/// \param exports [in] Contains the values to be sent by this
/// process. On exit from this method, it's OK to modify the
/// entries of this buffer.
///
/// \param numPackets [in] The number of Packets per export /
/// import. This version of the routine assumes that each LID
/// has the same number of Packets associated with it. (\c
/// MultiVector is an example of a DistObject subclass
/// satisfying this property.)
///
/// \param imports [out] On entry, buffer must be large enough to
/// accomodate the data exported (sent) to us. On exit,
/// contains the values exported to us.
template <class Packet>
void
doPostsAndWaits (const Teuchos::ArrayView<const Packet> &exports,
size_t numPackets,
const Teuchos::ArrayView<Packet> &imports);
/// \brief Execute the (forward) communication plan.
///
/// Call this version of the method when you have possibly
/// different numbers of Packets for each LID (local ID) to send
/// or receive.
///
/// \tparam Packet The type of data to send and receive.
///
/// \param exports [in] Contains the values to be sent by this
/// process. On exit from this method, it's OK to modify the
/// entries of this buffer.
///
/// \param numExportPacketsPerLID [in] The number of packets for
/// each export LID (i.e., each LID to be sent).
///
/// \param imports [out] On entry, buffer must be large enough to
/// accomodate the data exported (sent) to us. On exit,
/// contains the values exported to us.
///
/// \param numImportPacketsPerLID [in] The number of packets for
/// each import LID (i.e., each LID to be received).
template <class Packet>
void
doPostsAndWaits (const Teuchos::ArrayView<const Packet> &exports,
const Teuchos::ArrayView<const size_t>& numExportPacketsPerLID,
const Teuchos::ArrayView<Packet> &imports,
const Teuchos::ArrayView<const size_t>& numImportPacketsPerLID);
/// \brief Post the data for a forward plan, but do not execute the waits yet.
///
/// Call this overload when you have the same number of Packets
/// for each LID to send or receive.
///
/// \tparam Packet The type of data to send and receive.
///
/// \param exports [in] Contains the values to be sent by this
/// process. This is an ArrayRCP and not an ArrayView so that
/// we have the freedom to use nonblocking sends if we wish. Do
/// not modify the data in this array until \c doWaits() has
/// completed.
///
/// \param numPackets [in] The number of Packets per export /
/// import. (Same as the three-argument version of
/// doPostsAndWaits().)
///
/// \param imports [out] On entry, buffer must be large enough to
/// accomodate the data exported (sent) to us. This is an
/// ArrayRCP and not an ArrayView so that we have the freedom to
/// use nonblocking sends if we wish. Do not modify the data in
/// this array until \c doWaits() has completed. Upon
/// completion of \c doWaits(), this buffer contains the values
/// exported to us.
template <class Packet>
void
doPosts (const Teuchos::ArrayRCP<const Packet> &exports,
size_t numPackets,
const Teuchos::ArrayRCP<Packet> &imports);
/// \brief Post the data for a forward plan, but do not execute the waits yet.
///
/// Call this overload when you have possibly different numbers of
/// Packets for each LID to send or receive.
///
/// \tparam Packet The type of data to send and receive.
///
/// \param exports [in] Same as in the three-argument version of
/// doPosts().
///
/// \param numExportPacketsPerLID [in] Same as in the
/// four-argument version of doPostsAndWaits().
///
/// \param imports [out] Same as in the three-argument version of
/// doPosts().
///
/// \param numImportPacketsPerLID [in] Same as in the
/// four-argument version of doPostsAndWaits().
template <class Packet>
void
doPosts (const Teuchos::ArrayRCP<const Packet> &exports,
const Teuchos::ArrayView<const size_t>& numExportPacketsPerLID,
const Teuchos::ArrayRCP<Packet> &imports,
const Teuchos::ArrayView<const size_t>& numImportPacketsPerLID);
/// Wait on any outstanding nonblocking message requests to complete.
///
/// This method is for forward mode communication only, that is,
/// after calling doPosts(). For reverse mode communication
/// (after calling doReversePosts()), call doReverseWaits()
/// instead.
void doWaits ();
/// \brief Execute the reverse communication plan.
///
/// This method takes the same arguments as the three-argument
/// version of doPostsAndWaits().
template <class Packet>
void
doReversePostsAndWaits (const Teuchos::ArrayView<const Packet> &exports,
size_t numPackets,
const Teuchos::ArrayView<Packet> &imports);
/// \brief Execute the reverse communication plan.
///
/// This method takes the same arguments as the four-argument
/// version of doPostsAndWaits().
template <class Packet>
void
doReversePostsAndWaits (const Teuchos::ArrayView<const Packet> &exports,
const Teuchos::ArrayView<const size_t>& numExportPacketsPerLID,
const Teuchos::ArrayView<Packet> &imports,
const Teuchos::ArrayView<const size_t>& numImportPacketsPerLID);
/// \brief Post the data for a reverse plan, but do not execute the waits yet.
///
/// This method takes the same arguments as the three-argument
/// version of doPosts().
template <class Packet>
void
doReversePosts (const Teuchos::ArrayRCP<const Packet> &exports,
size_t numPackets,
const Teuchos::ArrayRCP<Packet> &imports);
/// \brief Post the data for a reverse plan, but do not execute the waits yet.
///
/// This method takes the same arguments as the four-argument
/// version of doPosts().
template <class Packet>
void
doReversePosts (const Teuchos::ArrayRCP<const Packet> &exports,
const Teuchos::ArrayView<const size_t>& numExportPacketsPerLID,
const Teuchos::ArrayRCP<Packet> &imports,
const Teuchos::ArrayView<const size_t>& numImportPacketsPerLID);
/// Wait on any outstanding nonblocking message requests to complete.
///
/// This method is for reverse mode communication only, that is,
/// after calling doReversePosts(). For forward mode
/// communication (after calling doPosts()), call doWaits()
/// instead.
void doReverseWaits ();
/// \brief Execute the (forward) communication plan.
///
/// Call this version of the method when you have the same number
/// of Packets for each LID (local ID) to send or receive.
///
/// \tparam Packet The type of data to send and receive.
///
/// \param exports [in] Contains the values to be sent by this
/// process. On exit from this method, it's OK to modify the
/// entries of this buffer.
///
/// \param numPackets [in] The number of Packets per export /
/// import. This version of the routine assumes that each LID
/// has the same number of Packets associated with it. (\c
/// MultiVector is an example of a DistObject subclass
/// satisfying this property.)
///
/// \param imports [out] On entry, buffer must be large enough to
/// accomodate the data exported (sent) to us. On exit,
/// contains the values exported to us.
template <class ExpView, class ImpView>
typename std::enable_if<(Kokkos::Impl::is_view<ExpView>::value && Kokkos::Impl::is_view<ImpView>::value)>::type
doPostsAndWaits (
const ExpView &exports,
size_t numPackets,
const ImpView &imports);
/// \brief Execute the (forward) communication plan.
///
/// Call this version of the method when you have possibly
/// different numbers of Packets for each LID (local ID) to send
/// or receive.
///
/// \tparam Packet The type of data to send and receive.
///
/// \param exports [in] Contains the values to be sent by this
/// process. On exit from this method, it's OK to modify the
/// entries of this buffer.
///
/// \param numExportPacketsPerLID [in] The number of packets for
/// each export LID (i.e., each LID to be sent).
///
/// \param imports [out] On entry, buffer must be large enough to
/// accomodate the data exported (sent) to us. On exit,
/// contains the values exported to us.
///
/// \param numImportPacketsPerLID [in] The number of packets for
/// each import LID (i.e., each LID to be received).
template <class ExpView, class ImpView>
typename std::enable_if<(Kokkos::Impl::is_view<ExpView>::value && Kokkos::Impl::is_view<ImpView>::value)>::type
doPostsAndWaits (const ExpView &exports,
const Teuchos::ArrayView<const size_t>& numExportPacketsPerLID,
const ImpView &imports,
const Teuchos::ArrayView<const size_t>& numImportPacketsPerLID);
/// \brief Post the data for a forward plan, but do not execute the waits yet.
///
/// Call this overload when you have the same number of Packets
/// for each LID to send or receive.
///
/// \tparam Packet The type of data to send and receive.
///
/// \param exports [in] Contains the values to be sent by this
/// process. This is an ArrayRCP and not an ArrayView so that
/// we have the freedom to use nonblocking sends if we wish. Do
/// not modify the data in this array until \c doWaits() has
/// completed.
///
/// \param numPackets [in] The number of Packets per export /
/// import. (Same as the three-argument version of
/// doPostsAndWaits().)
///
/// \param imports [out] On entry, buffer must be large enough to
/// accomodate the data exported (sent) to us. This is an
/// ArrayRCP and not an ArrayView so that we have the freedom to
/// use nonblocking sends if we wish. Do not modify the data in
/// this array until \c doWaits() has completed. Upon
/// completion of \c doWaits(), this buffer contains the values
/// exported to us.
template <class ExpView, class ImpView>
typename std::enable_if<(Kokkos::Impl::is_view<ExpView>::value && Kokkos::Impl::is_view<ImpView>::value)>::type
doPosts (const ExpView &exports,
size_t numPackets,
const ImpView &imports);
/// \brief Post the data for a forward plan, but do not execute the waits yet.
///
/// Call this overload when you have possibly different numbers of
/// Packets for each LID to send or receive.
///
/// \tparam Packet The type of data to send and receive.
///
/// \param exports [in] Same as in the three-argument version of
/// doPosts().
///
/// \param numExportPacketsPerLID [in] Same as in the
/// four-argument version of doPostsAndWaits().
///
/// \param imports [out] Same as in the three-argument version of
/// doPosts().
///
/// \param numImportPacketsPerLID [in] Same as in the
/// four-argument version of doPostsAndWaits().
template <class ExpView, class ImpView>
typename std::enable_if<(Kokkos::Impl::is_view<ExpView>::value && Kokkos::Impl::is_view<ImpView>::value)>::type
doPosts (const ExpView &exports,
const Teuchos::ArrayView<const size_t>& numExportPacketsPerLID,
const ImpView &imports,
const Teuchos::ArrayView<const size_t>& numImportPacketsPerLID);
/// \brief Execute the reverse communication plan.
///
/// This method takes the same arguments as the three-argument
/// version of doPostsAndWaits().
template <class ExpView, class ImpView>
typename std::enable_if<(Kokkos::Impl::is_view<ExpView>::value && Kokkos::Impl::is_view<ImpView>::value)>::type
doReversePostsAndWaits (const ExpView &exports,
size_t numPackets,
const ImpView &imports);
/// \brief Execute the reverse communication plan.
///
/// This method takes the same arguments as the four-argument
/// version of doPostsAndWaits().
template <class ExpView, class ImpView>
typename std::enable_if<(Kokkos::Impl::is_view<ExpView>::value && Kokkos::Impl::is_view<ImpView>::value)>::type
doReversePostsAndWaits (const ExpView &exports,
const Teuchos::ArrayView<const size_t>& numExportPacketsPerLID,
const ImpView &imports,
const Teuchos::ArrayView<const size_t>& numImportPacketsPerLID);
/// \brief Post the data for a reverse plan, but do not execute the waits yet.
///
/// This method takes the same arguments as the three-argument
/// version of doPosts().
template <class ExpView, class ImpView>
typename std::enable_if<(Kokkos::Impl::is_view<ExpView>::value && Kokkos::Impl::is_view<ImpView>::value)>::type
doReversePosts (const ExpView &exports,
size_t numPackets,
const ImpView &imports);
/// \brief Post the data for a reverse plan, but do not execute the waits yet.
///
/// This method takes the same arguments as the four-argument
/// version of doPosts().
template <class ExpView, class ImpView>
typename std::enable_if<(Kokkos::Impl::is_view<ExpView>::value && Kokkos::Impl::is_view<ImpView>::value)>::type
doReversePosts (const ExpView &exports,
const Teuchos::ArrayView<const size_t>& numExportPacketsPerLID,
const ImpView &imports,
const Teuchos::ArrayView<const size_t>& numImportPacketsPerLID);
/// \brief Information on the last call to do/doReverse
///
/// Returns the amount of data sent & recv'd on this processor in bytes
void getLastDoStatistics(size_t & bytes_sent, size_t & bytes_recvd) const{
bytes_sent = lastRoundBytesSend_;
bytes_recvd = lastRoundBytesRecv_;
}
//@}
//! @name Implementation of Teuchos::Describable
//@{
//! Return a one-line description of this object.
std::string description() const;
/// \brief Describe this object in a human-readable way to the
/// given output stream.
///
/// You must call this method as a collective over all processes
/// in this object's communicator.
///
/// \param out [out] Output stream to which to write. Only
/// Process 0 in this object's communicator may write to the
/// output stream.
///
/// \param verbLevel [in] Verbosity level. This also controls
/// whether this method does any communication. At verbosity
/// levels higher (greater) than Teuchos::VERB_LOW, this method
/// behaves as a collective over the object's communicator.
///
/// Teuchos::FancyOStream wraps std::ostream. It adds features
/// like tab levels. If you just want to wrap std::cout, try
/// this:
/// \code
/// auto out = Teuchos::getFancyOStream (Teuchos::rcpFromRef (std::out));
/// \endcode
void
describe (Teuchos::FancyOStream& out,
const Teuchos::EVerbosityLevel verbLevel =
Teuchos::Describable::verbLevel_default) const;
//@}
private:
//! The communicator over which to perform distributions.
Teuchos::RCP<const Teuchos::Comm<int> > comm_;
//! Output stream for debug output.
Teuchos::RCP<Teuchos::FancyOStream> out_;
//! How the Distributor was initialized (if it was).
Details::EDistributorHowInitialized howInitialized_;
//! @name Parameters read in from the Teuchos::ParameterList
//@{
//! The variant of send to use in do[Reverse]Posts().
Details::EDistributorSendType sendType_;
//! Whether to do a barrier between receives and sends in do[Reverse]Posts().
bool barrierBetween_;
//! Whether to print copious debug output to stderr on all processes.
bool debug_;
//@}
/// \brief Whether I am supposed to send a message to myself.
///
/// This is set in createFromSends or createReverseDistributor.
bool selfMessage_;
/// \brief The number of sends from this process to other process.
///
/// This is always less than or equal to the number of processes.
/// It does <i>not</i> count self receives (that is, messages from
/// the calling process to itself).
///
/// This value is computed by the createFromSends() method. That
/// method first includes self receives in the count, but at the
/// end subtracts one if selfMessage_ is true.
size_t numSends_;
/// \brief List of process IDs to which to send.
///
/// This array has length numSends_ + selfMessage_ (that is, it
/// includes the self message, if there is one).
Teuchos::Array<int> procsTo_;
/// \brief Starting index of the block of Packets to send to each process.
///
/// Given an export buffer that contains all of the data being
/// sent by this process, the block of Packets to send to process
/// p will start at position startsTo_[p].
///
/// This array has length numSends_ + selfMessage_ (that is, it
/// includes the self message, if there is one).
Teuchos::Array<size_t> startsTo_;
/// \brief Length (in number of Packets) of my process' send to each process.
///
/// lengthsTo_[p] is the length of my process' send to process p.
/// This array has length numSends_ + selfMessage_ (that is, it
/// includes the self message, if there is one).
Teuchos::Array<size_t> lengthsTo_;
/// \brief The maximum send length (in number of Packets) to another process.
///
/// maxSendLength_ = max(lengthsTo_[p]) for p != my process rank.
size_t maxSendLength_;
/// \brief Offset (by message, not by number of Packets) into exports array.
///
/// This array is used by both versions of doPosts(). In that
/// method, <tt>indicesTo_[j]*numPackets</tt> is the offset into
/// the <tt>exports</tt> array, where <tt>j = startsTo_[p]</tt>
/// and p is an index iterating through the sends in reverse order
/// (starting with the process rank right before the self message,
/// if there is a self message, else the largest process rank to
/// which this process sends).
///
/// This array is only used if export data are not blocked (laid
/// out) by process rank, that is, if we need to use a send
/// buffer. Otherwise, this array has no entries. (In fact,
/// Distributor currently uses this in both overloads of doPosts()
/// to test whether data are laid out by process.)
Teuchos::Array<size_t> indicesTo_;
/// \brief The number of messages received by my process from other processes.
///
/// This does <i>not</i> count self receives. If selfMessage_ is
/// true, the actual number of receives is one more (we assume
/// that we only receive zero or one messages from ourself).
///
/// This value is computed by the \c computeReceives() method.
/// That method first includes self receives in the count, but at
/// the end subtracts one if selfMessage_ is true.
size_t numReceives_;
/// \brief sum(lengthsFrom_)
///
/// This is computed by \c createFromSends() and is used to
/// allocate the receive buffer. The reverse communicator's total
/// receive length is the total send length of the forward
/// communicator.
size_t totalReceiveLength_;
/// \brief Array of lengths of incoming messages.
///
/// This array has length numReceives_ + selfMessage_. Incoming
/// message i from process procsFrom_[i] has length
/// lengthsFrom_[i].
Teuchos::Array<size_t> lengthsFrom_;
/// \brief Array of ranks of the process from which the calling
/// process will receive a message.
///
/// This array has length numReceives_ + selfMessage_. Incoming
/// message i was sent by process procsFrom_[i].
Teuchos::Array<int> procsFrom_;
/// \brief Array of offsets of incoming messages.
///
/// This array has length numReceives_ + selfMessage_. It is an
/// exclusive prefix sum of lengthsFrom_. It is only used for
/// constructing the reverse Distributor.
Teuchos::Array<size_t> startsFrom_;
/// \brief List that becomes the reverse communicator's indicesTo_.
///
/// Array of length totalReceiveLength_. Allocated and filled in
/// computeReceives() as [0, 1, ..., totalReceiveLength_-1]. When
/// creating the reverse Distributor, this is assigned to the
/// reverse Distributor's indicesTo_.
Teuchos::Array<size_t> indicesFrom_;
/// \brief Communication requests associated with nonblocking receives and sends.
///
/// \note To implementers: Distributor uses requests_.size() as
/// the number of outstanding nonblocking receives and sends.
/// This means you should always resize to zero after completing
/// receive and send requests.
Teuchos::Array<Teuchos::RCP<Teuchos::CommRequest<int> > > requests_;
/// \brief The reverse distributor.
///
/// This is created on demand in getReverse() and cached for
/// later reuse. This is why it is declared "mutable".
mutable Teuchos::RCP<Distributor> reverseDistributor_;
/// \brief The number of bytes sent by this proc in the last call to do/doReverse
size_t lastRoundBytesSend_;
/// \brief The number of bytes received by this proc in the last call to do/doReverse
size_t lastRoundBytesRecv_;
#ifdef TPETRA_DISTRIBUTOR_TIMERS
Teuchos::RCP<Teuchos::Time> timer_doPosts3_;
Teuchos::RCP<Teuchos::Time> timer_doPosts4_;
Teuchos::RCP<Teuchos::Time> timer_doWaits_;
Teuchos::RCP<Teuchos::Time> timer_doPosts3_recvs_;
Teuchos::RCP<Teuchos::Time> timer_doPosts4_recvs_;
Teuchos::RCP<Teuchos::Time> timer_doPosts3_barrier_;
Teuchos::RCP<Teuchos::Time> timer_doPosts4_barrier_;
Teuchos::RCP<Teuchos::Time> timer_doPosts3_sends_;
Teuchos::RCP<Teuchos::Time> timer_doPosts4_sends_;
//! Make the instance's timers. (Call only in constructor.)
void makeTimers ();
#endif // TPETRA_DISTRIBUTOR_TIMERS
/// \brief Whether to use different tags for different code paths.
///
/// There are currently three code paths in Distributor that post
/// receives and sends:
///
/// 1. Three-argument variant of doPosts()
/// 2. Four-argument variant of doPosts()
/// 3. computeReceives()
///
/// If this option is true, Distributor will use a distinct
/// message tag for each of these paths.
bool useDistinctTags_;
//! Get the tag to use for receives and sends.
///
/// See useDistinctTags_. This is called in doPosts() (both
/// variants) and computeReceives().
int getTag (const int pathTag) const;
/// \brief Initialize using the specified communicator and ParameterList.
///
/// This method is only meant to be called by the constructor.
///
/// \param comm [in] Communicator used by the Distributor. MUST
/// be nonnull.
/// \param out [in/out] Output stream (for debugging output). If
/// null, the default is \c std::cerr.
/// \param plist [in/out] List of parameters controlling how the
/// Distributor performs communication, and specifying debug
/// options. If null, all parameters take their default values.
/// Please see the class documentation for a list of all
/// accepted parameters and their default values.
///
/// This method doesn't actually set up the distribution pattern.
/// You need to call one of the "gather / scatter 'constructors'"
/// to do that.
void
init (const Teuchos::RCP<const Teuchos::Comm<int> >& comm,
const Teuchos::RCP<Teuchos::FancyOStream>& out,
const Teuchos::RCP<Teuchos::ParameterList>& plist);
/// \brief Compute receive info from sends.
///
/// This method computes numReceives_, lengthsFrom_, procsFrom_,
/// totalReceiveLength_, indicesFrom_, and startsFrom_.
///
/// \note This method currently ignores the sendType_ and
/// barrierBetween_ parameters, and always uses ireceive() /
/// send() for communication of the process IDs from which our
/// process is receiving and their corresponding receive packet
/// counts.
void computeReceives ();
/// \brief Compute send (GID,PID) pairs from receive (GID,PID) pairs.
///
/// GID means "global ID" and PID means "process ID" (rank, in MPI
/// terms).
///
/// \param importGIDs [in] GIDs to receive by my process.
/// \param importProcIDs [in] Process IDs from which to receive by
/// my process.
/// \param exportGIDs [out] GIDs to send by my process. Resized if
/// necessary.
/// \param exportProcIDs [out] Process IDs to which to send by my
/// process. Resized if necessary.
template <class Ordinal>
void computeSends (const Teuchos::ArrayView<const Ordinal> &remoteGIDs,
const Teuchos::ArrayView<const int> &remoteProcIDs,
Teuchos::Array<Ordinal> &exportGIDs,
Teuchos::Array<int> &exportProcIDs);
//! Create a distributor for the reverse communication pattern.
void createReverseDistributor() const;
/// \brief Print the calling process' verbose describe()
/// information to the given output string.
///
/// This is an implementation detail of describe().
std::string
localDescribeToString (const Teuchos::EVerbosityLevel vl) const;
}; // class Distributor
template <class Packet>
void Distributor::
doPostsAndWaits (const Teuchos::ArrayView<const Packet>& exports,
size_t numPackets,
const Teuchos::ArrayView<Packet>& imports)
{
using Teuchos::arcp;
using Teuchos::ArrayRCP;
typedef typename ArrayRCP<const Packet>::size_type size_type;
TEUCHOS_TEST_FOR_EXCEPTION(
requests_.size () != 0, std::runtime_error, "Tpetra::Distributor::"
"doPostsAndWaits(3 args): There are " << requests_.size () <<
" outstanding nonblocking messages pending. It is incorrect to call "
"this method with posts outstanding.");
// doPosts() accepts the exports and imports arrays as ArrayRCPs,
// requiring that the memory location is persisting (as is
// necessary for nonblocking receives). However, it need only
// persist until doWaits() completes, so it is safe for us to use
// a nonpersisting reference in this case. The use of a
// nonpersisting reference is purely a performance optimization.
//const Packet* exportsPtr = exports.getRawPtr();
//ArrayRCP<const Packet> exportsArcp (exportsPtr, static_cast<size_type> (0),
// exports.size(), false);
ArrayRCP<const Packet> exportsArcp (exports.getRawPtr (),
static_cast<size_type> (0),
exports.size(), false);
// For some reason, neither of the options below (that use arcp)
// compile for Packet=std::complex<double> with GCC 4.5.1. The
// issue only arises with the exports array. This is why we
// construct a separate nonowning ArrayRCP.
// doPosts (arcp<const Packet> (exports.getRawPtr(), 0, exports.size(), false),
// numPackets,
// arcp<Packet> (imports.getRawPtr(), 0, imports.size(), false));
// doPosts (arcp<const Packet> (exportsPtr, 0, exports.size(), false),
// numPackets,
// arcp<Packet> (imports.getRawPtr(), 0, imports.size(), false));
doPosts (exportsArcp,
numPackets,
arcp<Packet> (imports.getRawPtr (), 0, imports.size (), false));
doWaits ();
lastRoundBytesSend_ = exports.size () * sizeof (Packet);
lastRoundBytesRecv_ = imports.size () * sizeof (Packet);
}
template <class Packet>
void Distributor::
doPostsAndWaits (const Teuchos::ArrayView<const Packet>& exports,
const Teuchos::ArrayView<const size_t>& numExportPacketsPerLID,
const Teuchos::ArrayView<Packet> &imports,
const Teuchos::ArrayView<const size_t>& numImportPacketsPerLID)
{
using Teuchos::arcp;
using Teuchos::ArrayRCP;
TEUCHOS_TEST_FOR_EXCEPTION(
requests_.size () != 0, std::runtime_error, "Tpetra::Distributor::"
"doPostsAndWaits: There are " << requests_.size () << " outstanding "
"nonblocking messages pending. It is incorrect to call doPostsAndWaits "
"with posts outstanding.");
// doPosts() accepts the exports and imports arrays as ArrayRCPs,
// requiring that the memory location is persisting (as is
// necessary for nonblocking receives). However, it need only
// persist until doWaits() completes, so it is safe for us to use
// a nonpersisting reference in this case.
// mfh 04 Apr 2012: For some reason, calling arcp<const Packet>
// for Packet=std::complex<T> (e.g., T=float) fails to compile
// with some versions of GCC. The issue only arises with the
// exports array. This is why we construct a separate nonowning
// ArrayRCP.
typedef typename ArrayRCP<const Packet>::size_type size_type;
ArrayRCP<const Packet> exportsArcp (exports.getRawPtr (),
static_cast<size_type> (0),
exports.size (), false);
// mfh 04 Apr 2012: This is the offending code. This statement
// would normally be in place of "exportsArcp" in the
// doPosts() call below.
//arcp<const Packet> (exports.getRawPtr(), 0, exports.size(), false),
doPosts (exportsArcp,
numExportPacketsPerLID,
arcp<Packet> (imports.getRawPtr (), 0, imports.size (), false),
numImportPacketsPerLID);
doWaits ();
lastRoundBytesSend_ = exports.size () * sizeof (Packet);
lastRoundBytesRecv_ = imports.size () * sizeof (Packet);
}
template <class Packet>
void Distributor::
doPosts (const Teuchos::ArrayRCP<const Packet>& exports,
size_t numPackets,
const Teuchos::ArrayRCP<Packet>& imports)
{
using Teuchos::Array;
using Teuchos::ArrayRCP;
using Teuchos::ArrayView;
using Teuchos::as;
using Teuchos::FancyOStream;
using Teuchos::includesVerbLevel;
using Teuchos::ireceive;
using Teuchos::isend;
using Teuchos::OSTab;
using Teuchos::readySend;
using Teuchos::send;
using Teuchos::ssend;
using Teuchos::TypeNameTraits;
using Teuchos::typeName;
using std::endl;
typedef Array<size_t>::size_type size_type;
#ifdef TPETRA_DISTRIBUTOR_TIMERS
Teuchos::TimeMonitor timeMon (*timer_doPosts3_);
#endif // TPETRA_DISTRIBUTOR_TIMERS
const int myRank = comm_->getRank ();
// Run-time configurable parameters that come from the input
// ParameterList set by setParameterList().
const Details::EDistributorSendType sendType = sendType_;
const bool doBarrier = barrierBetween_;
Teuchos::OSTab tab0 (out_);
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": Distributor::doPosts(3 args, Teuchos::ArrayRCP)" << endl;
*out_ << os.str ();
}
Teuchos::OSTab tab1 (out_);
TEUCHOS_TEST_FOR_EXCEPTION(
sendType == Details::DISTRIBUTOR_RSEND && ! doBarrier, std::logic_error,
"Tpetra::Distributor::doPosts(3 args): Ready-send version requires a "
"barrier between posting receives and posting ready sends. This should "
"have been checked before. "
"Please report this bug to the Tpetra developers.");
size_t selfReceiveOffset = 0;
// mfh 30 Mar 2016: See Github Issue #227 to see why we need to
// check whether we're doing reverse mode before checking the
// length of the imports array.
if (howInitialized_ != Details::DISTRIBUTOR_INITIALIZED_BY_REVERSE) {
// Each message has the same number of packets.
//
// FIXME (mfh 18 Jul 2014): Relaxing this test from strict
// inequality to a less-than seems to have fixed Bug 6170. It's
// OK for the 'imports' array to be longer than it needs to be;
// I'm just curious why it would be.
const size_t totalNumImportPackets = totalReceiveLength_ * numPackets;
TEUCHOS_TEST_FOR_EXCEPTION
(static_cast<size_t> (imports.size ()) < totalNumImportPackets,
std::invalid_argument, "Tpetra::Distributor::doPosts(3 args): The "
"'imports' array must have enough entries to hold the expected number "
"of import packets. imports.size() = " << imports.size () << " < "
"totalNumImportPackets = " << totalNumImportPackets << ".");
}
// MPI tag for nonblocking receives and blocking sends in this
// method. Some processes might take the "fast" path
// (indicesTo_.empty()) and others might take the "slow" path for
// the same doPosts() call, so the path tag must be the same for
// both.
const int pathTag = 0;
const int tag = this->getTag (pathTag);
#ifdef HAVE_TPETRA_DEBUG
TEUCHOS_TEST_FOR_EXCEPTION
(requests_.size () != 0, std::logic_error, "Tpetra::Distributor::"
"doPosts(3 args, Kokkos): Process " << myRank << ": requests_.size() = "
<< requests_.size () << " != 0.");
#endif // HAVE_TPETRA_DEBUG
// Distributor uses requests_.size() as the number of outstanding
// nonblocking message requests, so we resize to zero to maintain
// this invariant.
//
// numReceives_ does _not_ include the self message, if there is
// one. Here, we do actually send a message to ourselves, so we
// include any self message in the "actual" number of receives to
// post.
//
// NOTE (mfh 19 Mar 2012): Epetra_MpiDistributor::DoPosts()
// doesn't (re)allocate its array of requests. That happens in
// CreateFromSends(), ComputeRecvs_(), DoReversePosts() (on
// demand), or Resize_().
const size_type actualNumReceives = as<size_type> (numReceives_) +
as<size_type> (selfMessage_ ? 1 : 0);
requests_.resize (0);
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts(3,"
<< (indicesTo_.empty () ? "fast" : "slow") << "): Post receives"
<< endl;
*out_ << os.str ();
}
// Post the nonblocking receives. It's common MPI wisdom to post
// receives before sends. In MPI terms, this means favoring
// adding to the "posted queue" (of receive requests) over adding
// to the "unexpected queue" (of arrived messages not yet matched
// with a receive).
{
#ifdef TPETRA_DISTRIBUTOR_TIMERS
Teuchos::TimeMonitor timeMonRecvs (*timer_doPosts3_recvs_);
#endif // TPETRA_DISTRIBUTOR_TIMERS
size_t curBufOffset = 0;
for (size_type i = 0; i < actualNumReceives; ++i) {
const size_t curBufLen = lengthsFrom_[i] * numPackets;
if (procsFrom_[i] != myRank) {
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts(3,"
<< (indicesTo_.empty () ? "fast" : "slow") << "): "
<< "Post irecv: {source: " << procsFrom_[i]
<< ", tag: " << tag << "}" << endl;
*out_ << os.str ();
}
// If my process is receiving these packet(s) from another
// process (not a self-receive):
//
// 1. Set up the persisting view (recvBuf) of the imports
// array, given the offset and size (total number of
// packets from process procsFrom_[i]).
// 2. Start the Irecv and save the resulting request.
TEUCHOS_TEST_FOR_EXCEPTION(
curBufOffset + curBufLen > static_cast<size_t> (imports.size ()),
std::logic_error, "Tpetra::Distributor::doPosts(3 args, Teuchos): "
"Exceeded size of 'imports' array in packing loop on Process " <<
myRank << ". imports.size() = " << imports.size () << " < "
"curBufOffset(" << curBufOffset << ") + curBufLen(" << curBufLen
<< ").");
ArrayRCP<Packet> recvBuf =
imports.persistingView (curBufOffset, curBufLen);
requests_.push_back (ireceive<int, Packet> (recvBuf, procsFrom_[i],
tag, *comm_));
}
else { // Receiving from myself
selfReceiveOffset = curBufOffset; // Remember the self-recv offset
}
curBufOffset += curBufLen;
}
}
if (doBarrier) {
#ifdef TPETRA_DISTRIBUTOR_TIMERS
Teuchos::TimeMonitor timeMonBarrier (*timer_doPosts3_barrier_);
#endif // TPETRA_DISTRIBUTOR_TIMERS
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts(3,"
<< (indicesTo_.empty () ? "fast" : "slow") << "): Barrier" << endl;
*out_ << os.str ();
}
// If we are using ready sends (MPI_Rsend) below, we need to do
// a barrier before we post the ready sends. This is because a
// ready send requires that its matching receive has already
// been posted before the send has been posted. The only way to
// guarantee that in this case is to use a barrier.
comm_->barrier ();
}
#ifdef TPETRA_DISTRIBUTOR_TIMERS
Teuchos::TimeMonitor timeMonSends (*timer_doPosts3_sends_);
#endif // TPETRA_DISTRIBUTOR_TIMERS
// setup scan through procsTo_ list starting with higher numbered procs
// (should help balance message traffic)
//
// FIXME (mfh 20 Feb 2013) Why haven't we precomputed this?
// It doesn't depend on the input at all.
size_t numBlocks = numSends_ + selfMessage_;
size_t procIndex = 0;
while ((procIndex < numBlocks) && (procsTo_[procIndex] < myRank)) {
++procIndex;
}
if (procIndex == numBlocks) {
procIndex = 0;
}
size_t selfNum = 0;
size_t selfIndex = 0;
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts(3,"
<< (indicesTo_.empty () ? "fast" : "slow") << "): Post sends" << endl;
*out_ << os.str ();
}
if (indicesTo_.empty()) {
if (debug_) {
std::ostringstream os;
os << myRank << ": doPosts(3,fast): posting sends" << endl;
*out_ << os.str ();
}
// Data are already blocked (laid out) by process, so we don't
// need a separate send buffer (besides the exports array).
for (size_t i = 0; i < numBlocks; ++i) {
size_t p = i + procIndex;
if (p > (numBlocks - 1)) {
p -= numBlocks;
}
if (procsTo_[p] != myRank) {
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts(3,fast): Post send: "
"{target: " << procsTo_[p] << ", tag: " << tag << "}" << endl;
*out_ << os.str ();
}
ArrayView<const Packet> tmpSend =
exports.view (startsTo_[p]*numPackets, lengthsTo_[p]*numPackets);
if (sendType == Details::DISTRIBUTOR_SEND) {
send<int, Packet> (tmpSend.getRawPtr (),
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
else if (sendType == Details::DISTRIBUTOR_ISEND) {
ArrayRCP<const Packet> tmpSendBuf =
exports.persistingView (startsTo_[p] * numPackets,
lengthsTo_[p] * numPackets);
requests_.push_back (isend<int, Packet> (tmpSendBuf, procsTo_[p],
tag, *comm_));
}
else if (sendType == Details::DISTRIBUTOR_RSEND) {
readySend<int, Packet> (tmpSend.getRawPtr (),
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
else if (sendType == Details::DISTRIBUTOR_SSEND) {
ssend<int, Packet> (tmpSend.getRawPtr (),
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
} else {
TEUCHOS_TEST_FOR_EXCEPTION(
true, std::logic_error, "Tpetra::Distributor::doPosts(3 args): "
"Invalid send type. We should never get here. "
"Please report this bug to the Tpetra developers.");
}
}
else { // "Sending" the message to myself
selfNum = p;
}
}
if (selfMessage_) {
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts(3,fast): Self-send" << endl;
*out_ << os.str ();
}
// This is how we "send a message to ourself": we copy from
// the export buffer to the import buffer. That saves
// Teuchos::Comm implementations other than MpiComm (in
// particular, SerialComm) the trouble of implementing self
// messages correctly. (To do this right, SerialComm would
// need internal buffer space for messages, keyed on the
// message's tag.)
std::copy (exports.begin()+startsTo_[selfNum]*numPackets,
exports.begin()+startsTo_[selfNum]*numPackets+lengthsTo_[selfNum]*numPackets,
imports.begin()+selfReceiveOffset);
}
if (debug_) {
std::ostringstream os;
os << myRank << ": doPosts(3,fast) done" << endl;
*out_ << os.str ();
}
}
else { // data are not blocked by proc, use send buffer
if (debug_) {
std::ostringstream os;
os << myRank << ": doPosts(3,slow): posting sends" << endl;
*out_ << os.str ();
}
// FIXME (mfh 05 Mar 2013) This is broken for Isend (nonblocking
// sends), because the buffer is only long enough for one send.
ArrayRCP<Packet> sendArray (maxSendLength_ * numPackets); // send buffer
TEUCHOS_TEST_FOR_EXCEPTION(
sendType == Details::DISTRIBUTOR_ISEND, std::logic_error,
"Tpetra::Distributor::doPosts(3 args): The \"send buffer\" code path "
<< "doesn't currently work with nonblocking sends.");
for (size_t i = 0; i < numBlocks; ++i) {
size_t p = i + procIndex;
if (p > (numBlocks - 1)) {
p -= numBlocks;
}
if (procsTo_[p] != myRank) {
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts(3,slow): Post send: "
"{target: " << procsTo_[p] << ", tag: " << tag << "}" << endl;
*out_ << os.str ();
}
typename ArrayView<const Packet>::iterator srcBegin, srcEnd;
size_t sendArrayOffset = 0;
size_t j = startsTo_[p];
for (size_t k = 0; k < lengthsTo_[p]; ++k, ++j) {
srcBegin = exports.begin() + indicesTo_[j]*numPackets;
srcEnd = srcBegin + numPackets;
std::copy (srcBegin, srcEnd, sendArray.begin()+sendArrayOffset);
sendArrayOffset += numPackets;
}
ArrayView<const Packet> tmpSend =
sendArray.view (0, lengthsTo_[p]*numPackets);
if (sendType == Details::DISTRIBUTOR_SEND) {
send<int, Packet> (tmpSend.getRawPtr (),
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
else if (sendType == Details::DISTRIBUTOR_ISEND) {
ArrayRCP<const Packet> tmpSendBuf =
sendArray.persistingView (0, lengthsTo_[p] * numPackets);
requests_.push_back (isend<int, Packet> (tmpSendBuf, procsTo_[p],
tag, *comm_));
}
else if (sendType == Details::DISTRIBUTOR_RSEND) {
readySend<int, Packet> (tmpSend.getRawPtr (),
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
else if (sendType == Details::DISTRIBUTOR_SSEND) {
ssend<int, Packet> (tmpSend.getRawPtr (),
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
else {
TEUCHOS_TEST_FOR_EXCEPTION(
true, std::logic_error, "Tpetra::Distributor::doPosts(3 args): "
"Invalid send type. We should never get here. "
"Please report this bug to the Tpetra developers.");
}
}
else { // "Sending" the message to myself
selfNum = p;
selfIndex = startsTo_[p];
}
}
if (selfMessage_) {
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts(3,slow): Self-send" << endl;
*out_ << os.str ();
}
for (size_t k = 0; k < lengthsTo_[selfNum]; ++k) {
std::copy (exports.begin()+indicesTo_[selfIndex]*numPackets,
exports.begin()+indicesTo_[selfIndex]*numPackets + numPackets,
imports.begin() + selfReceiveOffset);
++selfIndex;
selfReceiveOffset += numPackets;
}
}
if (debug_) {
std::ostringstream os;
os << myRank << ": doPosts(3,slow) done" << endl;
*out_ << os.str ();
}
}
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts done" << endl;
*out_ << os.str ();
}
}
template <class Packet>
void Distributor::
doPosts (const Teuchos::ArrayRCP<const Packet>& exports,
const Teuchos::ArrayView<const size_t>& numExportPacketsPerLID,
const Teuchos::ArrayRCP<Packet>& imports,
const Teuchos::ArrayView<const size_t>& numImportPacketsPerLID)
{
using Teuchos::Array;
using Teuchos::ArrayRCP;
using Teuchos::ArrayView;
using Teuchos::as;
using Teuchos::ireceive;
using Teuchos::isend;
using Teuchos::readySend;
using Teuchos::send;
using Teuchos::ssend;
using Teuchos::TypeNameTraits;
#ifdef HAVE_TEUCHOS_DEBUG
using Teuchos::OSTab;
#endif // HAVE_TEUCHOS_DEBUG
using std::endl;
typedef Array<size_t>::size_type size_type;
Teuchos::OSTab tab (out_);
#ifdef TPETRA_DISTRIBUTOR_TIMERS
Teuchos::TimeMonitor timeMon (*timer_doPosts4_);
#endif // TPETRA_DISTRIBUTOR_TIMERS
// Run-time configurable parameters that come from the input
// ParameterList set by setParameterList().
const Details::EDistributorSendType sendType = sendType_;
const bool doBarrier = barrierBetween_;
// #ifdef HAVE_TEUCHOS_DEBUG
// // Prepare for verbose output, if applicable.
// Teuchos::EVerbosityLevel verbLevel = this->getVerbLevel ();
// Teuchos::RCP<Teuchos::FancyOStream> out = this->getOStream ();
// const bool doPrint = out.get () && (comm_->getRank () == 0) &&
// includesVerbLevel (verbLevel, Teuchos::VERB_EXTREME, true);
// if (doPrint) {
// // Only need one process to print out parameters.
// *out << "Distributor::doPosts (4 args)" << endl;
// }
// // Add one tab level. We declare this outside the doPrint scopes
// // so that the tab persists until the end of this method.
// Teuchos::OSTab tab = this->getOSTab ();
// if (doPrint) {
// *out << "Parameters:" << endl;
// {
// OSTab tab2 (out);
// *out << "sendType: " << DistributorSendTypeEnumToString (sendType)
// << endl << "barrierBetween: " << doBarrier << endl;
// }
// }
// #endif // HAVE_TEUCHOS_DEBUG
TEUCHOS_TEST_FOR_EXCEPTION(
sendType == Details::DISTRIBUTOR_RSEND && ! doBarrier, std::logic_error,
"Tpetra::Distributor::doPosts(4 args): Ready-send version requires a "
"barrier between posting receives and posting ready sends. This should "
"have been checked before. "
"Please report this bug to the Tpetra developers.");
const int myProcID = comm_->getRank ();
size_t selfReceiveOffset = 0;
#ifdef HAVE_TEUCHOS_DEBUG
// Different messages may have different numbers of packets.
size_t totalNumImportPackets = 0;
for (size_t ii = 0; ii < static_cast<size_t> (numImportPacketsPerLID.size ()); ++ii) {
totalNumImportPackets += numImportPacketsPerLID[ii];
}
TEUCHOS_TEST_FOR_EXCEPTION(
static_cast<size_t> (imports.size ()) < totalNumImportPackets,
std::runtime_error, "Tpetra::Distributor::doPosts(4 args): The 'imports' "
"array must have enough entries to hold the expected number of import "
"packets. imports.size() = " << imports.size() << " < "
"totalNumImportPackets = " << totalNumImportPackets << ".");
#endif // HAVE_TEUCHOS_DEBUG
// MPI tag for nonblocking receives and blocking sends in this
// method. Some processes might take the "fast" path
// (indicesTo_.empty()) and others might take the "slow" path for
// the same doPosts() call, so the path tag must be the same for
// both.
const int pathTag = 1;
const int tag = this->getTag (pathTag);
if (debug_) {
TEUCHOS_TEST_FOR_EXCEPTION(
requests_.size () != 0, std::logic_error, "Tpetra::Distributor::"
"doPosts(4 args): Process " << myProcID << ": requests_.size() = "
<< requests_.size () << " != 0.");
std::ostringstream os;
os << myProcID << ": doPosts(4,"
<< (indicesTo_.empty () ? "fast" : "slow") << ")" << endl;
*out_ << os.str ();
}
// Distributor uses requests_.size() as the number of outstanding
// nonblocking message requests, so we resize to zero to maintain
// this invariant.
//
// numReceives_ does _not_ include the self message, if there is
// one. Here, we do actually send a message to ourselves, so we
// include any self message in the "actual" number of receives to
// post.
//
// NOTE (mfh 19 Mar 2012): Epetra_MpiDistributor::DoPosts()
// doesn't (re)allocate its array of requests. That happens in
// CreateFromSends(), ComputeRecvs_(), DoReversePosts() (on
// demand), or Resize_().
const size_type actualNumReceives = as<size_type> (numReceives_) +
as<size_type> (selfMessage_ ? 1 : 0);
requests_.resize (0);
// Post the nonblocking receives. It's common MPI wisdom to post
// receives before sends. In MPI terms, this means favoring
// adding to the "posted queue" (of receive requests) over adding
// to the "unexpected queue" (of arrived messages not yet matched
// with a receive).
{
#ifdef TPETRA_DISTRIBUTOR_TIMERS
Teuchos::TimeMonitor timeMonRecvs (*timer_doPosts4_recvs_);
#endif // TPETRA_DISTRIBUTOR_TIMERS
size_t curBufferOffset = 0;
size_t curLIDoffset = 0;
for (size_type i = 0; i < actualNumReceives; ++i) {
size_t totalPacketsFrom_i = 0;
for (size_t j = 0; j < lengthsFrom_[i]; ++j) {
totalPacketsFrom_i += numImportPacketsPerLID[curLIDoffset+j];
}
curLIDoffset += lengthsFrom_[i];
if (procsFrom_[i] != myProcID && totalPacketsFrom_i) {
// If my process is receiving these packet(s) from another
// process (not a self-receive), and if there is at least
// one packet to receive:
//
// 1. Set up the persisting view (recvBuf) into the imports
// array, given the offset and size (total number of
// packets from process procsFrom_[i]).
// 2. Start the Irecv and save the resulting request.
ArrayRCP<Packet> recvBuf =
imports.persistingView (curBufferOffset, totalPacketsFrom_i);
requests_.push_back (ireceive<int, Packet> (recvBuf, procsFrom_[i],
tag, *comm_));
}
else { // Receiving these packet(s) from myself
selfReceiveOffset = curBufferOffset; // Remember the offset
}
curBufferOffset += totalPacketsFrom_i;
}
}
if (doBarrier) {
#ifdef TPETRA_DISTRIBUTOR_TIMERS
Teuchos::TimeMonitor timeMonBarrier (*timer_doPosts4_barrier_);
#endif // TPETRA_DISTRIBUTOR_TIMERS
// If we are using ready sends (MPI_Rsend) below, we need to do
// a barrier before we post the ready sends. This is because a
// ready send requires that its matching receive has already
// been posted before the send has been posted. The only way to
// guarantee that in this case is to use a barrier.
comm_->barrier ();
}
#ifdef TPETRA_DISTRIBUTOR_TIMERS
Teuchos::TimeMonitor timeMonSends (*timer_doPosts4_sends_);
#endif // TPETRA_DISTRIBUTOR_TIMERS
// setup arrays containing starting-offsets into exports for each send,
// and num-packets-to-send for each send.
Array<size_t> sendPacketOffsets(numSends_,0), packetsPerSend(numSends_,0);
size_t maxNumPackets = 0;
size_t curPKToffset = 0;
for (size_t pp=0; pp<numSends_; ++pp) {
sendPacketOffsets[pp] = curPKToffset;
size_t numPackets = 0;
for (size_t j=startsTo_[pp]; j<startsTo_[pp]+lengthsTo_[pp]; ++j) {
numPackets += numExportPacketsPerLID[j];
}
if (numPackets > maxNumPackets) maxNumPackets = numPackets;
packetsPerSend[pp] = numPackets;
curPKToffset += numPackets;
}
// setup scan through procsTo_ list starting with higher numbered procs
// (should help balance message traffic)
size_t numBlocks = numSends_+ selfMessage_;
size_t procIndex = 0;
while ((procIndex < numBlocks) && (procsTo_[procIndex] < myProcID)) {
++procIndex;
}
if (procIndex == numBlocks) {
procIndex = 0;
}
size_t selfNum = 0;
size_t selfIndex = 0;
if (indicesTo_.empty()) {
if (debug_) {
std::ostringstream os;
os << myProcID << ": doPosts(4,fast): posting sends" << endl;
*out_ << os.str ();
}
// Data are already blocked (laid out) by process, so we don't
// need a separate send buffer (besides the exports array).
for (size_t i = 0; i < numBlocks; ++i) {
size_t p = i + procIndex;
if (p > (numBlocks - 1)) {
p -= numBlocks;
}
if (procsTo_[p] != myProcID && packetsPerSend[p] > 0) {
ArrayView<const Packet> tmpSend =
exports.view (sendPacketOffsets[p], packetsPerSend[p]);
if (sendType == Details::DISTRIBUTOR_SEND) { // the default, so put it first
send<int, Packet> (tmpSend.getRawPtr (),
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
else if (sendType == Details::DISTRIBUTOR_RSEND) {
readySend<int, Packet> (tmpSend.getRawPtr (),
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
else if (sendType == Details::DISTRIBUTOR_ISEND) {
ArrayRCP<const Packet> tmpSendBuf =
exports.persistingView (sendPacketOffsets[p], packetsPerSend[p]);
requests_.push_back (isend<int, Packet> (tmpSendBuf, procsTo_[p],
tag, *comm_));
}
else if (sendType == Details::DISTRIBUTOR_SSEND) {
ssend<int, Packet> (tmpSend.getRawPtr (),
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
else {
TEUCHOS_TEST_FOR_EXCEPTION(
true, std::logic_error, "Tpetra::Distributor::doPosts(4 args): "
"Invalid send type. We should never get here. Please report "
"this bug to the Tpetra developers.");
}
}
else { // "Sending" the message to myself
selfNum = p;
}
}
if (selfMessage_) {
std::copy (exports.begin()+sendPacketOffsets[selfNum],
exports.begin()+sendPacketOffsets[selfNum]+packetsPerSend[selfNum],
imports.begin()+selfReceiveOffset);
}
if (debug_) {
std::ostringstream os;
os << myProcID << ": doPosts(4,fast) done" << endl;
*out_ << os.str ();
}
}
else { // data are not blocked by proc, use send buffer
if (debug_) {
std::ostringstream os;
os << myProcID << ": doPosts(4,slow): posting sends" << endl;
*out_ << os.str ();
}
// FIXME (mfh 05 Mar 2013) This may be broken for Isend.
ArrayRCP<Packet> sendArray (maxNumPackets); // send buffer
TEUCHOS_TEST_FOR_EXCEPTION(
sendType == Details::DISTRIBUTOR_ISEND, std::logic_error,
"Tpetra::Distributor::doPosts(3 args): The \"send buffer\" "
"code path may not necessarily work with nonblocking sends.");
Array<size_t> indicesOffsets (numExportPacketsPerLID.size(), 0);
size_t ioffset = 0;
for (int j=0; j<numExportPacketsPerLID.size(); ++j) {
indicesOffsets[j] = ioffset;
ioffset += numExportPacketsPerLID[j];
}
for (size_t i = 0; i < numBlocks; ++i) {
size_t p = i + procIndex;
if (p > (numBlocks - 1)) {
p -= numBlocks;
}
if (procsTo_[p] != myProcID) {
typename ArrayView<const Packet>::iterator srcBegin, srcEnd;
size_t sendArrayOffset = 0;
size_t j = startsTo_[p];
size_t numPacketsTo_p = 0;
for (size_t k = 0; k < lengthsTo_[p]; ++k, ++j) {
srcBegin = exports.begin() + indicesOffsets[j];
srcEnd = srcBegin + numExportPacketsPerLID[j];
numPacketsTo_p += numExportPacketsPerLID[j];
std::copy (srcBegin, srcEnd, sendArray.begin()+sendArrayOffset);
sendArrayOffset += numExportPacketsPerLID[j];
}
if (numPacketsTo_p > 0) {
ArrayView<const Packet> tmpSend =
sendArray.view (0, numPacketsTo_p);
if (sendType == Details::DISTRIBUTOR_RSEND) {
readySend<int, Packet> (tmpSend.getRawPtr (),
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
else if (sendType == Details::DISTRIBUTOR_ISEND) {
ArrayRCP<const Packet> tmpSendBuf =
sendArray.persistingView (0, numPacketsTo_p);
requests_.push_back (isend<int, Packet> (tmpSendBuf, procsTo_[p],
tag, *comm_));
}
else if (sendType == Details::DISTRIBUTOR_SSEND) {
ssend<int, Packet> (tmpSend.getRawPtr (),
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
else { // if (sendType == Details::DISTRIBUTOR_SSEND)
send<int, Packet> (tmpSend.getRawPtr (),
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
}
}
else { // "Sending" the message to myself
selfNum = p;
selfIndex = startsTo_[p];
}
}
if (selfMessage_) {
for (size_t k = 0; k < lengthsTo_[selfNum]; ++k) {
std::copy (exports.begin()+indicesOffsets[selfIndex],
exports.begin()+indicesOffsets[selfIndex]+numExportPacketsPerLID[selfIndex],
imports.begin() + selfReceiveOffset);
selfReceiveOffset += numExportPacketsPerLID[selfIndex];
++selfIndex;
}
}
if (debug_) {
std::ostringstream os;
os << myProcID << ": doPosts(4,slow) done" << endl;
*out_ << os.str ();
}
}
}
template <class Packet>
void Distributor::
doReversePostsAndWaits (const Teuchos::ArrayView<const Packet>& exports,
size_t numPackets,
const Teuchos::ArrayView<Packet>& imports)
{
using Teuchos::arcp;
using Teuchos::ArrayRCP;
using Teuchos::as;
// doReversePosts() takes exports and imports as ArrayRCPs,
// requiring that the memory locations are persisting. However,
// they need only persist within the scope of that routine, so it
// is safe for us to use nonpersisting references in this case.
// mfh 04 Apr 2012: For some reason, calling arcp<const Packet>
// for Packet=std::complex<T> (e.g., T=float) fails to compile
// with some versions of GCC. The issue only arises with the
// exports array. This is why we construct a separate nonowning
// ArrayRCP.
typedef typename ArrayRCP<const Packet>::size_type size_type;
ArrayRCP<const Packet> exportsArcp (exports.getRawPtr(), as<size_type> (0),
exports.size(), false);
// mfh 04 Apr 2012: This is the offending code. This statement
// would normally be in place of "exportsArcp" in the
// doReversePosts() call below.
//arcp<const Packet> (exports.getRawPtr(), 0, exports.size(), false)
doReversePosts (exportsArcp,
numPackets,
arcp<Packet> (imports.getRawPtr (), 0, imports.size (), false));
doReverseWaits ();
lastRoundBytesSend_ = exports.size() * sizeof(Packet);
lastRoundBytesRecv_ = imports.size() * sizeof(Packet);
}
template <class Packet>
void Distributor::
doReversePostsAndWaits (const Teuchos::ArrayView<const Packet>& exports,
const Teuchos::ArrayView<const size_t>& numExportPacketsPerLID,
const Teuchos::ArrayView<Packet> &imports,
const Teuchos::ArrayView<const size_t>& numImportPacketsPerLID)
{
using Teuchos::as;
using Teuchos::arcp;
using Teuchos::ArrayRCP;
TEUCHOS_TEST_FOR_EXCEPTION(
requests_.size () != 0, std::runtime_error, "Tpetra::Distributor::"
"doReversePostsAndWaits(4 args): There are " << requests_.size ()
<< " outstanding nonblocking messages pending. It is incorrect to call "
"this method with posts outstanding.");
// doReversePosts() accepts the exports and imports arrays as
// ArrayRCPs, requiring that the memory location is persisting (as
// is necessary for nonblocking receives). However, it need only
// persist until doReverseWaits() completes, so it is safe for us
// to use a nonpersisting reference in this case. The use of a
// nonpersisting reference is purely a performance optimization.
// mfh 02 Apr 2012: For some reason, calling arcp<const Packet>
// for Packet=std::complex<double> fails to compile with some
// versions of GCC. The issue only arises with the exports array.
// This is why we construct a separate nonowning ArrayRCP.
typedef typename ArrayRCP<const Packet>::size_type size_type;
ArrayRCP<const Packet> exportsArcp (exports.getRawPtr (), as<size_type> (0),
exports.size (), false);
doReversePosts (exportsArcp,
numExportPacketsPerLID,
arcp<Packet> (imports.getRawPtr (), 0, imports.size (), false),
numImportPacketsPerLID);
doReverseWaits ();
lastRoundBytesSend_ = exports.size() * sizeof(Packet);
lastRoundBytesRecv_ = imports.size() * sizeof(Packet);
}
template <class Packet>
void Distributor::
doReversePosts (const Teuchos::ArrayRCP<const Packet>& exports,
size_t numPackets,
const Teuchos::ArrayRCP<Packet>& imports)
{
// FIXME (mfh 29 Mar 2012) WHY?
TEUCHOS_TEST_FOR_EXCEPTION(
! indicesTo_.empty (), std::runtime_error,
"Tpetra::Distributor::doReversePosts(3 args): Can only do reverse "
"communication when original data are blocked by process.");
if (reverseDistributor_.is_null ()) {
createReverseDistributor ();
}
reverseDistributor_->doPosts (exports, numPackets, imports);
}
template <class Packet>
void Distributor::
doReversePosts (const Teuchos::ArrayRCP<const Packet>& exports,
const Teuchos::ArrayView<const size_t>& numExportPacketsPerLID,
const Teuchos::ArrayRCP<Packet>& imports,
const Teuchos::ArrayView<const size_t>& numImportPacketsPerLID)
{
// FIXME (mfh 29 Mar 2012) WHY?
TEUCHOS_TEST_FOR_EXCEPTION(
! indicesTo_.empty (), std::runtime_error,
"Tpetra::Distributor::doReversePosts(3 args): Can only do reverse "
"communication when original data are blocked by process.");
if (reverseDistributor_.is_null ()) {
createReverseDistributor ();
}
reverseDistributor_->doPosts (exports, numExportPacketsPerLID,
imports, numImportPacketsPerLID);
}
template <class ExpView, class ImpView>
typename std::enable_if<(Kokkos::Impl::is_view<ExpView>::value && Kokkos::Impl::is_view<ImpView>::value)>::type
Distributor::
doPostsAndWaits (const ExpView& exports,
size_t numPackets,
const ImpView& imports)
{
using Teuchos::RCP;
using Teuchos::rcp;
using std::endl;
RCP<Teuchos::OSTab> tab0, tab1;
if (debug_) {
tab0 = rcp (new Teuchos::OSTab (out_));
const int myRank = comm_->getRank ();
std::ostringstream os;
os << "Proc " << myRank
<< ": Distributor::doPostsAndWaits(3 args, Kokkos): "
<< "{sendType: " << DistributorSendTypeEnumToString (sendType_)
<< ", barrierBetween: " << barrierBetween_ << "}" << endl;
*out_ << os.str ();
tab1 = rcp (new Teuchos::OSTab (out_));
}
TEUCHOS_TEST_FOR_EXCEPTION(
requests_.size () != 0, std::runtime_error, "Tpetra::Distributor::"
"doPostsAndWaits(3 args): There are " << requests_.size () <<
" outstanding nonblocking messages pending. It is incorrect to call "
"this method with posts outstanding.");
if (debug_) {
const int myRank = comm_->getRank ();
std::ostringstream os;
os << "Proc " << myRank
<< ": Distributor::doPostsAndWaits: Call doPosts" << endl;
*out_ << os.str ();
}
doPosts (exports, numPackets, imports);
if (debug_) {
const int myRank = comm_->getRank ();
std::ostringstream os;
os << "Proc " << myRank
<< ": Distributor::doPostsAndWaits: Call doWaits" << endl;
*out_ << os.str ();
}
doWaits ();
}
template <class ExpView, class ImpView>
typename std::enable_if<(Kokkos::Impl::is_view<ExpView>::value && Kokkos::Impl::is_view<ImpView>::value)>::type
Distributor::
doPostsAndWaits (const ExpView& exports,
const Teuchos::ArrayView<const size_t>& numExportPacketsPerLID,
const ImpView& imports,
const Teuchos::ArrayView<const size_t>& numImportPacketsPerLID)
{
TEUCHOS_TEST_FOR_EXCEPTION(
requests_.size () != 0, std::runtime_error,
"Tpetra::Distributor::doPostsAndWaits(4 args): There are "
<< requests_.size () << " outstanding nonblocking messages pending. "
"It is incorrect to call this method with posts outstanding.");
doPosts (exports, numExportPacketsPerLID, imports, numImportPacketsPerLID);
doWaits ();
}
template <class ExpView, class ImpView>
typename std::enable_if<(Kokkos::Impl::is_view<ExpView>::value && Kokkos::Impl::is_view<ImpView>::value)>::type
Distributor::
doPosts (const ExpView &exports,
size_t numPackets,
const ImpView &imports)
{
using Teuchos::Array;
using Teuchos::as;
using Teuchos::FancyOStream;
using Teuchos::includesVerbLevel;
using Teuchos::ireceive;
using Teuchos::isend;
using Teuchos::OSTab;
using Teuchos::readySend;
using Teuchos::send;
using Teuchos::ssend;
using Teuchos::TypeNameTraits;
using Teuchos::typeName;
using std::endl;
using Kokkos::Compat::create_const_view;
using Kokkos::Compat::create_view;
using Kokkos::Compat::subview_offset;
using Kokkos::Compat::deep_copy_offset;
typedef Array<size_t>::size_type size_type;
typedef ExpView exports_view_type;
typedef ImpView imports_view_type;
#ifdef TPETRA_DISTRIBUTOR_TIMERS
Teuchos::TimeMonitor timeMon (*timer_doPosts3_);
#endif // TPETRA_DISTRIBUTOR_TIMERS
const int myRank = comm_->getRank ();
// Run-time configurable parameters that come from the input
// ParameterList set by setParameterList().
const Details::EDistributorSendType sendType = sendType_;
const bool doBarrier = barrierBetween_;
Teuchos::OSTab tab0 (out_);
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": Distributor::doPosts(3 args, Kokkos)" << endl;
*out_ << os.str ();
}
Teuchos::OSTab tab1 (out_);
TEUCHOS_TEST_FOR_EXCEPTION(
sendType == Details::DISTRIBUTOR_RSEND && ! doBarrier, std::logic_error,
"Tpetra::Distributor::doPosts(3 args): Ready-send version requires a "
"barrier between posting receives and posting ready sends. This should "
"have been checked before. "
"Please report this bug to the Tpetra developers.");
size_t selfReceiveOffset = 0;
// mfh 30 Mar 2016: See Github Issue #227 to see why we need to
// check whether we're doing reverse mode before checking the
// length of the imports array.
if (false /* howInitialized_ != Details::DISTRIBUTOR_INITIALIZED_BY_REVERSE */) {
// Each message has the same number of packets.
const size_t totalNumImportPackets = totalReceiveLength_ * numPackets;
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts: totalNumImportPackets = " <<
totalNumImportPackets << " = " << totalReceiveLength_ << " * " <<
numPackets << "; imports.dimension_0() = " << imports.dimension_0 ()
<< endl;
*out_ << os.str ();
}
#ifdef HAVE_TPETRA_DEBUG
// mfh 31 Mar 2016: Extra special all-reduce check to help diagnose #227.
{
const size_t importBufSize = static_cast<size_t> (imports.dimension_0 ());
const int lclBad = (importBufSize < totalNumImportPackets) ? 1 : 0;
int gblBad = 0;
using Teuchos::reduceAll;
using Teuchos::REDUCE_MAX;
using Teuchos::outArg;
reduceAll (*comm_, REDUCE_MAX, lclBad, outArg (gblBad));
TEUCHOS_TEST_FOR_EXCEPTION
(gblBad != 0, std::runtime_error, "Tpetra::Distributor::doPosts(3 "
"args, Kokkos): On one or more MPI processes, the 'imports' array "
"does not have enough entries to hold the expected number of "
"import packets. ");
}
#else
TEUCHOS_TEST_FOR_EXCEPTION
(static_cast<size_t> (imports.dimension_0 ()) < totalNumImportPackets,
std::runtime_error, "Tpetra::Distributor::doPosts(3 args): The 'imports' "
"array must have enough entries to hold the expected number of import "
"packets. imports.dimension_0() = " << imports.dimension_0 () << " < "
"totalNumImportPackets = " << totalNumImportPackets << " = "
"totalReceiveLength_ (" << totalReceiveLength_ << ") * numPackets ("
<< numPackets << ").");
#endif // HAVE_TPETRA_DEBUG
}
// MPI tag for nonblocking receives and blocking sends in this
// method. Some processes might take the "fast" path
// (indicesTo_.empty()) and others might take the "slow" path for
// the same doPosts() call, so the path tag must be the same for
// both.
const int pathTag = 0;
const int tag = this->getTag (pathTag);
#ifdef HAVE_TPETRA_DEBUG
TEUCHOS_TEST_FOR_EXCEPTION
(requests_.size () != 0, std::logic_error, "Tpetra::Distributor::"
"doPosts(3 args, Kokkos): Process " << myRank << ": requests_.size() = "
<< requests_.size () << " != 0.");
#endif // HAVE_TPETRA_DEBUG
// Distributor uses requests_.size() as the number of outstanding
// nonblocking message requests, so we resize to zero to maintain
// this invariant.
//
// numReceives_ does _not_ include the self message, if there is
// one. Here, we do actually send a message to ourselves, so we
// include any self message in the "actual" number of receives to
// post.
//
// NOTE (mfh 19 Mar 2012): Epetra_MpiDistributor::DoPosts()
// doesn't (re)allocate its array of requests. That happens in
// CreateFromSends(), ComputeRecvs_(), DoReversePosts() (on
// demand), or Resize_().
const size_type actualNumReceives = as<size_type> (numReceives_) +
as<size_type> (selfMessage_ ? 1 : 0);
requests_.resize (0);
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts(3,"
<< (indicesTo_.empty () ? "fast" : "slow") << "): Post receives"
<< endl;
*out_ << os.str ();
}
// Post the nonblocking receives. It's common MPI wisdom to post
// receives before sends. In MPI terms, this means favoring
// adding to the "posted queue" (of receive requests) over adding
// to the "unexpected queue" (of arrived messages not yet matched
// with a receive).
{
#ifdef TPETRA_DISTRIBUTOR_TIMERS
Teuchos::TimeMonitor timeMonRecvs (*timer_doPosts3_recvs_);
#endif // TPETRA_DISTRIBUTOR_TIMERS
size_t curBufferOffset = 0;
for (size_type i = 0; i < actualNumReceives; ++i) {
const size_t curBufLen = lengthsFrom_[i] * numPackets;
if (procsFrom_[i] != myRank) {
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts(3,"
<< (indicesTo_.empty () ? "fast" : "slow") << "): "
<< "Post irecv: {source: " << procsFrom_[i]
<< ", tag: " << tag << "}" << endl;
*out_ << os.str ();
}
// If my process is receiving these packet(s) from another
// process (not a self-receive):
//
// 1. Set up the persisting view (recvBuf) of the imports
// array, given the offset and size (total number of
// packets from process procsFrom_[i]).
// 2. Start the Irecv and save the resulting request.
TEUCHOS_TEST_FOR_EXCEPTION(
curBufferOffset + curBufLen > static_cast<size_t> (imports.size ()),
std::logic_error, "Tpetra::Distributor::doPosts(3 args, Kokkos): "
"Exceeded size of 'imports' array in packing loop on Process " <<
myRank << ". imports.size() = " << imports.size () << " < "
"curBufferOffset(" << curBufferOffset << ") + curBufLen(" <<
curBufLen << ").");
imports_view_type recvBuf =
subview_offset (imports, curBufferOffset, curBufLen);
requests_.push_back (ireceive<int> (recvBuf, procsFrom_[i],
tag, *comm_));
}
else { // Receiving from myself
selfReceiveOffset = curBufferOffset; // Remember the self-recv offset
}
curBufferOffset += curBufLen;
}
}
if (doBarrier) {
#ifdef TPETRA_DISTRIBUTOR_TIMERS
Teuchos::TimeMonitor timeMonBarrier (*timer_doPosts3_barrier_);
#endif // TPETRA_DISTRIBUTOR_TIMERS
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts(3,"
<< (indicesTo_.empty () ? "fast" : "slow") << "): Barrier" << endl;
*out_ << os.str ();
}
// If we are using ready sends (MPI_Rsend) below, we need to do
// a barrier before we post the ready sends. This is because a
// ready send requires that its matching receive has already
// been posted before the send has been posted. The only way to
// guarantee that in this case is to use a barrier.
comm_->barrier ();
}
#ifdef TPETRA_DISTRIBUTOR_TIMERS
Teuchos::TimeMonitor timeMonSends (*timer_doPosts3_sends_);
#endif // TPETRA_DISTRIBUTOR_TIMERS
// setup scan through procsTo_ list starting with higher numbered procs
// (should help balance message traffic)
//
// FIXME (mfh 20 Feb 2013) Why haven't we precomputed this?
// It doesn't depend on the input at all.
size_t numBlocks = numSends_ + selfMessage_;
size_t procIndex = 0;
while ((procIndex < numBlocks) && (procsTo_[procIndex] < myRank)) {
++procIndex;
}
if (procIndex == numBlocks) {
procIndex = 0;
}
size_t selfNum = 0;
size_t selfIndex = 0;
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts(3,"
<< (indicesTo_.empty () ? "fast" : "slow") << "): Post sends" << endl;
*out_ << os.str ();
}
if (indicesTo_.empty()) {
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts(3,fast): posting sends" << endl;
*out_ << os.str ();
}
// Data are already blocked (laid out) by process, so we don't
// need a separate send buffer (besides the exports array).
for (size_t i = 0; i < numBlocks; ++i) {
size_t p = i + procIndex;
if (p > (numBlocks - 1)) {
p -= numBlocks;
}
if (procsTo_[p] != myRank) {
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts(3,fast): Post send: "
"{target: " << procsTo_[p] << ", tag: " << tag << "}" << endl;
*out_ << os.str ();
}
// if (debug_) {
// const size_t off = startsTo_[p] * numPackets;
// const size_t len = lengthsTo_[p] * numPackets;
// TEUCHOS_TEST_FOR_EXCEPTION
// (static_cast<size_t> (off + len) >
// static_cast<size_t> (exports.size ()), std::logic_error,
// "doPosts: off=" << off << " + len=" << len << " > "
// "exports.size()=" << exports.size () << ".");
// }
exports_view_type tmpSend = subview_offset(
exports, startsTo_[p]*numPackets, lengthsTo_[p]*numPackets);
if (sendType == Details::DISTRIBUTOR_SEND) {
send<int> (tmpSend,
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
else if (sendType == Details::DISTRIBUTOR_ISEND) {
exports_view_type tmpSendBuf =
subview_offset (exports, startsTo_[p] * numPackets,
lengthsTo_[p] * numPackets);
requests_.push_back (isend<int> (tmpSendBuf, procsTo_[p],
tag, *comm_));
}
else if (sendType == Details::DISTRIBUTOR_RSEND) {
readySend<int> (tmpSend,
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
else if (sendType == Details::DISTRIBUTOR_SSEND) {
ssend<int> (tmpSend,
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
} else {
TEUCHOS_TEST_FOR_EXCEPTION(
true, std::logic_error, "Tpetra::Distributor::doPosts(3 args): "
"Invalid send type. We should never get here. "
"Please report this bug to the Tpetra developers.");
}
}
else { // "Sending" the message to myself
selfNum = p;
}
}
if (selfMessage_) {
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts(3,fast): Self-send" << endl;
*out_ << os.str ();
}
// This is how we "send a message to ourself": we copy from
// the export buffer to the import buffer. That saves
// Teuchos::Comm implementations other than MpiComm (in
// particular, SerialComm) the trouble of implementing self
// messages correctly. (To do this right, SerialComm would
// need internal buffer space for messages, keyed on the
// message's tag.)
deep_copy_offset(imports, exports, selfReceiveOffset,
startsTo_[selfNum]*numPackets,
lengthsTo_[selfNum]*numPackets);
}
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts(3,fast) done" << endl;
*out_ << os.str ();
}
}
else { // data are not blocked by proc, use send buffer
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts(3,slow): posting sends" << endl;
*out_ << os.str ();
}
typedef typename ExpView::non_const_value_type Packet;
typedef typename ExpView::array_layout Layout;
typedef typename ExpView::device_type Device;
typedef typename ExpView::memory_traits Mem;
Kokkos::View<Packet*,Layout,Device,Mem> sendArray ("sendArray",
maxSendLength_ * numPackets);
// FIXME (mfh 05 Mar 2013) This is broken for Isend (nonblocking
// sends), because the buffer is only long enough for one send.
TEUCHOS_TEST_FOR_EXCEPTION(
sendType == Details::DISTRIBUTOR_ISEND, std::logic_error,
"Tpetra::Distributor::doPosts(3 args): The \"send buffer\" code path "
"doesn't currently work with nonblocking sends.");
for (size_t i = 0; i < numBlocks; ++i) {
size_t p = i + procIndex;
if (p > (numBlocks - 1)) {
p -= numBlocks;
}
if (procsTo_[p] != myRank) {
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts(3,slow): Post send: "
"{target: " << procsTo_[p] << ", tag: " << tag << "}" << endl;
*out_ << os.str ();
}
size_t sendArrayOffset = 0;
size_t j = startsTo_[p];
for (size_t k = 0; k < lengthsTo_[p]; ++k, ++j) {
deep_copy_offset(sendArray, exports, sendArrayOffset,
indicesTo_[j]*numPackets, numPackets);
sendArrayOffset += numPackets;
}
ImpView tmpSend =
subview_offset(sendArray, size_t(0), lengthsTo_[p]*numPackets);
if (sendType == Details::DISTRIBUTOR_SEND) {
send<int> (tmpSend,
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
else if (sendType == Details::DISTRIBUTOR_ISEND) {
exports_view_type tmpSendBuf =
subview_offset (sendArray, size_t(0), lengthsTo_[p] * numPackets);
requests_.push_back (isend<int> (tmpSendBuf, procsTo_[p],
tag, *comm_));
}
else if (sendType == Details::DISTRIBUTOR_RSEND) {
readySend<int> (tmpSend,
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
else if (sendType == Details::DISTRIBUTOR_SSEND) {
ssend<int> (tmpSend,
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
else {
TEUCHOS_TEST_FOR_EXCEPTION(
true, std::logic_error, "Tpetra::Distributor::doPosts(3 args): "
"Invalid send type. We should never get here. "
"Please report this bug to the Tpetra developers.");
}
}
else { // "Sending" the message to myself
selfNum = p;
selfIndex = startsTo_[p];
}
}
if (selfMessage_) {
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts(3,slow): Self-send" << endl;
*out_ << os.str ();
}
for (size_t k = 0; k < lengthsTo_[selfNum]; ++k) {
deep_copy_offset(imports, exports, selfReceiveOffset,
indicesTo_[selfIndex]*numPackets, numPackets);
++selfIndex;
selfReceiveOffset += numPackets;
}
}
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts(3,slow) done" << endl;
*out_ << os.str ();
}
}
if (debug_) {
std::ostringstream os;
os << "Proc " << myRank << ": doPosts done" << endl;
*out_ << os.str ();
}
}
template <class ExpView, class ImpView>
typename std::enable_if<(Kokkos::Impl::is_view<ExpView>::value && Kokkos::Impl::is_view<ImpView>::value)>::type
Distributor::
doPosts (const ExpView &exports,
const Teuchos::ArrayView<const size_t>& numExportPacketsPerLID,
const ImpView &imports,
const Teuchos::ArrayView<const size_t>& numImportPacketsPerLID)
{
using Teuchos::Array;
using Teuchos::as;
using Teuchos::ireceive;
using Teuchos::isend;
using Teuchos::readySend;
using Teuchos::send;
using Teuchos::ssend;
using Teuchos::TypeNameTraits;
#ifdef HAVE_TEUCHOS_DEBUG
using Teuchos::OSTab;
#endif // HAVE_TEUCHOS_DEBUG
using std::endl;
using Kokkos::Compat::create_const_view;
using Kokkos::Compat::create_view;
using Kokkos::Compat::subview_offset;
using Kokkos::Compat::deep_copy_offset;
typedef Array<size_t>::size_type size_type;
typedef ExpView exports_view_type;
typedef ImpView imports_view_type;
Teuchos::OSTab tab (out_);
#ifdef TPETRA_DISTRIBUTOR_TIMERS
Teuchos::TimeMonitor timeMon (*timer_doPosts4_);
#endif // TPETRA_DISTRIBUTOR_TIMERS
// Run-time configurable parameters that come from the input
// ParameterList set by setParameterList().
const Details::EDistributorSendType sendType = sendType_;
const bool doBarrier = barrierBetween_;
// #ifdef HAVE_TEUCHOS_DEBUG
// // Prepare for verbose output, if applicable.
// Teuchos::EVerbosityLevel verbLevel = this->getVerbLevel ();
// RCP<Teuchos::FancyOStream> out = this->getOStream ();
// const bool doPrint = out.get () && (comm_->getRank () == 0) &&
// includesVerbLevel (verbLevel, Teuchos::VERB_EXTREME, true);
// if (doPrint) {
// // Only need one process to print out parameters.
// *out << "Distributor::doPosts (4 args)" << endl;
// }
// // Add one tab level. We declare this outside the doPrint scopes
// // so that the tab persists until the end of this method.
// Teuchos::OSTab tab = this->getOSTab ();
// if (doPrint) {
// *out << "Parameters:" << endl;
// {
// OSTab tab2 (out);
// *out << "sendType: " << DistributorSendTypeEnumToString (sendType)
// << endl << "barrierBetween: " << doBarrier << endl;
// }
// }
// #endif // HAVE_TEUCHOS_DEBUG
TEUCHOS_TEST_FOR_EXCEPTION(
sendType == Details::DISTRIBUTOR_RSEND && ! doBarrier,
std::logic_error, "Tpetra::Distributor::doPosts(4 args): Ready-send "
"version requires a barrier between posting receives and posting ready "
"sends. This should have been checked before. "
"Please report this bug to the Tpetra developers.");
const int myProcID = comm_->getRank ();
size_t selfReceiveOffset = 0;
#ifdef HAVE_TEUCHOS_DEBUG
// Different messages may have different numbers of packets.
size_t totalNumImportPackets = 0;
for (size_type ii = 0; ii < numImportPacketsPerLID.size (); ++ii) {
totalNumImportPackets += numImportPacketsPerLID[ii];
}
TEUCHOS_TEST_FOR_EXCEPTION(
imports.dimension_0 () < totalNumImportPackets, std::runtime_error,
"Tpetra::Distributor::doPosts(4 args): The 'imports' array must have "
"enough entries to hold the expected number of import packets. "
"imports.dimension_0() = " << imports.dimension_0 () << " < "
"totalNumImportPackets = " << totalNumImportPackets << ".");
#endif // HAVE_TEUCHOS_DEBUG
// MPI tag for nonblocking receives and blocking sends in this
// method. Some processes might take the "fast" path
// (indicesTo_.empty()) and others might take the "slow" path for
// the same doPosts() call, so the path tag must be the same for
// both.
const int pathTag = 1;
const int tag = this->getTag (pathTag);
if (debug_) {
TEUCHOS_TEST_FOR_EXCEPTION(
requests_.size () != 0, std::logic_error, "Tpetra::Distributor::"
"doPosts(4 args): Process " << myProcID << ": requests_.size () = "
<< requests_.size () << " != 0.");
std::ostringstream os;
os << myProcID << ": doPosts(4,"
<< (indicesTo_.empty () ? "fast" : "slow") << ")" << endl;
*out_ << os.str ();
}
// Distributor uses requests_.size() as the number of outstanding
// nonblocking message requests, so we resize to zero to maintain
// this invariant.
//
// numReceives_ does _not_ include the self message, if there is
// one. Here, we do actually send a message to ourselves, so we
// include any self message in the "actual" number of receives to
// post.
//
// NOTE (mfh 19 Mar 2012): Epetra_MpiDistributor::DoPosts()
// doesn't (re)allocate its array of requests. That happens in
// CreateFromSends(), ComputeRecvs_(), DoReversePosts() (on
// demand), or Resize_().
const size_type actualNumReceives = as<size_type> (numReceives_) +
as<size_type> (selfMessage_ ? 1 : 0);
requests_.resize (0);
// Post the nonblocking receives. It's common MPI wisdom to post
// receives before sends. In MPI terms, this means favoring
// adding to the "posted queue" (of receive requests) over adding
// to the "unexpected queue" (of arrived messages not yet matched
// with a receive).
{
#ifdef TPETRA_DISTRIBUTOR_TIMERS
Teuchos::TimeMonitor timeMonRecvs (*timer_doPosts4_recvs_);
#endif // TPETRA_DISTRIBUTOR_TIMERS
size_t curBufferOffset = 0;
size_t curLIDoffset = 0;
for (size_type i = 0; i < actualNumReceives; ++i) {
size_t totalPacketsFrom_i = 0;
for (size_t j = 0; j < lengthsFrom_[i]; ++j) {
totalPacketsFrom_i += numImportPacketsPerLID[curLIDoffset+j];
}
curLIDoffset += lengthsFrom_[i];
if (procsFrom_[i] != myProcID && totalPacketsFrom_i) {
// If my process is receiving these packet(s) from another
// process (not a self-receive), and if there is at least
// one packet to receive:
//
// 1. Set up the persisting view (recvBuf) into the imports
// array, given the offset and size (total number of
// packets from process procsFrom_[i]).
// 2. Start the Irecv and save the resulting request.
imports_view_type recvBuf =
subview_offset (imports, curBufferOffset, totalPacketsFrom_i);
requests_.push_back (ireceive<int> (recvBuf, procsFrom_[i],
tag, *comm_));
}
else { // Receiving these packet(s) from myself
selfReceiveOffset = curBufferOffset; // Remember the offset
}
curBufferOffset += totalPacketsFrom_i;
}
}
if (doBarrier) {
#ifdef TPETRA_DISTRIBUTOR_TIMERS
Teuchos::TimeMonitor timeMonBarrier (*timer_doPosts4_barrier_);
#endif // TPETRA_DISTRIBUTOR_TIMERS
// If we are using ready sends (MPI_Rsend) below, we need to do
// a barrier before we post the ready sends. This is because a
// ready send requires that its matching receive has already
// been posted before the send has been posted. The only way to
// guarantee that in this case is to use a barrier.
comm_->barrier ();
}
#ifdef TPETRA_DISTRIBUTOR_TIMERS
Teuchos::TimeMonitor timeMonSends (*timer_doPosts4_sends_);
#endif // TPETRA_DISTRIBUTOR_TIMERS
// setup arrays containing starting-offsets into exports for each send,
// and num-packets-to-send for each send.
Array<size_t> sendPacketOffsets(numSends_,0), packetsPerSend(numSends_,0);
size_t maxNumPackets = 0;
size_t curPKToffset = 0;
for (size_t pp=0; pp<numSends_; ++pp) {
sendPacketOffsets[pp] = curPKToffset;
size_t numPackets = 0;
for (size_t j=startsTo_[pp]; j<startsTo_[pp]+lengthsTo_[pp]; ++j) {
numPackets += numExportPacketsPerLID[j];
}
if (numPackets > maxNumPackets) maxNumPackets = numPackets;
packetsPerSend[pp] = numPackets;
curPKToffset += numPackets;
}
// setup scan through procsTo_ list starting with higher numbered procs
// (should help balance message traffic)
size_t numBlocks = numSends_+ selfMessage_;
size_t procIndex = 0;
while ((procIndex < numBlocks) && (procsTo_[procIndex] < myProcID)) {
++procIndex;
}
if (procIndex == numBlocks) {
procIndex = 0;
}
size_t selfNum = 0;
size_t selfIndex = 0;
if (indicesTo_.empty()) {
if (debug_) {
std::ostringstream os;
os << myProcID << ": doPosts(4,fast): posting sends" << endl;
*out_ << os.str ();
}
// Data are already blocked (laid out) by process, so we don't
// need a separate send buffer (besides the exports array).
for (size_t i = 0; i < numBlocks; ++i) {
size_t p = i + procIndex;
if (p > (numBlocks - 1)) {
p -= numBlocks;
}
if (procsTo_[p] != myProcID && packetsPerSend[p] > 0) {
exports_view_type tmpSend =
subview_offset(exports, sendPacketOffsets[p], packetsPerSend[p]);
if (sendType == Details::DISTRIBUTOR_SEND) { // the default, so put it first
send<int> (tmpSend,
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
else if (sendType == Details::DISTRIBUTOR_RSEND) {
readySend<int> (tmpSend,
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
else if (sendType == Details::DISTRIBUTOR_ISEND) {
exports_view_type tmpSendBuf =
subview_offset (exports, sendPacketOffsets[p], packetsPerSend[p]);
requests_.push_back (isend<int> (tmpSendBuf, procsTo_[p],
tag, *comm_));
}
else if (sendType == Details::DISTRIBUTOR_SSEND) {
ssend<int> (tmpSend,
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
else {
TEUCHOS_TEST_FOR_EXCEPTION(
true, std::logic_error, "Tpetra::Distributor::doPosts(4 args): "
"Invalid send type. We should never get here. "
"Please report this bug to the Tpetra developers.");
}
}
else { // "Sending" the message to myself
selfNum = p;
}
}
if (selfMessage_) {
deep_copy_offset(imports, exports, selfReceiveOffset,
sendPacketOffsets[selfNum], packetsPerSend[selfNum]);
}
if (debug_) {
std::ostringstream os;
os << myProcID << ": doPosts(4,fast) done" << endl;
*out_ << os.str ();
}
}
else { // data are not blocked by proc, use send buffer
if (debug_) {
std::ostringstream os;
os << myProcID << ": doPosts(4,slow): posting sends" << endl;
*out_ << os.str ();
}
// FIXME (mfh 05 Mar 2013) This may be broken for Isend.
typedef typename ExpView::non_const_value_type Packet;
typedef typename ExpView::array_layout Layout;
typedef typename ExpView::device_type Device;
typedef typename ExpView::memory_traits Mem;
Kokkos::View<Packet*,Layout,Device,Mem> sendArray ("sendArray", maxNumPackets); // send buffer
TEUCHOS_TEST_FOR_EXCEPTION(
sendType == Details::DISTRIBUTOR_ISEND, std::logic_error,
"Tpetra::Distributor::doPosts(3 args): The \"send buffer\" code path "
"may not necessarily work with nonblocking sends.");
Array<size_t> indicesOffsets (numExportPacketsPerLID.size(), 0);
size_t ioffset = 0;
for (int j=0; j<numExportPacketsPerLID.size(); ++j) {
indicesOffsets[j] = ioffset;
ioffset += numExportPacketsPerLID[j];
}
for (size_t i = 0; i < numBlocks; ++i) {
size_t p = i + procIndex;
if (p > (numBlocks - 1)) {
p -= numBlocks;
}
if (procsTo_[p] != myProcID) {
size_t sendArrayOffset = 0;
size_t j = startsTo_[p];
size_t numPacketsTo_p = 0;
for (size_t k = 0; k < lengthsTo_[p]; ++k, ++j) {
deep_copy_offset(sendArray, exports, sendArrayOffset,
indicesOffsets[j], numExportPacketsPerLID[j]);
sendArrayOffset += numExportPacketsPerLID[j];
}
if (numPacketsTo_p > 0) {
ImpView tmpSend =
subview_offset(sendArray, size_t(0), numPacketsTo_p);
if (sendType == Details::DISTRIBUTOR_RSEND) {
readySend<int> (tmpSend,
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
else if (sendType == Details::DISTRIBUTOR_ISEND) {
exports_view_type tmpSendBuf =
subview_offset (sendArray, size_t(0), numPacketsTo_p);
requests_.push_back (isend<int> (tmpSendBuf, procsTo_[p],
tag, *comm_));
}
else if (sendType == Details::DISTRIBUTOR_SSEND) {
ssend<int> (tmpSend,
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
else { // if (sendType == Details::DISTRIBUTOR_SSEND)
send<int> (tmpSend,
as<int> (tmpSend.size ()),
procsTo_[p], tag, *comm_);
}
}
}
else { // "Sending" the message to myself
selfNum = p;
selfIndex = startsTo_[p];
}
}
if (selfMessage_) {
for (size_t k = 0; k < lengthsTo_[selfNum]; ++k) {
deep_copy_offset(imports, exports, selfReceiveOffset,
indicesOffsets[selfIndex],
numExportPacketsPerLID[selfIndex]);
selfReceiveOffset += numExportPacketsPerLID[selfIndex];
++selfIndex;
}
}
if (debug_) {
std::ostringstream os;
os << myProcID << ": doPosts(4,slow) done" << endl;
*out_ << os.str ();
}
}
}
template <class ExpView, class ImpView>
typename std::enable_if<(Kokkos::Impl::is_view<ExpView>::value && Kokkos::Impl::is_view<ImpView>::value)>::type
Distributor::
doReversePostsAndWaits (const ExpView& exports,
size_t numPackets,
const ImpView& imports)
{
doReversePosts (exports, numPackets, imports);
doReverseWaits ();
}
template <class ExpView, class ImpView>
typename std::enable_if<(Kokkos::Impl::is_view<ExpView>::value && Kokkos::Impl::is_view<ImpView>::value)>::type
Distributor::
doReversePostsAndWaits (const ExpView& exports,
const Teuchos::ArrayView<const size_t>& numExportPacketsPerLID,
const ImpView& imports,
const Teuchos::ArrayView<const size_t>& numImportPacketsPerLID)
{
TEUCHOS_TEST_FOR_EXCEPTION(requests_.size() != 0, std::runtime_error,
"Tpetra::Distributor::doReversePostsAndWaits(4 args): There are "
<< requests_.size() << " outstanding nonblocking messages pending. It "
"is incorrect to call this method with posts outstanding.");
doReversePosts (exports, numExportPacketsPerLID, imports,
numImportPacketsPerLID);
doReverseWaits ();
}
template <class ExpView, class ImpView>
typename std::enable_if<(Kokkos::Impl::is_view<ExpView>::value && Kokkos::Impl::is_view<ImpView>::value)>::type
Distributor::
doReversePosts (const ExpView &exports,
size_t numPackets,
const ImpView &imports)
{
// FIXME (mfh 29 Mar 2012) WHY?
TEUCHOS_TEST_FOR_EXCEPTION(
! indicesTo_.empty (), std::runtime_error,
"Tpetra::Distributor::doReversePosts(3 args): Can only do "
"reverse communication when original data are blocked by process.");
if (reverseDistributor_.is_null ()) {
createReverseDistributor ();
}
reverseDistributor_->doPosts (exports, numPackets, imports);
}
template <class ExpView, class ImpView>
typename std::enable_if<(Kokkos::Impl::is_view<ExpView>::value && Kokkos::Impl::is_view<ImpView>::value)>::type
Distributor::
doReversePosts (const ExpView &exports,
const Teuchos::ArrayView<const size_t>& numExportPacketsPerLID,
const ImpView &imports,
const Teuchos::ArrayView<const size_t>& numImportPacketsPerLID)
{
// FIXME (mfh 29 Mar 2012) WHY?
TEUCHOS_TEST_FOR_EXCEPTION(
! indicesTo_.empty (), std::runtime_error,
"Tpetra::Distributor::doReversePosts(3 args): Can only do "
"reverse communication when original data are blocked by process.");
if (reverseDistributor_.is_null ()) {
createReverseDistributor ();
}
reverseDistributor_->doPosts (exports, numExportPacketsPerLID,
imports, numImportPacketsPerLID);
}
template <class OrdinalType>
void Distributor::
computeSends (const Teuchos::ArrayView<const OrdinalType> & importGIDs,
const Teuchos::ArrayView<const int> & importProcIDs,
Teuchos::Array<OrdinalType> & exportGIDs,
Teuchos::Array<int> & exportProcIDs)
{
// NOTE (mfh 19 Apr 2012): There was a note on this code saying:
// "assumes that size_t >= Ordinal". The code certainly does
// assume that sizeof(size_t) >= sizeof(OrdinalType) as well as
// sizeof(size_t) >= sizeof(int). This is because it casts the
// OrdinalType elements of importGIDs (along with their
// corresponding process IDs, as int) to size_t, and does a
// doPostsAndWaits<size_t>() to send the packed data.
using Teuchos::Array;
using Teuchos::ArrayView;
using std::endl;
typedef typename ArrayView<const OrdinalType>::size_type size_type;
Teuchos::OSTab tab (out_);
const int myRank = comm_->getRank ();
if (debug_) {
std::ostringstream os;
os << myRank << ": computeSends" << endl;
*out_ << os.str ();
}
TEUCHOS_TEST_FOR_EXCEPTION(
importGIDs.size () != importProcIDs.size (), std::invalid_argument,
"Tpetra::Distributor::computeSends: On Process " << myRank << ": "
"importProcIDs.size() = " << importProcIDs.size ()
<< " != importGIDs.size() = " << importGIDs.size () << ".");
const size_type numImports = importProcIDs.size ();
Array<size_t> importObjs (2*numImports);
// Pack pairs (importGIDs[i], my process ID) to send into importObjs.
for (size_type i = 0; i < numImports; ++i) {
importObjs[2*i] = static_cast<size_t> (importGIDs[i]);
importObjs[2*i+1] = static_cast<size_t> (myRank);
}
//
// Use a temporary Distributor to send the (importGIDs[i], myRank)
// pairs to importProcIDs[i].
//
Distributor tempPlan (comm_, out_);
if (debug_) {
std::ostringstream os;
os << myRank << ": computeSends: tempPlan.createFromSends" << endl;
*out_ << os.str ();
}
// mfh 20 Mar 2014: An extra-cautious cast from unsigned to
// signed, in order to forestall any possible causes for Bug 6069.
const size_t numExportsAsSizeT = tempPlan.createFromSends (importProcIDs);
const size_type numExports = static_cast<size_type> (numExportsAsSizeT);
TEUCHOS_TEST_FOR_EXCEPTION(
numExports < 0, std::logic_error, "Tpetra::Distributor::computeSends: "
"tempPlan.createFromSends() returned numExports = " << numExportsAsSizeT
<< " as a size_t, which overflows to " << numExports << " when cast to "
<< Teuchos::TypeNameTraits<size_type>::name () << ". "
"Please report this bug to the Tpetra developers.");
TEUCHOS_TEST_FOR_EXCEPTION(
static_cast<size_type> (tempPlan.getTotalReceiveLength ()) != numExports,
std::logic_error, "Tpetra::Distributor::computeSends: tempPlan.getTotal"
"ReceiveLength() = " << tempPlan.getTotalReceiveLength () << " != num"
"Exports = " << numExports << ". Please report this bug to the "
"Tpetra developers.");
if (numExports > 0) {
exportGIDs.resize (numExports);
exportProcIDs.resize (numExports);
}
// exportObjs: Packed receive buffer. (exportObjs[2*i],
// exportObjs[2*i+1]) will give the (GID, PID) pair for export i,
// after tempPlan.doPostsAndWaits(...) finishes below.
//
// FIXME (mfh 19 Mar 2014) This only works if OrdinalType fits in
// size_t. This issue might come up, for example, on a 32-bit
// machine using 64-bit global indices. I will add a check here
// for that case.
TEUCHOS_TEST_FOR_EXCEPTION(
sizeof (size_t) < sizeof (OrdinalType), std::logic_error,
"Tpetra::Distributor::computeSends: sizeof(size_t) = " << sizeof(size_t)
<< " < sizeof(" << Teuchos::TypeNameTraits<OrdinalType>::name () << ") = "
<< sizeof (OrdinalType) << ". This violates an assumption of the "
"method. It's not hard to work around (just use Array<OrdinalType> as "
"the export buffer, not Array<size_t>), but we haven't done that yet. "
"Please report this bug to the Tpetra developers.");
TEUCHOS_TEST_FOR_EXCEPTION(
tempPlan.getTotalReceiveLength () < static_cast<size_t> (numExports),
std::logic_error,
"Tpetra::Distributor::computeSends: tempPlan.getTotalReceiveLength() = "
<< tempPlan.getTotalReceiveLength() << " < numExports = " << numExports
<< ". Please report this bug to the Tpetra developers.");
Array<size_t> exportObjs (tempPlan.getTotalReceiveLength () * 2);
if (debug_) {
std::ostringstream os;
os << myRank << ": computeSends: tempPlan.doPostsAndWaits" << endl;
*out_ << os.str ();
}
tempPlan.doPostsAndWaits<size_t> (importObjs (), 2, exportObjs ());
// Unpack received (GID, PID) pairs into exportIDs resp. exportProcIDs.
for (size_type i = 0; i < numExports; ++i) {
exportGIDs[i] = static_cast<OrdinalType> (exportObjs[2*i]);
exportProcIDs[i] = static_cast<int> (exportObjs[2*i+1]);
}
if (debug_) {
std::ostringstream os;
os << myRank << ": computeSends done" << endl;
*out_ << os.str ();
}
}
template <class OrdinalType>
void Distributor::
createFromRecvs (const Teuchos::ArrayView<const OrdinalType> &remoteGIDs,
const Teuchos::ArrayView<const int> &remoteProcIDs,
Teuchos::Array<OrdinalType> &exportGIDs,
Teuchos::Array<int> &exportProcIDs)
{
using std::endl;
Teuchos::OSTab tab (out_);
const int myRank = comm_->getRank();
if (debug_) {
*out_ << myRank << ": createFromRecvs" << endl;
}
#ifdef HAVE_TPETRA_DEBUG
using Teuchos::outArg;
using Teuchos::reduceAll;
// In debug mode, first test locally, then do an all-reduce to
// make sure that all processes passed.
const int errProc =
(remoteGIDs.size () != remoteProcIDs.size ()) ? myRank : -1;
int maxErrProc = -1;
reduceAll<int, int> (*comm_, Teuchos::REDUCE_MAX, errProc, outArg (maxErrProc));
TEUCHOS_TEST_FOR_EXCEPTION(maxErrProc != -1, std::runtime_error,
Teuchos::typeName (*this) << "::createFromRecvs(): lists of remote IDs "
"and remote process IDs must have the same size on all participating "
"processes. Maximum process ID with error: " << maxErrProc << ".");
#else // NOT HAVE_TPETRA_DEBUG
// In non-debug mode, just test locally.
TEUCHOS_TEST_FOR_EXCEPTION(
remoteGIDs.size () != remoteProcIDs.size (), std::invalid_argument,
Teuchos::typeName (*this) << "::createFromRecvs<" <<
Teuchos::TypeNameTraits<OrdinalType>::name () << ">(): On Process " <<
myRank << ": remoteGIDs.size() = " << remoteGIDs.size () << " != "
"remoteProcIDs.size() = " << remoteProcIDs.size () << ".");
#endif // HAVE_TPETRA_DEBUG
computeSends (remoteGIDs, remoteProcIDs, exportGIDs, exportProcIDs);
const size_t numProcsSendingToMe = createFromSends (exportProcIDs ());
if (debug_) {
// NOTE (mfh 20 Mar 2014) If remoteProcIDs could contain
// duplicates, then its length might not be the right check here,
// even if we account for selfMessage_. selfMessage_ is set in
// createFromSends.
std::ostringstream os;
os << "Proc " << myRank << ": {numProcsSendingToMe: "
<< numProcsSendingToMe << ", remoteProcIDs.size(): "
<< remoteProcIDs.size () << ", selfMessage_: "
<< (selfMessage_ ? "true" : "false") << "}" << std::endl;
std::cerr << os.str ();
}
if (debug_) {
*out_ << myRank << ": createFromRecvs done" << endl;
}
howInitialized_ = Details::DISTRIBUTOR_INITIALIZED_BY_CREATE_FROM_RECVS;
}
} // namespace Tpetra
#endif // TPETRA_DISTRIBUTOR_HPP
|