/usr/share/doc/gcc-4.6-base/libgomp.html is in gcc-4.6-doc 4.6.3-1ubuntu5.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 | <html lang="en">
<head>
<title>GNU libgomp</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNU libgomp">
<meta name="generator" content="makeinfo 4.13">
<link title="Top" rel="top" href="#Top">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 2006, 2007, 2008, 2010, 2011 Free Software Foundation, Inc.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with the
Invariant Sections being "Funding Free Software", the Front-Cover
texts being (a) (see below), and with the Back-Cover Texts being (b)
(see below). A copy of the license is included in the section entitled
"GNU Free Documentation License".
(a) The FSF's Front-Cover Text is:
A GNU Manual
(b) The FSF's Back-Cover Text is:
You have freedom to copy and modify this GNU Manual, like GNU
software. Copies published by the Free Software Foundation raise
funds for GNU development.-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
pre.display { font-family:inherit }
pre.format { font-family:inherit }
pre.smalldisplay { font-family:inherit; font-size:smaller }
pre.smallformat { font-family:inherit; font-size:smaller }
pre.smallexample { font-size:smaller }
pre.smalllisp { font-size:smaller }
span.sc { font-variant:small-caps }
span.roman { font-family:serif; font-weight:normal; }
span.sansserif { font-family:sans-serif; font-weight:normal; }
--></style>
</head>
<body>
<h1 class="settitle">GNU libgomp</h1>
<div class="shortcontents">
<h2>Short Contents</h2>
<ul>
<li><a href="#toc_Top">Introduction</a></li>
<li><a href="#toc_Enabling-OpenMP">1 Enabling OpenMP</a></li>
<li><a href="#toc_Runtime-Library-Routines">2 Runtime Library Routines</a></li>
<li><a href="#toc_Environment-Variables">3 Environment Variables</a></li>
<li><a href="#toc_The-libgomp-ABI">4 The libgomp ABI</a></li>
<li><a href="#toc_Reporting-Bugs">5 Reporting Bugs</a></li>
<li><a href="#toc_Copying">GNU GENERAL PUBLIC LICENSE</a></li>
<li><a href="#toc_GNU-Free-Documentation-License">GNU Free Documentation License</a></li>
<li><a href="#toc_Funding">Funding Free Software</a></li>
<li><a href="#toc_Index">Index</a></li>
</ul>
</div>
<div class="contents">
<h2>Table of Contents</h2>
<ul>
<li><a name="toc_Top" href="#Top">Introduction</a>
<li><a name="toc_Enabling-OpenMP" href="#Enabling-OpenMP">1 Enabling OpenMP</a>
<li><a name="toc_Runtime-Library-Routines" href="#Runtime-Library-Routines">2 Runtime Library Routines</a>
<ul>
<li><a href="#omp_005fget_005factive_005flevel">2.1 <code>omp_get_active_level</code> – Number of parallel regions</a>
<li><a href="#omp_005fget_005fancestor_005fthread_005fnum">2.2 <code>omp_get_ancestor_thread_num</code> – Ancestor thread ID</a>
<li><a href="#omp_005fget_005fdynamic">2.3 <code>omp_get_dynamic</code> – Dynamic teams setting</a>
<li><a href="#omp_005fget_005flevel">2.4 <code>omp_get_level</code> – Obtain the current nesting level</a>
<li><a href="#omp_005fget_005fmax_005factive_005flevels">2.5 <code>omp_get_max_active_levels</code> – Maximum number of active regions</a>
<li><a href="#omp_005fget_005fmax_005fthreads">2.6 <code>omp_get_max_threads</code> – Maximum number of threads of parallel region</a>
<li><a href="#omp_005fget_005fnested">2.7 <code>omp_get_nested</code> – Nested parallel regions</a>
<li><a href="#omp_005fget_005fnum_005fprocs">2.8 <code>omp_get_num_procs</code> – Number of processors online</a>
<li><a href="#omp_005fget_005fnum_005fthreads">2.9 <code>omp_get_num_threads</code> – Size of the active team</a>
<li><a href="#omp_005fget_005fschedule">2.10 <code>omp_get_schedule</code> – Obtain the runtime scheduling method</a>
<li><a href="#omp_005fget_005fteam_005fsize">2.11 <code>omp_get_team_size</code> – Number of threads in a team</a>
<li><a href="#omp_005fget_005fthread_005flimit">2.12 <code>omp_get_thread_limit</code> – Maximum number of threads</a>
<li><a href="#omp_005fget_005fthread_005fnum">2.13 <code>omp_get_thread_num</code> – Current thread ID</a>
<li><a href="#omp_005fin_005fparallel">2.14 <code>omp_in_parallel</code> – Whether a parallel region is active</a>
<li><a href="#omp_005fset_005fdynamic">2.15 <code>omp_set_dynamic</code> – Enable/disable dynamic teams</a>
<li><a href="#omp_005fset_005fmax_005factive_005flevels">2.16 <code>omp_set_max_active_levels</code> – Limits the number of active parallel regions</a>
<li><a href="#omp_005fset_005fnested">2.17 <code>omp_set_nested</code> – Enable/disable nested parallel regions</a>
<li><a href="#omp_005fset_005fnum_005fthreads">2.18 <code>omp_set_num_threads</code> – Set upper team size limit</a>
<li><a href="#omp_005fset_005fschedule">2.19 <code>omp_set_schedule</code> – Set the runtime scheduling method</a>
<li><a href="#omp_005finit_005flock">2.20 <code>omp_init_lock</code> – Initialize simple lock</a>
<li><a href="#omp_005fset_005flock">2.21 <code>omp_set_lock</code> – Wait for and set simple lock</a>
<li><a href="#omp_005ftest_005flock">2.22 <code>omp_test_lock</code> – Test and set simple lock if available</a>
<li><a href="#omp_005funset_005flock">2.23 <code>omp_unset_lock</code> – Unset simple lock</a>
<li><a href="#omp_005fdestroy_005flock">2.24 <code>omp_destroy_lock</code> – Destroy simple lock</a>
<li><a href="#omp_005finit_005fnest_005flock">2.25 <code>omp_init_nest_lock</code> – Initialize nested lock</a>
<li><a href="#omp_005fset_005fnest_005flock">2.26 <code>omp_set_nest_lock</code> – Wait for and set nested lock</a>
<li><a href="#omp_005ftest_005fnest_005flock">2.27 <code>omp_test_nest_lock</code> – Test and set nested lock if available</a>
<li><a href="#omp_005funset_005fnest_005flock">2.28 <code>omp_unset_nest_lock</code> – Unset nested lock</a>
<li><a href="#omp_005fdestroy_005fnest_005flock">2.29 <code>omp_destroy_nest_lock</code> – Destroy nested lock</a>
<li><a href="#omp_005fget_005fwtick">2.30 <code>omp_get_wtick</code> – Get timer precision</a>
<li><a href="#omp_005fget_005fwtime">2.31 <code>omp_get_wtime</code> – Elapsed wall clock time</a>
</li></ul>
<li><a name="toc_Environment-Variables" href="#Environment-Variables">3 Environment Variables</a>
<ul>
<li><a href="#OMP_005fDYNAMIC">3.1 <samp><span class="env">OMP_DYNAMIC</span></samp> – Dynamic adjustment of threads</a>
<li><a href="#OMP_005fMAX_005fACTIVE_005fLEVELS">3.2 <samp><span class="env">OMP_MAX_ACTIVE_LEVELS</span></samp> – Set the maximum number of nested parallel regions</a>
<li><a href="#OMP_005fNESTED">3.3 <samp><span class="env">OMP_NESTED</span></samp> – Nested parallel regions</a>
<li><a href="#OMP_005fNUM_005fTHREADS">3.4 <samp><span class="env">OMP_NUM_THREADS</span></samp> – Specifies the number of threads to use</a>
<li><a href="#OMP_005fSCHEDULE">3.5 <samp><span class="env">OMP_SCHEDULE</span></samp> – How threads are scheduled</a>
<li><a href="#OMP_005fSTACKSIZE">3.6 <samp><span class="env">OMP_STACKSIZE</span></samp> – Set default thread stack size</a>
<li><a href="#OMP_005fTHREAD_005fLIMIT">3.7 <samp><span class="env">OMP_THREAD_LIMIT</span></samp> – Set the maximum number of threads</a>
<li><a href="#OMP_005fWAIT_005fPOLICY">3.8 <samp><span class="env">OMP_WAIT_POLICY</span></samp> – How waiting threads are handled</a>
<li><a href="#GOMP_005fCPU_005fAFFINITY">3.9 <samp><span class="env">GOMP_CPU_AFFINITY</span></samp> – Bind threads to specific CPUs</a>
<li><a href="#GOMP_005fSTACKSIZE">3.10 <samp><span class="env">GOMP_STACKSIZE</span></samp> – Set default thread stack size</a>
</li></ul>
<li><a name="toc_The-libgomp-ABI" href="#The-libgomp-ABI">4 The libgomp ABI</a>
<ul>
<li><a href="#Implementing-MASTER-construct">4.1 Implementing MASTER construct</a>
<li><a href="#Implementing-CRITICAL-construct">4.2 Implementing CRITICAL construct</a>
<li><a href="#Implementing-ATOMIC-construct">4.3 Implementing ATOMIC construct</a>
<li><a href="#Implementing-FLUSH-construct">4.4 Implementing FLUSH construct</a>
<li><a href="#Implementing-BARRIER-construct">4.5 Implementing BARRIER construct</a>
<li><a href="#Implementing-THREADPRIVATE-construct">4.6 Implementing THREADPRIVATE construct</a>
<li><a href="#Implementing-PRIVATE-clause">4.7 Implementing PRIVATE clause</a>
<li><a href="#Implementing-FIRSTPRIVATE-LASTPRIVATE-COPYIN-and-COPYPRIVATE-clauses">4.8 Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses</a>
<li><a href="#Implementing-REDUCTION-clause">4.9 Implementing REDUCTION clause</a>
<li><a href="#Implementing-PARALLEL-construct">4.10 Implementing PARALLEL construct</a>
<li><a href="#Implementing-FOR-construct">4.11 Implementing FOR construct</a>
<li><a href="#Implementing-ORDERED-construct">4.12 Implementing ORDERED construct</a>
<li><a href="#Implementing-SECTIONS-construct">4.13 Implementing SECTIONS construct</a>
<li><a href="#Implementing-SINGLE-construct">4.14 Implementing SINGLE construct</a>
</li></ul>
<li><a name="toc_Reporting-Bugs" href="#Reporting-Bugs">5 Reporting Bugs</a>
<li><a name="toc_Copying" href="#Copying">GNU GENERAL PUBLIC LICENSE</a>
<ul>
<li><a href="#Copying">Preamble</a>
<li><a href="#Copying">Appendix: How to Apply These Terms to Your New Programs</a>
</li></ul>
<li><a name="toc_GNU-Free-Documentation-License" href="#GNU-Free-Documentation-License">GNU Free Documentation License</a>
<ul>
<li><a href="#GNU-Free-Documentation-License">ADDENDUM: How to use this License for your documents</a>
</li></ul>
<li><a name="toc_Funding" href="#Funding">Funding Free Software</a>
<li><a name="toc_Index" href="#Index">Index</a>
</li></ul>
</div>
<div class="node">
<a name="Top"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Enabling-OpenMP">Enabling OpenMP</a>,
Up: <a rel="up" accesskey="u" href="#dir">(dir)</a>
</div>
<h2 class="unnumbered">Introduction</h2>
<p><a name="index-Introduction-1"></a>
This manual documents the usage of libgomp, the GNU implementation of the
<a href="http://www.openmp.org">OpenMP</a> Application Programming Interface (API)
for multi-platform shared-memory parallel programming in C/C++ and Fortran.
<!-- When you add a new menu item, please keep the right hand -->
<!-- aligned to the same column. Do not use tabs. This provides -->
<!-- better formatting. -->
<ul class="menu">
<li><a accesskey="1" href="#Enabling-OpenMP">Enabling OpenMP</a>: How to enable OpenMP for your applications.
<li><a accesskey="2" href="#Runtime-Library-Routines">Runtime Library Routines</a>: The OpenMP runtime application programming
interface.
<li><a accesskey="3" href="#Environment-Variables">Environment Variables</a>: Influencing runtime behavior with environment
variables.
<li><a accesskey="4" href="#The-libgomp-ABI">The libgomp ABI</a>: Notes on the external ABI presented by libgomp.
<li><a accesskey="5" href="#Reporting-Bugs">Reporting Bugs</a>: How to report bugs in GNU OpenMP.
<li><a accesskey="6" href="#Copying">Copying</a>: GNU general public license says
how you can copy and share libgomp.
<li><a accesskey="7" href="#GNU-Free-Documentation-License">GNU Free Documentation License</a>
How you can copy and share this manual.
<li><a accesskey="8" href="#Funding">Funding</a>: How to help assure continued work for free
software.
<li><a accesskey="9" href="#Index">Index</a>: Index of this documentation.
</ul>
<!-- -->
<!-- Enabling OpenMP -->
<!-- -->
<div class="node">
<a name="Enabling-OpenMP"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Runtime-Library-Routines">Runtime Library Routines</a>,
Previous: <a rel="previous" accesskey="p" href="#Top">Top</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">1 Enabling OpenMP</h2>
<p>To activate the OpenMP extensions for C/C++ and Fortran, the compile-time
flag <samp><span class="command">-fopenmp</span></samp> must be specified. This enables the OpenMP directive
<code>#pragma omp</code> in C/C++ and <code>!$omp</code> directives in free form,
<code>c$omp</code>, <code>*$omp</code> and <code>!$omp</code> directives in fixed form,
<code>!$</code> conditional compilation sentinels in free form and <code>c$</code>,
<code>*$</code> and <code>!$</code> sentinels in fixed form, for Fortran. The flag also
arranges for automatic linking of the OpenMP runtime library
(<a href="#Runtime-Library-Routines">Runtime Library Routines</a>).
<p>A complete description of all OpenMP directives accepted may be found in
the <a href="http://www.openmp.org">OpenMP Application Program Interface</a> manual,
version 3.0.
<!-- -->
<!-- Runtime Library Routines -->
<!-- -->
<div class="node">
<a name="Runtime-Library-Routines"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Environment-Variables">Environment Variables</a>,
Previous: <a rel="previous" accesskey="p" href="#Enabling-OpenMP">Enabling OpenMP</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">2 Runtime Library Routines</h2>
<p>The runtime routines described here are defined by section 3 of the OpenMP
specifications in version 3.0. The routines are structured in following
three parts:
<p>Control threads, processors and the parallel environment.
<ul class="menu">
<li><a accesskey="1" href="#omp_005fget_005factive_005flevel">omp_get_active_level</a>: Number of active parallel regions
<li><a accesskey="2" href="#omp_005fget_005fancestor_005fthread_005fnum">omp_get_ancestor_thread_num</a>: Ancestor thread ID
<li><a accesskey="3" href="#omp_005fget_005fdynamic">omp_get_dynamic</a>: Dynamic teams setting
<li><a accesskey="4" href="#omp_005fget_005flevel">omp_get_level</a>: Number of parallel regions
<li><a accesskey="5" href="#omp_005fget_005fmax_005factive_005flevels">omp_get_max_active_levels</a>: Maximum number of active regions
<li><a accesskey="6" href="#omp_005fget_005fmax_005fthreads">omp_get_max_threads</a>: Maximum number of threads of parallel region
<li><a accesskey="7" href="#omp_005fget_005fnested">omp_get_nested</a>: Nested parallel regions
<li><a accesskey="8" href="#omp_005fget_005fnum_005fprocs">omp_get_num_procs</a>: Number of processors online
<li><a accesskey="9" href="#omp_005fget_005fnum_005fthreads">omp_get_num_threads</a>: Size of the active team
<li><a href="#omp_005fget_005fschedule">omp_get_schedule</a>: Obtain the runtime scheduling method
<li><a href="#omp_005fget_005fteam_005fsize">omp_get_team_size</a>: Number of threads in a team
<li><a href="#omp_005fget_005fthread_005flimit">omp_get_thread_limit</a>: Maximum number of threads
<li><a href="#omp_005fget_005fthread_005fnum">omp_get_thread_num</a>: Current thread ID
<li><a href="#omp_005fin_005fparallel">omp_in_parallel</a>: Whether a parallel region is active
<li><a href="#omp_005fset_005fdynamic">omp_set_dynamic</a>: Enable/disable dynamic teams
<li><a href="#omp_005fset_005fmax_005factive_005flevels">omp_set_max_active_levels</a>: Limits the number of active parallel regions
<li><a href="#omp_005fset_005fnested">omp_set_nested</a>: Enable/disable nested parallel regions
<li><a href="#omp_005fset_005fnum_005fthreads">omp_set_num_threads</a>: Set upper team size limit
<li><a href="#omp_005fset_005fschedule">omp_set_schedule</a>: Set the runtime scheduling method
</ul>
<p>Initialize, set, test, unset and destroy simple and nested locks.
<ul class="menu">
<li><a accesskey="1" href="#omp_005finit_005flock">omp_init_lock</a>: Initialize simple lock
<li><a accesskey="2" href="#omp_005fset_005flock">omp_set_lock</a>: Wait for and set simple lock
<li><a accesskey="3" href="#omp_005ftest_005flock">omp_test_lock</a>: Test and set simple lock if available
<li><a accesskey="4" href="#omp_005funset_005flock">omp_unset_lock</a>: Unset simple lock
<li><a accesskey="5" href="#omp_005fdestroy_005flock">omp_destroy_lock</a>: Destroy simple lock
<li><a accesskey="6" href="#omp_005finit_005fnest_005flock">omp_init_nest_lock</a>: Initialize nested lock
<li><a accesskey="7" href="#omp_005fset_005fnest_005flock">omp_set_nest_lock</a>: Wait for and set simple lock
<li><a accesskey="8" href="#omp_005ftest_005fnest_005flock">omp_test_nest_lock</a>: Test and set nested lock if available
<li><a accesskey="9" href="#omp_005funset_005fnest_005flock">omp_unset_nest_lock</a>: Unset nested lock
<li><a href="#omp_005fdestroy_005fnest_005flock">omp_destroy_nest_lock</a>: Destroy nested lock
</ul>
<p>Portable, thread-based, wall clock timer.
<ul class="menu">
<li><a accesskey="1" href="#omp_005fget_005fwtick">omp_get_wtick</a>: Get timer precision.
<li><a accesskey="2" href="#omp_005fget_005fwtime">omp_get_wtime</a>: Elapsed wall clock time.
</ul>
<div class="node">
<a name="omp_get_active_level"></a>
<a name="omp_005fget_005factive_005flevel"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fget_005fancestor_005fthread_005fnum">omp_get_ancestor_thread_num</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.1 <code>omp_get_active_level</code> – Number of parallel regions</h3>
<dl>
<dt><em>Description</em>:<dd>This function returns the nesting level for the active parallel blocks,
which enclose the calling call.
<br><dt><em>C/C++</em><dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>int omp_get_active_level(void);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>integer function omp_get_active_level()</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005fget_005flevel">omp_get_level</a>, <a href="#omp_005fget_005fmax_005factive_005flevels">omp_get_max_active_levels</a>, <a href="#omp_005fset_005fmax_005factive_005flevels">omp_set_max_active_levels</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.2.19.
</dl>
<div class="node">
<a name="omp_get_ancestor_thread_num"></a>
<a name="omp_005fget_005fancestor_005fthread_005fnum"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fget_005fdynamic">omp_get_dynamic</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fget_005factive_005flevel">omp_get_active_level</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.2 <code>omp_get_ancestor_thread_num</code> – Ancestor thread ID</h3>
<dl>
<dt><em>Description</em>:<dd>This function returns the thread identification number for the given
nesting level of the current thread. For values of <var>level</var> outside
zero to <code>omp_get_level</code> -1 is returned; if <var>level</var> is
<code>omp_get_level</code> the result is identical to <code>omp_get_thread_num</code>.
<br><dt><em>C/C++</em><dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>int omp_get_ancestor_thread_num(int level);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>integer function omp_get_ancestor_thread_num(level)</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>integer level</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005fget_005flevel">omp_get_level</a>, <a href="#omp_005fget_005fthread_005fnum">omp_get_thread_num</a>, <a href="#omp_005fget_005fteam_005fsize">omp_get_team_size</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.2.17.
</dl>
<div class="node">
<a name="omp_get_dynamic"></a>
<a name="omp_005fget_005fdynamic"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fget_005flevel">omp_get_level</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fget_005fancestor_005fthread_005fnum">omp_get_ancestor_thread_num</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.3 <code>omp_get_dynamic</code> – Dynamic teams setting</h3>
<dl>
<dt><em>Description</em>:<dd>This function returns <code>true</code> if enabled, <code>false</code> otherwise.
Here, <code>true</code> and <code>false</code> represent their language-specific
counterparts.
<p>The dynamic team setting may be initialized at startup by the
<code>OMP_DYNAMIC</code> environment variable or at runtime using
<code>omp_set_dynamic</code>. If undefined, dynamic adjustment is
disabled by default.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>int omp_get_dynamic(void);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>logical function omp_get_dynamic()</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005fset_005fdynamic">omp_set_dynamic</a>, <a href="#OMP_005fDYNAMIC">OMP_DYNAMIC</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.2.8.
</dl>
<div class="node">
<a name="omp_get_level"></a>
<a name="omp_005fget_005flevel"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fget_005fmax_005factive_005flevels">omp_get_max_active_levels</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fget_005fdynamic">omp_get_dynamic</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.4 <code>omp_get_level</code> – Obtain the current nesting level</h3>
<dl>
<dt><em>Description</em>:<dd>This function returns the nesting level for the parallel blocks,
which enclose the calling call.
<br><dt><em>C/C++</em><dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>int omp_get_level(void);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>integer function omp_level()</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005fget_005factive_005flevel">omp_get_active_level</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.2.16.
</dl>
<div class="node">
<a name="omp_get_max_active_levels"></a>
<a name="omp_005fget_005fmax_005factive_005flevels"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fget_005fmax_005fthreads">omp_get_max_threads</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fget_005flevel">omp_get_level</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.5 <code>omp_get_max_active_levels</code> – Maximum number of active regions</h3>
<dl>
<dt><em>Description</em>:<dd>This function obtains the maximum allowed number of nested, active parallel regions.
<br><dt><em>C/C++</em><dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>int omp_get_max_active_levels(void);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>integer function omp_get_max_active_levels()</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005fset_005fmax_005factive_005flevels">omp_set_max_active_levels</a>, <a href="#omp_005fget_005factive_005flevel">omp_get_active_level</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.2.14.
</dl>
<div class="node">
<a name="omp_get_max_threads"></a>
<a name="omp_005fget_005fmax_005fthreads"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fget_005fnested">omp_get_nested</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fget_005fmax_005factive_005flevels">omp_get_max_active_levels</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.6 <code>omp_get_max_threads</code> – Maximum number of threads of parallel region</h3>
<dl>
<dt><em>Description</em>:<dd>Return the maximum number of threads used for the current parallel region
that does not use the clause <code>num_threads</code>.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>int omp_get_max_threads(void);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>integer function omp_get_max_threads()</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005fset_005fnum_005fthreads">omp_set_num_threads</a>, <a href="#omp_005fset_005fdynamic">omp_set_dynamic</a>, <a href="#omp_005fget_005fthread_005flimit">omp_get_thread_limit</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.2.3.
</dl>
<div class="node">
<a name="omp_get_nested"></a>
<a name="omp_005fget_005fnested"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fget_005fnum_005fprocs">omp_get_num_procs</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fget_005fmax_005fthreads">omp_get_max_threads</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.7 <code>omp_get_nested</code> – Nested parallel regions</h3>
<dl>
<dt><em>Description</em>:<dd>This function returns <code>true</code> if nested parallel regions are
enabled, <code>false</code> otherwise. Here, <code>true</code> and <code>false</code>
represent their language-specific counterparts.
<p>Nested parallel regions may be initialized at startup by the
<code>OMP_NESTED</code> environment variable or at runtime using
<code>omp_set_nested</code>. If undefined, nested parallel regions are
disabled by default.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>int omp_get_nested(void);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>logical function omp_get_nested()</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005fset_005fnested">omp_set_nested</a>, <a href="#OMP_005fNESTED">OMP_NESTED</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.2.10.
</dl>
<div class="node">
<a name="omp_get_num_procs"></a>
<a name="omp_005fget_005fnum_005fprocs"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fget_005fnum_005fthreads">omp_get_num_threads</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fget_005fnested">omp_get_nested</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.8 <code>omp_get_num_procs</code> – Number of processors online</h3>
<dl>
<dt><em>Description</em>:<dd>Returns the number of processors online.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>int omp_get_num_procs(void);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>integer function omp_get_num_procs()</code>
<br></td></tr></table>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.2.5.
</dl>
<div class="node">
<a name="omp_get_num_threads"></a>
<a name="omp_005fget_005fnum_005fthreads"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fget_005fschedule">omp_get_schedule</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fget_005fnum_005fprocs">omp_get_num_procs</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.9 <code>omp_get_num_threads</code> – Size of the active team</h3>
<dl>
<dt><em>Description</em>:<dd>Returns the number of threads in the current team. In a sequential section of
the program <code>omp_get_num_threads</code> returns 1.
<p>The default team size may be initialized at startup by the
<code>OMP_NUM_THREADS</code> environment variable. At runtime, the size
of the current team may be set either by the <code>NUM_THREADS</code>
clause or by <code>omp_set_num_threads</code>. If none of the above were
used to define a specific value and <code>OMP_DYNAMIC</code> is disabled,
one thread per CPU online is used.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>int omp_get_num_threads(void);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>integer function omp_get_num_threads()</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005fget_005fmax_005fthreads">omp_get_max_threads</a>, <a href="#omp_005fset_005fnum_005fthreads">omp_set_num_threads</a>, <a href="#OMP_005fNUM_005fTHREADS">OMP_NUM_THREADS</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.2.2.
</dl>
<div class="node">
<a name="omp_get_schedule"></a>
<a name="omp_005fget_005fschedule"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fget_005fteam_005fsize">omp_get_team_size</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fget_005fnum_005fthreads">omp_get_num_threads</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.10 <code>omp_get_schedule</code> – Obtain the runtime scheduling method</h3>
<dl>
<dt><em>Description</em>:<dd>Obtain the runtime scheduling method. The <var>kind</var> argument will be
set to the value <code>omp_sched_static</code>, <code>omp_sched_dynamic</code>,
<code>omp_sched_guided</code> or <code>omp_sched_auto</code>. The second argument,
<var>modifier</var>, is set to the chunk size.
<br><dt><em>C/C++</em><dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>omp_schedule(omp_sched_t *kind, int *modifier);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>subroutine omp_schedule(kind, modifier)</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>integer(kind=omp_sched_kind) kind</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>integer modifier</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005fset_005fschedule">omp_set_schedule</a>, <a href="#OMP_005fSCHEDULE">OMP_SCHEDULE</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.2.12.
</dl>
<div class="node">
<a name="omp_get_team_size"></a>
<a name="omp_005fget_005fteam_005fsize"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fget_005fthread_005flimit">omp_get_thread_limit</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fget_005fschedule">omp_get_schedule</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.11 <code>omp_get_team_size</code> – Number of threads in a team</h3>
<dl>
<dt><em>Description</em>:<dd>This function returns the number of threads in a thread team to which
either the current thread or its ancestor belongs. For values of <var>level</var>
outside zero to <code>omp_get_level</code>, -1 is returned; if <var>level</var> is zero,
1 is returned, and for <code>omp_get_level</code>, the result is identical
to <code>omp_get_num_threads</code>.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>int omp_get_team_size(int level);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>integer function omp_get_team_size(level)</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>integer level</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005fget_005fnum_005fthreads">omp_get_num_threads</a>, <a href="#omp_005fget_005flevel">omp_get_level</a>, <a href="#omp_005fget_005fancestor_005fthread_005fnum">omp_get_ancestor_thread_num</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.2.18.
</dl>
<div class="node">
<a name="omp_get_thread_limit"></a>
<a name="omp_005fget_005fthread_005flimit"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fget_005fthread_005fnum">omp_get_thread_num</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fget_005fteam_005fsize">omp_get_team_size</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.12 <code>omp_get_thread_limit</code> – Maximum number of threads</h3>
<dl>
<dt><em>Description</em>:<dd>Return the maximum number of threads of the program.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>int omp_get_thread_limit(void);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>integer function omp_get_thread_limit()</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005fget_005fmax_005fthreads">omp_get_max_threads</a>, <a href="#OMP_005fTHREAD_005fLIMIT">OMP_THREAD_LIMIT</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.2.13.
</dl>
<div class="node">
<a name="omp_get_thread_num"></a>
<a name="omp_005fget_005fthread_005fnum"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fin_005fparallel">omp_in_parallel</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fget_005fthread_005flimit">omp_get_thread_limit</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.13 <code>omp_get_thread_num</code> – Current thread ID</h3>
<dl>
<dt><em>Description</em>:<dd>Returns a unique thread identification number within the current team.
In a sequential parts of the program, <code>omp_get_thread_num</code>
always returns 0. In parallel regions the return value varies
from 0 to <code>omp_get_num_threads</code>-1 inclusive. The return
value of the master thread of a team is always 0.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>int omp_get_thread_num(void);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>integer function omp_get_thread_num()</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005fget_005fnum_005fthreads">omp_get_num_threads</a>, <a href="#omp_005fget_005fancestor_005fthread_005fnum">omp_get_ancestor_thread_num</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.2.4.
</dl>
<div class="node">
<a name="omp_in_parallel"></a>
<a name="omp_005fin_005fparallel"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fset_005fdynamic">omp_set_dynamic</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fget_005fthread_005fnum">omp_get_thread_num</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.14 <code>omp_in_parallel</code> – Whether a parallel region is active</h3>
<dl>
<dt><em>Description</em>:<dd>This function returns <code>true</code> if currently running in parallel,
<code>false</code> otherwise. Here, <code>true</code> and <code>false</code> represent
their language-specific counterparts.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>int omp_in_parallel(void);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>logical function omp_in_parallel()</code>
<br></td></tr></table>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.2.6.
</dl>
<div class="node">
<a name="omp_set_dynamic"></a>
<a name="omp_005fset_005fdynamic"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fset_005fmax_005factive_005flevels">omp_set_max_active_levels</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fin_005fparallel">omp_in_parallel</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.15 <code>omp_set_dynamic</code> – Enable/disable dynamic teams</h3>
<dl>
<dt><em>Description</em>:<dd>Enable or disable the dynamic adjustment of the number of threads
within a team. The function takes the language-specific equivalent
of <code>true</code> and <code>false</code>, where <code>true</code> enables dynamic
adjustment of team sizes and <code>false</code> disables it.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>void omp_set_dynamic(int set);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>subroutine omp_set_dynamic(set)</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>logical, intent(in) :: set</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#OMP_005fDYNAMIC">OMP_DYNAMIC</a>, <a href="#omp_005fget_005fdynamic">omp_get_dynamic</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.2.7.
</dl>
<div class="node">
<a name="omp_set_max_active_levels"></a>
<a name="omp_005fset_005fmax_005factive_005flevels"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fset_005fnested">omp_set_nested</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fset_005fdynamic">omp_set_dynamic</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.16 <code>omp_set_max_active_levels</code> – Limits the number of active parallel regions</h3>
<dl>
<dt><em>Description</em>:<dd>This function limits the maximum allowed number of nested, active
parallel regions.
<br><dt><em>C/C++</em><dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>void omp_set_max_active_levels(int max_levels);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>subroutine omp_set_max_active_levels(max_levels)</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>integer max_levels</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005fget_005fmax_005factive_005flevels">omp_get_max_active_levels</a>, <a href="#omp_005fget_005factive_005flevel">omp_get_active_level</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.2.14.
</dl>
<div class="node">
<a name="omp_set_nested"></a>
<a name="omp_005fset_005fnested"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fset_005fnum_005fthreads">omp_set_num_threads</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fset_005fmax_005factive_005flevels">omp_set_max_active_levels</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.17 <code>omp_set_nested</code> – Enable/disable nested parallel regions</h3>
<dl>
<dt><em>Description</em>:<dd>Enable or disable nested parallel regions, i.e., whether team members
are allowed to create new teams. The function takes the language-specific
equivalent of <code>true</code> and <code>false</code>, where <code>true</code> enables
dynamic adjustment of team sizes and <code>false</code> disables it.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>void omp_set_nested(int set);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>subroutine omp_set_nested(set)</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>logical, intent(in) :: set</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#OMP_005fNESTED">OMP_NESTED</a>, <a href="#omp_005fget_005fnested">omp_get_nested</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.2.9.
</dl>
<div class="node">
<a name="omp_set_num_threads"></a>
<a name="omp_005fset_005fnum_005fthreads"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fset_005fschedule">omp_set_schedule</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fset_005fnested">omp_set_nested</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.18 <code>omp_set_num_threads</code> – Set upper team size limit</h3>
<dl>
<dt><em>Description</em>:<dd>Specifies the number of threads used by default in subsequent parallel
sections, if those do not specify a <code>num_threads</code> clause. The
argument of <code>omp_set_num_threads</code> shall be a positive integer.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>void omp_set_num_threads(int n);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>subroutine omp_set_num_threads(n)</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>integer, intent(in) :: n</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#OMP_005fNUM_005fTHREADS">OMP_NUM_THREADS</a>, <a href="#omp_005fget_005fnum_005fthreads">omp_get_num_threads</a>, <a href="#omp_005fget_005fmax_005fthreads">omp_get_max_threads</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.2.1.
</dl>
<div class="node">
<a name="omp_set_schedule"></a>
<a name="omp_005fset_005fschedule"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005finit_005flock">omp_init_lock</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fset_005fnum_005fthreads">omp_set_num_threads</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.19 <code>omp_set_schedule</code> – Set the runtime scheduling method</h3>
<dl>
<dt><em>Description</em>:<dd>Sets the runtime scheduling method. The <var>kind</var> argument can have the
value <code>omp_sched_static</code>, <code>omp_sched_dynamic</code>,
<code>omp_sched_guided</code> or <code>omp_sched_auto</code>. Except for
<code>omp_sched_auto</code>, the chunk size is set to the value of
<var>modifier</var> if positive, or to the default value if zero or negative.
For <code>omp_sched_auto</code> the <var>modifier</var> argument is ignored.
<br><dt><em>C/C++</em><dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>int omp_set_schedule(omp_sched_t *kind, int *modifier);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>subroutine omp_set_schedule(kind, modifier)</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>integer(kind=omp_sched_kind) kind</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>integer modifier</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005fget_005fschedule">omp_get_schedule</a>
<a href="#OMP_005fSCHEDULE">OMP_SCHEDULE</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.2.11.
</dl>
<div class="node">
<a name="omp_init_lock"></a>
<a name="omp_005finit_005flock"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fset_005flock">omp_set_lock</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fset_005fschedule">omp_set_schedule</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.20 <code>omp_init_lock</code> – Initialize simple lock</h3>
<dl>
<dt><em>Description</em>:<dd>Initialize a simple lock. After initialization, the lock is in
an unlocked state.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>void omp_init_lock(omp_lock_t *lock);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>subroutine omp_init_lock(lock)</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>integer(omp_lock_kind), intent(out) :: lock</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005fdestroy_005flock">omp_destroy_lock</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.3.1.
</dl>
<div class="node">
<a name="omp_set_lock"></a>
<a name="omp_005fset_005flock"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005ftest_005flock">omp_test_lock</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005finit_005flock">omp_init_lock</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.21 <code>omp_set_lock</code> – Wait for and set simple lock</h3>
<dl>
<dt><em>Description</em>:<dd>Before setting a simple lock, the lock variable must be initialized by
<code>omp_init_lock</code>. The calling thread is blocked until the lock
is available. If the lock is already held by the current thread,
a deadlock occurs.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>void omp_set_lock(omp_lock_t *lock);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>subroutine omp_set_lock(lock)</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>integer(omp_lock_kind), intent(inout) :: lock</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005finit_005flock">omp_init_lock</a>, <a href="#omp_005ftest_005flock">omp_test_lock</a>, <a href="#omp_005funset_005flock">omp_unset_lock</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.3.3.
</dl>
<div class="node">
<a name="omp_test_lock"></a>
<a name="omp_005ftest_005flock"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005funset_005flock">omp_unset_lock</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fset_005flock">omp_set_lock</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.22 <code>omp_test_lock</code> – Test and set simple lock if available</h3>
<dl>
<dt><em>Description</em>:<dd>Before setting a simple lock, the lock variable must be initialized by
<code>omp_init_lock</code>. Contrary to <code>omp_set_lock</code>, <code>omp_test_lock</code>
does not block if the lock is not available. This function returns
<code>true</code> upon success, <code>false</code> otherwise. Here, <code>true</code> and
<code>false</code> represent their language-specific counterparts.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>int omp_test_lock(omp_lock_t *lock);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>subroutine omp_test_lock(lock)</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>logical(omp_logical_kind) :: omp_test_lock</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>integer(omp_lock_kind), intent(inout) :: lock</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005finit_005flock">omp_init_lock</a>, <a href="#omp_005fset_005flock">omp_set_lock</a>, <a href="#omp_005fset_005flock">omp_set_lock</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.3.5.
</dl>
<div class="node">
<a name="omp_unset_lock"></a>
<a name="omp_005funset_005flock"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fdestroy_005flock">omp_destroy_lock</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005ftest_005flock">omp_test_lock</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.23 <code>omp_unset_lock</code> – Unset simple lock</h3>
<dl>
<dt><em>Description</em>:<dd>A simple lock about to be unset must have been locked by <code>omp_set_lock</code>
or <code>omp_test_lock</code> before. In addition, the lock must be held by the
thread calling <code>omp_unset_lock</code>. Then, the lock becomes unlocked. If one
or more threads attempted to set the lock before, one of them is chosen to,
again, set the lock for itself.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>void omp_unset_lock(omp_lock_t *lock);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>subroutine omp_unset_lock(lock)</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>integer(omp_lock_kind), intent(inout) :: lock</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005fset_005flock">omp_set_lock</a>, <a href="#omp_005ftest_005flock">omp_test_lock</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.3.4.
</dl>
<div class="node">
<a name="omp_destroy_lock"></a>
<a name="omp_005fdestroy_005flock"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005finit_005fnest_005flock">omp_init_nest_lock</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005funset_005flock">omp_unset_lock</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.24 <code>omp_destroy_lock</code> – Destroy simple lock</h3>
<dl>
<dt><em>Description</em>:<dd>Destroy a simple lock. In order to be destroyed, a simple lock must be
in the unlocked state.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>void omp_destroy_lock(omp_lock_t *lock);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>subroutine omp_destroy_lock(lock)</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>integer(omp_lock_kind), intent(inout) :: lock</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005finit_005flock">omp_init_lock</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.3.2.
</dl>
<div class="node">
<a name="omp_init_nest_lock"></a>
<a name="omp_005finit_005fnest_005flock"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fset_005fnest_005flock">omp_set_nest_lock</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fdestroy_005flock">omp_destroy_lock</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.25 <code>omp_init_nest_lock</code> – Initialize nested lock</h3>
<dl>
<dt><em>Description</em>:<dd>Initialize a nested lock. After initialization, the lock is in
an unlocked state and the nesting count is set to zero.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>void omp_init_nest_lock(omp_nest_lock_t *lock);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>subroutine omp_init_nest_lock(lock)</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>integer(omp_nest_lock_kind), intent(out) :: lock</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005fdestroy_005fnest_005flock">omp_destroy_nest_lock</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.3.1.
</dl>
<div class="node">
<a name="omp_set_nest_lock"></a>
<a name="omp_005fset_005fnest_005flock"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005ftest_005fnest_005flock">omp_test_nest_lock</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005finit_005fnest_005flock">omp_init_nest_lock</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.26 <code>omp_set_nest_lock</code> – Wait for and set nested lock</h3>
<dl>
<dt><em>Description</em>:<dd>Before setting a nested lock, the lock variable must be initialized by
<code>omp_init_nest_lock</code>. The calling thread is blocked until the lock
is available. If the lock is already held by the current thread, the
nesting count for the lock in incremented.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>void omp_set_nest_lock(omp_nest_lock_t *lock);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>subroutine omp_set_nest_lock(lock)</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>integer(omp_nest_lock_kind), intent(inout) :: lock</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005finit_005fnest_005flock">omp_init_nest_lock</a>, <a href="#omp_005funset_005fnest_005flock">omp_unset_nest_lock</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.3.3.
</dl>
<div class="node">
<a name="omp_test_nest_lock"></a>
<a name="omp_005ftest_005fnest_005flock"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005funset_005fnest_005flock">omp_unset_nest_lock</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fset_005fnest_005flock">omp_set_nest_lock</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.27 <code>omp_test_nest_lock</code> – Test and set nested lock if available</h3>
<dl>
<dt><em>Description</em>:<dd>Before setting a nested lock, the lock variable must be initialized by
<code>omp_init_nest_lock</code>. Contrary to <code>omp_set_nest_lock</code>,
<code>omp_test_nest_lock</code> does not block if the lock is not available.
If the lock is already held by the current thread, the new nesting count
is returned. Otherwise, the return value equals zero.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>int omp_test_nest_lock(omp_nest_lock_t *lock);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>integer function omp_test_nest_lock(lock)</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>integer(omp_integer_kind) :: omp_test_nest_lock</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>integer(omp_nest_lock_kind), intent(inout) :: lock</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005finit_005flock">omp_init_lock</a>, <a href="#omp_005fset_005flock">omp_set_lock</a>, <a href="#omp_005fset_005flock">omp_set_lock</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.3.5.
</dl>
<div class="node">
<a name="omp_unset_nest_lock"></a>
<a name="omp_005funset_005fnest_005flock"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fdestroy_005fnest_005flock">omp_destroy_nest_lock</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005ftest_005fnest_005flock">omp_test_nest_lock</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.28 <code>omp_unset_nest_lock</code> – Unset nested lock</h3>
<dl>
<dt><em>Description</em>:<dd>A nested lock about to be unset must have been locked by <code>omp_set_nested_lock</code>
or <code>omp_test_nested_lock</code> before. In addition, the lock must be held by the
thread calling <code>omp_unset_nested_lock</code>. If the nesting count drops to zero, the
lock becomes unlocked. If one ore more threads attempted to set the lock before,
one of them is chosen to, again, set the lock for itself.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>void omp_unset_nest_lock(omp_nest_lock_t *lock);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>subroutine omp_unset_nest_lock(lock)</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>integer(omp_nest_lock_kind), intent(inout) :: lock</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005fset_005fnest_005flock">omp_set_nest_lock</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.3.4.
</dl>
<div class="node">
<a name="omp_destroy_nest_lock"></a>
<a name="omp_005fdestroy_005fnest_005flock"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fget_005fwtick">omp_get_wtick</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005funset_005fnest_005flock">omp_unset_nest_lock</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.29 <code>omp_destroy_nest_lock</code> – Destroy nested lock</h3>
<dl>
<dt><em>Description</em>:<dd>Destroy a nested lock. In order to be destroyed, a nested lock must be
in the unlocked state and its nesting count must equal zero.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>void omp_destroy_nest_lock(omp_nest_lock_t *);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>subroutine omp_destroy_nest_lock(lock)</code>
<br></td></tr><tr align="left"><td valign="top" width="20%"></td><td valign="top" width="80%"><code>integer(omp_nest_lock_kind), intent(inout) :: lock</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005finit_005flock">omp_init_lock</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.3.2.
</dl>
<div class="node">
<a name="omp_get_wtick"></a>
<a name="omp_005fget_005fwtick"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#omp_005fget_005fwtime">omp_get_wtime</a>,
Previous: <a rel="previous" accesskey="p" href="#omp_005fdestroy_005fnest_005flock">omp_destroy_nest_lock</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.30 <code>omp_get_wtick</code> – Get timer precision</h3>
<dl>
<dt><em>Description</em>:<dd>Gets the timer precision, i.e., the number of seconds between two
successive clock ticks.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>double omp_get_wtick(void);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>double precision function omp_get_wtick()</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005fget_005fwtime">omp_get_wtime</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.4.2.
</dl>
<div class="node">
<a name="omp_get_wtime"></a>
<a name="omp_005fget_005fwtime"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#omp_005fget_005fwtick">omp_get_wtick</a>,
Up: <a rel="up" accesskey="u" href="#Runtime-Library-Routines">Runtime Library Routines</a>
</div>
<h3 class="section">2.31 <code>omp_get_wtime</code> – Elapsed wall clock time</h3>
<dl>
<dt><em>Description</em>:<dd>Elapsed wall clock time in seconds. The time is measured per thread, no
guarantee can be made that two distinct threads measure the same time.
Time is measured from some "time in the past", which is an arbitrary time
guaranteed not to change during the execution of the program.
<br><dt><em>C/C++</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Prototype</em>: </td><td valign="top" width="80%"><code>double omp_get_wtime(void);</code>
<br></td></tr></table>
<br><dt><em>Fortran</em>:<dd>
<p><table summary=""><tr align="left"><td valign="top" width="20%"><em>Interface</em>: </td><td valign="top" width="80%"><code>double precision function omp_get_wtime()</code>
<br></td></tr></table>
<br><dt><em>See also</em>:<dd><a href="#omp_005fget_005fwtick">omp_get_wtick</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 3.4.1.
</dl>
<!-- -->
<!-- Environment Variables -->
<!-- -->
<div class="node">
<a name="Environment-Variables"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#The-libgomp-ABI">The libgomp ABI</a>,
Previous: <a rel="previous" accesskey="p" href="#Runtime-Library-Routines">Runtime Library Routines</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">3 Environment Variables</h2>
<p>The variables <samp><span class="env">OMP_DYNAMIC</span></samp>, <samp><span class="env">OMP_MAX_ACTIVE_LEVELS</span></samp>,
<samp><span class="env">OMP_NESTED</span></samp>, <samp><span class="env">OMP_NUM_THREADS</span></samp>, <samp><span class="env">OMP_SCHEDULE</span></samp>,
<samp><span class="env">OMP_STACKSIZE</span></samp>,<samp><span class="env">OMP_THREAD_LIMIT</span></samp> and <samp><span class="env">OMP_WAIT_POLICY</span></samp>
are defined by section 4 of the OpenMP specifications in version 3.0,
while <samp><span class="env">GOMP_CPU_AFFINITY</span></samp> and <samp><span class="env">GOMP_STACKSIZE</span></samp> are GNU
extensions.
<ul class="menu">
<li><a accesskey="1" href="#OMP_005fDYNAMIC">OMP_DYNAMIC</a>: Dynamic adjustment of threads
<li><a accesskey="2" href="#OMP_005fMAX_005fACTIVE_005fLEVELS">OMP_MAX_ACTIVE_LEVELS</a>: Set the maximum number of nested parallel regions
<li><a accesskey="3" href="#OMP_005fNESTED">OMP_NESTED</a>: Nested parallel regions
<li><a accesskey="4" href="#OMP_005fNUM_005fTHREADS">OMP_NUM_THREADS</a>: Specifies the number of threads to use
<li><a accesskey="5" href="#OMP_005fSTACKSIZE">OMP_STACKSIZE</a>: Set default thread stack size
<li><a accesskey="6" href="#OMP_005fSCHEDULE">OMP_SCHEDULE</a>: How threads are scheduled
<li><a accesskey="7" href="#OMP_005fTHREAD_005fLIMIT">OMP_THREAD_LIMIT</a>: Set the maximum number of threads
<li><a accesskey="8" href="#OMP_005fWAIT_005fPOLICY">OMP_WAIT_POLICY</a>: How waiting threads are handled
<li><a accesskey="9" href="#GOMP_005fCPU_005fAFFINITY">GOMP_CPU_AFFINITY</a>: Bind threads to specific CPUs
<li><a href="#GOMP_005fSTACKSIZE">GOMP_STACKSIZE</a>: Set default thread stack size
</ul>
<div class="node">
<a name="OMP_DYNAMIC"></a>
<a name="OMP_005fDYNAMIC"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#OMP_005fMAX_005fACTIVE_005fLEVELS">OMP_MAX_ACTIVE_LEVELS</a>,
Up: <a rel="up" accesskey="u" href="#Environment-Variables">Environment Variables</a>
</div>
<h3 class="section">3.1 <samp><span class="env">OMP_DYNAMIC</span></samp> – Dynamic adjustment of threads</h3>
<p><a name="index-Environment-Variable-2"></a>
<dl>
<dt><em>Description</em>:<dd>Enable or disable the dynamic adjustment of the number of threads
within a team. The value of this environment variable shall be
<code>TRUE</code> or <code>FALSE</code>. If undefined, dynamic adjustment is
disabled by default.
<br><dt><em>See also</em>:<dd><a href="#omp_005fset_005fdynamic">omp_set_dynamic</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 4.3
</dl>
<div class="node">
<a name="OMP_MAX_ACTIVE_LEVELS"></a>
<a name="OMP_005fMAX_005fACTIVE_005fLEVELS"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#OMP_005fNESTED">OMP_NESTED</a>,
Previous: <a rel="previous" accesskey="p" href="#OMP_005fDYNAMIC">OMP_DYNAMIC</a>,
Up: <a rel="up" accesskey="u" href="#Environment-Variables">Environment Variables</a>
</div>
<h3 class="section">3.2 <samp><span class="env">OMP_MAX_ACTIVE_LEVELS</span></samp> – Set the maximum number of nested parallel regions</h3>
<p><a name="index-Environment-Variable-3"></a>
<dl>
<dt><em>Description</em>:<dd>Specifies the initial value for the maximum number of nested parallel
regions. The value of this variable shall be positive integer.
If undefined, the number of active levels is unlimited.
<br><dt><em>See also</em>:<dd><a href="#omp_005fset_005fmax_005factive_005flevels">omp_set_max_active_levels</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 4.7
</dl>
<div class="node">
<a name="OMP_NESTED"></a>
<a name="OMP_005fNESTED"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#OMP_005fNUM_005fTHREADS">OMP_NUM_THREADS</a>,
Previous: <a rel="previous" accesskey="p" href="#OMP_005fMAX_005fACTIVE_005fLEVELS">OMP_MAX_ACTIVE_LEVELS</a>,
Up: <a rel="up" accesskey="u" href="#Environment-Variables">Environment Variables</a>
</div>
<h3 class="section">3.3 <samp><span class="env">OMP_NESTED</span></samp> – Nested parallel regions</h3>
<p><a name="index-Environment-Variable-4"></a><a name="index-Implementation-specific-setting-5"></a>
<dl>
<dt><em>Description</em>:<dd>Enable or disable nested parallel regions, i.e., whether team members
are allowed to create new teams. The value of this environment variable
shall be <code>TRUE</code> or <code>FALSE</code>. If undefined, nested parallel
regions are disabled by default.
<br><dt><em>See also</em>:<dd><a href="#omp_005fset_005fnested">omp_set_nested</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 4.4
</dl>
<div class="node">
<a name="OMP_NUM_THREADS"></a>
<a name="OMP_005fNUM_005fTHREADS"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#OMP_005fSTACKSIZE">OMP_STACKSIZE</a>,
Previous: <a rel="previous" accesskey="p" href="#OMP_005fNESTED">OMP_NESTED</a>,
Up: <a rel="up" accesskey="u" href="#Environment-Variables">Environment Variables</a>
</div>
<h3 class="section">3.4 <samp><span class="env">OMP_NUM_THREADS</span></samp> – Specifies the number of threads to use</h3>
<p><a name="index-Environment-Variable-6"></a><a name="index-Implementation-specific-setting-7"></a>
<dl>
<dt><em>Description</em>:<dd>Specifies the default number of threads to use in parallel regions. The
value of this variable shall be a positive integer. If undefined one thread
per CPU is used.
<br><dt><em>See also</em>:<dd><a href="#omp_005fset_005fnum_005fthreads">omp_set_num_threads</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 4.2
</dl>
<div class="node">
<a name="OMP_SCHEDULE"></a>
<a name="OMP_005fSCHEDULE"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#OMP_005fTHREAD_005fLIMIT">OMP_THREAD_LIMIT</a>,
Previous: <a rel="previous" accesskey="p" href="#OMP_005fSTACKSIZE">OMP_STACKSIZE</a>,
Up: <a rel="up" accesskey="u" href="#Environment-Variables">Environment Variables</a>
</div>
<h3 class="section">3.5 <samp><span class="env">OMP_SCHEDULE</span></samp> – How threads are scheduled</h3>
<p><a name="index-Environment-Variable-8"></a><a name="index-Implementation-specific-setting-9"></a>
<dl>
<dt><em>Description</em>:<dd>Allows to specify <code>schedule type</code> and <code>chunk size</code>.
The value of the variable shall have the form: <code>type[,chunk]</code> where
<code>type</code> is one of <code>static</code>, <code>dynamic</code>, <code>guided</code> or <code>auto</code>
The optional <code>chunk</code> size shall be a positive integer. If undefined,
dynamic scheduling and a chunk size of 1 is used.
<br><dt><em>See also</em>:<dd><a href="#omp_005fset_005fschedule">omp_set_schedule</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, sections 2.5.1 and 4.1
</dl>
<div class="node">
<a name="OMP_STACKSIZE"></a>
<a name="OMP_005fSTACKSIZE"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#OMP_005fSCHEDULE">OMP_SCHEDULE</a>,
Previous: <a rel="previous" accesskey="p" href="#OMP_005fNUM_005fTHREADS">OMP_NUM_THREADS</a>,
Up: <a rel="up" accesskey="u" href="#Environment-Variables">Environment Variables</a>
</div>
<h3 class="section">3.6 <samp><span class="env">OMP_STACKSIZE</span></samp> – Set default thread stack size</h3>
<p><a name="index-Environment-Variable-10"></a>
<dl>
<dt><em>Description</em>:<dd>Set the default thread stack size in kilobytes, unless the number
is suffixed by <code>B</code>, <code>K</code>, <code>M</code> or <code>G</code>, in which
case the size is, respectively, in bytes, kilobytes, megabytes
or gigabytes. This is different from <code>pthread_attr_setstacksize</code>
which gets the number of bytes as an argument. If the stacksize cannot
be set due to system constraints, an error is reported and the initial
stacksize is left unchanged. If undefined, the stack size is system
dependent.
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, sections 4.5
</dl>
<div class="node">
<a name="OMP_THREAD_LIMIT"></a>
<a name="OMP_005fTHREAD_005fLIMIT"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#OMP_005fWAIT_005fPOLICY">OMP_WAIT_POLICY</a>,
Previous: <a rel="previous" accesskey="p" href="#OMP_005fSCHEDULE">OMP_SCHEDULE</a>,
Up: <a rel="up" accesskey="u" href="#Environment-Variables">Environment Variables</a>
</div>
<h3 class="section">3.7 <samp><span class="env">OMP_THREAD_LIMIT</span></samp> – Set the maximum number of threads</h3>
<p><a name="index-Environment-Variable-11"></a>
<dl>
<dt><em>Description</em>:<dd>Specifies the number of threads to use for the whole program. The
value of this variable shall be a positive integer. If undefined,
the number of threads is not limited.
<br><dt><em>See also</em>:<dd><a href="#OMP_005fNUM_005fTHREADS">OMP_NUM_THREADS</a>
<a href="#omp_005fget_005fthread_005flimit">omp_get_thread_limit</a>
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, section 4.8
</dl>
<div class="node">
<a name="OMP_WAIT_POLICY"></a>
<a name="OMP_005fWAIT_005fPOLICY"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#GOMP_005fCPU_005fAFFINITY">GOMP_CPU_AFFINITY</a>,
Previous: <a rel="previous" accesskey="p" href="#OMP_005fTHREAD_005fLIMIT">OMP_THREAD_LIMIT</a>,
Up: <a rel="up" accesskey="u" href="#Environment-Variables">Environment Variables</a>
</div>
<h3 class="section">3.8 <samp><span class="env">OMP_WAIT_POLICY</span></samp> – How waiting threads are handled</h3>
<p><a name="index-Environment-Variable-12"></a>
<dl>
<dt><em>Description</em>:<dd>Specifies whether waiting threads should be active or passive. If
the value is <code>PASSIVE</code>, waiting threads should not consume CPU
power while waiting; while the value is <code>ACTIVE</code> specifies that
they should.
<br><dt><em>Reference</em>:<dd><a href="http://www.openmp.org/">OpenMP specifications v3.0</a>, sections 4.6
</dl>
<div class="node">
<a name="GOMP_CPU_AFFINITY"></a>
<a name="GOMP_005fCPU_005fAFFINITY"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#GOMP_005fSTACKSIZE">GOMP_STACKSIZE</a>,
Previous: <a rel="previous" accesskey="p" href="#OMP_005fWAIT_005fPOLICY">OMP_WAIT_POLICY</a>,
Up: <a rel="up" accesskey="u" href="#Environment-Variables">Environment Variables</a>
</div>
<h3 class="section">3.9 <samp><span class="env">GOMP_CPU_AFFINITY</span></samp> – Bind threads to specific CPUs</h3>
<p><a name="index-Environment-Variable-13"></a>
<dl>
<dt><em>Description</em>:<dd>Binds threads to specific CPUs. The variable should contain a space-separated
or comma-separated list of CPUs. This list may contain different kinds of
entries: either single CPU numbers in any order, a range of CPUs (M-N)
or a range with some stride (M-N:S). CPU numbers are zero based. For example,
<code>GOMP_CPU_AFFINITY="0 3 1-2 4-15:2"</code> will bind the initial thread
to CPU 0, the second to CPU 3, the third to CPU 1, the fourth to
CPU 2, the fifth to CPU 4, the sixth through tenth to CPUs 6, 8, 10, 12,
and 14 respectively and then start assigning back from the beginning of
the list. <code>GOMP_CPU_AFFINITY=0</code> binds all threads to CPU 0.
<p>There is no GNU OpenMP library routine to determine whether a CPU affinity
specification is in effect. As a workaround, language-specific library
functions, e.g., <code>getenv</code> in C or <code>GET_ENVIRONMENT_VARIABLE</code> in
Fortran, may be used to query the setting of the <code>GOMP_CPU_AFFINITY</code>
environment variable. A defined CPU affinity on startup cannot be changed
or disabled during the runtime of the application.
<p>If this environment variable is omitted, the host system will handle the
assignment of threads to CPUs.
</dl>
<div class="node">
<a name="GOMP_STACKSIZE"></a>
<a name="GOMP_005fSTACKSIZE"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#GOMP_005fCPU_005fAFFINITY">GOMP_CPU_AFFINITY</a>,
Up: <a rel="up" accesskey="u" href="#Environment-Variables">Environment Variables</a>
</div>
<h3 class="section">3.10 <samp><span class="env">GOMP_STACKSIZE</span></samp> – Set default thread stack size</h3>
<p><a name="index-Environment-Variable-14"></a><a name="index-Implementation-specific-setting-15"></a>
<dl>
<dt><em>Description</em>:<dd>Set the default thread stack size in kilobytes. This is different from
<code>pthread_attr_setstacksize</code> which gets the number of bytes as an
argument. If the stacksize cannot be set due to system constraints, an
error is reported and the initial stacksize is left unchanged. If undefined,
the stack size is system dependent.
<br><dt><em>See also</em>:<dd><a href="#OMP_005fSTACKSIZE">OMP_STACKSIZE</a>
<br><dt><em>Reference</em>:<dd><a href="http://gcc.gnu.org/ml/gcc-patches/2006-06/msg00493.html">GCC Patches Mailinglist</a>,
<a href="http://gcc.gnu.org/ml/gcc-patches/2006-06/msg00496.html">GCC Patches Mailinglist</a>
</dl>
<!-- -->
<!-- The libgomp ABI -->
<!-- -->
<div class="node">
<a name="The-libgomp-ABI"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Reporting-Bugs">Reporting Bugs</a>,
Previous: <a rel="previous" accesskey="p" href="#Environment-Variables">Environment Variables</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">4 The libgomp ABI</h2>
<p>The following sections present notes on the external ABI as
presented by libgomp. Only maintainers should need them.
<ul class="menu">
<li><a accesskey="1" href="#Implementing-MASTER-construct">Implementing MASTER construct</a>
<li><a accesskey="2" href="#Implementing-CRITICAL-construct">Implementing CRITICAL construct</a>
<li><a accesskey="3" href="#Implementing-ATOMIC-construct">Implementing ATOMIC construct</a>
<li><a accesskey="4" href="#Implementing-FLUSH-construct">Implementing FLUSH construct</a>
<li><a accesskey="5" href="#Implementing-BARRIER-construct">Implementing BARRIER construct</a>
<li><a accesskey="6" href="#Implementing-THREADPRIVATE-construct">Implementing THREADPRIVATE construct</a>
<li><a accesskey="7" href="#Implementing-PRIVATE-clause">Implementing PRIVATE clause</a>
<li><a accesskey="8" href="#Implementing-FIRSTPRIVATE-LASTPRIVATE-COPYIN-and-COPYPRIVATE-clauses">Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses</a>
<li><a accesskey="9" href="#Implementing-REDUCTION-clause">Implementing REDUCTION clause</a>
<li><a href="#Implementing-PARALLEL-construct">Implementing PARALLEL construct</a>
<li><a href="#Implementing-FOR-construct">Implementing FOR construct</a>
<li><a href="#Implementing-ORDERED-construct">Implementing ORDERED construct</a>
<li><a href="#Implementing-SECTIONS-construct">Implementing SECTIONS construct</a>
<li><a href="#Implementing-SINGLE-construct">Implementing SINGLE construct</a>
</ul>
<div class="node">
<a name="Implementing-MASTER-construct"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Implementing-CRITICAL-construct">Implementing CRITICAL construct</a>,
Up: <a rel="up" accesskey="u" href="#The-libgomp-ABI">The libgomp ABI</a>
</div>
<h3 class="section">4.1 Implementing MASTER construct</h3>
<pre class="smallexample"> if (omp_get_thread_num () == 0)
block
</pre>
<p>Alternately, we generate two copies of the parallel subfunction
and only include this in the version run by the master thread.
Surely this is not worthwhile though...
<div class="node">
<a name="Implementing-CRITICAL-construct"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Implementing-ATOMIC-construct">Implementing ATOMIC construct</a>,
Previous: <a rel="previous" accesskey="p" href="#Implementing-MASTER-construct">Implementing MASTER construct</a>,
Up: <a rel="up" accesskey="u" href="#The-libgomp-ABI">The libgomp ABI</a>
</div>
<h3 class="section">4.2 Implementing CRITICAL construct</h3>
<p>Without a specified name,
<pre class="smallexample"> void GOMP_critical_start (void);
void GOMP_critical_end (void);
</pre>
<p>so that we don't get COPY relocations from libgomp to the main
application.
<p>With a specified name, use omp_set_lock and omp_unset_lock with
name being transformed into a variable declared like
<pre class="smallexample"> omp_lock_t gomp_critical_user_<name> __attribute__((common))
</pre>
<p>Ideally the ABI would specify that all zero is a valid unlocked
state, and so we wouldn't need to initialize this at
startup.
<div class="node">
<a name="Implementing-ATOMIC-construct"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Implementing-FLUSH-construct">Implementing FLUSH construct</a>,
Previous: <a rel="previous" accesskey="p" href="#Implementing-CRITICAL-construct">Implementing CRITICAL construct</a>,
Up: <a rel="up" accesskey="u" href="#The-libgomp-ABI">The libgomp ABI</a>
</div>
<h3 class="section">4.3 Implementing ATOMIC construct</h3>
<p>The target should implement the <code>__sync</code> builtins.
<p>Failing that we could add
<pre class="smallexample"> void GOMP_atomic_enter (void)
void GOMP_atomic_exit (void)
</pre>
<p>which reuses the regular lock code, but with yet another lock
object private to the library.
<div class="node">
<a name="Implementing-FLUSH-construct"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Implementing-BARRIER-construct">Implementing BARRIER construct</a>,
Previous: <a rel="previous" accesskey="p" href="#Implementing-ATOMIC-construct">Implementing ATOMIC construct</a>,
Up: <a rel="up" accesskey="u" href="#The-libgomp-ABI">The libgomp ABI</a>
</div>
<h3 class="section">4.4 Implementing FLUSH construct</h3>
<p>Expands to the <code>__sync_synchronize</code> builtin.
<div class="node">
<a name="Implementing-BARRIER-construct"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Implementing-THREADPRIVATE-construct">Implementing THREADPRIVATE construct</a>,
Previous: <a rel="previous" accesskey="p" href="#Implementing-FLUSH-construct">Implementing FLUSH construct</a>,
Up: <a rel="up" accesskey="u" href="#The-libgomp-ABI">The libgomp ABI</a>
</div>
<h3 class="section">4.5 Implementing BARRIER construct</h3>
<pre class="smallexample"> void GOMP_barrier (void)
</pre>
<div class="node">
<a name="Implementing-THREADPRIVATE-construct"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Implementing-PRIVATE-clause">Implementing PRIVATE clause</a>,
Previous: <a rel="previous" accesskey="p" href="#Implementing-BARRIER-construct">Implementing BARRIER construct</a>,
Up: <a rel="up" accesskey="u" href="#The-libgomp-ABI">The libgomp ABI</a>
</div>
<h3 class="section">4.6 Implementing THREADPRIVATE construct</h3>
<p>In _most_ cases we can map this directly to <code>__thread</code>. Except
that OMP allows constructors for C++ objects. We can either
refuse to support this (how often is it used?) or we can
implement something akin to .ctors.
<p>Even more ideally, this ctor feature is handled by extensions
to the main pthreads library. Failing that, we can have a set
of entry points to register ctor functions to be called.
<div class="node">
<a name="Implementing-PRIVATE-clause"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Implementing-FIRSTPRIVATE-LASTPRIVATE-COPYIN-and-COPYPRIVATE-clauses">Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses</a>,
Previous: <a rel="previous" accesskey="p" href="#Implementing-THREADPRIVATE-construct">Implementing THREADPRIVATE construct</a>,
Up: <a rel="up" accesskey="u" href="#The-libgomp-ABI">The libgomp ABI</a>
</div>
<h3 class="section">4.7 Implementing PRIVATE clause</h3>
<p>In association with a PARALLEL, or within the lexical extent
of a PARALLEL block, the variable becomes a local variable in
the parallel subfunction.
<p>In association with FOR or SECTIONS blocks, create a new
automatic variable within the current function. This preserves
the semantic of new variable creation.
<div class="node">
<a name="Implementing-FIRSTPRIVATE-LASTPRIVATE-COPYIN-and-COPYPRIVATE-clauses"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Implementing-REDUCTION-clause">Implementing REDUCTION clause</a>,
Previous: <a rel="previous" accesskey="p" href="#Implementing-PRIVATE-clause">Implementing PRIVATE clause</a>,
Up: <a rel="up" accesskey="u" href="#The-libgomp-ABI">The libgomp ABI</a>
</div>
<h3 class="section">4.8 Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses</h3>
<p>This seems simple enough for PARALLEL blocks. Create a private
struct for communicating between the parent and subfunction.
In the parent, copy in values for scalar and "small" structs;
copy in addresses for others TREE_ADDRESSABLE types. In the
subfunction, copy the value into the local variable.
<p>It is not clear what to do with bare FOR or SECTION blocks.
The only thing I can figure is that we do something like:
<pre class="smallexample"> #pragma omp for firstprivate(x) lastprivate(y)
for (int i = 0; i < n; ++i)
body;
</pre>
<p>which becomes
<pre class="smallexample"> {
int x = x, y;
// for stuff
if (i == n)
y = y;
}
</pre>
<p>where the "x=x" and "y=y" assignments actually have different
uids for the two variables, i.e. not something you could write
directly in C. Presumably this only makes sense if the "outer"
x and y are global variables.
<p>COPYPRIVATE would work the same way, except the structure
broadcast would have to happen via SINGLE machinery instead.
<div class="node">
<a name="Implementing-REDUCTION-clause"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Implementing-PARALLEL-construct">Implementing PARALLEL construct</a>,
Previous: <a rel="previous" accesskey="p" href="#Implementing-FIRSTPRIVATE-LASTPRIVATE-COPYIN-and-COPYPRIVATE-clauses">Implementing FIRSTPRIVATE LASTPRIVATE COPYIN and COPYPRIVATE clauses</a>,
Up: <a rel="up" accesskey="u" href="#The-libgomp-ABI">The libgomp ABI</a>
</div>
<h3 class="section">4.9 Implementing REDUCTION clause</h3>
<p>The private struct mentioned in the previous section should have
a pointer to an array of the type of the variable, indexed by the
thread's <var>team_id</var>. The thread stores its final value into the
array, and after the barrier, the master thread iterates over the
array to collect the values.
<div class="node">
<a name="Implementing-PARALLEL-construct"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Implementing-FOR-construct">Implementing FOR construct</a>,
Previous: <a rel="previous" accesskey="p" href="#Implementing-REDUCTION-clause">Implementing REDUCTION clause</a>,
Up: <a rel="up" accesskey="u" href="#The-libgomp-ABI">The libgomp ABI</a>
</div>
<h3 class="section">4.10 Implementing PARALLEL construct</h3>
<pre class="smallexample"> #pragma omp parallel
{
body;
}
</pre>
<p>becomes
<pre class="smallexample"> void subfunction (void *data)
{
use data;
body;
}
setup data;
GOMP_parallel_start (subfunction, &data, num_threads);
subfunction (&data);
GOMP_parallel_end ();
</pre>
<pre class="smallexample"> void GOMP_parallel_start (void (*fn)(void *), void *data, unsigned num_threads)
</pre>
<p>The <var>FN</var> argument is the subfunction to be run in parallel.
<p>The <var>DATA</var> argument is a pointer to a structure used to
communicate data in and out of the subfunction, as discussed
above with respect to FIRSTPRIVATE et al.
<p>The <var>NUM_THREADS</var> argument is 1 if an IF clause is present
and false, or the value of the NUM_THREADS clause, if
present, or 0.
<p>The function needs to create the appropriate number of
threads and/or launch them from the dock. It needs to
create the team structure and assign team ids.
<pre class="smallexample"> void GOMP_parallel_end (void)
</pre>
<p>Tears down the team and returns us to the previous <code>omp_in_parallel()</code> state.
<div class="node">
<a name="Implementing-FOR-construct"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Implementing-ORDERED-construct">Implementing ORDERED construct</a>,
Previous: <a rel="previous" accesskey="p" href="#Implementing-PARALLEL-construct">Implementing PARALLEL construct</a>,
Up: <a rel="up" accesskey="u" href="#The-libgomp-ABI">The libgomp ABI</a>
</div>
<h3 class="section">4.11 Implementing FOR construct</h3>
<pre class="smallexample"> #pragma omp parallel for
for (i = lb; i <= ub; i++)
body;
</pre>
<p>becomes
<pre class="smallexample"> void subfunction (void *data)
{
long _s0, _e0;
while (GOMP_loop_static_next (&_s0, &_e0))
{
long _e1 = _e0, i;
for (i = _s0; i < _e1; i++)
body;
}
GOMP_loop_end_nowait ();
}
GOMP_parallel_loop_static (subfunction, NULL, 0, lb, ub+1, 1, 0);
subfunction (NULL);
GOMP_parallel_end ();
</pre>
<pre class="smallexample"> #pragma omp for schedule(runtime)
for (i = 0; i < n; i++)
body;
</pre>
<p>becomes
<pre class="smallexample"> {
long i, _s0, _e0;
if (GOMP_loop_runtime_start (0, n, 1, &_s0, &_e0))
do {
long _e1 = _e0;
for (i = _s0, i < _e0; i++)
body;
} while (GOMP_loop_runtime_next (&_s0, _&e0));
GOMP_loop_end ();
}
</pre>
<p>Note that while it looks like there is trickiness to propagating
a non-constant STEP, there isn't really. We're explicitly allowed
to evaluate it as many times as we want, and any variables involved
should automatically be handled as PRIVATE or SHARED like any other
variables. So the expression should remain evaluable in the
subfunction. We can also pull it into a local variable if we like,
but since its supposed to remain unchanged, we can also not if we like.
<p>If we have SCHEDULE(STATIC), and no ORDERED, then we ought to be
able to get away with no work-sharing context at all, since we can
simply perform the arithmetic directly in each thread to divide up
the iterations. Which would mean that we wouldn't need to call any
of these routines.
<p>There are separate routines for handling loops with an ORDERED
clause. Bookkeeping for that is non-trivial...
<div class="node">
<a name="Implementing-ORDERED-construct"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Implementing-SECTIONS-construct">Implementing SECTIONS construct</a>,
Previous: <a rel="previous" accesskey="p" href="#Implementing-FOR-construct">Implementing FOR construct</a>,
Up: <a rel="up" accesskey="u" href="#The-libgomp-ABI">The libgomp ABI</a>
</div>
<h3 class="section">4.12 Implementing ORDERED construct</h3>
<pre class="smallexample"> void GOMP_ordered_start (void)
void GOMP_ordered_end (void)
</pre>
<div class="node">
<a name="Implementing-SECTIONS-construct"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Implementing-SINGLE-construct">Implementing SINGLE construct</a>,
Previous: <a rel="previous" accesskey="p" href="#Implementing-ORDERED-construct">Implementing ORDERED construct</a>,
Up: <a rel="up" accesskey="u" href="#The-libgomp-ABI">The libgomp ABI</a>
</div>
<h3 class="section">4.13 Implementing SECTIONS construct</h3>
<p>A block as
<pre class="smallexample"> #pragma omp sections
{
#pragma omp section
stmt1;
#pragma omp section
stmt2;
#pragma omp section
stmt3;
}
</pre>
<p>becomes
<pre class="smallexample"> for (i = GOMP_sections_start (3); i != 0; i = GOMP_sections_next ())
switch (i)
{
case 1:
stmt1;
break;
case 2:
stmt2;
break;
case 3:
stmt3;
break;
}
GOMP_barrier ();
</pre>
<div class="node">
<a name="Implementing-SINGLE-construct"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Implementing-SECTIONS-construct">Implementing SECTIONS construct</a>,
Up: <a rel="up" accesskey="u" href="#The-libgomp-ABI">The libgomp ABI</a>
</div>
<h3 class="section">4.14 Implementing SINGLE construct</h3>
<p>A block like
<pre class="smallexample"> #pragma omp single
{
body;
}
</pre>
<p>becomes
<pre class="smallexample"> if (GOMP_single_start ())
body;
GOMP_barrier ();
</pre>
<p>while
<pre class="smallexample"> #pragma omp single copyprivate(x)
body;
</pre>
<p>becomes
<pre class="smallexample"> datap = GOMP_single_copy_start ();
if (datap == NULL)
{
body;
data.x = x;
GOMP_single_copy_end (&data);
}
else
x = datap->x;
GOMP_barrier ();
</pre>
<!-- -->
<!-- -->
<div class="node">
<a name="Reporting-Bugs"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Copying">Copying</a>,
Previous: <a rel="previous" accesskey="p" href="#The-libgomp-ABI">The libgomp ABI</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="chapter">5 Reporting Bugs</h2>
<p>Bugs in the GNU OpenMP implementation should be reported via
<a href="http://gcc.gnu.org/bugzilla/">bugzilla</a>. For all cases, please add
"openmp" to the keywords field in the bug report.
<!-- -->
<!-- GNU General Public License -->
<!-- -->
<div class="node">
<a name="Copying"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#GNU-Free-Documentation-License">GNU Free Documentation License</a>,
Previous: <a rel="previous" accesskey="p" href="#Reporting-Bugs">Reporting Bugs</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<!-- man begin DESCRIPTION -->
<h2 class="unnumbered">GNU GENERAL PUBLIC LICENSE</h2>
<div align="center">Version 2, June 1991</div>
<!-- This file is intended to be included in another file. -->
<pre class="display"> Copyright © 1989, 1991 Free Software Foundation, Inc.
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
</pre>
<h3 class="unnumberedsec">Preamble</h3>
<p>The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software—to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) You can apply it to
your programs, too.
<p>When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
this service if you wish), that you receive source code or can get it
if you want it, that you can change the software or use pieces of it
in new free programs; and that you know you can do these things.
<p>To protect your rights, we need to make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
<p>For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. You must make sure that they, too, receive or can get the
source code. And you must show them these terms so they know their
rights.
<p>We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
<p>Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
<p>Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
<p>The precise terms and conditions for copying, distribution and
modification follow.
<div align="center">TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION</div>
<ol type=1 start=0>
<li>This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The “Program”, below,
refers to any such program or work, and a “work based on the Program”
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term “modification”.) Each licensee is addressed as “you”.
<p>Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
<li>You may copy and distribute verbatim copies of the Program's
source code as you receive it, in any medium, provided that you
conspicuously and appropriately publish on each copy an appropriate
copyright notice and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
<p>You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
<li>You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
<ol type=a start=1>
<li>You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
<li>You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
<li>If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
</ol>
<p>These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
<p>Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
<p>In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
<li>You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
<ol type=a start=1>
<li>Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
<li>Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
<li>Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
</ol>
<p>The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
<p>If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
<li>You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
<li>You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
<li>Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
<li>If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
<p>If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
<p>It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
<p>This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
<li>If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
<li>The Free Software Foundation may publish revised and/or new versions
of the General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
<p>Each version is given a distinguishing version number. If the Program
specifies a version number of this License which applies to it and “any
later version”, you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
<li>If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
<div align="center">NO WARRANTY</div>
<li>BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE PROGRAM “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
REPAIR OR CORRECTION.
<li>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
POSSIBILITY OF SUCH DAMAGES.
</ol>
<div align="center">END OF TERMS AND CONDITIONS</div>
<h3 class="unnumberedsec">Appendix: How to Apply These Terms to Your New Programs</h3>
<p>If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
<p>To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
convey the exclusion of warranty; and each file should have at least
the “copyright” line and a pointer to where the full notice is found.
<pre class="smallexample"> <var>one line to give the program's name and a brief idea of what it does.</var>
Copyright (C) <var>year</var> <var>name of author</var>
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
</pre>
<p>Also add information on how to contact you by electronic and paper mail.
<p>If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
<pre class="smallexample"> Gnomovision version 69, Copyright (C) <var>year</var> <var>name of author</var>
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details
type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
</pre>
<p>The hypothetical commands ‘<samp><span class="samp">show w</span></samp>’ and ‘<samp><span class="samp">show c</span></samp>’ should show
the appropriate parts of the General Public License. Of course, the
commands you use may be called something other than ‘<samp><span class="samp">show w</span></samp>’ and
‘<samp><span class="samp">show c</span></samp>’; they could even be mouse-clicks or menu items—whatever
suits your program.
<p>You should also get your employer (if you work as a programmer) or your
school, if any, to sign a “copyright disclaimer” for the program, if
necessary. Here is a sample; alter the names:
<pre class="example"> Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<var>signature of Ty Coon</var>, 1 April 1989
Ty Coon, President of Vice
</pre>
<p>This General Public License does not permit incorporating your program into
proprietary programs. If your program is a subroutine library, you may
consider it more useful to permit linking proprietary applications with the
library. If this is what you want to do, use the GNU Library General
Public License instead of this License.
<!-- man end -->
<!-- -->
<!-- GNU Free Documentation License -->
<!-- -->
<!-- Special handling for inclusion in the install manual. -->
<!-- man begin DESCRIPTION -->
<div class="node">
<a name="GNU-Free-Documentation-License"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Funding">Funding</a>,
Previous: <a rel="previous" accesskey="p" href="#Copying">Copying</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="unnumbered">GNU Free Documentation License</h2>
<p><a name="index-FDL_002c-GNU-Free-Documentation-License-16"></a><div align="center">Version 1.3, 3 November 2008</div>
<pre class="display"> Copyright © 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc.
<a href="http://fsf.org/">http://fsf.org/</a>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
</pre>
<ol type=1 start=0>
<li>PREAMBLE
<p>The purpose of this License is to make a manual, textbook, or other
functional and useful document <dfn>free</dfn> in the sense of freedom: to
assure everyone the effective freedom to copy and redistribute it,
with or without modifying it, either commercially or noncommercially.
Secondarily, this License preserves for the author and publisher a way
to get credit for their work, while not being considered responsible
for modifications made by others.
<p>This License is a kind of “copyleft”, which means that derivative
works of the document must themselves be free in the same sense. It
complements the GNU General Public License, which is a copyleft
license designed for free software.
<p>We have designed this License in order to use it for manuals for free
software, because free software needs free documentation: a free
program should come with manuals providing the same freedoms that the
software does. But this License is not limited to software manuals;
it can be used for any textual work, regardless of subject matter or
whether it is published as a printed book. We recommend this License
principally for works whose purpose is instruction or reference.
<li>APPLICABILITY AND DEFINITIONS
<p>This License applies to any manual or other work, in any medium, that
contains a notice placed by the copyright holder saying it can be
distributed under the terms of this License. Such a notice grants a
world-wide, royalty-free license, unlimited in duration, to use that
work under the conditions stated herein. The “Document”, below,
refers to any such manual or work. Any member of the public is a
licensee, and is addressed as “you”. You accept the license if you
copy, modify or distribute the work in a way requiring permission
under copyright law.
<p>A “Modified Version” of the Document means any work containing the
Document or a portion of it, either copied verbatim, or with
modifications and/or translated into another language.
<p>A “Secondary Section” is a named appendix or a front-matter section
of the Document that deals exclusively with the relationship of the
publishers or authors of the Document to the Document's overall
subject (or to related matters) and contains nothing that could fall
directly within that overall subject. (Thus, if the Document is in
part a textbook of mathematics, a Secondary Section may not explain
any mathematics.) The relationship could be a matter of historical
connection with the subject or with related matters, or of legal,
commercial, philosophical, ethical or political position regarding
them.
<p>The “Invariant Sections” are certain Secondary Sections whose titles
are designated, as being those of Invariant Sections, in the notice
that says that the Document is released under this License. If a
section does not fit the above definition of Secondary then it is not
allowed to be designated as Invariant. The Document may contain zero
Invariant Sections. If the Document does not identify any Invariant
Sections then there are none.
<p>The “Cover Texts” are certain short passages of text that are listed,
as Front-Cover Texts or Back-Cover Texts, in the notice that says that
the Document is released under this License. A Front-Cover Text may
be at most 5 words, and a Back-Cover Text may be at most 25 words.
<p>A “Transparent” copy of the Document means a machine-readable copy,
represented in a format whose specification is available to the
general public, that is suitable for revising the document
straightforwardly with generic text editors or (for images composed of
pixels) generic paint programs or (for drawings) some widely available
drawing editor, and that is suitable for input to text formatters or
for automatic translation to a variety of formats suitable for input
to text formatters. A copy made in an otherwise Transparent file
format whose markup, or absence of markup, has been arranged to thwart
or discourage subsequent modification by readers is not Transparent.
An image format is not Transparent if used for any substantial amount
of text. A copy that is not “Transparent” is called “Opaque”.
<p>Examples of suitable formats for Transparent copies include plain
<span class="sc">ascii</span> without markup, Texinfo input format, LaTeX input
format, <acronym>SGML</acronym> or <acronym>XML</acronym> using a publicly available
<acronym>DTD</acronym>, and standard-conforming simple <acronym>HTML</acronym>,
PostScript or <acronym>PDF</acronym> designed for human modification. Examples
of transparent image formats include <acronym>PNG</acronym>, <acronym>XCF</acronym> and
<acronym>JPG</acronym>. Opaque formats include proprietary formats that can be
read and edited only by proprietary word processors, <acronym>SGML</acronym> or
<acronym>XML</acronym> for which the <acronym>DTD</acronym> and/or processing tools are
not generally available, and the machine-generated <acronym>HTML</acronym>,
PostScript or <acronym>PDF</acronym> produced by some word processors for
output purposes only.
<p>The “Title Page” means, for a printed book, the title page itself,
plus such following pages as are needed to hold, legibly, the material
this License requires to appear in the title page. For works in
formats which do not have any title page as such, “Title Page” means
the text near the most prominent appearance of the work's title,
preceding the beginning of the body of the text.
<p>The “publisher” means any person or entity that distributes copies
of the Document to the public.
<p>A section “Entitled XYZ” means a named subunit of the Document whose
title either is precisely XYZ or contains XYZ in parentheses following
text that translates XYZ in another language. (Here XYZ stands for a
specific section name mentioned below, such as “Acknowledgements”,
“Dedications”, “Endorsements”, or “History”.) To “Preserve the Title”
of such a section when you modify the Document means that it remains a
section “Entitled XYZ” according to this definition.
<p>The Document may include Warranty Disclaimers next to the notice which
states that this License applies to the Document. These Warranty
Disclaimers are considered to be included by reference in this
License, but only as regards disclaiming warranties: any other
implication that these Warranty Disclaimers may have is void and has
no effect on the meaning of this License.
<li>VERBATIM COPYING
<p>You may copy and distribute the Document in any medium, either
commercially or noncommercially, provided that this License, the
copyright notices, and the license notice saying this License applies
to the Document are reproduced in all copies, and that you add no other
conditions whatsoever to those of this License. You may not use
technical measures to obstruct or control the reading or further
copying of the copies you make or distribute. However, you may accept
compensation in exchange for copies. If you distribute a large enough
number of copies you must also follow the conditions in section 3.
<p>You may also lend copies, under the same conditions stated above, and
you may publicly display copies.
<li>COPYING IN QUANTITY
<p>If you publish printed copies (or copies in media that commonly have
printed covers) of the Document, numbering more than 100, and the
Document's license notice requires Cover Texts, you must enclose the
copies in covers that carry, clearly and legibly, all these Cover
Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
the back cover. Both covers must also clearly and legibly identify
you as the publisher of these copies. The front cover must present
the full title with all words of the title equally prominent and
visible. You may add other material on the covers in addition.
Copying with changes limited to the covers, as long as they preserve
the title of the Document and satisfy these conditions, can be treated
as verbatim copying in other respects.
<p>If the required texts for either cover are too voluminous to fit
legibly, you should put the first ones listed (as many as fit
reasonably) on the actual cover, and continue the rest onto adjacent
pages.
<p>If you publish or distribute Opaque copies of the Document numbering
more than 100, you must either include a machine-readable Transparent
copy along with each Opaque copy, or state in or with each Opaque copy
a computer-network location from which the general network-using
public has access to download using public-standard network protocols
a complete Transparent copy of the Document, free of added material.
If you use the latter option, you must take reasonably prudent steps,
when you begin distribution of Opaque copies in quantity, to ensure
that this Transparent copy will remain thus accessible at the stated
location until at least one year after the last time you distribute an
Opaque copy (directly or through your agents or retailers) of that
edition to the public.
<p>It is requested, but not required, that you contact the authors of the
Document well before redistributing any large number of copies, to give
them a chance to provide you with an updated version of the Document.
<li>MODIFICATIONS
<p>You may copy and distribute a Modified Version of the Document under
the conditions of sections 2 and 3 above, provided that you release
the Modified Version under precisely this License, with the Modified
Version filling the role of the Document, thus licensing distribution
and modification of the Modified Version to whoever possesses a copy
of it. In addition, you must do these things in the Modified Version:
<ol type=A start=1>
<li>Use in the Title Page (and on the covers, if any) a title distinct
from that of the Document, and from those of previous versions
(which should, if there were any, be listed in the History section
of the Document). You may use the same title as a previous version
if the original publisher of that version gives permission.
<li>List on the Title Page, as authors, one or more persons or entities
responsible for authorship of the modifications in the Modified
Version, together with at least five of the principal authors of the
Document (all of its principal authors, if it has fewer than five),
unless they release you from this requirement.
<li>State on the Title page the name of the publisher of the
Modified Version, as the publisher.
<li>Preserve all the copyright notices of the Document.
<li>Add an appropriate copyright notice for your modifications
adjacent to the other copyright notices.
<li>Include, immediately after the copyright notices, a license notice
giving the public permission to use the Modified Version under the
terms of this License, in the form shown in the Addendum below.
<li>Preserve in that license notice the full lists of Invariant Sections
and required Cover Texts given in the Document's license notice.
<li>Include an unaltered copy of this License.
<li>Preserve the section Entitled “History”, Preserve its Title, and add
to it an item stating at least the title, year, new authors, and
publisher of the Modified Version as given on the Title Page. If
there is no section Entitled “History” in the Document, create one
stating the title, year, authors, and publisher of the Document as
given on its Title Page, then add an item describing the Modified
Version as stated in the previous sentence.
<li>Preserve the network location, if any, given in the Document for
public access to a Transparent copy of the Document, and likewise
the network locations given in the Document for previous versions
it was based on. These may be placed in the “History” section.
You may omit a network location for a work that was published at
least four years before the Document itself, or if the original
publisher of the version it refers to gives permission.
<li>For any section Entitled “Acknowledgements” or “Dedications”, Preserve
the Title of the section, and preserve in the section all the
substance and tone of each of the contributor acknowledgements and/or
dedications given therein.
<li>Preserve all the Invariant Sections of the Document,
unaltered in their text and in their titles. Section numbers
or the equivalent are not considered part of the section titles.
<li>Delete any section Entitled “Endorsements”. Such a section
may not be included in the Modified Version.
<li>Do not retitle any existing section to be Entitled “Endorsements” or
to conflict in title with any Invariant Section.
<li>Preserve any Warranty Disclaimers.
</ol>
<p>If the Modified Version includes new front-matter sections or
appendices that qualify as Secondary Sections and contain no material
copied from the Document, you may at your option designate some or all
of these sections as invariant. To do this, add their titles to the
list of Invariant Sections in the Modified Version's license notice.
These titles must be distinct from any other section titles.
<p>You may add a section Entitled “Endorsements”, provided it contains
nothing but endorsements of your Modified Version by various
parties—for example, statements of peer review or that the text has
been approved by an organization as the authoritative definition of a
standard.
<p>You may add a passage of up to five words as a Front-Cover Text, and a
passage of up to 25 words as a Back-Cover Text, to the end of the list
of Cover Texts in the Modified Version. Only one passage of
Front-Cover Text and one of Back-Cover Text may be added by (or
through arrangements made by) any one entity. If the Document already
includes a cover text for the same cover, previously added by you or
by arrangement made by the same entity you are acting on behalf of,
you may not add another; but you may replace the old one, on explicit
permission from the previous publisher that added the old one.
<p>The author(s) and publisher(s) of the Document do not by this License
give permission to use their names for publicity for or to assert or
imply endorsement of any Modified Version.
<li>COMBINING DOCUMENTS
<p>You may combine the Document with other documents released under this
License, under the terms defined in section 4 above for modified
versions, provided that you include in the combination all of the
Invariant Sections of all of the original documents, unmodified, and
list them all as Invariant Sections of your combined work in its
license notice, and that you preserve all their Warranty Disclaimers.
<p>The combined work need only contain one copy of this License, and
multiple identical Invariant Sections may be replaced with a single
copy. If there are multiple Invariant Sections with the same name but
different contents, make the title of each such section unique by
adding at the end of it, in parentheses, the name of the original
author or publisher of that section if known, or else a unique number.
Make the same adjustment to the section titles in the list of
Invariant Sections in the license notice of the combined work.
<p>In the combination, you must combine any sections Entitled “History”
in the various original documents, forming one section Entitled
“History”; likewise combine any sections Entitled “Acknowledgements”,
and any sections Entitled “Dedications”. You must delete all
sections Entitled “Endorsements.”
<li>COLLECTIONS OF DOCUMENTS
<p>You may make a collection consisting of the Document and other documents
released under this License, and replace the individual copies of this
License in the various documents with a single copy that is included in
the collection, provided that you follow the rules of this License for
verbatim copying of each of the documents in all other respects.
<p>You may extract a single document from such a collection, and distribute
it individually under this License, provided you insert a copy of this
License into the extracted document, and follow this License in all
other respects regarding verbatim copying of that document.
<li>AGGREGATION WITH INDEPENDENT WORKS
<p>A compilation of the Document or its derivatives with other separate
and independent documents or works, in or on a volume of a storage or
distribution medium, is called an “aggregate” if the copyright
resulting from the compilation is not used to limit the legal rights
of the compilation's users beyond what the individual works permit.
When the Document is included in an aggregate, this License does not
apply to the other works in the aggregate which are not themselves
derivative works of the Document.
<p>If the Cover Text requirement of section 3 is applicable to these
copies of the Document, then if the Document is less than one half of
the entire aggregate, the Document's Cover Texts may be placed on
covers that bracket the Document within the aggregate, or the
electronic equivalent of covers if the Document is in electronic form.
Otherwise they must appear on printed covers that bracket the whole
aggregate.
<li>TRANSLATION
<p>Translation is considered a kind of modification, so you may
distribute translations of the Document under the terms of section 4.
Replacing Invariant Sections with translations requires special
permission from their copyright holders, but you may include
translations of some or all Invariant Sections in addition to the
original versions of these Invariant Sections. You may include a
translation of this License, and all the license notices in the
Document, and any Warranty Disclaimers, provided that you also include
the original English version of this License and the original versions
of those notices and disclaimers. In case of a disagreement between
the translation and the original version of this License or a notice
or disclaimer, the original version will prevail.
<p>If a section in the Document is Entitled “Acknowledgements”,
“Dedications”, or “History”, the requirement (section 4) to Preserve
its Title (section 1) will typically require changing the actual
title.
<li>TERMINATION
<p>You may not copy, modify, sublicense, or distribute the Document
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense, or distribute it is void, and
will automatically terminate your rights under this License.
<p>However, if you cease all violation of this License, then your license
from a particular copyright holder is reinstated (a) provisionally,
unless and until the copyright holder explicitly and finally
terminates your license, and (b) permanently, if the copyright holder
fails to notify you of the violation by some reasonable means prior to
60 days after the cessation.
<p>Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
<p>Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, receipt of a copy of some or all of the same material does
not give you any rights to use it.
<li>FUTURE REVISIONS OF THIS LICENSE
<p>The Free Software Foundation may publish new, revised versions
of the GNU Free Documentation License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns. See
<a href="http://www.gnu.org/copyleft/">http://www.gnu.org/copyleft/</a>.
<p>Each version of the License is given a distinguishing version number.
If the Document specifies that a particular numbered version of this
License “or any later version” applies to it, you have the option of
following the terms and conditions either of that specified version or
of any later version that has been published (not as a draft) by the
Free Software Foundation. If the Document does not specify a version
number of this License, you may choose any version ever published (not
as a draft) by the Free Software Foundation. If the Document
specifies that a proxy can decide which future versions of this
License can be used, that proxy's public statement of acceptance of a
version permanently authorizes you to choose that version for the
Document.
<li>RELICENSING
<p>“Massive Multiauthor Collaboration Site” (or “MMC Site”) means any
World Wide Web server that publishes copyrightable works and also
provides prominent facilities for anybody to edit those works. A
public wiki that anybody can edit is an example of such a server. A
“Massive Multiauthor Collaboration” (or “MMC”) contained in the
site means any set of copyrightable works thus published on the MMC
site.
<p>“CC-BY-SA” means the Creative Commons Attribution-Share Alike 3.0
license published by Creative Commons Corporation, a not-for-profit
corporation with a principal place of business in San Francisco,
California, as well as future copyleft versions of that license
published by that same organization.
<p>“Incorporate” means to publish or republish a Document, in whole or
in part, as part of another Document.
<p>An MMC is “eligible for relicensing” if it is licensed under this
License, and if all works that were first published under this License
somewhere other than this MMC, and subsequently incorporated in whole
or in part into the MMC, (1) had no cover texts or invariant sections,
and (2) were thus incorporated prior to November 1, 2008.
<p>The operator of an MMC Site may republish an MMC contained in the site
under CC-BY-SA on the same site at any time before August 1, 2009,
provided the MMC is eligible for relicensing.
</ol>
<h3 class="unnumberedsec">ADDENDUM: How to use this License for your documents</h3>
<p>To use this License in a document you have written, include a copy of
the License in the document and put the following copyright and
license notices just after the title page:
<pre class="smallexample"> Copyright (C) <var>year</var> <var>your name</var>.
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3
or any later version published by the Free Software Foundation;
with no Invariant Sections, no Front-Cover Texts, and no Back-Cover
Texts. A copy of the license is included in the section entitled ``GNU
Free Documentation License''.
</pre>
<p>If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
replace the “with...Texts.” line with this:
<pre class="smallexample"> with the Invariant Sections being <var>list their titles</var>, with
the Front-Cover Texts being <var>list</var>, and with the Back-Cover Texts
being <var>list</var>.
</pre>
<p>If you have Invariant Sections without Cover Texts, or some other
combination of the three, merge those two alternatives to suit the
situation.
<p>If your document contains nontrivial examples of program code, we
recommend releasing these examples in parallel under your choice of
free software license, such as the GNU General Public License,
to permit their use in free software.
<!-- Local Variables: -->
<!-- ispell-local-pdict: "ispell-dict" -->
<!-- End: -->
<!-- man end -->
<!-- -->
<!-- Funding Free Software -->
<!-- -->
<div class="node">
<a name="Funding"></a>
<p><hr>
Next: <a rel="next" accesskey="n" href="#Index">Index</a>,
Previous: <a rel="previous" accesskey="p" href="#GNU-Free-Documentation-License">GNU Free Documentation License</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<!-- man begin DESCRIPTION -->
<h2 class="unnumbered">Funding Free Software</h2>
<p>If you want to have more free software a few years from now, it makes
sense for you to help encourage people to contribute funds for its
development. The most effective approach known is to encourage
commercial redistributors to donate.
<p>Users of free software systems can boost the pace of development by
encouraging for-a-fee distributors to donate part of their selling price
to free software developers—the Free Software Foundation, and others.
<p>The way to convince distributors to do this is to demand it and expect
it from them. So when you compare distributors, judge them partly by
how much they give to free software development. Show distributors
they must compete to be the one who gives the most.
<p>To make this approach work, you must insist on numbers that you can
compare, such as, “We will donate ten dollars to the Frobnitz project
for each disk sold.” Don't be satisfied with a vague promise, such as
“A portion of the profits are donated,” since it doesn't give a basis
for comparison.
<p>Even a precise fraction “of the profits from this disk” is not very
meaningful, since creative accounting and unrelated business decisions
can greatly alter what fraction of the sales price counts as profit.
If the price you pay is $50, ten percent of the profit is probably
less than a dollar; it might be a few cents, or nothing at all.
<p>Some redistributors do development work themselves. This is useful too;
but to keep everyone honest, you need to inquire how much they do, and
what kind. Some kinds of development make much more long-term
difference than others. For example, maintaining a separate version of
a program contributes very little; maintaining the standard version of a
program for the whole community contributes much. Easy new ports
contribute little, since someone else would surely do them; difficult
ports such as adding a new CPU to the GNU Compiler Collection contribute more;
major new features or packages contribute the most.
<p>By establishing the idea that supporting further development is “the
proper thing to do” when distributing free software for a fee, we can
assure a steady flow of resources into making more free software.
<!-- man end -->
<pre class="display"> <!-- man begin COPYRIGHT -->
Copyright © 1994 Free Software Foundation, Inc.
Verbatim copying and redistribution of this section is permitted
without royalty; alteration is not permitted.
<!-- man end -->
</pre>
<!-- -->
<!-- Index -->
<!-- -->
<div class="node">
<a name="Index"></a>
<p><hr>
Previous: <a rel="previous" accesskey="p" href="#Funding">Funding</a>,
Up: <a rel="up" accesskey="u" href="#Top">Top</a>
</div>
<h2 class="unnumbered">Index</h2>
<ul class="index-cp" compact>
<li><a href="#index-Environment-Variable-14">Environment Variable</a>: <a href="#GOMP_005fSTACKSIZE">GOMP_STACKSIZE</a></li>
<li><a href="#index-Environment-Variable-13">Environment Variable</a>: <a href="#GOMP_005fCPU_005fAFFINITY">GOMP_CPU_AFFINITY</a></li>
<li><a href="#index-Environment-Variable-12">Environment Variable</a>: <a href="#OMP_005fWAIT_005fPOLICY">OMP_WAIT_POLICY</a></li>
<li><a href="#index-Environment-Variable-11">Environment Variable</a>: <a href="#OMP_005fTHREAD_005fLIMIT">OMP_THREAD_LIMIT</a></li>
<li><a href="#index-Environment-Variable-10">Environment Variable</a>: <a href="#OMP_005fSTACKSIZE">OMP_STACKSIZE</a></li>
<li><a href="#index-Environment-Variable-8">Environment Variable</a>: <a href="#OMP_005fSCHEDULE">OMP_SCHEDULE</a></li>
<li><a href="#index-Environment-Variable-6">Environment Variable</a>: <a href="#OMP_005fNUM_005fTHREADS">OMP_NUM_THREADS</a></li>
<li><a href="#index-Environment-Variable-4">Environment Variable</a>: <a href="#OMP_005fNESTED">OMP_NESTED</a></li>
<li><a href="#index-Environment-Variable-3">Environment Variable</a>: <a href="#OMP_005fMAX_005fACTIVE_005fLEVELS">OMP_MAX_ACTIVE_LEVELS</a></li>
<li><a href="#index-Environment-Variable-2">Environment Variable</a>: <a href="#OMP_005fDYNAMIC">OMP_DYNAMIC</a></li>
<li><a href="#index-FDL_002c-GNU-Free-Documentation-License-16">FDL, GNU Free Documentation License</a>: <a href="#GNU-Free-Documentation-License">GNU Free Documentation License</a></li>
<li><a href="#index-Implementation-specific-setting-15">Implementation specific setting</a>: <a href="#GOMP_005fSTACKSIZE">GOMP_STACKSIZE</a></li>
<li><a href="#index-Implementation-specific-setting-9">Implementation specific setting</a>: <a href="#OMP_005fSCHEDULE">OMP_SCHEDULE</a></li>
<li><a href="#index-Implementation-specific-setting-7">Implementation specific setting</a>: <a href="#OMP_005fNUM_005fTHREADS">OMP_NUM_THREADS</a></li>
<li><a href="#index-Implementation-specific-setting-5">Implementation specific setting</a>: <a href="#OMP_005fNESTED">OMP_NESTED</a></li>
<li><a href="#index-Introduction-1">Introduction</a>: <a href="#Top">Top</a></li>
</ul></body></html>
|