17.2.63. MPI_Comm_get_name

MPI_Comm_get_name — 返回最近与通信器关联的名称。

17.2.63.1. 语法

17.2.63.1.1. C语法

#include <mpi.h>

int MPI_Comm_get_name(MPI_Comm comm, char *comm_name, int *resultlen)

17.2.63.1.2. Fortran语法

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_COMM_GET_NAME(COMM, COMM_NAME, RESULTLEN, IERROR)
     INTEGER COMM, RESULTLEN, IERROR
     CHARACTER*(*) COMM_NAME

17.2.63.1.3. Fortran 2008 语法

USE mpi_f08
MPI_Comm_get_name(comm, comm_name, resultlen, ierror)
     TYPE(MPI_Comm), INTENT(IN) :: comm
     CHARACTER(LEN=MPI_MAX_OBJECT_NAME), INTENT(OUT) :: comm_name
     INTEGER, INTENT(OUT) :: resultlen
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.63.2. 输入参数

  • comm: 要返回名称的通信器（句柄）。

17.2.63.3. 输出参数

  • comm_name: 之前存储在通信器上的名称，如果不存在这样的名称则为空字符串（字符串类型）。

  • resultlen: 返回名称的长度（整数）。

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

17.2.63.4. 描述

MPI_Comm_get_name 返回之前与该通信器关联的名称。该名称可以通过任何语言进行设置和获取，无论使用何种语言都将返回相同的名称。comm_name 应分配足够空间以容纳长度为 MPI_MAX_OBJECT_NAME 字符的结果字符串。MPI_Comm_get_name 会在 comm_name 中返回已设置名称的副本。

如果用户未为通信器关联名称或发生错误，MPI_Comm_get_name将返回空字符串（Fortran中为全空格，C中为""）。三个预定义的通信器将具有预定义的关联名称。因此，MPI_COMM_WORLD、MPI_COMM_SELF和MPI_COMM_PARENT的名称将默认为MPI_COMM_WORLD、MPI_COMM_SELF和MPI_COMM_PARENT。系统可能选择为通信器提供默认名称的事实并不妨碍用户为同一通信器设置名称；这样做会移除旧名称并分配新名称。

17.2.63.5. 注意事项

直接打印MPI_Comm_get_name返回的字符串是安全的，因为即使没有名称，它也始终是一个有效的字符串。

请注意，为通信器关联名称不会影响MPI程序的语义，但（必然）会增加程序的存储需求，因为这些名称必须被保存。因此，并不强制要求用户使用这些函数为通信器关联名称。然而，如果为通信器关联名称，可能会使调试和分析MPI应用变得更加容易，因为调试器或分析工具将能够以更直观的方式呈现信息。

17.2.63.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标准中的错误处理部分。