1.2.1 (revision 3238)
Typedefs | Functions
OTF2_GlobalEvtReaderCallbacks.h File Reference

This defines the callbacks for the global 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 OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_BufferFlush )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_TimeStamp stopTime)
 Callback for the BufferFlush event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_Enter )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RegionRef region)
 Callback for the Enter event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_Leave )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RegionRef region)
 Callback for the Leave event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_MeasurementOnOff )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_MeasurementMode measurementMode)
 Callback for the MeasurementOnOff event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_Metric )(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_MpiCollectiveBegin )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList)
 Callback for the MpiCollectiveBegin event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_MpiCollectiveEnd )(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_MpiIrecv )(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_MpiIrecvRequest )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, uint64_t requestID)
 Callback for the MpiIrecvRequest event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_MpiIsend )(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_MpiIsendComplete )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, uint64_t requestID)
 Callback for the MpiIsendComplete event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_MpiRecv )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, uint32_t sender, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength)
 Callback for the MpiRecv event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_MpiRequestCancelled )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, uint64_t requestID)
 Callback for the MpiRequestCancelled event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_MpiRequestTest )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, uint64_t requestID)
 Callback for the MpiRequestTest event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_MpiSend )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, uint32_t receiver, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength)
 Callback for the MpiSend event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_OmpAcquireLock )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, uint32_t lockID, uint32_t acquisitionOrder)
 Callback for the OmpAcquireLock event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_OmpFork )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, uint32_t numberOfRequestedThreads)
 Callback for the OmpFork event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_OmpJoin )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList)
 Callback for the OmpJoin event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_OmpReleaseLock )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, uint32_t lockID, uint32_t acquisitionOrder)
 Callback for the OmpReleaseLock event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_OmpTaskComplete )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, uint64_t taskID)
 Callback for the OmpTaskComplete event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_OmpTaskCreate )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, uint64_t taskID)
 Callback for the OmpTaskCreate event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_OmpTaskSwitch )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, uint64_t taskID)
 Callback for the OmpTaskSwitch event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_ParameterInt )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_ParameterRef parameter, int64_t value)
 Callback for the ParameterInt event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_ParameterString )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_ParameterRef parameter, OTF2_StringRef string)
 Callback for the ParameterString event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_ParameterUnsignedInt )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_ParameterRef parameter, uint64_t value)
 Callback for the ParameterUnsignedInt event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_RmaAcquireLock )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId, OTF2_LockType lockType)
 Callback for the RmaAcquireLock event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_RmaAtomic )(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_RmaCollectiveBegin )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList)
 Callback for the RmaCollectiveBegin event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_RmaCollectiveEnd )(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_RmaGet )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t bytes, uint64_t matchingId)
 Callback for the RmaGet event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_RmaGroupSync )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaSyncLevel syncLevel, OTF2_RmaWinRef win, OTF2_GroupRef group)
 Callback for the RmaGroupSync event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_RmaOpCompleteBlocking )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint64_t matchingId)
 Callback for the RmaOpCompleteBlocking event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_RmaOpCompleteNonBlocking )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint64_t matchingId)
 Callback for the RmaOpCompleteNonBlocking event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_RmaOpCompleteRemote )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint64_t matchingId)
 Callback for the RmaOpCompleteRemote event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_RmaOpTest )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint64_t matchingId)
 Callback for the RmaOpTest event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_RmaPut )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t bytes, uint64_t matchingId)
 Callback for the RmaPut event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_RmaReleaseLock )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId)
 Callback for the RmaReleaseLock event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_RmaRequestLock )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId, OTF2_LockType lockType)
 Callback for the RmaRequestLock event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_RmaSync )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, OTF2_RmaSyncType syncType)
 Callback for the RmaSync event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_RmaTryLock )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId, OTF2_LockType lockType)
 Callback for the RmaTryLock event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_RmaWaitChange )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win)
 Callback for the RmaWaitChange event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_RmaWinCreate )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win)
 Callback for the RmaWinCreate event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_RmaWinDestroy )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win)
 Callback for the RmaWinDestroy event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_ThreadAcquireLock )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_Paradigm model, uint32_t lockID, uint32_t acquisitionOrder)
 Callback for the ThreadAcquireLock event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_ThreadFork )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_Paradigm model, uint32_t numberOfRequestedThreads)
 Callback for the ThreadFork event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_ThreadJoin )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_Paradigm model)
 Callback for the ThreadJoin event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_ThreadReleaseLock )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_Paradigm model, uint32_t lockID, uint32_t acquisitionOrder)
 Callback for the ThreadReleaseLock event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_ThreadTaskComplete )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadTeam, uint32_t creatingThread, uint32_t generationNumber)
 Callback for the ThreadTaskComplete event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_ThreadTaskCreate )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadTeam, uint32_t creatingThread, uint32_t generationNumber)
 Callback for the ThreadTaskCreate event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_ThreadTaskSwitch )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadTeam, uint32_t creatingThread, uint32_t generationNumber)
 Callback for the ThreadTaskSwitch event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_ThreadTeamBegin )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadTeam)
 Callback for the ThreadTeamBegin event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_ThreadTeamEnd )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadTeam)
 Callback for the ThreadTeamEnd event record.
