MPI_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, MPI_LASTUSEDCODE, and MPI_APPNUM
may not be changed.
The type of the attribute value depends on whether C or Fortran is being used.
In 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.
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_Errhandler_set; the predefined 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.
- MPI_SUCCESS
- No error; MPI routine completed successfully.
- MPI_ERR_COMM
- Invalid communicator. A common error is to use a null
communicator in a call (not even allowed in MPI_Comm_rank).
- MPI_ERR_OTHER
- Other error; the error code associated with this error
indicates an attempt to use an invalue keyval.
- MPI_ERR_ARG
- This error class is associated with an error code that
indicates that an attempt was made to free one of the permanent keys.
See Also
MPI_Attr_get, MPI_Keyval_create, MPI_Attr_delete
Location:attr_put.c