MPI_COMM_CALL_ERRHANDLER(3)

MPI_Comm_call_errhandler 💅 — the Open MPI manual page for MPI_COMM_CALL_ERRHANDLER(3)

okay so bestie, welcome to the group chat for MPI_Comm_call_errhandler. this is the Open MPI page where we pass an error code straight to the error handler assigned to a communicator. no cap, that's the whole plot.

---

✨ NAME ✨

MPI_Comm_call_errhandler — Passes the supplied error code to the error handler assigned to a communicator.

---

🦋 SYNTAX 🦋

C Syntax

#include <mpi.h>

int MPI_Comm_call_errhandler(MPI_Comm comm, int errorcode)

Fortran Syntax

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

MPI_COMM_CALL_ERRHANDLER(COMM, ERRORCODE, IERROR)
    INTEGER COMM, ERRORCODE, IERROR

Fortran 2008 Syntax

USE mpi_f08

MPI_Comm_call_errhandler(comm, errorcode, ierror)
    TYPE(MPI_Comm), INTENT(IN) :: comm
    INTEGER, INTENT(IN) :: errorcode
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

---

🎀 INPUT PARAMETER 🎀

• comm — communicator with error handler (handle). it's giving "the communicator we're handing the error code to" energy.
• errorcode — error code (integer). the actual integer error code you're serving up.

---

💖 OUTPUT PARAMETERS 💖

• ierror — Fortran only: Error status (integer).

---

🌸 DESCRIPTION 🌸

so here's the tea: this function invokes the error handler assigned to the communicator comm with the supplied error code errorcode. if the error handler was successfully called, the process is not aborted, and the error handler returns, then this function returns MPI_SUCCESS. periodt.

---

💅 NOTES 💅

bestie, read this twice: users should note that the default error handler is MPI_ERRORS_ARE_FATAL. thus, calling this function will abort the processes in comm if the default error handler has not been changed. 💀

---

🔥 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. fr fr, that's just how it is.

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. 😭 iconic but terrifying.
• 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. the "hand it back to you" option.

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. highkey important.

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 🌈

• MPI_Comm_create_errhandler

---

👑 COPYRIGHT 👑

2003-2026, The Open MPI Community

xoxo, your Open MPI bestie 💖 — source/version: Open MPI; footer date: Sep 11, 2026; manual: MPI_COMM_CALL_ERRHANDLER(3); copyright: 2003-2026, The Open MPI Community. slay. 🫶