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

FreeBSD Manual Pages

  
 
  

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. Call-
       ing  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 information	interface remains initialized and calls	 to  its  rou-
       tines	 are	permissible.	 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	execu-
       tion,  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
       application 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	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_er-
       rhandler	(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 guarentee that an MPI program can continue past
       an error; however, MPI implementations will attempt to  continue	 when-
       ever possible.

       MPI_SUCCESS
	      -	No error; MPI routine completed	successfully.
       MPI_T_ERR_NOT_INITIALIZED
	      -	The MPI	tool information interface is not initialized.

SEE ALSO
       MPI_T_init_thread

				  11/10/2017		     MPI_T_finalize(3)

NAME | SYNOPSIS | NOTES | THREAD AND INTERRUPT SAFETY | ERRORS | SEE ALSO

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

home | help