17.2.228. MPI_Info_get_string
MPI_Info_get_string — 从信息对象中获取与键关联的值。
17.2.228.1. 语法
17.2.228.1.1. C语法
#include <mpi.h>
int MPI_Info_get_string(MPI_Info info, const char *key, int *buflen, char *value, int *flag)
17.2.228.1.2. Fortran语法
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_INFO_GET_STRING(INFO, KEY, BUFLEN, VALUE, FLAG, IERROR)
INTEGER INFO, BUFLEN, IERROR
CHARACTER*(*) KEY, VALUE
LOGICAL FLAG
17.2.228.1.3. Fortran 2008 语法
USE mpi_f08
MPI_Info_get_string(info, key, buflen, value, flag, ierror)
TYPE(MPI_Info), INTENT(IN) :: info
CHARACTER(LEN=*), INTENT(IN) :: key
INTEGER, INTENT(INOUT) :: buflen
CHARACTER(LEN=valuelen), INTENT(OUT) :: value
LOGICAL, INTENT(OUT) :: flag
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
17.2.228.2. 输入参数
info: 信息对象(句柄)。key: 键值(字符串)。
17.2.228.3. 输出参数
buflen On entry, length of value arg. On return, set to required size to: 用于保存值字符串(整数)的所需大小。value: 值(字符串类型)。flag: 如果键已定义则返回true,未定义则返回false(布尔值)。ierror: 仅限Fortran:错误状态(整数)。
17.2.228.4. 描述
MPI_Info_get_string 从info中检索与key关联的值(如果存在)。如果该键存在于info中,则将flag设为true并在value中返回该值;否则将flag设为false且不改变value的值。输入的buflen表示提供缓冲区的大小,输出的buflen表示存储值字符串所需的缓冲区大小。如果传入函数的buflen小于实际存储值字符串所需的大小(包括C语言中的空终止符),则该值将被截断。返回时,buflen的值将被设为容纳值字符串所需的缓冲区大小。如果buflen设为0,则value不会被改变。在C语言中,buflen包含空终止符所需的空间。在C语言中,当buflen输入值大于0时,此函数始终返回以空字符终止的字符串。
如果key大于MPI_MAX_INFO_KEY,则该调用是错误的。
17.2.228.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-3.1标准中的错误处理部分。