17.2.169. MPI_Get_count

MPI_Get_count — 获取接收到的顶层元素数量。

17.2.169.1. 语法

17.2.169.1.1. C语法

#include <mpi.h>

int MPI_Get_count(const MPI_Status *status, MPI_Datatype datatype,
    int *count)

17.2.169.1.2. Fortran语法

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

MPI_GET_COUNT(STATUS, DATATYPE, COUNT, IERROR)
    INTEGER STATUS(MPI_STATUS_SIZE), DATATYPE, COUNT, IERROR

17.2.169.1.3. Fortran 2008 语法

USE mpi_f08

MPI_Get_count(status, datatype, count, ierror)
    TYPE(MPI_Status), INTENT(IN) :: status
    TYPE(MPI_Datatype), INTENT(IN) :: datatype
    INTEGER, INTENT(OUT) :: count
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.169.2. 输入参数

  • status : 返回接收操作的状态(status)。

  • datatype : 每个接收缓冲区元素的数据类型(句柄)。

17.2.169.3. 输出参数

  • count : 接收到的元素数量(整数)。

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

17.2.169.4. 描述

返回接收到的条目数量。(我们统计的是条目数,每个条目属于datatype类型,而非字节数。)datatype参数应与设置状态变量的接收调用所提供的参数相匹配。如MPI标准中"通信中通用数据类型的用法"章节所述,MPI_Get_count在某些情况下可能返回MPI_UNDEFINED值。

为了提高性能,将数据类型参数传递给MPI_Get_count。 接收消息时可能不需要计算其包含的元素数量,而且通常不需要计数结果。 此外,这允许在调用MPI_Probe后使用相同的函数。

17.2.169.5. 注意事项

如果数据类型的大小为零,此例程将返回计数为零。如果状态中的数据量不是数据类型大小的精确倍数(导致计数不为整数),则返回MPI_UNDEFINED作为计数。

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

如果要返回的值超出count参数所能容纳的范围,则会引发MPI_ERR_TRUNCATE错误。

另请参阅

MPI_Get_elements