Synopsis

int MPI_T_cvar_get_num(int *num_cvar)

Output Parameters

num_cvar

returns number of control variables (integer)

Description

MPI_T_cvar_get_num queries the number of control variables exported by the MPI implementation through the MPI tool information interface.

This routine has local semantics. If the returned count is zero, the MPI implementation does not export any control variables; otherwise the provided control variables are indexed from 0 to num_cvar-1. The MPI implementation may increase the number of control variables during execution when new variables become available through dynamic loading. However, MPI implementations are not permitted to change the index of a control variable or delete a variable once it has been added. The number and indices of control variables are not guaranteed to be the same across MPI processes or between runs of an application. Applications relying on a particular control variable may not be portable across MPI implementations or platforms.

Thread and Interrupt Safety

This routine is thread-safe. This means that this routine may be safely used by multiple threads without the need for any user-provided thread locks. However, the routine is not interrupt safe. Typically, this is due to the use of memory allocation routines such as 'malloc' or other non-MPICH runtime routines that are themselves not interrupt-safe.

Errors

All MPI routines (except 'MPI_Wtime' and 'MPI_Wtick') return an error value; C routines as the value of the function and Fortran routines in the last argument. Before the value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job. The error handler may be changed with 'MPI_Comm_set_errhandler' (for communicators), 'MPI_File_set_errhandler' (for files), and 'MPI_Win_set_errhandler' (for RMA windows). The MPI-1 routine 'MPI_Errhandler_set' may be used but its use is deprecated. The predefined error handler 'MPI_ERRORS_RETURN' may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error; however, MPI implementations will attempt to continue whenever possible.

  • MPI_SUCCESS - No error; MPI routine completed successfully.

  • MPI_T_ERR_INVALID - Invalid use of the interface or bad parameter values(s).

  • MPI_T_ERR_NOT_INITIALIZED - The MPI tool information interface is not initialized.

  • MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.