73 lines
2.9 KiB
HTML
73 lines
2.9 KiB
HTML
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML3.2 EN">
|
|
<HTML>
|
|
<HEAD>
|
|
<META NAME="GENERATOR" CONTENT="DOCTEXT">
|
|
<TITLE>MPI_Address</TITLE>
|
|
</HEAD>
|
|
<BODY BGCOLOR="FFFFFF">
|
|
<A NAME="MPI_Address"><H1>MPI_Address</H1></A>
|
|
Gets the address of a location in memory
|
|
<H2>Synopsis</H2>
|
|
<PRE>
|
|
int MPI_Address(void *location, MPI_Aint *address)
|
|
</PRE>
|
|
<H2>Input Parameters</H2>
|
|
<DL><DT><B>location </B> <DD> location in caller memory (choice)
|
|
</DL>
|
|
<P>
|
|
<H2>Output Parameters</H2>
|
|
<DL><DT><B>address </B> <DD> address of location (address integer)
|
|
</DL>
|
|
<P>
|
|
<H2>Note</H2>
|
|
This routine is provided for both the Fortran and C programmers.
|
|
On many systems, the address returned by this routine will be the same
|
|
as produced by the C <tt>&</tt> operator, but this is not required in C and
|
|
may not be true of systems with word- rather than byte-oriented
|
|
instructions or systems with segmented address spaces.
|
|
<P>
|
|
<H2>Thread and Interrupt Safety</H2>
|
|
<P>
|
|
This routine is both thread- and interrupt-safe.
|
|
This means that this routine may safely be used by multiple threads and
|
|
from within a signal handler.
|
|
<P>
|
|
<H2>Deprecated Function</H2>
|
|
The MPI-2 standard deprecated a number of routines because MPI-2 provides
|
|
better versions. This routine is one of those that was deprecated. The
|
|
routine may continue to be used, but new code should use the replacement
|
|
routine.
|
|
The replacement for this routine is <tt>MPI_Get_address</tt>.
|
|
<P>
|
|
<H2>Notes for Fortran</H2>
|
|
All MPI routines in Fortran (except for <tt>MPI_WTIME</tt> and <tt>MPI_WTICK</tt>) have
|
|
an additional argument <tt>ierr</tt> at the end of the argument list. <tt>ierr
|
|
</tt>is an integer and has the same meaning as the return value of the routine
|
|
in C. In Fortran, MPI routines are subroutines, and are invoked with the
|
|
<tt>call</tt> statement.
|
|
<P>
|
|
All MPI objects (e.g., <tt>MPI_Datatype</tt>, <tt>MPI_Comm</tt>) are of type <tt>INTEGER
|
|
</tt>in Fortran.
|
|
<P>
|
|
<H2>Errors</H2>
|
|
<P>
|
|
All MPI routines (except <tt>MPI_Wtime</tt> and <tt>MPI_Wtick</tt>) return an error value;
|
|
C routines as the value of the function and Fortran routines in the last
|
|
argument. Before the value is returned, the current MPI error handler is
|
|
called. By default, this error handler aborts the MPI job. The error handler
|
|
may be changed with <tt>MPI_Comm_set_errhandler</tt> (for communicators),
|
|
<tt>MPI_File_set_errhandler</tt> (for files), and <tt>MPI_Win_set_errhandler</tt> (for
|
|
RMA windows). The MPI-1 routine <tt>MPI_Errhandler_set</tt> may be used but
|
|
its use is deprecated. The predefined error handler
|
|
<tt>MPI_ERRORS_RETURN</tt> may be used to cause error values to be returned.
|
|
Note that MPI does <em>not</em> guarentee that an MPI program can continue past
|
|
an error; however, MPI implementations will attempt to continue whenever
|
|
possible.
|
|
<P>
|
|
<DL><DT><B>MPI_SUCCESS </B> <DD> No error; MPI routine completed successfully.
|
|
</DL>
|
|
<DL><DT><B>MPI_ERR_OTHER </B> <DD> Other error; use <tt>MPI_Error_string</tt> to get more information
|
|
about this error code.
|
|
</DL>
|
|
</BODY></HTML>
|