1
1
openmpi/oshmem/tools/oshmem_info/oshmem_info.c
Mark Allen 482d84b6e5 fixes for Dave's get/set info code
The expected sequence of events for processing info during object creation
is that if there's an incoming info arg, it is opal_info_dup()ed into the obj
at obj->s_info first. Then interested components register callbacks for
keys they want to know about using opal_infosubscribe_infosubscribe().

Inside info_subscribe_subscribe() the specified callback() is called with
whatever matching k/v is in the object's info, or with the default. The
return string from the callback goes into the new k/v stored in info, and
the input k/v is saved as __IN_<key>/<val>. It's saved the same way
whether the input came from info or whether it was a default. A null return
from the callback indicates an ignored key/val, and no k/v is stored for
it, but an __IN_<key>/<val> is still kept so we still have access to the
original.

At MPI_*_set_info() time, opal_infosubscribe_change_info() is used. That
function calls the registered callbacks for each item in the provided info.
If the callback returns non-null, the info is updated with that k/v, or if
the callback returns null, that key is deleted from info. An __IN_<key>/<val>
is saved either way, and overwrites any previously saved value.

When MPI_*_get_info() is called, opal_info_dup_mpistandard() is used, which
allows relatively easy changes in interpretation of the standard, by looking
at both the <key>/<val> and __IN_<key>/<val> in info. Right now it does
  1. includes system extras, eg k/v defaults not expliclty set by the user
  2. omits ignored keys
  3. shows input values, not callback modifications, eg not the internal values

Currently the callbacks are doing things like
    return some_condition ? "true" : "false"
that is, returning static strings that are not to be freed. If the return
strings start becoming more dynamic in the future I don't see how unallocated
strings could support that, so I'd propose a change for the future that
the callback()s registered with info_subscribe_subscribe() do a strdup on
their return, and we change the callers of callback() to free the strings
it returns (there are only two callers).

Rough outline of the smaller changes spread over the less central files:
  comm.c
    initialize comm->super.s_info to NULL
    copy into comm->super.s_info in comm creation calls that provide info
    OBJ_RELEASE comm->super.s_info at free time
  comm_init.c
    initialize comm->super.s_info to NULL
  file.c
    copy into file->super.s_info if file creation provides info
    OBJ_RELEASE file->super.s_info at free time
  win.c
    copy into win->super.s_info if win creation provides info
    OBJ_RELEASE win->super.s_info at free time

  comm_get_info.c
  file_get_info.c
  win_get_info.c
    change_info() if there's no info attached (shouldn't happen if callbacks
      are registered)
    copy the info for the user

The other category of change is generally addressing compiler warnings where
ompi_info_t and opal_info_t were being used a little too interchangably. An
ompi_info_t* contains an opal_info_t*, at &(ompi_info->super)

Also this commit updates the copyrights.

Signed-off-by: Mark Allen <markalle@us.ibm.com>
2017-05-17 01:12:49 -04:00

193 строки
5.7 KiB
C

