17.2.325. MPI_Session_get_nth_pset

MPI_Session_get_nth_pset — 向运行时查询第n个进程集的名称

17.2.325.1. 语法

17.2.325.1.1. C语法

#include <mpi.h>

int MPI_Session_get_nth_pset(MPI_Session session, MPI_Info info, int n, int *pset_len, char *pset_name)

17.2.325.1.2. Fortran语法

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

MPI_SESSION_GET_NTH_PSET(SESSION, INFO, N, PSET_LEN, PSET_NAME, IERROR)
    INTEGER SESSION, INFO, N, PSET_LEN, IERROR
    CHARACTER*(*) PSET_NAME

17.2.325.1.3. Fortran 2008 语法

USE mpi_f08

MPI_Session_get_nth_pset(session, info, n, pset_len, pset_name, ierror)
    TYPE(MPI_Session), INTENT(IN) :: session
    TYPE(MPI_Info), INTENT(IN) :: info
    INTEGER, INTENT(IN) :: n
    INTEGER, INTENT(INOUT) :: pset_len
    CHARACTER(LEN=*), INTENT(OUT) :: pset_name
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.325.2. 输入参数

  • session : 会话 (句柄)

  • info : 信息对象(句柄)

  • n : 所需进程集名称的索引(整数)

17.2.325.2.1. 输入/输出参数

  • pset_len : pset_name参数的长度(整数)

17.2.325.3. 输出参数

  • pset_name : 第n个进程集的名称(字符串)

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

17.2.325.4. 描述

MPI_Session_get_nth_pset 返回指定序号进程集的名称到提供的pset_name缓冲区中。pset_len表示存储该进程集名称所需的缓冲区大小。如果传入函数的pset_len小于实际所需的缓冲区大小,则pset_name中返回的字符串值将被截断。若pset_len设为0,则pset_name保持不变。函数返回时,pset_len的值将被设置为容纳进程集名称所需的缓冲区大小。在C语言中,pset_len包含空终止符所需的空间。当pset_len输入值大于0时,该函数始终返回以空字符结尾的字符串。

17.2.325.5. 注意事项

进程集名称的实现定义最大长度为MPI_MAX_PSET_NAME_LEN个字符。MPI_MAX_PSET_NAME_LEN的值应至少为63。

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

另请参阅

MPI_Session_init