1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070
|
/*___INFO__MARK_BEGIN__*/
/*************************************************************************
*
* The Contents of this file are made available subject to the terms of
* the Sun Industry Standards Source License Version 1.2
*
* Sun Microsystems Inc., March, 2001
*
*
* Sun Industry Standards Source License Version 1.2
* =================================================
* The contents of this file are subject to the Sun Industry Standards
* Source License Version 1.2 (the "License"); You may not use this file
* except in compliance with the License. You may obtain a copy of the
* License at http://gridengine.sunsource.net/Gridengine_SISSL_license.html
*
* Software provided under this License is provided on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
* WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
* MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
* See the License for the specific provisions governing your rights and
* obligations concerning the Software.
*
* The Initial Developer of the Original Code is: Sun Microsystems, Inc.
*
* Copyright: 2001 by Sun Microsystems, Inc.
*
* All Rights Reserved.
*
************************************************************************/
/*___INFO__MARK_END__*/
#include <stdio.h>
#include <string.h>
#include <unistd.h>
#include <errno.h>
#include <pwd.h>
#include "drmaa.h"
#include "msg_drmaa.h"
#include "japi.h"
#include "japiP.h"
#include "sge_answer.h"
/* CLIENTS/COMMON */
#include "read_defaults.h"
/* COMMON */
#include "msg_common.h"
#include "parse_job_cull.h"
#include "parse_qsub.h"
#include "sge_options.h"
#include "symbols.h"
/* UTI */
#include "setup_path.h"
#include "sge_dstring.h"
#include "sge_parse_args.h"
#include "sge_prog.h"
#include "sge_string.h"
#include "sge_uidgid.h"
#include "sge_profiling.h"
/* RMON */
#include "sge_rmon.h"
/* SGEOBJ */
#include "sge_path_alias.h"
#include "sge_job.h"
#include "parse.h"
#include "sge_mailrec.h"
#include "sge_range.h"
#include "sge_ulong.h"
#include "sge_var.h"
#include "sge_job.h"
#include "sge_ja_task.h"
#include "sge_str.h"
/* GDI */
#include "sge_qtcsh.h"
#include "gdi/sge_gdi_ctx.h"
extern sge_gdi_ctx_class_t *ctx;
/****** DRMAA/--DRMAA_Job_API ********************************************************
* NAME
* DRMAA_Job_API -- Grid Engine's C/C++ binding for the DRMAA interface
*
* FUNCTION
* This libary gives a C/C++ binding for the DRMAA interface specification.
* The DRMAA interface is independed of a DRM system and thus can be implememted
* by not only for Grid Engine. It's scope is job submission and control.
* Refer to www.drmaa.org for more about this interface.
*
* SEE ALSO
* DRMAA/-DRMAA_Session_state
* DRMAA/-DRMAA_Implementation
* DRMAA/-DRMAA_Interface
* DRMAA/-DRMAA_Global_Constants
*******************************************************************************/
/****** DRMAA/-DRMAA_Implementation *******************************************
* NAME
* DRMAA_Implementation -- Functions used to implement Grid Engine DRMAA
*
* FUNCTION
* These functions are used to implement DRMAA functions. Most of the
* functionality of DRMAA is derived from Grid Engine's Job API.
*
* SEE ALSO
* DRMAA/drmaa_job2sge_job()
* DRMAA/japi_drmaa_path2sge_job()
* JAPI/--Job_API
*******************************************************************************/
/* Defined in rshd.c */
#if defined(DARWIN)
# include <crt_externs.h>
# define environ (*_NSGetEnviron())
#else
extern char **environ;
#endif
static int drmaa_is_attribute_supported(const char *name, bool vector, dstring *diag);
static drmaa_attr_names_t *drmaa_fill_string_vector(const char *name[]);
static int drmaa_job2sge_job(lListElem **jtp, const drmaa_job_template_t *drmaa_jt,
int is_bulk, int start, int end, int step, bool *use_euid_egid, dstring *diag);
static int drmaa_path2path_opt(const lList *attrs, lList **args,
int is_bulk, const char *attribute_key,
const char *sw, int opt, dstring *diag,
bool bFileStaging);
static int drmaa_path2wd_opt(const lList *attrs, lList **args, int is_bulk, dstring *diag);
static int drmaa_path2sge_path(const lList *attrs, int is_bulk,
const char *attribute_key, int do_wd,
const char **new_path, dstring *diag);
static void prune_arg_list(lList *args);
static void opt_list_append_default_drmaa_opts(lList **opts);
static void merge_drmaa_options(lList **opts_all, lList **opts_default,
lList **opts_defaults, lList **opts_scriptfile,
lList **opts_job_cat, lList **opts_native,
lList **opts_drmaa);
static int opt_list_append_opts_from_drmaa_attr(lList **args, const lList *attrs,
const lList *vattrs, int is_bulk, dstring *diag);
static char *drmaa_time2sge_time(const char *drmaa_time, dstring *diag);
static char *drmaa_get_home_directory(const char *username, lList **answer_list);
static char *drmaa_expand_wd_path(const char *username, const char *path, lList **answer_list);
static int drmaa_set_bulk_range(lList **opts, int start, int end, int step,
lList **alp);
static drmaa_attr_names_t *drmaa_fill_supported_nonvector_attributes(dstring *diag);
static drmaa_attr_names_t *drmaa_fill_supported_vector_attributes(dstring *diag);
static int drmaa_parse_contact_string(const char *contact, char **session);
/****** DRMAA/-DRMAA_Global_Constants *******************************************
* NAME
* Global_Constants -- global constants used in DRMAA
*
* SYNOPSIS
* static const char *drmaa_supported_nonvector[];
* static const char *drmaa_supported_vector[];
*
* FUNCTION
* drmaa_supported_nonvector - A string array containing all supported job
* template non-vector attributes.
* drmaa_supported_vector - A string array containing all supported job
* template vector attributes.
* SEE ALSO
*******************************************************************************/
/* these non vector job template attributes are supported */
static const char *drmaa_supported_nonvector[] = {
DRMAA_REMOTE_COMMAND, /* mandatory */
DRMAA_JS_STATE, /* mandatory */
DRMAA_WD, /* mandatory */
DRMAA_JOB_NAME, /* mandatory */
DRMAA_INPUT_PATH, /* mandatory */
DRMAA_OUTPUT_PATH, /* mandatory */
DRMAA_ERROR_PATH, /* mandatory */
DRMAA_JOIN_FILES, /* mandatory */
DRMAA_JOB_CATEGORY, /* mandatory */
DRMAA_NATIVE_SPECIFICATION, /* mandatory */
DRMAA_BLOCK_EMAIL, /* mandatory */
DRMAA_START_TIME, /* mandatory */
#if 0
DRMAA_DEADLINE_TIME, /* optional */
DRMAA_WCT_HLIMIT, /* optional */
DRMAA_WCT_SLIMIT, /* optional */
DRMAA_DURATION_HLIMIT, /* optional */
DRMAA_DURATION_SLIMIT, /* optional */
#endif
DRMAA_SUBMIT_AS_EUID, /* SGE only */
NULL
};
/* these vector job template attributes are supported */
static const char *drmaa_supported_vector[] = {
DRMAA_V_ARGV, /* mandatory */
DRMAA_V_ENV, /* mandatory */
DRMAA_V_EMAIL, /* mandatory */
NULL
};
/****** DRMAA/Env **************************************************************
* NAME
* Env - Env vars used by DRMAA
*
* SYNOPSIS
* #define ENABLE_CWD_ENV "SGE_DRMAA_ALLOW_CWD"
* #define ENABLE_ERROR_STATE "SGE_DRMAA_ALLOW_JOB_ERROR_STATE"
*
* FUNCTION
* ENABLE_CWD_ENV - enables the parsing of the -cwd switch in the sge_request,
* job category, and/or native specification. Unless this
* env is set, -cwd will be ignored because it not multi-
* thread safe.
* ENABLE_ERROR_STATE - in case of job errors, the job will enter the
* error state. Without this environment variable
* DRMAA jobs are not allowed to enter the job error
* state.
*******************************************************************************/
#define ENABLE_CWD_ENV "SGE_DRMAA_ALLOW_CWD"
#define ENABLE_ERROR_STATE "SGE_DRMAA_ALLOW_JOB_ERROR_STATE"
/****** DRMAA/drmaa_init() ****************************************************
* NAME
* drmaa_init() -- Initialize DRMAA API library
*
* SYNOPSIS
* int drmaa_init(const char *contact, char *error_diagnosis,
* size_t error_diag_len)
*
* FUNCTION
* Initialize DRMAA API library and create a new DRMAA Session. 'Contact'
* is an implementation dependent string which may be used to specify
* which DRM system to use. This routine must be called before any other
* DRMAA calls, except for drmaa_version(). If 'contact' is NULL, the default
* DRM system will be used. If 'contact' is not NULL, it is parsed for a
* list of semi-colon separated name=value strings. The currently supported
* list of strings is:
*
* session -- the id of the session to which to reconnect
#if 0
* sge_root -- the SGE_ROOT to use
* sge_cell -- the SGE_CELL to use
#endif
*
* Initializes internal data structures and registers
* with qmaster using the event client mechanisms.
*
* INPUTS
* const char *contact - contact string
* char *error_diagnosis - diagnosis buffer
* size_t error_diag_len - diagnosis buffer length
*
* RESULT
* int - DRMAA_ERRNO_SUCCESS on success otherwise
* DRMAA_ERRNO_INVALID_CONTACT_STRING,
* DRMAA_ERRNO_ALREADY_ACTIVE_SESSION, or
* DRMAA_ERRNO_DEFAULT_CONTACT_STRING_ERROR.
*
* NOTES
* MT-NOTE: drmaa_init() is MT safe
*******************************************************************************/
int drmaa_init(const char *contact, char *error_diagnosis,
size_t error_diag_len)
{
int ret;
dstring diag;
dstring *diagp = NULL;
dstring session_key_out = DSTRING_INIT;
char *session_key_in = NULL;
DENTER(TOP_LAYER, "drmaa_init");
if (error_diagnosis != NULL) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
diagp = &diag;
}
/* Disable profiling for DRMAA clients. */
sge_prof_set_enabled(false);
ret = drmaa_parse_contact_string(contact, &session_key_in);
if (ret != DRMAA_ERRNO_SUCCESS) {
if (diagp != NULL) {
sge_dstring_copy_string(diagp, drmaa_strerror(ret));
}
DRETURN(ret);
}
ret = japi_init(contact, session_key_in, &session_key_out, DRMAA, true, NULL,
diagp);
sge_free(&session_key_in);
if (ret != DRMAA_ERRNO_SUCCESS) {
/* diag was set in japi_init() */
DRETURN(ret);
}
DRETURN(DRMAA_ERRNO_SUCCESS);
}
/****** drmaa/drmaa_parse_contact_string() *********************************************
* NAME
* drmaa_parse_contact_string() -- Parses the contact string
*
* SYNOPSIS
* void drmaa_parse_contact_string(const char *contact, char **session)
*
* FUNCTION
* If the contact string is non-NULL and non-empty, this function will parse
* it, looking for specific flags. The current set of supported flags is:
*
* INPUTS
* contact - The contact string to be parsed
* session - The buffer into which the session string will be written
*
* OUTPUTS
* int - DRMAA error code
*
* NOTES
* MT-NOTES: drmaa_parse_contact_string() is MT safe
*******************************************************************************/
static int drmaa_parse_contact_string(const char *contact, char **session)
{
const char *full_str = contact;
char *token = NULL;
char *str = NULL;
struct saved_vars_s *context = NULL;
int drmaa_errno = DRMAA_ERRNO_SUCCESS;
DENTER(TOP_LAYER, "drmaa_parse_contact_string");
if (contact != NULL) {
/* First look for the = sign to find the name. */
while ((token = sge_strtok_r(full_str, "=", &context)) != NULL) {
full_str = NULL;
/* Then look for the ; to find the value. */
str = sge_strtok_r(NULL, ";", &context);
if (str == NULL) {
/* If str is NULL, that means that the search for = did not find an
* = and so returned the remainder of the string. In this case,
* the contact string is malformed. */
drmaa_errno = DRMAA_ERRNO_INVALID_ARGUMENT;
}
else if(strcasecmp(token, "session") == 0) {
*session = strdup(str);
}
#if 0 /* For future use... */
else if (strcasecmp(token, "sge_root") == 0) {
}
else if (strcasecmp(token, "sge_cell") == 0) {
}
#endif
else {
/* Invalid name. */
drmaa_errno = DRMAA_ERRNO_INVALID_ARGUMENT;
}
}
sge_free_saved_vars(context);
context = NULL;
}
DRETURN(drmaa_errno);
}
/****** DRMAA/drmaa_exit() ****************************************************
* NAME
* drmaa_exit() -- Shutdown DRMAA API library
*
* SYNOPSIS
* int drmaa_exit(char *error_diagnosis, size_t error_diag_len)
*
* FUNCTION
* Disengage from DRMAA library and allow the DRMAA library to perform
* any necessary internal clean up.
* This routine ends this DRMAA Session, but does not effect any jobs (e.g.,
* queued and running jobs remain queued and running).
*
* INPUTS
* char *error_diagnosis - diagnosis buffer
* size_t error_diag_len - diagnosis buffer length
*
* RESULT
* int - DRMAA_ERRNO_SUCCESS on success, otherwise DRMAA_ERRNO_DRMS_EXIT_ERROR
* or DRMAA_ERRNO_NO_ACTIVE_SESSION.
*
* NOTES
* MT-NOTE: drmaa_exit() is MT safe
*******************************************************************************/
int drmaa_exit(char *error_diagnosis, size_t error_diag_len)
{
dstring diag;
dstring *diagp = NULL;
int drmaa_errno;
DENTER(TOP_LAYER, "drmaa_exit");
if (error_diagnosis != NULL) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
diagp = &diag;
}
drmaa_errno = japi_exit(JAPI_EXIT_NO_FLAG, diagp);
DRETURN(drmaa_errno);
}
/****** DRMAA/drmaa_allocate_job_template() *************************************
* NAME
* drmaa_allocate_job_template() -- Allocate a new job template.
*
* SYNOPSIS
* int drmaa_allocate_job_template(drmaa_job_template_t **jtp,
* char *error_diagnosis, size_t error_diag_len)
*
* FUNCTION
* Allocate a new job template.
*
* OUTPUT
* drmaa_job_template_t **jtp - The new job template
* char *error_diagnosis - diagnosis buffer
* size_t error_diag_len - diagnosis buffer length
*
* RESULT
* int - DRMAA_ERRNO_SUCCESS on success, otherwise
* DRMAA_ERRNO_DRM_COMMUNICATION_FAILURE or
* DRMAA_ERRNO_INTERNAL_ERROR.
*
* NOTES
* MT-NOTE: drmaa_allocate_job_template() is MT safe
*******************************************************************************/
int drmaa_allocate_job_template(drmaa_job_template_t **jtp, char *error_diagnosis, size_t error_diag_len)
{
dstring diag, *diagp = NULL;
int ret = DRMAA_ERRNO_SUCCESS;
DENTER(TOP_LAYER, "drmaa_allocate_job_template");
if (error_diagnosis) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
diagp = &diag;
}
if (jtp == NULL) {
japi_standard_error(DRMAA_ERRNO_INVALID_ARGUMENT, diagp);
DRETURN(DRMAA_ERRNO_INVALID_ARGUMENT);
}
ret = japi_was_init_called(diagp);
if (ret != DRMAA_ERRNO_SUCCESS) {
/* diagp written by japi_was_init_called() */
DRETURN(ret);
}
*jtp = (drmaa_job_template_t *)malloc(sizeof(drmaa_job_template_t));
(*jtp)->strings = (*jtp)->string_vectors = NULL;
DRETURN(DRMAA_ERRNO_SUCCESS);
}
/****** DRMAA/drmaa_delete_job_template() ***************************************
* NAME
* drmaa_delete_job_template() -- Deallocate a job template
*
* SYNOPSIS
* int drmaa_delete_job_template(drmaa_job_template_t *jt,
* char *error_diagnosis, size_t error_diag_len)
*
* FUNCTION
* Deallocate a job template. This routine has no effect on jobs.
*
* INPUTS
* drmaa_job_template_t *jt - job template to be deleted
*
* OUTPUTS
* char *error_diagnosis - diagnosis buffer
* size_t error_diag_len - diagnosis buffer length
*
* RESULT
* int - DRMAA_ERRNO_SUCCESS on success, otherwise
* DRMAA_ERRNO_DRM_COMMUNICATION_FAILURE or DRMAA_ERRNO_INTERNAL_ERROR.
*
* NOTES
* MT-NOTE: drmaa_delete_job_template() is MT safe
*******************************************************************************/
int drmaa_delete_job_template(drmaa_job_template_t *jt, char *error_diagnosis, size_t error_diag_len)
{
dstring diag;
DENTER(TOP_LAYER, "drmaa_delete_job_template");
if (error_diagnosis != NULL) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len);
}
if (jt == NULL) {
if (error_diagnosis != NULL) {
japi_standard_error(DRMAA_ERRNO_INVALID_ARGUMENT, &diag);
}
DRETURN(DRMAA_ERRNO_INVALID_ARGUMENT);
}
lFreeList(&(jt->strings));
lFreeList(&(jt->string_vectors));
sge_free(&jt);
DRETURN(DRMAA_ERRNO_SUCCESS);
}
/****** DRMAA/drmaa_fill_string_vector() ***************************************
* NAME
* drmaa_fill_string_vector() -- Returns values in 'name' as string vector
*
* SYNOPSIS
* static drmaa_attr_names_t* drmaa_fill_string_vector(const char *name[])
*
* FUNCTION
* Returns values in 'name' as string vector
*
* INPUTS
* const char *name[] - The name vector.
*
* RESULT
* static drmaa_attr_names_t* - The string vector as it is used for DRMAA.
*
* NOTES
* MT-NOTES: drmaa_fill_string_vector() is MT safe
*******************************************************************************/
static drmaa_attr_names_t *drmaa_fill_string_vector(const char *name[])
{
drmaa_attr_names_t *vector;
int i;
DENTER(TOP_LAYER, "drmaa_fill_string_vector");
/* allocate iterator */
if (!(vector=(drmaa_attr_names_t *)japi_allocate_string_vector(JAPI_ITERATOR_STRINGS))) {
DRETURN(NULL);
}
for (i=0; name[i]; i++) {
DPRINTF(("adding \"%s\"\n", name[i]));
if (!lAddElemStr(&(vector->it.si.strings), ST_name, name[i], ST_Type)) {
japi_delete_string_vector((drmaa_attr_values_t *)vector);
DRETURN(NULL);
}
}
/* initialize iterator */
vector->it.si.next_pos = lFirst(vector->it.si.strings);
DRETURN(vector);
}
/****** DRMAA/drmaa_is_attribute_supported() *************************************
* NAME
* drmaa_is_attribute_supported() -- Checks if given attribute is supported.
*
* SYNOPSIS
* static int drmaa_is_attribute_supported(const char *name, bool vector)
*
* FUNCTION
* Checks if the attribute "name" is supported by the DRM-System and DRMAA.
*
* INPUTS
* const char *name - name of the attribute
* bool vector - true: attribute is a vector attribute.
* false: attribute is a scalar attribute.
* dstring *diag - error info
*
* RESULT
* bool - DRMAA_ERRNO_SUCCESS if attribute is supported,
* DRMAA_ERRNO_INVALID_ARGUMENT if attribute is not supported.
*
* NOTES
* MT-NOTE: drmaa_is_attribute_supported() is MT safe
*******************************************************************************/
static int drmaa_is_attribute_supported(const char *name, bool vector, dstring *diag)
{
int ret;
drmaa_attr_names_t *p_attr;
DENTER(TOP_LAYER, "drmaa_is_attribute_supported");
if( vector ) {
p_attr = drmaa_fill_supported_vector_attributes(diag);
} else {
p_attr = drmaa_fill_supported_nonvector_attributes(diag);
}
if (lGetElemStr( p_attr->it.si.strings, ST_name, name ) != NULL) {
DPRINTF(("Attribute %s is supported\n", name));
ret = DRMAA_ERRNO_SUCCESS;
} else {
DPRINTF(("Attribute %s is not supported\n", name));
ret = DRMAA_ERRNO_INVALID_ARGUMENT;
}
drmaa_release_attr_names(p_attr);
DRETURN(ret);
}
/****** DRMAA/drmaa_set_attribute() *********************************************
* NAME
* drmaa_set_attribute() -- Set non vector attribute in job template
*
* SYNOPSIS
* int drmaa_set_attribute(drmaa_job_template_t *jt, const char *name,
* const char *value, char *error_diagnosis, size_t error_diag_len)
*
* FUNCTION
* Adds ('name', 'value') pair to list of attributes in job template 'jt'.
* Only non-vector attributes may be passed.
*
* INPUTS
* drmaa_job_template_t *jt - job template
* const char *name - name
* const char *value - value
*
* OUTPUTS
* char *error_diagnosis - diagnosis buffer
* size_t error_diag_len - diagnosis buffer length
*
* RESULT
* int - returns DRMAA_ERRNO_SUCCESS on success, otherwise
* DRMAA_ERRNO_INVALID_ATTRIBUTE_FORMAT, DRMAA_ERRNO_INVALID_ARGUMENT,
* DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE, or
* DRMAA_ERRNO_CONFLICTING_ATTRIBUTE_VALUES
*
* NOTES
* MT-NOTE: drmaa_set_attribute() is MT safe
*******************************************************************************/
int drmaa_set_attribute(drmaa_job_template_t *jt, const char *name, const char *value,
char *error_diagnosis, size_t error_diag_len)
{
lListElem *ep = NULL;
int ret = DRMAA_ERRNO_SUCCESS;
dstring diag, *diagp = NULL;
DENTER(TOP_LAYER, "drmaa_set_attribute");
if (error_diagnosis != NULL) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
diagp = &diag;
}
if (!name || !value || jt == NULL) {
japi_standard_error(DRMAA_ERRNO_INVALID_ARGUMENT, diagp);
DRETURN(DRMAA_ERRNO_INVALID_ARGUMENT);
}
ret = japi_was_init_called(diagp);
if (ret != DRMAA_ERRNO_SUCCESS) {
/* diagp written by japi_was_init_called() */
DRETURN(ret);
}
ret = drmaa_is_attribute_supported(name, false, diagp);
if (ret == DRMAA_ERRNO_SUCCESS) {
/* verify value */
/* join files must be either 'y' or 'n' */
if (!strcmp(name, DRMAA_JOIN_FILES)) {
if (strlen(value)!=1 || (value[0] != 'y' && value[0] != 'n' )) {
sge_dstring_sprintf(diagp, "attribute "SFQ" must be either "SFQ" or "SFQ"\n",
DRMAA_JOIN_FILES, "y", "n");
DRETURN(DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE);
}
}
/* submission state must be either active or hold */
if (!strcmp(name, DRMAA_JS_STATE)) {
if (strcmp(value, DRMAA_SUBMISSION_STATE_ACTIVE) &&
strcmp(value, DRMAA_SUBMISSION_STATE_HOLD)) {
sge_dstring_sprintf(diagp,
"attribute "SFQ" must be either "SFQ" or "SFQ"\n",
DRMAA_JS_STATE,
DRMAA_SUBMISSION_STATE_ACTIVE,
DRMAA_SUBMISSION_STATE_HOLD);
DRETURN(DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE);
}
}
/* transfer files must contain only 'e', 'i', and 'o'. */
if (strcmp(name, DRMAA_TRANSFER_FILES) == 0) {
int count = 0;
for (count = 0; value[count] != '\0'; count++) {
if ((value[count] != 'e') && (value[count] != 'i') &&
(value[count] != 'o')) {
sge_dstring_sprintf(diagp,
"attribute "SFQ" must contain only 'e', 'i', and/or 'o'\n",
DRMAA_TRANSFER_FILES);
DRETURN(DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE);
}
}
}
/* add or replace attribute */
if ((ep = lGetElemStr(jt->strings, VA_variable, name))) {
lSetString(ep, VA_value, value);
} else {
ep = lAddElemStr(&(jt->strings), VA_variable, name, VA_Type);
lSetString(ep, VA_value, value);
}
}
DRETURN(ret);
}
/****** DRMAA/drmaa_get_attribute() **********************************************
* NAME
* drmaa_get_attribute() -- Return job template attribute value.
*
* SYNOPSIS
* int drmaa_get_attribute(drmaa_job_template_t *jt, const char *name, char *value,
* size_t value_len, char *error_diagnosis, size_t error_diag_len)
*
* FUNCTION
* If 'name' is an existing non-vector attribute name in the job
* template 'jt', then the value of 'name' is returned; otherwise,
* DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE is returned.
*
* INPUTS
* drmaa_job_template_t *jt - the job template
* const char *name - the attribute name
*
* OUTPUTS
* char *value - value buffer
* size_t value_len - value buffer length
* char *error_diagnosis - diagnosis buffer
* size_t error_diag_len - diagnosis buffer length
*
* RESULT
* int - returns DRMAA_ERRNO_SUCCESS on success, otherwise
* DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE.
*
* NOTES
* MT-NOTE: drmaa_get_attribute() is MT safe
*******************************************************************************/
int drmaa_get_attribute(drmaa_job_template_t *jt, const char *name, char *value,
size_t value_len, char *error_diagnosis, size_t error_diag_len)
{
dstring val, diag, *diagp = NULL;
lListElem *va = NULL;
int ret = DRMAA_ERRNO_SUCCESS;
DENTER(TOP_LAYER, "drmaa_get_attribute");
if (error_diagnosis) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
diagp = &diag;
}
if ((value == NULL) || (name == NULL) || (jt == NULL)) {
japi_standard_error(DRMAA_ERRNO_INVALID_ARGUMENT, diagp);
DRETURN(DRMAA_ERRNO_INVALID_ARGUMENT);
}
ret = japi_was_init_called(diagp);
if (ret != DRMAA_ERRNO_SUCCESS) {
/* diagp written by japi_was_init_called() */
DRETURN(ret);
}
sge_dstring_init(&val, value, value_len+1);
/* search name in string_vectors */
if (!(va = lGetElemStr(jt->strings, VA_variable, name))) {
japi_standard_error(DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE, diagp);
DRETURN(DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE);
}
sge_dstring_copy_string(&val, lGetString(va, VA_value));
DRETURN(DRMAA_ERRNO_SUCCESS);
}
/****** DRMAA/drmaa_set_vector_attribute() ***************************************
* NAME
* drmaa_set_vector_attribute() -- Set vector attribute in job template
*
* SYNOPSIS
* int drmaa_set_vector_attribute(drmaa_job_template_t *jt, const char *name,
* const char *value[], char *error_diagnosis, size_t error_diag_len)
*
* FUNCTION
* Adds ('name', 'values') pair to list of vector attributes in job template
* 'jt'. Only vector attributes may be passed.
*
* INPUTS
* drmaa_job_template_t *jt - job template
* const char *name - attribute name
* char *value[] - array of string values
*
* OUTPUTS
* char *error_diagnosis - diagnosis buffer
* size_t error_diag_len - diagnosis buffer length
*
* RESULT
* int - returns DRMAA_ERRNO_SUCCESS on success, otherwise
* DRMAA_ERRNO_INVALID_ATTRIBUTE_FORMAT,
* DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE,
* DRMAA_ERRNO_CONFLICTING_ATTRIBUTE_VALUES.
*
* NOTES
* MT-NOTE: drmaa_set_vector_attribute() is MT safe
*******************************************************************************/
int drmaa_set_vector_attribute(drmaa_job_template_t *jt, const char *name,
const char *value[], char *error_diagnosis, size_t error_diag_len)
{
lListElem *sep = NULL, *ep = NULL;
lList *lp = NULL;
dstring diag, *diagp = NULL;
int i;
int ret = DRMAA_ERRNO_SUCCESS;
DENTER(TOP_LAYER, "drmaa_set_vector_attribute");
if (error_diagnosis) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
diagp = &diag;
}
if (!jt || !name || !value ) {
japi_standard_error(DRMAA_ERRNO_INVALID_ARGUMENT, diagp);
DRETURN(DRMAA_ERRNO_INVALID_ARGUMENT);
}
ret = japi_was_init_called(diagp);
if (ret != DRMAA_ERRNO_SUCCESS) {
/* diagp written by japi_was_init_called() */
DRETURN(ret);
}
if (drmaa_is_attribute_supported(name, true, diagp)!=DRMAA_ERRNO_SUCCESS) {
DPRINTF(("setting not supported attribute \"%s\"\n", name));
japi_standard_error(DRMAA_ERRNO_INVALID_ARGUMENT, diagp);
DRETURN(DRMAA_ERRNO_INVALID_ARGUMENT);
}
if ((ep = lGetElemStr(jt->string_vectors, NSV_name, name)) != NULL) {
lSetList(ep, NSV_strings, NULL);
}
else {
ep = lAddElemStr(&(jt->string_vectors), NSV_name, name, NSV_Type);
}
lp = lCreateList(NULL, ST_Type);
for (i=0; value[i] != NULL; i++) {
sep = lCreateElem(ST_Type);
lSetString(sep, ST_name, value[i]);
lAppendElem(lp, sep);
}
lSetList(ep, NSV_strings, lp);
DRETURN(DRMAA_ERRNO_SUCCESS);
}
/****** DRAMA/drmaa_get_vector_attribute() ***************************************
* NAME
* drmaa_get_vector_attribute() -- Return attributes values of a vector attribute.
*
* SYNOPSIS
* int drmaa_get_vector_attribute(drmaa_job_template_t *jt, const char *name,
* drmaa_attr_values_t **values, char *error_diagnosis, size_t error_diag_len)
*
* FUNCTION
* If 'name' is an existing vector attribute name in the job template 'jt',
* then the values of 'name' are returned; otherwise, DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE
* is returned.
*
* INPUTS
* drmaa_job_template_t *jt - the job template
* const char *name - the vector attribute name
*
* OUTPUT
* drmaa_attr_values_t **values - destination string vector
* char *error_diagnosis - diagnosis buffer
* size_t error_diag_len - diagnosis buffer length
*
* RESULT
* int - DRMAA_ERRNO_SUCCESS on success, otherwise
* DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE.
*
* NOTES
* MT-NOTE: drmaa_get_vector_attribute() is MT safe
*******************************************************************************/
int drmaa_get_vector_attribute(drmaa_job_template_t *jt, const char *name,
drmaa_attr_values_t **values, char *error_diagnosis, size_t error_diag_len)
{
lListElem *nsv = NULL;
drmaa_attr_values_t *iter = NULL;
dstring diag, *diagp = NULL;
int ret = DRMAA_ERRNO_SUCCESS;
DENTER(TOP_LAYER, "drmaa_get_vector_attribute");
if (error_diagnosis) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
diagp = &diag;
}
if ((values == NULL) || (name == NULL) || (jt == NULL)) {
japi_standard_error(DRMAA_ERRNO_INVALID_ARGUMENT, diagp);
DRETURN(DRMAA_ERRNO_INVALID_ARGUMENT);
}
ret = japi_was_init_called(diagp);
if (ret != DRMAA_ERRNO_SUCCESS) {
/* diagp written by japi_was_init_called() */
DRETURN(ret);
}
/* search name in string_vectors */
if (!(nsv = lGetElemStr(jt->string_vectors, NSV_name, name))) {
japi_standard_error(DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE, diagp);
DRETURN(DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE);
}
/* allocate iterator */
if (!(iter=japi_allocate_string_vector(JAPI_ITERATOR_STRINGS))) {
japi_standard_error(DRMAA_ERRNO_NO_MEMORY, diagp);
DRETURN(DRMAA_ERRNO_NO_MEMORY);
}
/* copy job template attributes into iterator */
iter->it.si.strings = lCopyList(NULL, lGetList(nsv, NSV_strings));
if (!iter->it.si.strings) {
japi_delete_string_vector(iter);
japi_standard_error(DRMAA_ERRNO_NO_MEMORY, diagp);
DRETURN(DRMAA_ERRNO_NO_MEMORY);
}
/* initialize iterator */
iter->it.si.next_pos = lFirst(iter->it.si.strings);
*values = iter;
DRETURN(DRMAA_ERRNO_SUCCESS);
}
/****** DRMAA/drmaa_get_attribute_names() **************************************
* NAME
* drmaa_get_attribute_names() -- Return supported job template attributes
*
* SYNOPSIS
* int drmaa_get_attribute_names(drmaa_attr_names_t **values, char
* *error_diagnosis, size_t error_diag_len)
*
* FUNCTION
* Returns the set of supported attribute names whose associated
* value type is String. This set will include supported DRMAA reserved
* attribute names and native attribute names.
*
* INPUTS
* drmaa_attr_names_t **values - String vector containing names of supported
* attributes
* char *error_diagnosis - diagnosis buffer
* size_t error_diag_len - diagnosis buffer length
*
* RESULT
* int - returns DRMAA_ERRNO_SUCCESS on success
*
* NOTES
* MT-NOTE: drmaa_get_attribute_names() is MT safe
*******************************************************************************/
int drmaa_get_attribute_names(drmaa_attr_names_t **values, char *error_diagnosis, size_t error_diag_len)
{
int ret;
dstring diag, *diagp = NULL;
drmaa_attr_names_t *iter;
DENTER(TOP_LAYER, "drmaa_get_attribute_names");
if (error_diagnosis) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
diagp = &diag;
}
ret = japi_was_init_called(diagp);
if (ret != DRMAA_ERRNO_SUCCESS) {
/* diagp written by japi_was_init_called() */
DRETURN(ret);
}
if (!(iter=drmaa_fill_supported_nonvector_attributes(diagp))) {
japi_standard_error(DRMAA_ERRNO_NO_MEMORY, diagp);
DRETURN(DRMAA_ERRNO_NO_MEMORY);
}
*values = iter;
DRETURN(DRMAA_ERRNO_SUCCESS);
}
/****** DRMAA/drmaa_get_vector_attribute_names() *******************************
* NAME
* drmaa_get_vector_attribute_names() -- Return supported job template vector
* attributes
*
* SYNOPSIS
* int drmaa_get_vector_attribute_names(drmaa_attr_names_t **values, char
* *error_diagnosis, size_t error_diag_len)
*
* FUNCTION
* Returns the set of supported attribute names whose associated
* value type is String Vector. This set will include supported DRMAA reserved
* attribute names and native attribute names.
*
* INPUTS
* drmaa_attr_names_t **values - String vector containing names of supported
* vector attributes
* char *error_diagnosis - diagnosis buffer
* size_t error_diag_len - diagnosis buffer length
*
* RESULT
* int - returns DRMAA_ERRNO_SUCCESS on success
*
* NOTES
* MT-NOTE: drmaa_get_vector_attribute_names() is MT safe
*******************************************************************************/
int drmaa_get_vector_attribute_names(drmaa_attr_names_t **values, char *error_diagnosis, size_t error_diag_len)
{
dstring diag, *diagp = NULL;
drmaa_attr_names_t *iter = NULL;
int ret = DRMAA_ERRNO_SUCCESS;
DENTER(TOP_LAYER, "drmaa_get_vector_attribute_names");
if (error_diagnosis) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
diagp = &diag;
}
ret = japi_was_init_called(diagp);
if (ret != DRMAA_ERRNO_SUCCESS) {
/* diagp written by japi_was_init_called() */
DRETURN(ret);
}
if (!(iter=drmaa_fill_supported_vector_attributes(diagp))) {
japi_standard_error(DRMAA_ERRNO_NO_MEMORY, diagp);
DRETURN(DRMAA_ERRNO_NO_MEMORY);
}
*values = iter;
DRETURN(DRMAA_ERRNO_SUCCESS);
}
/****** DRMAA/drmaa_run_job() ****************************************************
* NAME
* drmaa_run_job() -- Submit a job
*
* SYNOPSIS
* int drmaa_run_job(char *job_id, size_t job_id_len, const drmaa_job_template_t *jt,
* char *error_diagnosis, size_t error_diag_len)
*
* FUNCTION
* Submit a job with attributes defined in the job template 'jt'.
* The job identifier 'job_id' is a printable, NULL terminated string,
* identical to that returned by the underlying DRM system.
*
* INPUTS
* drmaa_job_template_t *jt - the job template
*
* OUTPUTS
* char *job_id - buffer for resulting jobid
* size_t job_id_len - size of job_id buffer
* char *error_diagnosis - diagnosis buffer
* size_t error_diag_len - diagnosis buffer length
*
* RESULT
* int - returns DRMAA_ERRNO_SUCCESS on success, otherwise
* DRMAA_ERRNO_TRY_LATER, DRMAA_ERRNO_DENIED_BY_DRM,
* DRMAA_ERRNO_DRM_COMMUNICATION_FAILURE, or DRMAA_ERRNO_AUTH_FAILURE.
*
* NOTES
* MT-NOTE: drmaa_run_job() is MT safe
*******************************************************************************/
int drmaa_run_job(char *job_id, size_t job_id_len, const drmaa_job_template_t *jt,
char *error_diagnosis, size_t error_diag_len)
{
dstring diag, *diagp = NULL;
dstring jobid;
int drmaa_errno = DRMAA_ERRNO_SUCCESS;
lListElem *sge_job_template;
bool use_euid_egid;
DENTER(TOP_LAYER, "drmaa_run_job");
if (error_diagnosis) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
diagp = &diag;
}
if ((job_id == NULL) || (jt == NULL)) {
japi_standard_error(DRMAA_ERRNO_INVALID_ARGUMENT, diagp);
DRETURN(DRMAA_ERRNO_INVALID_ARGUMENT);
}
/* per thread initialization */
drmaa_errno = japi_was_init_called(diagp);
if( drmaa_errno != DRMAA_ERRNO_SUCCESS ) {
/* diagp written by japi_was_init_called() */
DRETURN(drmaa_errno);
}
sge_dstring_init(&jobid, job_id, job_id_len+1);
/* convert DRMAA job template into Grid Engine job template */
if ((drmaa_errno=drmaa_job2sge_job(&sge_job_template, jt,
0, 1, 1, 1, &use_euid_egid, diagp))!=DRMAA_ERRNO_SUCCESS) {
/* diag written by drmaa_job2sge_job() */
DRETURN(drmaa_errno);
}
drmaa_errno = japi_run_job(&jobid, &sge_job_template, use_euid_egid, diagp);
lFreeElem(&sge_job_template);
DRETURN(drmaa_errno);
}
/****** DRMAA/drmaa_run_bulk_jobs() ****************************************************
* NAME
* drmaa_run_bulk_jobs() -- Submit a bulk of jobs
*
* SYNOPSIS
* int drmaa_run_bulk_jobs(drmaa_job_ids_t **jobids, const drmaa_job_template_t *jt,
* int start, int end, int incr, char *error_diagnosis, size_t error_diag_len)
*
* FUNCTION
* Submit a set of parametric jobs, dependent on the implied loop index, each
* with attributes defined in the job template 'jt'.
* The job identifiers 'job_ids' are all printable,
* NULL terminated strings, identical to those returned by the underlying
* DRM system. Nonnegative loop bounds are mandated to avoid file names
* that start with minus sign like command line options.
* The special index placeholder is a DRMAA defined string
* drmaa_incr_ph == $incr_pl$
* that is used to construct parametric job templates.
* For example:
* drmaa_set_attribute(pjt, "stderr", drmaa_incr_ph + ".err" ); (C++/java string syntax used)
*
* INPUTS
* drmaa_job_template_t *jt - The job template.
* int start - Start index
* int end - End index
* int incr - Increment
*
* OUTPUTS
* drmaa_job_ids_t **jobids - returns vector of job ids
* char *error_diagnosis - diagnosis buffer
* size_t error_diag_len - diagnosis buffer length
*
* RESULT
* int - returns DRMAA_ERRNO_SUCCESS on success, otherwise DRMAA_ERRNO_TRY_LATER,
* DRMAA_ERRNO_DENIED_BY_DRM, DRMAA_ERRNO_DRM_COMMUNICATION_FAILURE, or
* DRMAA_ERRNO_AUTH_FAILURE.
*
* NOTES
* MT-NOTE: drmaa_run_bulk_jobs() is MT safe
*******************************************************************************/
int drmaa_run_bulk_jobs(drmaa_job_ids_t **jobids, const drmaa_job_template_t *jt,
unsigned start, unsigned end, int incr, char *error_diagnosis, size_t error_diag_len)
{
dstring diag, *diagp = NULL;
int drmaa_errno = DRMAA_ERRNO_SUCCESS;
lListElem *sge_job_template = NULL;
bool use_euid_egid;
DENTER(TOP_LAYER, "drmaa_run_bulk_jobs");
if (error_diagnosis) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
diagp = &diag;
}
if ((jobids == NULL) || (jt == NULL) || (start < 1) || (end < 1) ||
(incr < 1) || (end < start)) {
japi_standard_error(DRMAA_ERRNO_INVALID_ARGUMENT, diagp);
DRETURN(DRMAA_ERRNO_INVALID_ARGUMENT);
}
/* per thread initialization */
drmaa_errno = japi_was_init_called(diagp);
if( drmaa_errno != DRMAA_ERRNO_SUCCESS ) {
/* diagp written by japi_was_init_called() */
DRETURN(drmaa_errno);
}
/* convert DRMAA job template into Grid Engine job template */
drmaa_errno = drmaa_job2sge_job(&sge_job_template, jt, 1, start, end, incr,
&use_euid_egid, diagp);
if (drmaa_errno != DRMAA_ERRNO_SUCCESS) {
/* diag written by drmaa_job2sge_job() */
DRETURN(drmaa_errno);
}
drmaa_errno = japi_run_bulk_jobs((drmaa_attr_values_t **)jobids, &sge_job_template,
start, end, incr, use_euid_egid, diagp);
lFreeElem(&sge_job_template);
DRETURN(drmaa_errno);
}
/****** DRMAA/drmaa_control() ****************************************************
* NAME
* drmaa_control() -- Start, stop, restart, or kill jobs
*
* SYNOPSIS
* int drmaa_control(const char *jobid, int action,
* char *error_diagnosis, size_t error_diag_len)
*
* FUNCTION
* Start, stop, restart, or kill the job identified by 'job_id'.
* If 'job_id' is DRMAA_JOB_IDS_SESSION_ALL, then this routine
* acts on all jobs *submitted* during this DRMAA session.
* The legal values for 'action' and their meanings are:
* DRMAA_CONTROL_SUSPEND: stop the job,
* DRMAA_CONTROL_RESUME: (re)start the job,
* DRMAA_CONTROL_HOLD: put the job on-hold,
* DRMAA_CONTROL_RELEASE: release the hold on the job, and
* DRMAA_CONTROL_TERMINATE: kill the job.
* This routine returns once the action has been acknowledged by
* the DRM system, but does not necessarily wait until the action
* has been completed.
*
* INPUT
* const char *jobid - job id or DRMAA_JOB_IDS_SESSION_ALL
* int action - a DRMAA_CONTROL_* value
*
* OUTPUT
* char *error_diagnosis - diagnosis buffer
* size_t error_diag_len - diagnosis buffer length
*
* RESULT
* int - DRMAA error codes
* DRMAA_ERRNO_SUCCESS
* DRMAA_ERRNO_DRM_COMMUNICATION_FAILURE
* DRMAA_ERRNO_AUTH_FAILURE
* DRMAA_ERRNO_RESUME_INCONSISTENT_STATE
* DRMAA_ERRNO_SUSPEND_INCONSISTENT_STATE
* DRMAA_ERRNO_HOLD_INCONSISTENT_STATE
* DRMAA_ERRNO_RELEASE_INCONSISTENT_STATE
* DRMAA_ERRNO_INVALID_JOB
*
* NOTES
* MT-NOTE: drmaa_control() is MT safe
*******************************************************************************/
int drmaa_control(const char *jobid, int action, char *error_diagnosis, size_t error_diag_len)
{
dstring diag;
if (error_diagnosis != NULL) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
}
return japi_control(jobid, action, error_diagnosis?&diag:NULL);
}
/****** DRMAA/drmaa_synchronize() ****************************************************
* NAME
* drmaa_synchronize() -- Synchronize with jobs to finish
*
* SYNOPSIS
* int drmaa_synchronize(const char *job_ids[], signed long timeout,
* int dispose, char *error_diagnosis, size_t error_diag_len)
*
* FUNCTION
* Wait until all jobs specified by 'job_ids' have finished
* execution. If 'job_ids' is DRMAA_JOB_IDS_SESSION_ALL, then this routine
* waits for all jobs *submitted* during this DRMAA session. To prevent
* blocking indefinitely in this call the caller could use timeout specifying
* after how many seconds to time out in this call.
* If the call exits before timeout all the jobs have been waited on
* or there was an interrupt.
* If the invocation exits on timeout, the return code is DRMAA_ERRNO_EXIT_TIMEOUT.
* The caller should check system time before and after this call
* in order to check how much time has passed.
* Dispose parameter specifies how to treat reaping information:
* True=1 "fake reap", i.e. dispose of the rusage data
* False=0 do not reap
*
* INPUTS
* const char *job_ids[] - vector of jobids to synchronize or
* DRMAA_JOB_IDS_SESSION_ALL
* signed long timeout - timeout in seconds or
* DRMAA_TIMEOUT_WAIT_FOREVER for infinite waiting
* DRMAA_TIMEOUT_NO_WAIT for immediate returning
* int dispose - Whether job finish information shall be reaped (1) or not (0).
*
* OUTPUTS
* char *error_diagnosis - diagnosis buffer
* size_t error_diag_len - diagnosis buffer length
*
* RESULT
* int - returns DRMAA_ERRNO_SUCCESS on success, otherwise
* DRMAA_ERRNO_DRM_COMMUNICATION_FAILURE, DRMAA_ERRNO_AUTH_FAILURE,
* DRMAA_ERRNO_EXIT_TIMEOUT, or DRMAA_ERRNO_INVALID_JOB.
*
* NOTES
* MT-NOTE: drmaa_synchronize() is MT safe
*******************************************************************************/
int drmaa_synchronize(const char *job_ids[], signed long timeout, int dispose,
char *error_diagnosis, size_t error_diag_len)
{
dstring diag;
if (error_diagnosis != NULL) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
}
return japi_synchronize(job_ids, timeout, dispose ? true : false,
error_diagnosis?&diag:NULL);
}
/****** DRMAA/drmaa_wait() ****************************************************
* NAME
* drmaa_wait() -- Wait for job
*
* SYNOPSIS
* int drmaa_wait(const char *job_id, char *job_id_out, size_t job_id_out_len,
* int *stat, signed long timeout, drmaa_attr_values_t **rusage,
* char *error_diagnosis, size_t error_diag_len)
*
* FUNCTION
* This routine waits for a job with job_id to fail or finish execution. Passing a special string
* DRMAA_JOB_IDS_SESSION_ANY instead job_id waits for any job. If such a job was
* successfully waited its job_id is returned as a second parameter. This routine is
* modeled on wait3 POSIX routine. To prevent
* blocking indefinitely in this call the caller could use timeout specifying
* after how many seconds to time out in this call.
* If the call exits before timeout the job has been waited on
* successfully or there was an interrupt.
* If the invocation exits on timeout, the return code is DRMAA_ERRNO_EXIT_TIMEOUT.
* The caller should check system time before and after this call
* in order to check how much time has passed.
* The routine reaps jobs on a successful call, so any subsequent calls
* to drmaa_wait should fail returning an error DRMAA_ERRNO_INVALID_JOB meaning
* that the job has been already reaped. This error is the same as if the job was
* unknown. Failing due to an elapsed timeout has an effect that it is possible to
* issue drmaa_wait multiple times for the same job_id.
*
* INPUTS
* const char *job_id - jobid we're waiting for or DRMAA_JOB_IDS_SESSION_ANY
* signed long timeout - timeout in seconds or
* DRMAA_TIMEOUT_WAIT_FOREVER for infinite waiting
* DRMAA_TIMEOUT_NO_WAIT for immediate returning
*
*
*
* OUTPUTS
* char *job_id - returns job id of waited job on success
* size_t job_id_out - job id buffer size
* char *error_diagnosis - diagnosis buffer on error
* size_t error_diag_len - diagnosis buffer length on error
*
* RESULT
* int - DRMAA_ERRNO_SUCCESS on success, otherwise
* DRMAA_ERRNO_EXIT_TIMEOUT
* No job end within specified time.
*
* DRMAA_ERRNO_INVALID_JOB
* The job id specified was invalid or DRMAA_JOB_IDS_SESSION_ANY has been specified
* and all jobs of this session have already finished.
*
* DRMAA_ERRNO_NO_ACTIVE_SESSION
* No active session.
*
* DRMAA_ERRNO_DRM_COMMUNICATION_FAILURE
* DRMAA_ERRNO_AUTH_FAILURE
*
* NOTES
* MT-NOTE: drmaa_wait() is MT safe
*******************************************************************************/
int drmaa_wait(const char *job_id, char *job_id_out, size_t job_id_out_len,
int *stat, signed long timeout, drmaa_attr_values_t **rusage,
char *error_diagnosis, size_t error_diag_len)
{
dstring diag;
dstring waited_job;
int ev;
if (error_diagnosis != NULL) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
}
if (job_id_out != NULL) {
sge_dstring_init(&waited_job, job_id_out, job_id_out_len+1);
}
return japi_wait(job_id, job_id_out?&waited_job:NULL, stat, timeout,
JAPI_JOB_FINISH, &ev, rusage, error_diagnosis?&diag:NULL);
}
/****** DRMAA/drmaa_job_ps() ****************************************************
* NAME
* drmaa_job_ps() -- Get job status
*
* SYNOPSIS
* int drmaa_job_ps(const char *job_id, int *remote_ps,
* char *error_diagnosis, size_t error_diag_len)
*
* FUNCTION
* Get the program status of the job identified by 'job_id'.
* The possible values returned in 'remote_ps' and their meanings are:
* DRMAA_PS_UNDETERMINED = 00H : process status cannot be determined,
* DRMAA_PS_QUEUED_ACTIVE = 10H : job is queued and active,
* DRMAA_PS_SYSTEM_ON_HOLD = 11H : job is queued and in system hold,
* DRMAA_PS_USER_ON_HOLD = 12H : job is queued and in user hold,
* DRMAA_PS_USER_SYSTEM_ON_HOLD = 13H : job is queued and in user and system hold,
* DRMAA_PS_RUNNING = 20H : job is running,
* DRMAA_PS_SYSTEM_SUSPENDED = 21H : job is system suspended,
* DRMAA_PS_USER_SUSPENDED = 22H : job is user suspended,
* DRMAA_PS_USER_SYSTEM_SUSPENDED = 23H : job is user and system suspended,
* DRMAA_PS_DONE = 30H : job finished normally, and
* DRMAA_PS_FAILED = 40H : job finished, but failed.
*
* INPUTS
* const char *job_id - Job id of job to retrieve status.
*
* OUTPUTS
* int *remote_ps - One of the DRMAA_PS_* constants.
* char *error_diagnosis - diagnosis buffer
* size_t error_diag_len - diagnosis buffer length
*
* RESULT
* int - returns DRMAA_ERRNO_SUCCESS on success, otherwise
* DRMAA_ERRNO_DRM_COMMUNICATION_FAILURE, DRMAA_ERRNO_AUTH_FAILURE,
* or DRMAA_ERRNO_INVALID_JOB.
*
* NOTES
* MT-NOTE: drmaa_job_ps() is MT safe
*******************************************************************************/
int drmaa_job_ps(const char *job_id, int *remote_ps, char *error_diagnosis, size_t error_diag_len)
{
dstring diag;
if (error_diagnosis != NULL) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
}
return japi_job_ps(job_id, remote_ps, error_diagnosis?&diag:NULL);
}
/****** DRMAA/drmaa_wifexited() ************************************************
* NAME
* drmaa_wifexited() -- Has job terminated normally?
*
* SYNOPSIS
* int drmaa_wifexited(int *exited, int stat, char *error_diagnosis, size_t
* error_diag_len)
*
* FUNCTION
* Evaluates into 'exited' a non-zero value if stat was returned for a job
* that terminated normally. A zero value can also indicate that altough the
* job has terminated normally an exit status is not available or that it is
* not known whether the job terminated normally. In both cases drmaa_wexitstatus()
* will not provide exit status information. A non-zero 'exited' value indicates
* more detailed diagnosis can be provided by means of drmaa_wifsignaled(),
* drmaa_wtermsig() and drmaa_wcoredump().
*
* INPUTS
* int stat - The stat value returned by drmaa_wait()
*
* OUTPUTS
* int *exited - Returns 0 or 1.
* char *error_diagnosis - diagnosis buffer
* size_t error_diag_len - diagnosis buffer length
*
* RESULT
* int - Returns DRMAA_ERRNO_SUCCESS on success.
*
* NOTES
* MT-NOTE: drmaa_wifexited() is MT safe
*******************************************************************************/
int drmaa_wifexited(int *exited, int stat, char *error_diagnosis, size_t error_diag_len)
{
dstring diag;
dstring *diagp = NULL;
int ret = DRMAA_ERRNO_SUCCESS;
if (error_diagnosis != NULL) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
diagp = &diag;
}
ret = japi_was_init_called(diagp);
if (ret != DRMAA_ERRNO_SUCCESS) {
/* diagp written by japi_was_init_called() */
return ret;
}
return japi_wifexited(exited, stat, error_diagnosis?&diag:NULL);
}
/****** DRMAA/drmaa_wexitstatus() **********************************************
* NAME
* drmaa_wexitstatus() -- Return job exit status
*
* SYNOPSIS
* int drmaa_wexitstatus(int *exit_status, int stat, char *error_diagnosis,
* size_t error_diag_len)
*
* FUNCTION
* If the OUT parameter 'exited' of drmaa_wifexited() is non-zero, this function
* evaluates into 'exit_code' the exit code that the job passed to _exit()
* (see exit(2)) or exit(3C), or the value that the child process returned from main.
*
* INPUTS
* int stat - The stat value returned by drmaa_wait()
*
* OUTPUTS
* int *exit_status - Exit status.
* char *error_diagnosis - diagnosis buffer
* size_t error_diag_len - diagnosis buffer length
*
* RESULT
* int - Returns DRMAA_ERRNO_SUCCESS on success.
*
* NOTES
* MT-NOTE: drmaa_wexitstatus() is MT safe
*******************************************************************************/
int drmaa_wexitstatus(int *exit_status, int stat, char *error_diagnosis, size_t error_diag_len)
{
dstring diag;
dstring *diagp = NULL;
int ret = DRMAA_ERRNO_SUCCESS;
if (error_diagnosis != NULL) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
diagp = &diag;
}
ret = japi_was_init_called(diagp);
if (ret != DRMAA_ERRNO_SUCCESS) {
/* diagp written by japi_was_init_called() */
return ret;
}
return japi_wexitstatus(exit_status, stat, error_diagnosis?&diag:NULL);
}
/****** DRMAA/drmaa_wifsignaled() **********************************************
* NAME
* drmaa_wifsignaled() -- Has job terminated due to a signal?
*
* SYNOPSIS
* int drmaa_wifsignaled(int *signaled, int stat, char *error_diagnosis,
* size_t error_diag_len)
*
* FUNCTION
* Evaluates into 'signaled' a non-zero value if status was returned for a job
* that terminated due to the receipt of a signal. A zero value can also indicate
* that altough the job has terminated due to the receipt of a signal the signal
* is not available or that it is not known whether the job terminated due to the
* receipt of a signal. In both cases drmaa_wtermsig() will not provide signal
* information.
*
* INPUTS
* int stat - The stat value returned by drmaa_wait()
*
* OUTPUTS
* int *signaled - Returns 0 or 1.
* char *error_diagnosis - diagnosis buffer
* size_t error_diag_len - diagnosis buffer length
*
* RESULT
* int - Returns DRMAA_ERRNO_SUCCESS on success.
*
* NOTES
* MT-NOTE: drmaa_wifsignaled() is MT safe
*******************************************************************************/
int drmaa_wifsignaled(int *signaled, int stat, char *error_diagnosis, size_t error_diag_len)
{
dstring diag;
dstring *diagp = NULL;
int ret = DRMAA_ERRNO_SUCCESS;
if (error_diagnosis != NULL) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
diagp = &diag;
}
ret = japi_was_init_called(diagp);
if (ret != DRMAA_ERRNO_SUCCESS) {
/* diagp written by japi_was_init_called() */
return ret;
}
return japi_wifsignaled(signaled, stat, error_diagnosis?&diag:NULL);
}
/****** DRMAA/drmaa_wtermsig() *************************************************
* NAME
* drmaa_wtermsig() -- Return signal that caused job termination.
*
* SYNOPSIS
* int drmaa_wtermsig(char *signal, size_t signal_len, int stat, char
* *error_diagnosis, size_t error_diag_len)
*
* FUNCTION
* If the OUT parameter 'signaled' of drmaa_wifsignaled(stat) is non-zero,
* this function evaluates into signal a string representation of the signal that
* caused the termination of the job. For signals declared by POSIX, the symbolic
* names are returned (e.g., SIGABRT, SIGALRM). For signals not declared by POSIX,
* any other string may be returned.
*
* INPUTS
* int stat - The stat value returned by drmaa_wait()
*
* OUTPUTS
* char *signal - Signal string buffer.
* size_t signal_len - Signal string buffer lenght.
* char *error_diagnosis - diagnosis buffer
* size_t error_diag_len - diagnosis buffer length
*
* RESULT
* int - Returns DRMAA_ERRNO_SUCCESS on success.
*
* NOTES
* MT-NOTE: drmaa_wifsignaled() is MT safe
*******************************************************************************/
int drmaa_wtermsig(char *signal, size_t signal_len, int stat, char *error_diagnosis, size_t error_diag_len)
{
dstring sig, diag;
dstring *diagp = NULL;
int ret = DRMAA_ERRNO_SUCCESS;
if (error_diagnosis != NULL) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
diagp = &diag;
}
ret = japi_was_init_called(diagp);
if (ret != DRMAA_ERRNO_SUCCESS) {
/* diagp written by japi_was_init_called() */
return ret;
}
if (signal != NULL) {
sge_dstring_init(&sig, signal, signal_len+1);
}
return japi_wtermsig(signal?&sig:NULL, stat, error_diagnosis?&diag:NULL);
}
/****** DRMAA/drmaa_wcoredump() ************************************************
* NAME
* drmaa_wcoredump() -- Was a core image created.
*
* SYNOPSIS
* int drmaa_wcoredump(int *core_dumped, int stat, char *error_diagnosis,
* size_t error_diag_len)
*
* FUNCTION
* If the OUT parameter 'signaled' of drmaa_wifsignaled(stat) is non-zero,
* this function evaluates into 'core_dumped' a non-zero value if a core image
* of the terminated job was created.
*
* INPUTS
* int stat - The stat value returned by drmaa_wait()
*
* OUTPUTS
* int *core_dumped - Returns 0 or 1.
* char *error_diagnosis - diagnosis buffer
* size_t error_diag_len - diagnosis buffer length
*
* RESULT
* int - Returns DRMAA_ERRNO_SUCCESS on success.
*
* NOTES
* MT-NOTE: drmaa_wcoredump() is MT safe
*******************************************************************************/
int drmaa_wcoredump(int *core_dumped, int stat, char *error_diagnosis, size_t error_diag_len)
{
dstring diag;
dstring *diagp = NULL;
int ret = DRMAA_ERRNO_SUCCESS;
if (error_diagnosis != NULL) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
diagp = &diag;
}
ret = japi_was_init_called(diagp);
if (ret != DRMAA_ERRNO_SUCCESS) {
/* diagp written by japi_was_init_called() */
return ret;
}
return japi_wifcoredump(core_dumped, stat, error_diagnosis?&diag:NULL);
}
/****** drmaa/drmaa_wifaborted() ***********************************************
* NAME
* drmaa_wifaborted() -- Did the job ever run?
*
* SYNOPSIS
* int drmaa_wifaborted(int *aborted, int stat, char *error_diagnosis,
* size_t error_diag_len)
*
* FUNCTION
* Evaluates into 'aborted' a non-zero value if 'stat' was returned for
* a job that ended before entering the running state.
*
* INPUTS
* int stat - The stat value returned by drmaa_wait()
*
* OUTPUTS
* int *aborted - Returns 0 or 1.
* char *error_diagnosis - diagnosis buffer
* size_t error_diag_len - diagnosis buffer length
*
* RESULT
* int - Returns DRMAA_ERRNO_SUCCESS on success.
*
* NOTES
* MT-NOTE: drmaa_wifaborted() is MT safe
*******************************************************************************/
int drmaa_wifaborted(int *aborted, int stat, char *error_diagnosis, size_t error_diag_len)
{
dstring diag;
dstring *diagp = NULL;
int ret = DRMAA_ERRNO_SUCCESS;
if (error_diagnosis != NULL) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
diagp = &diag;
}
ret = japi_was_init_called(diagp);
if (ret != DRMAA_ERRNO_SUCCESS) {
/* diagp written by japi_was_init_called() */
return ret;
}
return japi_wifaborted(aborted, stat, error_diagnosis?&diag:NULL);
}
/****** DRMAA/drmaa_strerror() ****************************************************
* NAME
* drmaa_strerror() -- Convert DRMAA error codes into string representation
*
* SYNOPSIS
* void drmaa_strerror(int drmaa_errno, char *error_string, int error_len)
*
* FUNCTION
* Returns readable text version of errno (constant string)
*
* INPUTS
* int drmaa_errno - DRMAA errno number.
*
* RESULT
* const char * - Returns string representation of errno.
*
* NOTES
* MT-NOTE: drmaa_strerror() is MT safe
*******************************************************************************/
const char *drmaa_strerror(int drmaa_errno)
{
return japi_strerror(drmaa_errno);
}
/****** DRMAA/drmaa_get_next_attr_value() ***************************************
* NAME
* drmaa_get_next_attr_value() -- Get next entry from attribute name vector.
*
* SYNOPSIS
* int drmaa_get_next_attr_value(drmaa_attr_values_t* values, char *value, size_t
* value_len)
*
* FUNCTION
* Returns the next entry from attribute value vector.
*
* INPUTS
* drmaa_attr_values_t* values - The attribute value vector.
*
* OUTPUTS
* char *value - Buffer for the entry.
* size_t value_len - Buffer length.
*
* RESULT
* int - DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE if no more entries
* or DRMAA_ERRNO_SUCCESS
*
* NOTES
* MT-NOTE: drmaa_get_next_attr_value() is MT safe
*******************************************************************************/
int drmaa_get_next_attr_value(drmaa_attr_values_t* values, char *value, size_t value_len)
{
dstring val;
if (value != NULL) {
sge_dstring_init(&val, value, value_len+1);
}
return japi_string_vector_get_next(values, value?&val:NULL);
}
/****** DRMAA/drmaa_get_next_attr_name() ***************************************
* NAME
* drmaa_get_next_attr_name() -- Get next entry from attribute name vector.
*
* SYNOPSIS
* int drmaa_get_next_attr_name(drmaa_attr_names_t* values, char *value, size_t
* value_len)
*
* FUNCTION
* Returns the next entry from attribute name vector.
*
* INPUTS
* drmaa_attr_names_t* values - The attribute name vector.
*
* OUTPUTS
* char *value - Buffer for the entry.
* size_t value_len - Buffer length.
*
* RESULT
* int - DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE if no more entries
* or DRMAA_ERRNO_SUCCESS
*
* NOTES
* MT-NOTE: drmaa_get_next_attr_name() is MT safe
*******************************************************************************/
int drmaa_get_next_attr_name(drmaa_attr_names_t* values, char *value, size_t value_len)
{
dstring val;
if (value != NULL) {
sge_dstring_init(&val, value, value_len+1);
}
return japi_string_vector_get_next((drmaa_attr_values_t*)values, value?&val:NULL);
}
/****** DRMAA/drmaa_get_next_job_id() ***************************************
* NAME
* drmaa_get_next_job_id() -- Get next entry from job id vector.
*
* SYNOPSIS
* int drmaa_get_next_job_id(drmaa_job_ids_t* values, char *value, size_t
* value_len)
*
* FUNCTION
* Returns the next entry from job id vector.
*
* INPUTS
* drmaa_job_ids_t* values - The job id name vector.
*
* OUTPUTS
* char *value - Buffer for the entry.
* size_t value_len - Buffer length.
*
* RESULT
* int - DRMAA_ERRNO_INVALID_ATTRIBUTE_VALUE if no more entries
* or DRMAA_ERRNO_SUCCESS
*
* NOTES
* MT-NOTE: drmaa_get_next_job_id() is MT safe
*******************************************************************************/
int drmaa_get_next_job_id(drmaa_job_ids_t* values, char *value, size_t value_len)
{
dstring val;
if (value != NULL) {
sge_dstring_init(&val, value, value_len+1);
}
return japi_string_vector_get_next((drmaa_attr_values_t*)values, value?&val:NULL);
}
/****** DRMAA/drmaa_get_num_attr_names() **************************************
* NAME
* drmaa_get_num_attr_names() -- Get the number of entries in the vector
*
* SYNOPSIS
* void drmaa_get_num_attr_names(drmaa_attr_values_t* values, int *size)
*
* FUNCTION
* Get the number of entries in the name vector.
*
* INPUTS
* drmaa_attr_values_t* values - The attribute value vector.
*
* OUTPUTS
* int - DRMAA error code
* NOTES
* MT-NOTE: drmaa_get_num_attr_names() is MT safe
*******************************************************************************/
int drmaa_get_num_attr_names(drmaa_attr_names_t* values, int *size)
{
return japi_string_vector_get_num((drmaa_attr_values_t*)values, size);
}
/****** DRMAA/drmaa_get_num_attr_values() **************************************
* NAME
* drmaa_get_num_attr_values() -- Get the number of entries in the vector
*
* SYNOPSIS
* void drmaa_get_num_attr_values(drmaa_attr_values_t* values, int *size)
*
* FUNCTION
* Get the number of entries in the value vector.
*
* INPUTS
* drmaa_attr_values_t* values - The attribute value vector.
*
* OUTPUTS
* int - DRMAA error code
* NOTES
* MT-NOTE: drmaa_get_num_attr_values() is MT safe
*******************************************************************************/
int drmaa_get_num_attr_values(drmaa_attr_values_t* values, int *size)
{
return japi_string_vector_get_num((drmaa_attr_values_t*)values, size);
}
/****** DRMAA/drmaa_get_num_job_ids() **************************************
* NAME
* drmaa_get_num_job_ids() -- Get the number of entries in the vector
*
* SYNOPSIS
* void drmaa_get_num_job_ids(drmaa_attr_values_t* values, int *size)
*
* FUNCTION
* Get the number of entries in the id vector.
*
* INPUTS
* drmaa_attr_values_t* values - The attribute id vector.
*
* OUTPUTS
* int - DRMAA error code
* NOTES
* MT-NOTE: drmaa_get_num_job_ids() is MT safe
*******************************************************************************/
int drmaa_get_num_job_ids(drmaa_job_ids_t* values, int *size)
{
return japi_string_vector_get_num((drmaa_attr_values_t*)values, size);
}
/****** DRMAA/drmaa_release_attr_values() **************************************
* NAME
* drmaa_release_attr_values() -- Release attribute value vector
*
* SYNOPSIS
* void drmaa_release_attr_values(drmaa_attr_values_t* values)
*
* FUNCTION
* Release resources used by attribute value vector.
*
* INPUTS
* drmaa_attr_values_t* values - The attribute value vector.
*
* NOTES
* MT-NOTE: drmaa_release_attr_values() is MT safe
*******************************************************************************/
void drmaa_release_attr_values(drmaa_attr_values_t* values)
{
japi_delete_string_vector(values);
}
/****** DRMAA/drmaa_release_attr_names() **************************************
* NAME
* drmaa_release_attr_names() -- Release attribute name vector
*
* SYNOPSIS
* void drmaa_release_attr_names(drmaa_attr_names_t* values)
*
* FUNCTION
* Release resources used by attribute name vector.
*
* INPUTS
* drmaa_attr_names_t* values - The attribute name vector.
*
* NOTES
* MT-NOTE: drmaa_release_attr_names() is MT safe
*******************************************************************************/
void drmaa_release_attr_names(drmaa_attr_names_t* values)
{
japi_delete_string_vector((drmaa_attr_values_t*)values);
}
/****** DRMAA/drmaa_release_job_ids() **************************************
* NAME
* drmaa_release_job_ids() -- Release job id vector
*
* SYNOPSIS
* void drmaa_release_job_ids(drmaa_job_ids_t* values)
*
* FUNCTION
* Release resources used by job id vector.
*
* INPUTS
* drmaa_job_ids_t* values - The job id vector.
*
* NOTES
* MT-NOTE: drmaa_release_job_ids() is MT safe
*******************************************************************************/
void drmaa_release_job_ids(drmaa_job_ids_t* values)
{
japi_delete_string_vector((drmaa_attr_values_t*)values);
}
/****** DRMAA/drmaa_get_DRM_system() *******************************************
* NAME
* drmaa_get_DRM_system() -- Return DRM system information
*
* SYNOPSIS
* int drmaa_get_DRM_system(char *drm_system, size_t drm_system_len, char
* *error_diagnosis, size_t error_diag_len)
*
* FUNCTION
* Returns SGE system information. The output contains the
* DRM name and release information.
*
* OUTPUTS
* char *drm_system - Buffer for the DRM system name.
* size_t drm_system_len - Buffer length.
* char *error_diagnosis - Buffer for error diagnosis information.
* size_t error_diag_len - Buffer length.
*
* RESULT
* int - DRMAA_ERRNO_INTERNAL_ERROR on error or DRMAA_ERRNO_SUCCESS
*
* NOTES
* MT-NOTE: drmaa_get_DRM_system() is MT safe
*******************************************************************************/
int drmaa_get_DRM_system(char *drm_system, size_t drm_system_len,
char *error_diagnosis, size_t error_diag_len)
{
/* Since we will only ever support one DRM, namely SGE, it doesn't make any
* difference whether drmaa_get_DRM_system() is called before or after
* drmaa_init(). We will always return the same string. */
dstring drm;
dstring diag;
dstring *diagp = NULL;
int drmaa_errno = DRMAA_ERRNO_SUCCESS;
if (error_diagnosis != NULL) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len + 1);
diagp = &diag;
}
if (drm_system != NULL) {
sge_dstring_init(&drm, drm_system, drm_system_len + 1);
drmaa_errno = japi_get_drm_system(&drm, diagp, DRMAA);
}
/* This will change the previous behavior for this method, so we have to make it
* specific to the new library version. */
else {
drmaa_errno = DRMAA_ERRNO_INVALID_ARGUMENT;
japi_standard_error(drmaa_errno, diagp);
}
return drmaa_errno;
}
/****** DRMAA/drmaa_get_DRMAA_implementation() *********************************
* NAME
* drmaa_get_DRMAA_implementation() -- Return DRMAA system information
*
* SYNOPSIS
* int drmaa_get_DRMAA_implementation(char *drm_impl, size_t drm_impl_len,
* char *error_diagnosis, size_t error_diag_len)
*
* FUNCTION
* Returns SGE implementation information. The output is the same as that of
* the drmaa_get_DRM_system() call.
*
* OUTPUTS
* char *drmaa_impl - Buffer for the DRMAA system name.
* size_t drmaa_impl_len - Buffer length.
* char *error_diagnosis - Buffer for error diagnosis information.
* size_t error_diag_len - Buffer length.
*
* RESULT
* int - DRMAA_ERRNO_INTERNAL_ERROR on error or DRMAA_ERRNO_SUCCESS
*
* NOTES
* MT-NOTE: drmaa_get_DRMAA_implementation() is MT safe
*******************************************************************************/
int drmaa_get_DRMAA_implementation(char *drmaa_impl, size_t drmaa_impl_len,
char *error_diagnosis, size_t error_diag_len)
{
/* Since we will only ever support one DRM, namely SGE, it doesn't make any
* difference whether drmaa_get_DRM_system() is called before or after
* drmaa_init(). We will always return the same string. */
int drmaa_errno = DRMAA_ERRNO_SUCCESS;
/* Because the DRMAA implementation is inherently bound to the DRM version,
* there is no need to distinguish between them. Version information can be
* gotten from drmaa_version() and language information is self-evident. */
drmaa_errno = drmaa_get_DRM_system(drmaa_impl, drmaa_impl_len,
error_diagnosis, error_diag_len);
return drmaa_errno;
}
/****** DRMAA/drmaa_get_contact() **********************************************
* NAME
* drmaa_get_contact() -- Return current (session) contact information.
*
* SYNOPSIS
* int drmaa_get_contact(char *contact, size_t contact_len, char
* *error_diagnosis, size_t error_diag_len)
*
* FUNCTION
* Return current (session) contact information.
*
* INPUTS
* char *contact - Buffer for contact string.
* size_t contact_len - Buffer length.
* char *error_diagnosis - Buffer for error diagnosis information.
* size_t error_diag_len - Buffer length.
*
* RESULT
* int - DRMAA_ERRNO_INTERNAL_ERROR on error or DRMAA_ERRNO_SUCCESS
*
* NOTES
* MT-NOTE: drmaa_get_contact() is MT safe
*******************************************************************************/
int drmaa_get_contact(char *contact, size_t contact_len,
char *error_diagnosis, size_t error_diag_len)
{
dstring con;
dstring diag;
dstring *diagp = NULL;
int drmaa_errno = DRMAA_ERRNO_SUCCESS;
if (error_diagnosis != NULL) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
diagp = &diag;
}
if (contact != NULL) {
sge_dstring_init(&con, contact, contact_len + 1);
drmaa_errno = japi_get_contact(&con, diagp);
/* On failure, diag is populated by japi_get_contact(). */
}
/* This will change the previous behavior for this method, so we have to make it
* specific to the new library version. */
else {
drmaa_errno = DRMAA_ERRNO_INVALID_ARGUMENT;
japi_standard_error(drmaa_errno, diagp);
}
return drmaa_errno;
}
/****** DRMAA/drmaa_version() **************************************************
* NAME
* drmaa_version() -- Return DRMAA version information.
*
* SYNOPSIS
* int drmaa_version(unsigned int *major, unsigned int *minor, char
* *error_diagnosis, size_t error_diag_len)
*
* FUNCTION
* Returns the major and minor version numbers of the DRMAA library.
*
* INPUTS
* unsigned int *major - Major number.
* unsigned int *minor - Minor number.
*
* OUTPUTS
* char *error_diagnosis - Buffer for error diagnosis information.
* size_t error_diag_len - Buffer length.
*
* RESULT
* int - DRMAA_ERRNO_INTERNAL_ERROR on error or DRMAA_ERRNO_SUCCESS
*
* NOTES
* MT-NOTE: drmaa_version() is MT safe
*******************************************************************************/
int drmaa_version(unsigned int *major, unsigned int *minor,
char *error_diagnosis, size_t error_diag_len)
{
dstring diag;
if (error_diagnosis != NULL) {
sge_dstring_init(&diag, error_diagnosis, error_diag_len+1);
}
if (major != NULL) {
*major = 1;
}
if (minor != NULL) {
*minor = 0;
}
return DRMAA_ERRNO_SUCCESS;
}
/****** DRMAA/drmaa_path2wd_opt() **********************************************
* NAME
* drmaa_path2wd_opt() -- Transform a DRMAA job path into SGE
* qsub style -wd option
*
* SYNOPSIS
* static int drmaa_path2wd_opt(const lList *attrs, lList **args, int is_bulk,
* dstring *diag)
*
* FUNCTION
* Transform a DRMAA job path into SGE qsub style -wd option. The following
* substitutions are performed
*
* $drmaa_hd_ph$ --> $HOME
* $drmaa_incr_ph$ --> $TASK_ID
*
* The $drmaa_incr_ph$ substitutions are performed only for bulk jobs
* otherwise submission fails.
*
* INPUTS
* lList* attrs - the DRMAA job attribute list (drmaa_jt->strings)
* lList *args - the list to which to append the switch
* int is_bulk - 1 for bulk jobs 0 otherwise
* path
* dstring *diag - diagnosis inforation
*
* RESULT
* static int - DRMAA error codes
*
* NOTES
* MT-NOTE: drmaa_path2wd_opt() is MT safe
*******************************************************************************/
static int drmaa_path2wd_opt(const lList *attrs, lList **args, int is_bulk,
dstring *diag)
{
const char *new_path = NULL;
int drmaa_errno;
DENTER(TOP_LAYER, "drmaa_path2wd_opt");
if ((drmaa_errno = drmaa_path2sge_path(attrs, is_bulk,
DRMAA_WD, 0, &new_path,
diag)) == DRMAA_ERRNO_SUCCESS) {
if (new_path != NULL) {
lListElem *ep = lGetElemStr(attrs, VA_variable, DRMAA_WD);
const char *value = lGetString(ep, VA_value);
DPRINTF(("-wd = \"%s\"\n", new_path));
ep = sge_add_arg(args, wd_OPT, lStringT, "-wd", value);
lSetString(ep, SPA_argval_lStringT, new_path);
sge_free(&new_path);
}
else {
drmaa_errno = DRMAA_ERRNO_SUCCESS;
}
}
DRETURN(drmaa_errno);
}
/****** DRMAA/drmaa_path2path_opt() ********************************************
* NAME
* drmaa_path2sge_job() -- Transform a DRMAA job path into SGE qsub style
* path option
*
* SYNOPSIS
* static int drmaa_path2path_opt(const lList *attrs, lList **args,
* int is_bulk, const char *attribute_key,
* const char *sw, int opt, dstring *diag)
*
* FUNCTION
* Transform a DRMAA job path into SGE qsub style path option. The following
* substitutions are performed
*
* $drmaa_hd_ph$ --> $HOME
* $drmaa_wd_ph$ --> $CWD
* $drmaa_incr_ph$ --> $TASK_ID
*
* The $drmaa_incr_ph$ substitutions are performed only for bulk jobs
* otherwise submission fails.
*
* INPUTS
* lList* attrs - the DRMAA job attribute list (drmaa_jt->strings)
* lList *args - the list to which to append the switch
* int is_bulk - 1 for bulk jobs 0 otherwise
* const char *attribute_key - The DRMAA job template keyword for this
* path
* const char *sw - The qsub switch to store this under
* int *opt - The type to store this under
* dstring *diag - diagnosis inforation
*
* RESULT
* static int - DRMAA error codes
*
* NOTES
* MT-NOTE: drmaa_path2path_opt() is MT safe
*******************************************************************************/
static int drmaa_path2path_opt(const lList *attrs, lList **args, int is_bulk,
const char *attribute_key, const char *sw,
int opt, dstring *diag, bool bFileStaging )
{
const char *new_path = NULL;
int drmaa_errno;
lList *path_list = lCreateList("path_list", PN_Type);
const char *unqualified_hostname = ctx->get_unqualified_hostname(ctx);
DENTER(TOP_LAYER, "drmaa_path2path_opt");
if (path_list == NULL) {
japi_standard_error(DRMAA_ERRNO_NO_MEMORY, diag);
DRETURN(DRMAA_ERRNO_INTERNAL_ERROR);
}
if ((drmaa_errno = drmaa_path2sge_path(attrs, is_bulk,
attribute_key, 1, &new_path,
diag)) == DRMAA_ERRNO_SUCCESS) {
if (new_path) {
lListElem *ep = lGetElemStr(attrs, VA_variable, attribute_key);
const char *value = lGetString(ep, VA_value);
char *cell = NULL;
char *path = NULL;
/* We must accept an empty path. This must be set to the default
* path later.
* A empty path means that the drmaa attribute is not set, so it
* obviously doesn't have to start with a colon.
*/
if( strlen( new_path )==0 ) {
path = "";
} else if (new_path[0] == ':') { /* :path */
path = (char *)new_path + 1;
} else if ((path = strstr(new_path, ":"))){ /* host:path */
path[0] = '\0';
cell = strdup(new_path);
path[0] = ':';
path += 1;
} else { /* path */
/* DRMAA-Spec says: The path MUST begin with a colon! */
sge_dstring_sprintf(diag, MSG_DRMAA_PATH_NEEDS_COLON_S, attribute_key);
DRETURN(DRMAA_ERRNO_INVALID_ARGUMENT);
}
ep = lCreateElem(PN_Type);
lAppendElem(path_list, ep);
DPRINTF(("PN_path = \"%s\"\n", path));
if( strlen( path )>0 ) {
lSetString( ep, PN_path, path );
} else if( !strcmp( sw, "-i" ) && bFileStaging==true ) {
/* No default stdin_path for file staging! */
sge_dstring_sprintf(diag, "%s", MSG_DRMAA_NEEDS_INPUT_PATH);
drmaa_errno = DRMAA_ERRNO_INVALID_ARGUMENT;
}
if( cell ) {
DPRINTF(( "PN_file_host = \"%s\"\n", cell ));
lSetHost( ep, PN_file_host, cell );
sge_free(&cell);
} else {
/* No host was given, so we use this host we are running on.*/
lSetHost( ep, PN_file_host, unqualified_hostname);
}
DPRINTF(("FileStaging = %d\n", bFileStaging));
lSetBool(ep, PN_file_staging, bFileStaging);
DPRINTF(("Adding args\n"));
ep = sge_add_arg(args, opt, lListT, sw, value);
DPRINTF(("Setting List\n"));
lSetList(ep, SPA_argval_lListT, path_list);
path_list = NULL; /* must not free it later */
DPRINTF(("Freeing Path\n"));
sge_free(&new_path);
} else {
drmaa_errno = DRMAA_ERRNO_SUCCESS;
}
}
lFreeList(&path_list);
DRETURN(drmaa_errno);
}
/****** DRMAA/drmaa_path2sge_path() ********************************************
* NAME
* drmaa_path2sge_path() -- Transform a DRMAA job path into SGE
* counterpart
*
* SYNOPSIS
* static int drmaa_path2sge_path(const lList *attrs, int is_bulk,
* const char *attribute_key, int do_wd,
* const char **new_path, dstring *diag)
*
* FUNCTION
* Transform a DRMAA job path into SGE counterpart. The following
* substitutions are performed
*
* $drmaa_hd_ph$ --> $HOME
* $drmaa_wd_ph$ --> $CWD
* $drmaa_incr_ph$ --> $TASK_ID
*
* The $drmaa_incr_ph$ substitutions are performed only for bulk jobs
* otherwise submission fails.
*
* INPUTS
* lList* attrs - the DRMAA job attribute list (drmaa_jt->strings)
* int is_bulk - 1 for bulk jobs 0 otherwise
* const char *attribute_key - The DRMAA job template keyword for this
* path
* int do_wd - whether the WD placeholder should be used
* char **new_path - The modified path
* dstring *diag - diagnosis inforation
*
* RESULT
* static int - DRMAA error codes
*
* NOTES
* MT-NOTE: drmaa_path2sge_path() is MT safe
*******************************************************************************/
static int drmaa_path2sge_path(const lList *attrs, int is_bulk,
const char *attribute_key, int do_wd,
const char **new_path, dstring *diag)
{
lListElem *ep = NULL;
DENTER(TOP_LAYER, "drmaa_path2sge_path");
if ((ep=lGetElemStr(attrs, VA_variable, attribute_key ))) {
dstring ds = DSTRING_INIT;
const char *p = NULL;
const char *value = lGetString(ep, VA_value);
/* Only look for a hostname if the WD placeholder is being processed, i.e.
* if we're processing a working directory path. */
if (do_wd) {
/* substitute DRMAA placeholder with grid engine counterparts */
p = strchr(value, ':');
/* If there is a colon, skip past it */
if (p != NULL) {
sge_dstring_append_char(&ds, ':');
value = p + 1;
}
}
/* If there is no colon, we assume that the calling function will deal
* with the problem since we can't know who's doing the calling and
* whether there has to be a colon or not. */
/* home directory and working directory placeholder only recognized at the
* begin */
if (strncmp(value, DRMAA_PLACEHOLDER_HD,
strlen(DRMAA_PLACEHOLDER_HD)) == 0) {
sge_dstring_append(&ds, "$HOME/");
value += strlen(DRMAA_PLACEHOLDER_HD);
}
else if (strncmp(value, DRMAA_PLACEHOLDER_WD,
strlen(DRMAA_PLACEHOLDER_WD)) == 0) {
if (do_wd) {
sge_dstring_append(&ds, "./");
value += strlen(DRMAA_PLACEHOLDER_WD);
}
else {
sge_dstring_free(&ds);
sge_dstring_sprintf(diag, "working directory placeholder "SFQ" is not allowed "
"in the working directory path\n", DRMAA_PLACEHOLDER_WD);
DRETURN(DRMAA_ERRNO_DENIED_BY_DRM);
}
}
/* bulk job index placeholder recognized at any position */
if ((p=strstr(value, DRMAA_PLACEHOLDER_INCR))) {
if (!is_bulk) {
/* reject incr placeholder for non-array jobs */
sge_dstring_free(&ds);
sge_dstring_sprintf(diag, "increment placeholder "SFQ" is only allowed in pathes "
"for bulk jobs\n", DRMAA_PLACEHOLDER_INCR);
DRETURN(DRMAA_ERRNO_DENIED_BY_DRM);
}
if (p != value) {
sge_dstring_sprintf_append(&ds, "%.*s", (int) (p-value), value);
value = p;
}
sge_dstring_append(&ds, "$TASK_ID");
value += strlen(DRMAA_PLACEHOLDER_INCR);
}
/* rest of the path */
sge_dstring_append(&ds, value);
*new_path = strdup(sge_dstring_get_string(&ds));
sge_dstring_free(&ds);
}
DRETURN(DRMAA_ERRNO_SUCCESS);
}
/****** DRMAA/drmaa_job2sge_job() **********************************************
* NAME
* drmaa_job2sge_job() -- convert a DRMAA job template into the Grid
* Engine counterpart
*
* SYNOPSIS
* int drmaa_job2sge_job(lListElem **jtp, const drmaa_job_template_t
* *drmaa_jt, int is_bulk, int start, int end, int step, dstring *diag)
*
* FUNCTION
* All DRMAA job template attributes are translated into Grid Engine
* job attributes.
*
* INPUTS
* drmaa_job_template_t *drmaa_jt - the DRMAA job template
* int is_bulk - 1 for bulk jobs 0 otherwise
* int start - start index for bulk jobs
* int end - end index for bulk jobs
* int step - increment for bulk jobs
* dstring *diag - diagnosis information
* lListElem **jtp - returns Grid Engine JB_Type job
*
* RESULT
* static int - DRMAA error codes
*
* NOTES
* MT-NOTE: drmaa_job2sge_job() is MT safe except on AIX4.2 and FreeBSD, with
* restrictions imposed by sge_get_qtask_args().
*
*******************************************************************************/
static int drmaa_job2sge_job(lListElem **jtp, const drmaa_job_template_t *drmaa_jt,
int is_bulk, int start, int end, int step, bool *use_euid_egid,
dstring *diag)
{
lListElem *jt, *ep;
int drmaa_errno;
lList *alp = NULL;
lList *opts_drmaa = NULL;
lList *opts_native = NULL;
lList *opts_default = NULL;
lList *opts_job_cat = NULL;
lList *opts_defaults = NULL;
lList *opts_scriptfile = NULL;
lList *opts_all = NULL;
int read_scriptfile = 0;
u_long32 jb_now = 0;
u_long32 prog_number = ctx->get_who(ctx);
uid_t myuid;
char username[128];
const char *cell_root = ctx->get_cell_root(ctx);
const char *unqualified_hostname = ctx->get_unqualified_hostname(ctx);
const char *qualified_hostname = ctx->get_qualified_hostname(ctx);
DENTER(TOP_LAYER, "drmaa_job2sge_job");
/* make JB_Type job description out of DRMAA job template */
if (!(jt = lCreateElem(JB_Type))) {
japi_standard_error(DRMAA_ERRNO_NO_MEMORY, diag);
DRETURN(DRMAA_ERRNO_NO_MEMORY);
}
/* init range of jobids and put all tasks in 'active' state */
if (job_set_submit_task_ids(jt, start, end, step) ||
job_initialize_id_lists(jt, NULL)) {
lFreeElem(&jt);
japi_standard_error(DRMAA_ERRNO_NO_MEMORY, diag);
DRETURN(DRMAA_ERRNO_NO_MEMORY);
}
jb_now = lGetUlong(jt, JB_type);
/*
* An error state does not exist with DRMAA jobs.
* This setting is necessary to ensure e.g. jobs
* with a wrong input path specification fail when
* doing drmaa_wait(). An SGE job template attribute
* could be supported to enable SGE error state.
*/
if (getenv(ENABLE_ERROR_STATE) == NULL)
JOB_TYPE_SET_NO_ERROR(jb_now);
/* mark array job */
if (is_bulk) {
JOB_TYPE_SET_ARRAY(jb_now);
}
lSetUlong(jt, JB_type, jb_now);
/* Modify UID and username for a seteuid() application */
if ((ep = lGetElemStr(drmaa_jt->strings, VA_variable, DRMAA_SUBMIT_AS_EUID))
&& !strncasecmp(lGetString(ep, VA_value), "y", 1)) {
myuid = geteuid();
if (sge_uid2user(myuid, username, sizeof(username) - 1, 3) != 0) {
sge_dstring_sprintf(diag, "Could not resolve EUID into username.");
lFreeElem(&jt);
DRETURN(DRMAA_ERRNO_DENIED_BY_DRM);
}
if (use_euid_egid)
*use_euid_egid = true;
} else {
const char *u = ctx->get_username(ctx);
myuid = ctx->get_uid(ctx);
if (!u) {
sge_dstring_sprintf(diag, "Context username is NULL!");
lFreeElem(&jt);
DRETURN(DRMAA_ERRNO_DENIED_BY_DRM);
}
sge_strlcpy(username, u, sizeof(username));
if (use_euid_egid)
*use_euid_egid = false;
}
/*
* read switches from the various defaults files
*/
opt_list_append_opts_from_default_files(prog_number, cell_root, username, &opts_defaults, &alp, environ);
if (answer_list_has_error(&alp)) {
answer_list_to_dstring(alp, diag);
lFreeList(&opts_defaults);
lFreeList(&alp);
lFreeElem(&jt);
DRETURN(DRMAA_ERRNO_DENIED_BY_DRM);
}
lFreeList(&alp);
/*
* append the native spec switches to the list if they exist
*/
if ((ep=lGetElemStr(drmaa_jt->strings, VA_variable, DRMAA_NATIVE_SPECIFICATION))) {
int num_args;
char **args;
const char *value = lGetString(ep, VA_value);
/* fix for IZ 2325: skip leading whitespace */
while (isspace(*value)) {
value++;
}
num_args = sge_quick_count_num_args(value);
args = (char **)malloc(sizeof(char *) * (num_args + 1));
memset(args, 0, sizeof(char *) * (num_args + 1));
DPRINTF(("processing %s, count %d = \"%s\"\n", DRMAA_NATIVE_SPECIFICATION, num_args, value));
if (num_args != 0) {
sge_parse_args(value, args);
opt_list_append_opts_from_qsub_cmdline(prog_number, &opts_native, &alp,
args, environ);
if (answer_list_has_error(&alp)) {
answer_list_to_dstring(alp, diag);
lFreeList(&opts_defaults);
lFreeList(&opts_native);
lFreeList(&alp);
lFreeElem(&jt);
DRETURN(DRMAA_ERRNO_DENIED_BY_DRM);
}
}
/* Free the args. */
while (num_args >= 0) {
sge_free(&(args[num_args]));
num_args--;
}
/* Free the args array. */
sge_free(&args);
}
lFreeList(&alp);
if ((drmaa_errno = opt_list_append_opts_from_drmaa_attr(&opts_drmaa,
drmaa_jt->strings, drmaa_jt->string_vectors,
is_bulk, diag)) != DRMAA_ERRNO_SUCCESS) {
lFreeList(&opts_defaults);
lFreeList(&opts_native);
lFreeList(&opts_drmaa);
lFreeElem(&jt);
DRETURN(drmaa_errno);
}
/*
* Set up default options
*/
opt_list_append_default_drmaa_opts(&opts_default);
/*
* We will only read commandline options from scripfile if the script
* itself should not be handled as binary.
* There's a big danger in trying to parse the scriptfile that needs to be
* documented. The problem is that the path to the working directory and
* hence to the script is relative to the execution host. This code runs on
* the submit host, so the working directory path may not point to the right
* thing. If it doesn't the only way we'll find out is the path to the
* script doesn't exist. If it just points to the wrong script, we have no
* way of knowing it.
*/
if (opt_list_is_X_true(opts_native, "-b") ||
(!opt_list_has_X(opts_native, "-b") &&
(opt_list_is_X_true(opts_defaults, "-b") ||
(!opt_list_has_X(opts_defaults, "-b") &&
opt_list_is_X_true(opts_default, "-b"))))) {
DPRINTF(("Skipping options from script due to -b option\n"));
} else {
const char *path = NULL;
if (opt_list_has_X(opts_drmaa, "-wd")) {
ep = lGetElemStr(opts_drmaa, SPA_switch, "-wd");
path = lGetString(ep, SPA_argval_lStringT);
path = drmaa_expand_wd_path(username, path, &alp);
if (path == NULL) {
answer_list_to_dstring(alp, diag);
lFreeList(&opts_defaults);
lFreeList(&opts_native);
lFreeList(&opts_drmaa);
lFreeList(&opts_default);
lFreeElem(&jt);
lFreeList(&alp);
DRETURN(DRMAA_ERRNO_DENIED_BY_DRM);
}
lFreeList(&alp);
}
/* -cwd could also theoretically appear in opts_default, but since I
* control what goes into opts_default, I know it isn't. */
else if ((!(opt_list_has_X(opts_native, "-cwd"))) &&
(!(opt_list_has_X(opts_defaults, "-cwd")))){
path = drmaa_get_home_directory(username, &alp);
lFreeList(&alp);
}
if (path != NULL) {
DPRINTF(("Using \"%s\" for the working directory.\n", path));
opt_list_append_opts_from_script_path(prog_number, &opts_scriptfile, path, &alp,
opts_drmaa, environ);
sge_free(&path);
} else {
DPRINTF(("Using current directory for the working directory.\n"));
opt_list_append_opts_from_script(prog_number, &opts_scriptfile, &alp, opts_drmaa,
environ);
}
if (answer_list_has_error(&alp)) {
answer_list_to_dstring(alp, diag);
lFreeList(&opts_defaults);
lFreeList(&opts_native);
lFreeList(&opts_drmaa);
lFreeList(&opts_default);
lFreeList(&opts_scriptfile);
lFreeList(&alp);
lFreeElem(&jt);
DRETURN(DRMAA_ERRNO_DENIED_BY_DRM);
}
lFreeList(&alp);
/* Note that we parsed the script file for command line options so that
* we can reneg on it later if we need to. */
read_scriptfile = 1;
}
/*
* append the job category switches to the list if they exist
*/
if (opt_list_has_X(opts_drmaa, "-cat") ||
opt_list_has_X(opts_scriptfile, "-cat") ||
opt_list_has_X(opts_native, "-cat") ||
opt_list_has_X(opts_defaults, "-cat") ||
opt_list_has_X(opts_default, "-cat")) {
/* No need to free job_cat since it points to a string in an element
* in jt->strings. */
char *job_cat = NULL;
char **args = NULL;
lListElem *ep = NULL;
DPRINTF(("Processing job category\n"));
/* This long series of ifs is really pointless since opts_drmaa is the
* only one that can contain -cat. However, I expect that at some point
* -cat will be added as a normal switch to qsub et al, at which point
* this long series of ifs becomes necessary. */
if ((ep = lGetElemStr(opts_drmaa, SPA_switch, "-cat")) != NULL) {
job_cat = strdup(lGetString(ep, SPA_argval_lStringT));
lRemoveElem(opts_drmaa, &ep);
} else if ((ep = lGetElemStr(opts_scriptfile, SPA_switch, "-cat")) != NULL) {
job_cat = strdup(lGetString(ep, SPA_argval_lStringT));
lRemoveElem(opts_scriptfile, &ep);
} else if ((ep = lGetElemStr(opts_native, SPA_switch, "-cat")) != NULL) {
job_cat = strdup(lGetString(ep, SPA_argval_lStringT));
lRemoveElem(opts_native, &ep);
} else if ((ep = lGetElemStr(opts_defaults, SPA_switch, "-cat")) != NULL) {
job_cat = strdup(lGetString(ep, SPA_argval_lStringT));
lRemoveElem(opts_defaults, &ep);
} else if ((ep = lGetElemStr(opts_default, SPA_switch, "-cat")) != NULL) {
job_cat = strdup(lGetString(ep, SPA_argval_lStringT));
lRemoveElem(opts_default, &ep);
} else {
/* This theoretically can't happen. */
sge_dstring_copy_string(diag, MSG_DRMAA_SWITCH_WITH_NO_CAT);
lFreeList(&opts_defaults);
lFreeList(&opts_native);
lFreeList(&opts_drmaa);
lFreeList(&opts_default);
lFreeList(&opts_scriptfile);
lFreeElem(&jt);
DRETURN(DRMAA_ERRNO_DENIED_BY_DRM);
}
/* We need to document a standard practice for naming job categories so
* they don't conflict with command names. I think something like
* <cat_name>.cat would work fine. */
args = sge_get_qtask_args(ctx, job_cat, &alp);
if (answer_list_has_error(&alp)) {
answer_list_to_dstring(alp, diag);
lFreeList(&opts_defaults);
lFreeList(&opts_native);
lFreeList(&opts_drmaa);
lFreeList(&opts_default);
lFreeList(&opts_scriptfile);
lFreeList(&alp);
lFreeElem(&jt);
DRETURN(DRMAA_ERRNO_DENIED_BY_DRM);
}
lFreeList(&alp);
sge_free(&job_cat);
if (args != NULL) {
opt_list_append_opts_from_qsub_cmdline(prog_number, &opts_job_cat, &alp,
args, environ);
/* free the args string array */
sge_strafree(&args);
if (answer_list_has_error(&alp)) {
answer_list_to_dstring(alp, diag);
lFreeList(&opts_defaults);
lFreeList(&opts_native);
lFreeList(&opts_drmaa);
lFreeList(&opts_default);
lFreeList(&opts_scriptfile);
lFreeList(&opts_job_cat);
lFreeList(&alp);
lFreeElem(&jt);
DRETURN(DRMAA_ERRNO_DENIED_BY_DRM);
}
lFreeList(&alp);
/* Now, since the job category can affect whether the script files
* get parsed for options, we have to step back a bit and make sure
* that if the job category contained a -b option, that it's effect
* gets counted appropriately. */
if (opt_list_has_X(opts_job_cat, "-b") &&
!opt_list_has_X(opts_native, "-b")) {
/* We are only concerned with the native specification options
* because those are the only ones that can override the job
* category settings. */
if (read_scriptfile && opt_list_is_X_true(opts_job_cat, "-b")) {
/* If we parsed the script file due to a -b n in the defaults files
* or the DRMAA defaults or because of no -b option, and a -b y
* is given in the job category, clear the script file options. */
lFreeList(&opts_scriptfile);
}
else if (!read_scriptfile &&
!opt_list_is_X_true(opts_job_cat, "-b")) {
/* If we didn't parse the script file due to a -b y in the defaults
* files or the DRMAA defaults, and a -b n is given in the job
* category, parse the script file now. */
/* No need to worry about recursion or infinite loops here since
* the script file cannot contain -cat. (-cat can only come from
* DRMAA_JOB_CATEGORY. If at some point in the future -cat gets
* added as a normal switch to qsub et al, the issue of inifite
* loops will have to be addressed. The best solution at that
* point will probably be to parse the job category before the
* script file and simply not allow the script file to set the
* job category.) */
opt_list_append_opts_from_script(prog_number, &opts_scriptfile, &alp,
opts_drmaa, environ);
if (answer_list_has_error(&alp)) {
answer_list_to_dstring(alp, diag);
lFreeList(&opts_defaults);
lFreeList(&opts_native);
lFreeList(&opts_drmaa);
lFreeList(&opts_default);
lFreeList(&opts_scriptfile);
lFreeList(&opts_job_cat);
lFreeList(&alp);
lFreeElem(&jt);
DRETURN(DRMAA_ERRNO_DENIED_BY_DRM);
}
lFreeList(&alp);
}
}
} else {
/* Bad job category */
sge_dstring_copy_string(diag, MSG_DRMAA_UNKNOWN_JOB_CAT);
lFreeList(&opts_defaults);
lFreeList(&opts_native);
lFreeList(&opts_drmaa);
lFreeList(&opts_default);
lFreeList(&opts_scriptfile);
lFreeList(&opts_job_cat);
lFreeElem(&jt);
DRETURN(DRMAA_ERRNO_DENIED_BY_DRM);
}
}
/*
* Merge all commandline options and interpret them.
*/
merge_drmaa_options(&opts_all, &opts_default, &opts_defaults, &opts_scriptfile,
&opts_job_cat, &opts_native, &opts_drmaa);
/* If the job is a bulk job, add the -t switch last so it takes top priority. */
if (is_bulk) {
if (drmaa_set_bulk_range(&opts_all, start, end, step, &alp) != 0) {
answer_list_to_dstring(alp, diag);
lFreeList(&alp);
lFreeElem(&jt);
lFreeList(&opts_all);
DRETURN(DRMAA_ERRNO_DENIED_BY_DRM);
}
lFreeList(&alp);
}
alp = cull_parse_job_parameter(myuid, username, cell_root, unqualified_hostname, qualified_hostname, opts_all, &jt);
if (answer_list_has_error(&alp)) {
answer_list_to_dstring(alp, diag);
lFreeElem(&jt);
lFreeList(&opts_all);
lFreeList(&alp);
DRETURN(DRMAA_ERRNO_DENIED_BY_DRM);
}
lFreeList(&alp);
*jtp = jt;
lFreeList(&opts_all);
DRETURN(DRMAA_ERRNO_SUCCESS);
}
/****** DRMAA/opt_list_append_opts_from_drmaa_attr() ***************************
* NAME
* opt_list_append_opts_from_drmaa_attr() -- covert the DRMAA attributes
* into qsub style option lListElem
* and append them to the given
* lList.
*
* SYNOPSIS
* int opt_list_append_opts_from_drmaa_attr(lList **args, const lList *attrs,
* const lList *vattrs, int is_bulk,
* dstring *diag)
*
* FUNCTION
* All DRMAA job template attributes are translated into qsub style option
* lListElem for parsing by cull_parse_job_parameter()
*
* INPUTS
* lList **args - list to which options will be appended
* lList *attrs - list of DRMAA scalar attributes
* lList *vattrs - list of DRMAA vector attributes
* int is_bulk - 1 for bulk jobs 0 otherwise
* dstring *diag - diagnosis information
*
* RESULT
* static int - DRMAA error codes
*
* NOTES
* MT-NOTE: opt_list_append_opts_from_drmaa_attr() is MT safe
*
*******************************************************************************/
static int opt_list_append_opts_from_drmaa_attr(lList **args, const lList *attrs,
const lList *vattrs, int is_bulk,
dstring *diag)
{
int drmaa_errno;
lListElem *ep = NULL;
lListElem *ep_opt = NULL;
const char *scriptname = NULL;
/* Turn each DRMAA attribute into a list entry. */
DENTER(TOP_LAYER, "opt_list_append_opts_from_drmaa_attr");
DPRINTF(("%d DRMAA attributes\n", lGetNumberOfElem(attrs)));
DPRINTF(("%d DRMAA vector attributes\n", lGetNumberOfElem(vattrs)));
/* job name -- -N <name>*/
if ((ep=lGetElemStr(attrs, VA_variable, DRMAA_JOB_NAME))) {
DPRINTF(("processing %s = \"%s\"\n", DRMAA_JOB_NAME, lGetString(ep, VA_value)));
ep_opt = sge_add_arg(args, N_OPT, lStringT, "-N", lGetString(ep, VA_value));
lSetString(ep_opt, SPA_argval_lStringT, lGetString(ep, VA_value));
}
/* job category -- -cat (not exposed in qsub) */
if ((ep=lGetElemStr(attrs, VA_variable, DRMAA_JOB_CATEGORY))) {
const char *value = lGetString(ep, VA_value);
DPRINTF(("processing %s = \"%s\"\n", DRMAA_JOB_CATEGORY, value));
DPRINTF(("%d args before adding job cat\n", lGetNumberOfElem(*args)));
ep_opt = sge_add_arg(args, cat_OPT, lStringT, "-cat", value);
lSetString(ep_opt, SPA_argval_lStringT, value);
DPRINTF(("%d args after adding job cat\n", lGetNumberOfElem(*args)));
}
/* join files -- -j "y|n" */
if ((ep=lGetElemStr(attrs, VA_variable, DRMAA_JOIN_FILES))) {
const char *value = lGetString(ep, VA_value);
DPRINTF(("processing %s = \"%s\"\n", DRMAA_JOIN_FILES, value));
if (value[0] == 'y') {
ep_opt = sge_add_arg(args, j_OPT, lIntT, "-j", "y");
lSetInt(ep_opt, SPA_argval_lIntT, TRUE);
}
else {
ep_opt = sge_add_arg(args, j_OPT, lIntT, "-j", "n");
lSetInt(ep_opt, SPA_argval_lIntT, FALSE);
}
}
/* working directory -- -wd (not exposed in qsub) */
if ((drmaa_errno = drmaa_path2wd_opt(attrs, args, is_bulk, diag))
!= DRMAA_ERRNO_SUCCESS) {
DRETURN(drmaa_errno);
}
/* jobs input/output/error stream -- -i/o/e */
{
const char* strvalue="";
if( (ep=lGetElemStr( attrs, VA_variable, DRMAA_TRANSFER_FILES ))) {
strvalue = lGetString( ep, VA_value );
}
if((drmaa_errno = drmaa_path2path_opt(attrs, args, is_bulk,
DRMAA_OUTPUT_PATH, "-o", o_OPT, diag, strchr( strvalue, 'o')?true:false))
!= DRMAA_ERRNO_SUCCESS) {
DRETURN(drmaa_errno);
}
if((drmaa_errno = drmaa_path2path_opt(attrs, args, is_bulk,
DRMAA_ERROR_PATH, "-e", e_OPT, diag, strchr( strvalue, 'e')?true:false))
!= DRMAA_ERRNO_SUCCESS) {
DRETURN(drmaa_errno);
}
if((drmaa_errno = drmaa_path2path_opt(attrs, args, is_bulk,
DRMAA_INPUT_PATH, "-i", i_OPT, diag, strchr( strvalue, 'i')?true:false))
!= DRMAA_ERRNO_SUCCESS) {
DRETURN(drmaa_errno);
}
}
/* user hold state -- -h */
if ((ep=lGetElemStr(attrs, VA_variable, DRMAA_JS_STATE))) {
const char *value = lGetString(ep, VA_value);
DPRINTF(("processing %s = \"%s\"\n", DRMAA_JS_STATE, value));
if (!strcmp(value, DRMAA_SUBMISSION_STATE_HOLD)) {
ep_opt = sge_add_arg(args, h_OPT, lIntT, "-h", "");
lSetInt(ep_opt, SPA_argval_lIntT, MINUS_H_TGT_USER);
}
}
/* job environment -- -v */
if ((ep=lGetElemStr(vattrs, NSV_name, DRMAA_V_ENV))) {
dstring env = DSTRING_INIT;
char *variable = NULL;
char *value = NULL;
lListElem *oep = NULL;
lList *olp = lGetList(ep, NSV_strings);
lListElem *nep = NULL;
lList *nlp = lCreateList("variable list", VA_Type);
int first_time = 1;
DPRINTF(("processing %s\n", DRMAA_V_ENV));
for_each(oep, olp) {
struct saved_vars_s *context = NULL;
const char *str = lGetString(oep, ST_name);
if (first_time) {
first_time = 0;
}
else {
sge_dstring_append_char(&env, ',');
}
sge_dstring_append(&env, str);
nep = lCreateElem(VA_Type);
lAppendElem(nlp, nep);
variable = sge_strtok_r(str, "=", &context);
lSetString(nep, VA_variable, variable);
value = sge_strtok_r((char *)NULL, "=", &context);
if (value)
lSetString(nep, VA_value, value);
else
lSetString(nep, VA_value, NULL);
sge_free_saved_vars(context);
}
DPRINTF(("\"%s\"\n", sge_dstring_get_string(&env)));
ep_opt = sge_add_arg(args, v_OPT, lListT, "-v", sge_dstring_get_string(&env));
sge_dstring_free(&env);
lSetList(ep_opt, SPA_argval_lListT, nlp);
}
/* email address -- -M */
if ((ep=lGetElemStr(vattrs, NSV_name, DRMAA_V_EMAIL))) {
dstring email = DSTRING_INIT;
char *user = NULL;
char *host = NULL;
lListElem *oep = NULL;
lList *olp = lGetList(ep, NSV_strings);
lListElem *nep = NULL;
lList *nlp = lCreateList("mail list", MR_Type);
lListElem *tmp = NULL;
int first_time = 1;
DPRINTF(("processing %s = ", DRMAA_V_EMAIL));
for_each(oep, olp) {
struct saved_vars_s *context = NULL;
const char *str = lGetString(oep, ST_name);
if (first_time) {
first_time = 0;
}
else {
sge_dstring_append_char(&email, ',');
}
sge_dstring_append(&email, str);
user = sge_strtok_r(str, "@", &context);
host = sge_strtok_r(NULL, "@", &context);
if ((tmp=lGetElemStr(nlp, MR_user, user))) {
if (!sge_strnullcmp(host, lGetHost(tmp, MR_host))) {
/* got this mail adress twice */
sge_free_saved_vars(context);
continue;
}
}
/* got a new adress - add it */
nep = lCreateElem(MR_Type);
lSetString(nep, MR_user, user);
if (host)
lSetHost(nep, MR_host, host);
lAppendElem(nlp, nep);
sge_free_saved_vars(context);
}
DPRINTF(("\"%s\"\n", sge_dstring_get_string(&email)));
ep_opt = sge_add_arg(args, M_OPT, lListT, "-M", sge_dstring_get_string(&email));
sge_dstring_free(&email);
lSetList(ep_opt, SPA_argval_lListT, nlp);
}
/* email supression -- -m */
if ((ep=lGetElemStr(attrs, VA_variable, DRMAA_BLOCK_EMAIL))) {
const char *value = lGetString(ep, VA_value);
DPRINTF(("processing %s = \"%s\"\n", DRMAA_BLOCK_EMAIL, value));
if (value[0] == '1') {
ep_opt = sge_add_arg(args, m_OPT, lIntT, "-m", "n");
lSetInt(ep_opt, SPA_argval_lIntT, NO_MAIL);
}
else if (value[0] == '0') {
/* This needs to be implemented so that DRMAA can reenable email that
* may have been blocked by a job cat, native spec, et al. Since we
* don't have the granularity to say how exactly to unblock the email,
* we just assume an innocuous default, i.e. email when the job is
* done. This should definitely be documented somewhere. */
ep_opt = sge_add_arg(args, m_OPT, lIntT, "-m", "e");
lSetInt(ep_opt, SPA_argval_lIntT, MAIL_AT_EXIT);
}
else {
DRETURN(DRMAA_ERRNO_DENIED_BY_DRM);
}
}
/* job start time -- -a */
if ((ep=lGetElemStr(attrs, VA_variable, DRMAA_START_TIME))) {
u_long32 timeval;
const char *value = (const char*)drmaa_time2sge_time(lGetString(ep, VA_value), diag);
if (value == NULL) {
/* diag is set by drmma_time2sge_time */
DRETURN(DRMAA_ERRNO_DENIED_BY_DRM);
}
DPRINTF(("processing %s = \"%s\"\n", DRMAA_START_TIME, value));
if (!ulong_parse_date_time_from_string(&timeval, NULL, value)) {
sge_dstring_copy_string(diag, MSG_DRMAA_INVALID_TIME_STRING);
DRETURN(DRMAA_ERRNO_DENIED_BY_DRM);
}
ep_opt = sge_add_arg(args, a_OPT, lUlongT, "-a", value);
lSetUlong(ep_opt, SPA_argval_lUlongT, timeval);
}
/* remote command -- last thing on the command line before the job args */
if (!(ep=lGetElemStr(attrs, VA_variable, DRMAA_REMOTE_COMMAND))) {
DPRINTF(("no remote command given\n"));
sge_dstring_copy_string(diag, "job template must have \""DRMAA_REMOTE_COMMAND"\" attribute set");
DRETURN(DRMAA_ERRNO_DENIED_BY_DRM);
}
if ((scriptname = lGetString(ep, VA_value)) != NULL) {
DPRINTF(("remote command is \"%s\"\n", scriptname));
ep_opt = sge_add_arg(args, 0, lStringT, STR_PSEUDO_SCRIPT, NULL);
lSetString(ep_opt, SPA_argval_lStringT, scriptname);
/* job arguments -- last thing on the command line */
if ((ep=lGetElemStr(vattrs, NSV_name, DRMAA_V_ARGV))) {
lList *lp = lGetList(ep, NSV_strings);
lListElem *aep = NULL;
DPRINTF(("processing %s\n", DRMAA_V_ARGV));
for_each(aep, lp) {
DPRINTF(("arg: \"%s\"\n", lGetString(aep, ST_name)));
ep_opt = sge_add_arg(args, 0, lStringT, STR_PSEUDO_JOBARG, NULL);
lSetString(ep_opt, SPA_argval_lStringT, lGetString(aep, ST_name));
}
}
}
DPRINTF(("%d args at end of method\n", lGetNumberOfElem(*args)));
DRETURN(DRMAA_ERRNO_SUCCESS);
}
/****** DRMAA/opt_list_append_default_drmaa_opts() ***************************
* NAME
* opt_list_append_default_drmaa_opts() -- append the DRMAA default setting
* to the list in the form of qsub
* style lListElem.
*
* SYNOPSIS
* int opt_list_append_default_drmaa_opts(lList **opts)
*
* FUNCTION
* All DRMAA default settings are translated into qsub style option
* lListElem for parsing by cull_parse_job_parameter()
*
* INPUTS
* lList **opts - list to which options will be appended
*
* RESULT
* static int - DRMAA error codes
*
* NOTES
* MT-NOTE: opt_list_append_default_drmaa_opts() is MT safe
*
*******************************************************************************/
static void opt_list_append_default_drmaa_opts(lList **opts)
{
lListElem *ep_opt;
DENTER(TOP_LAYER, "opt_list_append_drmaa_default_opts");
/* average priority of 0 -- -p 0 */
DPRINTF(("setting default priority to 0\n"));
ep_opt = sge_add_arg(opts, p_OPT, lIntT, "-p", "0");
lSetInt(ep_opt, SPA_argval_lIntT, 0);
/* We always use binary submission mode by default. A native spec, job
* category, or default file attribute can use -b n to reenable script
* attributes.
*/
DPRINTF(("enabling binary mode\n"));
ep_opt = sge_add_arg(opts, b_OPT, lIntT, "-b", "y");
lSetInt(ep_opt, SPA_argval_lIntT, 1);
/* Bugfix: Issuezilla #658
* In order to work around Bug #476, I set DRMAA to not spawn an exec
* shell. */
DPRINTF(("disabling execution shell\n"));
ep_opt = sge_add_arg(opts, shell_OPT, lIntT, "-shell", "n");
/* Bugfix: Issuezilla #1151
* Not only should -w e be allowed, it should be set by default. The main
* reason for this is to make the API friendlier. Without -w e set by
* default, jobs which will never be scheduled can be submitted without
* a problem, but the API is not rich enough to allow the application to
* discover post-facto that the jobs will never run. With -w e jobs that
* will never be scheduled cannot be submitted, a fact that the application
* will note immediately without further need of explanation. The main
* argument against setting -w e by default is performance overhead. In the
* end we decided for setting -w e by default because developer experience
* is very important, and if the performance overhead becomes too great, the
* option can always be turned off in the native specification or job
* category. */
DPRINTF(("disabling submission of unschedulable jobs\n"));
ep_opt = sge_add_arg(opts, w_OPT, lIntT, "-w", "e");
lSetInt(ep_opt, SPA_argval_lIntT, ERROR_VERIFY);
DRETURN_VOID;
}
/****** DRMAA/merge_drmaa_options() ********************************************
* NAME
* merge_drmaa_options() -- merge the various option lists into a single list
*
* SYNOPSIS
* void merge_drmaa_options(lList **opts_all, lList **opts_default,
* lList **opts_defaults, lList **opts_scriptfile,
* lList **opts_job_cat, lList **opts_native,
* lList **opts_drmaa)
*
* FUNCTION
* All options from the last six lists are combined into the first list.
* Each list has prune_arg_list() called on it to remove inappropriate
* options.
*
* INPUTS
* lList **opts_all - list to which options will be appended
* lList **opts_default - list with default options
* lList **opts_defaults - list with options from default files
* lList **opts_scriptfile - list with options from the script file
* lList **opts_job_cat - list with options from the job category
* lList **opts_native - list with options from the native spec
* lList **opts_drmaa - list with options from the DRMAA attributes
*
* NOTES
* MT-NOTE: merge_drmaa_options() is MT safe
*
*******************************************************************************/
static void merge_drmaa_options(lList **opts_all, lList **opts_default,
lList **opts_defaults, lList **opts_scriptfile,
lList **opts_job_cat, lList **opts_native,
lList **opts_drmaa)
{
DENTER(TOP_LAYER, "merge_drmaa_options");
/*
* Order is very important here
*/
if (*opts_default != NULL) {
DPRINTF(("Adding default options\n"));
prune_arg_list(*opts_default);
if (*opts_all == NULL) {
*opts_all = *opts_default;
*opts_default = NULL;
} else {
lAddList(*opts_all, opts_default);
}
}
if (*opts_defaults != NULL) {
DPRINTF(("Adding defaults options\n"));
prune_arg_list(*opts_defaults);
if (*opts_all == NULL) {
*opts_all = *opts_defaults;
} else {
lAddList(*opts_all, opts_defaults);
}
*opts_defaults = NULL;
}
if (*opts_scriptfile != NULL) {
DPRINTF(("Adding scriptfile options\n"));
prune_arg_list(*opts_scriptfile);
if (*opts_all == NULL) {
*opts_all = *opts_scriptfile;
} else {
lAddList(*opts_all, opts_scriptfile);
}
*opts_scriptfile = NULL;
}
if (*opts_job_cat != NULL) {
DPRINTF(("Adding job cat options\n"));
prune_arg_list(*opts_job_cat);
if (*opts_all == NULL) {
*opts_all = *opts_job_cat;
} else {
lAddList(*opts_all, opts_job_cat);
}
*opts_job_cat = NULL;
}
if (*opts_native != NULL) {
DPRINTF(("Adding native options\n"));
prune_arg_list(*opts_native);
if (*opts_all == NULL) {
*opts_all = *opts_native;
} else {
lAddList(*opts_all, opts_native);
}
*opts_native = NULL;
}
if (*opts_drmaa != NULL) {
DPRINTF(("Adding drmaa options\n"));
/* No need to prune since options are already bounded by DRMAA */
if (*opts_all == NULL) {
*opts_all = *opts_drmaa;
} else {
lAddList(*opts_all, opts_drmaa);
}
*opts_drmaa = NULL;
}
DRETURN_VOID;
}
/****** DRMAA/prune_arg_list() *************************************************
* NAME
* prune_arg_list() -- remove inappropriate options
*
* SYNOPSIS
* void prune_arg_list(lList *args)
*
* FUNCTION
* All options from the list which are not appropriate for DRMAA are removed
*
* INPUTS
* lList *args - list to prune
*
* NOTES
* MT-NOTE: prune_arg_list() is MT safe
*
*******************************************************************************/
static void prune_arg_list(lList *args)
{
/* o=override, +=keep, -=remove
o -a date_time request a job start time
+ -ac context_list add context variable(s)
+ -A account_string use account at host
+ -b y|n handle command as binary
+ -binding core binding
+ -c ckpt_selector define type of checkpointing for job
+ -ckpt ckpt-name request checkpoint method
+ -clear skip previous definitions for job
-? -cwd use current working directory
+ -C directive_prefix define command prefix for job script
+ -dc simple_context_list remove context variable(s)
+ -dl date_time request a deadline initiation time
o -e path_list specify standard error stream path(s)
o -h place user hold on job
+ -hard consider following requests "hard"
- -help print this help
+ -hold_jid job_identifier_list define jobnet interdependencies
+ -hold_jid_ad job_identifier_list define jobnet array interdependencies
o -i file_list specify standard input stream file(s)
+ -j y|n merge stdout and stderr stream of job
+ -l resource_list request the given resources
+ -m mail_options define mail notification events
+ -masterq destin_id_list bind master task to queue(s)
o -M mail_list notify these e-mail addresses
+ -notify notify job before killing/suspending it
+ -now y[es]|n[o] start job immediately or not at all
o -N name specify job name
o -o path_list specify standard output stream path(s)
+ -p priority define job's relative priority
+ -pe pe-name slot_range request slot range for parallel jobs
+ -P project_name set job's project
+ -q destin_id_list bind job to queue(s)
+ -r y|n define job as (not) restartable
+ -sc context_list set job context (replaces old context)
+ -soft consider following requests as soft
- -sync wait for job to complete
+ -S path_list command interpreter to be used
- -t task_id_range create a job-array with these tasks
o -v variable_list export these environment variables
- -verify do not submit just verify
o -V export all environment variables
+ -w e|n verify mode (error|none) for jobs
- -w w|v verify mode (warning|just verify) for jobs
+ -@ file read commandline input from file
*/
lListElem *element = NULL;
const void *i = NULL;
DENTER(TOP_LAYER, "prune_arg_list");
/* skip arguments that aren't supported */
while ((element = lGetElemStr(args, SPA_switch, "-help"))) {
lRemoveElem(args, &element);
}
/* This one isn't supported because bulk jobs are handled through the
* drmaa_run_bulk_jobs() method. */
while ((element = lGetElemStr(args, SPA_switch, "-t"))) {
lRemoveElem(args, &element);
}
while ((element = lGetElemStr(args, SPA_switch, "-verify"))) {
lRemoveElem(args, &element);
}
while ((element = lGetElemStrNext(args, SPA_switch, "-w", &i))) {
int argval = lGetInt(element, SPA_argval_lIntT);
if ((argval == JUST_VERIFY) || (argval == POKE_VERIFY) || (argval == WARNING_VERIFY)) {
lRemoveElem(args, &element);
}
}
if (getenv(ENABLE_CWD_ENV) == NULL) {
while ((element = lGetElemStr(args, SPA_switch, "-cwd"))) {
lRemoveElem(args, &element);
}
}
while ((element = lGetElemStr(args, SPA_switch, "-sync"))) {
lRemoveElem(args, &element);
}
DRETURN_VOID;
}
/****** DRMAA/drmaa_time2sge_time() ********************************************
* NAME
* drmaa_time2sge_time() -- convert DRMAA time strings to SGE time strings
*
* SYNOPSIS
* void drmaa_time2sge_time(const char *drmaa_time, dstring *diag)
*
* FUNCTION
* The DRMAA time string is converted into an SGE time string. If the
* resulting time string represents a time in the past, and any of the date
* elements were not specified in the DRMAA time string, the least order
* date element will be incremented.
*
* INPUTS
* lList *drmaa_time - the DRMAA time string
*
* OUTPUTS
* dstring *diag - errors
*
* RESULT
* char * - The time as a string
*
* NOTES
* MT-NOTE: drmaa_time2sge_time() is MT safe
*
*******************************************************************************/
static char *drmaa_time2sge_time(const char *drmaa_time, dstring *diag)
{
/* SGE time format is [[CC]]YY]MMDDhhmm.[ss] */
/* DRMAA time format is [[[[CC]YY/]MM/]DD] hh:mm[:ss] [{-|+}UU:uu] */
int year, month, day, hour, minute, second, tz_hours, tz_minutes;
int century_set = 0, year_set = 0, month_set = 0, day_set = 0;
int tz_diff_hours, tz_diff_minutes;
char *p1, *p2, *start;
char tz_sign, tmp[128], sge_time[16]; /* We will always build a string 15 + 1 long */
time_t now;
struct tm gmnow;
struct tm herenow;
DENTER(TOP_LAYER, "drmaa_time2sge_time");
/* Get default times */
time(&now);
gmtime_r(&now, &gmnow);
localtime_r(&now, &herenow);
/* Set parsed times to defaults */
year = -1;
month = -1;
day = -1;
hour = -1;
minute = -1;
second = -1;
tz_sign = -1;
tz_hours = -1;
tz_minutes = -1;
start = strdup(drmaa_time);
p1 = start;
p2 = strchr(p1, '/');
/* Look for year */
if (p2 != NULL) {
/* If we found a /, we know we have either a month or year */
if ((p2 - p1)/sizeof(char) == 4) {
/* 4 digit year given */
strncpy(tmp, p1, 4);
tmp[4] = '\0';
year = atoi(tmp);
century_set = 1;
year_set = 1;
p1 = p2 + 1;
}
else if ((p2 - p1)/sizeof(char) == 2) {
/* 2 digit year or month given. We'll sort it out later. */
strncpy(tmp, p1, 2);
tmp[2] = '\0';
year = atoi(tmp);
year_set = 1;
p1 = p2 + 1;
}
else {
/* Whatever comes before the slash can only be 2 or 4 characters */
sge_dstring_copy_string(diag, MSG_DRMAA_TIME_PARSE_ERROR);
DRETURN(NULL);
}
}
else {
/* No year or month given. Set the year now and worry about the month
* later. */
/* tm_year is number of years since 1900. Since we add 2000 later, we
* have to subtract 100 now. */
year = gmnow.tm_year - 100;
}
p2 = strchr(p1, '/');
/* If we found a second slash, that means the year, month, and day were
* specified. */
if (p2 != NULL) {
/* 2 digit month given. Set the month now and worry about the day later. */
strncpy(tmp, p1, 2);
tmp[2] = '\0';
month = atoi(tmp);
month_set = 1;
p1 = p2 + 1;
}
else {
if (year_set) {
/* If there's only on slash, what we thought was a year was really a
* month. */
month = year;
/* tm_year is number of years since 1900. Since we add 2000 later, we
* have to subtract 100 now. */
year = gmnow.tm_year - 100;
month_set = 1;
year_set = 0;
}
else {
/* No month given */
month = gmnow.tm_mon + 1;
}
}
p2 = strchr(p1, ' ');
/* If we find a space that's 2 characters from the last slash, we've found
* the day. */
if ((p2 != NULL) && ((p2 - p1)/sizeof(char) == 2)) {
/* 2 digit day given. */
strncpy(tmp, p1, 2);
tmp[2] = '\0';
day = atoi(tmp);
day_set = 1;
p1 = p2 + 1;
}
else {
/* No day given */
day = gmnow.tm_mday;
}
/* Since hour and minute are required, we just use sscanf to read them.
* sscanf also provides the added bonus of dealing with the whitespace for
* us. */
if (sscanf(p1, "%2d:%2d", &hour, &minute) != 2) {
/* Hour and minute as hh:mm is required in DRMAA date strings. */
sge_dstring_copy_string(diag, MSG_DRMAA_TIME_PARSE_ERROR);
DRETURN(NULL);
}
/* Rather than trying to figure out how much whitespace the sscanf skipped
* before getting to the hour and minute, we just find the colon between the
* hour and minute and add 2 to get past the minutes. */
p2 = strchr(p1, ':');
p1 = p2 + 1;
p2 += 3;
/* If the character after the minutes is a :, we've found the seconds. */
if (*p2 == ':') {
/* 2 digit seconds given */
strncpy(tmp, p2 + 1, 2);
tmp[2] = '\0';
second = atoi(tmp);
/* Set our pointer to the end of the minutes plus 1 for the colon plus 2
* for the seconds. */
p1 = p2 + 3;
}
else {
/* No seconds given */
second = 0;
/* Set our pointer to the end of the minutes. */
p1 = p2;
}
/* Check that if a day and month were given that they are a valid
* combination. Also check that the hour, minute, and second are ok. We're
* making the assumption here that gmtime() isn't going to return out of
* range values. We deal with the case of setting a day and getting a month
* from gmtime that don't work together later. */
if ((day_set && (day > 31)) ||
(month_set && (day > 30) &&
((month == 4) || (month == 6) || (month == 9) || (month == 11))) ||
(month_set && (day > 29) &&
((month == 2) && (year % 4 == 0))) ||
(month_set && (day > 28) && (month == 2)) ||
(month_set && (month > 12)) ||
(hour > 23) || (minute > 59) || (second > 59)) {
sge_dstring_append(diag, MSG_DRMAA_TIME_PARSE_ERROR);
DRETURN(NULL);
}
/* If the day was gotten from gmtime(), check if the resulting date is in the
* past. If it is, increment the day and ripple the change through the
* month and year. */
else if (!day_set) {
if ((hour < gmnow.tm_hour) ||
((hour == gmnow.tm_hour) &&
((minute < gmnow.tm_min) ||
((minute == gmnow.tm_min) && (second < gmnow.tm_sec))))) {
day++;
if ((day > 31) ||
((day > 30) &&
((month == 4) || (month == 6) || (month == 9) || (month == 11))) ||
((day > 29) &&
((month == 2) && (year % 4 == 0))) ||
((day > 28) && (month == 2))) {
day = 1;
month++;
if (month > 12) {
month = 1;
year++;
}
}
}
}
/* If the month was gotten from gmtime(), check if the resulting date is in
* the past. If it is, increment the month and ripple the change though the
* year. */
else if (!month_set) {
/* Make sure that the date is not in the past. It doesn't matter if the
* day of the month doesn't exist in the current month. From the
* perspective of determining what's earlier, it will work fine. */
if ((day < gmnow.tm_mday) ||
((day == gmnow.tm_mday) &&
((hour < gmnow.tm_hour) ||
((hour == gmnow.tm_hour) &&
((minute < gmnow.tm_min) ||
((minute == gmnow.tm_min) && (second < gmnow.tm_sec))))))) {
month++;
if (month > 12) {
month = 1;
year++;
}
}
/* Now make sure that the month and day make sense together. */
if ((day > 30) && ((month == 4) || (month == 6) || (month == 9) || (month == 11))) {
day -= 30;
month++;
}
else if ((day > 29) && ((month == 2) && (year % 4 == 0))) {
day -= 29;
month++;
}
else if ((day > 28) && (month == 2)) {
day -= 28;
month++;
}
}
/* If the year was gotten from gmtime(), check if the resulting date is in
* the past. If it is, increment the year. The change will automatically
* ripple through the century. */
else if (!year_set) {
if ((month < gmnow.tm_mon + 1) ||
((month == gmnow.tm_mon + 1) &&
((day < gmnow.tm_mday) ||
((day == gmnow.tm_mday) &&
((hour < gmnow.tm_hour) ||
((hour == gmnow.tm_hour) &&
((minute < gmnow.tm_min) ||
((minute == gmnow.tm_min) && (second < gmnow.tm_sec))))))))) {
/* Here we can just increment the year because even if it grows larger
* than 99, since the century is added to it, it all works out. */
year++;
}
}
/* If the year was set as two digits, or if the year was gotten from gmtime(),
* Add the current century to it. */
if (!century_set) {
year += 2000;
}
/* It's ok to deal with the timezone after doing all the math to validate the
* date because timezone only affects hours and minutes, and we never
* increment or get defaults for hours or minutes; they're required to be
* specified. */
tz_diff_hours = herenow.tm_hour - gmnow.tm_hour;
tz_diff_minutes = herenow.tm_min - gmnow.tm_min;
/* We use sscanf to deal with the timezone information because of the potential
* whitespace between the minute/second and the tz info and because the tz
* info is either all present or all not present. */
if (sscanf(p1, "%1s%2d:%2d", &tz_sign, &tz_hours, &tz_minutes) == 3) {
/* If we read all three fields, check the sign and adjust the hour and
* minute accordingly. */
if (tz_sign == '+') {
hour += tz_diff_hours - tz_hours;
minute += tz_diff_minutes - tz_minutes;
}
else if (tz_sign == '-') {
hour += tz_diff_hours + tz_hours;
minute += tz_diff_minutes + tz_minutes;
}
else {
/* The sign must always be present and be a + or - */
sge_dstring_copy_string(diag, MSG_DRMAA_TIME_PARSE_ERROR);
DRETURN(NULL);
}
}
/* If no timezone info was given, just use whatever hour and minute were in
* the DRMAA date string. */
/* Build the SGE date string from the parsed components. sprintf adds the
* terminating character for us. */
sprintf(sge_time, "%.4d%.2d%.2d%.2d%.2d.%.2d", year, month, day, hour,
minute, second);
sge_free(&start);
DRETURN(strdup(sge_time));
}
/****** DRMAA/drmaa_expand_wd_path()********************************************
* NAME
* drmaa_expand_wd_path() -- convert DRMAA_WD to a usable path
*
* SYNOPSIS
* void drmaa_expand_wd_path(const char *path, lList **answer_list)
*
* FUNCTION
* The DRMAA_WD is translated into a usable path by converting $drmaa_hd_ph$
* into the user's home directory path. Note that $drmaa_inc_ph$ is not
* translated. This function is used only when parsing the script file.
* because $drmaa_inc_ph$ only has a value after the job has been submitted,
* it is not useful for finding the script, and hence is not allowed in
* conjunction with "-b n".
*
* INPUTS
* const char *username - the user's name
* lList *path - the DRMAA_WD string
*
* OUTPUTS
* lList **answer_list - errors
*
* RESULT
* char * - The expanded path as a string
*
* NOTES
* MT-NOTE: drmaa_expand_wd_path() is MT safe except on AIX4.2 and FreeBSD
*
*******************************************************************************/
static char *drmaa_expand_wd_path(const char*username, const char *path, lList **answer_list)
{
char *file = NULL;
char str[MAX_STRING_SIZE];
DENTER(TOP_LAYER, "drmaa_expand_wd_path");
DPRINTF(("Expanding \"%s\"\n", path));
/* First look for the job index placeholder. It is illegal. */
if (strstr(path, "$TASK_ID") != NULL) {
snprintf(str, sizeof(str), SFNMAX, MSG_DRMAA_INC_NOT_ALLOWED);
answer_list_add(answer_list, str, STATUS_ENOSUCHUSER,
ANSWER_QUALITY_ERROR);
DRETURN(NULL);
}
/* If the home directory placeholder is found at the beginning of the
* path, replace it with the user's home directory on the current
* machine in hopes that it's the same home directory as on the exec
* host. */
if (!strncmp(path, "$HOME", 5)) {
int length = 0;
char *homedir = drmaa_get_home_directory(username, answer_list);
if (homedir == NULL) {
DRETURN(NULL);
}
length = strlen(path) - 5 + strlen(homedir) + 1;
file = (char *)malloc(sizeof(char) * length);
strcpy(file, homedir); /* RATS: ignore */
file = strcat(file, path + 5); /* RATS: ignore */
sge_free(&homedir);
}
else {
file = (char *)malloc(sizeof(char) * (strlen(path) + 1));
file = strcpy(file, path); /* RATS: ignore */
}
DPRINTF(("Expanded to \"%s\"\n", file));
DRETURN(file);
}
/****** DRMAA/drmaa_get_home_directory()****************************************
* NAME
* drmaa_get_home_directory() -- get the user's home directory
*
* SYNOPSIS
* void drmaa_get_home_directory(lList **answer_list)
*
* FUNCTION
* Returns the user's home directory as determined from nsswitch.conf.
*
* OUTPUTS
* lList **answer_list - errors
*
* RESULT
* char * - the home directory path as a string
*
* NOTES
* MT-NOTE: drmaa_get_home_directory() is MT safe except on AIX4.2 and
* MT-NOTE: FreeBSD
*
*******************************************************************************/
static char *drmaa_get_home_directory(const char* username, lList **answer_list)
{
struct passwd *pwd = NULL;
char str[MAX_STRING_SIZE];
struct passwd pw_struct;
char *buffer;
int size;
DENTER(TOP_LAYER, "drmaa_get_home_directory");
size = get_pw_buffer_size();
buffer = sge_malloc(size);
pwd = sge_getpwnam_r(username, &pw_struct, buffer, size);
if (!pwd) {
snprintf(str, sizeof(str), MSG_USER_INVALIDNAMEX_S, username);
answer_list_add(answer_list, str, STATUS_ENOSUCHUSER, ANSWER_QUALITY_ERROR);
sge_free(&buffer);
DRETURN(NULL);
}
if (!pwd->pw_dir) {
snprintf(str, sizeof(str), MSG_USER_NOHOMEDIRFORUSERX_S, username);
answer_list_add(answer_list, str, STATUS_EDISK, ANSWER_QUALITY_ERROR);
DRETURN(NULL);
}
sge_free(&buffer);
DRETURN(strdup(pwd->pw_dir));
}
/****** DRMAA/drmaa_set_bulk_range()********************************************
* NAME
* drmaa_set_bulk_range() -- set the bulk job switch for the given range
*
* SYNOPSIS
* int drmaa_set_bulk_range(lList **opts, int start, int end, int step,
* lList **alp)
*
* FUNCTION
* Adds a "-t range" option to the opts list for the given task id range.
*
* INPUTS
* lList **opts - the list to which the -t option will be added
* int start - the beginning of the task id range
* int end - the end of the task id range
* int step - the increment between consequetive task ids
* OUTPUTS
* lList **alp - errors
*
* RESULT
* int - error code: 1 = OK, 0 = Error
*
* NOTES
* MT-NOTE: drmaa_set_bulk_range() is MT safe
*
*******************************************************************************/
static int drmaa_set_bulk_range(lList **opts, int start, int end, int step,
lList **alp)
{
char str[128];
lListElem *ep_opt = NULL;
lList *task_id_range_list = NULL;
DENTER(TOP_LAYER, "drmaa_set_bulk_range");
snprintf(str, sizeof(str), "%d-%d:%d", start, end, step);
range_list_parse_from_string(&task_id_range_list, alp, str,
false, true, INF_NOT_ALLOWED);
if (task_id_range_list) {
ep_opt = sge_add_arg(opts, t_OPT, lStringT, "-t", str);
lSetList(ep_opt, SPA_argval_lListT, task_id_range_list);
DRETURN(0);
}
else {
DRETURN(1);
}
}
static drmaa_attr_names_t *drmaa_fill_supported_vector_attributes(dstring *diag)
{
return drmaa_fill_string_vector(drmaa_supported_vector);
}
static drmaa_attr_names_t *drmaa_fill_supported_nonvector_attributes(dstring *diag)
{
drmaa_attr_names_t *p = NULL;
DENTER(TOP_LAYER, "drmaa_fill_supported_nonvector_attribute");
p = drmaa_fill_string_vector(drmaa_supported_nonvector);
if (japi_is_delegated_file_staging_enabled(diag)) {
DPRINTF(("adding \"%s\"\n", DRMAA_TRANSFER_FILES));
if (!lAddElemStr(&(p->it.si.strings),
ST_name, DRMAA_TRANSFER_FILES, ST_Type)) {
japi_delete_string_vector((drmaa_attr_values_t *)p);
DRETURN(NULL);
}
}
DRETURN(p);
}
|