1
1
openmpi/ompi/runtime/params.h
Jeff Squyres 52ca6cf86c The mpi_leave_pinned and mpi_leave_pinned_pipeline MCA parameters were
needlessly registered in multiple different places, and none of them
had a good help string.  There was also an inconsistent check for
setting both mpi_leave_pinned and mpi_leave_pinned_pipeline (i.e., it
was only in ob1).  This commit moves the registration of these params
to one central place (ompi/runtime/ompi_mpi_params.c, with all other
mpi_* MCA params) and uses globals to propagate the values as
relevant.  The error check was also moved to the central location to
ensure that we can consistency everywhere.

This commit was SVN r13226.
2007-01-21 14:02:06 +00:00

155 строки
5.0 KiB
C

/*
* Copyright (c) 2004-2005 The Trustees of Indiana University and Indiana
* University Research and Technology
* Corporation. All rights reserved.
* Copyright (c) 2004-2005 The University of Tennessee and The University
* of Tennessee Research Foundation. 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 (c) 2006-2007 Cisco Systems, Inc. All rights reserved.
* $COPYRIGHT$
*
* Additional copyrights may follow
*
* $HEADER$
*/
#ifndef OMPI_RUNTIME_PARAMS_H
#define OMPI_RUNTIME_PARAMS_H
#if defined(c_plusplus) || defined(__cplusplus)
extern "C" {
#endif
/*
* Global variables
*/
/**
* Whether or not to check the parameters of top-level MPI API
* functions or not.
*
* This variable should never be checked directly; the macro
* MPI_PARAM_CHECK should be used instead. This allows multiple
* levels of MPI function parameter checking:
*
* #- Disable all parameter checking at configure/compile time
* #- Enable all parameter checking at configure/compile time
* #- Disable all parameter checking at run time
* #- Enable all parameter checking at run time
*
* Hence, the MPI_PARAM_CHECK macro will either be "0", "1", or
* "ompi_mpi_param_check".
*/
OMPI_DECLSPEC extern bool ompi_mpi_param_check;
/**
* Whether or not to check for MPI handle leaks during MPI_FINALIZE.
* If enabled, each MPI handle type will display a summary of the
* handles that are still allocated during MPI_FINALIZE.
*
* This is good debugging for user applications to find out if they
* are inadvertantly orphaning MPI handles.
*/
OMPI_DECLSPEC extern bool ompi_debug_show_handle_leaks;
/**
* Whether or not to actually free MPI handles when their
* corresponding destructor is invoked. If enabled, Open MPI will not
* free handles, but will rather simply mark them as "freed". Any
* attempt to use them will result in an MPI exception.
*
* This is good debugging for user applications to find out if they
* are inadvertantly using MPI handles after they have been freed.
*/
OMPI_DECLSPEC extern bool ompi_debug_no_free_handles;
/**
* Whether or not to print MCA parameters on MPI_INIT
*
* This is good debugging for user applications to see exactly which
* MCA parameters are being used in the current program execution.
*/
OMPI_DECLSPEC extern bool ompi_mpi_show_mca_params;
/**
* Whether or not to print the MCA parameters to a file or to stdout
*
* If this argument is set then it is used when parameters are dumped
* when the mpi_show_mca_params is set.
*/
OMPI_DECLSPEC extern char * ompi_mpi_show_mca_params_file;
/**
* If this value is true, assume that this ORTE job is the only job
* running on the nodes that have been allocated to it, and bind
* processes to processors (starting with processor 0).
*/
OMPI_DECLSPEC extern bool ompi_mpi_paffinity_alone;
/**
* Whether we should keep the string hostnames of all the MPI
* process peers around or not (eats up a good bit of memory).
*/
OMPI_DECLSPEC extern bool ompi_mpi_keep_peer_hostnames;
/**
* Whether an MPI_ABORT should print out a stack trace or not.
*/
OMPI_DECLSPEC extern bool ompi_mpi_abort_print_stack;
/**
* Whether we should force all connections to be created during
* MPI_INIT (vs. potentially making all the connection lazily upon
* first communication with an MPI peer process).
*/
OMPI_DECLSPEC extern bool ompi_mpi_preconnect_all;
/**
* Whether MPI_ABORT should print out an identifying message
* (e.g., hostname and PID) and loop waiting for a debugger to
* attach. The value of the integer is how many seconds to wait:
*
* 0 = do not print the message and do not loop
* negative value = print the message and loop forever
* positive value = print the message and delay for that many seconds
*/
OMPI_DECLSPEC extern int ompi_mpi_abort_delay;
/**
* Whether to use the "leave pinned" protocol or not.
*/
OMPI_DECLSPEC extern bool ompi_mpi_leave_pinned;
/**
* Whether to use the "leave pinned pipeline" protocol or not.
*/
OMPI_DECLSPEC extern bool ompi_mpi_leave_pinned_pipeline;
/**
* Register MCA parameters used by the MPI layer.
*
* @returns OMPI_SUCCESS
*
* Registers several MCA parameters and initializes corresponding
* global variables to the values obtained from the MCA system.
*/
OMPI_DECLSPEC int ompi_mpi_register_params(void);
/**
* Display all MCA parameters used
*
* @returns OMPI_SUCCESS
*
* Displays in key = value format
*/
int ompi_show_all_mca_params(int32_t, int, char *);
#if defined(c_plusplus) || defined(__cplusplus)
}
#endif
#endif /* OMPI_RUNTIME_PARAMS_H */