/* -*- Mode: C; c-basic-offset:4 ; indent-tabs-mode:nil -*- */ /* * Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana * University Research and Technology * Corporation. All rights reserved. * Copyright (c) 2004-2007 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-2015 Cisco Systems, Inc. All rights reserved. * Copyright (c) 2008 Sun Microsystems, Inc. All rights reserved. * Copyright (c) 2015 Research Organization for Information Science * and Technology (RIST). All rights reserved. * Copyright (c) 2014-2015 Los Alamos National Security, LLC. All rights * reserved. * Copyright (c) 2016-2020 Intel, Inc. All rights reserved. * Copyright (c) 2021-2022 Nanook Consulting. All rights reserved. * $COPYRIGHT$ * * Additional copyrights may follow * * $HEADER$ */ #include "src/include/pmix_config.h" #include #include #include #include #ifdef HAVE_SYS_TYPES_H # include #endif #ifdef HAVE_SYS_STAT_H # include #endif #ifdef HAVE_UNISTD_H # include #endif #ifdef HAVE_SYS_PARAM_H # include #endif #ifdef HAVE_NETDB_H # include #endif #include "pmix_common.h" #include "src/class/pmix_list.h" #include "src/include/pmix_globals.h" #include "src/mca/base/pmix_base.h" #include "src/mca/base/pmix_mca_base_component_repository.h" #include "src/mca/mca.h" #include "src/mca/pdl/base/base.h" #include "src/mca/pinstalldirs/pinstalldirs.h" #include "src/util/pmix_argv.h" #include "src/util/pmix_output.h" #include "src/util/pmix_environ.h" #include "src/util/pmix_show_help.h" #if PMIX_HAVE_PDL_SUPPORT /* * Private functions */ static void find_dyn_components(const char *path, pmix_mca_base_framework_t *framework, const char **names, bool include_mode); #endif /* PMIX_HAVE_PDL_SUPPORT */ static int component_find_check(pmix_mca_base_framework_t *framework, char **requested_component_names); /* * Dummy structure for casting for open_only logic */ struct pmix_mca_base_open_only_dummy_component_t { /** MCA base component */ pmix_mca_base_component_t version; }; typedef struct pmix_mca_base_open_only_dummy_component_t pmix_mca_base_open_only_dummy_component_t; static char negate[] = "^"; static bool use_component(const bool include_mode, const char **requested_component_names, const char *component_name); /* * Function to find as many components of a given type as possible. This * includes statically-linked in components as well as opening up a * directory and looking for shared-library MCA components of the * appropriate type (load them if available). * * Return one consolidated array of (pmix_mca_base_component_t*) pointing to all * available components. */ int pmix_mca_base_component_find(const char *directory, pmix_mca_base_framework_t *framework, bool ignore_requested, bool open_dso_components) { const pmix_mca_base_component_t **static_components = framework->framework_static_components; char **requested_component_names = NULL; pmix_mca_base_component_list_item_t *cli; bool include_mode = true; int ret; PMIX_HIDE_UNUSED_PARAMS(open_dso_components); pmix_output_verbose(PMIX_MCA_BASE_VERBOSE_COMPONENT, framework->framework_output, "mca: base: component_find: searching %s for %s components", (NULL == directory) ? "NULL" : directory, framework->framework_name); if (!ignore_requested) { ret = pmix_mca_base_component_parse_requested(framework->framework_selection, &include_mode, &requested_component_names); if (PMIX_SUCCESS != ret) { return ret; } } /* Find all the components that were statically linked in */ if (static_components) { for (int i = 0; NULL != static_components[i]; ++i) { if (use_component(include_mode, (const char **) requested_component_names, static_components[i]->pmix_mca_component_name)) { cli = PMIX_NEW(pmix_mca_base_component_list_item_t); if (NULL == cli) { ret = PMIX_ERR_OUT_OF_RESOURCE; goto component_find_out; } cli->cli_component = static_components[i]; pmix_list_append(&framework->framework_components, (pmix_list_item_t *) cli); } } } #if PMIX_HAVE_PDL_SUPPORT /* Find any available dynamic components in the specified directory */ if (open_dso_components && !pmix_mca_base_component_disable_dlopen) { find_dyn_components(directory, framework, (const char **) requested_component_names, include_mode); } else { pmix_output_verbose(PMIX_MCA_BASE_VERBOSE_INFO, 0, "pmix:mca: base: component_find: dso loading for %s MCA components disabled", framework->framework_name); } #endif if (include_mode) { ret = component_find_check(framework, requested_component_names); } else { ret = PMIX_SUCCESS; } component_find_out: if (NULL != requested_component_names) { PMIx_Argv_free(requested_component_names); } /* All done */ return ret; } int pmix_mca_base_component_find_finalize(void) { return PMIX_SUCCESS; } int pmix_mca_base_components_filter(pmix_mca_base_framework_t *framework) { pmix_list_t *components = &framework->framework_components; int output_id = framework->framework_output; pmix_mca_base_component_list_item_t *cli, *next; char **requested_component_names = NULL; bool include_mode, can_use; int ret; assert(NULL != components); if (NULL == framework->framework_selection) { return PMIX_SUCCESS; } ret = pmix_mca_base_component_parse_requested(framework->framework_selection, &include_mode, &requested_component_names); if (PMIX_SUCCESS != ret) { return ret; } PMIX_LIST_FOREACH_SAFE (cli, next, components, pmix_mca_base_component_list_item_t) { const pmix_mca_base_component_t *component = cli->cli_component; can_use = use_component(include_mode, (const char **) requested_component_names, cli->cli_component->pmix_mca_component_name); if (!can_use) { pmix_list_remove_item(components, &cli->super); pmix_mca_base_component_unload(component, output_id); PMIX_RELEASE(cli); } } if (include_mode) { ret = component_find_check(framework, requested_component_names); } else { ret = PMIX_SUCCESS; } if (NULL != requested_component_names) { PMIx_Argv_free(requested_component_names); } return ret; } #if PMIX_HAVE_PDL_SUPPORT /* * Open up all directories in a given path and search for components of * the specified type (and possibly of a given name). * * Note that we use our own path iteration functionality because we * need to look at companion .pmix_info files in the same directory as * the library to generate dependencies, etc. */ static void find_dyn_components(const char *path, pmix_mca_base_framework_t *framework, const char **names, bool include_mode) { pmix_mca_base_component_repository_item_t *ri; pmix_list_t *dy_components; int ret; pmix_output_verbose(PMIX_MCA_BASE_VERBOSE_COMPONENT, framework->framework_output, "mca: base: find_dyn_components: checking %s for %s components", (NULL == path) ? "NULL" : path, framework->framework_name); if (NULL != path) { ret = pmix_mca_base_component_repository_add(framework->framework_project, path); if (PMIX_SUCCESS != ret) { return; } } ret = pmix_mca_base_component_repository_get_components(framework, &dy_components); if (PMIX_SUCCESS != ret) { return; } /* Iterate through the repository and find components that can be included */ PMIX_LIST_FOREACH (ri, dy_components, pmix_mca_base_component_repository_item_t) { if (use_component(include_mode, names, ri->ri_name)) { pmix_mca_base_component_repository_open(framework, ri); } } } #endif /* PMIX_HAVE_PDL_SUPPORT */ static bool use_component(const bool include_mode, const char **requested_component_names, const char *component_name) { bool found = false; const char **req_comp_name = requested_component_names; /* * If no selection is specified then we use all components * we can find. */ if (NULL == req_comp_name) { return true; } while (*req_comp_name != NULL) { if (strcmp(component_name, *req_comp_name) == 0) { found = true; break; } req_comp_name++; } /* * include_mode found | use * --------------------+------ * 0 0 | true * 0 1 | false * 1 0 | false * 1 1 | true * * -> inverted xor * As xor is a binary operator let's implement it manually before * a compiler screws it up. */ return (include_mode && found) || !(include_mode || found); } /* Ensure that *all* requested components exist. Print a warning and abort if they do not. */ static int component_find_check(pmix_mca_base_framework_t *framework, char **requested_component_names) { pmix_list_t *components = &framework->framework_components; pmix_mca_base_component_list_item_t *cli; if (NULL == requested_component_names) { return PMIX_SUCCESS; } for (int i = 0; NULL != requested_component_names[i]; ++i) { bool found = false; PMIX_LIST_FOREACH (cli, components, pmix_mca_base_component_list_item_t) { if (0 == strcmp(requested_component_names[i], cli->cli_component->pmix_mca_component_name)) { found = true; break; } } if (!found && pmix_mca_base_component_show_load_errors) { char h[PMIX_MAXHOSTNAMELEN] = {0}; gethostname(h, sizeof(h) - 1); pmix_show_help("help-pmix-mca-base.txt", "find-available:not-valid", true, h, framework->framework_name, requested_component_names[i]); if (pmix_mca_base_component_abort_on_load_error) { return PMIX_ERR_NOT_FOUND; } } } return PMIX_SUCCESS; } int pmix_mca_base_component_parse_requested(const char *requested, bool *include_mode, char ***requested_component_names) { const char *requested_orig = requested; *requested_component_names = NULL; *include_mode = true; /* See if the user requested anything */ if (NULL == requested || 0 == strlen(requested)) { return PMIX_SUCCESS; } /* Are we including or excluding? We only allow the negate character to be the *first* character of the value (but be nice and allow any number of negate characters in the beginning). */ *include_mode = requested[0] != negate[0]; /* skip over all negate symbols at the beginning */ requested += strspn(requested, negate); /* Double check to ensure that the user did not specify the negate character anywhere else in the value. */ if (NULL != strstr(requested, negate)) { pmix_show_help("help-pmix-mca-base.txt", "framework-param:too-many-negates", true, requested_orig); return PMIX_ERROR; } /* Split up the value into individual component names */ *requested_component_names = PMIx_Argv_split(requested, ','); /* All done */ return PMIX_SUCCESS; }