2.0 (revision 4408)
Typedefs | Functions
OTF2_EvtReaderCallbacks.h File Reference

This defines the callbacks for the event 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_EvtReaderCallbacks_struct OTF2_EvtReaderCallbacks
 Opaque struct which holds all event record callbacks.
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_Unknown) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList)
 Callback for an unknown event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_BufferFlush) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp stopTime)
 Callback for the BufferFlush event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_MeasurementOnOff) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_MeasurementMode measurementMode)
 Callback for the MeasurementOnOff event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_Enter) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RegionRef region)
 Callback for the Enter event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_Leave) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RegionRef region)
 Callback for the Leave event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_MpiSend) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint32_t receiver, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength)
 Callback for the MpiSend event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_MpiIsend) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint32_t receiver, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength, uint64_t requestID)
 Callback for the MpiIsend event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_MpiIsendComplete) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint64_t requestID)
 Callback for the MpiIsendComplete event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_MpiIrecvRequest) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint64_t requestID)
 Callback for the MpiIrecvRequest event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_MpiRecv) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint32_t sender, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength)
 Callback for the MpiRecv event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_MpiIrecv) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint32_t sender, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength, uint64_t requestID)
 Callback for the MpiIrecv event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_MpiRequestTest) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint64_t requestID)
 Callback for the MpiRequestTest event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_MpiRequestCancelled) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint64_t requestID)
 Callback for the MpiRequestCancelled event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_MpiCollectiveBegin) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList)
 Callback for the MpiCollectiveBegin event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_MpiCollectiveEnd) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CollectiveOp collectiveOp, OTF2_CommRef communicator, uint32_t root, uint64_t sizeSent, uint64_t sizeReceived)
 Callback for the MpiCollectiveEnd event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_OmpFork) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint32_t numberOfRequestedThreads)
 Callback for the OmpFork event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_OmpJoin) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList)
 Callback for the OmpJoin event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_OmpAcquireLock) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint32_t lockID, uint32_t acquisitionOrder)
 Callback for the OmpAcquireLock event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_OmpReleaseLock) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint32_t lockID, uint32_t acquisitionOrder)
 Callback for the OmpReleaseLock event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_OmpTaskCreate) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint64_t taskID)
 Callback for the OmpTaskCreate event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_OmpTaskSwitch) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint64_t taskID)
 Callback for the OmpTaskSwitch event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_OmpTaskComplete) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint64_t taskID)
 Callback for the OmpTaskComplete event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_Metric) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_MetricRef metric, uint8_t numberOfMetrics, const OTF2_Type *typeIDs, const OTF2_MetricValue *metricValues)
 Callback for the Metric event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_ParameterString) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_ParameterRef parameter, OTF2_StringRef string)
 Callback for the ParameterString event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_ParameterInt) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_ParameterRef parameter, int64_t value)
 Callback for the ParameterInt event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_ParameterUnsignedInt) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_ParameterRef parameter, uint64_t value)
 Callback for the ParameterUnsignedInt event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_RmaWinCreate) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win)
 Callback for the RmaWinCreate event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_RmaWinDestroy) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win)
 Callback for the RmaWinDestroy event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_RmaCollectiveBegin) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList)
 Callback for the RmaCollectiveBegin event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_RmaCollectiveEnd) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CollectiveOp collectiveOp, OTF2_RmaSyncLevel syncLevel, OTF2_RmaWinRef win, uint32_t root, uint64_t bytesSent, uint64_t bytesReceived)
 Callback for the RmaCollectiveEnd event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_RmaGroupSync) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaSyncLevel syncLevel, OTF2_RmaWinRef win, OTF2_GroupRef group)
 Callback for the RmaGroupSync event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_RmaRequestLock) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId, OTF2_LockType lockType)
 Callback for the RmaRequestLock event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_RmaAcquireLock) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId, OTF2_LockType lockType)
 Callback for the RmaAcquireLock event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_RmaTryLock) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId, OTF2_LockType lockType)
 Callback for the RmaTryLock event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_RmaReleaseLock) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId)
 Callback for the RmaReleaseLock event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_RmaSync) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, OTF2_RmaSyncType syncType)
 Callback for the RmaSync event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_RmaWaitChange) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win)
 Callback for the RmaWaitChange event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_RmaPut) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t bytes, uint64_t matchingId)
 Callback for the RmaPut event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_RmaGet) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t bytes, uint64_t matchingId)
 Callback for the RmaGet event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_RmaAtomic) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, OTF2_RmaAtomicType type, uint64_t bytesSent, uint64_t bytesReceived, uint64_t matchingId)
 Callback for the RmaAtomic event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_RmaOpCompleteBlocking) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint64_t matchingId)
 Callback for the RmaOpCompleteBlocking event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_RmaOpCompleteNonBlocking) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint64_t matchingId)
 Callback for the RmaOpCompleteNonBlocking event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_RmaOpTest) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint64_t matchingId)
 Callback for the RmaOpTest event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_RmaOpCompleteRemote) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint64_t matchingId)
 Callback for the RmaOpCompleteRemote event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_ThreadFork) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_Paradigm model, uint32_t numberOfRequestedThreads)
 Callback for the ThreadFork event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_ThreadJoin) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_Paradigm model)
 Callback for the ThreadJoin event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_ThreadTeamBegin) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadTeam)
 Callback for the ThreadTeamBegin event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_ThreadTeamEnd) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadTeam)
 Callback for the ThreadTeamEnd event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_ThreadAcquireLock) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_Paradigm model, uint32_t lockID, uint32_t acquisitionOrder)
 Callback for the ThreadAcquireLock event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_ThreadReleaseLock) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_Paradigm model, uint32_t lockID, uint32_t acquisitionOrder)
 Callback for the ThreadReleaseLock event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_ThreadTaskCreate) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadTeam, uint32_t creatingThread, uint32_t generationNumber)
 Callback for the ThreadTaskCreate event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_ThreadTaskSwitch) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadTeam, uint32_t creatingThread, uint32_t generationNumber)
 Callback for the ThreadTaskSwitch event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_ThreadTaskComplete) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadTeam, uint32_t creatingThread, uint32_t generationNumber)
 Callback for the ThreadTaskComplete event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_ThreadCreate) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadContingent, uint64_t sequenceCount)
 Callback for the ThreadCreate event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_ThreadBegin) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadContingent, uint64_t sequenceCount)
 Callback for the ThreadBegin event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_ThreadWait) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadContingent, uint64_t sequenceCount)
 Callback for the ThreadWait event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_ThreadEnd) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadContingent, uint64_t sequenceCount)
 Callback for the ThreadEnd event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_CallingContextEnter) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CallingContextRef callingContext, uint32_t unwindDistance)
 Callback for the CallingContextEnter event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_CallingContextLeave) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CallingContextRef callingContext)
 Callback for the CallingContextLeave event record. More...
 
