MPI_WIN_SET_ATTR(3)

πŸ’– MPI_Win_set_attr πŸ’–

MPI_Win_set_attr β€” sets the value of a window attribute. This is the Open MPI manual page, bestie, and we're gonna get through it together. ✨


✨ SYNTAX ✨

C Syntax πŸŽ€

          #include <mpi.h>

          int MPI_Win_set_attr(MPI_Win win, int win_keyval, void *attribute_val)

Fortran Syntax 🌸

          USE MPI
          ! or the older form: INCLUDE 'mpif.h'
          MPI_WIN_SET_ATTR(WIN, WIN_KEYVAL, ATTRIBUTE_VAL, IERROR)
               INTEGER WIN, WIN_KEYVAL, IERROR
               INTEGER(KIND=MPI_ADDRESS_KIND) ATTRIBUTE_VAL

Fortran 2008 Syntax πŸ¦‹

          USE mpi_f08
          MPI_Win_set_attr(win, win_keyval, attribute_val, ierror)
               TYPE(MPI_Win), INTENT(IN) :: win
               INTEGER, INTENT(IN) :: win_keyval
               INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(IN) :: attribute_val
               INTEGER, OPTIONAL, INTENT(OUT) :: ierror

🫢 INPUT/OUTPUT PARAMETER 🫢

  • win β€” the window to which the attribute will be attached (handle). πŸ’…

🌟 INPUT PARAMETERS 🌟

  • win_keyval β€” key value (integer).
  • attribute_val β€” attribute value.

πŸŽ€ OUTPUT PARAMETER πŸŽ€

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

πŸ’« DESCRIPTION πŸ’«

Sets the value of a window attribute. That's the whole vibe, no cap. ✨


😭 ERRORS 😭

Okay bestie, error-handling lore time β€” stay with me. πŸ’€

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

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.


The copyright line says: 2003-2026, The Open MPI Community.

bye bestie 🫢 β€” source/version: Open MPI; copyright: 2003-2026, The Open MPI Community; date: Sep 11, 2026. πŸ’–

πŸ“¦ where this page comes from