MPI_Comm_set_attr(3) MPI MPI_Comm_set_attr(3) NAME MPI_Comm_set_attr - Stores attribute value associated with a key SYNOPSIS int MPI_Comm_set_attr(MPI_Comm comm, int comm_keyval, void *attribute_val) INPUT PARAMETERS comm - communicator to which attribute will be attached (handle) comm_keyval - key value (integer) attribute_val - attribute value (None) 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 an address-sized integer. 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. 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 inte- ger 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 state- ment. 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 ar- gument. Before the value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job. The error han- dler may be changed with MPI_Comm_set_errhandler (for communicators), 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 predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned. Note that MPI does not guarantee 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 communica- tor in a call (not even allowed in MPI_Comm_rank ). MPI_ERR_KEYVAL - Invalid keyval MPI_ERR_OTHER - Other error; use MPI_Error_string to get more information about this error code. SEE ALSO MPI_Comm_create_keyval, MPI_Comm_delete_attr 4/10/2026 MPI_Comm_set_attr(3)
NAME | SYNOPSIS | INPUT PARAMETERS | NOTES | THREAD AND INTERRUPT SAFETY | NOTES FOR FORTRAN | ERRORS | SEE ALSO
Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=MPI_Comm_set_attr&sektion=3&manpath=FreeBSD+Ports+15.1.quarterly>