typedef OTF2_CallbackCode(* OTF2_EvtReaderCallback_CallingContextSample) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CallingContextRef callingContext, uint32_t unwindDistance, OTF2_InterruptGeneratorRef interruptGenerator)
 Callback for the CallingContextSample event record. More...
 

Functions

OTF2_EvtReaderCallbacksOTF2_EvtReaderCallbacks_New (void)
 Allocates a new struct for the event callbacks. More...
 
void OTF2_EvtReaderCallbacks_Delete (OTF2_EvtReaderCallbacks *evtReaderCallbacks)
 Deallocates a struct for the event callbacks. More...
 
void OTF2_EvtReaderCallbacks_Clear (OTF2_EvtReaderCallbacks *evtReaderCallbacks)
 Clears a struct for the event callbacks. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetUnknownCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_Unknown unknownCallback)
 Registers the callback for the Unknown event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetBufferFlushCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_BufferFlush bufferFlushCallback)
 Registers the callback for the BufferFlush event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMeasurementOnOffCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_MeasurementOnOff measurementOnOffCallback)
 Registers the callback for the MeasurementOnOff event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetEnterCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_Enter enterCallback)
 Registers the callback for the Enter event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetLeaveCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_Leave leaveCallback)
 Registers the callback for the Leave event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMpiSendCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_MpiSend mpiSendCallback)
 Registers the callback for the MpiSend event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMpiIsendCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_MpiIsend mpiIsendCallback)
 Registers the callback for the MpiIsend event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMpiIsendCompleteCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_MpiIsendComplete mpiIsendCompleteCallback)
 Registers the callback for the MpiIsendComplete event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMpiIrecvRequestCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_MpiIrecvRequest mpiIrecvRequestCallback)
 Registers the callback for the MpiIrecvRequest event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMpiRecvCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_MpiRecv mpiRecvCallback)
 Registers the callback for the MpiRecv event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMpiIrecvCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_MpiIrecv mpiIrecvCallback)
 Registers the callback for the MpiIrecv event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMpiRequestTestCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_MpiRequestTest mpiRequestTestCallback)
 Registers the callback for the MpiRequestTest event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMpiRequestCancelledCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_MpiRequestCancelled mpiRequestCancelledCallback)
 Registers the callback for the MpiRequestCancelled event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMpiCollectiveBeginCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_MpiCollectiveBegin mpiCollectiveBeginCallback)
 Registers the callback for the MpiCollectiveBegin event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMpiCollectiveEndCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_MpiCollectiveEnd mpiCollectiveEndCallback)
 Registers the callback for the MpiCollectiveEnd event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetOmpForkCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_OmpFork ompForkCallback)
 Registers the callback for the OmpFork event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetOmpJoinCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_OmpJoin ompJoinCallback)
 Registers the callback for the OmpJoin event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetOmpAcquireLockCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_OmpAcquireLock ompAcquireLockCallback)
 Registers the callback for the OmpAcquireLock event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetOmpReleaseLockCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_OmpReleaseLock ompReleaseLockCallback)
 Registers the callback for the OmpReleaseLock event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetOmpTaskCreateCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_OmpTaskCreate ompTaskCreateCallback)
 Registers the callback for the OmpTaskCreate event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetOmpTaskSwitchCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_OmpTaskSwitch ompTaskSwitchCallback)
 Registers the callback for the OmpTaskSwitch event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetOmpTaskCompleteCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_OmpTaskComplete ompTaskCompleteCallback)
 Registers the callback for the OmpTaskComplete event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMetricCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_Metric metricCallback)
 Registers the callback for the Metric event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetParameterStringCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_ParameterString parameterStringCallback)
 Registers the callback for the ParameterString event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetParameterIntCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_ParameterInt parameterIntCallback)
 Registers the callback for the ParameterInt event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetParameterUnsignedIntCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_ParameterUnsignedInt parameterUnsignedIntCallback)
 Registers the callback for the ParameterUnsignedInt event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaWinCreateCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_RmaWinCreate rmaWinCreateCallback)
 Registers the callback for the RmaWinCreate event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaWinDestroyCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_RmaWinDestroy rmaWinDestroyCallback)
 Registers the callback for the RmaWinDestroy event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaCollectiveBeginCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_RmaCollectiveBegin rmaCollectiveBeginCallback)
 Registers the callback for the RmaCollectiveBegin event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaCollectiveEndCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_RmaCollectiveEnd rmaCollectiveEndCallback)
 Registers the callback for the RmaCollectiveEnd event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaGroupSyncCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_RmaGroupSync rmaGroupSyncCallback)
 Registers the callback for the RmaGroupSync event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaRequestLockCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_RmaRequestLock rmaRequestLockCallback)
 Registers the callback for the RmaRequestLock event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaAcquireLockCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_RmaAcquireLock rmaAcquireLockCallback)
 Registers the callback for the RmaAcquireLock event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaTryLockCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_RmaTryLock rmaTryLockCallback)
 Registers the callback for the RmaTryLock event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaReleaseLockCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_RmaReleaseLock rmaReleaseLockCallback)
 Registers the callback for the RmaReleaseLock event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaSyncCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_RmaSync rmaSyncCallback)
 Registers the callback for the RmaSync event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaWaitChangeCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_RmaWaitChange rmaWaitChangeCallback)
 Registers the callback for the RmaWaitChange event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaPutCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_RmaPut rmaPutCallback)
 Registers the callback for the RmaPut event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaGetCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_RmaGet rmaGetCallback)
 Registers the callback for the RmaGet event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaAtomicCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_RmaAtomic rmaAtomicCallback)
 Registers the callback for the RmaAtomic event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaOpCompleteBlockingCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_RmaOpCompleteBlocking rmaOpCompleteBlockingCallback)
 Registers the callback for the RmaOpCompleteBlocking event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaOpCompleteNonBlockingCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_RmaOpCompleteNonBlocking rmaOpCompleteNonBlockingCallback)
 Registers the callback for the RmaOpCompleteNonBlocking event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaOpTestCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_RmaOpTest rmaOpTestCallback)
 Registers the callback for the RmaOpTest event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaOpCompleteRemoteCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_RmaOpCompleteRemote rmaOpCompleteRemoteCallback)
 Registers the callback for the RmaOpCompleteRemote event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadForkCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_ThreadFork threadForkCallback)
 Registers the callback for the ThreadFork event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadJoinCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_ThreadJoin threadJoinCallback)
 Registers the callback for the ThreadJoin event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadTeamBeginCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_ThreadTeamBegin threadTeamBeginCallback)
 Registers the callback for the ThreadTeamBegin event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadTeamEndCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_ThreadTeamEnd threadTeamEndCallback)
 Registers the callback for the ThreadTeamEnd event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadAcquireLockCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_ThreadAcquireLock threadAcquireLockCallback)
 Registers the callback for the ThreadAcquireLock event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadReleaseLockCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_ThreadReleaseLock threadReleaseLockCallback)
 Registers the callback for the ThreadReleaseLock event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadTaskCreateCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_ThreadTaskCreate threadTaskCreateCallback)
 Registers the callback for the ThreadTaskCreate event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadTaskSwitchCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_ThreadTaskSwitch threadTaskSwitchCallback)
 Registers the callback for the ThreadTaskSwitch event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadTaskCompleteCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_ThreadTaskComplete threadTaskCompleteCallback)
 Registers the callback for the ThreadTaskComplete event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadCreateCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_ThreadCreate threadCreateCallback)
 Registers the callback for the ThreadCreate event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadBeginCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_ThreadBegin threadBeginCallback)
 Registers the callback for the ThreadBegin event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadWaitCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_ThreadWait threadWaitCallback)
 Registers the callback for the ThreadWait event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadEndCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_ThreadEnd threadEndCallback)
 Registers the callback for the ThreadEnd event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetCallingContextEnterCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_CallingContextEnter callingContextEnterCallback)
 Registers the callback for the CallingContextEnter event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetCallingContextLeaveCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_CallingContextLeave callingContextLeaveCallback)
 Registers the callback for the CallingContextLeave event. More...
 
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetCallingContextSampleCallback (OTF2_EvtReaderCallbacks *evtReaderCallbacks, OTF2_EvtReaderCallback_CallingContextSample callingContextSampleCallback)
 Registers the callback for the CallingContextSample event. More...
 