typedef OTF2_CallbackCode(* OTF2_GlobalEvtReaderCallback_Unknown )(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList)
 Callback for an unknown event record.
typedef struct
OTF2_GlobalEvtReaderCallbacks_struct 
OTF2_GlobalEvtReaderCallbacks
 Opaque struct which holdes all event record callbacks.

Functions

void OTF2_GlobalEvtReaderCallbacks_Clear (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks)
 Clears a struct for the global event callbacks.
void OTF2_GlobalEvtReaderCallbacks_Delete (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks)
 Deallocates a struct for the global event callbacks.
OTF2_GlobalEvtReaderCallbacksOTF2_GlobalEvtReaderCallbacks_New (void)
 Allocates a new struct for the event callbacks.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetBufferFlushCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_BufferFlush bufferFlushCallback)
 Registers the callback for the BufferFlush event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetEnterCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_Enter enterCallback)
 Registers the callback for the Enter event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetLeaveCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_Leave leaveCallback)
 Registers the callback for the Leave event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMeasurementOnOffCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_MeasurementOnOff measurementOnOffCallback)
 Registers the callback for the MeasurementOnOff event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMetricCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_Metric metricCallback)
 Registers the callback for the Metric event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMpiCollectiveBeginCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_MpiCollectiveBegin mpiCollectiveBeginCallback)
 Registers the callback for the MpiCollectiveBegin event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMpiCollectiveEndCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_MpiCollectiveEnd mpiCollectiveEndCallback)
 Registers the callback for the MpiCollectiveEnd event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMpiIrecvCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_MpiIrecv mpiIrecvCallback)
 Registers the callback for the MpiIrecv event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMpiIrecvRequestCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_MpiIrecvRequest mpiIrecvRequestCallback)
 Registers the callback for the MpiIrecvRequest event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMpiIsendCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_MpiIsend mpiIsendCallback)
 Registers the callback for the MpiIsend event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMpiIsendCompleteCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_MpiIsendComplete mpiIsendCompleteCallback)
 Registers the callback for the MpiIsendComplete event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMpiRecvCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_MpiRecv mpiRecvCallback)
 Registers the callback for the MpiRecv event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMpiRequestCancelledCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_MpiRequestCancelled mpiRequestCancelledCallback)
 Registers the callback for the MpiRequestCancelled event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMpiRequestTestCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_MpiRequestTest mpiRequestTestCallback)
 Registers the callback for the MpiRequestTest event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMpiSendCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_MpiSend mpiSendCallback)
 Registers the callback for the MpiSend event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetOmpAcquireLockCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_OmpAcquireLock ompAcquireLockCallback)
 Registers the callback for the OmpAcquireLock event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetOmpForkCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_OmpFork ompForkCallback)
 Registers the callback for the OmpFork event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetOmpJoinCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_OmpJoin ompJoinCallback)
 Registers the callback for the OmpJoin event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetOmpReleaseLockCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_OmpReleaseLock ompReleaseLockCallback)
 Registers the callback for the OmpReleaseLock event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetOmpTaskCompleteCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_OmpTaskComplete ompTaskCompleteCallback)
 Registers the callback for the OmpTaskComplete event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetOmpTaskCreateCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_OmpTaskCreate ompTaskCreateCallback)
 Registers the callback for the OmpTaskCreate event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetOmpTaskSwitchCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_OmpTaskSwitch ompTaskSwitchCallback)
 Registers the callback for the OmpTaskSwitch event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetParameterIntCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_ParameterInt parameterIntCallback)
 Registers the callback for the ParameterInt event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetParameterStringCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_ParameterString parameterStringCallback)
 Registers the callback for the ParameterString event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetParameterUnsignedIntCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_ParameterUnsignedInt parameterUnsignedIntCallback)
 Registers the callback for the ParameterUnsignedInt event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaAcquireLockCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_RmaAcquireLock rmaAcquireLockCallback)
 Registers the callback for the RmaAcquireLock event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaAtomicCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_RmaAtomic rmaAtomicCallback)
 Registers the callback for the RmaAtomic event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaCollectiveBeginCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_RmaCollectiveBegin rmaCollectiveBeginCallback)
 Registers the callback for the RmaCollectiveBegin event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaCollectiveEndCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_RmaCollectiveEnd rmaCollectiveEndCallback)
 Registers the callback for the RmaCollectiveEnd event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaGetCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_RmaGet rmaGetCallback)
 Registers the callback for the RmaGet event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaGroupSyncCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_RmaGroupSync rmaGroupSyncCallback)
 Registers the callback for the RmaGroupSync event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaOpCompleteBlockingCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_RmaOpCompleteBlocking rmaOpCompleteBlockingCallback)
 Registers the callback for the RmaOpCompleteBlocking event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaOpCompleteNonBlockingCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_RmaOpCompleteNonBlocking rmaOpCompleteNonBlockingCallback)
 Registers the callback for the RmaOpCompleteNonBlocking event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaOpCompleteRemoteCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_RmaOpCompleteRemote rmaOpCompleteRemoteCallback)
 Registers the callback for the RmaOpCompleteRemote event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaOpTestCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_RmaOpTest rmaOpTestCallback)
 Registers the callback for the RmaOpTest event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaPutCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_RmaPut rmaPutCallback)
 Registers the callback for the RmaPut event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaReleaseLockCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_RmaReleaseLock rmaReleaseLockCallback)
 Registers the callback for the RmaReleaseLock event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaRequestLockCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_RmaRequestLock rmaRequestLockCallback)
 Registers the callback for the RmaRequestLock event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaSyncCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_RmaSync rmaSyncCallback)
 Registers the callback for the RmaSync event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaTryLockCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_RmaTryLock rmaTryLockCallback)
 Registers the callback for the RmaTryLock event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaWaitChangeCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_RmaWaitChange rmaWaitChangeCallback)
 Registers the callback for the RmaWaitChange event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaWinCreateCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_RmaWinCreate rmaWinCreateCallback)
 Registers the callback for the RmaWinCreate event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaWinDestroyCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_RmaWinDestroy rmaWinDestroyCallback)
 Registers the callback for the RmaWinDestroy event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetThreadAcquireLockCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_ThreadAcquireLock threadAcquireLockCallback)
 Registers the callback for the ThreadAcquireLock event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetThreadForkCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_ThreadFork threadForkCallback)
 Registers the callback for the ThreadFork event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetThreadJoinCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_ThreadJoin threadJoinCallback)
 Registers the callback for the ThreadJoin event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetThreadReleaseLockCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_ThreadReleaseLock threadReleaseLockCallback)
 Registers the callback for the ThreadReleaseLock event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetThreadTaskCompleteCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_ThreadTaskComplete threadTaskCompleteCallback)
 Registers the callback for the ThreadTaskComplete event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetThreadTaskCreateCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_ThreadTaskCreate threadTaskCreateCallback)
 Registers the callback for the ThreadTaskCreate event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetThreadTaskSwitchCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_ThreadTaskSwitch threadTaskSwitchCallback)
 Registers the callback for the ThreadTaskSwitch event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetThreadTeamBeginCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_ThreadTeamBegin threadTeamBeginCallback)
 Registers the callback for the ThreadTeamBegin event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetThreadTeamEndCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_ThreadTeamEnd threadTeamEndCallback)
 Registers the callback for the ThreadTeamEnd event.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetUnknownCallback (OTF2_GlobalEvtReaderCallbacks *globalEvtReaderCallbacks, OTF2_GlobalEvtReaderCallback_Unknown unknownCallback)
 Registers the callback for unknown events.

