1.5.1 (revision 4026)
Typedefs | Functions
otf2/OTF2_SnapReaderCallbacks.h File Reference

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 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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
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.
typedef OTF2_CallbackCode(* OTF2_SnapReaderCallback_Unknown )(OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList)
 Callback for an unknown snap event record.
typedef struct
OTF2_SnapReaderCallbacks_struct 
OTF2_SnapReaderCallbacks
 Opaque struct which holdes all snap event record callbacks.

Functions

void OTF2_SnapReaderCallbacks_Clear (OTF2_SnapReaderCallbacks *snapReaderCallbacks)
 Clears a struct for the sanp event callbacks.
void OTF2_SnapReaderCallbacks_Delete (OTF2_SnapReaderCallbacks *snapReaderCallbacks)
 Deallocates a struct for the snap event callbacks.
OTF2_SnapReaderCallbacksOTF2_SnapReaderCallbacks_New (void)
 Allocates a new struct for the snap event callbacks.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetEnterCallback (OTF2_SnapReaderCallbacks *snapReaderCallbacks, OTF2_SnapReaderCallback_Enter enterCallback)
 Registers the callback for the Enter snap event.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMeasurementOnOffCallback (OTF2_SnapReaderCallbacks *snapReaderCallbacks, OTF2_SnapReaderCallback_MeasurementOnOff measurementOnOffCallback)
 Registers the callback for the MeasurementOnOff snap event.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMetricCallback (OTF2_SnapReaderCallbacks *snapReaderCallbacks, OTF2_SnapReaderCallback_Metric metricCallback)
 Registers the callback for the Metric snap event.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiCollectiveBeginCallback (OTF2_SnapReaderCallbacks *snapReaderCallbacks, OTF2_SnapReaderCallback_MpiCollectiveBegin mpiCollectiveBeginCallback)
 Registers the callback for the MpiCollectiveBegin snap event.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiCollectiveEndCallback (OTF2_SnapReaderCallbacks *snapReaderCallbacks, OTF2_SnapReaderCallback_MpiCollectiveEnd mpiCollectiveEndCallback)
 Registers the callback for the MpiCollectiveEnd snap event.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiIrecvCallback (OTF2_SnapReaderCallbacks *snapReaderCallbacks, OTF2_SnapReaderCallback_MpiIrecv mpiIrecvCallback)
 Registers the callback for the MpiIrecv snap event.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiIrecvRequestCallback (OTF2_SnapReaderCallbacks *snapReaderCallbacks, OTF2_SnapReaderCallback_MpiIrecvRequest mpiIrecvRequestCallback)
 Registers the callback for the MpiIrecvRequest snap event.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiIsendCallback (OTF2_SnapReaderCallbacks *snapReaderCallbacks, OTF2_SnapReaderCallback_MpiIsend mpiIsendCallback)
 Registers the callback for the MpiIsend snap event.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiIsendCompleteCallback (OTF2_SnapReaderCallbacks *snapReaderCallbacks, OTF2_SnapReaderCallback_MpiIsendComplete mpiIsendCompleteCallback)
 Registers the callback for the MpiIsendComplete snap event.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiRecvCallback (OTF2_SnapReaderCallbacks *snapReaderCallbacks, OTF2_SnapReaderCallback_MpiRecv mpiRecvCallback)
 Registers the callback for the MpiRecv snap event.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiSendCallback (OTF2_SnapReaderCallbacks *snapReaderCallbacks, OTF2_SnapReaderCallback_MpiSend mpiSendCallback)
 Registers the callback for the MpiSend snap event.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetOmpAcquireLockCallback (OTF2_SnapReaderCallbacks *snapReaderCallbacks, OTF2_SnapReaderCallback_OmpAcquireLock ompAcquireLockCallback)
 Registers the callback for the OmpAcquireLock snap event.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetOmpForkCallback (OTF2_SnapReaderCallbacks *snapReaderCallbacks, OTF2_SnapReaderCallback_OmpFork ompForkCallback)
 Registers the callback for the OmpFork snap event.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetOmpTaskCreateCallback (OTF2_SnapReaderCallbacks *snapReaderCallbacks, OTF2_SnapReaderCallback_OmpTaskCreate ompTaskCreateCallback)
 Registers the callback for the OmpTaskCreate snap event.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetOmpTaskSwitchCallback (OTF2_SnapReaderCallbacks *snapReaderCallbacks, OTF2_SnapReaderCallback_OmpTaskSwitch ompTaskSwitchCallback)
 Registers the callback for the OmpTaskSwitch snap event.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetParameterIntCallback (OTF2_SnapReaderCallbacks *snapReaderCallbacks, OTF2_SnapReaderCallback_ParameterInt parameterIntCallback)
 Registers the callback for the ParameterInt snap event.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetParameterStringCallback (OTF2_SnapReaderCallbacks *snapReaderCallbacks, OTF2_SnapReaderCallback_ParameterString parameterStringCallback)
 Registers the callback for the ParameterString snap event.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetParameterUnsignedIntCallback (OTF2_SnapReaderCallbacks *snapReaderCallbacks, OTF2_SnapReaderCallback_ParameterUnsignedInt parameterUnsignedIntCallback)
 Registers the callback for the ParameterUnsignedInt snap event.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetSnapshotEndCallback (OTF2_SnapReaderCallbacks *snapReaderCallbacks, OTF2_SnapReaderCallback_SnapshotEnd snapshotEndCallback)
 Registers the callback for the SnapshotEnd snap event.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetSnapshotStartCallback (OTF2_SnapReaderCallbacks *snapReaderCallbacks, OTF2_SnapReaderCallback_SnapshotStart snapshotStartCallback)
 Registers the callback for the SnapshotStart snap event.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetUnknownCallback (OTF2_SnapReaderCallbacks *snapReaderCallbacks, OTF2_SnapReaderCallback_Unknown unknownCallback)
 Registers the callback for the Unknown snap event.

