17.2.390. MPI_Type_create_keyval

MPI_Type_create_keyval — 为数据类型缓存生成一个新的属性键。

17.2.390.1. 语法

17.2.390.1.1. C语法

#include <mpi.h>

int MPI_Type_create_keyval(MPI_Type_copy_attr_function *type_copy_attr_fn,
     MPI_Type_delete_attr_function *type_delete_attr_fn,
     int *type_keyval, void *extra_state)

17.2.390.1.2. Fortran语法

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_TYPE_CREATE_KEYVAL(TYPE_COPY_ATTR_FN, TYPE_DELETE_ATTR_FN,
             TYPE_KEYVAL, EXTRA_STATE, IERROR)
     EXTERNAL TYPE_COPY_ATTR_FN, TYPE_DELETE_ATTR_FN
     INTEGER TYPE_KEYVAL, IERROR
     INTEGER(KIND=MPI_ADDRESS_KIND) EXTRA_STATE

17.2.390.1.3. Fortran 2008 语法

USE mpi_f08
MPI_Type_create_keyval(type_copy_attr_fn, type_delete_attr_fn, type_keyval,
             extra_state, ierror)
     PROCEDURE(MPI_Type_copy_attr_function) :: type_copy_attr_fn
     PROCEDURE(MPI_Type_delete_attr_function) :: type_delete_attr_fn
     INTEGER, INTENT(OUT) :: type_keyval
     INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(IN) :: extra_state
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.390.2. 输入参数

  • type_copy_attr_fn: 用于type_keyval的复制回调函数（函数）。

  • type_delete_attr_fn: 用于type_keyval的删除回调函数（函数）。

  • extra_state: 回调函数的额外状态。

17.2.390.3. 输出参数

  • type_keyval: 用于后续访问的键值（整数）。

  • ierror: 仅限Fortran：错误状态（整数）。

17.2.390.4. 描述

MPI_Type_create_keyval 为数据类型缓存生成一个新的属性键。该例程部分替代了 MPI_Keyval_create。

参数 type_copy_attr_fn 可以指定为 C 或 Fortran 中的 MPI_TYPE_NULL_COPY_FN 或 MPI_TYPE_DUP_FN。 MPI_TYPE_NULL_COPY_FN 是一个除了返回 flag = 0 和 MPI_SUCCESS 外不执行任何操作的函数。MPI_TYPE_DUP_FN 是一个简单的复制函数，它会设置 flag = 1，将 attribute_val_in 的值返回到 attribute_val_out 中，并返回 MPI_SUCCESS。

参数 type_delete_attr_fn 可以指定为来自 C 或 Fortran 的 MPI_TYPE_NULL_DELETE_FN。MPI_TYPE_NULL_DELETE_FN 是一个除了返回 MPI_SUCCESS 外不执行任何操作的函数。C 回调函数如下：

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);

typedef int MPI_Type_delete_attr_function(MPI_Datatype type, int type_keyval,
             void *attribute_val, void *extra_state);

Fortran回调函数包括：

SUBROUTINE TYPE_COPY_ATTR_FN(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

SUBROUTINE TYPE_DELETE_ATTR_FN(TYPE, TYPE_KEYVAL, ATTRIBUTE_VAL, EXTRA_STATE,
             IERROR)
    INTEGER TYPE, TYPE_KEYVAL, IERROR
    INTEGER(KIND=MPI_ADDRESS_KIND) ATTRIBUTE VAL, EXTRA_STATE

17.2.390.5. 错误

几乎所有MPI例程都会返回一个错误值；C语言例程通过函数返回值返回，Fortran例程则通过最后一个参数返回。

在返回错误值之前，会调用与通信对象（如通信器、窗口、文件）关联的当前MPI错误处理程序。如果MPI调用未关联任何通信对象，则该调用被视为附加到MPI_COMM_SELF，并将调用关联的MPI错误处理程序。当MPI_COMM_SELF未初始化时（即在MPI_Init/MPI_Init_thread之前、MPI_Finalize之后，或仅使用会话模型时），错误会触发初始错误处理程序。初始错误处理程序可通过在使用世界模型时调用MPI_Comm_set_errhandler来修改MPI_COMM_SELF，或通过mpiexec的mpi_initial_errhandler命令行参数，或MPI_Comm_spawn/MPI_Comm_spawn_multiple的info键来设置。如果未设置其他适当的错误处理程序，则MPI I/O函数将调用MPI_ERRORS_RETURN错误处理程序，而其他所有MPI函数将调用MPI_ERRORS_ABORT错误处理程序。

Open MPI 包含三个可使用的预定义错误处理器：

  • MPI_ERRORS_ARE_FATAL 导致程序中止所有连接的MPI进程。

  • MPI_ERRORS_ABORT 一个可在通信器、窗口、文件或会话上调用的错误处理程序。当在通信器上调用时，其行为类似于在该通信器上调用MPI_Abort。如果在窗口或文件上调用，则行为类似于在包含对应窗口或文件中进程组的通信器上调用MPI_Abort。如果在会话上调用，则仅中止本地进程。

  • MPI_ERRORS_RETURN 向应用程序返回一个错误代码。

MPI应用程序也可以通过调用以下方式实现自己的错误处理程序：

请注意，MPI不保证MPI程序在出现错误后能够继续运行。

查看MPI手册页获取完整的MPI错误代码列表。

有关更多信息，请参阅MPI-3.1标准中的错误处理部分。

另请参阅