MPI_T_pvar_reset(3) MPI MPI_T_pvar_reset(3)
NAME
MPI_T_pvar_reset - Reset a performance variable
SYNOPSIS
int MPI_T_pvar_reset(MPI_T_pvar_session session, MPI_T_pvar_handle handle)
INPUT PARAMETERS
session
- identifier of performance experiment session (handle)
handle - handle of a performance variable (handle)
NOTES
The MPI_T_pvar_reset() call sets the performance variable with the han-
dle identified by the parameter handle to its starting value. If it is
not possible to change the variable, the function returns
MPI_T_ERR_PVAR_NO_WRITE. If the constant MPI_T_PVAR_ALL_HANDLES is
passed in handle, the MPI implementation attempts to reset all vari-
ables within the session identified by the parameter session for which
handles have been allocated. In this case, the routine returns MPI_SUC-
CESS if all variables are reset successfully, otherwise
MPI_T_ERR_PVAR_NO_WRITE is returned. Readonly variables are ignored
when MPI_T_PVAR_ALL_HANDLES is specified.
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 com-
municators), 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 prede-
fined 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_HANDLE
- The handle is invalid.
MPI_T_ERR_INVALID_SESSION
- Session argument is not valid.
MPI_T_ERR_NOT_INITIALIZED
- The MPI tool information interface is not initialized.
MPI_T_ERR_PVAR_NO_WRITE
- The performance variable can not be written or reset.
MPI_ERR_OTHER
- Other error; use MPI_Error_string to get more information
about this error code.
2/22/2022 MPI_T_pvar_reset(3)
mpi 4.0.1 - Generated Tue Mar 29 16:05:54 CDT 2022