MPI_Comm_free_keyval - Frees attribute key for communicator cache attribute.
22.214.171.124.1. C Syntax
#include <mpi.h> int MPI_Comm_free_keyval(int *comm_keyval)
126.96.36.199.2. Fortran Syntax
USE MPI ! or the older form: INCLUDE 'mpif.h' MPI_COMM_FREE_KEYVAL(COMM_KEYVAL, IERROR) INTEGER COMM_KEYVAL, IERROR
188.8.131.52.3. Fortran 2008 Syntax
USE mpi_f08 MPI_Comm_free_keyval(comm_keyval, ierror) INTEGER, INTENT(INOUT) :: comm_keyval INTEGER, OPTIONAL, INTENT(OUT) :: ierror
184.108.40.206. INPUT/OUTPUT PARAMETER
220.127.116.11. OUTPUT PARAMETER
IERROR: Fortran only: Error status (integer).
MPI_Comm_free_keyval frees an extant attribute key. This function sets the value of keyval to MPI_KEYVAL_INVALID. Note that it is not erroneous to free an attribute key that is in use, because the actual free does not transpire until after all references (in other communicators on the process) to the key have been freed. These references need to be explicitly freed by the program, either via calls to MPI_Comm_delete_attr that free one attribute instance, or by calls to MPI_Comm_free that free all attribute instances associated with the freed communicator.
Key values are global (they can be used with any and all communicators).
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.
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.