---
name: "MPI_Session_init.openmpi"
section: "3"
platform: "linux"
package: "openmpi-doc"
version: "5.0.7-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/MPI_Session_init.openmpi"
---

# MPI\_Session\_init.openmpi(3)

*MPI\_Session\_init* — Creates a new session handle

## SYNTAX

### C Syntax

```
#include <mpi.h>
int MPI_Session_init(MPI_Info info, MPI_Errhandler errhandler, MPI_Session *session)
```

### Fortran Syntax

```
USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_SESSION_INIT(INFO, ERRHANDLER, SESSION, IERROR)
    INTEGER INFO, ERRHANDLER, SESSION, IERROR
```

### Fortran 2008 Syntax

```
USE mpi_f08
MPI_Session_init(info, errhandler, session, ierror)
    TYPE(MPI_Info), INTENT(IN) :: info
    TYPE(MPI_Errhandler), INTENT(IN) :: errhandler
    TYPE(MPI_Session), INTENT(OUT) :: session
    INTEGER, OPTIONAL, INTENT(OUT) :: ierror
```

## INPUT PARAMETERS

- •

  **info** : info object (handle)

- •

  - **errhandler (error handler to be attached to the returned session)**

    (handle)

## OUTPUT PARAMETERS

- •

  **session** : New session (handle).

- •

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

## DESCRIPTION

*MPI\_Session\_init* is used to instantiate an MPI Session. The returned session handle can be used to query the runtime system about characteristics of the job within which the process is running, as well as other system resources. An application can make multiple calls to *MPI\_Session\_init* and the related *MPI\_Session\_finalize* routine.

## NOTES

The info argument is used to request MPI functionality requirements and possible MPI implementation specific capabilities.

The errhandler argument specifies an error handler to invoke in the event that the Session instantiation call encounters an error.

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

- •

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

**SEE ALSO:**

*MPI\_Session\_get\_num\_psets* MPI\_Session\_group\_from\_pset

## COPYRIGHT

2003-2025, The Open MPI Community