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
|
/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */
/*
* Copyright (c) 2004-2008 The Trustees of Indiana University and Indiana
* University Research and Technology
* Corporation. All rights reserved.
* Copyright (c) 2004-2021 The University of Tennessee and The University
* of Tennessee Research Foundation. All rights
* reserved.
* Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
* University of Stuttgart. All rights reserved.
* Copyright (c) 2004-2005 The Regents of the University of California.
* All rights reserved.
* Copyright (c) 2008-2021 Cisco Systems, Inc. All rights reserved
* Copyright (c) 2012-2018 Los Alamos National Security, LLC. All rights
* reserved.
* Copyright (c) 2014-2020 Intel, Inc. All rights reserved.
* Copyright (c) 2015 Research Organization for Information Science
* and Technology (RIST). All rights reserved.
* Copyright (c) 2017 IBM Corporation. All rights reserved.
* Copyright (c) 2018 Amazon.com, Inc. or its affiliates. All Rights reserved.
* Copyright (c) 2018 Triad National Security, LLC. All rights
* reserved.
* Copyright (c) 2020 Google, LLC. All rights reserved.
* Copyright (c) 2021 Nanook Consulting. All rights reserved.
* Copyright (c) 2022 Computer Architecture and VLSI Systems (CARV)
* Laboratory, ICS Forth. All rights reserved.
* Copyright (c) 2023 Jeffrey M. Squyres. All rights reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*/
#include "opal_config.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#ifdef HAVE_UNISTD_H
# include <unistd.h>
#endif
#ifdef HAVE_SYS_PARAM_H
# include <sys/param.h>
#endif
#include <errno.h>
#include "opal/constants.h"
#include "opal/include/opal_stdint.h"
#include "opal/mca/base/mca_base_alias.h"
#include "opal/mca/base/mca_base_vari.h"
#include "opal/mca/installdirs/installdirs.h"
#include "opal/mca/mca.h"
#include "opal/runtime/opal.h"
#include "opal/runtime/opal_params_core.h"
#include "opal/util/argv.h"
#include "opal/util/opal_environ.h"
#include "opal/util/os_path.h"
#include "opal/util/output.h"
#include "opal/util/path.h"
#include "opal/util/printf.h"
#include "opal/util/show_help.h"
#ifndef MAXPATHLEN /* Hurd */
#define MAXPATHLEN 65535
#endif
#ifndef PATH_MAX /* Hurd */
#define PATH_MAX 65535
#endif
/*
* local variables
*/
static opal_pointer_array_t mca_base_vars;
static const char *mca_prefix = OPAL_MCA_PREFIX;
static char *home = NULL;
static char *cwd = NULL;
bool mca_base_var_initialized = false;
static char *force_agg_path = NULL;
static char *mca_base_var_files = NULL;
static char *mca_base_envar_files = NULL;
static char **mca_base_var_file_list = NULL;
static char *mca_base_var_override_file = NULL;
static char *mca_base_var_file_prefix = NULL;
static char *mca_base_envar_file_prefix = NULL;
static char *mca_base_param_file_path = NULL;
char *mca_base_env_list = NULL;
char *mca_base_env_list_sep = MCA_BASE_ENV_LIST_SEP_DEFAULT;
char *mca_base_env_list_internal = NULL;
static bool mca_base_var_suppress_override_warning = false;
static opal_list_t mca_base_var_file_values;
static opal_list_t mca_base_envar_file_values;
static opal_list_t mca_base_var_override_values;
static int mca_base_var_count = 0;
static opal_hash_table_t mca_base_var_index_hash;
#define OPAL_MCA_VAR_MBV_ENUMERATOR_FREE(mbv_enumerator) \
{ \
if (mbv_enumerator && !mbv_enumerator->enum_is_static) { \
OBJ_RELEASE(mbv_enumerator); \
} \
}
const char *ompi_var_type_names[] = {
"int", "unsigned_int", "unsigned_long", "unsigned_long_long",
"size_t", "string", "version_string", "bool",
"double", "long", "int32_t", "uint32_t",
"int64_t", "uint64_t",
};
const size_t ompi_var_type_sizes[] = {
sizeof(int), sizeof(unsigned), sizeof(unsigned long), sizeof(unsigned long long),
sizeof(size_t), sizeof(char), sizeof(char), sizeof(bool),
sizeof(double), sizeof(long), sizeof(int32_t), sizeof(uint32_t),
sizeof(int64_t), sizeof(uint64_t),
};
static const char *var_source_names[] = {"default", "command line", "environment",
"file", "set", "override"};
static const char *info_lvl_strings[] = {"user/basic", "user/detail", "user/all",
"tuner/basic", "tuner/detail", "tuner/all",
"dev/basic", "dev/detail", "dev/all"};
/*
* local functions
*/
static int fixup_files(char **file_list, char *path, bool rel_path_search, char sep);
static int read_files(char *file_list, opal_list_t *file_values, char sep);
static int var_set_initial(mca_base_var_t *var, mca_base_var_t *original);
static int var_get(int vari, mca_base_var_t **var_out, bool original);
static int var_value_string(mca_base_var_t *var, char **value_string);
static void mca_base_var_finalize(void);
/*
* classes
*/
static void var_constructor(mca_base_var_t *p);
static void var_destructor(mca_base_var_t *p);
OBJ_CLASS_INSTANCE(mca_base_var_t, opal_object_t, var_constructor, var_destructor);
static void fv_constructor(mca_base_var_file_value_t *p);
static void fv_destructor(mca_base_var_file_value_t *p);
OBJ_CLASS_INSTANCE(mca_base_var_file_value_t, opal_list_item_t, fv_constructor, fv_destructor);
static const char *mca_base_var_source_file(const mca_base_var_t *var)
{
mca_base_var_file_value_t *fv = (mca_base_var_file_value_t *) var->mbv_file_value;
if (NULL != var->mbv_source_file) {
return var->mbv_source_file;
}
if (fv) {
return fv->mbvfv_file;
}
return NULL;
}
/*
* Generate a full name from three names
*/
int mca_base_var_generate_full_name4(const char *project, const char *framework,
const char *component, const char *variable, char **full_name)
{
const char *const names[] = {project, framework, component, variable};
char *name, *tmp;
size_t i, len;
*full_name = NULL;
for (i = 0, len = 0; i < 4; ++i) {
if (NULL != names[i]) {
/* Add space for the string + _ or \0 */
len += strlen(names[i]) + 1;
}
}
name = calloc(1, len);
if (NULL == name) {
return OPAL_ERR_OUT_OF_RESOURCE;
}
for (i = 0, tmp = name; i < 4; ++i) {
if (NULL != names[i]) {
if (name != tmp) {
*tmp++ = '_';
}
strncat(name, names[i], len - (size_t)(uintptr_t)(tmp - name));
tmp += strlen(names[i]);
}
}
*full_name = name;
return OPAL_SUCCESS;
}
static int compare_strings(const char *str1, const char *str2)
{
if ((NULL != str1 && 0 == strcmp(str1, "*")) || (NULL == str1 && NULL == str2)) {
return 0;
}
if (NULL != str1 && NULL != str2) {
return strcmp(str1, str2);
}
return 1;
}
/*
* Append a filename to the file list if it does not exist and return a
* pointer to the filename in the list.
*/
static char *append_filename_to_list(const char *filename)
{
int i, count;
(void) opal_argv_append_unique_nosize(&mca_base_var_file_list, filename, false);
count = opal_argv_count(mca_base_var_file_list);
for (i = count - 1; i >= 0; --i) {
if (0 == strcmp(mca_base_var_file_list[i], filename)) {
return mca_base_var_file_list[i];
}
}
/* *#@*? */
return NULL;
}
/*
* Set it up
*/
int mca_base_var_init(void)
{
int ret;
if (!mca_base_var_initialized) {
/* Init the value array for the param storage */
OBJ_CONSTRUCT(&mca_base_vars, opal_pointer_array_t);
/* These values are arbitrary */
ret = opal_pointer_array_init(&mca_base_vars, 128, 16384, 128);
if (OPAL_SUCCESS != ret) {
return ret;
}
mca_base_var_count = 0;
/* Init the file param value list */
OBJ_CONSTRUCT(&mca_base_var_file_values, opal_list_t);
OBJ_CONSTRUCT(&mca_base_envar_file_values, opal_list_t);
OBJ_CONSTRUCT(&mca_base_var_override_values, opal_list_t);
OBJ_CONSTRUCT(&mca_base_var_index_hash, opal_hash_table_t);
ret = opal_hash_table_init(&mca_base_var_index_hash, 1024);
if (OPAL_SUCCESS != ret) {
return ret;
}
ret = mca_base_var_group_init();
if (OPAL_SUCCESS != ret) {
return ret;
}
ret = mca_base_pvar_init();
if (OPAL_SUCCESS != ret) {
return ret;
}
/* We may need this later */
home = (char *) opal_home_directory();
if (NULL == home) {
opal_output(0, "Error: Unable to get the user home directory\n");
return OPAL_ERROR;
}
if (NULL == (cwd = getcwd(NULL, 0))) {
opal_output(0, "Error: Unable to get the current working directory\n");
cwd = strdup(".");
}
/* Set this before we register the parameter, below */
mca_base_var_initialized = true;
}
opal_finalize_register_cleanup(mca_base_var_finalize);
return OPAL_SUCCESS;
}
static void process_env_list(char *env_list, char ***argv, char sep)
{
char **tokens;
char *ptr, *value;
tokens = opal_argv_split(env_list, (int) sep);
if (NULL == tokens) {
return;
}
for (int i = 0; NULL != tokens[i]; ++i) {
if (NULL == (ptr = strchr(tokens[i], '='))) {
value = getenv(tokens[i]);
if (NULL == value) {
opal_show_help("help-mca-var.txt", "incorrect-env-list-param", true, tokens[i],
env_list);
break;
}
/* duplicate the value to silence tainted string coverity issue */
value = strdup(value);
if (NULL == value) {
/* out of memory */
break;
}
if (NULL != (ptr = strchr(value, '='))) {
*ptr = '\0';
opal_setenv(value, ptr + 1, true, argv);
} else {
opal_setenv(tokens[i], value, true, argv);
}
free(value);
} else {
*ptr = '\0';
opal_setenv(tokens[i], ptr + 1, true, argv);
/* NTH: don't bother resetting ptr to = since the string will not be used again */
}
}
opal_argv_free(tokens);
}
int mca_base_var_process_env_list(char *list, char ***argv)
{
char sep;
sep = ';';
if (NULL != mca_base_env_list_sep) {
if (1 == strlen(mca_base_env_list_sep)) {
sep = mca_base_env_list_sep[0];
} else {
opal_show_help("help-mca-var.txt", "incorrect-env-list-sep", true,
mca_base_env_list_sep);
return OPAL_SUCCESS;
}
}
if (NULL != list) {
process_env_list(list, argv, sep);
} else if (NULL != mca_base_env_list) {
process_env_list(mca_base_env_list, argv, sep);
}
return OPAL_SUCCESS;
}
int mca_base_var_process_env_list_from_file(char ***argv)
{
if (NULL != mca_base_env_list_internal) {
process_env_list(mca_base_env_list_internal, argv, ';');
}
return OPAL_SUCCESS;
}
static void resolve_relative_paths(char **file_prefix, char *file_path, bool rel_path_search,
char **files, char sep)
{
char *tmp_str;
/*
* Resolve all relative paths.
* the file list returned will contain only absolute paths
*/
if (OPAL_SUCCESS != fixup_files(file_prefix, file_path, rel_path_search, sep)) {
#if 0
/* JJH We need to die! */
abort();
#else
;
#endif
} else {
/* Prepend the files to the search list */
opal_asprintf(&tmp_str, "%s%c%s", *file_prefix, sep, *files);
free(*files);
*files = tmp_str;
}
}
int mca_base_var_load_extra_files(char *files, bool rel_path_search)
{
char *tmp1 = strdup(files);
resolve_relative_paths(&tmp1, mca_base_param_file_path, rel_path_search, &mca_base_var_files,
OPAL_ENV_SEP);
read_files(tmp1, &mca_base_var_file_values, ',');
free(tmp1);
return OPAL_SUCCESS;
}
int mca_base_var_cache_files(bool rel_path_search)
{
char *tmp = NULL;
int ret;
#if OPAL_WANT_HOME_CONFIG_FILES
if (NULL == getenv("OPAL_USER_PARAMS_GIVEN")) {
opal_asprintf(&tmp, "%s" OPAL_PATH_SEP ".openmpi" OPAL_PATH_SEP "mca-params.conf", home);
}
#endif
if (NULL == getenv("OPAL_SYS_PARAMS_GIVEN")) {
if (NULL != tmp) {
opal_asprintf(&mca_base_var_files, "%s,%s" OPAL_PATH_SEP "openmpi-mca-params.conf", tmp,
opal_install_dirs.sysconfdir);
free(tmp);
} else {
opal_asprintf(&mca_base_var_files, "%s" OPAL_PATH_SEP "openmpi-mca-params.conf",
opal_install_dirs.sysconfdir);
}
} else {
mca_base_var_files = strdup("none");
}
/* Initialize a parameter that says where MCA param files can be found.
We may change this value so set the scope to MCA_BASE_VAR_SCOPE_READONLY */
tmp = mca_base_var_files;
ret = mca_base_var_register("opal", "mca", "base", "param_files",
"Path for MCA "
"configuration files containing variable values",
MCA_BASE_VAR_TYPE_STRING, NULL, 0, 0, OPAL_INFO_LVL_2,
MCA_BASE_VAR_SCOPE_READONLY, &mca_base_var_files);
free(tmp);
if (0 > ret) {
return ret;
}
mca_base_envar_files = strdup(mca_base_var_files);
(void) mca_base_var_register_synonym(ret, "opal", "mca", NULL, "param_files",
MCA_BASE_VAR_SYN_FLAG_DEPRECATED);
ret = opal_asprintf(&mca_base_var_override_file,
"%s" OPAL_PATH_SEP "openmpi-mca-params-override.conf",
opal_install_dirs.sysconfdir);
if (0 > ret) {
return OPAL_ERR_OUT_OF_RESOURCE;
}
tmp = mca_base_var_override_file;
ret = mca_base_var_register("opal", "mca", "base", "override_param_file",
"Variables set in this file will override any value set in"
"the environment or another configuration file",
MCA_BASE_VAR_TYPE_STRING, NULL, 0, MCA_BASE_VAR_FLAG_DEFAULT_ONLY,
OPAL_INFO_LVL_2, MCA_BASE_VAR_SCOPE_CONSTANT,
&mca_base_var_override_file);
free(tmp);
if (0 > ret) {
return ret;
}
/* Disable reading MCA parameter files. */
if (0 == strcmp(mca_base_var_files, "none")) {
return OPAL_SUCCESS;
}
mca_base_var_suppress_override_warning = false;
ret = mca_base_var_register(
"opal", "mca", "base", "suppress_override_warning",
"Suppress warnings when attempting to set an overridden value (default: false)",
MCA_BASE_VAR_TYPE_BOOL, NULL, 0, 0, OPAL_INFO_LVL_2, MCA_BASE_VAR_SCOPE_LOCAL,
&mca_base_var_suppress_override_warning);
if (0 > ret) {
return ret;
}
/* Aggregate MCA parameter files
* A prefix search path to look up aggregate MCA parameter file
* requests that do not specify an absolute path
*/
mca_base_var_file_prefix = NULL;
ret = mca_base_var_register("opal", "mca", "base", "param_file_prefix",
"Aggregate MCA parameter file sets", MCA_BASE_VAR_TYPE_STRING, NULL,
0, 0, OPAL_INFO_LVL_3, MCA_BASE_VAR_SCOPE_READONLY,
&mca_base_var_file_prefix);
if (0 > ret) {
return ret;
}
mca_base_envar_file_prefix = NULL;
ret = mca_base_var_register("opal", "mca", "base", "envar_file_prefix",
"Aggregate MCA parameter file set for env variables",
MCA_BASE_VAR_TYPE_STRING, NULL, 0, 0, OPAL_INFO_LVL_3,
MCA_BASE_VAR_SCOPE_READONLY, &mca_base_envar_file_prefix);
if (0 > ret) {
return ret;
}
ret = opal_asprintf(&mca_base_param_file_path, "%s" OPAL_PATH_SEP "amca-param-sets%c%s",
opal_install_dirs.opaldatadir, OPAL_ENV_SEP, cwd);
if (0 > ret) {
return OPAL_ERR_OUT_OF_RESOURCE;
}
tmp = mca_base_param_file_path;
ret = mca_base_var_register("opal", "mca", "base", "param_file_path",
"Aggregate MCA parameter Search path", MCA_BASE_VAR_TYPE_STRING,
NULL, 0, 0, OPAL_INFO_LVL_3, MCA_BASE_VAR_SCOPE_READONLY,
&mca_base_param_file_path);
free(tmp);
if (0 > ret) {
return ret;
}
force_agg_path = NULL;
ret = mca_base_var_register("opal", "mca", "base", "param_file_path_force",
"Forced Aggregate MCA parameter Search path",
MCA_BASE_VAR_TYPE_STRING, NULL, 0, 0, OPAL_INFO_LVL_3,
MCA_BASE_VAR_SCOPE_READONLY, &force_agg_path);
if (0 > ret) {
return ret;
}
if (NULL != force_agg_path) {
if (NULL != mca_base_param_file_path) {
char *tmp_str = mca_base_param_file_path;
opal_asprintf(&mca_base_param_file_path, "%s%c%s", force_agg_path, OPAL_ENV_SEP,
tmp_str);
free(tmp_str);
} else {
mca_base_param_file_path = strdup(force_agg_path);
}
}
if (NULL != mca_base_var_file_prefix) {
resolve_relative_paths(&mca_base_var_file_prefix, mca_base_param_file_path, rel_path_search,
&mca_base_var_files, OPAL_ENV_SEP);
}
read_files(mca_base_var_files, &mca_base_var_file_values, ',');
if (NULL != mca_base_envar_file_prefix) {
resolve_relative_paths(&mca_base_envar_file_prefix, mca_base_param_file_path,
rel_path_search, &mca_base_envar_files, ',');
}
read_files(mca_base_envar_files, &mca_base_envar_file_values, ',');
if (0 == access(mca_base_var_override_file, F_OK)) {
read_files(mca_base_var_override_file, &mca_base_var_override_values, OPAL_ENV_SEP);
}
return OPAL_SUCCESS;
}
/*
* Look up an integer MCA parameter.
*/
int mca_base_var_get_value(int vari, const void *value, mca_base_var_source_t *source,
const char **source_file)
{
mca_base_var_t *var;
void **tmp = (void **) value;
int ret;
ret = var_get(vari, &var, true);
if (OPAL_SUCCESS != ret) {
return ret;
}
if (!VAR_IS_VALID(var[0])) {
return OPAL_ERR_NOT_FOUND;
}
if (NULL != value) {
/* Return a pointer to our backing store (either a char **, int *,
or bool *) */
*tmp = var->mbv_storage;
}
if (NULL != source) {
*source = var->mbv_source;
}
if (NULL != source_file) {
*source_file = mca_base_var_source_file(var);
}
return OPAL_SUCCESS;
}
static int var_set_string(mca_base_var_t *var, char *value)
{
char *tmp;
int ret;
if (NULL != var->mbv_storage->stringval) {
free(var->mbv_storage->stringval);
}
var->mbv_storage->stringval = NULL;
if (NULL == value || 0 == strlen(value)) {
return OPAL_SUCCESS;
}
/* Replace all instances of ~/ in a path-style string with the
user's home directory. This may be handled by the enumerator
in the future. */
if (0 == strncmp(value, "~/", 2)) {
if (NULL != home) {
ret = opal_asprintf(&value, "%s/%s", home, value + 2);
if (0 > ret) {
return OPAL_ERROR;
}
} else {
value = strdup(value + 2);
}
} else {
value = strdup(value);
}
if (NULL == value) {
return OPAL_ERR_OUT_OF_RESOURCE;
}
while (NULL != (tmp = strstr(value, ":~/"))) {
tmp[0] = '\0';
tmp += 3;
ret = opal_asprintf(&tmp, "%s:%s%s%s", value, home ? home : "", home ? "/" : "", tmp);
free(value);
if (0 > ret) {
return OPAL_ERR_OUT_OF_RESOURCE;
}
value = tmp;
}
var->mbv_storage->stringval = value;
return OPAL_SUCCESS;
}
static int int_from_string(const char *src, mca_base_var_enum_t *enumerator, uint64_t *value_out)
{
uint64_t value;
bool is_int;
char *tmp;
if (NULL == src || 0 == strlen(src)) {
if (NULL == enumerator) {
*value_out = 0;
}
return OPAL_SUCCESS;
}
if (enumerator) {
int int_val, ret;
ret = enumerator->value_from_string(enumerator, src, &int_val);
if (OPAL_SUCCESS != ret) {
return ret;
}
*value_out = (uint64_t) int_val;
return OPAL_SUCCESS;
}
/* Check for an integer value */
value = strtoull(src, &tmp, 0);
is_int = tmp[0] == '\0';
if (!is_int && tmp != src) {
switch (tmp[0]) {
case 'G':
case 'g':
value <<= 10;
case 'M':
case 'm':
value <<= 10;
case 'K':
case 'k':
value <<= 10;
break;
default:
break;
}
}
*value_out = value;
return OPAL_SUCCESS;
}
static int var_set_from_string(mca_base_var_t *var, char *src)
{
mca_base_var_storage_t *dst = var->mbv_storage;
uint64_t int_value = 0;
int ret;
switch (var->mbv_type) {
case MCA_BASE_VAR_TYPE_INT:
case MCA_BASE_VAR_TYPE_INT32_T:
case MCA_BASE_VAR_TYPE_UINT32_T:
case MCA_BASE_VAR_TYPE_LONG:
case MCA_BASE_VAR_TYPE_UNSIGNED_INT:
case MCA_BASE_VAR_TYPE_UNSIGNED_LONG:
case MCA_BASE_VAR_TYPE_INT64_T:
case MCA_BASE_VAR_TYPE_UINT64_T:
case MCA_BASE_VAR_TYPE_UNSIGNED_LONG_LONG:
case MCA_BASE_VAR_TYPE_BOOL:
case MCA_BASE_VAR_TYPE_SIZE_T:
ret = int_from_string(src, var->mbv_enumerator, &int_value);
if (OPAL_SUCCESS != ret
|| (MCA_BASE_VAR_TYPE_INT == var->mbv_type && ((int) int_value != (int64_t) int_value))
|| (MCA_BASE_VAR_TYPE_UNSIGNED_INT == var->mbv_type
&& ((unsigned int) int_value != int_value))) {
if (var->mbv_enumerator) {
char *valid_values;
(void) var->mbv_enumerator->dump(var->mbv_enumerator, &valid_values,
MCA_BASE_VAR_ENUM_DUMP_READABLE);
opal_show_help("help-mca-var.txt", "invalid-value-enum", true, var->mbv_full_name,
src, valid_values);
free(valid_values);
} else {
opal_show_help("help-mca-var.txt", "invalid-value", true, var->mbv_full_name, src);
}
return OPAL_ERR_VALUE_OUT_OF_BOUNDS;
}
if (MCA_BASE_VAR_TYPE_INT == var->mbv_type
|| MCA_BASE_VAR_TYPE_UNSIGNED_INT == var->mbv_type) {
int *castme = (int *) var->mbv_storage;
*castme = int_value;
} else if (MCA_BASE_VAR_TYPE_INT32_T == var->mbv_type
|| MCA_BASE_VAR_TYPE_UINT32_T == var->mbv_type) {
int32_t *castme = (int32_t *) var->mbv_storage;
*castme = int_value;
} else if (MCA_BASE_VAR_TYPE_INT64_T == var->mbv_type
|| MCA_BASE_VAR_TYPE_UINT64_T == var->mbv_type) {
int64_t *castme = (int64_t *) var->mbv_storage;
*castme = int_value;
} else if (MCA_BASE_VAR_TYPE_LONG == var->mbv_type) {
long *castme = (long *) var->mbv_storage;
*castme = (long) int_value;
} else if (MCA_BASE_VAR_TYPE_UNSIGNED_LONG == var->mbv_type) {
unsigned long *castme = (unsigned long *) var->mbv_storage;
*castme = (unsigned long) int_value;
} else if (MCA_BASE_VAR_TYPE_UNSIGNED_LONG_LONG == var->mbv_type) {
unsigned long long *castme = (unsigned long long *) var->mbv_storage;
*castme = (unsigned long long) int_value;
} else if (MCA_BASE_VAR_TYPE_SIZE_T == var->mbv_type) {
size_t *castme = (size_t *) var->mbv_storage;
*castme = (size_t) int_value;
} else if (MCA_BASE_VAR_TYPE_BOOL == var->mbv_type) {
bool *castme = (bool *) var->mbv_storage;
*castme = !!int_value;
}
return ret;
case MCA_BASE_VAR_TYPE_DOUBLE:
dst->lfval = strtod(src, NULL);
break;
case MCA_BASE_VAR_TYPE_STRING:
case MCA_BASE_VAR_TYPE_VERSION_STRING:
var_set_string(var, src);
break;
case MCA_BASE_VAR_TYPE_MAX:
return OPAL_ERROR;
}
return OPAL_SUCCESS;
}
/*
* Set a variable
*/
int mca_base_var_set_value(int vari, const void *value, size_t size, mca_base_var_source_t source,
const char *source_file)
{
mca_base_var_t *var;
int ret;
ret = var_get(vari, &var, true);
if (OPAL_SUCCESS != ret) {
return ret;
}
if (!VAR_IS_VALID(var[0])) {
return OPAL_ERR_BAD_PARAM;
}
if (!VAR_IS_SETTABLE(var[0])) {
return OPAL_ERR_PERM;
}
if (NULL != var->mbv_enumerator) {
/* Validate */
ret = var->mbv_enumerator->string_from_value(var->mbv_enumerator, ((int *) value)[0], NULL);
if (OPAL_SUCCESS != ret) {
return ret;
}
}
if (MCA_BASE_VAR_TYPE_STRING != var->mbv_type
&& MCA_BASE_VAR_TYPE_VERSION_STRING != var->mbv_type) {
memmove(var->mbv_storage, value, ompi_var_type_sizes[var->mbv_type]);
} else {
var_set_string(var, (char *) value);
}
var->mbv_source = source;
if (MCA_BASE_VAR_SOURCE_FILE == source && NULL != source_file) {
var->mbv_file_value = NULL;
var->mbv_source_file = append_filename_to_list(source_file);
}
return OPAL_SUCCESS;
}
/*
* Deregister a parameter
*/
int mca_base_var_deregister(int vari)
{
mca_base_var_t *var;
int ret;
ret = var_get(vari, &var, false);
if (OPAL_SUCCESS != ret) {
return ret;
}
if (!VAR_IS_VALID(var[0])) {
return OPAL_ERR_BAD_PARAM;
}
/* Mark this parameter as invalid but keep its info in case this
parameter is reregistered later */
var->mbv_flags &= ~MCA_BASE_VAR_FLAG_VALID;
/* Done deregistering synonym */
if (MCA_BASE_VAR_FLAG_SYNONYM & var->mbv_flags) {
return OPAL_SUCCESS;
}
/* Release the current value if it is a string. */
if ((MCA_BASE_VAR_TYPE_STRING == var->mbv_type
|| MCA_BASE_VAR_TYPE_VERSION_STRING == var->mbv_type)
&& var->mbv_storage->stringval) {
free(var->mbv_storage->stringval);
var->mbv_storage->stringval = NULL;
} else {
OPAL_MCA_VAR_MBV_ENUMERATOR_FREE(var->mbv_enumerator);
}
var->mbv_enumerator = NULL;
var->mbv_storage = NULL;
return OPAL_SUCCESS;
}
static int var_get(int vari, mca_base_var_t **var_out, bool original)
{
mca_base_var_t *var;
if (var_out) {
*var_out = NULL;
}
/* Check for bozo cases */
if (!mca_base_var_initialized) {
return OPAL_ERROR;
}
if (vari < 0) {
return OPAL_ERR_BAD_PARAM;
}
var = opal_pointer_array_get_item(&mca_base_vars, vari);
if (NULL == var) {
return OPAL_ERR_BAD_PARAM;
}
if (VAR_IS_SYNONYM(var[0]) && original) {
return var_get(var->mbv_synonym_for, var_out, false);
}
if (var_out) {
*var_out = var;
}
return OPAL_SUCCESS;
}
int mca_base_var_env_name(const char *param_name, char **env_name)
{
int ret;
assert(NULL != env_name);
ret = opal_asprintf(env_name, "%s%s", mca_prefix, param_name);
if (0 > ret) {
return OPAL_ERR_OUT_OF_RESOURCE;
}
return OPAL_SUCCESS;
}
/*
* Find the index for an MCA parameter based on its names.
*/
static int var_find_by_name(const char *full_name, int *vari, bool invalidok)
{
mca_base_var_t *var = NULL;
void *tmp;
int rc;
rc = opal_hash_table_get_value_ptr(&mca_base_var_index_hash, full_name, strlen(full_name),
&tmp);
if (OPAL_SUCCESS != rc) {
return rc;
}
(void) var_get((int) (uintptr_t) tmp, &var, false);
if (invalidok || (var && VAR_IS_VALID(var[0]))) {
*vari = (int) (uintptr_t) tmp;
return OPAL_SUCCESS;
}
return OPAL_ERR_NOT_FOUND;
}
static int var_find(const char *project_name, const char *framework_name,
const char *component_name, const char *variable_name, bool invalidok)
{
char *full_name;
int ret, vari;
ret = mca_base_var_generate_full_name4(NULL, framework_name, component_name, variable_name,
&full_name);
if (OPAL_SUCCESS != ret) {
return OPAL_ERROR;
}
ret = var_find_by_name(full_name, &vari, invalidok);
/* NTH: should we verify the name components match? */
free(full_name);
if (OPAL_SUCCESS != ret) {
return ret;
}
return vari;
}
/*
* Find the index for an MCA parameter based on its name components.
*/
int mca_base_var_find(const char *project_name, const char *framework_name,
const char *component_name, const char *variable_name)
{
return var_find(project_name, framework_name, component_name, variable_name, false);
}
/*
* Find the index for an MCA parameter based on full name.
*/
int mca_base_var_find_by_name(const char *full_name, int *vari)
{
return var_find_by_name(full_name, vari, false);
}
int mca_base_var_set_flag(int vari, mca_base_var_flag_t flag, bool set)
{
mca_base_var_t *var;
int ret;
ret = var_get(vari, &var, true);
if (OPAL_SUCCESS != ret || VAR_IS_SYNONYM(var[0])) {
return OPAL_ERR_BAD_PARAM;
}
var->mbv_flags = (var->mbv_flags & ~flag) | (set ? flag : 0);
/* All done */
return OPAL_SUCCESS;
}
/*
* Return info on a parameter at an index
*/
int mca_base_var_get(int vari, const mca_base_var_t **var)
{
int ret;
ret = var_get(vari, (mca_base_var_t **) var, false);
if (OPAL_SUCCESS != ret) {
return ret;
}
if (!VAR_IS_VALID(*(var[0]))) {
return OPAL_ERR_NOT_FOUND;
}
return OPAL_SUCCESS;
}
/*
* Make an argv-style list of strings suitable for an environment
*/
int mca_base_var_build_env(char ***env, int *num_env, bool internal)
{
mca_base_var_t *var;
size_t i, len;
int ret;
/* Check for bozo cases */
if (!mca_base_var_initialized) {
return OPAL_ERROR;
}
/* Iterate through all the registered parameters */
len = opal_pointer_array_get_size(&mca_base_vars);
for (i = 0; i < len; ++i) {
char *value_string;
char *str = NULL;
var = opal_pointer_array_get_item(&mca_base_vars, i);
if (NULL == var) {
continue;
}
/* Don't output default values or internal variables (unless
requested) */
if (MCA_BASE_VAR_SOURCE_DEFAULT == var->mbv_source
|| (!internal && VAR_IS_INTERNAL(var[0]))) {
continue;
}
if ((MCA_BASE_VAR_TYPE_STRING == var->mbv_type
|| MCA_BASE_VAR_TYPE_VERSION_STRING == var->mbv_type)
&& NULL == var->mbv_storage->stringval) {
continue;
}
ret = var_value_string(var, &value_string);
if (OPAL_SUCCESS != ret) {
goto cleanup;
}
ret = opal_asprintf(&str, "%s%s=%s", mca_prefix, var->mbv_full_name, value_string);
free(value_string);
if (0 > ret) {
goto cleanup;
}
opal_argv_append(num_env, env, str);
free(str);
switch (var->mbv_source) {
case MCA_BASE_VAR_SOURCE_FILE:
case MCA_BASE_VAR_SOURCE_OVERRIDE:
opal_asprintf(&str, "%sSOURCE_%s=FILE:%s", mca_prefix, var->mbv_full_name,
mca_base_var_source_file(var));
break;
case MCA_BASE_VAR_SOURCE_COMMAND_LINE:
opal_asprintf(&str, "%sSOURCE_%s=COMMAND_LINE", mca_prefix, var->mbv_full_name);
break;
case MCA_BASE_VAR_SOURCE_ENV:
case MCA_BASE_VAR_SOURCE_SET:
case MCA_BASE_VAR_SOURCE_DEFAULT:
str = NULL;
break;
case MCA_BASE_VAR_SOURCE_MAX:
goto cleanup;
}
if (NULL != str) {
opal_argv_append(num_env, env, str);
free(str);
}
}
/* All done */
return OPAL_SUCCESS;
/* Error condition */
cleanup:
if (*num_env > 0) {
opal_argv_free(*env);
*num_env = 0;
*env = NULL;
}
return OPAL_ERR_NOT_FOUND;
}
/*
* Shut down the MCA parameter system (normally only invoked by the
* MCA framework itself).
*/
static void mca_base_var_finalize(void)
{
opal_object_t *object;
opal_list_item_t *item;
int size, i;
if (mca_base_var_initialized) {
size = opal_pointer_array_get_size(&mca_base_vars);
for (i = 0; i < size; ++i) {
object = opal_pointer_array_get_item(&mca_base_vars, i);
if (NULL != object) {
OBJ_RELEASE(object);
}
}
OBJ_DESTRUCT(&mca_base_vars);
while (NULL != (item = opal_list_remove_first(&mca_base_var_file_values))) {
OBJ_RELEASE(item);
}
OBJ_DESTRUCT(&mca_base_var_file_values);
while (NULL != (item = opal_list_remove_first(&mca_base_envar_file_values))) {
OBJ_RELEASE(item);
}
OBJ_DESTRUCT(&mca_base_envar_file_values);
while (NULL != (item = opal_list_remove_first(&mca_base_var_override_values))) {
OBJ_RELEASE(item);
}
OBJ_DESTRUCT(&mca_base_var_override_values);
if (NULL != cwd) {
free(cwd);
cwd = NULL;
}
mca_base_var_initialized = false;
mca_base_var_count = 0;
if (NULL != mca_base_var_file_list) {
opal_argv_free(mca_base_var_file_list);
}
mca_base_var_file_list = NULL;
(void) mca_base_var_group_finalize();
(void) mca_base_pvar_finalize();
OBJ_DESTRUCT(&mca_base_var_index_hash);
free(mca_base_envar_files);
mca_base_envar_files = NULL;
}
}
/*************************************************************************/
static int fixup_files(char **file_list, char *path, bool rel_path_search, char sep)
{
int exit_status = OPAL_SUCCESS;
char **files = NULL;
char **search_path = NULL;
char *tmp_file = NULL;
char **argv = NULL;
char *rel_path;
int mode = R_OK; /* The file exists, and we can read it */
int count, i, argc = 0;
search_path = opal_argv_split(path, OPAL_ENV_SEP);
files = opal_argv_split(*file_list, sep);
count = opal_argv_count(files);
rel_path = force_agg_path ? force_agg_path : cwd;
/* Read in reverse order, so we can preserve the original ordering */
for (i = 0; i < count; ++i) {
char *msg_path = path;
if (opal_path_is_absolute(files[i])) {
/* Absolute paths preserved */
tmp_file = opal_path_access(files[i], NULL, mode);
} else if (!rel_path_search && NULL != strchr(files[i], OPAL_PATH_SEP[0])) {
/* Resolve all relative paths:
* - If filename contains a "/" (e.g., "./foo" or "foo/bar")
* - look for it relative to cwd
* - if exists, use it
* - ow warn/error
*/
msg_path = rel_path;
tmp_file = opal_path_access(files[i], rel_path, mode);
} else {
/* Resolve all relative paths:
* - Use path resolution
* - if found and readable, use it
* - otherwise, warn/error
*/
tmp_file = opal_path_find(files[i], search_path, mode, NULL);
}
if (NULL == tmp_file) {
opal_show_help("help-mca-var.txt", "missing-param-file", true, getpid(), files[i],
msg_path);
exit_status = OPAL_ERROR;
break;
}
opal_argv_append(&argc, &argv, tmp_file);
free(tmp_file);
tmp_file = NULL;
}
if (OPAL_SUCCESS == exit_status) {
free(*file_list);
*file_list = opal_argv_join(argv, sep);
}
if (NULL != files) {
opal_argv_free(files);
files = NULL;
}
if (NULL != argv) {
opal_argv_free(argv);
argv = NULL;
}
if (NULL != search_path) {
opal_argv_free(search_path);
search_path = NULL;
}
return exit_status;
}
static int read_files(char *file_list, opal_list_t *file_values, char sep)
{
char **tmp = opal_argv_split(file_list, sep);
int i, count;
if (!tmp) {
return OPAL_ERR_OUT_OF_RESOURCE;
}
count = opal_argv_count(tmp);
/* Iterate through all the files passed in -- read them in reverse
order so that we preserve unix/shell path-like semantics (i.e.,
the entries farthest to the left get precedence) */
for (i = count - 1; i >= 0; --i) {
char *file_name = append_filename_to_list(tmp[i]);
mca_base_parse_paramfile(file_name, file_values);
}
opal_argv_free(tmp);
mca_base_internal_env_store();
return OPAL_SUCCESS;
}
/******************************************************************************/
static int register_variable(const char *project_name, const char *framework_name,
const char *component_name, const char *variable_name,
const char *description, mca_base_var_type_t type,
mca_base_var_enum_t *enumerator, int bind, mca_base_var_flag_t flags,
mca_base_var_info_lvl_t info_lvl, mca_base_var_scope_t scope,
int synonym_for, void *storage)
{
int ret, var_index, group_index, tmp;
mca_base_var_group_t *group;
mca_base_var_t *var, *original = NULL;
/* Developer error. Storage can not be NULL and type must exist */
assert(((flags & MCA_BASE_VAR_FLAG_SYNONYM) || NULL != storage) && type >= 0
&& type < MCA_BASE_VAR_TYPE_MAX);
/* Developer error: check max length of strings */
if (NULL != project_name && strlen(project_name) > MCA_BASE_MAX_PROJECT_NAME_LEN) {
return OPAL_ERR_BAD_PARAM;
}
if (NULL != framework_name && strlen(framework_name) > MCA_BASE_MAX_TYPE_NAME_LEN) {
return OPAL_ERR_BAD_PARAM;
}
if (NULL != component_name && strlen(component_name) > MCA_BASE_MAX_COMPONENT_NAME_LEN) {
return OPAL_ERR_BAD_PARAM;
}
if (NULL != variable_name && strlen(variable_name) > MCA_BASE_MAX_VARIABLE_NAME_LEN) {
return OPAL_ERR_BAD_PARAM;
}
#if OPAL_ENABLE_DEBUG
/* Developer error: check for alignments */
uintptr_t align = 0;
switch (type) {
case MCA_BASE_VAR_TYPE_INT:
case MCA_BASE_VAR_TYPE_UNSIGNED_INT:
align = OPAL_ALIGNMENT_INT;
break;
case MCA_BASE_VAR_TYPE_INT32_T:
case MCA_BASE_VAR_TYPE_UINT32_T:
align = OPAL_ALIGNMENT_INT32;
break;
case MCA_BASE_VAR_TYPE_INT64_T:
case MCA_BASE_VAR_TYPE_UINT64_T:
align = OPAL_ALIGNMENT_INT64;
break;
case MCA_BASE_VAR_TYPE_LONG:
case MCA_BASE_VAR_TYPE_UNSIGNED_LONG:
align = OPAL_ALIGNMENT_LONG;
break;
case MCA_BASE_VAR_TYPE_UNSIGNED_LONG_LONG:
align = OPAL_ALIGNMENT_LONG_LONG;
break;
case MCA_BASE_VAR_TYPE_SIZE_T:
align = OPAL_ALIGNMENT_SIZE_T;
break;
case MCA_BASE_VAR_TYPE_BOOL:
align = OPAL_ALIGNMENT_BOOL;
break;
case MCA_BASE_VAR_TYPE_DOUBLE:
align = OPAL_ALIGNMENT_DOUBLE;
break;
case MCA_BASE_VAR_TYPE_VERSION_STRING:
case MCA_BASE_VAR_TYPE_STRING:
default:
align = 0;
break;
}
if (0 != align) {
assert(((uintptr_t) storage) % align == 0);
}
/* Also check to ensure that synonym_for>=0 when
MCA_BCASE_VAR_FLAG_SYNONYM is specified */
if (flags & MCA_BASE_VAR_FLAG_SYNONYM && synonym_for < 0) {
assert((flags & MCA_BASE_VAR_FLAG_SYNONYM) && synonym_for >= 0);
}
#endif
if (flags & MCA_BASE_VAR_FLAG_SYNONYM) {
original = opal_pointer_array_get_item(&mca_base_vars, synonym_for);
if (NULL == original) {
/* Attempting to create a synonym for a non-existent variable. probably a
* developer error. */
assert(NULL != original);
return OPAL_ERR_NOT_FOUND;
}
}
/* There are data holes in the var struct */
OPAL_DEBUG_ZERO(var);
/* Initialize the array if it has never been initialized */
if (!mca_base_var_initialized) {
mca_base_var_init();
}
/* See if this entry is already in the array */
var_index = var_find(project_name, framework_name, component_name, variable_name, true);
if (0 > var_index) {
/* Create a new parameter entry */
group_index = mca_base_var_group_register(project_name, framework_name, component_name,
NULL);
if (-1 > group_index) {
return group_index;
}
/* Read-only and constant variables can't be settable */
if (scope < MCA_BASE_VAR_SCOPE_LOCAL || (flags & MCA_BASE_VAR_FLAG_DEFAULT_ONLY)) {
if ((flags & MCA_BASE_VAR_FLAG_DEFAULT_ONLY) && (flags & MCA_BASE_VAR_FLAG_SETTABLE)) {
opal_show_help("help-mca-var.txt", "invalid-flag-combination", true,
"MCA_BASE_VAR_FLAG_DEFAULT_ONLY", "MCA_BASE_VAR_FLAG_SETTABLE");
return OPAL_ERROR;
}
/* Should we print a warning for other cases? */
flags &= ~MCA_BASE_VAR_FLAG_SETTABLE;
}
var = OBJ_NEW(mca_base_var_t);
var->mbv_type = type;
var->mbv_flags = flags;
var->mbv_group_index = group_index;
var->mbv_info_lvl = info_lvl;
var->mbv_scope = scope;
var->mbv_synonym_for = synonym_for;
var->mbv_bind = bind;
if (NULL != description) {
var->mbv_description = strdup(description);
}
ret = mca_base_var_generate_full_name4(project_name, framework_name, component_name,
variable_name, &var->mbv_long_name);
if (OPAL_SUCCESS != ret) {
OBJ_RELEASE(var);
return OPAL_ERROR;
}
/* The mbv_full_name and the variable name are subset of the mbv_long_name
* so instead of allocating them we can just point into the var mbv_long_name
* at the right location.
*/
var->mbv_full_name = var->mbv_long_name
+ (NULL == project_name ? 0
: (strlen(project_name) + 1)); /* 1 for _ */
if (NULL != variable_name) {
var->mbv_variable_name = var->mbv_full_name
+ (NULL == framework_name ? 0 : (strlen(framework_name) + 1))
+ (NULL == component_name ? 0 : (strlen(component_name) + 1));
}
/* Add it to the array. Note that we copy the mca_var_t by value,
so the entire contents of the struct is copied. The synonym list
will always be empty at this point, so there's no need for an
extra RETAIN or RELEASE. */
var_index = opal_pointer_array_add(&mca_base_vars, var);
if (0 > var_index) {
OBJ_RELEASE(var);
return OPAL_ERROR;
}
var->mbv_index = var_index;
if (0 <= group_index) {
mca_base_var_group_add_var(group_index, var_index);
}
mca_base_var_count++;
if (0 <= var_find_by_name(var->mbv_full_name, &tmp, 0)) {
/* XXX --- FIXME: variable overshadows an existing variable. this is difficult to
* support */
assert(0);
}
opal_hash_table_set_value_ptr(&mca_base_var_index_hash, var->mbv_full_name,
strlen(var->mbv_full_name), (void *) (uintptr_t) var_index);
} else {
ret = var_get(var_index, &var, false);
if (OPAL_SUCCESS != ret) {
/* Shouldn't ever happen */
return OPAL_ERROR;
}
ret = mca_base_var_group_get_internal(var->mbv_group_index, &group, true);
if (OPAL_SUCCESS != ret) {
/* Shouldn't ever happen */
return OPAL_ERROR;
}
if (!group->group_isvalid) {
group->group_isvalid = true;
}
/* Verify the name components match */
if (0 != compare_strings(framework_name, group->group_framework)
|| 0 != compare_strings(component_name, group->group_component)
|| 0 != compare_strings(variable_name, var->mbv_variable_name)) {
opal_show_help("help-mca-var.txt", "var-name-conflict", true, var->mbv_full_name,
framework_name, component_name, variable_name, group->group_framework,
group->group_component, var->mbv_variable_name);
/* This is developer error. abort! */
assert(0);
return OPAL_ERROR;
}
if (var->mbv_type != type) {
#if OPAL_ENABLE_DEBUG
opal_show_help("help-mca-var.txt", "re-register-with-different-type", true,
var->mbv_full_name);
#endif
return OPAL_ERR_VALUE_OUT_OF_BOUNDS;
}
}
if (MCA_BASE_VAR_TYPE_BOOL == var->mbv_type) {
enumerator = &mca_base_var_enum_bool;
} else if (NULL != enumerator) {
OPAL_MCA_VAR_MBV_ENUMERATOR_FREE(var->mbv_enumerator);
if (!enumerator->enum_is_static) {
OBJ_RETAIN(enumerator);
}
}
var->mbv_enumerator = enumerator;
if (!original) {
var->mbv_storage = storage;
/* make a copy of the default string value */
if ((MCA_BASE_VAR_TYPE_STRING == type || MCA_BASE_VAR_TYPE_VERSION_STRING == type)
&& NULL != ((char **) storage)[0]) {
((char **) storage)[0] = strdup(((char **) storage)[0]);
}
} else {
/* synonym variable */
opal_value_array_append_item(&original->mbv_synonyms, &var_index);
}
/* go ahead and mark this variable as valid */
var->mbv_flags |= MCA_BASE_VAR_FLAG_VALID;
ret = var_set_initial(var, original);
if (OPAL_SUCCESS != ret) {
return ret;
}
/* All done */
return var_index;
}
int mca_base_var_register(const char *project_name, const char *framework_name,
const char *component_name, const char *variable_name,
const char *description, mca_base_var_type_t type,
mca_base_var_enum_t *enumerator, int bind, mca_base_var_flag_t flags,
mca_base_var_info_lvl_t info_lvl, mca_base_var_scope_t scope,
void *storage)
{
int ret;
/* Only integer variables can have enumerator */
assert(NULL == enumerator
|| (MCA_BASE_VAR_TYPE_INT == type || MCA_BASE_VAR_TYPE_UNSIGNED_INT == type));
ret = register_variable(project_name, framework_name, component_name, variable_name,
description, type, enumerator, bind, flags, info_lvl, scope, -1,
storage);
if (OPAL_UNLIKELY(0 > ret)) {
return ret;
}
/* Register aliases if any exist */
const mca_base_alias_t *alias = mca_base_alias_lookup(project_name, framework_name,
component_name);
if (NULL == alias) {
return ret;
}
OPAL_LIST_FOREACH_DECL(alias_item, &alias->component_aliases, mca_base_alias_item_t) {
mca_base_var_syn_flag_t flags_derived = 0;
if (alias_item->alias_flags & MCA_BASE_ALIAS_FLAG_DEPRECATED) {
flags_derived = MCA_BASE_VAR_SYN_FLAG_DEPRECATED;
}
(void) mca_base_var_register_synonym(ret, project_name, framework_name,
alias_item->component_alias, variable_name, flags_derived);
}
return ret;
}
int mca_base_component_var_register(const mca_base_component_t *component,
const char *variable_name, const char *description,
mca_base_var_type_t type, mca_base_var_enum_t *enumerator,
int bind, mca_base_var_flag_t flags,
mca_base_var_info_lvl_t info_lvl, mca_base_var_scope_t scope,
void *storage)
{
return mca_base_var_register(component->mca_project_name, component->mca_type_name,
component->mca_component_name, variable_name, description, type,
enumerator, bind, flags | MCA_BASE_VAR_FLAG_DWG, info_lvl, scope,
storage);
}
int mca_base_framework_var_register(const mca_base_framework_t *framework,
const char *variable_name, const char *help_msg,
mca_base_var_type_t type, mca_base_var_enum_t *enumerator,
int bind, mca_base_var_flag_t flags,
mca_base_var_info_lvl_t info_level, mca_base_var_scope_t scope,
void *storage)
{
return mca_base_var_register(framework->framework_project, framework->framework_name, "base",
variable_name, help_msg, type, enumerator, bind,
flags | MCA_BASE_VAR_FLAG_DWG, info_level, scope, storage);
}
int mca_base_var_register_synonym(int synonym_for, const char *project_name,
const char *framework_name, const char *component_name,
const char *synonym_name, mca_base_var_syn_flag_t flags)
{
mca_base_var_flag_t var_flags = (mca_base_var_flag_t) MCA_BASE_VAR_FLAG_SYNONYM;
mca_base_var_t *var;
int ret;
ret = var_get(synonym_for, &var, false);
if (OPAL_SUCCESS != ret || VAR_IS_SYNONYM(var[0])) {
return OPAL_ERR_BAD_PARAM;
}
if (flags & MCA_BASE_VAR_SYN_FLAG_DEPRECATED) {
var_flags |= MCA_BASE_VAR_FLAG_DEPRECATED;
}
if (flags & MCA_BASE_VAR_SYN_FLAG_INTERNAL) {
var_flags |= MCA_BASE_VAR_FLAG_INTERNAL;
}
return register_variable(project_name, framework_name, component_name, synonym_name,
var->mbv_description, var->mbv_type, var->mbv_enumerator,
var->mbv_bind, var_flags, var->mbv_info_lvl, var->mbv_scope,
synonym_for, NULL);
}
static int var_get_env(mca_base_var_t *var, const char *name, char **source, char **value)
{
const char source_prefix[] = "SOURCE_";
const int max_len = strlen(mca_prefix) + strlen(source_prefix) + strlen(name) + 1;
char *envvar = alloca(max_len);
if (NULL == envvar) {
return OPAL_ERR_OUT_OF_RESOURCE;
}
int ret;
ret = snprintf(envvar, max_len, "%s%s", mca_prefix, name);
if (0 > ret) {
return OPAL_ERROR;
}
*value = getenv(envvar);
if (NULL == *value) {
*source = NULL;
return OPAL_ERR_NOT_FOUND;
}
ret = snprintf(envvar, max_len, "%s%s%s", mca_prefix, source_prefix, name);
if (0 > ret) {
return OPAL_ERROR;
}
*source = getenv(envvar);
return OPAL_SUCCESS;
}
/*
* Lookup a param in the environment
*/
static int var_set_from_env(mca_base_var_t *var, mca_base_var_t *original)
{
const char *var_full_name = var->mbv_full_name;
const char *var_long_name = var->mbv_long_name;
bool deprecated = VAR_IS_DEPRECATED(var[0]);
bool is_synonym = VAR_IS_SYNONYM(var[0]);
char *source_env, *value_env;
int ret;
ret = var_get_env(var, var_long_name, &source_env, &value_env);
if (OPAL_SUCCESS != ret) {
ret = var_get_env(var, var_full_name, &source_env, &value_env);
}
if (OPAL_SUCCESS != ret) {
return ret;
}
/* we found an environment variable but this variable is default-only. print
a warning. */
if (VAR_IS_DEFAULT_ONLY(original[0])) {
opal_show_help("help-mca-var.txt", "default-only-param-set", true, var_full_name);
return OPAL_ERR_NOT_FOUND;
}
if (MCA_BASE_VAR_SOURCE_OVERRIDE == original->mbv_source) {
if (!mca_base_var_suppress_override_warning) {
opal_show_help("help-mca-var.txt", "overridden-param-set", true, var_full_name);
}
return OPAL_ERR_NOT_FOUND;
}
original->mbv_source = MCA_BASE_VAR_SOURCE_ENV;
if (NULL != source_env) {
if (0 == strncasecmp(source_env, "file:", 5)) {
original->mbv_source_file = append_filename_to_list(source_env + 5);
if (0 == strcmp(var->mbv_source_file, mca_base_var_override_file)) {
original->mbv_source = MCA_BASE_VAR_SOURCE_OVERRIDE;
} else {
original->mbv_source = MCA_BASE_VAR_SOURCE_FILE;
}
} else if (0 == strcasecmp(source_env, "command")) {
var->mbv_source = MCA_BASE_VAR_SOURCE_COMMAND_LINE;
}
}
if (deprecated) {
const char *new_variable = "None (going away)";
if (is_synonym) {
new_variable = original->mbv_full_name;
}
switch (var->mbv_source) {
case MCA_BASE_VAR_SOURCE_ENV:
opal_show_help("help-mca-var.txt", "deprecated-mca-env", true, var_full_name,
new_variable);
break;
case MCA_BASE_VAR_SOURCE_COMMAND_LINE:
opal_show_help("help-mca-var.txt", "deprecated-mca-cli", true, var_full_name,
new_variable);
break;
case MCA_BASE_VAR_SOURCE_FILE:
case MCA_BASE_VAR_SOURCE_OVERRIDE:
opal_show_help("help-mca-var.txt", "deprecated-mca-file", true, var_full_name,
mca_base_var_source_file(var), new_variable);
break;
case MCA_BASE_VAR_SOURCE_DEFAULT:
case MCA_BASE_VAR_SOURCE_MAX:
case MCA_BASE_VAR_SOURCE_SET:
/* silence compiler warnings about unhandled enumerations */
break;
}
}
return var_set_from_string(original, value_env);
}
/*
* Lookup a param in the files
*/
static int var_set_from_file(mca_base_var_t *var, mca_base_var_t *original,
opal_list_t *file_values)
{
const char *var_full_name = var->mbv_full_name;
const char *var_long_name = var->mbv_long_name;
bool deprecated = VAR_IS_DEPRECATED(var[0]);
bool is_synonym = VAR_IS_SYNONYM(var[0]);
mca_base_var_file_value_t *fv;
/* Scan through the list of values read in from files and try to
find a match. If we do, cache it on the param (for future
lookups) and save it in the storage. */
OPAL_LIST_FOREACH (fv, file_values, mca_base_var_file_value_t) {
if (0 != strcmp(fv->mbvfv_var, var_full_name)
&& 0 != strcmp(fv->mbvfv_var, var_long_name)) {
continue;
}
/* found it */
if (VAR_IS_DEFAULT_ONLY(var[0])) {
opal_show_help("help-mca-var.txt", "default-only-param-set", true, var_full_name);
return OPAL_ERR_NOT_FOUND;
}
if (MCA_BASE_VAR_FLAG_ENVIRONMENT_ONLY & original->mbv_flags) {
opal_show_help("help-mca-var.txt", "environment-only-param", true, var_full_name,
fv->mbvfv_value, fv->mbvfv_file);
return OPAL_ERR_NOT_FOUND;
}
if (MCA_BASE_VAR_SOURCE_OVERRIDE == original->mbv_source) {
if (!mca_base_var_suppress_override_warning) {
opal_show_help("help-mca-var.txt", "overridden-param-set", true, var_full_name);
}
return OPAL_ERR_NOT_FOUND;
}
if (deprecated) {
const char *new_variable = "None (going away)";
if (is_synonym) {
new_variable = original->mbv_full_name;
}
opal_show_help("help-mca-var.txt", "deprecated-mca-file", true, var_full_name,
fv->mbvfv_file, new_variable);
}
original->mbv_file_value = (void *) fv;
original->mbv_source = MCA_BASE_VAR_SOURCE_FILE;
if (is_synonym) {
var->mbv_file_value = (void *) fv;
var->mbv_source = MCA_BASE_VAR_SOURCE_FILE;
}
return var_set_from_string(original, fv->mbvfv_value);
}
return OPAL_ERR_NOT_FOUND;
}
/*
* Lookup the initial value for a parameter
*/
static int var_set_initial(mca_base_var_t *var, mca_base_var_t *original)
{
int ret;
if (original) {
/* synonym */
var->mbv_source = original->mbv_source;
var->mbv_file_value = original->mbv_file_value;
var->mbv_source_file = original->mbv_source_file;
} else {
var->mbv_source = MCA_BASE_VAR_SOURCE_DEFAULT;
original = var;
}
/* Check all the places that the param may be hiding, in priority
order. If the default only flag is set the user will get a
warning if they try to set a value from the environment or a
file. */
ret = var_set_from_file(var, original, &mca_base_var_override_values);
if (OPAL_SUCCESS == ret) {
var->mbv_flags = ~MCA_BASE_VAR_FLAG_SETTABLE
& (var->mbv_flags | MCA_BASE_VAR_FLAG_OVERRIDE);
var->mbv_source = MCA_BASE_VAR_SOURCE_OVERRIDE;
}
ret = var_set_from_env(var, original);
if (OPAL_ERR_NOT_FOUND != ret) {
return ret;
}
ret = var_set_from_file(var, original, &mca_base_envar_file_values);
if (OPAL_ERR_NOT_FOUND != ret) {
return ret;
}
ret = var_set_from_file(var, original, &mca_base_var_file_values);
if (OPAL_ERR_NOT_FOUND != ret) {
return ret;
}
return OPAL_SUCCESS;
}
/*
* Create an empty param container
*/
static void var_constructor(mca_base_var_t *var)
{
memset((char *) var + sizeof(var->super), 0, sizeof(*var) - sizeof(var->super));
var->mbv_type = MCA_BASE_VAR_TYPE_MAX;
OBJ_CONSTRUCT(&var->mbv_synonyms, opal_value_array_t);
opal_value_array_init(&var->mbv_synonyms, sizeof(int));
}
/*
* Free all the contents of a param container
*/
static void var_destructor(mca_base_var_t *var)
{
if ((MCA_BASE_VAR_TYPE_STRING == var->mbv_type
|| MCA_BASE_VAR_TYPE_VERSION_STRING == var->mbv_type)
&& NULL != var->mbv_storage && NULL != var->mbv_storage->stringval) {
free(var->mbv_storage->stringval);
var->mbv_storage->stringval = NULL;
}
/* don't release the boolean enumerator */
OPAL_MCA_VAR_MBV_ENUMERATOR_FREE(var->mbv_enumerator);
if (NULL != var->mbv_long_name) {
free(var->mbv_long_name);
}
var->mbv_full_name = NULL;
var->mbv_variable_name = NULL;
if (NULL != var->mbv_description) {
free(var->mbv_description);
}
/* Destroy the synonym array */
OBJ_DESTRUCT(&var->mbv_synonyms);
/* mark this parameter as invalid */
var->mbv_type = MCA_BASE_VAR_TYPE_MAX;
#if OPAL_ENABLE_DEBUG
/* Cheap trick to reset everything to NULL */
memset((char *) var + sizeof(var->super), 0, sizeof(*var) - sizeof(var->super));
#endif
}
static void fv_constructor(mca_base_var_file_value_t *f)
{
memset((char *) f + sizeof(f->super), 0, sizeof(*f) - sizeof(f->super));
}
static void fv_destructor(mca_base_var_file_value_t *f)
{
if (NULL != f->mbvfv_var) {
free(f->mbvfv_var);
}
if (NULL != f->mbvfv_value) {
free(f->mbvfv_value);
}
/* the file name is stored in mca_*/
fv_constructor(f);
}
static char *source_name(mca_base_var_t *var)
{
char *ret;
if (MCA_BASE_VAR_SOURCE_FILE == var->mbv_source
|| MCA_BASE_VAR_SOURCE_OVERRIDE == var->mbv_source) {
struct mca_base_var_file_value_t *fv = var->mbv_file_value;
int rc;
if (fv) {
rc = opal_asprintf(&ret, "file (%s:%d)", fv->mbvfv_file, fv->mbvfv_lineno);
} else {
rc = opal_asprintf(&ret, "file (%s)", var->mbv_source_file);
}
/* some compilers will warn if the return code of opal_asprintf is not checked (even if it
* is cast to void) */
if (0 > rc) {
return NULL;
}
return ret;
} else if (MCA_BASE_VAR_SOURCE_MAX <= var->mbv_source) {
return strdup("unknown(!!)");
}
return strdup(var_source_names[var->mbv_source]);
}
static int var_value_string(mca_base_var_t *var, char **value_string)
{
const mca_base_var_storage_t *value = NULL;
int ret;
assert(MCA_BASE_VAR_TYPE_MAX > var->mbv_type);
/** Parameters with MCA_BASE_VAR_FLAG_DEF_UNSET flag should be shown
* as "unset" by default. */
if ((var->mbv_flags & MCA_BASE_VAR_FLAG_DEF_UNSET)
&& (MCA_BASE_VAR_SOURCE_DEFAULT == var->mbv_source)) {
opal_asprintf(value_string, "%s", "unset");
return OPAL_SUCCESS;
}
ret = mca_base_var_get_value(var->mbv_index, &value, NULL, NULL);
if (OPAL_SUCCESS != ret || NULL == value) {
return ret;
}
if (NULL == var->mbv_enumerator) {
switch (var->mbv_type) {
case MCA_BASE_VAR_TYPE_INT:
ret = opal_asprintf(value_string, "%d", value->intval);
break;
case MCA_BASE_VAR_TYPE_INT32_T:
ret = opal_asprintf(value_string, "%" PRId32, value->int32tval);
break;
case MCA_BASE_VAR_TYPE_UINT32_T:
ret = opal_asprintf(value_string, "%" PRIu32, value->uint32tval);
break;
case MCA_BASE_VAR_TYPE_INT64_T:
ret = opal_asprintf(value_string, "%" PRId64, value->int64tval);
break;
case MCA_BASE_VAR_TYPE_UINT64_T:
ret = opal_asprintf(value_string, "%" PRIu64, value->uint64tval);
break;
case MCA_BASE_VAR_TYPE_LONG:
ret = opal_asprintf(value_string, "%ld", value->longval);
break;
case MCA_BASE_VAR_TYPE_UNSIGNED_INT:
ret = opal_asprintf(value_string, "%u", value->uintval);
break;
case MCA_BASE_VAR_TYPE_UNSIGNED_LONG:
ret = opal_asprintf(value_string, "%lu", value->ulval);
break;
case MCA_BASE_VAR_TYPE_UNSIGNED_LONG_LONG:
ret = opal_asprintf(value_string, "%llu", value->ullval);
break;
case MCA_BASE_VAR_TYPE_SIZE_T:
ret = opal_asprintf(value_string, "%" PRIsize_t, value->sizetval);
break;
case MCA_BASE_VAR_TYPE_STRING:
case MCA_BASE_VAR_TYPE_VERSION_STRING:
ret = opal_asprintf(value_string, "%s", value->stringval ? value->stringval : "");
break;
case MCA_BASE_VAR_TYPE_BOOL:
ret = opal_asprintf(value_string, "%d", value->boolval);
break;
case MCA_BASE_VAR_TYPE_DOUBLE:
ret = opal_asprintf(value_string, "%lf", value->lfval);
break;
default:
ret = -1;
break;
}
ret = (0 > ret) ? OPAL_ERR_OUT_OF_RESOURCE : OPAL_SUCCESS;
} else {
/* we use an enumerator to handle string->bool and bool->string conversion */
if (MCA_BASE_VAR_TYPE_BOOL == var->mbv_type) {
ret = var->mbv_enumerator->string_from_value(var->mbv_enumerator, value->boolval,
value_string);
} else {
ret = var->mbv_enumerator->string_from_value(var->mbv_enumerator, value->intval,
value_string);
}
}
return ret;
}
int mca_base_var_check_exclusive(const char *project, const char *type_a, const char *component_a,
const char *param_a, const char *type_b, const char *component_b,
const char *param_b)
{
mca_base_var_t *var_a = NULL, *var_b = NULL;
int var_ai, var_bi;
/* XXX -- Remove me once the project name is in the componennt */
project = NULL;
var_ai = mca_base_var_find(project, type_a, component_a, param_a);
var_bi = mca_base_var_find(project, type_b, component_b, param_b);
if (var_bi < 0 || var_ai < 0) {
return OPAL_ERR_NOT_FOUND;
}
(void) var_get(var_ai, &var_a, true);
(void) var_get(var_bi, &var_b, true);
if (NULL == var_a || NULL == var_b) {
return OPAL_ERR_NOT_FOUND;
}
if (MCA_BASE_VAR_SOURCE_DEFAULT != var_a->mbv_source
&& MCA_BASE_VAR_SOURCE_DEFAULT != var_b->mbv_source) {
char *str_a, *str_b;
/* Form cosmetic string names for A */
str_a = source_name(var_a);
/* Form cosmetic string names for B */
str_b = source_name(var_b);
/* Print it all out */
opal_show_help("help-mca-var.txt", "mutually-exclusive-vars", true, var_a->mbv_full_name,
str_a, var_b->mbv_full_name, str_b);
/* Free the temp strings */
free(str_a);
free(str_b);
return OPAL_ERR_BAD_PARAM;
}
return OPAL_SUCCESS;
}
int mca_base_var_get_count(void)
{
return mca_base_var_count;
}
int mca_base_var_dump(int vari, char ***out, mca_base_var_dump_type_t output_type)
{
const char *framework, *component, *full_name;
int i, line_count, line = 0, enum_count = 0;
char *value_string, *source_string, *tmp;
int synonym_count, ret, *synonyms = NULL;
mca_base_var_t *var, *original = NULL;
mca_base_var_group_t *group;
ret = var_get(vari, &var, false);
if (OPAL_SUCCESS != ret) {
return ret;
}
ret = mca_base_var_group_get_internal(var->mbv_group_index, &group, false);
if (OPAL_SUCCESS != ret) {
return ret;
}
if (VAR_IS_SYNONYM(var[0])) {
ret = var_get(var->mbv_synonym_for, &original, false);
if (OPAL_SUCCESS != ret) {
return ret;
}
/* just for protection... */
if (NULL == original) {
return OPAL_ERR_NOT_FOUND;
}
}
framework = group->group_framework;
component = group->group_component ? group->group_component : "base";
full_name = var->mbv_full_name;
synonym_count = opal_value_array_get_size(&var->mbv_synonyms);
if (synonym_count) {
synonyms = OPAL_VALUE_ARRAY_GET_BASE(&var->mbv_synonyms, int);
}
ret = var_value_string(var, &value_string);
if (OPAL_SUCCESS != ret) {
return ret;
}
source_string = source_name(var);
if (NULL == source_string) {
free(value_string);
return OPAL_ERR_OUT_OF_RESOURCE;
}
if (MCA_BASE_VAR_DUMP_PARSABLE == output_type) {
if (NULL != var->mbv_enumerator) {
(void) var->mbv_enumerator->get_count(var->mbv_enumerator, &enum_count);
}
line_count = 8 + (var->mbv_description ? 1 : 0)
+ (VAR_IS_SYNONYM(var[0]) ? 1 : synonym_count) + enum_count;
*out = (char **) calloc(line_count + 1, sizeof(char *));
if (NULL == *out) {
free(value_string);
free(source_string);
return OPAL_ERR_OUT_OF_RESOURCE;
}
/* build the message*/
opal_asprintf(&tmp, "mca:%s:%s:param:%s:", framework, component, full_name);
/* Output the value */
char *colon = strchr(value_string, ':');
if (NULL != colon) {
opal_asprintf(out[0] + line++, "%svalue:\"%s\"", tmp, value_string);
} else {
opal_asprintf(out[0] + line++, "%svalue:%s", tmp, value_string);
}
/* Output the source */
opal_asprintf(out[0] + line++, "%ssource:%s", tmp, source_string);
/* Output whether it's read only or writable */
opal_asprintf(out[0] + line++, "%sstatus:%s", tmp,
VAR_IS_SETTABLE(var[0]) ? "writeable" : "read-only");
/* Output the info level of this parameter */
opal_asprintf(out[0] + line++, "%slevel:%d", tmp, var->mbv_info_lvl + 1);
/* If it has a help message, output the help message */
if (var->mbv_description) {
opal_asprintf(out[0] + line++, "%shelp:%s", tmp, var->mbv_description);
}
if (NULL != var->mbv_enumerator) {
for (i = 0; i < enum_count; ++i) {
const char *enum_string = NULL;
int enum_value;
ret = var->mbv_enumerator->get_value(var->mbv_enumerator, i, &enum_value,
&enum_string);
if (OPAL_SUCCESS != ret) {
continue;
}
opal_asprintf(out[0] + line++, "%senumerator:value:%d:%s", tmp, enum_value,
enum_string);
}
}
/* Is this variable deprecated? */
opal_asprintf(out[0] + line++, "%sdeprecated:%s", tmp,
VAR_IS_DEPRECATED(var[0]) ? "yes" : "no");
opal_asprintf(out[0] + line++, "%stype:%s", tmp, ompi_var_type_names[var->mbv_type]);
/* Does this parameter have any synonyms or is it a synonym? */
if (VAR_IS_SYNONYM(var[0])) {
opal_asprintf(out[0] + line++, "%ssynonym_of:name:%s", tmp, original->mbv_full_name);
} else if (opal_value_array_get_size(&var->mbv_synonyms)) {
for (i = 0; i < synonym_count; ++i) {
mca_base_var_t *synonym;
ret = var_get(synonyms[i], &synonym, false);
if (OPAL_SUCCESS != ret) {
continue;
}
opal_asprintf(out[0] + line++, "%ssynonym:name:%s", tmp, synonym->mbv_full_name);
}
}
free(tmp);
} else if (MCA_BASE_VAR_DUMP_READABLE == output_type
|| MCA_BASE_VAR_DUMP_READABLE_COLOR == output_type) {
char *color_name = "", *color_value = "", *color_reset = "";
/* There will be at most three lines in the pretty print case */
*out = (char **) calloc(4, sizeof(char *));
if (NULL == *out) {
free(value_string);
free(source_string);
return OPAL_ERR_OUT_OF_RESOURCE;
}
if (MCA_BASE_VAR_DUMP_READABLE_COLOR == output_type) {
color_name = opal_var_dump_color[OPAL_VAR_DUMP_COLOR_VAR_NAME];
color_value = opal_var_dump_color[OPAL_VAR_DUMP_COLOR_VAR_VALUE];
color_reset = "\033[0m";
}
opal_asprintf(out[0],
"%s %s\"%s\"%s (current value: %s\"%s\"%s, data source: %s, level: %d %s, type: %s",
VAR_IS_DEFAULT_ONLY(var[0]) ? "informational" : "parameter",
color_name, full_name, color_reset,
color_value, value_string, color_reset,
source_string, var->mbv_info_lvl + 1,
info_lvl_strings[var->mbv_info_lvl], ompi_var_type_names[var->mbv_type]);
tmp = out[0][0];
if (VAR_IS_DEPRECATED(var[0])) {
opal_asprintf(out[0], "%s, deprecated", tmp);
free(tmp);
tmp = out[0][0];
}
/* Does this parameter have any synonyms or is it a synonym? */
if (VAR_IS_SYNONYM(var[0])) {
opal_asprintf(out[0], "%s, synonym of: %s)", tmp, original->mbv_full_name);
free(tmp);
} else if (synonym_count) {
opal_asprintf(out[0], "%s, synonyms: ", tmp);
free(tmp);
for (i = 0; i < synonym_count; ++i) {
mca_base_var_t *synonym;
ret = var_get(synonyms[i], &synonym, false);
if (OPAL_SUCCESS != ret) {
continue;
}
tmp = out[0][0];
if (synonym_count == i + 1) {
opal_asprintf(out[0], "%s%s)", tmp, synonym->mbv_full_name);
} else {
opal_asprintf(out[0], "%s%s, ", tmp, synonym->mbv_full_name);
}
free(tmp);
}
} else {
opal_asprintf(out[0], "%s)", tmp);
free(tmp);
}
line++;
if (var->mbv_description) {
opal_asprintf(out[0] + line++, "%s", var->mbv_description);
}
if (NULL != var->mbv_enumerator) {
char *values;
ret = var->mbv_enumerator->dump(var->mbv_enumerator, &values,
MCA_BASE_VAR_DUMP_TYPE_TO_ENUM_DUMP_TYPE(output_type));
if (OPAL_SUCCESS == ret) {
opal_asprintf(out[0] + line++, "Valid values: %s", values);
free(values);
}
}
} else if (MCA_BASE_VAR_DUMP_SIMPLE == output_type) {
*out = (char **) calloc(2, sizeof(char *));
if (NULL == *out) {
free(value_string);
free(source_string);
return OPAL_ERR_OUT_OF_RESOURCE;
}
opal_asprintf(out[0], "%s=%s (%s)", var->mbv_full_name, value_string, source_string);
}
free(value_string);
free(source_string);
return OPAL_SUCCESS;
}
|