MPI_Exscan_init(3)

πŸ’– MPI_Exscan_init(3) β€” the MPI manual, but make it slay πŸ’–

okay bestie, welcome to the MPI manual page for MPI_Exscan_init, and yes we're doing this whole thing together, hand in hand, no cap 🫢

So what's the vibe? MPI_Exscan_init Creates a persistent request for exscan. That's the whole NAME section energy right there. Short, sweet, iconic ✨


✨ SYNOPSIS ✨

Like, here's the literal shape of the function calls, copied character for character because I would NEVER mess with your code πŸŽ€

int MPI_Exscan_init(const void *sendbuf, void *recvbuf, int count,
MPI_Datatype datatype, MPI_Op op, MPI_Comm comm,
MPI_Info info, MPI_Request *request)
int MPI_Exscan_init_c(const void *sendbuf, void *recvbuf, MPI_Count count,
MPI_Datatype datatype, MPI_Op op, MPI_Comm comm,
MPI_Info info, MPI_Request *request)

🌸 INPUT PARAMETERS 🌸

the stuff you hand over to it πŸ’…

  • sendbuf β€” starting address of send buffer (choice). where your data starts its journey, bestie
  • count β€” number of elements in input buffer (non-negative integer). lowkey important that it's non-negative, just saying πŸ™ˆ
  • datatype β€” data type of elements of input buffer (handle)
  • op β€” operation (handle)
  • comm β€” intra-communicator (handle)
  • info β€” info argument (handle)

πŸ’œ OUTPUT PARAMETERS πŸ’œ

the stuff it hands back to you πŸ‘‘

  • recvbuf β€” starting address of receive buffer (choice)
  • request β€” communication request (handle)

🧡 THREAD AND INTERRUPT SAFETY 🧡

okay so this one is thread-safe, which means: this routine may be safely used by multiple threads without the need for any user-provided thread locks. slay πŸ’…

BUT β€” and this is the plot twist 😭 β€” the routine is not interrupt safe. Typically, this is due to the use of memory allocation routines such as malloc or other non-MPICH runtime routines that are themselves not interrupt-safe.

so like. threads? yes. interrupts? absolutely not the moment, babe πŸ’€

πŸŽ€ NOTES FOR FORTRAN πŸŽ€

Fortran girlies, this part is for you 🫢

All MPI routines in Fortran (except for MPI_WTIME and MPI_WTICK) have an additional argument ierr at the end of the argument list. ierr is an integer and has the same meaning as the return value of the routine in C. In Fortran, MPI routines are subroutines, and are invoked with the call statement.

All MPI objects (e.g., MPI_Datatype, MPI_Comm) are of type INTEGER in Fortran.


⚠️ ERRORS ⚠️

bestie. listen. All MPI routines (except MPI_Wtime and MPI_Wtick) return an error value; C routines as the value of the function and Fortran routines in the last argument. Before the value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job. (yes, fr fr, it just ends everything 😭)

The error handler may 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. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error; however, MPI implementations will attempt to continue whenever possible.

and now, the error code menu πŸ“:

  • MPI_SUCCESS β€” No error; MPI routine completed successfully. the dream ✨
  • MPI_ERR_ARG β€” Invalid argument. Some argument is invalid and is not identified by a specific error class (e.g., MPI_ERR_RANK).
  • MPI_ERR_BUFFER β€” Invalid buffer pointer. Usually a null buffer where one is not valid.
  • MPI_ERR_COMM β€” Invalid communicator. A common error is to use a null communicator in a call (not even allowed in MPI_Comm_rank).
  • MPI_ERR_COUNT β€” Invalid count argument. Count arguments must be non-negative; a count of zero is often valid.
  • MPI_ERR_INFO β€” Invalid Info
  • MPI_ERR_OP β€” Invalid operation. MPI operations (objects of type MPI_Op) must either be one of the predefined operations (e.g., MPI_SUM) or created with MPI_Op_create.
  • MPI_ERR_TYPE β€” Invalid datatype argument. Additionally, this error can occur if an uncommitted MPI_Datatype (see MPI_Type_commit) is used in a communication call.
  • MPI_ERR_OTHER β€” Other error; use MPI_Error_string to get more information about this error code.

and that's the whole page, bestie, you ate it πŸ½οΈπŸ’…

this little masterpiece is from the MPI manual, MPI_Exscan_init(3), dated 4/10/2026 β€” so when you're out here scanning exclusively, remember who taught you 🫢✨ go be the main character of your communicator πŸ¦‹πŸ‘‘

πŸ“¦ where this page comes from