/*
* Copyright (c) 2013-2015 Mellanox Technologies, Inc.
* All rights reserved.
* Copyright (c) 2014 Intel, Inc. All rights reserved.
*
* Copyright (c) 2016-2017 IBM Corporation. All rights reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*/
#include "oshmem_config.h"
#include <stdio.h>
#include <string.h>
#include <ctype.h>
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#ifdef HAVE_NETDB_H
#include <netdb.h>
#endif
#ifdef HAVE_SYS_PARAM_H
#include <sys/param.h>
#endif
#include <errno.h>
#include <signal.h>
#include "opal/version.h"
#include "opal/mca/installdirs/installdirs.h"
#include "opal/class/opal_object.h"
#include "opal/class/opal_pointer_array.h"
#include "opal/runtime/opal.h"
#if OPAL_ENABLE_FT_CR == 1
#include "opal/runtime/opal_cr.h"
#endif
#include "opal/mca/base/base.h"
#include "opal/runtime/opal_info_support.h"
#include "opal/util/argv.h"
#include "opal/util/show_help.h"
#if OMPI_RTE_ORTE
#include "orte/runtime/orte_info_support.h"
#endif
#include "ompi/runtime/ompi_info_support.h"
#include "oshmem/include/oshmem/constants.h"
#include "oshmem/tools/oshmem_info/oshmem_info.h"
#include "oshmem/runtime/oshmem_info_support.h"
/*
* Public variables
*/
int main(int argc, char *argv[])
{
int ret = 0;
bool acted = false;
bool want_all = false;
int i;
opal_cmd_line_t *info_cmd_line;
opal_pointer_array_t mca_types;
opal_pointer_array_t component_map;
opal_info_component_map_t *map;
/* protect against problems if someone passes us thru a pipe
* and then abnormally terminates the pipe early */
signal(SIGPIPE, SIG_IGN);
/* Initialize the argv parsing handle */
if (OPAL_SUCCESS != opal_init_util(&argc, &argv)) {
opal_show_help("help-oshmem-info.txt", "lib-call-fail", true,
"opal_init_util", __FILE__, __LINE__, NULL);
exit(ret);
}
info_cmd_line = OBJ_NEW(opal_cmd_line_t);
if (NULL == info_cmd_line) {
ret = errno;
opal_show_help("help-oshmem-info.txt", "lib-call-fail", true,
"opal_cmd_line_create", __FILE__, __LINE__, NULL);
exit(ret);
}
/* initialize the command line, parse it, and return the directives
* telling us what the user wants output
*/
if (OPAL_SUCCESS != (ret = opal_info_init(argc, argv, info_cmd_line))) {
exit(ret);
}
if (opal_cmd_line_is_taken(info_cmd_line, "version")) {
fprintf(stdout, "Open MPI/SHMEM v%s\n\n%s\n",
OPAL_VERSION, PACKAGE_BUGREPORT);
exit(0);
}
/* setup the mca_types array */
OBJ_CONSTRUCT(&mca_types, opal_pointer_array_t);
opal_pointer_array_init(&mca_types, 256, INT_MAX, 128);
/* add in the opal frameworks */
opal_info_register_types(&mca_types);
#if OMPI_RTE_ORTE
/* add in the orte frameworks */
orte_info_register_types(&mca_types);
#endif
/* add in the ompi frameworks */
opal_info_register_types(&mca_types);
/* add in the oshmem frameworks */
oshmem_info_register_types(&mca_types);
/* init the component map */
OBJ_CONSTRUCT(&component_map, opal_pointer_array_t);
opal_pointer_array_init(&component_map, 256, INT_MAX, 128);
/* Register OMPI/OSHMEM's params */
if (OSHMEM_SUCCESS != (ret = oshmem_info_register_framework_params(&component_map))) {
if (OSHMEM_ERR_BAD_PARAM == ret) {
/* output what we got */
opal_info_do_params(true, opal_cmd_line_is_taken(info_cmd_line, "internal"),
&mca_types, &component_map, NULL);
}
exit(1);
}
/* Execute the desired action(s) */
want_all = opal_cmd_line_is_taken(info_cmd_line, "all");
if (want_all || opal_cmd_line_is_taken(info_cmd_line, "path")) {
opal_info_do_path(want_all, info_cmd_line);
acted = true;
}
if (want_all || opal_cmd_line_is_taken(info_cmd_line, "arch")) {
opal_info_do_arch();
acted = true;
}
if (want_all || opal_cmd_line_is_taken(info_cmd_line, "hostname")) {
opal_info_do_hostname();
acted = true;
}
if (want_all || opal_cmd_line_is_taken(info_cmd_line, "config")) {
oshmem_info_do_config(true);
acted = true;
}
if (want_all || opal_cmd_line_is_taken(info_cmd_line, "param") ||
opal_cmd_line_is_taken(info_cmd_line, "params")) {
opal_info_do_params(want_all, opal_cmd_line_is_taken(info_cmd_line, "internal"),
&mca_types, &component_map, info_cmd_line);
acted = true;
}
/* If no command line args are specified, show default set */
if (!acted) {
opal_info_out("Package", "package", OPAL_PACKAGE_STRING);
oshmem_info_show_oshmem_version(opal_info_ver_full);
opal_info_show_path(opal_info_path_prefix, opal_install_dirs.prefix);
opal_info_do_arch();
opal_info_do_hostname();
oshmem_info_do_config(false);
opal_info_show_component_version(&mca_types, &component_map, opal_info_type_all,
opal_info_component_all, opal_info_ver_full,
opal_info_ver_all);
}
/* All done */
oshmem_info_close_components();
OBJ_RELEASE(info_cmd_line);
OBJ_DESTRUCT(&mca_types);
for (i=0; i < component_map.size; i++) {
if (NULL != (map = (opal_info_component_map_t*)opal_pointer_array_get_item(&component_map, i))) {
OBJ_RELEASE(map);
}
}
OBJ_DESTRUCT(&component_map);
opal_info_finalize();
/* Put our own call to opal_finalize_util() here because we called
it up above (and it refcounts) */
opal_finalize_util();
return 0;
}