Detailed Description

This defines the callbacks for the event reader.

Source Template:
templates/OTF2_EvtReaderCallbacks.tmpl.h

Typedef Documentation

typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_Unknown) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList)

Callback for an unknown event record.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_BufferFlush) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp stopTime)

Callback for the BufferFlush event record.

This event signals that the internal buffer was flushed at the given time.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
stopTimeThe time the buffer flush finished.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_MeasurementOnOff) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_MeasurementMode measurementMode)

Callback for the MeasurementOnOff event record.

This event signals where the measurement system turned measurement on or off.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
measurementModeIs the measurement turned on (OTF2_MEASUREMENT_ON) or off (OTF2_MEASUREMENT_OFF)?
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_Enter) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RegionRef region)

Callback for the Enter event record.

An enter record indicates that the program enters a code region.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
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.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_Leave) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RegionRef region)

Callback for the Leave event record.

A leave record indicates that the program leaves a code region.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
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.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_MpiSend) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint32_t receiver, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength)

Callback for the MpiSend event record.

A MpiSend record indicates that a MPI message send process was initiated (MPI_SEND). It keeps the necessary information for this event: receiver of the message, communicator, and the message tag. You can optionally add further information like the message length (size of the send buffer).

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
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.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_MpiIsend) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint32_t receiver, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength, uint64_t requestID)

Callback for the MpiIsend event record.

A MpiIsend record indicates that a MPI message send process was initiated (MPI_ISEND). It keeps the necessary information for this event: receiver of the message, communicator, and the message tag. You can optionally add further information like the message length (size of the send buffer).

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
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.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_MpiIsendComplete) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint64_t requestID)

Callback for the MpiIsendComplete event record.

Signals the completion of non-blocking send request.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
requestIDID of the related request
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_MpiIrecvRequest) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint64_t requestID)

Callback for the MpiIrecvRequest event record.

Signals the request of a receive, which can be completed later.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
requestIDID of the requested receive
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_MpiRecv) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint32_t sender, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength)

Callback for the MpiRecv event record.

A MpiRecv record indicates that a MPI message was received (MPI_RECV). It keeps the necessary information for this event: sender of the message, communicator, and the message tag. You can optionally add further information like the message length (size of the receive buffer).

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
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.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_MpiIrecv) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint32_t sender, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength, uint64_t requestID)

Callback for the MpiIrecv event record.

A MpiIrecv record indicates that a MPI message was received (MPI_IRECV). It keeps the necessary information for this event: sender of the message, communicator, and the message tag. You can optionally add further information like the message length (size of the receive buffer).

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
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.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_MpiRequestTest) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint64_t requestID)

Callback for the MpiRequestTest event record.

This events appears if the program tests if a request has already completed but the test failed.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
requestIDID of the related request
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_MpiRequestCancelled) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint64_t requestID)

Callback for the MpiRequestCancelled event record.

This events appears if the program canceled a request.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
requestIDID of the related request
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_MpiCollectiveBegin) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList)

Callback for the MpiCollectiveBegin event record.

A MpiCollectiveBegin record marks the begin of a MPI collective operation (MPI_GATHER, MPI_SCATTER etc.).

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_MpiCollectiveEnd) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CollectiveOp collectiveOp, OTF2_CommRef communicator, uint32_t root, uint64_t sizeSent, uint64_t sizeReceived)

Callback for the MpiCollectiveEnd event record.

A MpiCollectiveEnd record marks the end of a MPI collective operation (MPI_GATHER, MPI_SCATTER etc.). It keeps the necessary information for this event: type of collective operation, communicator, the root of this collective operation. You can optionally add further information like sent and received bytes.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
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.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_OmpFork) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint32_t numberOfRequestedThreads)

Callback for the OmpFork event record.

An OmpFork record marks that an OpenMP Thread forks a thread team.

This event record is superseded by the ThreadFork event record and should not be used when the ThreadFork event record is in use.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
numberOfRequestedThreadsRequested size of the team.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_OmpJoin) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList)

Callback for the OmpJoin event record.

An OmpJoin record marks that a team of threads is joint and only the master thread continues execution.

This event record is superseded by the ThreadJoin event record and should not be used when the ThreadJoin event record is in use.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_OmpAcquireLock) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint32_t lockID, uint32_t acquisitionOrder)

