|
Packit Service |
c5cf8c |
.TH MPI_Attr_put 3 "11/12/2019" " " "MPI"
|
|
Packit Service |
c5cf8c |
.SH NAME
|
|
Packit Service |
c5cf8c |
MPI_Attr_put \- Stores attribute value associated with a key
|
|
Packit Service |
c5cf8c |
.SH SYNOPSIS
|
|
Packit Service |
c5cf8c |
.nf
|
|
Packit Service |
c5cf8c |
int MPI_Attr_put(MPI_Comm comm, int keyval, void *attribute_val)
|
|
Packit Service |
c5cf8c |
.fi
|
|
Packit Service |
c5cf8c |
.SH INPUT PARAMETERS
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B comm
|
|
Packit Service |
c5cf8c |
- communicator to which attribute will be attached (handle)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B keyval
|
|
Packit Service |
c5cf8c |
- key value, as returned by
|
|
Packit Service |
c5cf8c |
.I MPI_KEYVAL_CREATE
|
|
Packit Service |
c5cf8c |
(integer)
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B attribute_val
|
|
Packit Service |
c5cf8c |
- attribute value
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH NOTES
|
|
Packit Service |
c5cf8c |
Values of the permanent attributes
|
|
Packit Service |
c5cf8c |
.I MPI_TAG_UB
|
|
Packit Service |
c5cf8c |
,
|
|
Packit Service |
c5cf8c |
.I MPI_HOST
|
|
Packit Service |
c5cf8c |
,
|
|
Packit Service |
c5cf8c |
.I MPI_IO
|
|
Packit Service |
c5cf8c |
,
|
|
Packit Service |
c5cf8c |
.I MPI_WTIME_IS_GLOBAL
|
|
Packit Service |
c5cf8c |
,
|
|
Packit Service |
c5cf8c |
.I MPI_UNIVERSE_SIZE
|
|
Packit Service |
c5cf8c |
,
|
|
Packit Service |
c5cf8c |
.I MPI_LASTUSEDCODE
|
|
Packit Service |
c5cf8c |
, and
|
|
Packit Service |
c5cf8c |
.I MPI_APPNUM
|
|
Packit Service |
c5cf8c |
may not be changed.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
The type of the attribute value depends on whether C, C++, or Fortran
|
|
Packit Service |
c5cf8c |
is being used.
|
|
Packit Service |
c5cf8c |
In C and C++, an attribute value is a pointer (
|
|
Packit Service |
c5cf8c |
.I void *
|
|
Packit Service |
c5cf8c |
); in Fortran,
|
|
Packit Service |
c5cf8c |
it is a single
|
|
Packit Service |
c5cf8c |
integer (
|
|
Packit Service |
c5cf8c |
.B not
|
|
Packit Service |
c5cf8c |
a pointer, since Fortran has no pointers and there are systems
|
|
Packit Service |
c5cf8c |
for which a pointer does not fit in an integer (e.g., any > 32 bit address
|
|
Packit Service |
c5cf8c |
system that uses 64 bits for Fortran
|
|
Packit Service |
c5cf8c |
.I DOUBLE PRECISION
|
|
Packit Service |
c5cf8c |
).
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
If an attribute is already present, the delete function (specified when the
|
|
Packit Service |
c5cf8c |
corresponding keyval was created) will be called.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH THREAD AND INTERRUPT SAFETY
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
This routine is thread-safe. This means that this routine may be
|
|
Packit Service |
c5cf8c |
safely used by multiple threads without the need for any user-provided
|
|
Packit Service |
c5cf8c |
thread locks. However, the routine is not interrupt safe. Typically,
|
|
Packit Service |
c5cf8c |
this is due to the use of memory allocation routines such as
|
|
Packit Service |
c5cf8c |
.I malloc
|
|
Packit Service |
c5cf8c |
or other non-MPICH runtime routines that are themselves not interrupt-safe.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH DEPRECATED FUNCTION
|
|
Packit Service |
c5cf8c |
The MPI-2 standard deprecated a number of routines because MPI-2 provides
|
|
Packit Service |
c5cf8c |
better versions. This routine is one of those that was deprecated. The
|
|
Packit Service |
c5cf8c |
routine may continue to be used, but new code should use the replacement
|
|
Packit Service |
c5cf8c |
routine.
|
|
Packit Service |
c5cf8c |
The replacement for this routine is
|
|
Packit Service |
c5cf8c |
.I MPI_Comm_set_attr
|
|
Packit Service |
c5cf8c |
\&.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH NOTES FOR FORTRAN
|
|
Packit Service |
c5cf8c |
All MPI routines in Fortran (except for
|
|
Packit Service |
c5cf8c |
.I MPI_WTIME
|
|
Packit Service |
c5cf8c |
and
|
|
Packit Service |
c5cf8c |
.I MPI_WTICK
|
|
Packit Service |
c5cf8c |
) have
|
|
Packit Service |
c5cf8c |
an additional argument
|
|
Packit Service |
c5cf8c |
.I ierr
|
|
Packit Service |
c5cf8c |
at the end of the argument list.
|
|
Packit Service |
c5cf8c |
.I ierr
|
|
Packit Service |
c5cf8c |
is an integer and has the same meaning as the return value of the routine
|
|
Packit Service |
c5cf8c |
in C. In Fortran, MPI routines are subroutines, and are invoked with the
|
|
Packit Service |
c5cf8c |
.I call
|
|
Packit Service |
c5cf8c |
statement.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
All MPI objects (e.g.,
|
|
Packit Service |
c5cf8c |
.I MPI_Datatype
|
|
Packit Service |
c5cf8c |
,
|
|
Packit Service |
c5cf8c |
.I MPI_Comm
|
|
Packit Service |
c5cf8c |
) are of type
|
|
Packit Service |
c5cf8c |
.I INTEGER
|
|
Packit Service |
c5cf8c |
in Fortran.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH ERRORS
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
All MPI routines (except
|
|
Packit Service |
c5cf8c |
.I MPI_Wtime
|
|
Packit Service |
c5cf8c |
and
|
|
Packit Service |
c5cf8c |
.I MPI_Wtick
|
|
Packit Service |
c5cf8c |
) return an error value;
|
|
Packit Service |
c5cf8c |
C routines as the value of the function and Fortran routines in the last
|
|
Packit Service |
c5cf8c |
argument. Before the value is returned, the current MPI error handler is
|
|
Packit Service |
c5cf8c |
called. By default, this error handler aborts the MPI job. The error handler
|
|
Packit Service |
c5cf8c |
may be changed with
|
|
Packit Service |
c5cf8c |
.I MPI_Comm_set_errhandler
|
|
Packit Service |
c5cf8c |
(for communicators),
|
|
Packit Service |
c5cf8c |
.I MPI_File_set_errhandler
|
|
Packit Service |
c5cf8c |
(for files), and
|
|
Packit Service |
c5cf8c |
.I MPI_Win_set_errhandler
|
|
Packit Service |
c5cf8c |
(for
|
|
Packit Service |
c5cf8c |
RMA windows). The MPI-1 routine
|
|
Packit Service |
c5cf8c |
.I MPI_Errhandler_set
|
|
Packit Service |
c5cf8c |
may be used but
|
|
Packit Service |
c5cf8c |
its use is deprecated. The predefined error handler
|
|
Packit Service |
c5cf8c |
.I MPI_ERRORS_RETURN
|
|
Packit Service |
c5cf8c |
may be used to cause error values to be returned.
|
|
Packit Service |
c5cf8c |
Note that MPI does
|
|
Packit Service |
c5cf8c |
.B not
|
|
Packit Service |
c5cf8c |
guarentee that an MPI program can continue past
|
|
Packit Service |
c5cf8c |
an error; however, MPI implementations will attempt to continue whenever
|
|
Packit Service |
c5cf8c |
possible.
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B MPI_SUCCESS
|
|
Packit Service |
c5cf8c |
- No error; MPI routine completed successfully.
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B MPI_ERR_COMM
|
|
Packit Service |
c5cf8c |
- Invalid communicator. A common error is to use a null
|
|
Packit Service |
c5cf8c |
communicator in a call (not even allowed in
|
|
Packit Service |
c5cf8c |
.I MPI_Comm_rank
|
|
Packit Service |
c5cf8c |
).
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B MPI_ERR_KEYVAL
|
|
Packit Service |
c5cf8c |
- Invalid keyval
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
.PD 0
|
|
Packit Service |
c5cf8c |
.TP
|
|
Packit Service |
c5cf8c |
.B MPI_ERR_ARG
|
|
Packit Service |
c5cf8c |
- This error class is associated with an error code that
|
|
Packit Service |
c5cf8c |
indicates that an attempt was made to free one of the permanent keys.
|
|
Packit Service |
c5cf8c |
.PD 1
|
|
Packit Service |
c5cf8c |
|
|
Packit Service |
c5cf8c |
.SH SEE ALSO
|
|
Packit Service |
c5cf8c |
MPI_Attr_get, MPI_Keyval_create, MPI_Attr_delete, MPI_Comm_set_attr
|
|
Packit Service |
c5cf8c |
.br
|