32 #ifndef OTF2_EVT_WRITER_H
33 #define OTF2_EVT_WRITER_H
134 uint64_t* numberOfEvents );
256 uint64_t msgLength );
290 uint64_t requestID );
310 uint64_t requestID );
330 uint64_t requestID );
362 uint64_t msgLength );
396 uint64_t requestID );
417 uint64_t requestID );
437 uint64_t requestID );
490 uint64_t sizeReceived );
516 uint32_t numberOfRequestedThreads );
573 uint32_t acquisitionOrder );
605 uint32_t acquisitionOrder );
721 uint8_t numberOfMetrics,
903 uint64_t bytesReceived );
1139 uint64_t matchingId );
1169 uint64_t matchingId );
1202 uint64_t bytesReceived,
1203 uint64_t matchingId );
1230 uint64_t matchingId );
1257 uint64_t matchingId );
1284 uint64_t matchingId );
1311 uint64_t matchingId );
1333 uint32_t numberOfRequestedThreads );
1426 uint32_t acquisitionOrder );
1454 uint32_t acquisitionOrder );
1482 uint32_t creatingThread,
1483 uint32_t generationNumber );
1513 uint32_t creatingThread,
1514 uint32_t generationNumber );
1542 uint32_t creatingThread,
1543 uint32_t generationNumber );
1570 uint64_t sequenceCount );
1597 uint64_t sequenceCount );
1624 uint64_t sequenceCount );
1653 uint64_t sequenceCount );
1693 uint32_t unwindDistance );
1775 uint32_t unwindDistance,
1790 uint32_t rewindId );
1804 uint32_t rewindId );
1818 uint32_t rewindId );
uint8_t OTF2_RmaSyncType
Wrapper for enum OTF2_RmaSyncType_enum.
Definition: OTF2_Events.h:164
OTF2_ErrorCode OTF2_EvtWriter_RmaOpTest(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint64_t matchingId)
Records a RmaOpTest event.
OTF2_ErrorCode OTF2_EvtWriter_ThreadCreate(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadContingent, uint64_t sequenceCount)
Records a ThreadCreate event.
OTF2_ErrorCode OTF2_EvtWriter_StoreRewindPoint(OTF2_EvtWriter *writer, uint32_t rewindId)
Please give me a documentation.
OTF2_ErrorCode OTF2_EvtWriter_GetNumberOfEvents(OTF2_EvtWriter *writer, uint64_t *numberOfEvents)
Get the number of events.
uint64_t OTF2_LocationRef
Type used to indicate a reference to a Location definition.
Definition: OTF2_GeneralDefinitions.h:125
OTF2_ErrorCode OTF2_EvtWriter_RmaGet(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, uint64_t bytes, uint64_t matchingId)
Records a RmaGet event.
OTF2_ErrorCode OTF2_EvtWriter_SetLocationID(OTF2_EvtWriter *writer, OTF2_LocationRef location)
The location ID is not always known on measurement start, and only needed on the first buffer flush t...
uint8_t OTF2_Type
Wrapper for enum OTF2_Type_enum.
Definition: OTF2_GeneralDefinitions.h:525
OTF2_ErrorCode OTF2_EvtWriter_ThreadTaskSwitch(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadTeam, uint32_t creatingThread, uint32_t generationNumber)
Records a ThreadTaskSwitch event.
OTF2_ErrorCode OTF2_EvtWriter_RmaOpCompleteRemote(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint64_t matchingId)
Records a RmaOpCompleteRemote event.
uint8_t OTF2_Paradigm
Wrapper for enum OTF2_Paradigm_enum.
Definition: OTF2_GeneralDefinitions.h:661
OTF2_ErrorCode OTF2_EvtWriter_RmaCollectiveEnd(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CollectiveOp collectiveOp, OTF2_RmaSyncLevel syncLevel, OTF2_RmaWinRef win, uint32_t root, uint64_t bytesSent, uint64_t bytesReceived)
Records a RmaCollectiveEnd event.
uint32_t OTF2_StringRef
Type used to indicate a reference to a String definition.
Definition: OTF2_GeneralDefinitions.h:101
OTF2_ErrorCode OTF2_EvtWriter_RmaTryLock(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId, OTF2_LockType lockType)
Records a RmaTryLock event.
OTF2_ErrorCode OTF2_EvtWriter_MpiIrecvRequest(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t requestID)
Records a MpiIrecvRequest event.
OTF2_ErrorCode OTF2_EvtWriter_RmaAtomic(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, OTF2_RmaAtomicType type, uint64_t bytesSent, uint64_t bytesReceived, uint64_t matchingId)
Records a RmaAtomic event.
Enums and types used in event records.
uint8_t OTF2_MeasurementMode
Wrapper for enum OTF2_MeasurementMode_enum.
Definition: OTF2_Events.h:56
Metric value.
Definition: OTF2_Events.h:269
uint32_t OTF2_ParameterRef
Type used to indicate a reference to a Parameter definition.
Definition: OTF2_GeneralDefinitions.h:173
This layer enables dynamic appending of arbitrary attributes to any type of event record...
uint8_t OTF2_RmaAtomicType
Wrapper for enum OTF2_RmaAtomicType_enum.
Definition: OTF2_Events.h:229
uint32_t OTF2_RmaSyncLevel
Wrapper for enum OTF2_RmaSyncLevel_enum.
Definition: OTF2_Events.h:186
OTF2_ErrorCode OTF2_EvtWriter_ParameterString(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_ParameterRef parameter, OTF2_StringRef string)
Records a ParameterString event.
OTF2_ErrorCode OTF2_EvtWriter_MpiCollectiveBegin(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time)
Records a MpiCollectiveBegin event.
struct OTF2_AttributeList_struct OTF2_AttributeList
Attribute list handle.
Definition: OTF2_AttributeList.h:104
OTF2_ErrorCode
Definition: OTF2_ErrorCodes.h:54
OTF2_ErrorCode OTF2_EvtWriter_ThreadTaskComplete(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadTeam, uint32_t creatingThread, uint32_t generationNumber)
Records a ThreadTaskComplete event.
OTF2_ErrorCode OTF2_EvtWriter_OmpTaskComplete(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t taskID)
Records a OmpTaskComplete event.
OTF2_ErrorCode OTF2_EvtWriter_RmaGroupSync(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaSyncLevel syncLevel, OTF2_RmaWinRef win, OTF2_GroupRef group)
Records a RmaGroupSync event.
OTF2_ErrorCode OTF2_EvtWriter_GetLocationID(const OTF2_EvtWriter *writer, OTF2_LocationRef *locationID)
Function to get the location ID of a writer object.
OTF2_ErrorCode OTF2_EvtWriter_OmpReleaseLock(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint32_t lockID, uint32_t acquisitionOrder)
Records a OmpReleaseLock event.
uint32_t OTF2_InterruptGeneratorRef
Type used to indicate a reference to a InterruptGenerator definition.
Definition: OTF2_GeneralDefinitions.h:209
uint8_t OTF2_LockType
Wrapper for enum OTF2_LockType_enum.
Definition: OTF2_Events.h:209
OTF2_ErrorCode OTF2_EvtWriter_ThreadTeamBegin(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadTeam)
Records a ThreadTeamBegin event.
OTF2_ErrorCode OTF2_EvtWriter_ThreadTaskCreate(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadTeam, uint32_t creatingThread, uint32_t generationNumber)
Records a ThreadTaskCreate event.
OTF2_ErrorCode OTF2_EvtWriter_MpiIsendComplete(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t requestID)
Records a MpiIsendComplete event.
OTF2_ErrorCode OTF2_EvtWriter_RmaRequestLock(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId, OTF2_LockType lockType)
Records a RmaRequestLock event.
uint64_t OTF2_TimeStamp
OTF2 time stamp.
Definition: OTF2_GeneralDefinitions.h:95
OTF2_ErrorCode OTF2_EvtWriter_RmaWaitChange(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win)
Records a RmaWaitChange event.
OTF2_ErrorCode OTF2_EvtWriter_ParameterUnsignedInt(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_ParameterRef parameter, uint64_t value)
Records a ParameterUnsignedInt event.
OTF2_ErrorCode OTF2_EvtWriter_Leave(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RegionRef region)
Records a Leave event.
OTF2_ErrorCode OTF2_EvtWriter_MpiIsend(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint32_t receiver, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength, uint64_t requestID)
Records a MpiIsend event.
OTF2_ErrorCode OTF2_EvtWriter_RmaAcquireLock(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId, OTF2_LockType lockType)
Records a RmaAcquireLock event.
uint32_t OTF2_MetricRef
Type used to indicate a reference to a MetricClass, or a MetricInstance definition.
Definition: OTF2_GeneralDefinitions.h:161
OTF2_ErrorCode OTF2_EvtWriter_OmpAcquireLock(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint32_t lockID, uint32_t acquisitionOrder)
Records a OmpAcquireLock event.
OTF2_ErrorCode OTF2_EvtWriter_MpiRequestCancelled(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t requestID)
Records a MpiRequestCancelled event.
OTF2_ErrorCode OTF2_EvtWriter_RmaReleaseLock(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId)
Records a RmaReleaseLock event.
OTF2_ErrorCode OTF2_EvtWriter_OmpJoin(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time)
Records a OmpJoin event.
OTF2_ErrorCode OTF2_EvtWriter_OmpFork(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint32_t numberOfRequestedThreads)
Records a OmpFork event.
uint32_t OTF2_CallingContextRef
Type used to indicate a reference to a CallingContext definition.
Definition: OTF2_GeneralDefinitions.h:203
OTF2_ErrorCode OTF2_EvtWriter_SetUserData(OTF2_EvtWriter *writer, void *userData)
Function to set user defined data to a writer object.
OTF2_ErrorCode OTF2_EvtWriter_RmaOpCompleteNonBlocking(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint64_t matchingId)
Records a RmaOpCompleteNonBlocking event.
OTF2_ErrorCode OTF2_EvtWriter_MpiCollectiveEnd(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CollectiveOp collectiveOp, OTF2_CommRef communicator, uint32_t root, uint64_t sizeSent, uint64_t sizeReceived)
Records a MpiCollectiveEnd event.
uint8_t OTF2_CollectiveOp
Wrapper for enum OTF2_CollectiveOp_enum.
Definition: OTF2_Events.h:75
OTF2_ErrorCode OTF2_EvtWriter_MpiRequestTest(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t requestID)
Records a MpiRequestTest event.
OTF2_ErrorCode OTF2_EvtWriter_OmpTaskSwitch(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t taskID)
Records a OmpTaskSwitch event.
OTF2_ErrorCode OTF2_EvtWriter_OmpTaskCreate(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t taskID)
Records a OmpTaskCreate event.
OTF2_ErrorCode OTF2_EvtWriter_ThreadEnd(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadContingent, uint64_t sequenceCount)
Records a ThreadEnd event.
OTF2_ErrorCode OTF2_EvtWriter_Metric(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_MetricRef metric, uint8_t numberOfMetrics, const OTF2_Type *typeIDs, const OTF2_MetricValue *metricValues)
Records a Metric event.
OTF2_ErrorCode OTF2_EvtWriter_RmaWinCreate(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win)
Records a RmaWinCreate event.
OTF2_ErrorCode OTF2_EvtWriter_Enter(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RegionRef region)
Records a Enter event.
OTF2_ErrorCode OTF2_EvtWriter_MpiSend(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint32_t receiver, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength)
Records a MpiSend event.
OTF2_ErrorCode OTF2_EvtWriter_GetUserData(const OTF2_EvtWriter *writer, void **userData)
Function to get the location of a writer object.
OTF2_ErrorCode OTF2_EvtWriter_ThreadWait(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadContingent, uint64_t sequenceCount)
Records a ThreadWait event.
OTF2_ErrorCode OTF2_EvtWriter_MpiIrecv(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint32_t sender, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength, uint64_t requestID)
Records a MpiIrecv event.
OTF2_ErrorCode OTF2_EvtWriter_CallingContextEnter(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CallingContextRef callingContext, uint32_t unwindDistance)
Records a CallingContextEnter event.
OTF2_ErrorCode OTF2_EvtWriter_CallingContextLeave(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CallingContextRef callingContext)
Records a CallingContextLeave event.
OTF2_ErrorCode OTF2_EvtWriter_ThreadJoin(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_Paradigm model)
Records a ThreadJoin event.
OTF2_ErrorCode OTF2_EvtWriter_RmaCollectiveBegin(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time)
Records a RmaCollectiveBegin event.
OTF2_ErrorCode OTF2_EvtWriter_RmaWinDestroy(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win)
Records a RmaWinDestroy event.
OTF2_ErrorCode OTF2_EvtWriter_ClearRewindPoint(OTF2_EvtWriter *writer, uint32_t rewindId)
Please give me a documentation.
struct OTF2_EvtWriter_struct OTF2_EvtWriter
Keeps all necessary information about the event writer. See OTF2_EvtWriter_struct for detailed inform...
Definition: OTF2_EvtWriter.h:63
OTF2_ErrorCode OTF2_EvtWriter_ThreadAcquireLock(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_Paradigm model, uint32_t lockID, uint32_t acquisitionOrder)
Records a ThreadAcquireLock event.
uint32_t OTF2_CommRef
Type used to indicate a reference to a Comm definition.
Definition: OTF2_GeneralDefinitions.h:167
OTF2_ErrorCode OTF2_EvtWriter_BufferFlush(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_TimeStamp stopTime)
Records a BufferFlush event.
uint32_t OTF2_RegionRef
Type used to indicate a reference to a Region definition.
Definition: OTF2_GeneralDefinitions.h:131
OTF2_ErrorCode OTF2_EvtWriter_ThreadReleaseLock(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_Paradigm model, uint32_t lockID, uint32_t acquisitionOrder)
Records a ThreadReleaseLock event.
OTF2_ErrorCode OTF2_EvtWriter_ThreadFork(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_Paradigm model, uint32_t numberOfRequestedThreads)
Records a ThreadFork event.
OTF2_ErrorCode OTF2_EvtWriter_Rewind(OTF2_EvtWriter *writer, uint32_t rewindId)
Please give me a documentation.
OTF2_ErrorCode OTF2_EvtWriter_RmaPut(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, uint64_t bytes, uint64_t matchingId)
Records a RmaPut event.
uint32_t OTF2_GroupRef
Type used to indicate a reference to a Group definition.
Definition: OTF2_GeneralDefinitions.h:149
OTF2_ErrorCode OTF2_EvtWriter_ThreadTeamEnd(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadTeam)
Records a ThreadTeamEnd event.
OTF2_ErrorCode OTF2_EvtWriter_MpiRecv(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint32_t sender, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength)
Records a MpiRecv event.
OTF2_ErrorCode OTF2_EvtWriter_RmaSync(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, OTF2_RmaSyncType syncType)
Records a RmaSync event.
OTF2_ErrorCode OTF2_EvtWriter_CallingContextSample(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CallingContextRef callingContext, uint32_t unwindDistance, OTF2_InterruptGeneratorRef interruptGenerator)
Records a CallingContextSample event.
OTF2_ErrorCode OTF2_EvtWriter_RmaOpCompleteBlocking(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint64_t matchingId)
Records a RmaOpCompleteBlocking event.
Error codes and error handling.
uint32_t OTF2_RmaWinRef
Type used to indicate a reference to a RmaWin definition.
Definition: OTF2_GeneralDefinitions.h:179
OTF2_ErrorCode OTF2_EvtWriter_ParameterInt(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_ParameterRef parameter, int64_t value)
Records a ParameterInt event.
OTF2_ErrorCode OTF2_EvtWriter_ThreadBegin(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadContingent, uint64_t sequenceCount)
Records a ThreadBegin event.
OTF2_ErrorCode OTF2_EvtWriter_MeasurementOnOff(OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_MeasurementMode measurementMode)
Records a MeasurementOnOff event.