The new functions for caching on datatypes are:
| MPI_TYPE_CREATE_KEYVAL(type_copy_attr_fn, type_delete_attr_fn, type_keyval, extra_state) | |
| IN type_copy_attr_fn | copy callback function for type_keyval (function) |
| IN type_delete_attr_fn | delete callback function for type_keyval (function) |
| OUT type_keyval | key value for future access (integer) |
| IN extra_state | extra state for callback function |
The argument type_copy_attr_fn may be specified as MPI_TYPE_NULL_COPY_FN or MPI_TYPE_DUP_FN from either C or Fortran. MPI_TYPE_NULL_COPY_FN is a function that does nothing other than returning flag = 0 and MPI_SUCCESS. MPI_TYPE_DUP_FN is a simple copy function that sets flag = 1, returns the value of attribute_val_in in attribute_val_out, and returns MPI_SUCCESS.
The argument type_delete_attr_fn may be specified as MPI_TYPE_NULL_DELETE_FN from either C or Fortran. MPI_TYPE_NULL_DELETE_FN is a function that does nothing, other than returning MPI_SUCCESS.
The C callback functions are:
typedef int MPI_Type_copy_attr_function(MPI_Datatype oldtype, int type_keyval, void *extra_state, void *attribute_val_in, void *attribute_val_out, int *flag);
and
typedef int MPI_Type_delete_attr_function(MPI_Datatype datatype, int type_keyval, void *attribute_val, void *extra_state);
With the mpi_f08 module, the Fortran callback functions are:
ABSTRACT INTERFACE
SUBROUTINE MPI_Type_copy_attr_function(oldtype, type_keyval, extra_state, attribute_val_in, attribute_val_out, flag, ierror)
TYPE(MPI_Datatype) :: oldtype
INTEGER :: type_keyval, ierror
INTEGER(KIND=MPI_ADDRESS_KIND) :: extra_state, attribute_val_in, attribute_val_out
LOGICAL :: flag
and
ABSTRACT INTERFACE
SUBROUTINE MPI_Type_delete_attr_function(datatype, type_keyval, attribute_val, extra_state, ierror)
TYPE(MPI_Datatype) :: datatype
INTEGER :: type_keyval, ierror
INTEGER(KIND=MPI_ADDRESS_KIND) :: attribute_val, extra_state
With the mpi module and (deprecated) mpif.h include file, the Fortran callback functions are:
SUBROUTINE TYPE_COPY_ATTR_FUNCTION(OLDTYPE, TYPE_KEYVAL, EXTRA_STATE, ATTRIBUTE_VAL_IN, ATTRIBUTE_VAL_OUT, FLAG, IERROR)
INTEGER OLDTYPE, TYPE_KEYVAL, IERROR
INTEGER(KIND=MPI_ADDRESS_KIND) EXTRA_STATE, ATTRIBUTE_VAL_IN, ATTRIBUTE_VAL_OUT
LOGICAL FLAG
and
SUBROUTINE TYPE_DELETE_ATTR_FUNCTION(DATATYPE, TYPE_KEYVAL, ATTRIBUTE_VAL, EXTRA_STATE, IERROR)
INTEGER DATATYPE, TYPE_KEYVAL, IERROR
INTEGER(KIND=MPI_ADDRESS_KIND) ATTRIBUTE_VAL, EXTRA_STATE
If an attribute copy function or attribute delete function returns other than MPI_SUCCESS, then the call that caused it to be invoked (for example, MPI_TYPE_FREE), is erroneous.
| MPI_TYPE_FREE_KEYVAL(type_keyval) | |
| INOUT type_keyval | key value (integer) |
| MPI_TYPE_SET_ATTR(datatype, type_keyval, attribute_val) | |
| INOUT datatype | datatype to which attribute will be attached (handle) |
| IN type_keyval | key value (integer) |
| IN attribute_val | attribute value |
| MPI_TYPE_GET_ATTR(datatype, type_keyval, attribute_val, flag) | |
| IN datatype | datatype to which the attribute is attached (handle) |
| IN type_keyval | key value (integer) |
| OUT attribute_val | attribute value, unless flag = false |
| OUT flag | false if no attribute is associated with the key (logical) |
| MPI_TYPE_DELETE_ATTR(datatype, type_keyval) | |
| INOUT datatype | datatype from which the attribute is deleted (handle) |
| IN type_keyval | key value (integer) |