18.2.229. MPI_Info_set

MPI_Info_set - Adds a key/value pair to info.

18.2.229.1. SYNTAX

18.2.229.1.1. C Syntax

#include <mpi.h>

int MPI_Info_set(MPI_Info info, const char *key, const char *value)

18.2.229.1.2. Fortran Syntax

USE MPI
! or the older form: INCLUDE 'mpif.h'
MPI_INFO_SET(INFO, KEY, VALUE, IERROR)
     INTEGER         INFO, IERROR
     CHARACTER*(*)   KEY, VALUE

18.2.229.1.3. Fortran 2008 Syntax

USE mpi_f08
MPI_Info_set(info, key, value, ierror)
     TYPE(MPI_Info), INTENT(IN) :: info
     CHARACTER(LEN=*), INTENT(IN) :: key, value
     INTEGER, OPTIONAL, INTENT(OUT) :: ierror

18.2.229.2. INPUT/OUTPUT PARAMETER

  • info: Info object (handle).

18.2.229.3. INPUT PARAMETERS

  • key: Key (string).

  • value: Value (string).

18.2.229.4. OUTPUT PARAMETER

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

18.2.229.5. DESCRIPTION

MPI_Info_set adds the (key,value) pair to info and overrides the value if a value for the same key was previously set. The key and value parameters are null-terminated strings in C. In Fortran, leading and trailing spaces in key and value are stripped. If either key or value is larger than the allowed maximums, the error MPI_ERR_INFO_KEY or MPI_ERR_INFO_VALUE is raised, respectively.

18.2.229.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[_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.

In the sessions model, the error handler can be set during MPI_Session_init.

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.

Custom MPI error handlers can be created by calling: MPI_Comm_create_errhandler(3) MPI_File_create_errhandler(3) MPI_Session_create_errhandler(3) MPI_Win_create_errhandler(3)

Predefined and custom error handlers can be set by calling: MPI_Comm_set_errhandler(3) MPI_File_set_errhandler(3) MPI_Session_set_errhandler(3) MPI_Win_set_errhandler(3)

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 standard for more information.