Synopsis
int MPI_Session_finalize(MPI_Session *session)
Input/Output Parameters
- session
-
session to be finalized (handle)
Description
MPI_Session_finalize cleans up all MPI state associated with a session and sets the session handle to MPI_SESSION_NULL.
Before invoking this routine, an MPI process must locally complete all MPI operations it initiated and execute matching calls needed to complete MPI communications initiated by other processes. All message handles associated with the session must be received and all request handles must be freed for nonblocking operations, or be inactive or freed for persistent or partitioned operations. This routine does not free objects created by MPI calls; these objects are freed using MPI_XXX_FREE, MPI_COMM_DISCONNECT, or MPI_FILE_CLOSE calls. After this routine returns, no MPI procedure related to this session may be called except for those listed as callable before initialization. MPI_Session_finalize may be synchronizing on any or all of the groups associated with communicators, windows, or files derived from the session and not disconnected, freed, or closed before the call. Opaque objects and their handles may bind internal resources; therefore, explicitly freeing handles associated with a session before finalizing it is recommended.
Notes for Fortran
All MPI routines in Fortran (except for 'MPI_WTIME' and 'MPI_WTICK') have an additional argument 'ierr' at the end of the argument list. 'ierr' is an integer and has the same meaning as the return value of the routine in C. In Fortran, MPI routines are subroutines, and are invoked with the 'call' statement.
All MPI objects (e.g., 'MPI_Datatype', 'MPI_Comm') are of type 'INTEGER' in Fortran.
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_ERR_SESSION - Invalid session handle
-
MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.