MPI_FILE_GET_POSITION_SHARED(3)

πŸŽ€ MPI_File_get_position_shared πŸŽ€

okay so bestie, welcome to MPI_FILE_GET_POSITION_SHARED(3) from Open MPI. yes it's a long name, no you don't have to be scared of it, I got you πŸ’–


✨ NAME ✨

MPI_File_get_position_shared β€” returns the current position of the shared file pointer 🫢


πŸ“œ SYNTAX πŸ“œ

C Syntax

#include <mpi.h>

int MPI_File_get_position_shared(MPI_File fh, MPI_Offset *offset)

Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_FILE_GET_POSITION_SHARED(FH, OFFSET, IERROR)
     INTEGER FH, IERROR
     INTEGER(KIND=MPI_OFFSET_KIND)   OFFSET

Fortran 2008 Syntax

USE mpi_f08
MPI_File_get_position_shared(fh, offset, ierror)
     TYPE(MPI_File), INTENT(IN) :: fh
     INTEGER(KIND=MPI_OFFSET_KIND), INTENT(OUT) :: offset
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

🌸 INPUT PARAMETER 🌸

  • fh β€” the file handle (handle). yes literally just the handle, that's the whole vibe πŸ¦‹

πŸ’– OUTPUT PARAMETERS πŸ’–

  • offset β€” offset of the shared file pointer (integer).
  • ierror β€” Fortran only: error status (integer).

πŸ’… DESCRIPTION πŸ’…

MPI_File_get_position_shared returns, in offset, the current position of the shared file pointer in etype units relative to the current displacement and file type. that's it, that's the whole thing, and it ate ✨


😭 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 duality, we love to see it πŸ™ˆ

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.

Open MPI includes three predefined error handlers that can be used:

  • MPI_ERRORS_ARE_FATAL β€” causes the program to abort all connected MPI processes. dramatic, but make it official πŸ’€
  • 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 if MPI_Abort was called on that communicator. If called on a window or file, acts as if MPI_Abort was 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.

MPI applications can also implement their own error handlers by calling:

  • MPI_Comm_create_errhandler then MPI_Comm_set_errhandler
  • MPI_File_create_errhandler then MPI_File_set_errhandler
  • MPI_Session_create_errhandler then MPI_Session_set_errhandler or at MPI_Session_init
  • MPI_Win_create_errhandler then MPI_Win_set_errhandler

Note that MPI does not guarantee that an MPI program can continue past an error.

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.


2003-2026, The Open MPI Community


okay that's the whole page, you're officially educated πŸ’œ one last lil sign-off: this was MPI_FILE_GET_POSITION_SHARED(3), dated Sep 10, 2026, straight from the Open MPI girlies. go get that shared file pointer position, bestie, you're the main character 🌈⭐

πŸ“¦ where this page comes from