Callback for the OmpAcquireLock event record.

An OmpAcquireLock record marks that a thread acquires an OpenMP lock.

This event record is superseded by the ThreadAcquireLock event record and should not be used when the ThreadAcquireLock event record is in use.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
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.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_OmpReleaseLock) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint32_t lockID, uint32_t acquisitionOrder)

Callback for the OmpReleaseLock event record.

An OmpReleaseLock record marks that a thread releases an OpenMP lock.

This event record is superseded by the ThreadReleaseLock event record and should not be used when the ThreadReleaseLock event record is in use.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
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.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_OmpTaskCreate) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint64_t taskID)

Callback for the OmpTaskCreate event record.

An OmpTaskCreate record marks that an OpenMP Task was/will be created in the current region.

This event record is superseded by the ThreadTaskCreate event record and should not be used when the ThreadTaskCreate event record is in use.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
taskIDIdentifier of the newly created task instance.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_OmpTaskSwitch) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint64_t taskID)

Callback for the OmpTaskSwitch event record.

An OmpTaskSwitch record indicates that the execution of the current task will be suspended and another task starts/restarts its execution. Please note that this may change the current call stack of the executing location.

This event record is superseded by the ThreadTaskSwitch event record and should not be used when the ThreadTaskSwitch event record is in use.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
taskIDIdentifier of the now active task instance.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_OmpTaskComplete) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, uint64_t taskID)

Callback for the OmpTaskComplete event record.

An OmpTaskComplete record indicates that the execution of an OpenMP task has finished.

This event record is superseded by the ThreadTaskComplete event record and should not be used when the ThreadTaskComplete event record is in use.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
taskIDIdentifier of the completed task instance.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_Metric) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_MetricRef metric, uint8_t numberOfMetrics, const OTF2_Type *typeIDs, const OTF2_MetricValue *metricValues)

Callback for the Metric event record.

A metric event is always stored at the location that recorded the metric. A metric event can reference a metric class or metric instance. Therefore, metric classes and instances share same ID space. Synchronous metrics are always located right before the according enter and leave event.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
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.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_ParameterString) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_ParameterRef parameter, OTF2_StringRef string)

Callback for the ParameterString event record.

A ParameterString record marks that in the current region, the specified string parameter has the specified value.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
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.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_ParameterInt) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_ParameterRef parameter, int64_t value)

Callback for the ParameterInt event record.

A ParameterInt record marks that in the current region, the specified integer parameter has the specified value.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
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.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_ParameterUnsignedInt) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_ParameterRef parameter, uint64_t value)

Callback for the ParameterUnsignedInt event record.

A ParameterUnsignedInt record marks that in the current region, the specified unsigned integer parameter has the specified value.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
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.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_RmaWinCreate) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win)

Callback for the RmaWinCreate event record.

A RmaWinCreate record denotes the creation of a RMA window.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
winID of the window created. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_RmaWinDestroy) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win)

Callback for the RmaWinDestroy event record.

A RmaWinDestroy record denotes the destruction of a RMA window.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
winID of the window destructed. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_RmaCollectiveBegin) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList)

Callback for the RmaCollectiveBegin event record.

A RmaCollectiveBegin record denotes the beginning of a collective RMA operation.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_RmaCollectiveEnd) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CollectiveOp collectiveOp, OTF2_RmaSyncLevel syncLevel, OTF2_RmaWinRef win, uint32_t root, uint64_t bytesSent, uint64_t bytesReceived)

Callback for the RmaCollectiveEnd event record.

A RmaCollectiveEnd record denotes the end of a collective RMA operation.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
collectiveOpDetermines which collective operation it is.
syncLevelSynchronization level of this collective operation.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
rootRoot process for this operation.
bytesSentBytes sent in operation.
bytesReceivedBytes receives in operation.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_RmaGroupSync) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaSyncLevel syncLevel, OTF2_RmaWinRef win, OTF2_GroupRef group)

Callback for the RmaGroupSync event record.

A RmaGroupSync record denotes the synchronization with a subgroup of processes on a window.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
syncLevelSynchronization level of this collective operation.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
groupGroup of remote processes involved in synchronization. References a Group definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_GROUP is available.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_RmaRequestLock) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId, OTF2_LockType lockType)

Callback for the RmaRequestLock event record.

A RmaRequestLock record denotes the time a lock was requested and with it the earliest time it could have been granted. It is used to mark (possibly) non-blocking lock request, as defined by the MPI standard.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
remoteRank of the locked remote process.
lockIdID of the lock acquired, if multiple locks are defined on a window.
lockTypeType of lock acquired.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_RmaAcquireLock) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId, OTF2_LockType lockType)

Callback for the RmaAcquireLock event record.

A RmaAcquireLock record denotes the time a lock was acquired by the process.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
remoteRank of the locked remote process.
lockIdID of the lock acquired, if multiple locks are defined on a window.
lockTypeType of lock acquired.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_RmaTryLock) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId, OTF2_LockType lockType)

Callback for the RmaTryLock event record.

A RmaTryLock record denotes the time of an unsuccessful attempt to acquire the lock.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
remoteRank of the locked remote process.
lockIdID of the lock acquired, if multiple locks are defined on a window.
lockTypeType of lock acquired.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_RmaReleaseLock) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId)

Callback for the RmaReleaseLock event record.

A RmaReleaseLock record denotes the time the lock was released.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
remoteRank of the locked remote process.
lockIdID of the lock released, if multiple locks are defined on a window.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_RmaSync) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, OTF2_RmaSyncType syncType)

Callback for the RmaSync event record.

A RmaSync record denotes the direct synchronization with a possibly remote process.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
remoteRank of the locked remote process.
syncTypeType of synchronization.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_RmaWaitChange) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win)

Callback for the RmaWaitChange event record.

A RmaWaitChange record denotes the change of a window that was waited for.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_RmaPut) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t bytes, uint64_t matchingId)

Callback for the RmaPut event record.

A RmaPut record denotes the time a put operation was issued.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
remoteRank of the target process.
bytesBytes sent to target.
matchingIdID used for matching the corresponding completion record.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_RmaGet) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t bytes, uint64_t matchingId)

Callback for the RmaGet event record.

A RmaGet record denotes the time a get operation was issued.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
remoteRank of the target process.
bytesBytes received from target.
matchingIdID used for matching the corresponding completion record.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_RmaAtomic) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, OTF2_RmaAtomicType type, uint64_t bytesSent, uint64_t bytesReceived, uint64_t matchingId)