Detailed Description

This defines the callbacks for the global event reader.

Source Template:
templates/OTF2_GlobalEvtReaderCallbacks.tmpl.h
Maintainer:
Dominic Eschweiler <d.eschweiler@fz-juelich.de>
Authors:
Dominic Eschweiler <d.eschweiler@fz-juelich.de>, Michael Wagner <michael.wagner@zih.tu-dresden.de>

Typedef Documentation

Callback for the BufferFlush event record.

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

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_Enter)(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_Leave)(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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.

Callback for the MeasurementOnOff event record.

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

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_Metric)(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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.
metricValuesList of metric values.
Since:
Version 1.0
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.

Callback for the MpiCollectiveBegin event record.

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

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
Since:
Version 1.0
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_GlobalEvtReaderCallback_MpiCollectiveEnd)(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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 an 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:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_MpiIrecv)(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_MpiIrecvRequest)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, uint64_t requestID)

Callback for the MpiIrecvRequest event record.

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

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_MpiIsend)(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_MpiIsendComplete)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, uint64_t requestID)

Callback for the MpiIsendComplete event record.

Signals the completion of non-blocking send request.

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_MpiRecv)(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_MpiRequestCancelled)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, uint64_t requestID)

Callback for the MpiRequestCancelled event record.

This events appears if the program canceled a request.

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_MpiRequestTest)(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_MpiSend)(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_OmpAcquireLock)(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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 record.

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_OmpFork)(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_OmpJoin)(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
Since:
Version 1.0
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_GlobalEvtReaderCallback_OmpReleaseLock)(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_OmpTaskComplete)(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_OmpTaskCreate)(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_OmpTaskSwitch)(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_ParameterInt)(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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.

Callback for the ParameterString event record.

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

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_ParameterUnsignedInt)(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_RmaAcquireLock)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId, OTF2_LockType lockType)

