MPI_Get_address(3)

NAME
MPI_Get_address - Return an absolute address of a pointer

SYNOPSIS
#include <mpi.h>
int MPI_Get_adress(void *ptr, MPI_Aint *addr);

#include <pmpi.h>
int PMPI_Get_address(void *ptr, MPI_Aint *addr);

#include <mpi.h>
MPI::Aint MPI::Get_address(void *ptr);

INCLUDE 'mpif.h'
MPI_GET_ADDRESS(ptr, addr, ierr)
<type> ptr
INTEGER (KIND=MPI_ADDRESS_KIND) addr
INTEGER ierr

INPUT PARAMETER
ptr - pointer to use as the address (pointer)

OUTPUT PARAMETER
addr
    - address relative to MPI_BOTTOM (integer)

DESCRIPTION
The MPI_Get_address() function is used to obtain the absolute address pointed to by a pointer, ptr and store it in an address-sized integer, addr. Note that since MPI_BOTTOM is not NULL in this implementation, the address returned is not the result of casting the pointer to the MPI_Aint type. This implementation allows MPI to notice if a NULL pointer is accidentally used as a buffer and return the MPI_ERR_BUFFER error when needed. Note that MPI_Address() is a deprecated function that in FORTRAN uses a 32 bit integer to store the address. The remaining bits are truncated. The MPI_Get_address() function is able to store the full 64 bits in FORTRAN. The C++ version of this function passes the resulting address as the return value. PMPI_Get_address() is the profiling version of this function.

ERRORS
All MPI routines except for MPI_Wtime and MPI_Wtick return an error code. The the current MPI error handler is invoked if the return value is not MPI_SUCCESS. The default error handler aborts, but this may be changed with by using the MPI_Errhandler_set() function. The predefined error handler MPI_ERRORS_RETURN may be used to cause error values to be returned instead. Note that MPI does not guarentee that an MPI program can continue past an error. In this implementation, all errors except MPI_ERR_INTERN or MPI_ERR_OTHER should always be recoverable. In C, the error code is passed as the return value. In FORTRAN, all functions have an parameter ierr which returns the error code. MPI C++ functions do not directly return an error code. However, C++ users may want to use the MPI::ERRORS_THROW_EXCEPTIONS handler. This will throw an MPI::Exception with the corresponding error code. To prevent exceptions from being raised from within C and Fortran code, they will see all error return values as MPI_ERR_PENDING when this handler is chosen. In this implementation, call MPI::throw_exception() to throw the correct exception if this occurs.
MPI_SUCCESS
    - No error;
MPI_ERR_PENDING
    - Pending exception;
MPI_ERR_ARG
    - Invalid address pointer.

SEE ALSO
MPI_Get_address(3)