Blame www/www3/MPI_Get_address.html

Packit Service c5cf8c
Packit Service c5cf8c
<HTML>
Packit Service c5cf8c
<HEAD>
Packit Service c5cf8c
<META NAME="GENERATOR" CONTENT="DOCTEXT">
Packit Service c5cf8c
<TITLE>MPI_Get_address</TITLE>
Packit Service c5cf8c
</HEAD>
Packit Service c5cf8c
<BODY BGCOLOR="FFFFFF">
Packit Service c5cf8c

MPI_Get_address

Packit Service c5cf8c
Get the address of a location in memory 
Packit Service c5cf8c

Synopsis

Packit Service c5cf8c
Packit Service c5cf8c
int MPI_Get_address(const void *location, MPI_Aint * address)
Packit Service c5cf8c
Packit Service c5cf8c

Input Parameters

Packit Service c5cf8c
Packit Service c5cf8c
location
location in caller memory (choice)
Packit Service c5cf8c
Packit Service c5cf8c

Packit Service c5cf8c

Output Parameters

Packit Service c5cf8c
Packit Service c5cf8c
address
address of location (address integer)
Packit Service c5cf8c
Packit Service c5cf8c

Packit Service c5cf8c

Notes

Packit Service c5cf8c
This routine is provided for both the Fortran and C programmers.
Packit Service c5cf8c
On many systems, the address returned by this routine will be the same
Packit Service c5cf8c
as produced by the C <tt>&</tt> operator, but this is not required in C and
Packit Service c5cf8c
may not be true of systems with word- rather than byte-oriented
Packit Service c5cf8c
instructions or systems with segmented address spaces.
Packit Service c5cf8c

Packit Service c5cf8c
This routine should be used instead of <tt>MPI_Address</tt>.
Packit Service c5cf8c

Packit Service c5cf8c

Thread and Interrupt Safety

Packit Service c5cf8c

Packit Service c5cf8c
This routine is both thread- and interrupt-safe.
Packit Service c5cf8c
This means that this routine may safely be used by multiple threads and
Packit Service c5cf8c
from within a signal handler.
Packit Service c5cf8c

Packit Service c5cf8c

Notes for Fortran

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

Packit Service c5cf8c
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
Packit Service c5cf8c
</tt>in Fortran.
Packit Service c5cf8c

Packit Service c5cf8c
In Fortran, the integer type is always signed.  This can cause problems
Packit Service c5cf8c
on systems where the address fits into a four byte unsigned integer but
Packit Service c5cf8c
the value is larger than the largest signed integer.  For example, a system
Packit Service c5cf8c
with more than 2 GBytes of memory may have addresses that do not fit within
Packit Service c5cf8c
a four byte signed integer.  Unfortunately, there is no easy solution to
Packit Service c5cf8c
this problem, as there is no Fortran datatype that can be used here (using
Packit Service c5cf8c
a longer integer type will cause other problems, as well as surprising
Packit Service c5cf8c
users when the size of the integer type is larger that the size of a pointer
Packit Service c5cf8c
in C).  In this case, it is recommended that you use C to manipulate
Packit Service c5cf8c
addresses.
Packit Service c5cf8c

Packit Service c5cf8c

Errors

Packit Service c5cf8c

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

Packit Service c5cf8c
Packit Service c5cf8c
MPI_SUCCESS
No error; MPI routine completed successfully.
Packit Service c5cf8c
Packit Service c5cf8c
Packit Service c5cf8c
MPI_ERR_OTHER
Other error; use <tt>MPI_Error_string</tt> to get more information
Packit Service c5cf8c
about this error code. 
Packit Service c5cf8c
Packit Service c5cf8c
</BODY></HTML>