Synopsis
int MPI_T_event_read(MPI_T_event_instance event_instance, int element_index,
void *buffer)
Input Parameters
- event_instance
-
event-instance handle provided to the callback function (handle)
- element_index
-
index into the array of datatypes of the item to be queried (integer)
Output Parameters
- buffer
-
pointer to a memory location to store the item data (choice)
Description
MPI_T_event_read copies one element of event data to a user-specified buffer.
This routine has local semantics and must be called from within an event callback function. The event_instance argument identifies the event instance to query; it is erroneous to provide any event-instance handle other than the one passed by the MPI implementation to the callback function. The buffer argument must point to a memory location where the MPI implementation can copy the element of event data identified by element_index. When called inside a callback, the actions permitted are restricted by callback safety levels such as MPI_T_CB_REQUIRE_MPI_RESTRICTED or MPI_T_CB_REQUIRE_THREAD_SAFE.
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 - Invalid use of the interface or bad parameter values(s).
-
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.