/* * Copyright (c) 2004-2010 The Trustees of Indiana University and Indiana * University Research and Technology * Corporation. All rights reserved. * Copyright (c) 2004-2011 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) 2006-2013 Los Alamos National Security, LLC. * All rights reserved. * Copyright (c) 2009-2012 Cisco Systems, Inc. All rights reserved. * Copyright (c) 2011 Oak Ridge National Labs. All rights reserved. * Copyright (c) 2013-2020 Intel, Inc. All rights reserved. * Copyright (c) 2015 Mellanox Technologies, Inc. All rights reserved. * Copyright (c) 2021-2023 Nanook Consulting. All rights reserved. * $COPYRIGHT$ * * Additional copyrights may follow * * $HEADER$ * */ #include "pmix_config.h" #include "pmix_common.h" #include #include #include #include #include #include "include/pmix_tool.h" #include "src/common/pmix_attributes.h" #include "src/mca/base/pmix_base.h" #include "src/mca/pinstalldirs/base/base.h" #include "src/runtime/pmix_rte.h" #include "src/threads/pmix_threads.h" #include "src/util/pmix_argv.h" #include "src/util/pmix_cmd_line.h" #include "src/util/pmix_keyval_parse.h" #include "src/util/pmix_show_help.h" #define PMIX_PRINT_ATTR_COLUMN_WIDTH 141 typedef struct { pmix_lock_t lock; pmix_status_t status; } mylock_t; static pmix_proc_t myproc; /* define a structure for collecting returned * info from a query */ typedef struct { pmix_lock_t lock; pmix_status_t status; pmix_info_t *info; size_t ninfo; } myquery_data_t; /* this is a callback function for the PMIx_Query * API. The query will callback with a status indicating * if the request could be fully satisfied, partially * satisfied, or completely failed. The info parameter * contains an array of the returned data, with the * info->key field being the key that was provided in * the query call. Thus, you can correlate the returned * data in the info->value field to the requested key. * * Once we have dealt with the returned data, we must * call the release_fn so that the PMIx library can * cleanup */ static void querycbfunc(pmix_status_t status, pmix_info_t *info, size_t ninfo, void *cbdata, pmix_release_cbfunc_t release_fn, void *release_cbdata) { myquery_data_t *mq = (myquery_data_t *) cbdata; size_t n; mq->status = status; /* save the returned info - the PMIx library "owns" it * and will release it and perform other cleanup actions * when release_fn is called */ if (0 < ninfo) { PMIX_INFO_CREATE(mq->info, ninfo); mq->ninfo = ninfo; for (n = 0; n < ninfo; n++) { PMIX_INFO_XFER(&mq->info[n], &info[n]); } } /* let the library release the data and cleanup from * the operation */ if (NULL != release_fn) { release_fn(release_cbdata); } /* release the block */ PMIX_WAKEUP_THREAD(&mq->lock); } /* this is the event notification function we pass down below * when registering for general events - i.e.,, the default * handler. We don't technically need to register one, but it * is usually good practice to catch any events that occur */ static void notification_fn(size_t evhdlr_registration_id, pmix_status_t status, const pmix_proc_t *source, pmix_info_t info[], size_t ninfo, pmix_info_t results[], size_t nresults, pmix_event_notification_cbfunc_fn_t cbfunc, void *cbdata) { PMIX_HIDE_UNUSED_PARAMS(evhdlr_registration_id, status, source, info, ninfo, results, nresults); /* this example doesn't do anything with default events */ if (NULL != cbfunc) { cbfunc(PMIX_EVENT_ACTION_COMPLETE, NULL, 0, NULL, NULL, cbdata); } } /* event handler registration is done asynchronously because it * may involve the PMIx server registering with the host RM for * external events. So we provide a callback function that returns * the status of the request (success or an error), plus a numerical index * to the registered event. The index is used later on to deregister * an event handler - if we don't explicitly deregister it, then the * PMIx server will do so when it see us exit */ static void evhandler_reg_callbk(pmix_status_t status, size_t evhandler_ref, void *cbdata) { mylock_t *lock = (mylock_t *) cbdata; if (PMIX_SUCCESS != status) { fprintf(stderr, "Client %s:%d EVENT HANDLER REGISTRATION FAILED WITH STATUS %d, ref=%lu\n", myproc.nspace, myproc.rank, status, (unsigned long) evhandler_ref); } lock->status = status; PMIX_WAKEUP_THREAD(&lock->lock); } static struct option pattroptions[] = { PMIX_OPTION_SHORT_DEFINE(PMIX_CLI_HELP, PMIX_ARG_OPTIONAL, 'h'), PMIX_OPTION_SHORT_DEFINE(PMIX_CLI_VERSION, PMIX_ARG_NONE, 'V'), PMIX_OPTION_SHORT_DEFINE(PMIX_CLI_VERBOSE, PMIX_ARG_NONE, 'v'), PMIX_OPTION_DEFINE(PMIX_CLI_PMIXMCA, PMIX_ARG_REQD), PMIX_OPTION_DEFINE(PMIX_CLI_SYS_SERVER_FIRST, PMIX_ARG_NONE), PMIX_OPTION_DEFINE(PMIX_CLI_SYSTEM_SERVER, PMIX_ARG_NONE), PMIX_OPTION_DEFINE(PMIX_CLI_DO_NOT_CONNECT, PMIX_ARG_NONE), PMIX_OPTION_DEFINE(PMIX_CLI_WAIT_TO_CONNECT, PMIX_ARG_REQD), PMIX_OPTION_DEFINE(PMIX_CLI_NUM_CONNECT_RETRIES, PMIX_ARG_REQD), PMIX_OPTION_DEFINE(PMIX_CLI_PID, PMIX_ARG_REQD), PMIX_OPTION_DEFINE(PMIX_CLI_NAMESPACE, PMIX_ARG_REQD), PMIX_OPTION_DEFINE(PMIX_CLI_URI, PMIX_ARG_REQD), PMIX_OPTION_DEFINE(PMIX_CLI_TMPDIR, PMIX_ARG_REQD), PMIX_OPTION_DEFINE("client", PMIX_ARG_REQD), PMIX_OPTION_DEFINE("server", PMIX_ARG_REQD), PMIX_OPTION_DEFINE("tool", PMIX_ARG_REQD), PMIX_OPTION_DEFINE("host", PMIX_ARG_REQD), PMIX_OPTION_DEFINE("client-fns", PMIX_ARG_NONE), PMIX_OPTION_DEFINE("server-fns", PMIX_ARG_NONE), PMIX_OPTION_DEFINE("tool-fns", PMIX_ARG_NONE), PMIX_OPTION_DEFINE("host-fns", PMIX_ARG_NONE), PMIX_OPTION_END }; static char *pattrshorts = "h::vV"; int main(int argc, char **argv) { pmix_status_t rc; pmix_info_t *info; mylock_t mylock; pmix_cli_result_t results; pmix_cli_item_t *opt; char **fns = NULL, *ptr; size_t n, m; myquery_data_t mq; pmix_query_t query; pmix_regattr_t *reg; char **ans = NULL; bool clientfns, serverfns, toolfns, hostfns; char *client, *server, *tool, *host; char line[PMIX_PRINT_ATTR_COLUMN_WIDTH]; PMIX_HIDE_UNUSED_PARAMS(argc); /* protect against problems if someone passes us thru a pipe * and then abnormally terminates the pipe early */ signal(SIGPIPE, SIG_IGN); /* init globals */ pmix_tool_basename = "pattrs"; /* initialize the output system */ if (!pmix_output_init()) { return PMIX_ERROR; } /* initialize install dirs code */ rc = pmix_mca_base_framework_open(&pmix_pinstalldirs_base_framework, PMIX_MCA_BASE_OPEN_DEFAULT); if (PMIX_SUCCESS != rc) { fprintf(stderr, "pmix_pinstalldirs_base_open() failed -- process will likely abort (%s:%d, " "returned %d instead of PMIX_SUCCESS)\n", __FILE__, __LINE__, rc); return rc; } if (PMIX_SUCCESS != (rc = pmix_pinstall_dirs_base_init(NULL, 0))) { fprintf(stderr, "pmix_pinstalldirs_base_init() failed -- process will likely abort (%s:%d, " "returned %d instead of PMIX_SUCCESS)\n", __FILE__, __LINE__, rc); return rc; } /* initialize the help system */ pmix_show_help_init(NULL); /* keyval lex-based parser */ if (PMIX_SUCCESS != (rc = pmix_util_keyval_parse_init())) { fprintf(stderr, "pmix_util_keyval_parse_init failed with %d\n", rc); return PMIX_ERROR; } /* Setup the parameter system */ if (PMIX_SUCCESS != (rc = pmix_mca_base_var_init())) { fprintf(stderr, "pmix_mca_base_var_init failed with %d\n", rc); return PMIX_ERROR; } /* Parse the command line options */ PMIX_CONSTRUCT(&results, pmix_cli_result_t); rc = pmix_cmd_line_parse(argv, pattrshorts, pattroptions, NULL, &results, "help-pattrs.txt"); if (PMIX_SUCCESS != rc) { if (PMIX_ERR_SILENT != rc && PMIX_OPERATION_SUCCEEDED != rc) { fprintf(stderr, "%s: command line error (%s)\n", argv[0], PMIx_Error_string(rc)); } if (PMIX_OPERATION_SUCCEEDED == rc) { rc = PMIX_SUCCESS; } exit(rc); } // handle relevant MCA params PMIX_LIST_FOREACH(opt, &results.instances, pmix_cli_item_t) { if (0 == strcmp(opt->key, PMIX_CLI_PMIXMCA)) { for (n=0; NULL != opt->values[n]; n++) { pmix_expose_param(opt->values[n]); } } } /* register params for pmix */ if (PMIX_SUCCESS != (rc = pmix_register_params())) { fprintf(stderr, "pmix_register_params failed with %d\n", rc); return PMIX_ERROR; } client = pmix_cmd_line_get_nth_instance(&results, "client", 0); server = pmix_cmd_line_get_nth_instance(&results, "server", 0); tool = pmix_cmd_line_get_nth_instance(&results, "tool", 0); host = pmix_cmd_line_get_nth_instance(&results, "host", 0); clientfns = pmix_cmd_line_is_taken(&results, "client-fns"); serverfns = pmix_cmd_line_is_taken(&results, "server-fns"); toolfns = pmix_cmd_line_is_taken(&results, "tool-fns"); hostfns = pmix_cmd_line_is_taken(&results, "host-fns"); /* cannot list functions and get attributes at same time */ if ((clientfns || serverfns || toolfns || hostfns) && (client || server || tool || host)) { fprintf(stderr, "Cannot request both a list of functions and attributes at same time\n"); exit(1); } /* if they are asking for client, server, or tool attrs, then * we don't need to connect to anyone - just register the * attrs and report */ if (clientfns || serverfns || toolfns || client || server || tool) { PMIX_INFO_CREATE(info, 1); PMIX_INFO_LOAD(&info[0], PMIX_TOOL_DO_NOT_CONNECT, NULL, PMIX_BOOL); rc = PMIx_tool_init(&myproc, info, 1); if (PMIX_SUCCESS != rc) { fprintf(stderr, "PMIx_tool_init failed: %s\n", PMIx_Error_string(rc)); exit(rc); } if (clientfns) { pmix_register_client_attrs(); fns = pmix_attributes_print_functions(PMIX_CLIENT_FUNCTIONS); } else if (serverfns) { pmix_register_server_attrs(); fns = pmix_attributes_print_functions(PMIX_SERVER_FUNCTIONS); } else if (toolfns) { pmix_register_tool_attrs(); fns = pmix_attributes_print_functions(PMIX_TOOL_FUNCTIONS); } else if (NULL != client) { pmix_register_client_attrs(); fns = pmix_attributes_print_attr(PMIX_CLIENT_ATTRIBUTES, client); } else if (NULL != server) { pmix_register_server_attrs(); fns = pmix_attributes_print_attr(PMIX_SERVER_ATTRIBUTES, server); } else if (NULL != tool) { pmix_register_tool_attrs(); fns = pmix_attributes_print_attr(PMIX_TOOL_ATTRIBUTES, tool); } if (NULL != fns) { for (n = 0; NULL != fns[n]; n++) { fprintf(stderr, "%s\n", fns[n]); } } goto done; } /* if they didn't give us an option, then we can't do anything */ if (!hostfns && NULL == host) { char *str; str = pmix_show_help_string("help-pattrs.txt", "usage", false, pmix_tool_basename, "PMIx", PMIX_PROXY_VERSION, pmix_tool_basename, PMIX_PROXY_BUGREPORT); if (NULL != str) { printf("%s", str); free(str); } exit(1); } /* if we were given the pid of a starter, then direct that * we connect to it */ n = 1; PMIX_INFO_CREATE(info, n); if (NULL != (opt = pmix_cmd_line_get_param(&results, PMIX_CLI_PID))) { /* see if it is an integer value */ char *leftover, *param; pid_t pid; leftover = NULL; pid = strtol(opt->values[0], &leftover, 10); if (NULL == leftover || 0 == strlen(leftover)) { /* it is an integer */ PMIX_INFO_LOAD(&info[0], PMIX_SERVER_PIDINFO, &pid, PMIX_PID); } else if (0 == strncasecmp(opt->values[0], "file", 4)) { FILE *fp; /* step over the file: prefix */ param = strchr(opt->values[0], ':'); if (NULL == param) { /* malformed input */ pmix_show_help("help-pattrs.txt", "bad-option-input", true, pmix_tool_basename, "--pid", opt->values[0], "file:path"); return PMIX_ERR_BAD_PARAM; } ++param; fp = fopen(param, "r"); if (NULL == fp) { pmix_show_help("help-pattrs.txt", "file-open-error", true, pmix_tool_basename, "--pid", opt->values[0], param); return PMIX_ERR_BAD_PARAM; } rc = fscanf(fp, "%lu", (unsigned long *) &pid); if (1 != rc) { /* if we were unable to obtain the single conversion we * require, then error out */ pmix_show_help("help-pattrs.txt", "bad-file", true, pmix_tool_basename, "--pid", opt->values[0], param); fclose(fp); return PMIX_ERR_BAD_PARAM; } fclose(fp); PMIX_INFO_LOAD(&info[0], PMIX_SERVER_PIDINFO, &pid, PMIX_PID); } else { /* a string that's neither an integer nor starts with 'file:' */ pmix_show_help("help-pattrs.txt", "bad-option-input", true, pmix_tool_basename, "--pid", opt->values[0], "file:path"); return PMIX_ERR_BAD_PARAM; } } else if (NULL != (opt = pmix_cmd_line_get_param(&results, PMIX_CLI_NAMESPACE))) { PMIX_INFO_LOAD(&info[0], PMIX_SERVER_NSPACE, opt->values[0], PMIX_STRING); } else if (NULL != (opt = pmix_cmd_line_get_param(&results, PMIX_CLI_URI))) { PMIX_INFO_LOAD(&info[0], PMIX_SERVER_URI, opt->values[0], PMIX_STRING); } else if (pmix_cmd_line_is_taken(&results, PMIX_CLI_SYS_SERVER_FIRST)) { /* otherwise, use the system connection first, if available */ PMIX_INFO_LOAD(&info[0], PMIX_CONNECT_SYSTEM_FIRST, NULL, PMIX_BOOL); } else if (pmix_cmd_line_is_taken(&results, PMIX_CLI_SYSTEM_SERVER)) { PMIX_INFO_LOAD(&info[0], PMIX_CONNECT_TO_SYSTEM, NULL, PMIX_BOOL); } else { PMIX_INFO_FREE(info, 1); n = 0; } /* init as a tool */ if (PMIX_SUCCESS != (rc = PMIx_tool_init(&myproc, info, n))) { fprintf(stderr, "PMIx_tool_init failed: %s\n", PMIx_Error_string(rc)); exit(rc); } PMIX_INFO_FREE(info, 1); /* register a default event handler */ PMIX_CONSTRUCT_LOCK(&mylock.lock); PMIx_Register_event_handler(NULL, 0, NULL, 0, notification_fn, evhandler_reg_callbk, (void *) &mylock); PMIX_WAIT_THREAD(&mylock.lock); if (PMIX_SUCCESS != mylock.status) { fprintf(stderr, "PMIx_Register_event_handler returned bad status: %d\n", mylock.status); PMIX_DESTRUCT_LOCK(&mylock.lock); rc = mylock.status; goto done; } PMIX_DESTRUCT_LOCK(&mylock.lock); /* generate the query */ PMIX_QUERY_CONSTRUCT(&query); PMIx_Argv_append_nosize(&query.keys, PMIX_QUERY_ATTRIBUTE_SUPPORT); PMIX_QUERY_QUALIFIERS_CREATE(&query, 1); if (hostfns) { PMIX_INFO_LOAD(&query.qualifiers[0], PMIX_HOST_FUNCTIONS, NULL, PMIX_BOOL); } else { PMIX_INFO_LOAD(&query.qualifiers[0], PMIX_HOST_ATTRIBUTES, host, PMIX_STRING); } PMIX_CONSTRUCT_LOCK(&mq.lock); rc = PMIx_Query_info_nb(&query, 1, querycbfunc, (void *) &mq); if (PMIX_SUCCESS != rc) { fprintf(stderr, "PMIx_Query_info failed: %d\n", rc); goto done; } PMIX_WAIT_THREAD(&mq.lock); PMIX_DESTRUCT_LOCK(&mq.lock); if (PMIX_SUCCESS != mq.status) { fprintf(stderr, "PMIx_Query_info returned: %s\n", PMIx_Error_string(mq.status)); rc = mq.status; } else if (!PMIX_CHECK_KEY(&mq.info[0], PMIX_QUERY_ATTRIBUTE_SUPPORT)) { fprintf(stderr, "PMIx_Query_info returned incorrect key: %s\n", mq.info[0].key); rc = PMIX_ERR_BAD_PARAM; } else { /* print out the returned value(s) */ if (PMIX_CHECK_KEY(&query.qualifiers[0], PMIX_HOST_FUNCTIONS)) { pmix_attributes_print_headers(&ans, PMIX_HOST_FUNCTIONS); if (PMIX_DATA_ARRAY == mq.info[0].value.type) { info = (pmix_info_t *) mq.info[0].value.data.darray->array; ptr = info[0].value.data.string; } else { ptr = mq.info[0].value.data.string; } ans = PMIx_Argv_split(ptr, ','); for (m = 0; NULL != ans[m]; m++) { fprintf(stderr, "%s\n", ans[m]); } PMIx_Argv_free(ans); ans = NULL; } else { pmix_attributes_print_headers(&ans, PMIX_HOST_ATTRIBUTES); memset(line, '=', PMIX_PRINT_ATTR_COLUMN_WIDTH); line[PMIX_PRINT_ATTR_COLUMN_WIDTH - 1] = '\0'; if (PMIX_DATA_ARRAY == mq.info[0].value.type) { info = (pmix_info_t *) mq.info[0].value.data.darray->array; for (m = 0; m < mq.info[0].value.data.darray->size; m++) { reg = (pmix_regattr_t *) info[m].value.data.darray->array; pmix_attributes_print_attrs(&ans, info[m].key, reg, info[m].value.data.darray->size); /* add a spacer between functions */ PMIx_Argv_append_nosize(&ans, " "); PMIx_Argv_append_nosize(&ans, line); PMIx_Argv_append_nosize(&ans, " "); } } else { reg = (pmix_regattr_t *) mq.info[0].value.data.ptr; pmix_attributes_print_attrs(&ans, mq.info[0].key, reg, 1); } for (m = 0; NULL != ans[m]; m++) { fprintf(stderr, "%s\n", ans[m]); } PMIx_Argv_free(ans); ans = NULL; } } done: PMIx_tool_finalize(); return (rc); }