MPI_GET_ADDRESS(3)
π MPI_GET_ADDRESS(3) π
ok so bestie, welcome to the Open MPI manual page for MPI_Get_address β she's giving "where in memory does this live actually" and honestly she ate. π
πΈ NAME πΈ
MPI_Get_address β gets the address of a location in memory. literally just that. no cap. β¨
π¦ SYNTAX π¦
π C Syntax π
#include <mpi.h>
int MPI_Get_address(const void *location, MPI_Aint *address)
π Fortran Syntax π
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_GET_ADDRESS(LOCATION, ADDRESS, IERROR)
<type> LOCATION(*)
INTEGER(KIND=MPI_ADDRESS_KIND) ADDRESS
INTEGER IERROR
π§ Fortran 2008 Syntax π§
USE mpi_f08
MPI_Get_address(location, address, ierror)
TYPE(*), DIMENSION(..), ASYNCHRONOUS :: location
INTEGER(KIND=MPI_ADDRESS_KIND), INTENT(OUT) :: address
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
π INPUT PARAMETERS π
locationβ the location in the caller's memory, bestie. that's it. that's the vibe. (choice)
β OUTPUT PARAMETERS β
addressβ the address oflocation. iconic integer behavior. (integer)ierrorβ Fortran only, so like, C girlies can ignore this one. it's the error status. (integer)
π DESCRIPTION π
okay so MPI_Get_address returns the byte address of a location in memory. periodt. π«Ά
Example: using MPI_Get_address for an array β this is the moment, look at her go:
REAL :: A(100,100)
INTEGER(MPI_ADDRESS_KIND) :: 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.
like yes, DIFF is 909*sizeofreal, but the values of I1 and I2 are implementation dependent so don't come for me if they look different on your machine, that's just how it is π
π₯ NOTES π₯
- This routine is provided for both Fortran and C programmers and may be useful when writing portable code. she serves both communities, we love a bilingual queen π
- In the current release, the address returned by this routine will be the same as that produced by the C
&operator. (key detail, remember it) - C users may be tempted to avoid using
MPI_Get_addressand rely on the availability of the address operator&. Note, however, that&cast-expression is a pointer, not an address. π¨ - ANSI C does not require that the value of a pointer (or the pointer cast to
int) be the absolute address of the object pointed at β although this is commonly the case. so like, it usually is, but don't count on it. - Furthermore, referencing may not have a unique definition on machines with a segmented address space. π
- The use of
MPI_Get_addressto "reference" C variables guarantees portability to such machines as well. yes bestie, portability slay π
Current Fortran MPI codes will run unmodified and will port to any system. However, they may fail if addresses larger than 2^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
KINDdeclarations. like, annoying, but the tradeoff is real.
π ERRORS π
Almost all MPI routines return an error value; C routines as the return result of the function and Fortran routines in the last argument. classic.
Before the error value is returned, the current MPI error handler associated with the communication object (e.g., communicator, window, file) is called. If no communication object is associated with the MPI call, then the call is considered attached to MPI_COMM_SELF and will call the associated MPI error handler. When MPI_COMM_SELF is not initialized (i.e., before MPI_Init/MPI_Init_thread, after MPI_Finalize, or when using the Sessions Model exclusively) the error raises the initial error handler. The initial error handler can be changed by calling MPI_Comm_set_errhandler on MPI_COMM_SELF when using the World model, or the mpi_initial_errhandler CLI argument to mpiexec or info key to MPI_Comm_spawn/MPI_Comm_spawn_multiple. If no other appropriate error handler has been set, then the MPI_ERRORS_RETURN error handler is called for MPI I/O functions and the MPI_ERRORS_ABORT error handler is called for all other MPI functions. okay that was a lot, but every word matters π«‘
Open MPI includes three predefined error handlers that can be used β the holy trinity β¨:
MPI_ERRORS_ARE_FATALβ causes the program to abort all connected MPI processes. dramatic? yes. effective? also yes πMPI_ERRORS_ABORTβ an error handler that can be invoked on a communicator, window, file, or session. When called on a communicator, it acts as ifMPI_Abortwas called on that communicator. If called on a window or file, acts as ifMPI_Abortwas called on a communicator containing the group of processes in the corresponding window or file. If called on a session, aborts only the local process.MPI_ERRORS_RETURNβ returns an error code to the application. the chill one. π§
MPI applications can also implement their own error handlers by calling β DIY queen behavior π :
MPI_Comm_create_errhandlerthenMPI_Comm_set_errhandlerMPI_File_create_errhandlerthenMPI_File_set_errhandlerMPI_Session_create_errhandlerthenMPI_Session_set_errhandleror atMPI_Session_initMPI_Win_create_errhandlerthenMPI_Win_set_errhandler
Note that MPI does not guarantee that an MPI program can continue past an error. like, she might just be done. no promises. π
See the MPI man page for a full list of MPI error codes.
See the Error Handling section of the MPI-3.1 standard for more information.
π COPYRIGHT π
2003-2026, The Open MPI Community
ok that's the whole page bestie, you're officially fluent π and yes, this was brought to you on Sep 11, 2026 by the Open MPI girlies β MPI_GET_ADDRESS(3) out, love u, bye! π¦β¨
π¦ where this page comes from
- arch rolling: openmpi 5.0.11-1 Β· BSD-3-Clause AND LicenseRef-MPICH
- π girlified by deepseek-ai/DeepSeek-V4.1-Flash-1017 on : a language model's rewrite of the original, under its terms