MPI_Attr_put(3) MPI MPI_Attr_put(3)NAMEMPI_Attr_put - Stores attribute value associated with a key
SYNOPSIS
int MPI_Attr_put(MPI_Comm comm, int keyval, void *attr_value)
INPUT PARAMETERS
comm - communicator to which attribute will be attached (handle)
keyval - key value, as returned by MPI_KEYVAL_CREATE (integer)
attribute_val
- attribute value
NOTES
Values of the permanent attributes MPI_TAG_UB , MPI_HOST , MPI_IO ,
MPI_WTIME_IS_GLOBAL , MPI_UNIVERSE_SIZE , MPI_LASTUSEDCODE , and
MPI_APPNUM may not be changed.
The type of the attribute value depends on whether C, C++, or Fortran
is being used. In C and C++, an attribute value is a pointer ( void *
); in Fortran, it is a single integer ( not a pointer, since Fortran
has no pointers and there are systems for which a pointer does not fit
in an integer (e.g., any > 32 bit address system that uses 64 bits for
Fortran DOUBLE PRECISION ).
If an attribute is already present, the delete function (specified when
the corresponding keyval was created) will be called.
THREAD AND INTERRUPT SAFETY
This routine is thread-safe. This means that this routine may be
safely used by multiple threads without the need for any user-provided
thread locks. 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.
DEPRECATED FUNCTION
The MPI-2 standard deprecated a number of routines because MPI-2 pro‐
vides better versions. This routine is one of those that was depre‐
cated. The routine may continue to be used, but new code should use
the replacement routine. The replacement for this routine is
MPI_Comm_set_attr .
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.
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 com‐
municators), 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 prede‐
fined error handler MPI_ERRORS_RETURN may be used to cause error values
to be returned. Note that MPI does not guarentee that an MPI program
can continue past an error; however, MPI implementations will attempt
to continue whenever possible.
MPI_SUCCESS
- No error; MPI routine completed successfully.
MPI_ERR_COMM
- Invalid communicator. A common error is to use a null commu‐
nicator in a call (not even allowed in MPI_Comm_rank ).
MPI_ERR_KEYVAL
- Invalid keyval
MPI_ERR_ARG
- This error class is associated with an error code that indi‐
cates that an attempt was made to free one of the permanent
keys.
SEE ALSO
MPI_Attr_get, MPI_Keyval_create, MPI_Attr_delete, MPI_Comm_set_attr
LOCATION
src/mpi/attr/attr_put.c
9/20/2012 MPI_Attr_put(3)
