Synopsis

int MPI_Finalize(void)

Description

MPI_Finalize cleans up all MPI state associated with the World Process Model.

If an MPI program that initializes the World Process Model terminates normally, each process must call MPI_Finalize before it exits. Before calling MPI_Finalize, a process must locally complete all MPI operations it initiated and execute matching calls needed to complete MPI communications initiated by other processes. All request handles associated with the World Process Model must be freed for nonblocking operations and must be inactive or freed for persistent or partitioned operations. MPI_Finalize does not free objects created by MPI calls; these objects are freed using MPI_xxx_FREE, MPI_COMM_DISCONNECT, or MPI_FILE_CLOSE calls. MPI_Finalize is collective over all connected processes. Once MPI_Finalize returns, no MPI procedure may be called in the World Process Model except for those listed as callable before initialization and after finalization. In multithreaded applications, the call to MPI_Finalize may occur on the main thread that initialized MPI after all process threads have completed their MPI calls with no pending communication or I/O operations.

MPI_Finalize first executes the equivalent of MPI_COMM_FREE on MPI_COMM_SELF, invoking delete callback functions on all keys associated with MPI_COMM_SELF in reverse order of association. It is not required that all processes return from MPI_Finalize, but when a process has not failed or aborted, at least the process assigned rank 0 in MPI_COMM_WORLD must return.

Notes

All processes must call this routine before exiting. The number of processes running after this routine is called is undefined; it is best not to perform much more than a return rc after calling MPI_Finalize.

Thread and Signal Safety

The MPI standard requires that MPI_Finalize be called only by the same thread that initialized MPI with either MPI_Init or MPI_Init_thread.

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_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.