17.2.53. MPI_Comm_delete_attr

MPI_Comm_delete_attr — 删除与键关联的属性值。

17.2.53.1. 语法

17.2.53.1.1. C语法

#include <mpi.h>

int MPI_Comm_delete_attr(MPI_Comm comm, int comm_keyval)

17.2.53.1.2. Fortran 语法

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

MPI_COMM_DELETE_ATTR(COMM, COMM_KEYVAL, IERROR)
    INTEGER COMM, COMM_KEYVAL, IERROR

17.2.53.1.3. Fortran 2008 语法

USE mpi_f08

MPI_Comm_delete_attr(comm, comm_keyval, ierror)
    TYPE(MPI_Comm), INTENT(IN) :: comm
    INTEGER, INTENT(IN) :: comm_keyval
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.53.1.4. 输入/输出参数

  • comm : 要删除属性的通信器(句柄)。

17.2.53.2. 输入参数

  • comm_keyval : 键值(整数)。

17.2.53.3. 输出参数

  • ierror : 仅限Fortran:错误状态(整数)。

17.2.53.4. 描述

MPI_Comm_delete_attr 通过键从缓存中删除一个属性。该函数会调用创建comm_keyval时指定的属性删除函数delete_fn。如果delete_fn函数返回的错误代码不是MPI_SUCCESS,则调用将失败。

每当使用函数MPI_Comm_dup复制通信器时,所有当前设置的属性回调复制函数都会被调用(调用顺序不定)。当使用函数MPI_Comm_free删除通信器时,所有当前设置的属性回调删除函数都会被调用。此函数与MPI_Attr_delete功能相同,但需要与MPI-2标准中引入的通信器专用函数相匹配。现已不推荐使用MPI_Attr_delete

17.2.53.5. 注意事项

请注意,MPI标准未定义当delete_fn回调函数调用其他MPI函数时会发生什么。在Open MPI中,delete_fn回调函数(或其任何子函数)在被调用的同一对象上添加或删除属性是无效的。

17.2.53.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不保证MPI程序在出现错误后能够继续运行。

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

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