MPI_SSEND(3)

πŸ’… MPI_Ssend β€” Standard synchronous send πŸ’…

okay so bestie, this is the MPI_SSEND(3) page from the Open MPI manual, section 3 β€” yes, the synchronous-send one, and we're gonna get into it πŸ’–


✨ SYNTAX ✨

C Syntax

          #include <mpi.h>

          int MPI_Ssend(const void *buf, int count, MPI_Datatype datatype, int dest,
               int tag, MPI_Comm comm)

Fortran Syntax

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

Fortran 2008 Syntax

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

πŸŽ€ INPUT PARAMETERS πŸŽ€

  • buf β€” Initial address of send buffer (choice). This is where your data lives, bestie.
  • count β€” Number of elements in send buffer (nonnegative integer). No negative vibes allowed, fr fr.
  • datatype β€” Datatype of each send buffer element (handle).
  • dest β€” Rank of destination (integer). Like, where the message is headed.
  • tag β€” Message tag (integer). Your little label for the message.
  • comm β€” Communicator (handle). The group chat your send is happening in.

πŸ¦‹ OUTPUT PARAMETER πŸ¦‹

  • ierror β€” Fortran only: Error status (integer).

πŸ”₯ DESCRIPTION πŸ”₯

MPI_Ssend performs a synchronous-mode, blocking send. That's the whole main character energy of this function πŸ’…

See the MPI Standard for more detailed information about such sends β€” it's giving "required reading," but that's where the full tea is.


😭 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. πŸ’€
  • 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. That's a real warning, bestie β€” don't just assume your program can keep going after an error, because it might not 😭

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.


2003-2026, The Open MPI Community


xoxo, your Open MPI bestie πŸ’– β€” this page's footer tea is Open MPI, dated Sep 11, 2026, page MPI_SSEND(3). mwah 😘

πŸ“¦ where this page comes from