Synopsis

int MPI_T_event_handle_free(MPI_T_event_registration event_registration,
                            void *user_data,
                            MPI_T_event_free_cb_function free_cb_function)

Input Parameters

event_registration

event registration (handle)

user_data

pointer to a user-controlled buffer (None)

free_cb_function

pointer to user-defined callback function (function)

Description

MPI_T_event_handle_free initiates deallocation of an event-registration handle and stops the MPI implementation from raising events for that registration.

This routine has local semantics. The free_cb_function callback is invoked by the MPI implementation when it can guarantee that no further event instances for the corresponding event-registration handle will be raised. If free_cb_function is NULL, no user function is invoked after successful deallocation. The user_data pointer is passed to free_cb_function upon invocation. The function returns MPI_T_ERR_INVALID_HANDLE if event_registration does not match a valid allocated event-registration handle at the time of the call. A free-callback function associated with a registration handle may need to postpone pending actions if the provided callback safety requirements exceed those required by the pending actions.

Thread and Interrupt Safety

This routine is thread-safe. This means that this routine may be safely used by multiple threads without the need for any user-provided thread locks. However, the routine is not interrupt safe. Typically, this is due to the use of memory allocation routines such as 'malloc' or other non-MPICH runtime routines that are themselves not interrupt-safe.

Errors

All MPI routines (except 'MPI_Wtime' and 'MPI_Wtick') return an error value; C routines as the value of the function and Fortran routines in the last argument. Before the value is returned, the current MPI error handler is called. By default, this error handler aborts the MPI job. The error handler may be changed with 'MPI_Comm_set_errhandler' (for communicators), 'MPI_File_set_errhandler' (for files), and 'MPI_Win_set_errhandler' (for RMA windows). The MPI-1 routine 'MPI_Errhandler_set' may be used but its use is deprecated. The predefined error handler 'MPI_ERRORS_RETURN' may be used to cause error values to be returned. Note that MPI does not guarantee that an MPI program can continue past an error; however, MPI implementations will attempt to continue whenever possible.

  • MPI_SUCCESS - No error; MPI routine completed successfully.

  • MPI_T_ERR_INVALID_HANDLE - The handle is invalid.

  • MPI_T_ERR_NOT_INITIALIZED - The MPI tool information interface is not initialized.

  • MPI_ERR_OTHER - Other error; use 'MPI_Error_string' to get more information about this error code.