root/opal/runtime/opal_info_support.h

INCLUDED FROM

   1 /*
   2  * Copyright (c) 2012-2013 Los Alamos National Security, LLC.
   3  *                         All rights reserved.
   4 * Copyright (c) 2014 Cisco Systems, Inc.  All rights reserved.
   5 * Copyright (c) 2017 IBM Corporation.  All rights reserved.
   6 * $COPYRIGHT$
   7  *
   8  * Additional copyrights may follow
   9  *
  10  * $HEADER$
  11  */
  12 
  13 /** @file **/
  14 
  15 #ifndef OPAL_INFO_REGISTER_H
  16 #define OPAL_INFO_REGISTER_H
  17 
  18 #include "opal_config.h"
  19 
  20 #include "opal/class/opal_list.h"
  21 #include "opal/class/opal_pointer_array.h"
  22 #include "opal/util/cmd_line.h"
  23 #include "opal/mca/base/base.h"
  24 
  25 BEGIN_C_DECLS
  26 
  27 OPAL_DECLSPEC extern const char *opal_info_path_prefix;
  28 
  29 OPAL_DECLSPEC extern const char *opal_info_type_all;
  30 OPAL_DECLSPEC extern const char *opal_info_type_opal;
  31 OPAL_DECLSPEC extern const char *opal_info_component_all;
  32 extern const char *opal_info_param_all;
  33 
  34 OPAL_DECLSPEC extern const char *opal_info_ver_full;
  35 extern const char *opal_info_ver_major;
  36 extern const char *opal_info_ver_minor;
  37 extern const char *opal_info_ver_release;
  38 extern const char *opal_info_ver_greek;
  39 extern const char *opal_info_ver_repo;
  40 
  41 OPAL_DECLSPEC extern const char *opal_info_ver_all;
  42 extern const char *opal_info_ver_mca;
  43 extern const char *opal_info_ver_type;
  44 extern const char *opal_info_ver_component;
  45 
  46 
  47 /*
  48  * Component-related functions
  49  */
  50 typedef struct {
  51     opal_list_item_t super;
  52     char *type;
  53     opal_list_t *components;
  54     opal_list_t *failed_components;
  55 } opal_info_component_map_t;
  56 OPAL_DECLSPEC OBJ_CLASS_DECLARATION(opal_info_component_map_t);
  57 
  58 
  59 OPAL_DECLSPEC int opal_info_init(int argc, char **argv,
  60                                  opal_cmd_line_t *opal_info_cmd_line);
  61 
  62 OPAL_DECLSPEC void opal_info_finalize(void);
  63 
  64 OPAL_DECLSPEC void opal_info_register_types(opal_pointer_array_t *mca_types);
  65 
  66 OPAL_DECLSPEC int opal_info_register_framework_params(opal_pointer_array_t *component_map);
  67 
  68 OPAL_DECLSPEC void opal_info_close_components(void);
  69 OPAL_DECLSPEC void opal_info_err_params(opal_pointer_array_t *component_map);
  70 
  71 OPAL_DECLSPEC void opal_info_do_params(bool want_all_in, bool want_internal,
  72                                        opal_pointer_array_t *mca_type,
  73                                        opal_pointer_array_t *component_map,
  74                                        opal_cmd_line_t *opal_info_cmd_line);
  75 
  76 OPAL_DECLSPEC void opal_info_show_path(const char *type, const char *value);
  77 
  78 OPAL_DECLSPEC void opal_info_do_path(bool want_all, opal_cmd_line_t *cmd_line);
  79 
  80 OPAL_DECLSPEC void opal_info_show_mca_params(const char *type,
  81                                              const char *component,
  82                                              mca_base_var_info_lvl_t max_level,
  83                                              bool want_internal);
  84 
  85 OPAL_DECLSPEC void opal_info_show_mca_version(const mca_base_component_t *component,
  86                                               const char *scope, const char *ver_type);
  87 
  88 OPAL_DECLSPEC void opal_info_show_component_version(opal_pointer_array_t *mca_types,
  89                                                     opal_pointer_array_t *component_map,
  90                                                     const char *type_name,
  91                                                     const char *component_name,
  92                                                     const char *scope, const char *ver_type);
  93 
  94 OPAL_DECLSPEC char *opal_info_make_version_str(const char *scope,
  95                                                int major, int minor, int release,
  96                                                const char *greek,
  97                                                const char *repo);
  98 
  99 OPAL_DECLSPEC void opal_info_show_opal_version(const char *scope);
 100 
 101 OPAL_DECLSPEC void opal_info_do_arch(void);
 102 
 103 OPAL_DECLSPEC void opal_info_do_hostname(void);
 104 
 105 OPAL_DECLSPEC void opal_info_do_type(opal_cmd_line_t *opal_info_cmd_line);
 106 
 107 OPAL_DECLSPEC void opal_info_out(const char *pretty_message, const char *plain_message, const char *value);
 108 
 109 OPAL_DECLSPEC void opal_info_out_int(const char *pretty_message,
 110                                      const char *plain_message,
 111                                      int value);
 112 
 113 OPAL_DECLSPEC int opal_info_register_project_frameworks (const char *project_name,
 114                                                          mca_base_framework_t **frameworks,
 115                                                          opal_pointer_array_t *component_map);
 116 
 117 END_C_DECLS
 118 
 119 #endif