Synopsis
int MPI_Comm_disconnect(MPI_Comm *comm)
Input/Output Parameters
- comm
-
communicator (handle)
Description
MPI_Comm_disconnect waits for all decoupled MPI activities on a communicator to complete internally, deallocates the communicator object, and sets the handle to MPI_COMM_NULL.
This function is collective and may not be called with MPI_COMM_WORLD or MPI_COMM_SELF. All communication must be complete and matched before calling this function, which is the same requirement as for MPI_FINALIZE. Before calling this function, all request handles associated with comm must be freed for nonblocking operations, and must be inactive or freed for persistent or partitioned operations. After calling this function, freeing or starting an inactive persistent request handle for a communication operation on comm is erroneous. To fully disconnect two processes, MPI_COMM_DISCONNECT, MPI_WIN_FREE, and MPI_FILE_CLOSE may need to be called to remove all communication paths between them.
Notes
This routine waits for all pending communication to complete, then frees the
communicator and sets comm to MPI_COMM_NULL. It may not be called
with MPI_COMM_WORLD or MPI_COMM_SELF.
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.
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_COMM - Invalid communicator. A common error is to use a null communicator in a call (not even allowed in 'MPI_Comm_rank').
-
MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.