Detailed Description

This defines the callbacks for the snap reader.

Source Template:
templates/OTF2_SnapReaderCallbacks.tmpl.h

Typedef Documentation

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.

Parameters:
locationThe location where this snap happened.
snapTimeSnapshot time.
userDataUser data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks.
attributeListAdditional attributes for this snap.
origEventTimeThe original time this event happended.
regionNeeds 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.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
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 an MeasurementOnOff event of this location, if any.

Parameters:
locationThe location where this snap happened.
snapTimeSnapshot time.
userDataUser data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks.
attributeListAdditional attributes for this snap.
origEventTimeThe original time this event happended.
measurementModeIs the measurement turned on (OTF2_MEASUREMENT_ON) or off (OTF2_MEASUREMENT_OFF)?
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
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 detontes an OTF2_METRIC_VALUE_RELATIVE mode the value indicates the accumulation of all previous metric values recorded.

Parameters:
locationThe location where this snap happened.
snapTimeSnapshot time.
userDataUser data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks.
attributeListAdditional attributes for this snap.
origEventTimeThe original time this event happended.
metricCould 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.
numberOfMetricsNumber of metrics with in the set.
typeIDsList of metric types. These types must match that of the corresponding MetricMember definitions.
metricValuesList of metric values.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
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.

Parameters:
locationThe location where this snap happened.
snapTimeSnapshot time.
userDataUser data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks.
attributeListAdditional attributes for this snap.
origEventTimeThe original time this event happended.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
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 localy but not all of the participating locations completed the operation yet. The corresponding MpiCollectiveBeginSnap record is still in the snapshot though.

Parameters:
locationThe location where this snap happened.
snapTimeSnapshot time.
userDataUser data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks.
attributeListAdditional attributes for this snap.
origEventTimeThe original time this event happended.
collectiveOpDetermines which collective operation it is.
communicatorCommunicator References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
rootMPI rank of root in communicator.
sizeSentSize of the sent message.
sizeReceivedSize of the received message.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
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 an MpiSend or an MpiIsendComplete event. Or an 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.

Parameters:
locationThe location where this snap happened.
snapTimeSnapshot time.
userDataUser data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks.
attributeListAdditional attributes for this snap.
origEventTimeThe original time this event happended.
senderMPI rank of sender in communicator.
communicatorCommunicator ID. References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
msgTagMessage tag
msgLengthMessage length
requestIDID of the related request
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
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 an MpiIrecv event.

Parameters:
locationThe location where this snap happened.
snapTimeSnapshot time.
userDataUser data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks.
attributeListAdditional attributes for this snap.
origEventTimeThe original time this event happended.
requestIDID of the requested receive
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
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 an 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 an MpiIrecv event.)

Parameters:
locationThe location where this snap happened.
snapTimeSnapshot time.
userDataUser data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks.
attributeListAdditional attributes for this snap.
origEventTimeThe original time this event happended.
receiverMPI rank of receiver in communicator.
communicatorCommunicator ID. References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
msgTagMessage tag
msgLengthMessage length
requestIDID of the related request
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
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 an MpiRecv or an MpiIrecv event.) .

