MPI_INFO_FREE(3)
π MPI_Info_free β Open MPI man page, section 3 π
MPI_Info_free β frees an info object. That's the whole mission, bestie. π«Ά
β¨ SYNTAX β¨
πΈ C Syntax πΈ
#include <mpi.h>
int MPI_Info_free(MPI_Info *info)
π Fortran Syntax π
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_INFO_FREE(INFO, IERROR)
INTEGER INFO, IERROR
π¦ Fortran 2008 Syntax π¦
USE mpi_f08
MPI_Info_free(info, ierror)
TYPE(MPI_Info), INTENT(INOUT) :: info
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
π«Ά INPUT/OUTPUT PARAMETER π«Ά
infoβ info object (handle). This is the one getting freed, so yes, it's kind of the main character. π
π OUTPUT PARAMETER π
ierrorβ Fortran only: error status (integer). That's it. That's the whole parameter. β¨
π« DESCRIPTION π«
MPI_Info_free frees info and sets it to MPI_INFO_NULL. No cap, that's literally the description. β
π¨ 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. So in C, look at the return result; in Fortran, check the last argument. That's the tea. π
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? Yes. Accurate? 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. Simple as that. π«Ά
MPI applications can also implement their own error handlers by calling:
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
β οΈ Important caveat: MPI does not guarantee that an MPI program can continue past an error. Like, do not assume you can just keep it moving after an error. Nope. π
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.
π SEE ALSO π
MPI_Info_createMPI_Info_deleteMPI_Info_dupMPI_Info_getMPI_Info_set
Go read these too, bestie. iykyk. π¦
π COPYRIGHT π
2003-2026, The Open MPI Community β that's the copyright line, preserved with love. π«Ά
Signed off with Open MPI sparkle: page MPI_INFO_FREE(3), dated Sep 11, 2026. β¨ππ
π¦ 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