Callback for the RmaAcquireLock event record.

An RmaAcquireLock record denotes the time a lock was aquired by the process.

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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 aquired, if multiple locks are defined on a window.
lockTypeType of lock aquired.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_GlobalEvtReaderCallback_RmaAtomic)(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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.

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

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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 appropriate completion record.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.

Callback for the RmaCollectiveBegin event record.

An RmaCollectiveBegin record denotes the beginnig of a collective RMA operation.

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_GlobalEvtReaderCallback_RmaCollectiveEnd)(OTF2_LocationRef locationID, OTF2_TimeStamp time, 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.

"An RmaCollectiveEnd record denotes the end of a collective RMA operation.

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_RmaGet)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t bytes, uint64_t matchingId)

Callback for the RmaGet event record.

An RmaGet record denotes the time a put operation was issued.

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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 appropriate completion record.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.

Callback for the RmaGroupSync event record.

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

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_RmaOpCompleteBlocking)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint64_t matchingId)

Callback for the RmaOpCompleteBlocking event record.

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

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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 appropriate completion record.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_GlobalEvtReaderCallback_RmaOpCompleteNonBlocking)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint64_t matchingId)

Callback for the RmaOpCompleteNonBlocking event record.

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

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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 appropriate completion record.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_GlobalEvtReaderCallback_RmaOpCompleteRemote)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint64_t matchingId)

