Open MPI logo

MPI_Get(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

C]MPI_GetR], C]MPI_RgetR] - Copies data from the target memory to the origin.

Syntax

C Syntax



C]#include <mpi.h>MPI_Get(void *origin_addr, int origin_count, MPI_Datatype origin_datatype, int target_rank, MPI_Aint target_disp, int target_count, MPI_Datatype target_datatype, MPI_Win win)MPI_Rget(void *origin_addr, int origin_count, MPI_Datatype origin_datatype, int target_rank, MPI_Aint target_disp, int target_count, MPI_Datatype target_datatype, MPI_Win win, MPI_Request *request)R]Fortran Syntax (See Fortran 77 Notes)



C]USE MPI! or the older form: INCLUDE [aq]mpif.h[aq]MPI_GET(ORIGIN_ADDR, ORIGIN_COUNT, ORIGIN_DATATYPE, TARGET_RANK, TARGET_DISP, TARGET_COUNT, TARGET_DATATYPE, WIN, IERROR) <type> ORIGIN_ADDR(*) INTEGER(KIND=MPI_ADDRESS_KIND) TARGET_DISP INTEGER ORIGIN_COUNT, ORIGIN_DATATYPE, TARGET_RANK, TARGET_COUNT, TARGET_DATATYPE, WIN, IERRORMPI_RGET(ORIGIN_ADDR, ORIGIN_COUNT, ORIGIN_DATATYPE, TARGET_RANK, TARGET_DISP, TARGET_COUNT, TARGET_DATATYPE, WIN, REQUEST, IERROR) <type> ORIGIN_ADDR(*) INTEGER(KIND=MPI_ADDRESS_KIND) TARGET_DISP INTEGER ORIGIN_COUNT, ORIGIN_DATATYPE, TARGET_RANK, TARGET_COUNT, TARGET_DATATYPE, WIN, REQUEST, IERRORR]Fortran 2008 Syntax



C]USE mpi_f08MPI_Get(origin_addr, origin_count, origin_datatype, target_rank, target_disp, target_count, target_datatype, win, ierror) TYPE(*), DIMENSION(..), ASYNCHRONOUS :: origin_addr INTEGER, INTENT(IN) :: origin_count, target_rank, target_count TYPE(MPI_Datatype), INTENT(IN) :: origin_datatype, target_datatype INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(IN) :: target_disp TYPE(MPI_Win), INTENT(IN) :: win INTEGER, OPTIONAL, INTENT(OUT) :: ierrorMPI_Rget(origin_addr, origin_count, origin_datatype, target_rank, target_disp, target_count, target_datatype, win, request, ierror) TYPE(*), DIMENSION(..), ASYNCHRONOUS :: origin_addr INTEGER, INTENT(IN) :: origin_count, target_rank, target_count TYPE(MPI_Datatype), INTENT(IN) :: origin_datatype, target_datatype INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(IN) :: target_disp TYPE(MPI_Win), INTENT(IN) :: win TYPE(MPI_Request), INTENT(OUT) :: request INTEGER, OPTIONAL, INTENT(OUT) :: ierrorR]Input Parameters

[bu]
C]origin_addrR] : Initial address of origin buffer (choice).
[bu]
C]origin_countR] : Number of entries in origin buffer (nonnegative integer).
[bu]
C]origin_datatypeR] : Data type of each entry in origin buffer (handle).
[bu]
C]target_rankR] : Rank of target (nonnegative integer).
[bu]
C]target_dispR] : Displacement from window start to the beginning of the target buffer (nonnegative integer).
[bu]
C]target_countR] : Number of entries in target buffer (nonnegative integer).
[bu]
C]target datatypeR] : datatype of each entry in target buffer (handle)
[bu]
C]winR] : window object used for communication (handle)

Output Parameter

[bu]
C]requestR] : MPI_Rget: RMA request
[bu]
C]IERRORR] : Fortran only: Error status (integer).

Description

C]MPI_GetR] copies data from the target memory to the origin, similar to C]MPI_PutR], except that the direction of data transfer is reversed. The C]origin_datatypeR] may not specify overlapping entries in the origin buffer. The target buffer must be contained within the target window, and the copied data must fit, without truncation, in the origin buffer. Only processes within the same node can access the target window.

C]MPI_RgetR] is similar to C]MPI_GetR], except that it allocates a communication C]requestR] object and associates it with the C]requestR] handle (the argument C]requestR]) that can be used to wait or test for completion. The completion of an C]MPI_RgetR] operation indicates that the data is available in the origin buffer. If C]origin_addrR] points to memory attached to a window, then the data becomes available in the private copy of this window.

Fortran 77 Notes

The MPI standard prescribes portable Fortran syntax for the C]TARGET_DISPR] argument only for Fortran 90. FORTRAN 77 users may use the non-portable syntax


C]INTEGER*MPI_ADDRESS_KIND TARGET_DISPR]where C]MPI_ADDRESS_KINDR] is a constant defined in mpif.h and
gives the length of the declared integer in bytes.

Errors

Almost all MPI routines return an error value; C routines as the value of the function and Fortran routines in the last argument.

Before the error value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job, except for I/O function errors. The error handler may be changed with C]MPI_Comm_set_errhandlerR]; the predefined error handler C]MPI_ERRORS_RETURNR] 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.

See Also

C]MPI_PutR](3)


Table of Contents

« Return to documentation listing