Callback for the RmaAtomic event record.

A RmaAtomic record denotes the time a atomic operation was issued.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
remoteRank of the target process.
typeType of atomic operation.
bytesSentBytes sent to target.
bytesReceivedBytes received from target.
matchingIdID used for matching the corresponding completion record.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_RmaOpCompleteBlocking) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint64_t matchingId)

Callback for the RmaOpCompleteBlocking event record.

A RmaOpCompleteBlocking record denotes the local completion of a blocking RMA operation.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
matchingIdID used for matching the corresponding RMA operation record.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_RmaOpCompleteNonBlocking) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint64_t matchingId)

Callback for the RmaOpCompleteNonBlocking event record.

A RmaOpCompleteNonBlocking record denotes the local completion of a non-blocking RMA operation.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
matchingIdID used for matching the corresponding RMA operation record.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_RmaOpTest) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint64_t matchingId)

Callback for the RmaOpTest event record.

A RmaOpTest record denotes that a non-blocking RMA operation has been tested for completion unsuccessfully.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
matchingIdID used for matching the corresponding RMA operation record.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_RmaOpCompleteRemote) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint64_t matchingId)

Callback for the RmaOpCompleteRemote event record.

A RmaOpCompleteRemote record denotes the remote completion of a RMA operation.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
matchingIdID used for matching the corresponding RMA operation record.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_ThreadFork) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_Paradigm model, uint32_t numberOfRequestedThreads)

Callback for the ThreadFork event record.

A ThreadFork record marks that a thread forks a thread team.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
modelThe threading paradigm this event took place.
numberOfRequestedThreadsRequested size of the team.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_ThreadJoin) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_Paradigm model)

Callback for the ThreadJoin event record.

A ThreadJoin record marks that a team of threads is joint and only the master thread continues execution.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
modelThe threading paradigm this event took place.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_ThreadTeamBegin) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadTeam)

Callback for the ThreadTeamBegin event record.

The current location enters the specified thread team.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
threadTeamThread team References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_ThreadTeamEnd) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadTeam)

Callback for the ThreadTeamEnd event record.

The current location leaves the specified thread team.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
threadTeamThread team References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_ThreadAcquireLock) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_Paradigm model, uint32_t lockID, uint32_t acquisitionOrder)

Callback for the ThreadAcquireLock event record.

A ThreadAcquireLock record marks that a thread acquires a lock.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
modelThe threading paradigm this event took place.
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_EvtReaderCallback_ThreadReleaseLock) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_Paradigm model, uint32_t lockID, uint32_t acquisitionOrder)

Callback for the ThreadReleaseLock event record.

A ThreadReleaseLock record marks that a thread releases a lock.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
modelThe threading paradigm this event took place.
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_EvtReaderCallback_ThreadTaskCreate) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadTeam, uint32_t creatingThread, uint32_t generationNumber)

Callback for the ThreadTaskCreate event record.

A ThreadTaskCreate record marks that a task in was/will be created and will be processed by the specified thread team.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
threadTeamThread team References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
creatingThreadCreating thread of this task.
generationNumberThread-private generation number of task's creating thread.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_ThreadTaskSwitch) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadTeam, uint32_t creatingThread, uint32_t generationNumber)

Callback for the ThreadTaskSwitch event record.

A ThreadTaskSwitch record indicates that the execution of the current task will be suspended and another task starts/restarts its execution. Please note that this may change the current call stack of the executing location.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
threadTeamThread team References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
creatingThreadCreating thread of this task.
generationNumberThread-private generation number of task's creating thread.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_ThreadTaskComplete) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadTeam, uint32_t creatingThread, uint32_t generationNumber)

Callback for the ThreadTaskComplete event record.

A ThreadTaskComplete record indicates that the execution of an OpenMP task has finished.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
threadTeamThread team References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
creatingThreadCreating thread of this task.
generationNumberThread-private generation number of task's creating thread.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_ThreadCreate) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadContingent, uint64_t sequenceCount)

Callback for the ThreadCreate event record.

The location created successfully a new thread.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
threadContingentThe thread contingent. References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
sequenceCountA threadContingent unique number. The corresponding ThreadBegin event does have the same number.
Since
Version 1.3
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_ThreadBegin) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadContingent, uint64_t sequenceCount)

Callback for the ThreadBegin event record.

Marks the begin of a thread created by another thread.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
threadContingentThe thread contingent. References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
sequenceCountA threadContingent unique number. The corresponding ThreadCreate event does have the same number.
Since
Version 1.3
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_ThreadWait) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadContingent, uint64_t sequenceCount)

Callback for the ThreadWait event record.

The location waits for the completion of another thread.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
threadContingentThe thread contingent. References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
sequenceCountA threadContingent unique number. The corresponding ThreadEnd event does have the same number.
Since
Version 1.3
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_ThreadEnd) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadContingent, uint64_t sequenceCount)

Callback for the ThreadEnd event record.

Marks the end of a thread.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
threadContingentThe thread contingent. References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
sequenceCountA threadContingent unique number. The corresponding ThreadWait event does have the same number. OTF2_UNDEFINED_UINT64 in case no corresponding ThreadWait event exists.
Since
Version 1.3
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_CallingContextEnter) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CallingContextRef callingContext, uint32_t unwindDistance)

Callback for the CallingContextEnter event record.

The thread entered an instrumented region, represented by the referenced CallingContext. In contrast to the Enter event, it gives the full calling context through the CallingContext tree.

Events based on the CallingContext definition are mutually exclusive with the Enter/Leave events in a trace.

If no callback for this event is set but a callback for Enter events is defined, the reader will automatically generate an Enter callback call for the Region referenced by the CallingContext attribute of this event. Note that this emulation does not re-create the full calling context! It only re-creates the event order for instrumented regions.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
callingContextThe entered region as referenced by the CallingContext definition. References a CallingContext definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_CALLING_CONTEXT is available.
unwindDistanceThe unwindDistance for this callingContext. See the description in CallingContext.
Since
Version 2.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_CallingContextLeave) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CallingContextRef callingContext)

Callback for the CallingContextLeave event record.

The thread left an instrumented region, represented by the referenced CallingContext. In contrast to the Leave event, it gives the full calling context through the CallingContext tree.

The unwind distance for this CallingContext is defined to be 1. Because it must be assumed that the instrumented region made progress since the previous CallingContext event.

Events based on the CallingContext definition are mutually exclusive with the Enter/Leave events in a trace.

