56 #ifndef OPAL_MCA_BASE_PARAM_H
57 #define OPAL_MCA_BASE_PARAM_H
59 #include "opal_config.h"
227 const char *param_name,
228 const char *help_msg,
289 const char *param_name,
290 const char *help_msg,
333 const char *param_name,
334 const char *help_msg,
337 const char *default_value,
338 char **current_value);
400 const char *param_name,
401 const char *help_msg,
404 const char *default_value,
405 char **current_value);
443 const char *syn_param_name,
468 const char *syn_type,
469 const char *syn_param_name,
636 const char *component,
654 const char *param_name,
675 const char *param_name,
693 const char *param_name,
695 char **current_value);
714 const char *param_name,
716 char **current_value);
747 const char *component_a,
750 const char *component_b,
751 const char *param_b);
907 const char *component_name,
908 const char *param_name,
909 const char *mca_param_name,
944 const char *component_name,
945 const char *param_name,
946 const char *mca_param_name,
947 const char *default_value) ;
Struct for holding name/type info.
Definition: mca_base_param.h:101
int mbpp_synonyms_len
Length of mbpp_synonyms array.
Definition: mca_base_param.h:125
Common type for all MCA components.
Definition: mca.h:250
OPAL_DECLSPEC int mca_base_param_reg_syn(int orignal_index, const mca_base_component_t *syn_component, const char *syn_param_name, bool deprecated)
Register a synonym name for an MCA parameter.
Definition: mca_base_param.c:463
The value came a "set" API call.
Definition: mca_base_param.h:90
OPAL_DECLSPEC int mca_base_param_reg_string_name(const char *type, const char *param_name, const char *help_msg, bool internal, bool read_only, const char *default_value, char **current_value)
Register a string MCA parameter that is not associated with a component.
Definition: mca_base_param.c:386
OPAL_DECLSPEC int mca_base_param_unset(int index)
Unset a parameter that was previously set by mca_base_param_set_int() or mca_base_param_set_string()...
Definition: mca_base_param.c:573
OPAL_DECLSPEC int mca_base_param_recache_files(bool rel_path_search)
Recache the MCA param files.
Definition: mca_base_param.c:179
OPAL_DECLSPEC int mca_base_param_build_env(char ***env, int *num_env, bool internal)
Obtain a list of all the MCA parameters currently defined as well as their types. ...
Definition: mca_base_param.c:836
OPAL_DECLSPEC int mca_base_param_register_int(const char *type_name, const char *component_name, const char *param_name, const char *mca_param_name, int default_value)
Definition: mca_base_param.c:418
int mbpp_index
Index of this parameter.
Definition: mca_base_param.h:106
OPAL_DECLSPEC int mca_base_param_reg_string(const mca_base_component_t *component, const char *param_name, const char *help_msg, bool internal, bool read_only, const char *default_value, char **current_value)
Register a string MCA parameter.
Definition: mca_base_param.c:352
OPAL_DECLSPEC char * mca_base_param_environ_variable(const char *type, const char *comp, const char *param)
Definition: mca_base_param.c:619
The opal_list_t interface is used to provide a generic doubly-linked list container for Open MPI...
BEGIN_C_DECLS OPAL_DECLSPEC OBJ_CLASS_DECLARATION(mca_base_param_info_t)
Make a real object for the info.
OPAL_DECLSPEC int mca_base_param_register_string(const char *type_name, const char *component_name, const char *param_name, const char *mca_param_name, const char *default_value)
Definition: mca_base_param.c:439
OPAL_DECLSPEC int mca_base_param_lookup_source(int index, mca_base_param_source_t *source, char **source_file)
Lookup the source of an MCA parameter's value.
Definition: mca_base_param.c:560
Top-level interface for all MCA components.
Definition: opal_list.h:98
char * mbpp_component_name
String name of the component of the parameter.
Definition: mca_base_param.h:113
bool mbpp_deprecated
Is this parameter deprecated?
Definition: mca_base_param.h:120
OPAL_DECLSPEC int mca_base_param_check_exclusive_string(const char *type_a, const char *component_a, const char *param_a, const char *type_b, const char *component_b, const char *param_b)
Check that two MCA parameters were not both set to non-default values.
Definition: mca_base_param.c:2297
OPAL_DECLSPEC int mca_base_param_dump_release(opal_list_t *info)
Release the memory associated with the info list returned from mca_base_param_dump().
Definition: mca_base_param.c:903
The default value.
Definition: mca_base_param.h:84
OPAL_DECLSPEC int mca_base_param_deregister(int index)
Deregister a MCA parameter.
Definition: mca_base_param.c:515
OPAL_DECLSPEC int mca_base_param_reg_int_name(const char *type, const char *param_name, const char *help_msg, bool internal, bool read_only, int default_value, int *current_value)
Register an integer MCA parameter that is not associated with a component.
Definition: mca_base_param.c:326
OPAL_DECLSPEC int mca_base_param_find(const char *type, const char *component, const char *param)
Find the index for an MCA parameter based on its names.
Definition: mca_base_param.c:670
The parameter is of type string.
Definition: mca_base_param.h:72
The value came from the environment (or command line!)
Definition: mca_base_param.h:86
OPAL_DECLSPEC int mca_base_param_init(void)
Initialize the MCA parameter system.
Definition: mca_base_param.c:156
struct mca_base_param_info_t * mbpp_synonym_parent
Back pointer to another mca_base_param_info_t that this param is a synonym of (or NULL) ...
Definition: mca_base_param.h:128
OPAL_DECLSPEC int mca_base_param_finalize(void)
Shut down the MCA parameter system (normally only invoked by the MCA framework itself).
Definition: mca_base_param.c:921
char * mbpp_full_name
Full, assembled parameter name.
Definition: mca_base_param.h:117
struct mca_base_param_info_t ** mbpp_synonyms
Array of pointers of synonyms of this parameter.
Definition: mca_base_param.h:123
OPAL_DECLSPEC int mca_base_param_lookup_int(int index, int *value)
Look up an integer MCA parameter.
Definition: mca_base_param.c:487
bool mbpp_internal
Is this parameter internal?
Definition: mca_base_param.h:131
char * mbpp_help_msg
Help message associated with this parameter.
Definition: mca_base_param.h:135
char * mbpp_type_name
String name of the type of this component.
Definition: mca_base_param.h:111
mca_base_param_source_t
Source of an MCA parameter's value.
Definition: mca_base_param.h:82
Definition: opal_list.h:147
mca_base_param_type_t mbpp_type
Enum indicating the back-end type of the parameter.
Definition: mca_base_param.h:108
The value came from a file.
Definition: mca_base_param.h:88
OPAL_DECLSPEC int mca_base_param_lookup_string(int index, char **value)
Look up a string MCA parameter.
Definition: mca_base_param.c:531
OPAL_DECLSPEC int mca_base_param_set_int(int index, int value)
Sets an "override" value for an integer MCA parameter.
Definition: mca_base_param.c:502
OPAL_DECLSPEC int mca_base_param_dump(opal_list_t **info, bool internal)
Obtain a list of all the MCA parameters currently defined as well as their types. ...
Definition: mca_base_param.c:739
OPAL_DECLSPEC int mca_base_param_find_int(const mca_base_component_t *component, const char *param_name, char **env, int *current_value)
Find an MCA parameter in an env array based on its names.
Definition: mca_base_param.c:2154
OPAL_DECLSPEC int mca_base_param_find_string_name(const char *type, const char *param_name, char **env, char **current_value)
Find a string MCA parameter (in an env array) that is not associated with a component.
Definition: mca_base_param.c:2240
opal_list_item_t super
So that we can be in a list.
Definition: mca_base_param.h:103
OPAL_DECLSPEC int mca_base_param_reg_syn_name(int orignal_index, const char *syn_type, const char *syn_param_name, bool deprecated)
Register an MCA parameter synonym that is not associated with a component.
Definition: mca_base_param.c:476
OPAL_DECLSPEC int mca_base_param_set_string(int index, char *value)
Sets an "override" value for an string MCA parameter.
Definition: mca_base_param.c:546
Maximum source type.
Definition: mca_base_param.h:93
mca_base_param_type_t
The types of MCA parameters.
Definition: mca_base_param.h:68
OPAL_DECLSPEC int mca_base_param_reg_int(const mca_base_component_t *component, const char *param_name, const char *help_msg, bool internal, bool read_only, int default_value, int *current_value)
Register an integer MCA parameter.
Definition: mca_base_param.c:297
OPAL_DECLSPEC int mca_base_param_set_internal(int index, bool internal)
Set the "internal" flag on an MCA parameter to true or false.
Definition: mca_base_param.c:707
OPAL_DECLSPEC int mca_base_param_find_int_name(const char *type, const char *param_name, char **env, int *current_value)
Find an MCA parameter (in an env array) that is not associated with a component.
Definition: mca_base_param.c:2183
The parameter is of type integer.
Definition: mca_base_param.h:70
char * mbpp_param_name
String name of the parameter of the parameter.
Definition: mca_base_param.h:115
OPAL_DECLSPEC int mca_base_param_find_string(const mca_base_component_t *component, const char *param_name, char **env, char **current_value)
Find a string MCA parameter in an env array based on its names.
Definition: mca_base_param.c:2211
OPAL_DECLSPEC char * mca_base_param_env_var(const char *param_name)
Get the string name corresponding to the MCA parameter value in the environment.
Definition: mca_base_param.c:607
Maximum parameter type.
Definition: mca_base_param.h:75
bool mbpp_read_only
Is this parameter changable?
Definition: mca_base_param.h:133