17.2.275. MPI_Pack_external
MPI_Pack_external — 将数据写入可移植格式
17.2.275.1. 语法
17.2.275.1.1. C语法
#include <mpi.h>
int MPI_Pack_external(const char *datarep, const void *inbuf,
int incount, MPI_Datatype datatype,
void *outbuf, MPI_Aint outsize,
MPI_Aint *position)
17.2.275.1.2. Fortran语法
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_PACK_EXTERNAL(DATAREP, INBUF, INCOUNT, DATATYPE,
OUTBUF, OUTSIZE, POSITION, IERROR)
INTEGER INCOUNT, DATATYPE, IERROR
INTEGER(KIND=MPI_ADDRESS_KIND) OUTSIZE, POSITION
CHARACTER*(*) DATAREP
<type> INBUF(*), OUTBUF(*)
17.2.275.1.3. Fortran 2008 语法
USE mpi_f08
MPI_Pack_external(datarep, inbuf, incount, datatype, outbuf, outsize,
position, ierror)
CHARACTER(LEN=*), INTENT(IN) :: datarep
TYPE(*), DIMENSION(..), INTENT(IN) :: inbuf
TYPE(*), DIMENSION(..) :: outbuf
INTEGER, INTENT(IN) :: incount
TYPE(MPI_Datatype), INTENT(IN) :: datatype
INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(IN) :: outsize
INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(INOUT) :: position
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
17.2.275.2. 输入参数
datarep: 数据表示（字符串）。inbuf: 输入缓冲区起始位置（可选）。incount: 输入数据项的数量（整数）。datatype: 每个输入数据项的数据类型（句柄）。outsize: 输出缓冲区大小，单位为字节（整数）。
17.2.275.3. 输入/输出参数
position: 缓冲区中的当前位置，以字节为单位（整数）。
17.2.275.4. 输出参数
outbuf: 输出缓冲区起始位置（选项）。ierror: 仅限Fortran：错误状态（整数）。
17.2.275.5. 描述
MPI_Pack_external 将数据打包为external32格式，这是由MPI论坛定义的一种通用数据表示形式。该格式适用于在不同MPI实现之间交换数据，或将数据写入文件时使用。
输入缓冲区由inbuf、incount和datatype指定，可以是MPI_Send中允许的任何通信缓冲区。输出缓冲区outbuf必须是包含outsize字节的连续存储区域。
position的输入值是outbuf中用于打包的第一个位置（以字节为单位测量，而非元素数量，相对于缓冲区的起始位置）。当函数返回时，position会增加已打包消息的大小，使其指向outbuf中打包消息之后的首个位置。这种方式可使其作为后续调用MPI_Pack_external的输入。
示例： 一个使用 MPI_Pack_external 的示例：
int position, i;
double msg[5];
char buf[1000];
...
MPI_Comm_rank(MPI_COMM_WORLD, &myrank);
if (myrank == 0) { /* SENDER CODE */
position = 0;
i = 5; /* number of doubles in msg[] */
MPI_Pack_external("external32", &i, 1, MPI_INT,
buf, 1000, &position);
MPI_Pack_external("external32", &msg, i, MPI_DOUBLE,
buf, 1000, &position);
MPI_Send(buf, position, MPI_BYTE, 1, 0,
MPI_COMM_WORLD);
} else { /* RECEIVER CODE */
MPI_Recv(buf, 1, MPI_BYTE, 0, 0, MPI_COMM_WORLD,
MPI_STATUS_IGNORE);
MPI_Unpack_external("external32", buf, 1000,
MPI_INT, &i, 1, &position);
MPI_Unpack_external("external32", buf, 1000,
MPI_DOUBLE, &msg, i, &position);
}
17.2.275.6. 注意事项
datarep参数用于指定数据格式。在当前版本的MPI中，唯一有效的值是"external32"。提供该参数是为了未来的可扩展性。
为了理解pack和unpack的行为，可以方便地将消息的数据部分视为通过连接该消息中连续发送的值所获得的序列。pack操作将此序列存储在缓冲区空间中，就像将消息发送到该缓冲区一样。unpack操作从缓冲区空间检索此序列，就像从该缓冲区接收消息一样。（可以联想Fortran内部文件或C语言中的sscanf函数来理解类似功能。）
可以将多条消息连续打包到一个打包单元中。这是通过多次连续相关的MPI_Pack_external调用来实现的，其中第一次调用提供position=0，而每次后续调用都输入前一次调用输出的position值，同时保持outbuf和outcount的值不变。这个打包单元现在包含的信息等同于通过一次发送调用存储的消息，其发送缓冲区是各个发送缓冲区的"串联"。
打包单元可以使用MPI_BYTE类型发送。任何点对点或集体通信函数都可以用于将构成打包单元的字节序列从一个进程移动到另一个进程。现在可以使用任何接收操作、任何数据类型来接收这个打包单元。（对于使用MPI_BYTE类型发送的消息，类型匹配规则会放宽。）
一个打包单元可以被解包成多个连续的消息。这是通过多次连续相关的MPI_Unpack_external调用来实现的，其中第一次调用提供position=0，而每次后续调用都输入前一次调用输出的position值，以及相同的inbuf和insize值。
两个打包单元的连接不一定是打包单元；打包单元的子串也不一定是打包单元。 因此，不能将两个打包单元连接后作为一个打包单元解包；也不能将打包单元的子串作为单独的打包单元解包。 每个由一系列相关打包调用创建的打包单元，必须通过一系列相关的解包调用作为一个单元进行解包。
17.2.275.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不保证MPI程序在出现错误后能够继续运行。
有关更多信息，请参阅MPI-3.1标准中的错误处理部分。
另请参阅
sscanf(3C)