Callback for the RmaOpCompleteRemote event record.

An RmaOpCompleteRemote record denotes the local completion of an RMA operation.

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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 appropriate completion record.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_GlobalEvtReaderCallback_RmaOpTest)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint64_t matchingId)

Callback for the RmaOpTest event record.

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

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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 appropriate completion record.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_GlobalEvtReaderCallback_RmaPut)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t bytes, uint64_t matchingId)

Callback for the RmaPut event record.

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

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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 appropriate completion record.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_GlobalEvtReaderCallback_RmaReleaseLock)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId)

Callback for the RmaReleaseLock event record.

An RmaReleaseLock record denotes the time the lock was released.

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_RmaRequestLock)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId, OTF2_LockType lockType)

Callback for the RmaRequestLock event record.

An 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:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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 aquired, if multiple locks are defined on a window.
lockTypeType of lock aquired.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_GlobalEvtReaderCallback_RmaSync)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, OTF2_RmaSyncType syncType)

Callback for the RmaSync event record.

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

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_RmaTryLock)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId, OTF2_LockType lockType)

Callback for the RmaTryLock event record.

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

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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 aquired, if multiple locks are defined on a window.
lockTypeType of lock aquired.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.

Callback for the RmaWaitChange event record.

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

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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.

Callback for the RmaWinCreate event record.

An RmaWinCreate record denotes the creation of an RMA window.

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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.

Callback for the RmaWinDestroy event record.

An RmaWinDestroy record denotes the destruction of an RMA window.

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_ThreadAcquireLock)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_Paradigm model, uint32_t lockID, uint32_t acquisitionOrder)

Callback for the ThreadAcquireLock event record.

An ThreadAcquireLock record marks that a thread acquires an lock.

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_GlobalEvtReaderCallback_ThreadFork)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_Paradigm model, uint32_t numberOfRequestedThreads)

Callback for the ThreadFork event record.

An ThreadFork record marks that an thread forks a thread team.

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
numberOfRequestedThreadsRequested size of the team.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.

Callback for the ThreadJoin event record.

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

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_GlobalEvtReaderCallback_ThreadReleaseLock)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_Paradigm model, uint32_t lockID, uint32_t acquisitionOrder)

Callback for the ThreadReleaseLock event record.

An ThreadReleaseLock record marks that a thread releases an lock.

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_GlobalEvtReaderCallback_ThreadTaskComplete)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadTeam, uint32_t creatingThread, uint32_t generationNumber)

Callback for the ThreadTaskComplete event record.

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

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_ThreadTaskCreate)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadTeam, uint32_t creatingThread, uint32_t generationNumber)

Callback for the ThreadTaskCreate event record.

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

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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. (This is redundant, remove?)
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_GlobalEvtReaderCallback_ThreadTaskSwitch)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadTeam, uint32_t creatingThread, uint32_t generationNumber)

Callback for the ThreadTaskSwitch event record.

An 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:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_ThreadTeamBegin)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadTeam)

Callback for the ThreadTeamBegin event record.

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_ThreadTeamEnd)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList, OTF2_CommRef threadTeam)

Callback for the ThreadTeamEnd event record.

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_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_GlobalEvtReaderCallback_Unknown)(OTF2_LocationRef locationID, OTF2_TimeStamp time, void *userData, OTF2_AttributeList *attributeList)

Callback for an unknown event record.

Parameters:
locationIDThe location where this event happened.
timeThe time when this event happened.
userDataUser data as set by OTF2_Reader_RegisterGlobalEvtCallbacks or OTF2_GlobalEvtReader_SetCallbacks.
attributeListAdditional attributes for this event.
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.

Function Documentation

void OTF2_GlobalEvtReaderCallbacks_Clear ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks)

Clears a struct for the global event callbacks.

Parameters:
globalEvtReaderCallbacksHandle to a struct previously allocated with OTF2_GlobalEvtReaderCallbacks_New.
void OTF2_GlobalEvtReaderCallbacks_Delete ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks)

