root/orte/tools/orte-info/orte-info.h

INCLUDED FROM

   1 /*
   2  * Copyright (c) 2004-2009 The Trustees of Indiana University and Indiana
   3  *                         University Research and Technology
   4  *                         Corporation.  All rights reserved.
   5  * Copyright (c) 2004-2005 The University of Tennessee and The University
   6  *                         of Tennessee Research Foundation.  All rights
   7  *                         reserved.
   8  * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
   9  *                         University of Stuttgart.  All rights reserved.
  10  * Copyright (c) 2004-2005 The Regents of the University of California.
  11  *                         All rights reserved.
  12  * Copyright (c) 2007-2010 Cisco Systems, Inc.  All rights reserved.
  13  * Copyright (c) 2015      Research Organization for Information Science
  14  *                         and Technology (RIST). All rights reserved.
  15  * Copyright (c) 2018      Intel, Inc.  All rights reserved.
  16  * $COPYRIGHT$
  17  *
  18  * Additional copyrights may follow
  19  *
  20  * $HEADER$
  21  */
  22 
  23 #ifndef ORTE_INFO_TOOL_H
  24 #define ORTE_INFO_TOOL_H
  25 #include "orte_config.h"
  26 
  27 #include "opal/class/opal_list.h"
  28 #include "opal/class/opal_pointer_array.h"
  29 #include "opal/util/cmd_line.h"
  30 #include "opal/util/printf.h"
  31 #include "opal/mca/mca.h"
  32 
  33 BEGIN_C_DECLS
  34 
  35 /*
  36  * Globals
  37  */
  38 
  39 extern bool orte_info_pretty;
  40 extern opal_cmd_line_t *orte_info_cmd_line;
  41 
  42 extern const char *orte_info_type_all;
  43 extern const char *orte_info_type_opal;
  44 extern const char *orte_info_type_base;
  45 
  46 extern opal_pointer_array_t mca_types;
  47 
  48 
  49 /*
  50  * Version-related strings and functions
  51  */
  52 
  53 extern const char *orte_info_ver_full;
  54 extern const char *orte_info_ver_major;
  55 extern const char *orte_info_ver_minor;
  56 extern const char *orte_info_ver_release;
  57 extern const char *orte_info_ver_greek;
  58 extern const char *orte_info_ver_svn;
  59 
  60 void orte_info_do_version(bool want_all, opal_cmd_line_t *cmd_line);
  61 void orte_info_show_orte_version(const char *scope);
  62 void orte_info_show_component_version(const char *type_name,
  63                                       const char *component_name,
  64                                       const char *scope,
  65                                       const char *ver_type);
  66 
  67 /*
  68  * Parameter/configuration-related functions
  69  */
  70 
  71 extern const char *orte_info_component_all;
  72 extern const char *orte_info_param_all;
  73 
  74 extern const char *orte_info_path_prefix;
  75 extern const char *orte_info_path_bindir;
  76 extern const char *orte_info_path_libdir;
  77 extern const char *orte_info_path_incdir;
  78 extern const char *orte_info_path_mandir;
  79 extern const char *orte_info_path_pkglibdir;
  80 extern const char *orte_info_path_sysconfdir;
  81 extern const char *orte_info_path_exec_prefix;
  82 extern const char *orte_info_path_sbindir;
  83 extern const char *orte_info_path_libexecdir;
  84 extern const char *orte_info_path_datarootdir;
  85 extern const char *orte_info_path_datadir;
  86 extern const char *orte_info_path_sharedstatedir;
  87 extern const char *orte_info_path_localstatedir;
  88 extern const char *orte_info_path_infodir;
  89 extern const char *orte_info_path_pkgdatadir;
  90 extern const char *orte_info_path_pkgincludedir;
  91 
  92 void orte_info_do_params(bool want_all, bool want_internal);
  93 void orte_info_show_mca_params(const char *type, const char *component,
  94                                bool want_internal);
  95 
  96 void orte_info_do_path(bool want_all, opal_cmd_line_t *cmd_line);
  97 void orte_info_show_path(const char *type, const char *value);
  98 
  99 void orte_info_do_arch(void);
 100 void orte_info_do_hostname(void);
 101 void orte_info_do_config(bool want_all);
 102 
 103 /*
 104  * Output-related functions
 105  */
 106 void orte_info_out(const char *pretty_message,
 107                    const char *plain_message,
 108                    const char *value);
 109 void orte_info_out_int(const char *pretty_message,
 110                        const char *plain_message,
 111                        int value);
 112 /*
 113  * Component-related functions
 114  */
 115 typedef struct {
 116     opal_list_item_t super;
 117     char *type;
 118     opal_list_t *components;
 119 } orte_info_component_map_t;
 120 ORTE_DECLSPEC OBJ_CLASS_DECLARATION(orte_info_component_map_t);
 121 
 122 extern opal_pointer_array_t orte_component_map;
 123 
 124 void orte_info_components_open(void);
 125 void orte_info_components_close(void);
 126 
 127 END_C_DECLS
 128 
 129 #endif /* ORTE_INFO_H */