The parent of the CallingContext must be used as the previous calling context for the next event.

If no callback for this event is set but a callback for Leave events is defined, the reader will automatically generate an Leave callback call for the Region referenced by the CallingContext attribute of this event. Note that this emulation does not re-create the full calling context! It only re-creates the event order for instrumented regions.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
callingContextThe left region as referenced by the CallingContext definition. References a CallingContext definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_CALLING_CONTEXT is available.
Since
Version 2.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_EvtReaderCallback_CallingContextSample) (OTF2_LocationRef location, OTF2_TimeStamp time, uint64_t eventPosition, void *userData, OTF2_AttributeList *attributeList, OTF2_CallingContextRef callingContext, uint32_t unwindDistance, OTF2_InterruptGeneratorRef interruptGenerator)

Callback for the CallingContextSample event record.

The thread was interrupted to take a sample of its current state (region and source code location).

Events based on the CallingContext definition are mutually exclusive with the Enter/Leave events in a trace.

Parameters
locationThe location where this event happened.
timeThe time when this event happened.
eventPositionThe event position of this event in the trace. Starting with 1.
userDataUser data as set by OTF2_Reader_RegisterEvtCallbacks or OTF2_EvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
callingContextDescribes the calling context of the thread when it was interrupted. References a CallingContext definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_CALLING_CONTEXT is available.
unwindDistanceThe unwindDistance for this callingContext. See the description in CallingContext.
interruptGeneratorReferences a InterruptGenerator definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_INTERRUPT_GENERATOR is available.
Since
Version 1.5
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.

Function Documentation

OTF2_EvtReaderCallbacks* OTF2_EvtReaderCallbacks_New ( void  )

Allocates a new struct for the event callbacks.

Returns
A newly allocated struct of type OTF2_EvtReaderCallbacks.
void OTF2_EvtReaderCallbacks_Delete ( OTF2_EvtReaderCallbacks evtReaderCallbacks)

Deallocates a struct for the event callbacks.

Parameters
evtReaderCallbacksHandle to a struct previously allocated with OTF2_EvtReaderCallbacks_New.
void OTF2_EvtReaderCallbacks_Clear ( OTF2_EvtReaderCallbacks evtReaderCallbacks)

Clears a struct for the event callbacks.

Parameters
evtReaderCallbacksHandle to a struct previously allocated with OTF2_EvtReaderCallbacks_New.
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetUnknownCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_Unknown  unknownCallback 
)

Registers the callback for the Unknown event.

Parameters
evtReaderCallbacksStruct for all callbacks.
unknownCallbackFunction which should be called for all unknown events.
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetBufferFlushCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_BufferFlush  bufferFlushCallback 
)

Registers the callback for the BufferFlush event.

Parameters
evtReaderCallbacksStruct for all callbacks.
bufferFlushCallbackFunction which should be called for all BufferFlush definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMeasurementOnOffCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_MeasurementOnOff  measurementOnOffCallback 
)

Registers the callback for the MeasurementOnOff event.

Parameters
evtReaderCallbacksStruct for all callbacks.
measurementOnOffCallbackFunction which should be called for all MeasurementOnOff definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetEnterCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_Enter  enterCallback 
)

Registers the callback for the Enter event.

Parameters
evtReaderCallbacksStruct for all callbacks.
enterCallbackFunction which should be called for all Enter definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetLeaveCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_Leave  leaveCallback 
)

Registers the callback for the Leave event.

Parameters
evtReaderCallbacksStruct for all callbacks.
leaveCallbackFunction which should be called for all Leave definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMpiSendCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_MpiSend  mpiSendCallback 
)

Registers the callback for the MpiSend event.

Parameters
evtReaderCallbacksStruct for all callbacks.
mpiSendCallbackFunction which should be called for all MpiSend definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMpiIsendCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_MpiIsend  mpiIsendCallback 
)

Registers the callback for the MpiIsend event.

Parameters
evtReaderCallbacksStruct for all callbacks.
mpiIsendCallbackFunction which should be called for all MpiIsend definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMpiIsendCompleteCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_MpiIsendComplete  mpiIsendCompleteCallback 
)

Registers the callback for the MpiIsendComplete event.

Parameters
evtReaderCallbacksStruct for all callbacks.
mpiIsendCompleteCallbackFunction which should be called for all MpiIsendComplete definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMpiIrecvRequestCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_MpiIrecvRequest  mpiIrecvRequestCallback 
)

Registers the callback for the MpiIrecvRequest event.

Parameters
evtReaderCallbacksStruct for all callbacks.
mpiIrecvRequestCallbackFunction which should be called for all MpiIrecvRequest definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMpiRecvCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_MpiRecv  mpiRecvCallback 
)

Registers the callback for the MpiRecv event.

Parameters
evtReaderCallbacksStruct for all callbacks.
mpiRecvCallbackFunction which should be called for all MpiRecv definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMpiIrecvCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_MpiIrecv  mpiIrecvCallback 
)

Registers the callback for the MpiIrecv event.

Parameters
evtReaderCallbacksStruct for all callbacks.
mpiIrecvCallbackFunction which should be called for all MpiIrecv definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMpiRequestTestCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_MpiRequestTest  mpiRequestTestCallback 
)

Registers the callback for the MpiRequestTest event.

Parameters
evtReaderCallbacksStruct for all callbacks.
mpiRequestTestCallbackFunction which should be called for all MpiRequestTest definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMpiRequestCancelledCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_MpiRequestCancelled  mpiRequestCancelledCallback 
)

Registers the callback for the MpiRequestCancelled event.

Parameters
evtReaderCallbacksStruct for all callbacks.
mpiRequestCancelledCallbackFunction which should be called for all MpiRequestCancelled definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMpiCollectiveBeginCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_MpiCollectiveBegin  mpiCollectiveBeginCallback 
)

Registers the callback for the MpiCollectiveBegin event.

Parameters
evtReaderCallbacksStruct for all callbacks.
mpiCollectiveBeginCallbackFunction which should be called for all MpiCollectiveBegin definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMpiCollectiveEndCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_MpiCollectiveEnd  mpiCollectiveEndCallback 
)

Registers the callback for the MpiCollectiveEnd event.

Parameters
evtReaderCallbacksStruct for all callbacks.
mpiCollectiveEndCallbackFunction which should be called for all MpiCollectiveEnd definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetOmpForkCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_OmpFork  ompForkCallback 
)

Registers the callback for the OmpFork event.

