MPI_T_pvar_session_free(3) MPI MPI_T_pvar_session_free(3)NAMEMPI_T_pvar_session_free - Free an existing performance variable ses‐
sion
SYNOPSIS
int MPI_T_pvar_session_free(MPI_T_pvar_session *session)
INPUT/OUTPUT PARAMETERS
session
- identifier of performance experiment session (handle)
NOTES
Calls to the MPI tool information interface can no longer be made
within the context of a session after it is freed. On a successful
return, MPI sets the session identifier to MPI_T_PVAR_SESSION_NULL.
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 guarentee 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_NOT_INITIALIZED
- The MPI tool information interface is not initialized.
MPI_T_ERR_INVALID_SESSION
- Session argument is not valid.
11/9/2015 MPI_T_pvar_session_free(3)