Parameters:
locationThe location where this snap happened.
snapTimeSnapshot time.
userDataUser data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks.
attributeListAdditional attributes for this snap.
origEventTimeThe original time this event happended.
requestIDID of the related request
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
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 an MpiSend or an MpiIsendComplete event. Or an 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.

Parameters:
locationThe location where this snap happened.
snapTimeSnapshot time.
userDataUser data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks.
attributeListAdditional attributes for this snap.
origEventTimeThe original time this event happended.
senderMPI rank of sender in communicator.
communicatorCommunicator ID. References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
msgTagMessage tag
msgLengthMessage length
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
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 an MpiRecv or an 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.

Parameters:
locationThe location where this snap happened.
snapTimeSnapshot time.
userDataUser data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks.
attributeListAdditional attributes for this snap.
origEventTimeThe original time this event happended.
receiverMPI rank of receiver in communicator.
communicatorCommunicator ID. References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
msgTagMessage tag
msgLengthMessage length
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
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.

Parameters:
locationThe location where this snap happened.
snapTimeSnapshot time.
userDataUser data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks.
attributeListAdditional attributes for this snap.
origEventTimeThe original time this event happended.
lockIDID of the lock.
acquisitionOrderA 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.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
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.

Parameters:
locationThe location where this snap happened.
snapTimeSnapshot time.
userDataUser data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks.
attributeListAdditional attributes for this snap.
origEventTimeThe original time this event happended.
numberOfRequestedThreadsRequested size of the team.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
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.

Parameters:
locationThe location where this snap happened.
snapTimeSnapshot time.
userDataUser data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks.
attributeListAdditional attributes for this snap.
origEventTimeThe original time this event happended.
taskIDIdentifier of the newly created task instance.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
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.

Parameters:
locationThe location where this snap happened.
snapTimeSnapshot time.
userDataUser data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks.
attributeListAdditional attributes for this snap.
origEventTimeThe original time this event happended.
taskIDIdentifier of the now active task instance.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
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 greates timestamp less or equal the timestamp of this record.

Parameters:
locationThe location where this snap happened.
snapTimeSnapshot time.
userDataUser data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks.
attributeListAdditional attributes for this snap.
origEventTimeThe original time this event happended.
parameterParameter ID. References a Parameter definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_PARAMETER is available.
valueValue of the recorded parameter.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
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 greates timestamp less or equal the timestamp of this record.

Parameters:
locationThe location where this snap happened.
snapTimeSnapshot time.
userDataUser data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks.
attributeListAdditional attributes for this snap.
origEventTimeThe original time this event happended.
parameterParameter ID. References a Parameter definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_PARAMETER is available.
stringValue: 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.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
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 greates timestamp less or equal the timestamp of this record.

Parameters:
locationThe location where this snap happened.
snapTimeSnapshot time.
userDataUser data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks.
attributeListAdditional attributes for this snap.
origEventTimeThe original time this event happended.
parameterParameter ID. References a Parameter definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_PARAMETER is available.
valueValue of the recorded parameter.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
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.

Parameters:
locationThe location where this snap happened.
snapTimeSnapshot time.
userDataUser data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks.
attributeListAdditional attributes for this snap.
contReadPosPosition to continue reading in the event trace.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
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 an 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.

Parameters:
locationThe location where this snap happened.
snapTimeSnapshot time.
userDataUser data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks.
attributeListAdditional attributes for this snap.
numberOfRecordsNumber of snapshot event records in this snapshot. Excluding the SnapshotEnd record.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_SnapReaderCallback_Unknown)(OTF2_LocationRef location, OTF2_TimeStamp snapTime, void *userData, OTF2_AttributeList *attributeList)

Callback for an unknown snap event record.

Parameters:
locationThe location where this event happened.
timeSnapshot time.
userDataUser data as set by OTF2_Reader_RegisterSnapCallbacks or OTF2_SnapReader_SetCallbacks.
attributeListAdditional attributes for this event.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef struct OTF2_SnapReaderCallbacks_struct OTF2_SnapReaderCallbacks

Opaque struct which holdes all snap event record callbacks.

Since:
Version 1.2

Function Documentation

void OTF2_SnapReaderCallbacks_Clear ( OTF2_SnapReaderCallbacks snapReaderCallbacks)

Clears a struct for the sanp event callbacks.

