17.2.420. MPI_Unpack

MPI_Unpack — 将数据类型解包到连续内存中。

17.2.420.1. 语法

17.2.420.1.1. C语法

#include <mpi.h>

int MPI_Unpack(const void *inbuf, int insize, int *position,
     void *outbuf, int outcount, MPI_Datatype datatype,
     MPI_Comm comm)

17.2.420.1.2. Fortran 语法

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_UNPACK(INBUF, INSIZE, POSITION, OUTBUF, OUTCOUNT,
     DATATYPE, COMM, IERROR)
     <type>  INBUF(*), OUTBUF(*)
     INTEGER INSIZE, POSITION, OUTCOUNT, DATATYPE,
             COMM, IERROR

17.2.420.1.3. Fortran 2008 语法

USE mpi_f08
MPI_Unpack(inbuf, insize, position, outbuf, outcount, datatype, comm,
             ierror)
     TYPE(*), DIMENSION(..), INTENT(IN) :: inbuf
     TYPE(*), DIMENSION(..) :: outbuf
     INTEGER, INTENT(IN) :: insize, outcount
     INTEGER, INTENT(INOUT) :: position
     TYPE(MPI_Datatype), INTENT(IN) :: datatype
     TYPE(MPI_Comm), INTENT(IN) :: comm
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.420.2. 输入参数

• inbuf: 输入缓冲区起始位置（可选）。

• insize: 输入缓冲区的大小，以字节为单位（整数）。

• outcount: 待解包的项目数量（整数）。

• datatype: 每个输出数据项的数据类型（句柄）。

• comm: 用于打包消息的通信器（句柄）。

17.2.420.3. 输入/输出参数

• position: 当前字节位置（整数）。

17.2.420.4. 输出参数

• outbuf: 输出缓冲区起始位置（选项）。

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

17.2.420.5. 描述

将消息从inbuf和insize指定的缓冲区空间解包到由outbuf、outcount和datatype指定的接收缓冲区中。输出缓冲区可以是MPI_Recv允许的任何通信缓冲区。输入缓冲区是一个连续的存储区域，包含从inbuf地址开始的insize字节。position的输入值是输入缓冲区中被打包消息占用的第一个位置。position会随着打包消息的大小增加，因此position的输出值是输入缓冲区中解包消息占用位置之后的首个位置。comm是用于接收打包消息的通信器。

17.2.420.6. 注意事项

注意MPI_Recv和MPI_Unpack之间的区别：在MPI_Recv中， count参数指定了可以接收的最大项目数。实际接收的项目数量由 传入消息的长度决定。而在MPI_Unpack中，count参数指定了 需要解包的实际项目数量；对应消息的"大小"是位置的增量。 这种变化的原因是"传入消息大小"并非预先确定，因为用户决定解包多少； 也不容易根据要解包的项目数量来确定"消息大小"。

为了理解pack和unpack的行为，可以方便地将消息的数据部分视为通过连接该消息中连续发送的值所获得的序列。pack操作将此序列存储在缓冲区空间中，就像将消息发送到该缓冲区一样。unpack操作从缓冲区空间检索此序列，就像从该缓冲区接收消息一样。（可以联想Fortran内部文件或C语言中的sscanf函数来理解类似功能。）

可以将多条消息连续打包到一个打包单元中。这是通过多次连续相关的MPI_Pack调用实现的：首次调用时设置position = 0，后续每次调用都输入前次调用输出的position值，并保持相同的outbuf、outcount和comm参数值。这样形成的打包单元所包含的信息，等同于将各个发送缓冲区"串联"后通过单次发送调用存储在消息中的信息。

打包单元可以使用MPI_Packed类型发送。任何点对点或集体通信函数都可以用于将构成打包单元的字节序列从一个进程移动到另一个进程。现在可以使用任何接收操作接收该打包单元，且支持任意数据类型：对于使用MPI_Packed类型发送的消息，类型匹配规则会放宽。

使用MPI_Packed类型可以接收任何类型（包括MPI_Packed）发送的消息。随后可以通过调用MPI_Unpack来解包此类消息。

一个打包单元（或由常规“类型化”发送创建的消息）可以被解包成多个连续的消息。这是通过多次连续相关的MPI_Unpack调用来实现的，其中第一次调用提供position = 0，而每次后续调用都输入前一次调用输出的position值，以及相同的inbuf、insize和comm值。

两个打包单元的连接不一定构成一个打包单元；同样，一个打包单元的子串也不一定是一个打包单元。因此，不能将两个打包单元连接后作为一个打包单元进行解包；也不能将打包单元的子串作为独立的打包单元进行解包。每个由一系列相关的pack调用或常规发送创建的打包单元，必须作为一个整体单元，通过一系列相关的unpack调用来解包。

17.2.420.7. 错误

几乎所有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_Comm_create_errhandler 然后 MPI_Comm_set_errhandler

• MPI_File_create_errhandler 然后 MPI_File_set_errhandler

• MPI_Session_create_errhandler 然后 MPI_Session_set_errhandler 或在 MPI_Session_init

• MPI_Win_create_errhandler 然后 MPI_Win_set_errhandler

请注意，MPI不保证MPI程序在出现错误后能够继续运行。

查看MPI手册页获取完整的MPI错误代码列表。

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

另请参阅

• MPI_Pack

• MPI_Pack_size