MPIX_Delete_error_code(3)

💖 MPIX_Delete_error_code 💖

okay bestie, welcome to the MPIX_Delete_error_code(3) page — MPI edition, obviously. this is the little glow-up routine that lets you yeet an error code you made earlier. it's giving cleanup era. ✨

---

🌸 NAME 🌸

MPIX_Delete_error_code — Delete an MPI error code 🗑️✨

---

🎀 SYNOPSIS 🎀

int MPIX_Delete_error_code(int errorcode)

---

🦋 INPUT PARAMETERS 🦋

• errorcode — the value of the error code to be remoed (integer). yes bestie, "remoed" — that's literally what the original says, we do not gatekeep typos here 💅. anyway: it's the error code you want gone.

---

💅 THREAD AND INTERRUPT SAFETY 💅

this routine is thread-safe. that means multiple threads can use it at the same time and you do not need to bring your own thread locks. no user-provided locking, none, zero, we're self-sufficient. 🫶

but — and this is the part where you gotta listen — it is not interrupt safe. 😭 typically that's because it uses memory allocation routines like malloc, or other non-MPICH runtime routines, and those are themselves not interrupt-safe. so like, don't interrupt it mid-glow-up. periodt.

---

✨ NOTES FOR FORTRAN ✨

so, all MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK) have an extra argument called ierr at the end of the argument list. ierr is an integer and it means the exact same thing as the return value of the routine in C. 🧠

also, in Fortran, MPI routines are subroutines, and you invoke them with the call statement. very demure, very Fortran.

and — important — all MPI objects (e.g., MPI_Datatype, MPI_Comm) are of type INTEGER in Fortran. no cap. 🌈

---

💀 ERRORS 💀

all MPI routines (except MPI_Wtime and MPI_Wtick) return an error value. C routines give it back as the value of the function, and Fortran routines give it back in that last argument. before that value comes back to you, the current MPI error handler gets called. 👀

by default, that error handler aborts the MPI job. like, whole thing, gone. 😭

the error handler can 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 — old news, bestie. the predefined error handler MPI_ERRORS_RETURN may be used to make error values actually get returned instead. 🫶

and note: MPI does not guarantee that an MPI program can continue past an error. however, MPI implementations will attempt to continue whenever possible. so like, they try. they really do. 🙈

• MPI_SUCCESS — no error; the MPI routine completed successfully. slay. ✅
• MPI_ERR_OTHER — other error; use MPI_Error_string to get more info about this error code. go read the receipts. 🔍

---

and that's the whole page, bestie!! 🌟 this was MPIX_Delete_error_code(3) from the MPI manual, dated 2/22/2022. mwah, take care of those error codes, drink water, and go delete something responsibly. 💖🎀🦋👑