Parameters:
snapReaderCallbacksHandle to a struct previously allocated with OTF2_SnapReaderCallbacks_New.
Since:
Version 1.2
void OTF2_SnapReaderCallbacks_Delete ( OTF2_SnapReaderCallbacks snapReaderCallbacks)

Deallocates a struct for the snap event callbacks.

Parameters:
snapReaderCallbacksHandle to a struct previously allocated with OTF2_SnapReaderCallbacks_New.
Since:
Version 1.2
OTF2_SnapReaderCallbacks* OTF2_SnapReaderCallbacks_New ( void  )

Allocates a new struct for the snap event callbacks.

Since:
Version 1.2
Returns:
A newly allocated struct of type OTF2_SnapReaderCallbacks.
OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetEnterCallback ( OTF2_SnapReaderCallbacks snapReaderCallbacks,
OTF2_SnapReaderCallback_Enter  enterCallback 
)

Registers the callback for the Enter snap event.

Parameters:
snapReaderCallbacksStruct for all callbacks.
enterCallbackFunction which should be called for all Enter definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMeasurementOnOffCallback ( OTF2_SnapReaderCallbacks snapReaderCallbacks,
OTF2_SnapReaderCallback_MeasurementOnOff  measurementOnOffCallback 
)

Registers the callback for the MeasurementOnOff snap event.

Parameters:
snapReaderCallbacksStruct for all callbacks.
measurementOnOffCallbackFunction which should be called for all MeasurementOnOff definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMetricCallback ( OTF2_SnapReaderCallbacks snapReaderCallbacks,
OTF2_SnapReaderCallback_Metric  metricCallback 
)

Registers the callback for the Metric snap event.

Parameters:
snapReaderCallbacksStruct for all callbacks.
metricCallbackFunction which should be called for all Metric definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiCollectiveBeginCallback ( OTF2_SnapReaderCallbacks snapReaderCallbacks,
OTF2_SnapReaderCallback_MpiCollectiveBegin  mpiCollectiveBeginCallback 
)

Registers the callback for the MpiCollectiveBegin snap event.

Parameters:
snapReaderCallbacksStruct for all callbacks.
mpiCollectiveBeginCallbackFunction which should be called for all MpiCollectiveBegin definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiCollectiveEndCallback ( OTF2_SnapReaderCallbacks snapReaderCallbacks,
OTF2_SnapReaderCallback_MpiCollectiveEnd  mpiCollectiveEndCallback 
)

Registers the callback for the MpiCollectiveEnd snap event.

Parameters:
snapReaderCallbacksStruct for all callbacks.
mpiCollectiveEndCallbackFunction which should be called for all MpiCollectiveEnd definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiIrecvCallback ( OTF2_SnapReaderCallbacks snapReaderCallbacks,
OTF2_SnapReaderCallback_MpiIrecv  mpiIrecvCallback 
)

Registers the callback for the MpiIrecv snap event.

Parameters:
snapReaderCallbacksStruct for all callbacks.
mpiIrecvCallbackFunction which should be called for all MpiIrecv definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiIrecvRequestCallback ( OTF2_SnapReaderCallbacks snapReaderCallbacks,
OTF2_SnapReaderCallback_MpiIrecvRequest  mpiIrecvRequestCallback 
)

Registers the callback for the MpiIrecvRequest snap event.

Parameters:
snapReaderCallbacksStruct for all callbacks.
mpiIrecvRequestCallbackFunction which should be called for all MpiIrecvRequest definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiIsendCallback ( OTF2_SnapReaderCallbacks snapReaderCallbacks,
OTF2_SnapReaderCallback_MpiIsend  mpiIsendCallback 
)

Registers the callback for the MpiIsend snap event.

Parameters:
snapReaderCallbacksStruct for all callbacks.
mpiIsendCallbackFunction which should be called for all MpiIsend definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiIsendCompleteCallback ( OTF2_SnapReaderCallbacks snapReaderCallbacks,
OTF2_SnapReaderCallback_MpiIsendComplete  mpiIsendCompleteCallback 
)

Registers the callback for the MpiIsendComplete snap event.

Parameters:
snapReaderCallbacksStruct for all callbacks.
mpiIsendCompleteCallbackFunction which should be called for all MpiIsendComplete definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiRecvCallback ( OTF2_SnapReaderCallbacks snapReaderCallbacks,
OTF2_SnapReaderCallback_MpiRecv  mpiRecvCallback 
)

Registers the callback for the MpiRecv snap event.

