/*
* Copyright (c) 2004-2009 The Trustees of Indiana University and Indiana
* University Research and Technology
* Corporation. All rights reserved.
* Copyright (c) 2004-2006 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) 2007-2009 Cisco Systems, Inc. All rights reserved.
* Copyright (c) 2009 Oak Ridge National Labs. All rights reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*/
#include "orte_config.h"
#include <string.h>
#include <ctype.h>
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
#ifdef HAVE_SYS_PARAM_H
#include <sys/param.h>
#endif
#ifdef HAVE_NETDB_H
#include <netdb.h>
#endif
#include MCA_timer_IMPLEMENTATION_HEADER
#include "opal/mca/installdirs/installdirs.h"
#include "opal/class/opal_value_array.h"
#include "opal/class/opal_pointer_array.h"
#include "opal/util/printf.h"
#include "opal/memoryhooks/memory.h"
#include "opal/mca/base/mca_base_param.h"
#include "opal/include/opal_portable_platform.h"
#include "orte/util/show_help.h"
#include "orte/tools/orte-info/orte-info.h"
/*
* Public variables
*/
const char *orte_info_component_all = "all";
const char *orte_info_param_all = "all";
const char *orte_info_path_prefix = "prefix";
const char *orte_info_path_bindir = "bindir";
const char *orte_info_path_libdir = "libdir";
const char *orte_info_path_incdir = "incdir";
const char *orte_info_path_mandir = "mandir";
const char *orte_info_path_pkglibdir = "pkglibdir";
const char *orte_info_path_sysconfdir = "sysconfdir";
const char *orte_info_path_exec_prefix = "exec_prefix";
const char *orte_info_path_sbindir = "sbindir";
const char *orte_info_path_libexecdir = "libexecdir";
const char *orte_info_path_datarootdir = "datarootdir";
const char *orte_info_path_datadir = "datadir";
const char *orte_info_path_sharedstatedir = "sharedstatedir";
const char *orte_info_path_localstatedir = "localstatedir";
const char *orte_info_path_infodir = "infodir";
const char *orte_info_path_pkgdatadir = "pkgdatadir";
const char *orte_info_path_pkgincludedir = "pkgincludedir";
/*
* External variables
*
* This exists in mca/base/mca_base_param.c. It's not extern'ed
* in mca_base_param.h so that no one else will use it.
*/
extern opal_value_array_t mca_base_params;
void orte_info_do_params(bool want_all_in, bool want_internal)
{
int count;
char *type, *component, *str;
bool found;
int i;
bool want_all = false;
opal_list_t *info;
orte_info_open_components();
if (want_all_in) {
want_all = true;
} else {
/* See if the special param "all" was givin to --param; that
* superceeds any individual type
*/
count = opal_cmd_line_get_ninsts(orte_info_cmd_line, "param");
for (i = 0; i < count; ++i) {
type = opal_cmd_line_get_param(orte_info_cmd_line, "param", (int)i, 0);
if (0 == strcmp(orte_info_type_all, type)) {
want_all = true;
break;
}
}
}
/* Get a dump of all the MCA params */
mca_base_param_dump(&info, want_internal);
/* Show the params */
if (want_all) {
for (i = 0; i < mca_types.size; ++i) {
if (NULL == (type = (char *)opal_pointer_array_get_item(&mca_types, i))) {
continue;
}
orte_info_show_mca_params(info, type, orte_info_component_all, want_internal);
}
} else {
for (i = 0; i < count; ++i) {
type = opal_cmd_line_get_param(orte_info_cmd_line, "param", (int)i, 0);
component = opal_cmd_line_get_param(orte_info_cmd_line, "param", (int)i, 1);
for (found = false, i = 0; i < mca_types.size; ++i) {
if (NULL == (str = (char *)opal_pointer_array_get_item(&mca_types, i))) {
continue;
}
if (0 == strcmp(str, type)) {
found = true;
break;
}
}
if (!found) {
char *usage = opal_cmd_line_get_usage_msg(orte_info_cmd_line);
orte_show_help("help-orte-info.txt", "not-found", true, type);
free(usage);
exit(1);
}
orte_info_show_mca_params(info, type, component, want_internal);
}
}
/* Release all the MCA param memory */
mca_base_param_dump_release(info);
}
void orte_info_show_mca_params(opal_list_t *info,
const char *type, const char *component,
bool want_internal)
{
opal_list_item_t *i;
mca_base_param_info_t *p;
char *value_string, *empty = "";
char *message, *content, *tmp;
int value_int, j;
mca_base_param_source_t source;
char *src_file;
for (i = opal_list_get_first(info); i != opal_list_get_last(info);
i = opal_list_get_next(i)) {
p = (mca_base_param_info_t*) i;
if (NULL != p->mbpp_type_name && 0 == strcmp(type, p->mbpp_type_name)) {
if (0 == strcmp(component, orte_info_component_all) ||
NULL == p->mbpp_component_name ||
(NULL != p->mbpp_component_name &&
0 == strcmp(component, p->mbpp_component_name))) {
/* Find the source of the value */
if (OPAL_SUCCESS !=
mca_base_param_lookup_source(p->mbpp_index, &source, &src_file)) {
continue;
}
/* Make a char *for the default value. Invoke a
* lookup because it may transform the char *("~/" ->
* "<home dir>/") or get the value from the
* environment, a file, etc.
*/
if (MCA_BASE_PARAM_TYPE_STRING == p->mbpp_type) {
mca_base_param_lookup_string(p->mbpp_index,
&value_string);
/* Can't let the char *be NULL because we
* assign it to a std::string, below
*/
if (NULL == value_string) {
value_string = strdup(empty);
}
} else {
mca_base_param_lookup_int(p->mbpp_index, &value_int);
asprintf(&value_string, "%d", value_int);
}
/* Build up the strings to orte_info_output. */
if (orte_info_pretty) {
asprintf(&message, "MCA %s", p->mbpp_type_name);
/* Put in the real, full name (which may be
* different than the categorization).
*/
asprintf(&content, "%s \"%s\" (%s: <%s>, data source: ",
p->mbpp_read_only ? "information" : "parameter",
p->mbpp_full_name,
p->mbpp_read_only ? "value" : "current value",
(0 == strlen(value_string)) ? "none" : value_string);
/* Indicate where the param was set from */
switch(source) {
case MCA_BASE_PARAM_SOURCE_DEFAULT:
asprintf(&tmp, "%sdefault value", content);
free(content);
content = tmp;
break;
case MCA_BASE_PARAM_SOURCE_ENV:
asprintf(&tmp, "%senvironment or cmdline", content);
free(content);
content = tmp;
break;
case MCA_BASE_PARAM_SOURCE_FILE:
asprintf(&tmp, "%sfile [%s]", content, src_file);
free(content);
content = tmp;
break;
case MCA_BASE_PARAM_SOURCE_OVERRIDE:
asprintf(&tmp, "%sAPI override", content);
free(content);
content = tmp;
break;
default:
break;
}
/* Is this parameter deprecated? */
if (p->mbpp_deprecated) {
asprintf(&tmp, "%s, deprecated", content);
free(content);
content = tmp;
}
/* Does this parameter have any synonyms? */
if (p->mbpp_synonyms_len > 0) {
asprintf(&tmp, "%s, synonyms: ", content);
free(content);
content = tmp;
for (j = 0; j < p->mbpp_synonyms_len; ++j) {
if (j > 0) {
asprintf(&tmp, "%s, %s", content, p->mbpp_synonyms[j]->mbpp_full_name);
free(content);
content = tmp;
} else {
asprintf(&tmp, "%s%s", content, p->mbpp_synonyms[j]->mbpp_full_name);
free(content);
content = tmp;
}
}
}
/* Is this parameter a synonym of something else? */
else if (NULL != p->mbpp_synonym_parent) {
asprintf(&tmp, "%s, synonym of: %s", content, p->mbpp_synonym_parent->mbpp_full_name);
free(content);
content = tmp;
}
asprintf(&tmp, "%s)", content);
free(content);
content = tmp;
orte_info_out(message, message, content);
free(message);
free(content);
/* If we have a help message, orte_info_output it */
if (NULL != p->mbpp_help_msg) {
orte_info_out("", "", p->mbpp_help_msg);
}
} else {
/* build the message*/
asprintf(&tmp, "mca:%s:%s:param:%s:", p->mbpp_type_name,
(NULL == p->mbpp_component_name) ? "base" : p->mbpp_component_name,
p->mbpp_full_name);
/* Output the value */
asprintf(&message, "%svalue", tmp);
orte_info_out(message, message, value_string);
free(message);
/* Indicate where the param was set from */
asprintf(&message, "%sdata_source", tmp);
switch(source) {
case MCA_BASE_PARAM_SOURCE_DEFAULT:
content = strdup("default value");
break;
case MCA_BASE_PARAM_SOURCE_ENV:
content = strdup("environment-cmdline");
break;
case MCA_BASE_PARAM_SOURCE_FILE:
asprintf(&content, "file: %s", src_file);
break;
case MCA_BASE_PARAM_SOURCE_OVERRIDE:
content = strdup("API override");
break;
default:
break;
}
orte_info_out(message, message, content);
free(message);
free(content);
/* Output whether it's read only or writable */
asprintf(&message, "%sstatus", tmp);
content = p->mbpp_read_only ? "read-only" : "writable";
orte_info_out(message, message, content);
free(message);
/* If it has a help message, orte_info_output that */
if (NULL != p->mbpp_help_msg) {
asprintf(&message, "%shelp", tmp);
content = p->mbpp_help_msg;
orte_info_out(message, message, content);
free(message);
}
/* Is this parameter deprecated? */
asprintf(&message, "%sdeprecated", tmp);
content = p->mbpp_deprecated ? "yes" : "no";
orte_info_out(message, message, content);
free(message);
/* Does this parameter have any synonyms? */
if (p->mbpp_synonyms_len > 0) {
for (j = 0; j < p->mbpp_synonyms_len; ++j) {
asprintf(&message, "%ssynonym:name", tmp);
content = p->mbpp_synonyms[j]->mbpp_full_name;
orte_info_out(message, message, content);
free(message);
}
}
/* Is this parameter a synonym of something else? */
else if (NULL != p->mbpp_synonym_parent) {
asprintf(&message, "%ssynonym_of:name", tmp);
content = p->mbpp_synonym_parent->mbpp_full_name;
orte_info_out(message, message, content);
free(message);
}
}
/* If we allocated the string, then free it */
if (NULL != value_string) {
free(value_string);
}
}
}
}
}
void orte_info_do_path(bool want_all, opal_cmd_line_t *cmd_line)
{
int i, count;
char *scope;
/* Check bozo case */
count = opal_cmd_line_get_ninsts(cmd_line, "path");
for (i = 0; i < count; ++i) {
scope = opal_cmd_line_get_param(cmd_line, "path", i, 0);
if (0 == strcmp("all", scope)) {
want_all = true;
break;
}
}
if (want_all) {
orte_info_show_path(orte_info_path_prefix, opal_install_dirs.prefix);
orte_info_show_path(orte_info_path_exec_prefix, opal_install_dirs.exec_prefix);
orte_info_show_path(orte_info_path_bindir, opal_install_dirs.bindir);
orte_info_show_path(orte_info_path_sbindir, opal_install_dirs.sbindir);
orte_info_show_path(orte_info_path_libdir, opal_install_dirs.libdir);
orte_info_show_path(orte_info_path_incdir, opal_install_dirs.includedir);
orte_info_show_path(orte_info_path_mandir, opal_install_dirs.mandir);
orte_info_show_path(orte_info_path_pkglibdir, opal_install_dirs.pkglibdir);
orte_info_show_path(orte_info_path_libexecdir, opal_install_dirs.libexecdir);
orte_info_show_path(orte_info_path_datarootdir, opal_install_dirs.datarootdir);
orte_info_show_path(orte_info_path_datadir, opal_install_dirs.datadir);
orte_info_show_path(orte_info_path_sysconfdir, opal_install_dirs.sysconfdir);
orte_info_show_path(orte_info_path_sharedstatedir, opal_install_dirs.sharedstatedir);
orte_info_show_path(orte_info_path_localstatedir, opal_install_dirs.localstatedir);
orte_info_show_path(orte_info_path_infodir, opal_install_dirs.infodir);
orte_info_show_path(orte_info_path_pkgdatadir, opal_install_dirs.pkgdatadir);
orte_info_show_path(orte_info_path_pkglibdir, opal_install_dirs.pkglibdir);
orte_info_show_path(orte_info_path_pkgincludedir, opal_install_dirs.pkgincludedir);
} else {
count = opal_cmd_line_get_ninsts(cmd_line, "path");
for (i = 0; i < count; ++i) {
scope = opal_cmd_line_get_param(cmd_line, "path", i, 0);
if (0 == strcmp(orte_info_path_prefix, scope)) {
orte_info_show_path(orte_info_path_prefix, opal_install_dirs.prefix);
} else if (0 == strcmp(orte_info_path_bindir, scope)) {
orte_info_show_path(orte_info_path_bindir, opal_install_dirs.bindir);
} else if (0 == strcmp(orte_info_path_libdir, scope)) {
orte_info_show_path(orte_info_path_libdir, opal_install_dirs.libdir);
} else if (0 == strcmp(orte_info_path_incdir, scope)) {
orte_info_show_path(orte_info_path_incdir, opal_install_dirs.includedir);
} else if (0 == strcmp(orte_info_path_mandir, scope)) {
orte_info_show_path(orte_info_path_mandir, opal_install_dirs.mandir);
} else if (0 == strcmp(orte_info_path_pkglibdir, scope)) {
orte_info_show_path(orte_info_path_pkglibdir, opal_install_dirs.pkglibdir);
} else if (0 == strcmp(orte_info_path_sysconfdir, scope)) {
orte_info_show_path(orte_info_path_sysconfdir, opal_install_dirs.sysconfdir);
} else if (0 == strcmp(orte_info_path_exec_prefix, scope)) {
orte_info_show_path(orte_info_path_exec_prefix, opal_install_dirs.exec_prefix);
} else if (0 == strcmp(orte_info_path_sbindir, scope)) {
orte_info_show_path(orte_info_path_sbindir, opal_install_dirs.sbindir);
} else if (0 == strcmp(orte_info_path_libexecdir, scope)) {
orte_info_show_path(orte_info_path_libexecdir, opal_install_dirs.libexecdir);
} else if (0 == strcmp(orte_info_path_datarootdir, scope)) {
orte_info_show_path(orte_info_path_datarootdir, opal_install_dirs.datarootdir);
} else if (0 == strcmp(orte_info_path_datadir, scope)) {
orte_info_show_path(orte_info_path_datadir, opal_install_dirs.datadir);
} else if (0 == strcmp(orte_info_path_sharedstatedir, scope)) {
orte_info_show_path(orte_info_path_sharedstatedir, opal_install_dirs.sharedstatedir);
} else if (0 == strcmp(orte_info_path_localstatedir, scope)) {
orte_info_show_path(orte_info_path_localstatedir, opal_install_dirs.localstatedir);
} else if (0 == strcmp(orte_info_path_infodir, scope)) {
orte_info_show_path(orte_info_path_infodir, opal_install_dirs.infodir);
} else if (0 == strcmp(orte_info_path_pkgdatadir, scope)) {
orte_info_show_path(orte_info_path_pkgdatadir, opal_install_dirs.pkgdatadir);
} else if (0 == strcmp(orte_info_path_pkgincludedir, scope)) {
orte_info_show_path(orte_info_path_pkgincludedir, opal_install_dirs.pkgincludedir);
} else {
char *usage = opal_cmd_line_get_usage_msg(cmd_line);
orte_show_help("help-orte-info.txt", "usage", true, usage);
free(usage);
exit(1);
}
}
}
}
void orte_info_show_path(const char *type, const char *value)
{
char *pretty, *path;
pretty = strdup(type);
pretty[0] = toupper(pretty[0]);
asprintf(&path, "path:%s", type);
orte_info_out(pretty, path, value);
free(pretty);
free(path);
}
void orte_info_do_arch()
{
orte_info_out("Configured architecture", "config:arch", OPAL_ARCH);
}
void orte_info_do_hostname()
{
orte_info_out("Configure host", "config:host", OMPI_CONFIGURE_HOST);
}
/*
* do_config
* Accepts:
* - want_all: boolean flag; TRUE -> display all options
* FALSE -> display selected options
*
* This function displays all the options with which the current
* installation of orte was configured. There are many options here
* that are carried forward from OMPI-7 and are not mca parameters
* in OMPI-10. I have to dig through the invalid options and replace
* them with OMPI-10 options.
*/
void orte_info_do_config(bool want_all)
{
char *heterogeneous;
char *memprofile;
char *memdebug;
char *debug;
char *threads;
char *want_libltdl;
char *orterun_prefix_by_default;
char *wtime_support;
char *symbol_visibility;
char *ft_support;
/* setup the strings that don't require allocations*/
heterogeneous = OPAL_ENABLE_HETEROGENEOUS_SUPPORT ? "yes" : "no";
memprofile = OPAL_ENABLE_MEM_PROFILE ? "yes" : "no";
memdebug = OPAL_ENABLE_MEM_DEBUG ? "yes" : "no";
debug = OPAL_ENABLE_DEBUG ? "yes" : "no";
want_libltdl = OPAL_WANT_LIBLTDL ? "yes" : "no";
orterun_prefix_by_default = ORTE_WANT_ORTERUN_PREFIX_BY_DEFAULT ? "yes" : "no";
wtime_support = OPAL_TIMER_USEC_NATIVE ? "native" : "gettimeofday";
symbol_visibility = OPAL_C_HAVE_VISIBILITY ? "yes" : "no";
/* setup strings that require allocation */
if (OPAL_HAVE_SOLARIS_THREADS || OPAL_HAVE_POSIX_THREADS) {
asprintf(&threads, "%s (mpi: %s, progress: %s)", OPAL_HAVE_SOLARIS_THREADS ? "solaris" :
(OPAL_HAVE_POSIX_THREADS ? "posix" : "type unknown"),
OPAL_ENABLE_MULTI_THREADS ? "yes" : "no",
OPAL_ENABLE_PROGRESS_THREADS ? "yes" : "no");
} else {
threads = strdup("no");
}
asprintf(&ft_support, "%s (checkpoint thread: %s)",
OPAL_ENABLE_FT ? "yes" : "no", OPAL_ENABLE_FT_THREAD ? "yes" : "no");;
/* output values */
orte_info_out("Configured by", "config:user", OMPI_CONFIGURE_USER);
orte_info_out("Configured on", "config:timestamp", OMPI_CONFIGURE_DATE);
orte_info_out("Configure host", "config:host", OMPI_CONFIGURE_HOST);
orte_info_out("Built by", "build:user", OMPI_BUILD_USER);
orte_info_out("Built on", "build:timestamp", OMPI_BUILD_DATE);
orte_info_out("Built host", "build:host", OMPI_BUILD_HOST);
orte_info_out("C compiler", "compiler:c:command", OPAL_CC);
orte_info_out("C compiler absolute", "compiler:c:absolute", OPAL_CC_ABSOLUTE);
orte_info_out("C compiler family name", "compiler:c:familyname", _STRINGIFY(OPAL_BUILD_PLATFORM_COMPILER_FAMILYNAME));
orte_info_out("C compiler version", "compiler:c:version", _STRINGIFY(OPAL_BUILD_PLATFORM_COMPILER_VERSION_STR));
if (want_all) {
orte_info_out_int("C char size", "compiler:c:sizeof:char", sizeof(char));
/* JMS: should be fixed in MPI-2.2 to differentiate between C
_Bool and C++ bool. For the moment, the code base assumes
that they are the same. Because of opal_config_bottom.h,
we can sizeof(bool) here, so we might as well -- even
though this technically isn't right. This should be fixed
when we update to MPI-2.2. See below for note about C++
bool alignment. */
orte_info_out_int("C bool size", "compiler:c:sizeof:bool", sizeof(bool));
orte_info_out_int("C short size", "compiler:c:sizeof:short", sizeof(short));
orte_info_out_int("C int size", "compiler:c:sizeof:int", sizeof(int));
orte_info_out_int("C long size", "compiler:c:sizeof:long", sizeof(long));
orte_info_out_int("C float size", "compiler:c:sizeof:float", sizeof(float));
orte_info_out_int("C double size", "compiler:c:sizeof:double", sizeof(double));
orte_info_out_int("C pointer size", "compiler:c:sizeof:pointer", sizeof(void *));
orte_info_out_int("C char align", "compiler:c:align:char", OPAL_ALIGNMENT_CHAR);
orte_info_out("C bool align", "compiler:c:align:bool", "skipped");
orte_info_out_int("C int align", "compiler:c:align:int", OPAL_ALIGNMENT_INT);
orte_info_out_int("C float align", "compiler:c:align:float", OPAL_ALIGNMENT_FLOAT);
orte_info_out_int("C double align", "compiler:c:align:double", OPAL_ALIGNMENT_DOUBLE);
}
if (want_all) {
orte_info_out("Thread support", "option:threads", threads);
free(threads);
orte_info_out("Build CFLAGS", "option:build:cflags", OMPI_BUILD_CFLAGS);
orte_info_out("Build CXXFLAGS", "option:build:cxxflags", OMPI_BUILD_CXXFLAGS);
orte_info_out("Build LDFLAGS", "option:build:ldflags", OMPI_BUILD_LDFLAGS);
orte_info_out("Build LIBS", "option:build:libs", OMPI_BUILD_LIBS);
orte_info_out("Wrapper extra CFLAGS", "option:wrapper:extra_cflags",
WRAPPER_EXTRA_CFLAGS);
orte_info_out("Wrapper extra CXXFLAGS", "option:wrapper:extra_cxxflags",
WRAPPER_EXTRA_CXXFLAGS);
orte_info_out("Wrapper extra LDFLAGS", "option:wrapper:extra_ldflags",
WRAPPER_EXTRA_LDFLAGS);
orte_info_out("Wrapper extra LIBS", "option:wrapper:extra_libs",
WRAPPER_EXTRA_LIBS);
}
orte_info_out("Internal debug support", "option:debug", debug);
orte_info_out("Memory profiling support", "option:mem-profile", memprofile);
orte_info_out("Memory debugging support", "option:mem-debug", memdebug);
orte_info_out("libltdl support", "option:dlopen", want_libltdl);
orte_info_out("Heterogeneous support", "options:heterogeneous", heterogeneous);
orte_info_out("orterun default --prefix", "orterun:prefix_by_default",
orterun_prefix_by_default);
orte_info_out("MPI_WTIME support", "options:mpi-wtime", wtime_support);
orte_info_out("Symbol vis. support", "options:visibility", symbol_visibility);
orte_info_out("FT Checkpoint support", "options:ft_support", ft_support);
free(ft_support);
}