32 #ifndef OTF2_GLOBAL_DEF_WRITER_H
33 #define OTF2_GLOBAL_DEF_WRITER_H
88 uint64_t* numberOfDefinitions );
101 uint64_t* numberOfLocations );
128 uint64_t timerResolution,
129 uint64_t globalOffset,
130 uint64_t traceLength,
131 uint64_t realtimeTimestamp );
227 uint8_t numberOfProperties,
248 const char*
string );
365 uint64_t numberOfEvents,
406 uint32_t beginLineNumber,
407 uint32_t endLineNumber );
490 uint32_t numberOfMembers,
491 const uint64_t* members );
575 uint8_t numberOfMetrics,
871 uint8_t numberOfDimensions,
898 uint8_t numberOfDimensions,
899 const uint32_t* coordinates );
927 uint32_t lineNumber );
uint32_t OTF2_GroupFlag
Wrapper for enum OTF2_GroupFlag_enum.
Definition: OTF2_Definitions.h:468
OTF2_ErrorCode OTF2_GlobalDefWriter_GetNumberOfLocations(OTF2_GlobalDefWriter *writerHandle, uint64_t *numberOfLocations)
Returns the current number of written location definitions of a global definition writer...
uint8_t OTF2_ParameterType
Wrapper for enum OTF2_ParameterType_enum.
Definition: OTF2_Definitions.h:750
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteClockProperties(OTF2_GlobalDefWriter *writerHandle, uint64_t timerResolution, uint64_t globalOffset, uint64_t traceLength, uint64_t realtimeTimestamp)
Writes a ClockProperties definition record into the GlobalDefWriter.
uint64_t OTF2_LocationRef
Type used to indicate a reference to a Location definition.
Definition: OTF2_GeneralDefinitions.h:142
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteIoParadigm(OTF2_GlobalDefWriter *writerHandle, OTF2_IoParadigmRef self, OTF2_StringRef identification, OTF2_StringRef name, OTF2_IoParadigmClass ioParadigmClass, OTF2_IoParadigmFlag ioParadigmFlags, uint8_t numberOfProperties, const OTF2_IoParadigmProperty *properties, const OTF2_Type *types, const OTF2_AttributeValue *values)
Writes a IoParadigm definition record into the GlobalDefWriter.
uint8_t OTF2_ParadigmProperty
Wrapper for enum OTF2_ParadigmProperty_enum.
Definition: OTF2_GeneralDefinitions.h:1005
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteAttribute(OTF2_GlobalDefWriter *writerHandle, OTF2_AttributeRef self, OTF2_StringRef name, OTF2_StringRef description, OTF2_Type type)
Writes a Attribute definition record into the GlobalDefWriter.
uint8_t OTF2_MetricMode
Wrapper for enum OTF2_MetricMode_enum.
Definition: OTF2_Definitions.h:638
uint8_t OTF2_Type
Wrapper for enum OTF2_Type_enum.
Definition: OTF2_GeneralDefinitions.h:596
uint8_t OTF2_Base
Wrapper for enum OTF2_Base_enum.
Definition: OTF2_Definitions.h:492
uint8_t OTF2_Paradigm
Wrapper for enum OTF2_Paradigm_enum.
Definition: OTF2_GeneralDefinitions.h:778
uint32_t OTF2_StringRef
Type used to indicate a reference to a String definition.
Definition: OTF2_GeneralDefinitions.h:118
uint8_t OTF2_IoParadigmRef
Type used to indicate a reference to a IoParadigm definition.
Definition: OTF2_GeneralDefinitions.h:112
uint32_t OTF2_CommFlag
Wrapper for enum OTF2_CommFlag_enum.
Definition: OTF2_Definitions.h:1060
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteMetricMember(OTF2_GlobalDefWriter *writerHandle, OTF2_MetricMemberRef self, OTF2_StringRef name, OTF2_StringRef description, OTF2_MetricType metricType, OTF2_MetricMode metricMode, OTF2_Type valueType, OTF2_Base base, int64_t exponent, OTF2_StringRef unit)
Writes a MetricMember definition record into the GlobalDefWriter.
uint8_t OTF2_RecorderKind
Wrapper for enum OTF2_RecorderKind_enum.
Definition: OTF2_Definitions.h:719
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteRegion(OTF2_GlobalDefWriter *writerHandle, OTF2_RegionRef self, OTF2_StringRef name, OTF2_StringRef canonicalName, OTF2_StringRef description, OTF2_RegionRole regionRole, OTF2_Paradigm paradigm, OTF2_RegionFlag regionFlags, OTF2_StringRef sourceFile, uint32_t beginLineNumber, uint32_t endLineNumber)
Writes a Region definition record into the GlobalDefWriter.
OTF2_ErrorCode OTF2_GlobalDefWriter_GetNumberOfDefinitions(OTF2_GlobalDefWriter *writerHandle, uint64_t *numberOfDefinitions)
Returns the current number of written definitions of a global definition writer.
Declares the OTF2_AttributeValue and provides convenience functions to convert from and to OTF2 enum ...
uint32_t OTF2_ParameterRef
Type used to indicate a reference to a Parameter definition.
Definition: OTF2_GeneralDefinitions.h:190
uint8_t OTF2_RegionRole
Wrapper for enum OTF2_RegionRole_enum.
Definition: OTF2_Definitions.h:192
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteCallpathParameter(OTF2_GlobalDefWriter *writerHandle, OTF2_CallpathRef callpath, OTF2_ParameterRef parameter, OTF2_Type type, OTF2_AttributeValue value)
Writes a CallpathParameter definition record into the GlobalDefWriter.
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteSystemTreeNodeProperty(OTF2_GlobalDefWriter *writerHandle, OTF2_SystemTreeNodeRef systemTreeNode, OTF2_StringRef name, OTF2_Type type, OTF2_AttributeValue value)
Writes a SystemTreeNodeProperty definition record into the GlobalDefWriter.
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteCallsite(OTF2_GlobalDefWriter *writerHandle, OTF2_CallsiteRef self, OTF2_StringRef sourceFile, uint32_t lineNumber, OTF2_RegionRef enteredRegion, OTF2_RegionRef leftRegion)
Writes a Callsite definition record into the GlobalDefWriter.
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteCartTopology(OTF2_GlobalDefWriter *writerHandle, OTF2_CartTopologyRef self, OTF2_StringRef name, OTF2_CommRef communicator, uint8_t numberOfDimensions, const OTF2_CartDimensionRef *cartDimensions)
Writes a CartTopology definition record into the GlobalDefWriter.
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteLocationGroupProperty(OTF2_GlobalDefWriter *writerHandle, OTF2_LocationGroupRef locationGroup, OTF2_StringRef name, OTF2_Type type, OTF2_AttributeValue value)
Writes a LocationGroupProperty definition record into the GlobalDefWriter.
uint32_t OTF2_IoHandleFlag
Wrapper for enum OTF2_IoHandleFlag_enum.
Definition: OTF2_Definitions.h:882
uint32_t OTF2_IoStatusFlag
Wrapper for enum OTF2_IoStatusFlag_enum.
Definition: OTF2_Definitions.h:974
OTF2_ErrorCode
Definition: OTF2_ErrorCodes.h:54
Data types used in the definition records.
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteMetricClass(OTF2_GlobalDefWriter *writerHandle, OTF2_MetricRef self, uint8_t numberOfMetrics, const OTF2_MetricMemberRef *metricMembers, OTF2_MetricOccurrence metricOccurrence, OTF2_RecorderKind recorderKind)
Writes a MetricClass definition record into the GlobalDefWriter.
uint32_t OTF2_InterruptGeneratorRef
Type used to indicate a reference to a InterruptGenerator definition.
Definition: OTF2_GeneralDefinitions.h:226
This header file provides general definitions which should be accessible in all internal and external...
uint8_t OTF2_ParadigmClass
Wrapper for enum OTF2_ParadigmClass_enum.
Definition: OTF2_GeneralDefinitions.h:977
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteCallingContext(OTF2_GlobalDefWriter *writerHandle, OTF2_CallingContextRef self, OTF2_RegionRef region, OTF2_SourceCodeLocationRef sourceCodeLocation, OTF2_CallingContextRef parent)
Writes a CallingContext definition record into the GlobalDefWriter.
uint8_t OTF2_MetricType
Wrapper for enum OTF2_MetricType_enum.
Definition: OTF2_Definitions.h:538
uint32_t OTF2_MetricMemberRef
Type used to indicate a reference to a MetricMember definition.
Definition: OTF2_GeneralDefinitions.h:172
uint32_t OTF2_IoHandleRef
Type used to indicate a reference to a IoHandle definition.
Definition: OTF2_GeneralDefinitions.h:238
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteLocation(OTF2_GlobalDefWriter *writerHandle, OTF2_LocationRef self, OTF2_StringRef name, OTF2_LocationType locationType, uint64_t numberOfEvents, OTF2_LocationGroupRef locationGroup)
Writes a Location definition record into the GlobalDefWriter.
uint8_t OTF2_InterruptGeneratorMode
Wrapper for enum OTF2_InterruptGeneratorMode_enum.
Definition: OTF2_Definitions.h:794
uint32_t OTF2_RmaWinFlag
Wrapper for enum OTF2_RmaWinFlag_enum.
Definition: OTF2_Definitions.h:1081
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteCartDimension(OTF2_GlobalDefWriter *writerHandle, OTF2_CartDimensionRef self, OTF2_StringRef name, uint32_t size, OTF2_CartPeriodicity cartPeriodicity)
Writes a CartDimension definition record into the GlobalDefWriter.
uint32_t OTF2_MetricRef
Type used to indicate a reference to a MetricClass, or a MetricInstance definition.
Definition: OTF2_GeneralDefinitions.h:178
uint8_t OTF2_LocationType
Wrapper for enum OTF2_LocationType_enum.
Definition: OTF2_Definitions.h:157
uint8_t OTF2_MetricOccurrence
Wrapper for enum OTF2_MetricOccurrence_enum.
Definition: OTF2_Definitions.h:512
uint8_t OTF2_LocationGroupType
Wrapper for enum OTF2_LocationGroupType_enum.
Definition: OTF2_Definitions.h:116
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteParameter(OTF2_GlobalDefWriter *writerHandle, OTF2_ParameterRef self, OTF2_StringRef name, OTF2_ParameterType parameterType)
Writes a Parameter definition record into the GlobalDefWriter.
uint8_t OTF2_IoParadigmClass
Wrapper for enum OTF2_IoParadigmClass_enum.
Definition: OTF2_Definitions.h:814
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteCallpath(OTF2_GlobalDefWriter *writerHandle, OTF2_CallpathRef self, OTF2_CallpathRef parent, OTF2_RegionRef region)
Writes a Callpath definition record into the GlobalDefWriter.
uint32_t OTF2_CallingContextRef
Type used to indicate a reference to a CallingContext definition.
Definition: OTF2_GeneralDefinitions.h:220
uint8_t OTF2_GroupType
Wrapper for enum OTF2_GroupType_enum.
Definition: OTF2_Definitions.h:405
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteRmaWin(OTF2_GlobalDefWriter *writerHandle, OTF2_RmaWinRef self, OTF2_StringRef name, OTF2_CommRef comm, OTF2_RmaWinFlag flags)
Writes a RmaWin definition record into the GlobalDefWriter.
Compiler feature test macros.
uint8_t OTF2_MetricScope
Wrapper for enum OTF2_MetricScope_enum.
Definition: OTF2_Definitions.h:691
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteString(OTF2_GlobalDefWriter *writerHandle, OTF2_StringRef self, const char *string)
Writes a String definition record into the GlobalDefWriter.
uint32_t OTF2_IoFileRef
Type used to indicate a reference to a IoRegularFile, or a IoDirectory definition.
Definition: OTF2_GeneralDefinitions.h:232
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteMetricClassRecorder(OTF2_GlobalDefWriter *writerHandle, OTF2_MetricRef metric, OTF2_LocationRef recorder)
Writes a MetricClassRecorder definition record into the GlobalDefWriter.
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteInterruptGenerator(OTF2_GlobalDefWriter *writerHandle, OTF2_InterruptGeneratorRef self, OTF2_StringRef name, OTF2_InterruptGeneratorMode interruptGeneratorMode, OTF2_Base base, int64_t exponent, uint64_t period)
Writes a InterruptGenerator definition record into the GlobalDefWriter.
uint32_t OTF2_SystemTreeNodeRef
Type used to indicate a reference to a SystemTreeNode definition.
Definition: OTF2_GeneralDefinitions.h:130
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteMetricInstance(OTF2_GlobalDefWriter *writerHandle, OTF2_MetricRef self, OTF2_MetricRef metricClass, OTF2_LocationRef recorder, OTF2_MetricScope metricScope, uint64_t scope)
Writes a MetricInstance definition record into the GlobalDefWriter.
uint32_t OTF2_IoParadigmFlag
Wrapper for enum OTF2_IoParadigmFlag_enum.
Definition: OTF2_Definitions.h:843
uint32_t OTF2_CartTopologyRef
Type used to indicate a reference to a CartTopology definition.
Definition: OTF2_GeneralDefinitions.h:208
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteLocationProperty(OTF2_GlobalDefWriter *writerHandle, OTF2_LocationRef location, OTF2_StringRef name, OTF2_Type type, OTF2_AttributeValue value)
Writes a LocationProperty definition record into the GlobalDefWriter.
uint8_t OTF2_CartPeriodicity
Wrapper for enum OTF2_CartPeriodicity_enum.
Definition: OTF2_Definitions.h:774
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteSystemTreeNode(OTF2_GlobalDefWriter *writerHandle, OTF2_SystemTreeNodeRef self, OTF2_StringRef name, OTF2_StringRef className, OTF2_SystemTreeNodeRef parent)
Writes a SystemTreeNode definition record into the GlobalDefWriter.
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteComm(OTF2_GlobalDefWriter *writerHandle, OTF2_CommRef self, OTF2_StringRef name, OTF2_GroupRef group, OTF2_CommRef parent, OTF2_CommFlag flags)
Writes a Comm definition record into the GlobalDefWriter.
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteInterComm(OTF2_GlobalDefWriter *writerHandle, OTF2_CommRef self, OTF2_StringRef name, OTF2_GroupRef groupA, OTF2_GroupRef groupB, OTF2_CommRef commonCommunicator, OTF2_CommFlag flags)
Writes a InterComm definition record into the GlobalDefWriter.
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteCallingContextProperty(OTF2_GlobalDefWriter *writerHandle, OTF2_CallingContextRef callingContext, OTF2_StringRef name, OTF2_Type type, OTF2_AttributeValue value)
Writes a CallingContextProperty definition record into the GlobalDefWriter.
uint32_t OTF2_SourceCodeLocationRef
Type used to indicate a reference to a SourceCodeLocation definition.
Definition: OTF2_GeneralDefinitions.h:214
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteParadigmProperty(OTF2_GlobalDefWriter *writerHandle, OTF2_Paradigm paradigm, OTF2_ParadigmProperty property, OTF2_Type type, OTF2_AttributeValue value)
Writes a ParadigmProperty definition record into the GlobalDefWriter.
struct OTF2_GlobalDefWriter_struct OTF2_GlobalDefWriter
Typedef of the struct which keeps all necessary information of a global definition writer...
Definition: OTF2_GlobalDefWriter.h:75
uint32_t OTF2_CartDimensionRef
Type used to indicate a reference to a CartDimension definition.
Definition: OTF2_GeneralDefinitions.h:202
uint32_t OTF2_CommRef
Type used to indicate a reference to a Comm, or a InterComm definition.
Definition: OTF2_GeneralDefinitions.h:184
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteSystemTreeNodeDomain(OTF2_GlobalDefWriter *writerHandle, OTF2_SystemTreeNodeRef systemTreeNode, OTF2_SystemTreeDomain systemTreeDomain)
Writes a SystemTreeNodeDomain definition record into the GlobalDefWriter.
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteIoDirectory(OTF2_GlobalDefWriter *writerHandle, OTF2_IoFileRef self, OTF2_StringRef name, OTF2_SystemTreeNodeRef scope)
Writes a IoDirectory definition record into the GlobalDefWriter.
uint32_t OTF2_RegionFlag
Wrapper for enum OTF2_RegionFlag_enum.
Definition: OTF2_Definitions.h:378
uint32_t OTF2_RegionRef
Type used to indicate a reference to a Region definition.
Definition: OTF2_GeneralDefinitions.h:148
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteParadigm(OTF2_GlobalDefWriter *writerHandle, OTF2_Paradigm paradigm, OTF2_StringRef name, OTF2_ParadigmClass paradigmClass)
Writes a Paradigm definition record into the GlobalDefWriter.
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteCartCoordinate(OTF2_GlobalDefWriter *writerHandle, OTF2_CartTopologyRef cartTopology, uint32_t rank, uint8_t numberOfDimensions, const uint32_t *coordinates)
Writes a CartCoordinate definition record into the GlobalDefWriter.
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteGroup(OTF2_GlobalDefWriter *writerHandle, OTF2_GroupRef self, OTF2_StringRef name, OTF2_GroupType groupType, OTF2_Paradigm paradigm, OTF2_GroupFlag groupFlags, uint32_t numberOfMembers, const uint64_t *members)
Writes a Group definition record into the GlobalDefWriter.
uint32_t OTF2_GroupRef
Type used to indicate a reference to a Group definition.
Definition: OTF2_GeneralDefinitions.h:166
uint8_t OTF2_IoAccessMode
Wrapper for enum OTF2_IoAccessMode_enum.
Definition: OTF2_Definitions.h:925
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteIoRegularFile(OTF2_GlobalDefWriter *writerHandle, OTF2_IoFileRef self, OTF2_StringRef name, OTF2_SystemTreeNodeRef scope)
Writes a IoRegularFile definition record into the GlobalDefWriter.
uint32_t OTF2_AttributeRef
Type used to indicate a reference to a Attribute definition.
Definition: OTF2_GeneralDefinitions.h:124
Error codes and error handling.
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteSourceCodeLocation(OTF2_GlobalDefWriter *writerHandle, OTF2_SourceCodeLocationRef self, OTF2_StringRef file, uint32_t lineNumber)
Writes a SourceCodeLocation definition record into the GlobalDefWriter.
uint8_t OTF2_IoParadigmProperty
Wrapper for enum OTF2_IoParadigmProperty_enum.
Definition: OTF2_Definitions.h:864
uint32_t OTF2_RmaWinRef
Type used to indicate a reference to a RmaWin definition.
Definition: OTF2_GeneralDefinitions.h:196
Value container for an attributes.
Definition: OTF2_AttributeValue.h:52
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteIoPreCreatedHandleState(OTF2_GlobalDefWriter *writerHandle, OTF2_IoHandleRef ioHandle, OTF2_IoAccessMode mode, OTF2_IoStatusFlag statusFlags)
Writes a IoPreCreatedHandleState definition record into the GlobalDefWriter.
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteLocationGroup(OTF2_GlobalDefWriter *writerHandle, OTF2_LocationGroupRef self, OTF2_StringRef name, OTF2_LocationGroupType locationGroupType, OTF2_SystemTreeNodeRef systemTreeParent, OTF2_LocationGroupRef creatingLocationGroup)
Writes a LocationGroup definition record into the GlobalDefWriter.
uint32_t OTF2_CallpathRef
Type used to indicate a reference to a Callpath definition.
Definition: OTF2_GeneralDefinitions.h:160
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteIoHandle(OTF2_GlobalDefWriter *writerHandle, OTF2_IoHandleRef self, OTF2_StringRef name, OTF2_IoFileRef file, OTF2_IoParadigmRef ioParadigm, OTF2_IoHandleFlag ioHandleFlags, OTF2_CommRef comm, OTF2_IoHandleRef parent)
Writes a IoHandle definition record into the GlobalDefWriter.
OTF2_ErrorCode OTF2_GlobalDefWriter_WriteIoFileProperty(OTF2_GlobalDefWriter *writerHandle, OTF2_IoFileRef ioFile, OTF2_StringRef name, OTF2_Type type, OTF2_AttributeValue value)
Writes a IoFileProperty definition record into the GlobalDefWriter.
uint32_t OTF2_CallsiteRef
Type used to indicate a reference to a Callsite definition.
Definition: OTF2_GeneralDefinitions.h:154
uint32_t OTF2_LocationGroupRef
Type used to indicate a reference to a LocationGroup definition.
Definition: OTF2_GeneralDefinitions.h:136
uint8_t OTF2_SystemTreeDomain
Wrapper for enum OTF2_SystemTreeDomain_enum.
Definition: OTF2_Definitions.h:59