Deallocates a struct for the global event callbacks.

Parameters:
globalEvtReaderCallbacksHandle to a struct previously allocated with OTF2_GlobalEvtReaderCallbacks_New.
OTF2_GlobalEvtReaderCallbacks* OTF2_GlobalEvtReaderCallbacks_New ( void  )

Allocates a new struct for the event callbacks.

Returns:
A newly allocated struct of type OTF2_GlobalEvtReaderCallbacks.
OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetBufferFlushCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_BufferFlush  bufferFlushCallback 
)

Registers the callback for the BufferFlush event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
bufferFlushCallbackFunction which should be called for all BufferFlush events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetEnterCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_Enter  enterCallback 
)

Registers the callback for the Enter event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
enterCallbackFunction which should be called for all Enter events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetLeaveCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_Leave  leaveCallback 
)

Registers the callback for the Leave event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
leaveCallbackFunction which should be called for all Leave events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMeasurementOnOffCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_MeasurementOnOff  measurementOnOffCallback 
)

Registers the callback for the MeasurementOnOff event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
measurementOnOffCallbackFunction which should be called for all MeasurementOnOff events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMetricCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_Metric  metricCallback 
)

Registers the callback for the Metric event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
metricCallbackFunction which should be called for all Metric events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMpiCollectiveBeginCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_MpiCollectiveBegin  mpiCollectiveBeginCallback 
)

Registers the callback for the MpiCollectiveBegin event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
mpiCollectiveBeginCallbackFunction which should be called for all MpiCollectiveBegin events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMpiCollectiveEndCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_MpiCollectiveEnd  mpiCollectiveEndCallback 
)

Registers the callback for the MpiCollectiveEnd event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
mpiCollectiveEndCallbackFunction which should be called for all MpiCollectiveEnd events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMpiIrecvCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_MpiIrecv  mpiIrecvCallback 
)

Registers the callback for the MpiIrecv event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
mpiIrecvCallbackFunction which should be called for all MpiIrecv events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMpiIrecvRequestCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_MpiIrecvRequest  mpiIrecvRequestCallback 
)

Registers the callback for the MpiIrecvRequest event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
mpiIrecvRequestCallbackFunction which should be called for all MpiIrecvRequest events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMpiIsendCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_MpiIsend  mpiIsendCallback 
)

Registers the callback for the MpiIsend event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
mpiIsendCallbackFunction which should be called for all MpiIsend events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMpiIsendCompleteCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_MpiIsendComplete  mpiIsendCompleteCallback 
)

Registers the callback for the MpiIsendComplete event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
mpiIsendCompleteCallbackFunction which should be called for all MpiIsendComplete events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMpiRecvCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_MpiRecv  mpiRecvCallback 
)

Registers the callback for the MpiRecv event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
mpiRecvCallbackFunction which should be called for all MpiRecv events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMpiRequestCancelledCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_MpiRequestCancelled  mpiRequestCancelledCallback 
)

Registers the callback for the MpiRequestCancelled event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
mpiRequestCancelledCallbackFunction which should be called for all MpiRequestCancelled events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMpiRequestTestCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_MpiRequestTest  mpiRequestTestCallback 
)

Registers the callback for the MpiRequestTest event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
mpiRequestTestCallbackFunction which should be called for all MpiRequestTest events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetMpiSendCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_MpiSend  mpiSendCallback 
)

Registers the callback for the MpiSend event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
mpiSendCallbackFunction which should be called for all MpiSend events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetOmpAcquireLockCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_OmpAcquireLock  ompAcquireLockCallback 
)

Registers the callback for the OmpAcquireLock event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
ompAcquireLockCallbackFunction which should be called for all OmpAcquireLock events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetOmpForkCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_OmpFork  ompForkCallback 
)

Registers the callback for the OmpFork event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
ompForkCallbackFunction which should be called for all OmpFork events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetOmpJoinCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_OmpJoin  ompJoinCallback 
)

