MPI_Ialltoallv(3)

πŸ“¦
version 5.0.1 Β· 5 versions
, in nixos 26.05, ubuntu stonking

πŸ’– MPI_Ialltoallv β€” the manual page (MPI, section 3) πŸ’–

okay bestie, gather round, because this one is a bop. We're in the MPI manual, section 3, and this page is all about MPI_Ialltoallv. Periodt. ✨


🌈 NAME 🌈

MPI_Ialltoallv β€” sends data from all to all processes in a nonblocking way; each process may send a different amount of data and provide displacements for the input and output data.

no cap, that's the whole vibe: everyone talks to everyone, nobody waits around, and every process gets to be a lil different from the others. main character energy fr fr. πŸ‘‘


✨ SYNOPSIS ✨

int MPI_Ialltoallv(const void *sendbuf, const int sendcounts[],
const int sdispls[], MPI_Datatype sendtype, void *recvbuf,
const int recvcounts[], const int rdispls[],
MPI_Datatype recvtype, MPI_Comm comm, MPI_Request *request)

int MPI_Ialltoallv_c(const void *sendbuf, const MPI_Count sendcounts[],
const MPI_Aint sdispls[], MPI_Datatype sendtype,
void *recvbuf, const MPI_Count recvcounts[],
const MPI_Aint rdispls[], MPI_Datatype recvtype,
MPI_Comm comm, MPI_Request *request)

two flavors, both iconic: the classic one with int counts and the _c one that levels up to MPI_Count and MPI_Aint for when your numbers are just built different. πŸ’…


πŸŽ€ INPUT PARAMETERS πŸŽ€

  • sendbuf β€” starting address of send buffer (choice). it's giving "where my stuff lives".
  • sendcounts β€” non-negative integer array (of length group size) specifying the number of elements to send to each rank (non-negative integer). literally one entry per bestie you're sending to.
  • sdispls β€” integer array (of length group size). Entry j specifies the displacement (relative to sendbuf) from which to take the outgoing data destined for process j (integer). so entry j = where to scoop from when you're packing for rank j. 🎁
  • sendtype β€” data type of send buffer elements (handle).
  • recvcounts β€” non-negative integer array (of length group size) specifying the number of elements that can be received from each rank (non-negative integer). can be received, bestie β€” it's a capacity, not a promise.
  • rdispls β€” integer array (of length group size). Entry i specifies the displacement (relative to recvbuf) at which to place the incoming data from process i (integer). entry i = the lil spot on the shelf reserved for rank i's package. πŸ“¦
  • recvtype β€” data type of receive buffer elements (handle).
  • comm β€” communicator (handle). the group chat itself. 🫢

πŸ’œ OUTPUT PARAMETERS πŸ’œ

  • recvbuf β€” address of receive buffer (choice).
  • request β€” communication request (handle). hang onto this one, because nonblocking means you have to come back for it later. it's your receipt. 🧾

🌸 THREAD AND INTERRUPT SAFETY 🌸

This routine is thread-safe. which means multiple threads can use it at the same time and you do not need to bring your own thread locks. she's self-sufficient. slay. πŸ’…

However, 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… thread-safe βœ…, interrupt-safe ❌. don't get it twisted bestie, those are two different things and one of them will absolutely humble you. 😭

πŸ¦‹ NOTES FOR FORTRAN πŸ¦‹

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.

so if you're in Fortran: extra ierr at the end, everything is a subroutine, call it, and all the fancy objects are just INTEGER. no cap, that's the whole translation. ✨

🌈 ERRORS 🌈

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

⚠️ real talk: the default handler kills the whole job. if you'd rather get an error code back and deal with it yourself, that's what MPI_ERRORS_RETURN is for. and yeah, MPI_Errhandler_set still exists but it's deprecated β€” we don't use deprecated things in this house, use the modern setters. πŸ’…

the error codes, one by one, no skips:

  • MPI_SUCCESS β€” No error; MPI routine completed successfully. πŸŽ‰
  • 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_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. every flag, every handle, every error code β€” nothing left behind. obsessed with her honestly. πŸ’–

🌸✨ signed off on 4/10/2026 β€” this was the MPI_Ialltoallv(3) page from the MPI manual. go forth and alltoallv, queen. πŸ‘‘πŸ¦‹

πŸ“¦ where this page comes from