openmpi  3.1.6
About: Open MPI is a high performance Message Passing Interface (MPI) library project combining technologies and resources from several other projects (FT-MPI, LA-MPI, LAM/MPI, and PACX-MPI) in order to build the best MPI library available. 3.x series.
  Fossies Dox: openmpi-3.1.6.tar.bz2  ("unofficial" and yet experimental doxygen-generated source code documentation)  

params.h File Reference
#include "ompi_config.h"
Include dependency graph for params.h:

Go to the source code of this file.

Functions

int ompi_mpi_register_params (void)
 Register MCA parameters used by the MPI layer. More...
 
int ompi_show_all_mca_params (int32_t, int, char *)
 Display all MCA parameters used. More...
 

Variables

BEGIN_C_DECLS bool ompi_mpi_param_check
 Whether or not to check the parameters of top-level MPI API functions or not. More...
 
bool ompi_debug_show_handle_leaks
 Whether or not to check for MPI handle leaks during MPI_FINALIZE. More...
 
int ompi_debug_show_mpi_alloc_mem_leaks
 If > 0, show that many MPI_ALLOC_MEM leaks during MPI_FINALIZE. More...
 
bool ompi_debug_no_free_handles
 Whether or not to actually free MPI handles when their corresponding destructor is invoked. More...
 
bool ompi_mpi_show_mca_params
 Whether or not to print MCA parameters on MPI_INIT. More...
 
char * ompi_mpi_show_mca_params_file
 Whether or not to print the MCA parameters to a file or to stdout. More...
 
bool ompi_mpi_abort_print_stack
 Whether an MPI_ABORT should print out a stack trace or not. More...
 
int ompi_mpi_abort_delay
 Whether MPI_ABORT should print out an identifying message (e.g., hostname and PID) and loop waiting for a debugger to attach. More...
 
bool ompi_have_sparse_group_storage
 Whether sparse MPI group storage formats are supported or not. More...
 
bool ompi_use_sparse_group_storage
 Whether sparse MPI group storage formats should be used or not. More...
 
uint32_t ompi_add_procs_cutoff
 Cutoff point for calling add_procs for all processes. More...
 
bool ompi_mpi_dynamics_enabled
 Whether anything in the code base has disabled MPI dynamic process functionality or not. More...
 
bool ompi_async_mpi_init
 
bool ompi_async_mpi_finalize
 

Function Documentation

◆ ompi_mpi_register_params()

int ompi_mpi_register_params ( void  )

◆ ompi_show_all_mca_params()

Variable Documentation

◆ ompi_add_procs_cutoff

uint32_t ompi_add_procs_cutoff
extern

Cutoff point for calling add_procs for all processes.

Definition at line 75 of file ompi_mpi_params.c.

Referenced by ompi_mpi_register_params(), ompi_proc_complete_init(), and ompi_proc_init().

◆ ompi_async_mpi_finalize

bool ompi_async_mpi_finalize
extern

Definition at line 72 of file ompi_mpi_params.c.

Referenced by ompi_mpi_finalize(), and ompi_mpi_register_params().

◆ ompi_async_mpi_init

bool ompi_async_mpi_init
extern

Definition at line 71 of file ompi_mpi_params.c.

Referenced by ompi_mpi_init(), and ompi_mpi_register_params().

◆ ompi_debug_no_free_handles

bool ompi_debug_no_free_handles
extern

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.

Definition at line 58 of file ompi_mpi_params.c.

Referenced by file_constructor(), info_constructor(), ompi_file_finalize(), ompi_mpi_register_params(), and ompi_mpiinfo_finalize().

◆ ompi_debug_show_handle_leaks

bool ompi_debug_show_handle_leaks
extern

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.

Definition at line 56 of file ompi_mpi_params.c.

Referenced by ompi_comm_finalize(), ompi_file_finalize(), ompi_mpi_register_params(), ompi_mpiinfo_finalize(), and ompi_win_finalize().

◆ ompi_debug_show_mpi_alloc_mem_leaks

int ompi_debug_show_mpi_alloc_mem_leaks
extern

If > 0, show that many MPI_ALLOC_MEM leaks during MPI_FINALIZE.

If enabled, memory that was returned via MPI_ALLOC_MEM but was never freed via MPI_FREE_MEM will be displayed during MPI_FINALIZE.

This is good debugging for user applications to find out if they are inadvertantly orphaning MPI "special" memory.

Definition at line 57 of file ompi_mpi_params.c.

Referenced by ompi_mpi_finalize(), and ompi_mpi_register_params().

◆ ompi_have_sparse_group_storage

bool ompi_have_sparse_group_storage
extern

Whether sparse MPI group storage formats are supported or not.

Definition at line 62 of file ompi_mpi_params.c.

◆ ompi_mpi_abort_delay

int ompi_mpi_abort_delay
extern

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_mpi_abort_print_stack

bool ompi_mpi_abort_print_stack
extern

Whether an MPI_ABORT should print out a stack trace or not.

◆ ompi_mpi_dynamics_enabled

bool ompi_mpi_dynamics_enabled
extern

Whether anything in the code base has disabled MPI dynamic process functionality or not.

Definition at line 76 of file ompi_mpi_params.c.

Referenced by ompi_mpi_dynamics_disable(), ompi_mpi_dynamics_finalize(), ompi_mpi_dynamics_is_enabled(), and ompi_mpi_register_params().

◆ ompi_mpi_param_check

BEGIN_C_DECLS bool ompi_mpi_param_check
extern

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".

Definition at line 55 of file ompi_mpi_params.c.

Referenced by ompi_mpi_register_params().

◆ ompi_mpi_show_mca_params

bool ompi_mpi_show_mca_params
extern

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.

Definition at line 59 of file ompi_mpi_params.c.

Referenced by ompi_mpi_init(), and ompi_mpi_register_params().

◆ ompi_mpi_show_mca_params_file

char* ompi_mpi_show_mca_params_file
extern

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.

Definition at line 60 of file ompi_mpi_params.c.

Referenced by ompi_mpi_register_params(), and ompi_show_all_mca_params().

◆ ompi_use_sparse_group_storage

bool ompi_use_sparse_group_storage
extern

Whether sparse MPI group storage formats should be used or not.

Definition at line 63 of file ompi_mpi_params.c.

Referenced by ompi_group_incl(), and ompi_mpi_register_params().