Open MPI logo

MPI_Get_address(3) man page (version 5.0.0rc2)

  |   Home   |   Support   |   FAQ   |  

« Return to documentation listing

Table of Contents

Name

C]MPI_Get_addressR] - Gets the address of a location in memory.

Syntax

C Syntax



C]#include <mpi.h>int MPI_Get_address(const void *location, MPI_Aint *address)R]Fortran Syntax



C]USE MPI! or the older form: INCLUDE [aq]mpif.h[aq]MPI_GET_ADDRESS(LOCATION, ADDRESS, IERROR) <type> LOCATION(*) INTEGER(KIND=MPI_ADDRESS_KIND) ADDRESS INTEGER IERRORR]Fortran 2008 Syntax



C]USE mpi_f08MPI_Get_address(location, address, ierror) TYPE(*), DIMENSION(..), ASYNCHRONOUS :: location INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(OUT) :: address INTEGER, OPTIONAL, INTENT(OUT) :: ierrorR]Input Parameters

[bu]
C]locationR] : Location in caller memory (choice).

Output Parameters

[bu]
C]addressR] : Address of location (integer).
[bu]
C]IERRORR] : Fortran only: Error status (integer).

Description

C]MPI_Get_addressR] returns the byte C]addressR] of a location in memory.

Example: Using C]MPI_Get_addressR] for an array.


C]EAL A(100,100) INTEGER I1, I2, DIFF CALL MPI_GET_ADDRESS(A(1,1), I1, IERROR) CALL MPI_GET_ADDRESS(A(10,10), I2, IERROR) DIFF = I2 - I1! The value of DIFF is 909*sizeofreal; the values of I1 and I2 are! implementation dependent.R]Notes

Current Fortran MPI codes will run unmodified and will port to any
system. However, they may fail if C]addressesR] larger than 2[ha]32 - 1 are used in the program. New codes should be written so that they use the new functions. This provides compatibility with C and avoids errors on 64-bit architectures. However, such newly written codes may need to be (slightly) rewritten to port to old Fortran 77 environments that do not support KIND declarations.

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.


Table of Contents

« Return to documentation listing