NAME

MPI_Address - Return an absolute address of a pointer

SYNOPSIS

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

INPUT PARAMETER

ptr - pointer to use as the address (pointer)

OUTPUT PARAMETER

addr - address relative to MPI_BOTTOM (integer)

DESCRIPTION

The MPI_Address() or MPI_Get_address() functions are 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() and MPI_Get_address() are aliases to each other. This is due to the MPI FORTRAN ABI incorrectly specifying the address as integer sized rather than MPI_Aint for MPI_Address(). Since this version of MPI currently does not support FORTRAN, the two functions are identical. MPI_Address() has been marked as depreciated by the MPI committee.

PMPI_Address() or PMPI_Get_address() are the profiling versions of this function.

ERRORS

All MPI routines except for MPI_Wtime and MPI_Wtick return an error value. The the current MPI error handler is invoked if this 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.

MPI_SUCCESS - No error;

MPI_ERR_ARG - Invalid address pointer.

SEE ALSO

MPI_Get_address (3)

• Lockless
• MPI Documentation
• MPI_Address