1
1
openmpi/ompi/mca/vprotocol/example/vprotocol_example_component.c
Nathan Hjelm cf377db823 MCA/base: Add new MCA variable system
Features:
 - Support for an override parameter file (openmpi-mca-param-override.conf).
   Variable values in this file can not be overridden by any file or environment
   value.
 - Support for boolean, unsigned, and unsigned long long variables.
 - Support for true/false values.
 - Support for enumerations on integer variables.
 - Support for MPIT scope, verbosity, and binding.
 - Support for command line source.
 - Support for setting variable source via the environment using
   OMPI_MCA_SOURCE_<var name>=source (either command or file:filename)
 - Cleaner API.
 - Support for variable groups (equivalent to MPIT categories).

Notes:
 - Variables must be created with a backing store (char **, int *, or bool *)
   that must live at least as long as the variable.
 - Creating a variable with the MCA_BASE_VAR_FLAG_SETTABLE enables the use of
   mca_base_var_set_value() to change the value.
 - String values are duplicated when the variable is registered. It is up to
   the caller to free the original value if necessary. The new value will be
   freed by the mca_base_var system and must not be freed by the user.
 - Variables with constant scope may not be settable.
 - Variable groups (and all associated variables) are deregistered when the
   component is closed or the component repository item is freed. This
   prevents a segmentation fault from accessing a variable after its component
   is unloaded.
 - After some discussion we decided we should remove the automatic registration
   of component priority variables. Few component actually made use of this
   feature.
 - The enumerator interface was updated to be general enough to handle
   future uses of the interface.
 - The code to generate ompi_info output has been moved into the MCA variable
   system. See mca_base_var_dump().

opal: update core and components to mca_base_var system
orte: update core and components to mca_base_var system
ompi: update core and components to mca_base_var system

This commit also modifies the rmaps framework. The following variables were
moved from ppr and lama: rmaps_base_pernode, rmaps_base_n_pernode,
rmaps_base_n_persocket. Both lama and ppr create synonyms for these variables.

This commit was SVN r28236.
2013-03-27 21:09:41 +00:00

104 строки
2.9 KiB
C

/*
* Copyright (c) 2004-2007 The Trustees of the University of Tennessee.
* All rights reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*/
#include "ompi_config.h"
#include "opal/mca/mca.h"
#include "../pml_v.h"
#include "../pml_v_protocol_base.h"
#include "vprotocol_example.h"
static int mca_vprotocol_example_component_open(void);
static int mca_vprotocol_example_component_close(void);
static mca_pml_v_protocol_base_module_t *mca_vprotocol_example_component_init( int* priority,
bool, bool);
static int mca_vprotocol_example_component_finalize(void);
static int _priority;
mca_pml_v_protocol_base_component_2_0_0_t mca_vprotocol_example_component =
{
/* First, the mca_base_component_t struct containing meta
* information about the component itself */
{
MCA_VPROTOCOL_BASE_VERSION_2_0_0,
"example", /* MCA component name */
OMPI_MAJOR_VERSION, /* MCA component major version */
OMPI_MINOR_VERSION, /* MCA component minor version */
OMPI_RELEASE_VERSION, /* MCA component release version */
mca_vprotocol_example_component_open, /* component open */
mca_vprotocol_example_component_close /* component close */
},
{
/* component is not checkpointable */
MCA_BASE_METADATA_PARAM_NONE
},
mca_vprotocol_example_component_init, /* component init */
mca_vprotocol_example_component_finalize /* component finalize */
};
/** MCA level functions
*/
int mca_vprotocol_example_component_open(void)
{
_priority = mca_param_register_int( "priority", -1);
V_OUTPUT_VERBOSE(10, "vprotocol_example_open, read priority %d", _priority);
return OMPI_SUCCESS;
}
int mca_vprotocol_example_component_close(void)
{
V_OUTPUT_VERBOSE(10, "vprotocol_example_close");
return OMPI_SUCCESS;
}
/** VPROTOCOL level functions (same as PML one)
*/
mca_pml_v_protocol_base_module_t *mca_vprotocol_example_component_init( int* priority,
bool enable_progress_threads,
bool enable_mpi_threads)
{
V_OUTPUT_VERBOSE(10, "vprotocol_example_init");
*priority = _priority;
/**
* Some protocols requires sanity check about thread support (those making piecewise deterministic assumption)
if(enable_mpi_threads)
{
OPAL_OUTPUT_VERBOSE( mca_pml_v_verbose, mca_pml_v_output, "vprotocol_example.init: threads are enabled, and not supported by vprotocol example fault tolerant layer, will not load"));
return NULL;
}
*/
/**
* Insert your own protocol initialization here
*/
return &mca_vprotocol_example.super;
}
int mca_vprotocol_example_component_finalize(void)
{
V_OUTPUT_VERBOSE(10, "vprotocol_example_finalize");
/**
* Insert your own garbage collecting here
*/
return OMPI_SUCCESS;
}