4c1dd716c7
- new preferred API calls for registering MCA parameters are
mca_base_param_reg_{int|string} and
mca_base_param_reg_{int|string}_name.
- See opal/mca/base/mca_base_param.h for docs on new calls.
- Can now register and lookup a value at the same time.
- Can now mark a parameter "read only" at registration time
- Can now mark a parameter "internal" at registration time
- Can now associate a help message with the parameter at registration
time; displayed in the ompi_info output.
The old API calls are still available for backwards compatibility
(mca_base_param_register_{int|string}. They will eventually be
removed -- all developers are encouraged to use the new APIs from here
on out and replace any old calls with the new API.
Some params were also renamed -- the previous convention of using
"base_" as a prefix for any param that was not associated with a
component is henceforth deprecated. Instead, use one of the following
prefixes:
mca: for anything in the MCA base itself
opal: for anything in OPAL
orte: for anything in ORTE
mpi: for anything in OMPI
This commit was SVN r6698.
167 строки
4.2 KiB
C
167 строки
4.2 KiB
C
/*
|
|
* Copyright (c) 2004-2005 The Trustees of Indiana University.
|
|
* All rights reserved.
|
|
* Copyright (c) 2004-2005 The Trustees of the University of Tennessee.
|
|
* 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$
|
|
*
|
|
* Additional copyrights may follow
|
|
*
|
|
* $HEADER$
|
|
*/
|
|
|
|
/**
|
|
* @file
|
|
*
|
|
* This is the private declarations for the MCA parameter system.
|
|
* This file is internal to the MCA parameter system and should not
|
|
* need to be used by any other elements in Open MPI except the
|
|
* special case of the ompi_info command.
|
|
*
|
|
* All the rest of the doxygen documentation in this file is marked as
|
|
* "internal" and won't show up unless you specifically tell doxygen
|
|
* to generate internal documentation (by default, it is skipped).
|
|
*/
|
|
|
|
#ifndef OMPI_MCA_BASE_PARAM_INTERNAL_H
|
|
#define OMPI_MCA_BASE_PARAM_INTERNAL_H
|
|
|
|
#include "ompi_config.h"
|
|
|
|
#include "opal/class/opal_object.h"
|
|
#include "opal/class/opal_list.h"
|
|
#include "class/opal_hash_table.h"
|
|
#include "mca/base/mca_base_param.h"
|
|
|
|
/**
|
|
* \internal
|
|
*
|
|
* Types for MCA parameters.
|
|
*/
|
|
typedef union {
|
|
/** Integer value */
|
|
int intval;
|
|
/** String value */
|
|
char *stringval;
|
|
} mca_base_param_storage_t;
|
|
|
|
|
|
/**
|
|
* \internal
|
|
*
|
|
* Entry for holding the information about an MCA parameter and its
|
|
* default value.
|
|
*/
|
|
struct mca_base_param_t {
|
|
/** Allow this to be an OMPI OBJ */
|
|
opal_object_t mbp_super;
|
|
|
|
/** Enum indicating the type of the parameter (integer or string) */
|
|
mca_base_param_type_t mbp_type;
|
|
/** String of the type name, or NULL */
|
|
char *mbp_type_name;
|
|
/** String of the component name */
|
|
char *mbp_component_name;
|
|
/** String of the parameter name */
|
|
char *mbp_param_name;
|
|
/** Full parameter name, in case it is not
|
|
<type>_<component>_<param> */
|
|
char *mbp_full_name;
|
|
|
|
/** Whether this is internal (not meant to be seen / modified by
|
|
users) or not */
|
|
bool mbp_internal;
|
|
/** Whether this value is changable from the default value that
|
|
was registered (e.g., when true, useful for reporting values,
|
|
like the value of the GM library that was linked against) */
|
|
bool mbp_read_only;
|
|
/** Help message associated with this parameter */
|
|
char *mbp_help_msg;
|
|
|
|
/** Keyval value for MPI attribute parameters */
|
|
int mbp_keyval;
|
|
/** Environment variable name */
|
|
char *mbp_env_var_name;
|
|
|
|
/** Default value of the parameter */
|
|
mca_base_param_storage_t mbp_default_value;
|
|
|
|
/** Whether or not we have a file value */
|
|
bool mbp_file_value_set;
|
|
/** Value of the parameter found in a file */
|
|
mca_base_param_storage_t mbp_file_value;
|
|
|
|
/** Whether or not we have an override value */
|
|
bool mbp_override_value_set;
|
|
/** Value of the parameter override set via API */
|
|
mca_base_param_storage_t mbp_override_value;
|
|
};
|
|
/**
|
|
* \internal
|
|
*
|
|
* Convenience typedef.
|
|
*/
|
|
typedef struct mca_base_param_t mca_base_param_t;
|
|
|
|
/**
|
|
* \internal
|
|
*
|
|
* Object delcataion for mca_base_param_t
|
|
*/
|
|
OBJ_CLASS_DECLARATION(mca_base_param_t);
|
|
|
|
|
|
/**
|
|
* \internal
|
|
*
|
|
* Structure for holding param names and values read in from files.
|
|
*/
|
|
struct mca_base_param_file_value_t {
|
|
/** Allow this to be an OMPI OBJ */
|
|
opal_list_item_t super;
|
|
|
|
/** Parameter name */
|
|
char *mbpfv_param;
|
|
/** Parameter value */
|
|
char *mbpfv_value;
|
|
};
|
|
/**
|
|
* \internal
|
|
*
|
|
* Convenience typedef
|
|
*/
|
|
typedef struct mca_base_param_file_value_t mca_base_param_file_value_t;
|
|
|
|
/**
|
|
* Object declaration for mca_base_param_file_value_t
|
|
*/
|
|
OBJ_CLASS_DECLARATION(mca_base_param_file_value_t);
|
|
|
|
|
|
/**
|
|
* \internal
|
|
*
|
|
* Global list of params and values read in from MCA parameter files
|
|
*/
|
|
OMPI_DECLSPEC extern opal_list_t mca_base_param_file_values;
|
|
|
|
|
|
#if defined(c_plusplus) || defined(__cplusplus)
|
|
extern "C" {
|
|
#endif
|
|
/**
|
|
* \internal
|
|
*
|
|
* Parse a parameter file.
|
|
*/
|
|
int mca_base_parse_paramfile(const char *paramfile);
|
|
#if defined(c_plusplus) || defined(__cplusplus)
|
|
}
|
|
#endif
|
|
|
|
#endif /* OMPI_MCA_BASE_PARAM_INTERNAL_H */
|