Scroll to navigation

MPI_COMM_GET_ATTR(3) Open MPI MPI_COMM_GET_ATTR(3)

MPI_Comm_get_attr — Retrieves attribute value by key.

SYNTAX

C Syntax

#include <mpi.h>
int MPI_Comm_get_attr(MPI_Comm comm, int comm_keyval,


     void *attribute_val, int *flag)


Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_COMM_GET_ATTR(COMM, COMM_KEYVAL, ATTRIBUTE_VAL, FLAG, IERROR)


     INTEGER COMM, COMM_KEYVAL, IERROR


     INTEGER(KIND=MPI_ADDRESS_KIND) ATTRIBUTE_VAL


     LOGICAL FLAG


Fortran 2008 Syntax

USE mpi_f08
MPI_Comm_get_attr(comm, comm_keyval, attribute_val, flag, ierror)


     TYPE(MPI_Comm), INTENT(IN) :: comm


     INTEGER, INTENT(IN) :: comm_keyval


     INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(OUT) :: attribute_val


     LOGICAL, INTENT(OUT) :: flag


     INTEGER, OPTIONAL, INTENT(OUT) :: ierror


INPUT PARAMETERS

  • comm: Communicator to which the attribute is attached (handle).
  • comm_keyval: Key value (integer).

OUTPUT PARAMETER

  • attribute_val: Attribute value, unless flag = false.
  • flag: False if no attribute is associated with the key (logical).
  • ierror: Fortran only: Error status (integer).

DESCRIPTION

MPI_Comm_get_attr retrieves an attribute value by key. The call is erroneous if there is no key with value keyval. On the other hand, the call is correct if the key value exists, but no attribute is attached on comm for that key; in that case, the call returns flag = false. In particular, MPI_KEYVAL_INVALID is an erroneous key value.

This function replaces MPI_Attr_get, the use of which is deprecated. The C binding is identical. The Fortran binding differs in that attribute_val is an address-sized integer.

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.

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.

COPYRIGHT

2003-2024, The Open MPI Community

November 19, 2024