|
| 1 | +# MPI_T Events Tests |
| 2 | + |
| 3 | +If the MPI implementation includes support for the MPI_T Events functions as defined in [MPI Standard 4.0](https://www.mpi-forum.org/docs/mpi-4.0/mpi40-report.pdf) and includes some implemented events, these tests will confirm basic functionality as well as some error checking. |
| 4 | + |
| 5 | +## Events Callback Test Requirements |
| 6 | +In order to confirm the MPI_T Events callback functionality, a callback must be registered and triggered by performing relevant MPI activity. |
| 7 | + |
| 8 | +The events_types test will print the list of events available by providing the command line '-l' flag. |
| 9 | + |
| 10 | +The events_callbacks event index can be set for the events_callbacks test with the `-i [number]` flag. |
| 11 | + |
| 12 | +If the default MPI activity in the function generate\_callback\_activity() in events_common.c does not trigger the event callback, custom MPI activity will need to be added. |
| 13 | + |
| 14 | +## Test Behavior |
| 15 | + |
| 16 | +The behavior of each test can be modified with the following command line arguments: |
| 17 | + |
| 18 | +- -d : print internal debugging messages [default: off] |
| 19 | +- -e : print error messages [default: off] |
| 20 | +- -f : perform failure tests [default: off] |
| 21 | +- -i [number] : event index for specific tests [default: 0] |
| 22 | +- -l : list available events (events_types only) [default: off] |
| 23 | + |
| 24 | +## Test Descriptions |
| 25 | + |
| 26 | +- events_callbacks |
| 27 | + - Register and free a callback function for an event |
| 28 | + - Get and set event handle and callback info |
| 29 | +- events_dropped |
| 30 | + - Register a callback function for dropped events |
| 31 | +- events\_meta_data |
| 32 | + - Get event timestamp and source |
| 33 | +- events\_read_data |
| 34 | + - Read and copy event data |
| 35 | +- events_source |
| 36 | + - Get number of source, source info object, and source timestamp |
| 37 | +- events_types |
| 38 | + - Get number of events and event info object |
| 39 | + |
| 40 | +## Event Callback and Read Data Example |
| 41 | +The events_example.c file has been provided as an example of registering an event callback and reading event data. |
| 42 | + |
| 43 | +## Test Suite And MPI Implementations |
| 44 | + |
| 45 | +Tested with [Open MPI PR #8057](https://github.com/open-mpi/ompi/pull/8057) with pml ob1 module events. |
0 commit comments