MPI_TYPE_COMMIT(3)
π MPI_Type_commit π
okay bestie, welcome to the Open MPI manual page for MPI_Type_commit β this is literally the moment your fancy custom datatype goes from "cute idea" to "actually usable" π
β¨
β¨ SYNTAX β¨
π C Syntax
#include <mpi.h>
int MPI_Type_commit(MPI_Datatype *datatype)
π Fortran Syntax
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_TYPE_COMMIT(DATATYPE, IERROR)
INTEGER DATATYPE, IERROR
π Fortran 2008 Syntax
USE mpi_f08
MPI_Type_commit(datatype, ierror)
TYPE(MPI_Datatype), INTENT(INOUT) :: datatype
INTEGER, OPTIONAL, INTENT(OUT) :: ierror
πΈ INPUT PARAMETER πΈ
datatypeβ your datatype handle, aka the little guy you built and now want to make official π«Ά
π¦ OUTPUT PARAMETER π¦
ierrorβ Fortran only: the error status, as an integer. slay, Fortran stays keeping receipts π
π DESCRIPTION π
so the commit operation commits the data type, which is the whole point. and here's the vibe check you need to internalize: a data type is the formal description of a communication buffer, NOT the content of that buffer. like, it's the blueprint, not the house π β¨
once a data type has been committed, you can reuse it over and over again β to communicate the changing content of a buffer, or honestly the content of completely different buffers with different starting addresses. it's giving reusable tote bag energy, no cap β»οΈ
Example: the following Fortran code fragment gives examples of using MPI_Type_commit.
INTEGER :: type1, type2
CALL MPI_TYPE_CONTIGUOUS(5, MPI_REAL, type1, ierr)
! new type object created
CALL MPI_TYPE_COMMIT(type1, ierr)
! now type1 can be used for communication
and the iconique little detail: if the data type specified in datatype is already committed, it's equivalent to a no-op. literally nothing happens. it's fine. go off π
π ERRORS π
almost all MPI routines return an error value β the C routines hand it back as the return result of the function, and the Fortran routines put it in the last argument. iykyk π₯
before that error value gets returned, the current MPI error handler associated with the communication object (e.g., communicator, window, file) is called. and if there's no communication object associated with the MPI call? then the call is considered attached to MPI_COMM_SELF and it'll 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. phew, still with me? π«
the initial error handler can be changed by:
- calling
MPI_Comm_set_errhandleronMPI_COMM_SELFwhen using the World model, or - the
mpi_initial_errhandlerCLI argument tompiexec, or - the 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. them's the rules β
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. 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. versatile queen πMPI_ERRORS_RETURNβ Returns an error code to the application. the chill one π«Ά
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
β οΈ note that MPI does not guarantee that an MPI program can continue past an error. no cap, fr fr β plan accordingly π
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
and that's the whole page, bestie β you're officially certified to commit datatypes π this was the Open MPI MPI_TYPE_COMMIT(3) manual page, dated Sep 11, 2026, brought to you by The Open MPI Community (copyright 2003-2026). go forth and communicate π§ββοΈβ¨π
π¦ 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