Synopsis
int MPI_Comm_join(int fd, MPI_Comm *intercomm)
Input Parameters
- fd
-
socket file descriptor (integer)
Output Parameters
- intercomm
-
new inter-communicator (handle)
Description
MPI_Comm_join creates an inter-communicator from the union of two MPI processes that are connected by a socket.
This function is intended for MPI implementations in environments supporting the Berkeley Socket interface; implementations in other environments provide the entry point but return MPI_COMM_NULL. The fd argument must be a file descriptor representing a connected socket of type SOCK_STREAM with nonblocking I/O and asynchronous notification via SIGIO disabled. The socket must be quiescent when this function is called and remains open and quiescent upon return. This function does not return until both processes have called it. In a multithreaded application, the application must ensure that one thread does not access the socket while another is calling this function, and must not call this function concurrently from multiple threads. Calling this function on two connected MPI processes is undefined because it uses non-MPI communication. An MPI implementation may require a specific communication medium for MPI communication, in which case two processes may not successfully join even with a socket connecting them and using the same MPI implementation.
Notes
The socket must be quiescent before MPI_COMM_JOIN is called and after
MPI_COMM_JOIN returns. More specifically, on entry to MPI_COMM_JOIN, a
read on the socket will not read any data that was written to the socket
before the remote process called MPI_COMM_JOIN.
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_ARG - Invalid argument. Some argument is invalid and is not identified by a specific error class (e.g., 'MPI_ERR_RANK').
-
MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.