Synopsis
int MPIX_Stream_comm_create(MPI_Comm comm, MPIX_Stream stream,
MPI_Comm *newcomm)
Input Parameters
- comm
-
communicator (handle)
- stream
-
stream object (handle)
Output Parameters
- newcomm
-
new stream-associated communicator (handle)
Description
MPIX_Stream_comm_create creates a new communicator with a stream attached for concurrent communication progress.
The function duplicates comm and associates the local stream with the resulting newcomm.
A VCI table is constructed via an internal allgather to track each process’s stream VCI.
If stream is MPIX_STREAM_NULL, the default VCI of zero is used for that process.
The new communicator inherits attributes from comm and holds a reference to stream.
Subsequent point-to-point operations on newcomm use stream-indexed VCIs for thread-safe message matching.
This operation is collective and nonlocal; all processes in comm must participate.
MPIX Function
This routine is part of the MPIX extension to the MPI standard. It may become part of the standard in the future, in which its signature will change to the MPI prefix.
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.
-
MPIX_ERR_STREAM - MPIX stream object has failed.
-
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_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.