MPIX_COMM_GET_FAILED(3)

MPIX_Comm_get_failed πŸ’…βœ¨

omg hi bestie, welcome to Open MPI's MPIX_COMM_GET_FAILED(3) page. this one is lowkey about fault tolerance and it's giving main character energy. 🫢

🌸 NAME 🌸

MPIX_Comm_get_failed β€” obtain a group that lists failed processes in a communicator. This is part of the User Level Fault Mitigation ULFM extension. no cap, that's the whole assignment. πŸ’–

✨ SYNTAX ✨

C Syntax πŸ’»

#include <mpi.h>
#include <mpi-ext.h>

int MPIX_Comm_get_failed(MPI_Comm comm, MPI_Group *failedgrp)

Fortran Syntax 🧑

USE MPI
USE MPI_EXT
! or the older form: INCLUDE 'mpif.h'

MPIX_COMM_GET_FAILED(COMM, FAILEDGRP, IERROR)
     INTEGER COMM, FAILEDGRP, IERROR

Fortran 2008 Syntax 🧊

USE mpi_f08
USE mpi_ext_f08

MPIX_Comm_get_failed(comm, failedgrp, ierror)
     TYPE(MPI_Comm), INTENT(IN) :: comm
     TYPE(MPI_Group), INTENT(OUT) :: failedgrp
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

πŸŽ€ INPUT PARAMETERS πŸŽ€

  • comm β€” communicator (handle). this is the friend group you're checking on. πŸ‘―β€β™€οΈ

πŸ¦‹ OUTPUT PARAMETERS πŸ¦‹

  • failedgrp β€” group (handle). it's where the failed-process group lands. 🫢
  • ierror β€” Fortran only: error status (integer). πŸ’…

πŸ’– DESCRIPTION πŸ’–

vibe check: ngl, this is a local operation. It returns the group failedgrp of processes from the communicator comm that are locally known to have failed. The failedgrp can be empty β€” literally equal to MPI_GROUP_EMPTY. 🫠

Now the rank-consistency bit, because it matters: for any two groups obtained from calls to this routine at the same MPI process, with the same comm, the intersection of the largest group with the smallest group is MPI_IDENT to the smallest group. Translation: the same processes have the same ranks in the two groups, up to the size of the smallest group. the way that works? iykyk, ranks stay matching. πŸ”₯

πŸ’€ PROCESS FAILURES πŸ’€

MPI makes no assumption about asynchronous progress of the failure detection. A valid MPI implementation may choose to update the group of locally known failed MPI processes only when it enters a function that must raise a fault tolerance error. so don't expect instant updates, bestie. 😭

It is possible that only the calling MPI process has detected the reported failure. If global knowledge is necessary, MPI processes detecting failures should call MPIX_Comm_revoke to enforce an error at other ranks. that's the group-chat broadcast of fault tolerance, fr fr. πŸ“£

🌈 WHEN COMMUNICATOR IS AN INTER-COMMUNICATOR 🌈

When the communicator is an inter-communicator, the value of failedgrp contains the members known to have failed in both the local and the remote groups of comm. both sides, 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. πŸ’…

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. okay that was a mouthful, but we got there. ✨

Open MPI includes three predefined error handlers that can be used:

  • MPI_ERRORS_ARE_FATAL β€” causes the program to abort all connected MPI processes. dramatic? yes. necessary? also yes. πŸ’€
  • 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. simple, iconic. πŸŽ€

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. not me being ominous about it, that's just the spec. πŸ™ˆ

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_revoke
  • MPIX_Comm_ack_failed

2003-2026, The Open MPI Community


okay bestie, that's the whole vibe. this was Open MPI's MPIX_COMM_GET_FAILED(3) page, dated May 14, 2026. go forth and handle those failed processes with main character energy. slay πŸ’…βœ¨ periodt.

πŸ“¦ where this page comes from