MPI_ISEND(3)

📦
version 5.0.10 · 7 versions
, in ubuntu stonking

🦋 MPI_ISEND 🦋

okay bestie, this page lives in the Open MPI manual, section 3, and it's about MPI_Isend — the one that starts a standard-mode, nonblocking send. no cap. let's get into it 💅

✨ NAME ✨

MPI_Isend — Starts a standard-mode, nonblocking send.

🎀 SYNTAX 🎀

C Syntax

#include <mpi.h>

int MPI_Isend(const void *buf, int count, MPI_Datatype datatype, int dest,
     int tag, MPI_Comm comm, MPI_Request *request)

Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_ISEND(BUF, COUNT, DATATYPE, DEST, TAG, COMM, REQUEST, IERROR)
     <type>  BUF(*)
     INTEGER COUNT, DATATYPE, DEST, TAG, COMM, REQUEST, IERROR

Fortran 2008 Syntax

USE mpi_f08
MPI_Isend(buf, count, datatype, dest, tag, comm, request, ierror)
     TYPE(*), DIMENSION(..), INTENT(IN), ASYNCHRONOUS :: buf
     INTEGER, INTENT(IN) :: count, dest, tag
     TYPE(MPI_Datatype), INTENT(IN) :: datatype
     TYPE(MPI_Comm), INTENT(IN) :: comm
     TYPE(MPI_Request), INTENT(OUT) :: request
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

💖 INPUT PARAMETERS 💖

  • buf — Initial address of send buffer (choice). it's giving "here's the goods, go get 'em" 🫶
  • count — Number of elements in send buffer (integer).
  • datatype — Datatype of each send buffer element (handle).
  • dest — Rank of destination (integer). the lucky recipient 👑
  • tag — Message tag (integer).
  • comm — Communicator (handle).

🌸 OUTPUT PARAMETERS 🌸

  • request — Communication request (handle). hold onto this one, she's your receipt 🧾✨
  • ierror — Fortran only: Error status (integer).

💫 DESCRIPTION 💫

MPI_Isend starts a standard-mode, nonblocking send. Nonblocking calls allocate a communication request object and associate it with the request handle (the argument request). The request can be used later to query the status of the communication or wait for its completion.

A nonblocking send call indicates that the system may start copying data out of the send buffer. The sender should not modify any part of the send buffer after a nonblocking send operation is called, until the send completes.

🚨 bestie do NOT touch that buffer. the system may already be copying out of it, and if you rewrite it mid-send it's giving chaos energy 😭

A send request can be determined being completed by calling the MPI_Wait, MPI_Waitany, MPI_Test, or MPI_Testany with request returned by this function.

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

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

  • MPI_ERRORS_ARE_FATAL — Causes the program to abort all connected MPI processes. she does not do second chances 💀
  • 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.

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. no promises, fr fr.

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_Send
  • MPI_Wait
  • MPI_Waitany
  • MPI_Test
  • MPI_Testany

2003-2026, The Open MPI Community

and that's the whole vibe check, bestie 🫶 this page came straight off the Open MPI version, dated Sep 10, 2026 — go forth and send nonblockingly, you absolute icon 💅🌈✨

📦 where this page comes from