Skip site navigation (1)Skip section navigation (2)

  
 
  

home | help
MPI_T_finalize(3)		       MPI		       MPI_T_finalize(3)

NAME
     MPI_T_finalize -  Finalize the MPI tool information interface

SYNOPSIS
     int MPI_T_finalize(void)

NOTES
     This    routine   may   be   called   as	often	as   the   corresponding
     MPI_T_init_thread() routine up to the current point of  execution.  Calling
     it  more times returns a corresponding error code. As long as the number of
     calls  to	MPI_T_finalize()  is  smaller  than  the  number  of  calls   to
     MPI_T_init_thread()  up to the current point of execution, the MPI tool in-
     formation interface remains initialized and calls to its routines are  per-
     missible.	 Further,  additional  calls to MPI_T_init_thread() after one or
     more calls to MPI_T_finalize() are permissible.  Once  MPI_T_finalize()  is
     called  the  same	number of times as the routine MPI_T_init_thread() up to
     the current point of execution, the MPI tool information  interface  is  no
     longer  initialized. The interface can be reinitialized by subsequent calls
     to MPI_T_init_thread().

     At the end of the program execution, unless MPI_Abort() is called,  an  ap-
     plication	must  have  called  MPI_T_init_thread()  and MPI_T_finalize() an
     equal number of times.

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 ar-
     gument.  Before the value is returned, the current  MPI  error  handler  is
     called.  By default, this error handler aborts the MPI job.  The error han-
     dler  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_T_ERR_NOT_INITIALIZED
	    - The MPI tool information interface is not initialized.
     MPI_ERR_OTHER
	    -  Other  error;  use MPI_Error_string to get more information about
	    this error code.

SEE ALSO
     MPI_T_init_thread

				    4/10/2026		       MPI_T_finalize(3)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=MPI_T_finalize&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>

home | help