Blame www/www3/MPI_T_pvar_session_free.html

Packit Service c5cf8c
Packit Service c5cf8c
<HTML>
Packit Service c5cf8c
<HEAD>
Packit Service c5cf8c
<META NAME="GENERATOR" CONTENT="DOCTEXT">
Packit Service c5cf8c
<TITLE>MPI_T_pvar_session_free</TITLE>
Packit Service c5cf8c
</HEAD>
Packit Service c5cf8c
<BODY BGCOLOR="FFFFFF">
Packit Service c5cf8c

MPI_T_pvar_session_free

Packit Service c5cf8c
Free an existing performance variable session 
Packit Service c5cf8c

Synopsis

Packit Service c5cf8c
Packit Service c5cf8c
int MPI_T_pvar_session_free(MPI_T_pvar_session * session)
Packit Service c5cf8c
Packit Service c5cf8c

Input/Output Parameters

Packit Service c5cf8c
Packit Service c5cf8c
session
identifier of performance experiment session (handle)
Packit Service c5cf8c
Packit Service c5cf8c

Packit Service c5cf8c

Notes

Packit Service c5cf8c
Calls to the MPI tool information interface can no longer be made
Packit Service c5cf8c
within the context of a session after it is freed. On a successful
Packit Service c5cf8c
return, MPI sets the session identifier to MPI_T_PVAR_SESSION_NULL.
Packit Service c5cf8c

Packit Service c5cf8c

Thread and Interrupt Safety

Packit Service c5cf8c

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

Packit Service c5cf8c

Errors

Packit Service c5cf8c

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

Packit Service c5cf8c
Packit Service c5cf8c
MPI_SUCCESS
No error; MPI routine completed successfully.
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
MPI_T_ERR_NOT_INITIALIZED
The MPI tool information interface is not initialized.
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
MPI_T_ERR_INVALID_SESSION
Session argument is not valid.
Packit Service c5cf8c
Packit Service c5cf8c
</BODY></HTML>