Synopsis
int MPIX_Threadcomm_init(MPI_Comm comm, int num_threads,
MPI_Comm *newthreadcomm)
Input Parameters
- comm
-
communicator (handle)
- num_threads
-
number of participating threads (non-negative integer)
Output Parameters
- newthreadcomm
-
new thread communicator (handle)
Description
MPIX_Threadcomm_init creates a persistent thread communicator from an existing communicator for use in multithreaded parallel regions.
The function duplicates comm and attaches a threadcomm structure that maps multiple threads per process to unique ranks within the new communicator.
Thread counts from all processes are gathered via an internal collective operation to construct a global rank offset table.
The function allocates thread-local storage structures, atomic barrier counters, and transport-specific message queues or mailboxes for inter-thread communication.
If initialized without MPI_THREAD_MULTIPLE, the function records this state and adjusts threading settings during subsequent MPIX_Threadcomm_start calls.
The resulting communicator must be activated inside a thread parallel region via MPIX_Threadcomm_start before use.
This operation is collective and nonlocal; all processes in comm must participate.
Threads within the same process communicate via lock-free queues; threads across processes use standard MPI point-to-point with encoded thread identifiers.
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.
-
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.