Synopsis

int MPI_T_event_register_callback(MPI_T_event_registration event_registration,
                                  MPI_T_cb_safety cb_safety, MPI_Info info,
                                  void *user_data,
                                  MPI_T_event_cb_function event_cb_function)

Input Parameters

event_registration

event registration (handle)

cb_safety

maximum callback safety level (integer)

info

info object (handle)

user_data

pointer to a user-controlled buffer (None)

event_cb_function

pointer to user-defined callback function (function)

Description

MPI_T_event_register_callback associates a user-defined callback function with an allocated event-registration handle for a specified callback safety level.

This routine has local semantics. Multiple callback functions may be registered for a given event-registration handle, one for each callback safety level. Registering a callback function for a specific callback safety level overwrites any previously-registered callback function and info object for that level; if event_cb_function is NULL, an existing association for that callback safety level is removed. When an event is triggered, the implementation selects the callback with the lowest safety level valid in the invocation context. If the required callback safety level exceeds the highest level for which a callback is registered, the event instance is dropped. To avoid dropped events, the callback with the highest safety guarantees is recommended to be registered before registering callbacks for lower safety levels.

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_ERR_INFO - Invalid Info

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