Synopsis

int MPI_Session_detach_buffer(MPI_Session session, void *buffer_addr,
                              int *size)
int MPI_Session_detach_buffer_c(MPI_Session session, void *buffer_addr,
                                MPI_Count *size)

Input Parameters

session

session (handle)

Output Parameters

buffer_addr

initial buffer address (choice)

size

buffer size, in bytes (integer)

Description

MPI_Session_detach_buffer detaches the session-specific buffer currently attached to a session and returns the address and size of the detached buffer. This procedure is nonlocal and will delay return until all messages currently in the buffer have been transmitted, after which the user may reuse or deallocate the buffer space.

If MPI_BUFFER_AUTOMATIC was used in the corresponding attach procedure, MPI_BUFFER_AUTOMATIC is returned in buffer_addr, the value in size is undefined, and automatic buffering is disabled. If the size of the detached buffer cannot be represented in size, it is set to MPI_UNDEFINED. It is erroneous to detach a buffer if no buffer was attached using a corresponding attach procedure. For libraries and programs using the Sessions Model, using only communicator-specific or session-specific buffers is recommended.

Notes for Fortran

All MPI routines in Fortran (except for 'MPI_WTIME' and 'MPI_WTICK') have an additional argument 'ierr' at the end of the argument list. 'ierr' is an integer and has the same meaning as the return value of the routine in C. In Fortran, MPI routines are subroutines, and are invoked with the 'call' statement.

All MPI objects (e.g., 'MPI_Datatype', 'MPI_Comm') are of type 'INTEGER' in Fortran.

Errors

All MPI routines (except 'MPI_Wtime' and 'MPI_Wtick') return an error value; C routines as the value of the function and Fortran routines in the last argument. Before the value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job. The error handler may be changed with 'MPI_Comm_set_errhandler' (for communicators), 'MPI_File_set_errhandler' (for files), and 'MPI_Win_set_errhandler' (for RMA windows). The MPI-1 routine 'MPI_Errhandler_set' may be used but its use is deprecated. The predefined error handler 'MPI_ERRORS_RETURN' may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error; however, MPI implementations will attempt to continue whenever possible.

  • MPI_SUCCESS - No error; MPI routine completed successfully.

  • MPI_ERR_ARG - Invalid argument. Some argument is invalid and is not identified by a specific error class (e.g., 'MPI_ERR_RANK').

  • MPI_ERR_SESSION - Invalid session handle

  • MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.

See also