Scroll to navigation

MPI_T_pvar_get_info(3) MPI MPI_T_pvar_get_info(3)


MPI_T_pvar_get_info - Get the information about a performance variable


int MPI_T_pvar_get_info(int pvar_index, char *name, int *name_len, int *verbosity, int *var_class,
MPI_Datatype *datatype, MPI_T_enum *enumtype, char *desc, int *desc_len,
int *bind, int *readonly, int *continuous, int *atomic)


- index of the performance variable to be queried between $0$ and $num_pvar-1$ (integer)


- length of the string and/or buffer for name (integer)
- length of the string and/or buffer for desc (integer)


- buffer to return the string containing the name of the performance variable (string)
- verbosity level of this variable (integer)
- class of performance variable (integer)
- mpi datatype of the information stored in the performance variable (handle)
- optional descriptor for enumeration information (handle)
- buffer to return the string containing a description of the performance variable (string)
- type of mpi object to which this variable must be bound (integer)
- flag indicating whether the variable can be written/reset (integer)
- flag indicating whether the variable can be started and stopped or is continuously active (integer)
- flag indicating whether the variable can be atomically read and reset (integer)


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.


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.

- No error; MPI routine completed successfully.

- Index is invalid or has been deleted.
- The MPI tool information interface is not initialized.
- Other error; use MPI_Error_string to get more information about this error code.