17.2.231. MPI_Init

MPI_Init — Initializes the MPI world model

17.2.231.1. SYNTAX

17.2.231.1.1. C Syntax

#include <mpi.h>

int MPI_Init(int *argc, char ***argv)

17.2.231.1.2. Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_INIT(IERROR)
     INTEGER IERROR

17.2.231.1.3. Fortran 2008 Syntax

USE mpi_f08
MPI_Init(ierror)
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

17.2.231.2. INPUT PARAMETERS

  • argc: C only: Pointer to the number of arguments.

  • argv: C only: Argument vector.

17.2.231.3. OUTPUT PARAMETER

  • ierror: Fortran only: Error status (integer).

17.2.231.4. DESCRIPTION

This routine, or MPI_Init_thread, initializes the MPI world model. Either of these routines must be called before MPI communication routines are called within the MPI world model. The MPI world model can be initialized at most exactly once in the lifetime of an MPI process. This is different than the MPI session model, which can be initialized and finalized multiple times in an MPI process. See MPI_Session_init and MPI_Session_finalize.

See MPI-5.0:11.4.1 for a list of MPI functionality that is available (e.g., even when the MPI world model has not yet initialized or has already been finalized).

Open MPI’s MPI_Init and MPI_Init_thread both accept the C argc and argv arguments to main, but neither modifies, interprets, nor distributes them:

#include <mpi.h>

int main(int argv, char *argv[]) {
    MPI_Init(&argc, &argv);
    /* ...body of main MPI pogram... */
    MPI_Finalize();
    return 0;
}

By default, MPI_Init is effectively equivalent to invoking MPI_Init_thread with a required value of MPI_THREAD_SINGLE. However, if the OMPI_MPI_THREAD_LEVEL environment variable is set to a valid value when MPI_Init is invoked, it is equivalent to invoking MPI_Init_thread with required set to the corresponding value of the OMPI_MPI_THREAD_LEVEL environment variable. See MPI_Init_thread for more details.

17.2.231.5. NOTES

The Fortran version does not have provisions for argc and argv and takes only IERROR.

The MPI Standard does not specify what a program using the MPI world model can do before invoking MPI_Init or MPI_Init_thread or after invoking MPI_Finalize. In the Open MPI implementation, it should do as little as possible. In particular, avoid anything that changes the external state of the program, such as opening files, reading standard input, or writing to standard output.

17.2.231.6. 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.

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.

  • 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:

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.

See also