Parameters
evtReaderCallbacksStruct for all callbacks.
ompForkCallbackFunction which should be called for all OmpFork definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetOmpJoinCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_OmpJoin  ompJoinCallback 
)

Registers the callback for the OmpJoin event.

Parameters
evtReaderCallbacksStruct for all callbacks.
ompJoinCallbackFunction which should be called for all OmpJoin definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetOmpAcquireLockCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_OmpAcquireLock  ompAcquireLockCallback 
)

Registers the callback for the OmpAcquireLock event.

Parameters
evtReaderCallbacksStruct for all callbacks.
ompAcquireLockCallbackFunction which should be called for all OmpAcquireLock definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetOmpReleaseLockCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_OmpReleaseLock  ompReleaseLockCallback 
)

Registers the callback for the OmpReleaseLock event.

Parameters
evtReaderCallbacksStruct for all callbacks.
ompReleaseLockCallbackFunction which should be called for all OmpReleaseLock definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetOmpTaskCreateCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_OmpTaskCreate  ompTaskCreateCallback 
)

Registers the callback for the OmpTaskCreate event.

Parameters
evtReaderCallbacksStruct for all callbacks.
ompTaskCreateCallbackFunction which should be called for all OmpTaskCreate definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetOmpTaskSwitchCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_OmpTaskSwitch  ompTaskSwitchCallback 
)

Registers the callback for the OmpTaskSwitch event.

Parameters
evtReaderCallbacksStruct for all callbacks.
ompTaskSwitchCallbackFunction which should be called for all OmpTaskSwitch definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetOmpTaskCompleteCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_OmpTaskComplete  ompTaskCompleteCallback 
)

Registers the callback for the OmpTaskComplete event.

Parameters
evtReaderCallbacksStruct for all callbacks.
ompTaskCompleteCallbackFunction which should be called for all OmpTaskComplete definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetMetricCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_Metric  metricCallback 
)

Registers the callback for the Metric event.

Parameters
evtReaderCallbacksStruct for all callbacks.
metricCallbackFunction which should be called for all Metric definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetParameterStringCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_ParameterString  parameterStringCallback 
)

Registers the callback for the ParameterString event.

Parameters
evtReaderCallbacksStruct for all callbacks.
parameterStringCallbackFunction which should be called for all ParameterString definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetParameterIntCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_ParameterInt  parameterIntCallback 
)

Registers the callback for the ParameterInt event.

Parameters
evtReaderCallbacksStruct for all callbacks.
parameterIntCallbackFunction which should be called for all ParameterInt definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetParameterUnsignedIntCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_ParameterUnsignedInt  parameterUnsignedIntCallback 
)

Registers the callback for the ParameterUnsignedInt event.

Parameters
evtReaderCallbacksStruct for all callbacks.
parameterUnsignedIntCallbackFunction which should be called for all ParameterUnsignedInt definitions.
Since
Version 1.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaWinCreateCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_RmaWinCreate  rmaWinCreateCallback 
)

Registers the callback for the RmaWinCreate event.

Parameters
evtReaderCallbacksStruct for all callbacks.
rmaWinCreateCallbackFunction which should be called for all RmaWinCreate definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaWinDestroyCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_RmaWinDestroy  rmaWinDestroyCallback 
)

Registers the callback for the RmaWinDestroy event.

Parameters
evtReaderCallbacksStruct for all callbacks.
rmaWinDestroyCallbackFunction which should be called for all RmaWinDestroy definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaCollectiveBeginCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_RmaCollectiveBegin  rmaCollectiveBeginCallback 
)

Registers the callback for the RmaCollectiveBegin event.

Parameters
evtReaderCallbacksStruct for all callbacks.
rmaCollectiveBeginCallbackFunction which should be called for all RmaCollectiveBegin definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaCollectiveEndCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_RmaCollectiveEnd  rmaCollectiveEndCallback 
)

Registers the callback for the RmaCollectiveEnd event.

Parameters
evtReaderCallbacksStruct for all callbacks.
rmaCollectiveEndCallbackFunction which should be called for all RmaCollectiveEnd definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaGroupSyncCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_RmaGroupSync  rmaGroupSyncCallback 
)

Registers the callback for the RmaGroupSync event.

Parameters
evtReaderCallbacksStruct for all callbacks.
rmaGroupSyncCallbackFunction which should be called for all RmaGroupSync definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaRequestLockCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_RmaRequestLock  rmaRequestLockCallback 
)

Registers the callback for the RmaRequestLock event.

Parameters
evtReaderCallbacksStruct for all callbacks.
rmaRequestLockCallbackFunction which should be called for all RmaRequestLock definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaAcquireLockCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_RmaAcquireLock  rmaAcquireLockCallback 
)

Registers the callback for the RmaAcquireLock event.

Parameters
evtReaderCallbacksStruct for all callbacks.
rmaAcquireLockCallbackFunction which should be called for all RmaAcquireLock definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaTryLockCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_RmaTryLock  rmaTryLockCallback 
)

Registers the callback for the RmaTryLock event.

Parameters
evtReaderCallbacksStruct for all callbacks.
rmaTryLockCallbackFunction which should be called for all RmaTryLock definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaReleaseLockCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_RmaReleaseLock  rmaReleaseLockCallback 
)

Registers the callback for the RmaReleaseLock event.

Parameters
evtReaderCallbacksStruct for all callbacks.
rmaReleaseLockCallbackFunction which should be called for all RmaReleaseLock definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaSyncCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_RmaSync  rmaSyncCallback 
)

Registers the callback for the RmaSync event.

Parameters
evtReaderCallbacksStruct for all callbacks.
rmaSyncCallbackFunction which should be called for all RmaSync definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaWaitChangeCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_RmaWaitChange  rmaWaitChangeCallback 
)

Registers the callback for the RmaWaitChange event.

Parameters
evtReaderCallbacksStruct for all callbacks.
rmaWaitChangeCallbackFunction which should be called for all RmaWaitChange definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaPutCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_RmaPut  rmaPutCallback 
)

Registers the callback for the RmaPut event.

Parameters
evtReaderCallbacksStruct for all callbacks.
rmaPutCallbackFunction which should be called for all RmaPut definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaGetCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_RmaGet  rmaGetCallback 
)

Registers the callback for the RmaGet event.

Parameters
evtReaderCallbacksStruct for all callbacks.
rmaGetCallbackFunction which should be called for all RmaGet definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaAtomicCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_RmaAtomic  rmaAtomicCallback 
)

