MPI_COMM_IDUP_WITH_INFO(3)
π¦ NAME π¦
MPI_Comm_idup_with_info β like, it starts the nonblocking duplication of an existing communicator, and it brings along all its cached information. Periodt. π
β¨ SYNTAX β¨
C Syntax
#include <mpi.h>
int MPI_Comm_idup_with_info(MPI_Comm comm, MPI_Info info, MPI_Comm *newcomm, MPI_Request *request)
Fortran Syntax
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_COMM_IDUP_WITH_INFO(COMM, INFO, NEWCOMM, REQUEST, IERROR)
INTEGER COMM, INFO, NEWCOMM, REQUEST, IERROR
Fortran 2008 Syntax
USE mpi_f08
MPI_Comm_idup_with_info(comm, info, newcomm, request, ierror)
TYPE(MPI_Comm), INTENT(IN) :: comm
TYPE(MPI_Info), INTENT(IN) :: info
TYPE(MPI_Comm), INTENT(OUT) :: newcomm
TYPE(MPI_Request), INTENT(OUT) :: request
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
πΈ INPUT PARAMETER πΈ
commβ communicator (handle).infoβ info object (handle).
π OUTPUT PARAMETERS π
newcommβ copy ofcomm(handle).requestβ communication request (handle).ierrorβ Fortran only: error status (integer).
π DESCRIPTION π
Okay so bestie, here's the tea. MPI_Comm_idup_with_info starts the nonblocking duplication of an existing communicator comm with associated key values. For each key value, the respective copy callback function determines the attribute value associated with this key in the new communicator β and one very specific little maneuver a copy callback is allowed to pull is to delete the attribute from the new communicator. Iconic of it, honestly.
It returns in newcomm a new communicator with the same group, any copied cached information, but a new context (peep the βFunctionalityβ subsection of the βCachingβ section in the βGroups, Contexts, and Communicatorsβ chapter of the MPI Standard, https://www.mpi-forum.org/docs/).
π«Ά Heads up: the communicator returned in newcomm will not be available until the request is complete. It's giving "coming soon" β do not touch it early.
The hints you hand over in the supplied info argument are associated with the output communicator. π
And how do you know when the duplication request is done-done? You find out by calling any of MPI_Wait, MPI_Waitany, MPI_Test, or MPI_Testany with the request that this function gave you back. Slay. π₯
π NOTES π
This operation exists to give a parallel library call a duplicate communication space that has the same properties as the original communicator. That includes any attributes (see below, bestie) and topologies (see the βProcess Topologiesβ chapter in the MPI Standard, https://www.mpi-forum.org/docs/). π§
This call is valid even if there are pending point-to-point communications involving the communicator comm. Like, yes, even then. π
A typical call might involve an MPI_Comm_idup_with_info at the beginning of the parallel call, and an MPI_Comm_free of that duplicated communicator at the end of the call. Other models of communicator management are also possible β you do you. π
This call applies to both intra- and intercommunicators.
π Not me having to tell you this: it is not defined by the MPI standard what happens if the attribute copy callback invokes other MPI functions. And in Open MPI specifically, it is not valid for attribute copy callbacks (or any of their children) to add or delete attributes on the same object on which the attribute copy callback is being invoked. Do not do it. No cap.
π ERRORS π
Almost all MPI routines return an error value; C routines as the return result of the function, and Fortran routines in the last argument. Classic.
Before the error value is returned, the current MPI error handler associated with the communication object (e.g., communicator, window, file) is called. If no communication object is associated with the MPI call, then the call is considered attached to MPI_COMM_SELF and will call the associated MPI error handler. When MPI_COMM_SELF is not initialized (i.e., before MPI_Init/MPI_Init_thread, after MPI_Finalize, or when using the Sessions Model exclusively) the error raises the initial error handler. The initial error handler can be changed by calling MPI_Comm_set_errhandler on MPI_COMM_SELF when using the World model, or the mpi_initial_errhandler CLI argument to mpiexec or info key to MPI_Comm_spawn/MPI_Comm_spawn_multiple. If no other appropriate error handler has been set, then the MPI_ERRORS_RETURN error handler is called for MPI I/O functions and the MPI_ERRORS_ABORT error handler is called for all other MPI functions.
Open MPI includes three predefined error handlers that can be used:
MPI_ERRORS_ARE_FATALβ causes the program to abort all connected MPI processes. π³MPI_ERRORS_ABORTβ an error handler that can be invoked on a communicator, window, file, or session. When called on a communicator, it acts as ifMPI_Abortwas called on that communicator. If called on a window or file, acts as ifMPI_Abortwas called on a communicator containing the group of processes in the corresponding window or file. If called on a session, aborts only the local process.MPI_ERRORS_RETURNβ returns an error code to the application.
MPI applications can also implement their own error handlers by calling:
MPI_Comm_create_errhandlerthenMPI_Comm_set_errhandlerMPI_File_create_errhandlerthenMPI_File_set_errhandlerMPI_Session_create_errhandlerthenMPI_Session_set_errhandleror atMPI_Session_initMPI_Win_create_errhandlerthenMPI_Win_set_errhandler
π Note that MPI does not guarantee that an MPI program can continue past an error. Like, it might just be over.
See the MPI man page for a full list of MPI error codes. (MPI error codes β go look, iykyk.)
See the Error Handling section of the MPI-3.1 standard for more information.
π See also:
MPI_Comm_dupMPI_Comm_idupMPI_Comm_dup_with_info
π Copyright π
2003-2026, The Open MPI Community
And that's the whole page, bestie β written up in the Open MPI source, under the manual name MPI_COMM_IDUP_WITH_INFO(3), dated Sep 10, 2026. Copyright 2003-2026, The Open MPI Community. Go forth and duplicate responsibly. π¦β¨π
π¦ where this page comes from
- ubuntu stonking: openmpi-doc 5.0.10-6 Β· other
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash on : a language model's rewrite of the original, under its terms