17.2.251. MPI_Keyval_create

MPI_Keyval_create — 生成一个新的属性键 — 该例程已被MPI_Comm_create_keyval取代。

17.2.251.1. 语法

17.2.251.1.1. C语法

#include <mpi.h>

int MPI_Keyval_create(MPI_Copy_function *copy_fn,
     MPI_Delete_function *delete_fn, int *keyval, void *extra_state)

17.2.251.1.2. Fortran语法

USE MPI
! or the older form: INCLUDE 'mpif.h'

MPI_KEYVAL_CREATE(COPY_FN, DELETE_FN, KEYVAL, EXTRA_STATE, IERROR)
     EXTERNAL        COPY_FN, DELETE_FN
     INTEGER KEYVAL, EXTRA_STATE, IERROR

17.2.251.2. 输入参数

copy_fn: 键值的复制回调函数。
delete_fn: 键值的删除回调函数。
extra_state: 回调函数的额外状态。

17.2.251.3. 输出参数

keyval: 用于后续访问的键值（整数）。
ierror: 仅限Fortran：错误状态（整数）。

17.2.251.4. 描述

请注意，自MPI-2起，此例程的使用已被弃用。请改用MPI_Comm_create_keyval。

生成一个新的属性键。键在进程内是局部唯一的，对用户而言是不透明的，尽管它们明确以整数形式存储。一旦分配，键值可用于关联属性，并在任何本地定义的通信器上访问这些属性。

当通过MPI_Comm_dup复制通信器时，会调用copy_fn函数。copy_fn应为MPI_Copy_function类型，其定义如下：

typedef int MPI_Copy_function(MPI_Comm oldcomm, int keyval,
                              void *extra_state, void *attribute_val_in,
                              void *attribute_val_out, int *flag)

此类函数的Fortran声明如下：

SUBROUTINE COPY_FUNCTION(OLDCOMM, KEYVAL, EXTRA_STATE, ATTRIBUTE_VAL_IN,
            ATTRIBUTE_VAL_OUT, FLAG, IERR)
INTEGER OLDCOMM, KEYVAL, EXTRA_STATE,
ATTRIBUTE_VAL_IN, ATTRIBUTE_VAL_OUT, IERR
LOGICAL FLAG

复制回调函数会以任意顺序为oldcomm中的每个键值调用。每次调用复制回调函数时，都会传入一个键值及其对应的属性。如果返回flag = 0，则该属性会在复制的通信子中被删除。否则（flag = 1），新属性值将被设置为attribute_val_out中返回的值。函数成功时返回MPI_SUCCESS，失败时返回错误代码（此时MPI_Comm_dup将失败）。

copy_fn可以指定为来自C或Fortran的MPI_NULL_COPY_FN或MPI_DUP_FN；MPI_NULL_COPY_FN是一个除了返回flag = 0和MPI_SUCCESS外不执行任何操作的函数。MPI_DUP_FN是一个简单的复制函数，它会设置flag = 1，将attribute_val_in的值赋给attribute_val_out，并返回MPI_SUCCESS。

17.2.251.5. 注意事项

键值是全局的（可用于任何及所有通信器）。

C语言和Fortran之间存在细微差异，要求copy_fn必须与调用MPI_Keyval_create时使用的语言保持一致。这对大多数用户来说应该不是问题；只有同时使用Fortran和C语言的程序员需要确保遵守此规则。

尽管形式参数attribute_val_in和attribute_val_out都是void*类型，但它们的用法不同。MPI传递给C复制函数时，attribute_val_in中是属性的值，而attribute_val_out中是属性的地址，以便函数能够返回（新的）属性值。两者都使用void *类型是为了避免繁琐的类型转换。

有效的复制函数是指通过完整复制属性所隐含的数据结构来完全复制信息的函数；另一种可能只是对该数据结构创建另一个引用，同时使用引用计数机制。其他类型的属性可能根本不会复制（它们可能仅适用于oldcomm）。

与copy_fn类似的是回调删除函数，定义如下。当通过MPI_Comm_free删除通信器或显式调用MPI_Attr_delete时，会调用delete_fn函数。delete_fn的类型应为MPI_Delete_function，其定义如下：

typedef int MPI_Delete_function(MPI_Comm comm, int keyval,
    void *attribute_val, void *extra_state);

此类函数的Fortran声明如下：

SUBROUTINE DELETE_FUNCTION(COMM, KEYVAL,ATTRIBUTE_VAL, EXTRA_STATE, IERR)
    INTEGER COMM, KEYVAL, ATTRIBUTE_VAL, EXTRA_STATE, IERR

该函数由MPI_Comm_free、MPI_Attr_delete和 MPI_Attr_put调用，用于执行删除属性所需的操作。函数执行成功时返回MPI_SUCCESS，失败时返回错误代码（此时MPI_Comm_free将执行失败）。

delete_fn 可以指定为 MPI_NULL_DELETE_FN（适用于 C 或 FORTRAN）；MPI_NULL_DELETE_FN 是一个空操作函数，除了返回 MPI_SUCCESS 外不执行任何操作。

特殊键值MPI_KEYVAL_INVALID永远不会被MPI_Keyval_create返回。因此，它可以用于键值的静态初始化。

17.2.251.6. 错误

几乎所有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_Comm_create_errhandler 然后 MPI_Comm_set_errhandler
MPI_File_create_errhandler 然后 MPI_File_set_errhandler
MPI_Session_create_errhandler 然后 MPI_Session_set_errhandler 或在 MPI_Session_init
MPI_Win_create_errhandler 然后 MPI_Win_set_errhandler

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

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

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

另请参阅