Parameters:
snapReaderCallbacksStruct for all callbacks.
mpiRecvCallbackFunction which should be called for all MpiRecv definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetMpiSendCallback ( OTF2_SnapReaderCallbacks snapReaderCallbacks,
OTF2_SnapReaderCallback_MpiSend  mpiSendCallback 
)

Registers the callback for the MpiSend snap event.

Parameters:
snapReaderCallbacksStruct for all callbacks.
mpiSendCallbackFunction which should be called for all MpiSend definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetOmpAcquireLockCallback ( OTF2_SnapReaderCallbacks snapReaderCallbacks,
OTF2_SnapReaderCallback_OmpAcquireLock  ompAcquireLockCallback 
)

Registers the callback for the OmpAcquireLock snap event.

Parameters:
snapReaderCallbacksStruct for all callbacks.
ompAcquireLockCallbackFunction which should be called for all OmpAcquireLock definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetOmpForkCallback ( OTF2_SnapReaderCallbacks snapReaderCallbacks,
OTF2_SnapReaderCallback_OmpFork  ompForkCallback 
)

Registers the callback for the OmpFork snap event.

Parameters:
snapReaderCallbacksStruct for all callbacks.
ompForkCallbackFunction which should be called for all OmpFork definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetOmpTaskCreateCallback ( OTF2_SnapReaderCallbacks snapReaderCallbacks,
OTF2_SnapReaderCallback_OmpTaskCreate  ompTaskCreateCallback 
)

Registers the callback for the OmpTaskCreate snap event.

Parameters:
snapReaderCallbacksStruct for all callbacks.
ompTaskCreateCallbackFunction which should be called for all OmpTaskCreate definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetOmpTaskSwitchCallback ( OTF2_SnapReaderCallbacks snapReaderCallbacks,
OTF2_SnapReaderCallback_OmpTaskSwitch  ompTaskSwitchCallback 
)

Registers the callback for the OmpTaskSwitch snap event.

Parameters:
snapReaderCallbacksStruct for all callbacks.
ompTaskSwitchCallbackFunction which should be called for all OmpTaskSwitch definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetParameterIntCallback ( OTF2_SnapReaderCallbacks snapReaderCallbacks,
OTF2_SnapReaderCallback_ParameterInt  parameterIntCallback 
)

Registers the callback for the ParameterInt snap event.

Parameters:
snapReaderCallbacksStruct for all callbacks.
parameterIntCallbackFunction which should be called for all ParameterInt definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetParameterStringCallback ( OTF2_SnapReaderCallbacks snapReaderCallbacks,
OTF2_SnapReaderCallback_ParameterString  parameterStringCallback 
)

Registers the callback for the ParameterString snap event.

Parameters:
snapReaderCallbacksStruct for all callbacks.
parameterStringCallbackFunction which should be called for all ParameterString definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetParameterUnsignedIntCallback ( OTF2_SnapReaderCallbacks snapReaderCallbacks,
OTF2_SnapReaderCallback_ParameterUnsignedInt  parameterUnsignedIntCallback 
)

Registers the callback for the ParameterUnsignedInt snap event.

Parameters:
snapReaderCallbacksStruct for all callbacks.
parameterUnsignedIntCallbackFunction which should be called for all ParameterUnsignedInt definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetSnapshotEndCallback ( OTF2_SnapReaderCallbacks snapReaderCallbacks,
OTF2_SnapReaderCallback_SnapshotEnd  snapshotEndCallback 
)

Registers the callback for the SnapshotEnd snap event.

Parameters:
snapReaderCallbacksStruct for all callbacks.
snapshotEndCallbackFunction which should be called for all SnapshotEnd definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetSnapshotStartCallback ( OTF2_SnapReaderCallbacks snapReaderCallbacks,
OTF2_SnapReaderCallback_SnapshotStart  snapshotStartCallback 
)

Registers the callback for the SnapshotStart snap event.

Parameters:
snapReaderCallbacksStruct for all callbacks.
snapshotStartCallbackFunction which should be called for all SnapshotStart definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_SnapReaderCallbacks_SetUnknownCallback ( OTF2_SnapReaderCallbacks snapReaderCallbacks,
OTF2_SnapReaderCallback_Unknown  unknownCallback 
)

Registers the callback for the Unknown snap event.

Parameters:
snapReaderCallbacksStruct for all callbacks.
unknownCallbackFunction which should be called for all unknown snap events.
Since:
Version 1.2
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument