--- name: "MPIX_Comm_agree.openmpi" section: "3" platform: "linux" package: "openmpi-doc" version: "5.0.7-1" release: "Debian 13 (Trixie)" platforms: ["linux"] url: "https://new.carta.tech/MPIX_Comm_agree.openmpi" --- # MPIX\_Comm\_agree.openmpi(3) *MPIX\_Comm\_agree*, *MPIX\_Comm\_iagree* - Agree on a flag value from all live processes and distributes the result back to all live processes, even after process failures. This is part of the User Level Fault Mitigation *ULFM extension*. ## SYNTAX ### C Syntax ``` #include #include int MPIX_Comm_agree(MPI_Comm comm, int *flag) int MPIX_Comm_iagree(MPI_Comm comm, int *flag, MPI_Request *request) ``` ### Fortran Syntax ``` USE MPI USE MPI_EXT ! or the older form: INCLUDE 'mpif.h' MPIX_COMM_AGREE(COMM, FLAG, IERROR) INTEGER COMM, FLAG, IERROR MPIX_COMM_IAGREE(COMM, FLAG, REQUEST, IERROR) INTEGER COMM, FLAG, REQUEST, IERROR ``` ### Fortran 2008 Syntax ``` USE mpi_f08 USE mpi_ext_f08 MPIX_Comm_agree(comm, flag, ierror) TYPE(MPI_Comm), INTENT(IN) :: comm INTEGER, INTENT(INOUT) :: flag INTEGER, OPTIONAL, INTENT(OUT) :: ierror MPIX_COMM_IAGREE(COMM, FLAG, REQUEST, IERROR) TYPE(MPI_Comm), INTENT(IN) :: comm INTEGER, INTENT(INOUT), ASYNCHRONOUS :: flag TYPE(MPI_Request), INTENT(OUT) :: request INTEGER, OPTIONAL, INTENT(OUT) :: ierror ``` ## INPUT PARAMETERS - • **comm**: Communicator (handle). - • **flag**: Binary flags (integer). ## OUTPUT PARAMETERS - • **flag**: Reduced binary flags (integer). - • **request**: Request (handle, non-blocking only). - • **ierror**: Fortran only: Error status (integer). ## DESCRIPTION This collective communication agrees on the integer value *flag* and (implicitly) on the group of failed processes in *comm*. On completion, all non-failed MPI processes have agreed to set the output integer value of *flag* to the result of a *bitwise AND* operation over the contributed input values of *flag*. *MPIX\_Comm\_iagree* is the non-blocking variant of *MPIX\_Comm\_agree*. ## PROCESS FAILURES When an MPI process fails before contributing to the agree operation, the *flag* is computed ignoring its contribution, and the operation raises an error of class MPIX\_ERR\_PROC\_FAILED. When an error of class MPIX\_ERR\_PROC\_FAILED is raised, it is consistently raised at all MPI processes in the group(s) of *comm*. After *MPIX\_Comm\_agree* raised an error of class MPIX\_ERR\_PROC\_FAILED, the group produced by a subsequent call to *MPIX\_Comm\_get\_failed* on *comm* contains every MPI process that didn’t contribute to the computation of *flag*. ## WHEN THE COMMUNICATOR CONTAINS ACKNOWLEDGED FAILURES If **all** MPI processes in the group of *comm* have acknowledged the failure of an MPI process (using *MPIX\_Comm\_ack\_failed*) prior to the call to *MPIX\_Comm\_agree* (or *MPIX\_Comm\_iagree*), the MPIX\_ERR\_PROC\_FAILED error is not raised when the output value of *flag* ignores the contribution of that failed process. Note that this is an uniform property: if a non-contributing process is found to be not-acknowledged at any live process in *comm*, all processes raise an error of class MPIX\_ERR\_PROC\_FAILED. **Example 1:** Using a combination of *MPIX\_Comm\_ack\_failed* and *MPIX\_Comm\_agree* users can propagate and synchronize the knowledge of failures across all MPI processes in *comm*. ``` Comm_get_failed_consistent(MPI_Comm c, MPI_Group * g) { int rc; int T=1; int size; int num_acked; MPI_Group gf; int ranges[3] = {0, 0, 1}; MPI_Comm_size(c, &size); do { /* this routine is not pure: calling MPI_Comm_ack_failed * affects the state of the communicator c */ MPIX_Comm_ack_failed(c, size, &num_acked); /* we simply ignore the T value in this example */ rc = MPIX_Comm_agree(c, &T); } while( rc != MPI_SUCCESS ); /* after this loop, MPIX_Comm_agree has returned MPI_SUCCESS at * all processes, so all processes have Acknowledged the same set of * failures. Let's get that set of failures in the g group. */ if( 0 == num_acked ) { *g = MPI_GROUP_EMPTY; } else { MPIX_Comm_get_failed(c, &gf); ranges[1] = num_acked - 1; MPI_Group_range_incl(gf, 1, ranges, g); MPI_Group_free(&gf); } } ``` ## WHEN THE COMMUNICATOR IS REVOKED This function never raises an error of class MPIX\_ERR\_REVOKED. The defined semantics of *MPIX\_Comm\_agree* are maintained when *comm* is revoked, or when the group of *comm* contains failed MPI processes. In particular, *MPIX\_Comm\_agree* is a collective operation, even when *comm* is revoked. ## WHEN COMMUNICATOR IS AN INTER-COMMUNICATOR When the communicator is an inter-communicator, the value of *flag* is a *bitwise AND* operation over the values contributed by the remote group. When an error of class MPIX\_ERR\_PROC\_FAILED is raised, it is consistently raised at all MPI processes in the group(s) of *comm*, that is, both the local and remote groups of the inter-communicator. ## 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. 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 if *MPI\_Abort* was called on that communicator. If called on a window or file, acts as if *MPI\_Abort* was 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\_errhandler* then *MPI\_Comm\_set\_errhandler* - • *MPI\_File\_create\_errhandler* then *MPI\_File\_set\_errhandler* - • *MPI\_Session\_create\_errhandler* then *MPI\_Session\_set\_errhandler* or at *MPI\_Session\_init* - • *MPI\_Win\_create\_errhandler* then *MPI\_Win\_set\_errhandler* Note that MPI does not guarantee that an MPI program can continue past an error. See the *MPI man page* for a full list of *MPI error codes*. See the Error Handling section of the MPI-3.1 standard for more information. **SEE ALSO:** - • *MPIX\_Comm\_is\_revoked* - • *MPIX\_Comm\_ack\_failed* ## COPYRIGHT 2003-2025, The Open MPI Community