Registers the callback for the OmpJoin event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
ompJoinCallbackFunction which should be called for all OmpJoin events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetOmpReleaseLockCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_OmpReleaseLock  ompReleaseLockCallback 
)

Registers the callback for the OmpReleaseLock event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
ompReleaseLockCallbackFunction which should be called for all OmpReleaseLock events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetOmpTaskCompleteCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_OmpTaskComplete  ompTaskCompleteCallback 
)

Registers the callback for the OmpTaskComplete event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
ompTaskCompleteCallbackFunction which should be called for all OmpTaskComplete events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetOmpTaskCreateCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_OmpTaskCreate  ompTaskCreateCallback 
)

Registers the callback for the OmpTaskCreate event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
ompTaskCreateCallbackFunction which should be called for all OmpTaskCreate events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetOmpTaskSwitchCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_OmpTaskSwitch  ompTaskSwitchCallback 
)

Registers the callback for the OmpTaskSwitch event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
ompTaskSwitchCallbackFunction which should be called for all OmpTaskSwitch events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetParameterIntCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_ParameterInt  parameterIntCallback 
)

Registers the callback for the ParameterInt event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
parameterIntCallbackFunction which should be called for all ParameterInt events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetParameterStringCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_ParameterString  parameterStringCallback 
)

Registers the callback for the ParameterString event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
parameterStringCallbackFunction which should be called for all ParameterString events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetParameterUnsignedIntCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_ParameterUnsignedInt  parameterUnsignedIntCallback 
)

Registers the callback for the ParameterUnsignedInt event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
parameterUnsignedIntCallbackFunction which should be called for all ParameterUnsignedInt events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaAcquireLockCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_RmaAcquireLock  rmaAcquireLockCallback 
)

Registers the callback for the RmaAcquireLock event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
rmaAcquireLockCallbackFunction which should be called for all RmaAcquireLock events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaAtomicCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_RmaAtomic  rmaAtomicCallback 
)

Registers the callback for the RmaAtomic event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
rmaAtomicCallbackFunction which should be called for all RmaAtomic events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaCollectiveBeginCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_RmaCollectiveBegin  rmaCollectiveBeginCallback 
)

Registers the callback for the RmaCollectiveBegin event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
rmaCollectiveBeginCallbackFunction which should be called for all RmaCollectiveBegin events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaCollectiveEndCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_RmaCollectiveEnd  rmaCollectiveEndCallback 
)

Registers the callback for the RmaCollectiveEnd event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
rmaCollectiveEndCallbackFunction which should be called for all RmaCollectiveEnd events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaGetCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_RmaGet  rmaGetCallback 
)

Registers the callback for the RmaGet event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
rmaGetCallbackFunction which should be called for all RmaGet events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaGroupSyncCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_RmaGroupSync  rmaGroupSyncCallback 
)

Registers the callback for the RmaGroupSync event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
rmaGroupSyncCallbackFunction which should be called for all RmaGroupSync events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaOpCompleteBlockingCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_RmaOpCompleteBlocking  rmaOpCompleteBlockingCallback 
)

Registers the callback for the RmaOpCompleteBlocking event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
rmaOpCompleteBlockingCallbackFunction which should be called for all RmaOpCompleteBlocking events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaOpCompleteNonBlockingCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_RmaOpCompleteNonBlocking  rmaOpCompleteNonBlockingCallback 
)

Registers the callback for the RmaOpCompleteNonBlocking event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
rmaOpCompleteNonBlockingCallbackFunction which should be called for all RmaOpCompleteNonBlocking events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaOpCompleteRemoteCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_RmaOpCompleteRemote  rmaOpCompleteRemoteCallback 
)

Registers the callback for the RmaOpCompleteRemote event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
rmaOpCompleteRemoteCallbackFunction which should be called for all RmaOpCompleteRemote events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaOpTestCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_RmaOpTest  rmaOpTestCallback 
)

Registers the callback for the RmaOpTest event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
rmaOpTestCallbackFunction which should be called for all RmaOpTest events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaPutCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_RmaPut  rmaPutCallback 
)

