17.2.274. MPI_Pack

MPI_Pack — 将给定数据类型的数据打包到连续内存中。

17.2.274.1. 语法

17.2.274.1.1. C语法

#include <mpi.h>

int MPI_Pack(const void *inbuf, int incount, MPI_Datatype datatype,
     void *outbuf, int outsize, int *position, MPI_Comm comm)

17.2.274.1.2. Fortran语法

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

17.2.274.1.3. Fortran 2008 语法

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

17.2.274.2. 输入参数

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

• incount: 输入数据项的数量（整数）。

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

• outsize: 输出缓冲区大小，单位为字节（整数）。

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

17.2.274.3. 输入/输出参数

• position: 缓冲区中的当前位置，以字节为单位（整数）。

17.2.274.4. 输出参数

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

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

17.2.274.5. 描述

将消息从由inbuf、incount和datatype指定的发送缓冲区打包到由outbuf和outsize指定的缓冲区空间。输入缓冲区可以是MPI_Send允许的任何通信缓冲区。输出缓冲区是一个连续的存储区域，包含从地址outbuf开始的outsize字节（长度以字节而非元素为单位计算，就像它是MPI_Packed类型消息的通信缓冲区一样）。

position的输入值是输出缓冲区中用于打包的第一个位置。position会随着打包消息的大小而递增，其输出值是输出缓冲区中紧随打包消息占用位置之后的第一个位置。comm参数是随后将用于发送打包消息的通信器。

示例： 一个使用 MPI_Pack 的示例：

int myrank, position, i, j, a[2];
char buff[1000];

// ...

MPI_Comm_rank(MPI_COMM_WORLD, &myrank);
if (myrank == 0) {
  /* SENDER CODE */
  position = 0;
  MPI_Pack(&i, 1, MPI_INT, buff, 1000, &position, MPI_COMM_WORLD);
  MPI_Pack(&j, 1, MPI_INT, buff, 1000, &position, MPI_COMM_WORLD);
  MPI_Send(buff, position, MPI_PACKED, 1, 0, MPI_COMM_WORLD);
} else {
  /* RECEIVER CODE */
  MPI_Recv(a, 2, MPI_INT, 0, 0, MPI_COMM_WORLD);
}

17.2.274.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_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_Unpack

• MPI_Pack_size