 |
3.1-rc3 (revision d9ca08bb)
|
This defines the callbacks for the snap reader. More...
#include <stdint.h>#include <otf2/OTF2_ErrorCodes.h>#include <otf2/OTF2_GeneralDefinitions.h>#include <otf2/OTF2_AttributeList.h>#include <otf2/OTF2_Events.h>Go to the source code of this file.
Typedefs | |
| typedef struct OTF2_SnapReaderCallbacks_struct | OTF2_SnapReaderCallbacks |
| Opaque struct which holds all snap event record callbacks. More... | |
| typedef OTF2_CallbackCode(* | OTF2_SnapReaderCallback_Unknown) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList) |
| Callback for an unknown snap event record. More... | |
| typedef OTF2_CallbackCode(* | OTF2_SnapReaderCallback_SnapshotStart) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, uint64_t numberOfRecords) |
| Callback for the SnapshotStart snap event record. More... | |
| typedef OTF2_CallbackCode(* | OTF2_SnapReaderCallback_SnapshotEnd) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, uint64_t contReadPos) |
| Callback for the SnapshotEnd snap event record. More... | |
| typedef OTF2_CallbackCode(* | OTF2_SnapReaderCallback_MeasurementOnOff) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, OTF2_MeasurementMode measurementMode) |
| Callback for the MeasurementOnOff snap event record. More... | |
| typedef OTF2_CallbackCode(* | OTF2_SnapReaderCallback_Enter) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, OTF2_RegionRef region) |
| Callback for the Enter snap event record. More... | |
| typedef OTF2_CallbackCode(* | OTF2_SnapReaderCallback_MpiSend) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, uint32_t receiver, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength) |
| Callback for the MpiSend snap event record. More... | |
| typedef OTF2_CallbackCode(* | OTF2_SnapReaderCallback_MpiIsend) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, uint32_t receiver, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength, uint64_t requestID) |
| Callback for the MpiIsend snap event record. More... | |
| typedef OTF2_CallbackCode(* | OTF2_SnapReaderCallback_MpiIsendComplete) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, uint64_t requestID) |
| Callback for the MpiIsendComplete snap event record. More... | |
| typedef OTF2_CallbackCode(* | OTF2_SnapReaderCallback_MpiRecv) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, uint32_t sender, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength) |
| Callback for the MpiRecv snap event record. More... | |
| typedef OTF2_CallbackCode(* | OTF2_SnapReaderCallback_MpiIrecvRequest) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, uint64_t requestID) |
| Callback for the MpiIrecvRequest snap event record. More... | |
| typedef OTF2_CallbackCode(* | OTF2_SnapReaderCallback_MpiIrecv) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, uint32_t sender, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength, uint64_t requestID) |
| Callback for the MpiIrecv snap event record. More... | |
| typedef OTF2_CallbackCode(* | OTF2_SnapReaderCallback_MpiCollectiveBegin) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime) |
| Callback for the MpiCollectiveBegin snap event record. More... | |
| typedef OTF2_CallbackCode(* | OTF2_SnapReaderCallback_MpiCollectiveEnd) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, OTF2_CollectiveOp collectiveOp, OTF2_CommRef communicator, uint32_t root, uint64_t sizeSent, uint64_t sizeReceived) |
| Callback for the MpiCollectiveEnd snap event record. More... | |
| typedef OTF2_CallbackCode(* | OTF2_SnapReaderCallback_OmpFork) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, uint32_t numberOfRequestedThreads) |
| Callback for the OmpFork snap event record. More... | |
| typedef OTF2_CallbackCode(* | OTF2_SnapReaderCallback_OmpAcquireLock) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, uint32_t lockID, uint32_t acquisitionOrder) |
| Callback for the OmpAcquireLock snap event record. More... | |
| typedef OTF2_CallbackCode(* | OTF2_SnapReaderCallback_OmpTaskCreate) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, uint64_t taskID) |
| Callback for the OmpTaskCreate snap event record. More... | |
| typedef OTF2_CallbackCode(* | OTF2_SnapReaderCallback_OmpTaskSwitch) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, uint64_t taskID) |
| Callback for the OmpTaskSwitch snap event record. More... | |
| typedef OTF2_CallbackCode(* | OTF2_SnapReaderCallback_Metric) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, OTF2_MetricRef metric, uint8_t numberOfMetrics, const OTF2_Type *typeIDs, const OTF2_MetricValue *metricValues) |
| Callback for the Metric snap event record. More... | |
| typedef OTF2_CallbackCode(* | OTF2_SnapReaderCallback_ParameterString) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, OTF2_ParameterRef parameter, OTF2_StringRef string) |
| Callback for the ParameterString snap event record. More... | |
| typedef OTF2_CallbackCode(* | OTF2_SnapReaderCallback_ParameterInt) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, OTF2_ParameterRef parameter, int64_t value) |
| Callback for the ParameterInt snap event record. More... | |
| typedef OTF2_CallbackCode(* | OTF2_SnapReaderCallback_ParameterUnsignedInt) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, OTF2_ParameterRef parameter, uint64_t value) |
| Callback for the ParameterUnsignedInt snap event record. More... | |
This defines the callbacks for the snap reader.
| typedef struct OTF2_SnapReaderCallbacks_struct OTF2_SnapReaderCallbacks |
Opaque struct which holds all snap event record callbacks.
| typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_Unknown) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList) |
Callback for an unknown snap event record.
| location | The location where this event happened. |
| time | Snapshot time. |
| userData | User data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks. |
| attributeList | Additional attributes for this event. |
| typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_SnapshotStart) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, uint64_t numberOfRecords) |
Callback for the SnapshotStart snap event record.
This record marks the start of a snapshot.
A snapshot consists of a timestamp and a set of snapshot records. All these snapshot records have the same snapshot time. A snapshot starts with one SnapshotStart record and closes with one SnapshotEnd record. All snapshot records inbetween are ordered by the origEventTime, which are also less than the snapshot timestamp. Ie. The timestamp of the next event read from the event stream is greater or equal to the snapshot time.
| location | The location where this snap happened. |
| snapTime | Snapshot time. |
| userData | User data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks. |
| attributeList | Additional attributes for this snap. |
| numberOfRecords | Number of snapshot event records in this snapshot. Excluding the SnapshotEnd record. |
| typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_SnapshotEnd) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, uint64_t contReadPos) |
Callback for the SnapshotEnd snap event record.
This record marks the end of a snapshot. It contains the position to continue reading in the event trace for this location. Use OTF2_EvtReader_Seek with contReadPos as the position.
| location | The location where this snap happened. |
| snapTime | Snapshot time. |
| userData | User data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks. |
| attributeList | Additional attributes for this snap. |
| contReadPos | Position to continue reading in the event trace. |
| typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_MeasurementOnOff) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, OTF2_MeasurementMode measurementMode) |
Callback for the MeasurementOnOff snap event record.
The last occurrence of a MeasurementOnOff event of this location, if any.
| location | The location where this snap happened. |
| snapTime | Snapshot time. |
| userData | User data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks. |
| attributeList | Additional attributes for this snap. |
| origEventTime | The original time this event happened. |
| measurementMode | Is the measurement turned on (OTF2_MEASUREMENT_ON) or off (OTF2_MEASUREMENT_OFF)? |
| typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_Enter) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, OTF2_RegionRef region) |
Callback for the Enter snap event record.
This record exists for each Enter event where the corresponding Leave event did not occur before the snapshot.
| location | The location where this snap happened. |
| snapTime | Snapshot time. |
| userData | User data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks. |
| attributeList | Additional attributes for this snap. |
| origEventTime | The original time this event happened. |
| region | Needs to be defined in a definition record References a Region definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_REGION is available. |
| typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_MpiSend) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, uint32_t receiver, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength) |
Callback for the MpiSend snap event record.
This record exists for each MpiSend event where the matching receive message event did not occur on the remote location before the snapshot. This could either be a MpiRecv or a MpiIrecv event. Note that it may so, that a previous MpiIsend with the same envelope than this one is neither completed not canceled yet, thus the matching receive may already occurred, but the matching couldn't be done yet.
| location | The location where this snap happened. |
| snapTime | Snapshot time. |
| userData | User data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks. |
| attributeList | Additional attributes for this snap. |
| origEventTime | The original time this event happened. |
| receiver | MPI rank of receiver in communicator. |
| communicator | Communicator ID. References a Comm, or a InterComm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available. |
| msgTag | Message tag |
| msgLength | Message length |
| typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_MpiIsend) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, uint32_t receiver, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength, uint64_t requestID) |
Callback for the MpiIsend snap event record.
This record exists for each MpiIsend event where a corresponding MpiIsendComplete or MpiRequestCancelled event did not occur on this location before the snapshot. Or the corresponding MpiIsendComplete did occurred (the MpiIsendCompleteSnap record exists in the snapshot) but the matching receive message event did not occur on the remote location before the snapshot. (This could either be anMpiRecv or a MpiIrecv event.)
| location | The location where this snap happened. |
| snapTime | Snapshot time. |
| userData | User data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks. |
| attributeList | Additional attributes for this snap. |
| origEventTime | The original time this event happened. |
| receiver | MPI rank of receiver in communicator. |
| communicator | Communicator ID. References a Comm, or a InterComm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available. |
| msgTag | Message tag |
| msgLength | Message length |
| requestID | ID of the related request |
| typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_MpiIsendComplete) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, uint64_t requestID) |
Callback for the MpiIsendComplete snap event record.
This record exists for each MpiIsend event where the corresponding MpiIsendComplete event occurred, but where the matching receive message event did not occur on the remote location before the snapshot. (This could either be a MpiRecv or a MpiIrecv event.) .
| location | The location where this snap happened. |
| snapTime | Snapshot time. |
| userData | User data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks. |
| attributeList | Additional attributes for this snap. |
| origEventTime | The original time this event happened. |
| requestID | ID of the related request |
| typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_MpiRecv) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, uint32_t sender, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength) |
Callback for the MpiRecv snap event record.
This record exists for each MpiRecv event where the matching send message event did not occur on the remote location before the snapshot. This could either be a MpiSend or a MpiIsendComplete event. Or a MpiIrecvRequest occurred before this event but the corresponding MpiIrecv event did not occurred before this snapshot. In this case the message matching couldn't performed yet, because the envelope of the ongoing MpiIrecvRequest is not yet known.
| location | The location where this snap happened. |
| snapTime | Snapshot time. |
| userData | User data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks. |
| attributeList | Additional attributes for this snap. |
| origEventTime | The original time this event happened. |
| sender | MPI rank of sender in communicator. |
| communicator | Communicator ID. References a Comm, or a InterComm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available. |
| msgTag | Message tag |
| msgLength | Message length |
| typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_MpiIrecvRequest) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, uint64_t requestID) |
Callback for the MpiIrecvRequest snap event record.
This record exists for each MpiIrecvRequest event where an corresponding MpiIrecv or MpiRequestCancelled event did not occur on this location before the snapshot. Or the corresponding MpiIrecv did occurred (the MpiIrecvSnap record exists in the snapshot) but the matching receive message event did not occur on the remote location before the snapshot. This could either be an MpiRecv or a MpiIrecv event.
| location | The location where this snap happened. |
| snapTime | Snapshot time. |
| userData | User data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks. |
| attributeList | Additional attributes for this snap. |
| origEventTime | The original time this event happened. |
| requestID | ID of the requested receive |
| typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_MpiIrecv) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, uint32_t sender, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength, uint64_t requestID) |
Callback for the MpiIrecv snap event record.
This record exists for each MpiIrecv event where the matching send message event did not occur on the remote location before the snapshot. This could either be a MpiSend or a MpiIsendComplete event. Or a MpiIrecvRequest occurred before this event but the corresponding MpiIrecv event did not occurred before this snapshot. In this case the message matching couldn't performed yet, because the envelope of the ongoing MpiIrecvRequest is not yet known.
| location | The location where this snap happened. |
| snapTime | Snapshot time. |
| userData | User data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks. |
| attributeList | Additional attributes for this snap. |
| origEventTime | The original time this event happened. |
| sender | MPI rank of sender in communicator. |
| communicator | Communicator ID. References a Comm, or a InterComm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available. |
| msgTag | Message tag |
| msgLength | Message length |
| requestID | ID of the related request |
| typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_MpiCollectiveBegin) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime) |
Callback for the MpiCollectiveBegin snap event record.
Indicates that this location started a collective operation but not all of the participating locations completed the operation yet, including this location.
| location | The location where this snap happened. |
| snapTime | Snapshot time. |
| userData | User data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks. |
| attributeList | Additional attributes for this snap. |
| origEventTime | The original time this event happened. |
| typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_MpiCollectiveEnd) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, OTF2_CollectiveOp collectiveOp, OTF2_CommRef communicator, uint32_t root, uint64_t sizeSent, uint64_t sizeReceived) |
Callback for the MpiCollectiveEnd snap event record.
Indicates that this location completed a collective operation locally but not all of the participating locations completed the operation yet. The corresponding MpiCollectiveBeginSnap record is still in the snapshot though.
| location | The location where this snap happened. |
| snapTime | Snapshot time. |
| userData | User data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks. |
| attributeList | Additional attributes for this snap. |
| origEventTime | The original time this event happened. |
| collectiveOp | Determines which collective operation it is. |
| communicator | Communicator References a Comm, or a InterComm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available. |
| root | Rank of root in communicator or any predefined constant of OTF2_CollectiveRoot. |
| sizeSent | Size of the sent message. |
| sizeReceived | Size of the received message. |
| typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_OmpFork) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, uint32_t numberOfRequestedThreads) |
Callback for the OmpFork snap event record.
This record exists for each OmpFork event where the corresponding OmpJoin did not occurred before this snapshot.
| location | The location where this snap happened. |
| snapTime | Snapshot time. |
| userData | User data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks. |
| attributeList | Additional attributes for this snap. |
| origEventTime | The original time this event happened. |
| numberOfRequestedThreads | Requested size of the team. |
| typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_OmpAcquireLock) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, uint32_t lockID, uint32_t acquisitionOrder) |
Callback for the OmpAcquireLock snap event record.
This record exists for each OmpAcquireLock event where the corresponding OmpReleaseLock did not occurred before this snapshot yet.
| location | The location where this snap happened. |
| snapTime | Snapshot time. |
| userData | User data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks. |
| attributeList | Additional attributes for this snap. |
| origEventTime | The original time this event happened. |
| lockID | ID of the lock. |
| acquisitionOrder | A monotonically increasing number to determine the order of lock acquisitions (with unsynchronized clocks this is otherwise not possible). Corresponding acquire-release events have same number. |
| typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_OmpTaskCreate) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, uint64_t taskID) |
Callback for the OmpTaskCreate snap event record.
This record exists for each OmpTaskCreate event where the corresponding OmpTaskComplete event did not occurred before this snapshot. Neither on this location nor on any other location in the current thread team.
| location | The location where this snap happened. |
| snapTime | Snapshot time. |
| userData | User data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks. |
| attributeList | Additional attributes for this snap. |
| origEventTime | The original time this event happened. |
| taskID | Identifier of the newly created task instance. |
| typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_OmpTaskSwitch) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, uint64_t taskID) |
Callback for the OmpTaskSwitch snap event record.
This record exists for each OmpTaskSwitch event where the corresponding OmpTaskComplete event did not occurred before this snapshot. Neither on this location nor on any other location in the current thread team.
| location | The location where this snap happened. |
| snapTime | Snapshot time. |
| userData | User data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks. |
| attributeList | Additional attributes for this snap. |
| origEventTime | The original time this event happened. |
| taskID | Identifier of the now active task instance. |
| typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_Metric) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, OTF2_MetricRef metric, uint8_t numberOfMetrics, const OTF2_Type *typeIDs, const OTF2_MetricValue *metricValues) |
Callback for the Metric snap event record.
This record exists for each referenced metric class or metric instance event this location recorded metrics before and provides the last known recorded metric values.
As an exception for metric classes where the metric mode denotes an OTF2_METRIC_VALUE_RELATIVE mode the value indicates the accumulation of all previous metric values recorded.
| location | The location where this snap happened. |
| snapTime | Snapshot time. |
| userData | User data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks. |
| attributeList | Additional attributes for this snap. |
| origEventTime | The original time this event happened. |
| metric | Could be a metric class or a metric instance. References a MetricClass, or a MetricInstance definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_METRIC is available. |
| numberOfMetrics | Number of metrics with in the set. |
| typeIDs | List of metric types. These types must match that of the corresponding MetricMember definitions. |
| metricValues | List of metric values. |
| typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_ParameterString) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, OTF2_ParameterRef parameter, OTF2_StringRef string) |
Callback for the ParameterString snap event record.
This record must be included in the snapshot until the leave event for the enter event occurs which has the greatest timestamp less or equal the timestamp of this record.
| location | The location where this snap happened. |
| snapTime | Snapshot time. |
| userData | User data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks. |
| attributeList | Additional attributes for this snap. |
| origEventTime | The original time this event happened. |
| parameter | Parameter ID. References a Parameter definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_PARAMETER is available. |
| string | Value: Handle of a string definition References a String definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_STRING is available. |
| typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_ParameterInt) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, OTF2_ParameterRef parameter, int64_t value) |
Callback for the ParameterInt snap event record.
This record must be included in the snapshot until the leave event for the enter event occurs which has the greatest timestamp less or equal the timestamp of this record.
| location | The location where this snap happened. |
| snapTime | Snapshot time. |
| userData | User data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks. |
| attributeList | Additional attributes for this snap. |
| origEventTime | The original time this event happened. |
| parameter | Parameter ID. References a Parameter definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_PARAMETER is available. |
| value | Value of the recorded parameter. |
| typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_ParameterUnsignedInt) (OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp origEventTime, OTF2_ParameterRef parameter, uint64_t value) |
Callback for the ParameterUnsignedInt snap event record.
This record must be included in the snapshot until the leave event for the enter event occurs which has the greatest timestamp less or equal the timestamp of this record.
| location | The location where this snap happened. |
| snapTime | Snapshot time. |
| userData | User data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks. |
| attributeList | Additional attributes for this snap. |
| origEventTime | The original time this event happened. |
| parameter | Parameter ID. References a Parameter definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_PARAMETER is available. |
| value | Value of the recorded parameter. |
| OTF2_SnapReaderCallbacks* OTF2_SnapReaderCallbacks_New | ( | void | ) |
Allocates a new struct for the snap event callbacks.
| void OTF2_SnapReaderCallbacks_Delete | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks | ) |
Deallocates a struct for the snap event callbacks.
| snapReaderCallbacks | Handle to a struct previously allocated with OTF2_SnapReaderCallbacks_New. |
| void OTF2_SnapReaderCallbacks_Clear | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks | ) |
Clears a struct for the snapshot event callbacks.
| snapReaderCallbacks | Handle to a struct previously allocated with OTF2_SnapReaderCallbacks_New. |
| OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetUnknownCallback | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks, |
| OTF2_SnapReaderCallback_Unknown | unknownCallback | ||
| ) |
Registers the callback for the Unknown snap event.
| snapReaderCallbacks | Struct for all callbacks. |
| unknownCallback | Function which should be called for all unknown snap events. |
defReaderCallbacks argument | OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetSnapshotStartCallback | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks, |
| OTF2_SnapReaderCallback_SnapshotStart | snapshotStartCallback | ||
| ) |
Registers the callback for the SnapshotStart snap event.
| snapReaderCallbacks | Struct for all callbacks. |
| snapshotStartCallback | Function which should be called for all SnapshotStart definitions. |
defReaderCallbacks argument | OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetSnapshotEndCallback | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks, |
| OTF2_SnapReaderCallback_SnapshotEnd | snapshotEndCallback | ||
| ) |
Registers the callback for the SnapshotEnd snap event.
| snapReaderCallbacks | Struct for all callbacks. |
| snapshotEndCallback | Function which should be called for all SnapshotEnd definitions. |
defReaderCallbacks argument | OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMeasurementOnOffCallback | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks, |
| OTF2_SnapReaderCallback_MeasurementOnOff | measurementOnOffCallback | ||
| ) |
Registers the callback for the MeasurementOnOff snap event.
| snapReaderCallbacks | Struct for all callbacks. |
| measurementOnOffCallback | Function which should be called for all MeasurementOnOff definitions. |
defReaderCallbacks argument | OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetEnterCallback | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks, |
| OTF2_SnapReaderCallback_Enter | enterCallback | ||
| ) |
Registers the callback for the Enter snap event.
| snapReaderCallbacks | Struct for all callbacks. |
| enterCallback | Function which should be called for all Enter definitions. |
defReaderCallbacks argument | OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiSendCallback | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks, |
| OTF2_SnapReaderCallback_MpiSend | mpiSendCallback | ||
| ) |
Registers the callback for the MpiSend snap event.
| snapReaderCallbacks | Struct for all callbacks. |
| mpiSendCallback | Function which should be called for all MpiSend definitions. |
defReaderCallbacks argument | OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiIsendCallback | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks, |
| OTF2_SnapReaderCallback_MpiIsend | mpiIsendCallback | ||
| ) |
Registers the callback for the MpiIsend snap event.
| snapReaderCallbacks | Struct for all callbacks. |
| mpiIsendCallback | Function which should be called for all MpiIsend definitions. |
defReaderCallbacks argument | OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiIsendCompleteCallback | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks, |
| OTF2_SnapReaderCallback_MpiIsendComplete | mpiIsendCompleteCallback | ||
| ) |
Registers the callback for the MpiIsendComplete snap event.
| snapReaderCallbacks | Struct for all callbacks. |
| mpiIsendCompleteCallback | Function which should be called for all MpiIsendComplete definitions. |
defReaderCallbacks argument | OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiRecvCallback | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks, |
| OTF2_SnapReaderCallback_MpiRecv | mpiRecvCallback | ||
| ) |
Registers the callback for the MpiRecv snap event.
| snapReaderCallbacks | Struct for all callbacks. |
| mpiRecvCallback | Function which should be called for all MpiRecv definitions. |
defReaderCallbacks argument | OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiIrecvRequestCallback | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks, |
| OTF2_SnapReaderCallback_MpiIrecvRequest | mpiIrecvRequestCallback | ||
| ) |
Registers the callback for the MpiIrecvRequest snap event.
| snapReaderCallbacks | Struct for all callbacks. |
| mpiIrecvRequestCallback | Function which should be called for all MpiIrecvRequest definitions. |
defReaderCallbacks argument | OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiIrecvCallback | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks, |
| OTF2_SnapReaderCallback_MpiIrecv | mpiIrecvCallback | ||
| ) |
Registers the callback for the MpiIrecv snap event.
| snapReaderCallbacks | Struct for all callbacks. |
| mpiIrecvCallback | Function which should be called for all MpiIrecv definitions. |
defReaderCallbacks argument | OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiCollectiveBeginCallback | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks, |
| OTF2_SnapReaderCallback_MpiCollectiveBegin | mpiCollectiveBeginCallback | ||
| ) |
Registers the callback for the MpiCollectiveBegin snap event.
| snapReaderCallbacks | Struct for all callbacks. |
| mpiCollectiveBeginCallback | Function which should be called for all MpiCollectiveBegin definitions. |
defReaderCallbacks argument | OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiCollectiveEndCallback | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks, |
| OTF2_SnapReaderCallback_MpiCollectiveEnd | mpiCollectiveEndCallback | ||
| ) |
Registers the callback for the MpiCollectiveEnd snap event.
| snapReaderCallbacks | Struct for all callbacks. |
| mpiCollectiveEndCallback | Function which should be called for all MpiCollectiveEnd definitions. |
defReaderCallbacks argument | OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetOmpForkCallback | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks, |
| OTF2_SnapReaderCallback_OmpFork | ompForkCallback | ||
| ) |
Registers the callback for the OmpFork snap event.
| snapReaderCallbacks | Struct for all callbacks. |
| ompForkCallback | Function which should be called for all OmpFork definitions. |
defReaderCallbacks argument | OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetOmpAcquireLockCallback | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks, |
| OTF2_SnapReaderCallback_OmpAcquireLock | ompAcquireLockCallback | ||
| ) |
Registers the callback for the OmpAcquireLock snap event.
| snapReaderCallbacks | Struct for all callbacks. |
| ompAcquireLockCallback | Function which should be called for all OmpAcquireLock definitions. |
defReaderCallbacks argument | OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetOmpTaskCreateCallback | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks, |
| OTF2_SnapReaderCallback_OmpTaskCreate | ompTaskCreateCallback | ||
| ) |
Registers the callback for the OmpTaskCreate snap event.
| snapReaderCallbacks | Struct for all callbacks. |
| ompTaskCreateCallback | Function which should be called for all OmpTaskCreate definitions. |
defReaderCallbacks argument | OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetOmpTaskSwitchCallback | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks, |
| OTF2_SnapReaderCallback_OmpTaskSwitch | ompTaskSwitchCallback | ||
| ) |
Registers the callback for the OmpTaskSwitch snap event.
| snapReaderCallbacks | Struct for all callbacks. |
| ompTaskSwitchCallback | Function which should be called for all OmpTaskSwitch definitions. |
defReaderCallbacks argument | OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMetricCallback | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks, |
| OTF2_SnapReaderCallback_Metric | metricCallback | ||
| ) |
Registers the callback for the Metric snap event.
| snapReaderCallbacks | Struct for all callbacks. |
| metricCallback | Function which should be called for all Metric definitions. |
defReaderCallbacks argument | OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetParameterStringCallback | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks, |
| OTF2_SnapReaderCallback_ParameterString | parameterStringCallback | ||
| ) |
Registers the callback for the ParameterString snap event.
| snapReaderCallbacks | Struct for all callbacks. |
| parameterStringCallback | Function which should be called for all ParameterString definitions. |
defReaderCallbacks argument | OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetParameterIntCallback | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks, |
| OTF2_SnapReaderCallback_ParameterInt | parameterIntCallback | ||
| ) |
Registers the callback for the ParameterInt snap event.
| snapReaderCallbacks | Struct for all callbacks. |
| parameterIntCallback | Function which should be called for all ParameterInt definitions. |
defReaderCallbacks argument | OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetParameterUnsignedIntCallback | ( | OTF2_SnapReaderCallbacks * | snapReaderCallbacks, |
| OTF2_SnapReaderCallback_ParameterUnsignedInt | parameterUnsignedIntCallback | ||
| ) |
Registers the callback for the ParameterUnsignedInt snap event.
| snapReaderCallbacks | Struct for all callbacks. |
| parameterUnsignedIntCallback | Function which should be called for all ParameterUnsignedInt definitions. |
defReaderCallbacks argument