17.2.32. MPI_Buffer_detach

MPI_Buffer_detach — 移除现有缓冲区(用于MPI_Bsend等操作)

17.2.32.1. 语法

17.2.32.1.1. C语法

#include <mpi.h>

int MPI_Buffer_detach(void *buf, int *size)

17.2.32.1.2. Fortran语法

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

MPI_BUFFER_DETACH(BUF, SIZE, IERROR)
    <type>  BUF(*)
    INTEGER SIZE, IERROR

17.2.32.1.3. Fortran 2008 语法

USE mpi_f08

MPI_Buffer_detach(buffer_addr, size, ierror)
    USE, INTRINSIC :: ISO_C_BINDING, ONLY
    TYPE(C_PTR), INTENT(OUT) :: buffer_addr
    INTEGER, INTENT(OUT) :: size
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.32.2. 输出参数

  • buf : 初始缓冲区地址(可选)。

  • size : 缓冲区大小,单位为字节(整数)。

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

17.2.32.3. 描述

分离当前与MPI关联的缓冲区。该调用将返回已分离缓冲区的地址和大小。此操作将阻塞,直到缓冲区中当前所有消息传输完毕。函数返回后,用户可以重新使用或释放该缓冲区占用的空间。

示例:调用附加和分离缓冲区的操作。

#define BUFFSIZE 10000

int size char *buff;
MPI_Buffer_attach( malloc(BUFFSIZE), BUFFSIZE);

// a buffer of 10000 bytes can now be used by MPI_Bsend

MPI_Buffer_detach( &buff, &size); // Buffer size reduced to zero
MPI_Buffer_attach( buff, size); // Buffer of 10000 bytes available again

17.2.32.4. 注意事项

MPI_Buffer_detach返回被分离缓冲区的地址和大小的原因是为了允许嵌套库替换和恢复缓冲区。例如,考虑

int size, mysize, idummy;
void *ptr, *myptr, *dummy;
MPI_Buffer_detach( &ptr, &size );
MPI_Buffer_attach( myptr, mysize );

/* ... library code ... */

MPI_Buffer_detach( &dummy, &idummy );
MPI_Buffer_attach( ptr, size );

这与UNIX信号例程的行为非常相似,具有相同的优点(简单)和缺点(仅适用于嵌套使用场景)。

对于Fortran语言:此例程的Fortran绑定有所不同。由于Fortran没有指针功能,无法提供利用此例程输出来交换缓冲区的方法。在这种情况下,仅会设置size字段。

对于C语言:尽管buf参数声明为void类型,但它实际上是一个void指针的地址。更多详情请参阅下方的原理说明。

尽管C函数MPI_Buffer_attachMPI_Buffer_detach的第一个参数都是void*类型,但这些参数的用法不同:传递给MPI_Buffer_attach的是缓冲区指针;而传递给MPI_Buffer_detach的是指针的地址,这样该调用可以返回指针值。

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

另请参阅