Registers the callback for the RmaAtomic event.

Parameters
evtReaderCallbacksStruct for all callbacks.
rmaAtomicCallbackFunction which should be called for all RmaAtomic definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaOpCompleteBlockingCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_RmaOpCompleteBlocking  rmaOpCompleteBlockingCallback 
)

Registers the callback for the RmaOpCompleteBlocking event.

Parameters
evtReaderCallbacksStruct for all callbacks.
rmaOpCompleteBlockingCallbackFunction which should be called for all RmaOpCompleteBlocking definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaOpCompleteNonBlockingCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_RmaOpCompleteNonBlocking  rmaOpCompleteNonBlockingCallback 
)

Registers the callback for the RmaOpCompleteNonBlocking event.

Parameters
evtReaderCallbacksStruct for all callbacks.
rmaOpCompleteNonBlockingCallbackFunction which should be called for all RmaOpCompleteNonBlocking definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaOpTestCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_RmaOpTest  rmaOpTestCallback 
)

Registers the callback for the RmaOpTest event.

Parameters
evtReaderCallbacksStruct for all callbacks.
rmaOpTestCallbackFunction which should be called for all RmaOpTest definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetRmaOpCompleteRemoteCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_RmaOpCompleteRemote  rmaOpCompleteRemoteCallback 
)

Registers the callback for the RmaOpCompleteRemote event.

Parameters
evtReaderCallbacksStruct for all callbacks.
rmaOpCompleteRemoteCallbackFunction which should be called for all RmaOpCompleteRemote definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadForkCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_ThreadFork  threadForkCallback 
)

Registers the callback for the ThreadFork event.

Parameters
evtReaderCallbacksStruct for all callbacks.
threadForkCallbackFunction which should be called for all ThreadFork definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadJoinCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_ThreadJoin  threadJoinCallback 
)

Registers the callback for the ThreadJoin event.

Parameters
evtReaderCallbacksStruct for all callbacks.
threadJoinCallbackFunction which should be called for all ThreadJoin definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadTeamBeginCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_ThreadTeamBegin  threadTeamBeginCallback 
)

Registers the callback for the ThreadTeamBegin event.

Parameters
evtReaderCallbacksStruct for all callbacks.
threadTeamBeginCallbackFunction which should be called for all ThreadTeamBegin definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadTeamEndCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_ThreadTeamEnd  threadTeamEndCallback 
)

Registers the callback for the ThreadTeamEnd event.

Parameters
evtReaderCallbacksStruct for all callbacks.
threadTeamEndCallbackFunction which should be called for all ThreadTeamEnd definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadAcquireLockCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_ThreadAcquireLock  threadAcquireLockCallback 
)

Registers the callback for the ThreadAcquireLock event.

Parameters
evtReaderCallbacksStruct for all callbacks.
threadAcquireLockCallbackFunction which should be called for all ThreadAcquireLock definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadReleaseLockCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_ThreadReleaseLock  threadReleaseLockCallback 
)

Registers the callback for the ThreadReleaseLock event.

Parameters
evtReaderCallbacksStruct for all callbacks.
threadReleaseLockCallbackFunction which should be called for all ThreadReleaseLock definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadTaskCreateCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_ThreadTaskCreate  threadTaskCreateCallback 
)

Registers the callback for the ThreadTaskCreate event.

Parameters
evtReaderCallbacksStruct for all callbacks.
threadTaskCreateCallbackFunction which should be called for all ThreadTaskCreate definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadTaskSwitchCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_ThreadTaskSwitch  threadTaskSwitchCallback 
)

Registers the callback for the ThreadTaskSwitch event.

Parameters
evtReaderCallbacksStruct for all callbacks.
threadTaskSwitchCallbackFunction which should be called for all ThreadTaskSwitch definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadTaskCompleteCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_ThreadTaskComplete  threadTaskCompleteCallback 
)

Registers the callback for the ThreadTaskComplete event.

Parameters
evtReaderCallbacksStruct for all callbacks.
threadTaskCompleteCallbackFunction which should be called for all ThreadTaskComplete definitions.
Since
Version 1.2
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadCreateCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_ThreadCreate  threadCreateCallback 
)

Registers the callback for the ThreadCreate event.

Parameters
evtReaderCallbacksStruct for all callbacks.
threadCreateCallbackFunction which should be called for all ThreadCreate definitions.
Since
Version 1.3
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadBeginCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_ThreadBegin  threadBeginCallback 
)

Registers the callback for the ThreadBegin event.

Parameters
evtReaderCallbacksStruct for all callbacks.
threadBeginCallbackFunction which should be called for all ThreadBegin definitions.
Since
Version 1.3
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadWaitCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_ThreadWait  threadWaitCallback 
)

Registers the callback for the ThreadWait event.

Parameters
evtReaderCallbacksStruct for all callbacks.
threadWaitCallbackFunction which should be called for all ThreadWait definitions.
Since
Version 1.3
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetThreadEndCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_ThreadEnd  threadEndCallback 
)

Registers the callback for the ThreadEnd event.

Parameters
evtReaderCallbacksStruct for all callbacks.
threadEndCallbackFunction which should be called for all ThreadEnd definitions.
Since
Version 1.3
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetCallingContextEnterCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_CallingContextEnter  callingContextEnterCallback 
)

Registers the callback for the CallingContextEnter event.

Parameters
evtReaderCallbacksStruct for all callbacks.
callingContextEnterCallbackFunction which should be called for all CallingContextEnter definitions.
Since
Version 2.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetCallingContextLeaveCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_CallingContextLeave  callingContextLeaveCallback 
)

Registers the callback for the CallingContextLeave event.

Parameters
evtReaderCallbacksStruct for all callbacks.
callingContextLeaveCallbackFunction which should be called for all CallingContextLeave definitions.
Since
Version 2.0
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument
OTF2_ErrorCode OTF2_EvtReaderCallbacks_SetCallingContextSampleCallback ( OTF2_EvtReaderCallbacks evtReaderCallbacks,
OTF2_EvtReaderCallback_CallingContextSample  callingContextSampleCallback 
)

Registers the callback for the CallingContextSample event.

Parameters
evtReaderCallbacksStruct for all callbacks.
callingContextSampleCallbackFunction which should be called for all CallingContextSample definitions.
Since
Version 1.5
Returns
OTF2_SUCCESS
if successful
OTF2_ERROR_INVALID_ARGUMENT
for an invalid defReaderCallbacks argument