17.2.401. MPI_Type_get_contents

MPI_Type_get_contents — 返回有关创建数据类型时所用参数的信息。

17.2.401.1. 语法

17.2.401.1.1. C语法

#include <mpi.h>

int MPI_Type_get_contents(MPI_Datatype datatype, int max_integers,
     int max_addresses, int max_datatypes, int array_of_integers[], MPI_Aint array_of_addresses[], MPI_Datatype array_of_datatypes[])

17.2.401.1.2. Fortran语法

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_TYPE_GET_CONTENTS(DATATYPE, MAX_INTEGERS, MAX_ADDRESSES,
             MAX_DATATYPES, ARRAY_OF_INTEGERS, ARRAY_OF_ADDRESSES,
             ARRAY_OF_DATATYPES, IERROR)
     INTEGER DATATYPE, MAX_INTEGERS, MAX_ADDRESSES, MAX_DATATYPES
     INTEGER ARRAY_OF_INTEGERS(*), ARRAY_OF_DATATYPES(*), IERROR
     INTEGER(KIND=MPI_ADDRESS_KIND) ARRAY_OF_ADDRESSES(*)

17.2.401.1.3. Fortran 2008 语法

USE mpi_f08
MPI_Type_get_contents(datatype, max_integers, max_addresses, max_datatypes,
     array_of_integers, array_of_addresses, array_of_datatypes,
             ierror)
     TYPE(MPI_Datatype), INTENT(IN) :: datatype
     INTEGER, INTENT(IN) :: max_integers, max_addresses, max_datatypes
     INTEGER, INTENT(OUT) :: array_of_integers(max_integers)
     INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(OUT) ::
     array_of_addresses(max_addresses)
     TYPE(MPI_Datatype), INTENT(OUT) :: array_of_datatypes(max_datatypes)
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.401.2. 输入参数

  • datatype: 要访问的数据类型（句柄）。

  • max_integers: array_of_integers数组中的元素数量（非负整数）。

  • max_addresses: array_of_addresses数组中的元素数量（非负整数）。

  • max_datatypes: array_of_datatypes中的元素数量（非负整数）。

17.2.401.3. 输出参数

  • array_of_integers: 包含用于构造数据类型（整数数组）的整型参数。

  • array_of_addresses: 包含用于构造数据类型(整数数组)的地址参数。

  • array_of_datatypes: 包含用于构造数据类型（整数数组）的数据类型参数。

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

17.2.401.4. 描述

对于给定的数据类型，MPI_Type_get_envelope会返回有关创建该数据类型时所用调用中输入参数的数量和类型的信息。返回的参数数量值可用于在解码例程MPI_Type_get_contents中提供足够大的数组。下文将描述此调用及返回值的含义。组合器反映了创建datatype时使用的MPI数据类型构造函数调用。

参数 datatype 必须是一个预定义的无名或派生数据类型。如果 datatype 是预定义的命名数据类型，则该调用是错误的。

为max_integers、max_addresses和max_datatypes指定的值必须至少与在调用:ref:`MPI_Type_get_envelope`时针对相同数据类型参数返回的num_integers、num_addresses和num_datatypes值一样大。

array_of_datatypes中返回的数据类型是对数据类型的句柄，这些数据类型与原始构造调用中使用的数据类型等效。如果这些是派生数据类型，则返回的数据类型是新的数据类型对象，用户需负责通过:ref:`MPI_Type_free`释放这些数据类型。如果这些是预定义数据类型，则返回的数据类型等于该（常量）预定义数据类型且无法被释放。

返回的派生数据类型的提交状态未定义，即这些数据类型可能已提交也可能未提交。此外，返回数据类型的属性内容也是未定义的。

请注意，MPI_Type_get_contents可以使用通过MPI_Type_create_f90_real、MPI_Type_create_f90_integer或MPI_Type_create_f90_complex（未命名的预定义数据类型）构建的数据类型参数进行调用。在这种情况下，将返回一个空的array_of_datatypes数组。

在传统的MPI-1数据类型构造函数调用中，Fortran语言中的地址参数类型为INTEGER。在后续版本的MPI标准中，地址参数类型改为INTEGER(KIND=MPI_ADDRESS_KIND)。函数调用MPI_Type_get_contents会以INTEGER(KIND=MPI_ADDRESS_KIND)类型返回所有地址参数。即使使用了旧的MPI-1调用方式也是如此。因此，可以认为返回值的位置是通过C语言绑定返回的。也可以通过检查当前涉及地址的已弃用MPI-1调用的数据类型构造函数MPI调用来确定。

17.2.401.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手册页获取完整的MPI错误代码列表。

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

另请参阅