Registers the callback for the RmaPut event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
rmaPutCallbackFunction which should be called for all RmaPut events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaReleaseLockCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_RmaReleaseLock  rmaReleaseLockCallback 
)

Registers the callback for the RmaReleaseLock event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
rmaReleaseLockCallbackFunction which should be called for all RmaReleaseLock events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaRequestLockCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_RmaRequestLock  rmaRequestLockCallback 
)

Registers the callback for the RmaRequestLock event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
rmaRequestLockCallbackFunction which should be called for all RmaRequestLock events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaSyncCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_RmaSync  rmaSyncCallback 
)

Registers the callback for the RmaSync event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
rmaSyncCallbackFunction which should be called for all RmaSync events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaTryLockCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_RmaTryLock  rmaTryLockCallback 
)

Registers the callback for the RmaTryLock event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
rmaTryLockCallbackFunction which should be called for all RmaTryLock events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaWaitChangeCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_RmaWaitChange  rmaWaitChangeCallback 
)

Registers the callback for the RmaWaitChange event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
rmaWaitChangeCallbackFunction which should be called for all RmaWaitChange events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaWinCreateCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_RmaWinCreate  rmaWinCreateCallback 
)

Registers the callback for the RmaWinCreate event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
rmaWinCreateCallbackFunction which should be called for all RmaWinCreate events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetRmaWinDestroyCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_RmaWinDestroy  rmaWinDestroyCallback 
)

Registers the callback for the RmaWinDestroy event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
rmaWinDestroyCallbackFunction which should be called for all RmaWinDestroy events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetThreadAcquireLockCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_ThreadAcquireLock  threadAcquireLockCallback 
)

Registers the callback for the ThreadAcquireLock event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
threadAcquireLockCallbackFunction which should be called for all ThreadAcquireLock events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetThreadForkCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_ThreadFork  threadForkCallback 
)

Registers the callback for the ThreadFork event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
threadForkCallbackFunction which should be called for all ThreadFork events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetThreadJoinCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_ThreadJoin  threadJoinCallback 
)

Registers the callback for the ThreadJoin event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
threadJoinCallbackFunction which should be called for all ThreadJoin events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetThreadReleaseLockCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_ThreadReleaseLock  threadReleaseLockCallback 
)

Registers the callback for the ThreadReleaseLock event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
threadReleaseLockCallbackFunction which should be called for all ThreadReleaseLock events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetThreadTaskCompleteCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_ThreadTaskComplete  threadTaskCompleteCallback 
)

Registers the callback for the ThreadTaskComplete event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
threadTaskCompleteCallbackFunction which should be called for all ThreadTaskComplete events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetThreadTaskCreateCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_ThreadTaskCreate  threadTaskCreateCallback 
)

Registers the callback for the ThreadTaskCreate event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
threadTaskCreateCallbackFunction which should be called for all ThreadTaskCreate events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetThreadTaskSwitchCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_ThreadTaskSwitch  threadTaskSwitchCallback 
)

Registers the callback for the ThreadTaskSwitch event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
threadTaskSwitchCallbackFunction which should be called for all ThreadTaskSwitch events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetThreadTeamBeginCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_ThreadTeamBegin  threadTeamBeginCallback 
)

Registers the callback for the ThreadTeamBegin event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
threadTeamBeginCallbackFunction which should be called for all ThreadTeamBegin events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetThreadTeamEndCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_ThreadTeamEnd  threadTeamEndCallback 
)

Registers the callback for the ThreadTeamEnd event.

Parameters:
globalEvtReaderCallbacksStruct for all callbacks.
threadTeamEndCallbackFunction which should be called for all ThreadTeamEnd events.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalEvtReaderCallbacks_SetUnknownCallback ( OTF2_GlobalEvtReaderCallbacks globalEvtReaderCallbacks,
OTF2_GlobalEvtReaderCallback_Unknown  unknownCallback 
)

Registers the callback for unknown events.

Parameters:
globalEvtReaderCallbacksStruct 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