2.3 (revision 117c8d5b)
Typedefs | Functions
OTF2_DefReaderCallbacks.h File Reference

This defines the callbacks for the definition reader. More...

#include <stdint.h>
#include <otf2/OTF2_ErrorCodes.h>
#include <otf2/OTF2_GeneralDefinitions.h>
#include <otf2/OTF2_AttributeValue.h>
#include <otf2/OTF2_Definitions.h>
#include <otf2/OTF2_IdMap.h>

Go to the source code of this file.

Typedefs

typedef struct OTF2_DefReaderCallbacks_struct OTF2_DefReaderCallbacks
 Opaque struct which holds all definition record callbacks.
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_Unknown) (void *userData)
 Function pointer definition for the callback which is triggered for an unknown definition. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_MappingTable) (void *userData, OTF2_MappingType mappingType, const OTF2_IdMap *idMap)
 Function pointer definition for the callback which is triggered by a MappingTable definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_ClockOffset) (void *userData, OTF2_TimeStamp time, int64_t offset, double standardDeviation)
 Function pointer definition for the callback which is triggered by a ClockOffset definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_String) (void *userData, OTF2_StringRef self, const char *string)
 Function pointer definition for the callback which is triggered by a String definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_Attribute) (void *userData, OTF2_AttributeRef self, OTF2_StringRef name, OTF2_StringRef description, OTF2_Type type)
 Function pointer definition for the callback which is triggered by a Attribute definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_SystemTreeNode) (void *userData, OTF2_SystemTreeNodeRef self, OTF2_StringRef name, OTF2_StringRef className, OTF2_SystemTreeNodeRef parent)
 Function pointer definition for the callback which is triggered by a SystemTreeNode definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_LocationGroup) (void *userData, OTF2_LocationGroupRef self, OTF2_StringRef name, OTF2_LocationGroupType locationGroupType, OTF2_SystemTreeNodeRef systemTreeParent)
 Function pointer definition for the callback which is triggered by a LocationGroup definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_Location) (void *userData, OTF2_LocationRef self, OTF2_StringRef name, OTF2_LocationType locationType, uint64_t numberOfEvents, OTF2_LocationGroupRef locationGroup)
 Function pointer definition for the callback which is triggered by a Location definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_Region) (void *userData, 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)
 Function pointer definition for the callback which is triggered by a Region definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_Callsite) (void *userData, OTF2_CallsiteRef self, OTF2_StringRef sourceFile, uint32_t lineNumber, OTF2_RegionRef enteredRegion, OTF2_RegionRef leftRegion)
 Function pointer definition for the callback which is triggered by a Callsite definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_Callpath) (void *userData, OTF2_CallpathRef self, OTF2_CallpathRef parent, OTF2_RegionRef region)
 Function pointer definition for the callback which is triggered by a Callpath definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_Group) (void *userData, OTF2_GroupRef self, OTF2_StringRef name, OTF2_GroupType groupType, OTF2_Paradigm paradigm, OTF2_GroupFlag groupFlags, uint32_t numberOfMembers, const uint64_t *members)
 Function pointer definition for the callback which is triggered by a Group definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_MetricMember) (void *userData, 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)
 Function pointer definition for the callback which is triggered by a MetricMember definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_MetricClass) (void *userData, OTF2_MetricRef self, uint8_t numberOfMetrics, const OTF2_MetricMemberRef *metricMembers, OTF2_MetricOccurrence metricOccurrence, OTF2_RecorderKind recorderKind)
 Function pointer definition for the callback which is triggered by a MetricClass definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_MetricInstance) (void *userData, OTF2_MetricRef self, OTF2_MetricRef metricClass, OTF2_LocationRef recorder, OTF2_MetricScope metricScope, uint64_t scope)
 Function pointer definition for the callback which is triggered by a MetricInstance definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_Comm) (void *userData, OTF2_CommRef self, OTF2_StringRef name, OTF2_GroupRef group, OTF2_CommRef parent)
 Function pointer definition for the callback which is triggered by a Comm definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_Parameter) (void *userData, OTF2_ParameterRef self, OTF2_StringRef name, OTF2_ParameterType parameterType)
 Function pointer definition for the callback which is triggered by a Parameter definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_RmaWin) (void *userData, OTF2_RmaWinRef self, OTF2_StringRef name, OTF2_CommRef comm)
 Function pointer definition for the callback which is triggered by a RmaWin definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_MetricClassRecorder) (void *userData, OTF2_MetricRef metric, OTF2_LocationRef recorder)
 Function pointer definition for the callback which is triggered by a MetricClassRecorder definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_SystemTreeNodeProperty) (void *userData, OTF2_SystemTreeNodeRef systemTreeNode, OTF2_StringRef name, OTF2_Type type, OTF2_AttributeValue value)
 Function pointer definition for the callback which is triggered by a SystemTreeNodeProperty definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_SystemTreeNodeDomain) (void *userData, OTF2_SystemTreeNodeRef systemTreeNode, OTF2_SystemTreeDomain systemTreeDomain)
 Function pointer definition for the callback which is triggered by a SystemTreeNodeDomain definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_LocationGroupProperty) (void *userData, OTF2_LocationGroupRef locationGroup, OTF2_StringRef name, OTF2_Type type, OTF2_AttributeValue value)
 Function pointer definition for the callback which is triggered by a LocationGroupProperty definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_LocationProperty) (void *userData, OTF2_LocationRef location, OTF2_StringRef name, OTF2_Type type, OTF2_AttributeValue value)
 Function pointer definition for the callback which is triggered by a LocationProperty definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_CartDimension) (void *userData, OTF2_CartDimensionRef self, OTF2_StringRef name, uint32_t size, OTF2_CartPeriodicity cartPeriodicity)
 Function pointer definition for the callback which is triggered by a CartDimension definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_CartTopology) (void *userData, OTF2_CartTopologyRef self, OTF2_StringRef name, OTF2_CommRef communicator, uint8_t numberOfDimensions, const OTF2_CartDimensionRef *cartDimensions)
 Function pointer definition for the callback which is triggered by a CartTopology definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_CartCoordinate) (void *userData, OTF2_CartTopologyRef cartTopology, uint32_t rank, uint8_t numberOfDimensions, const uint32_t *coordinates)
 Function pointer definition for the callback which is triggered by a CartCoordinate definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_SourceCodeLocation) (void *userData, OTF2_SourceCodeLocationRef self, OTF2_StringRef file, uint32_t lineNumber)
 Function pointer definition for the callback which is triggered by a SourceCodeLocation definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_CallingContext) (void *userData, OTF2_CallingContextRef self, OTF2_RegionRef region, OTF2_SourceCodeLocationRef sourceCodeLocation, OTF2_CallingContextRef parent)
 Function pointer definition for the callback which is triggered by a CallingContext definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_CallingContextProperty) (void *userData, OTF2_CallingContextRef callingContext, OTF2_StringRef name, OTF2_Type type, OTF2_AttributeValue value)
 Function pointer definition for the callback which is triggered by a CallingContextProperty definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_InterruptGenerator) (void *userData, OTF2_InterruptGeneratorRef self, OTF2_StringRef name, OTF2_InterruptGeneratorMode interruptGeneratorMode, OTF2_Base base, int64_t exponent, uint64_t period)
 Function pointer definition for the callback which is triggered by a InterruptGenerator definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_IoFileProperty) (void *userData, OTF2_IoFileRef ioFile, OTF2_StringRef name, OTF2_Type type, OTF2_AttributeValue value)
 Function pointer definition for the callback which is triggered by a IoFileProperty definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_IoRegularFile) (void *userData, OTF2_IoFileRef self, OTF2_StringRef name, OTF2_SystemTreeNodeRef scope)
 Function pointer definition for the callback which is triggered by a IoRegularFile definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_IoDirectory) (void *userData, OTF2_IoFileRef self, OTF2_StringRef name, OTF2_SystemTreeNodeRef scope)
 Function pointer definition for the callback which is triggered by a IoDirectory definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_IoHandle) (void *userData, OTF2_IoHandleRef self, OTF2_StringRef name, OTF2_IoFileRef file, OTF2_IoParadigmRef ioParadigm, OTF2_IoHandleFlag ioHandleFlags, OTF2_CommRef comm, OTF2_IoHandleRef parent)
 Function pointer definition for the callback which is triggered by a IoHandle definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_IoPreCreatedHandleState) (void *userData, OTF2_IoHandleRef ioHandle, OTF2_IoAccessMode mode, OTF2_IoStatusFlag statusFlags)
 Function pointer definition for the callback which is triggered by a IoPreCreatedHandleState definition record. More...
 
typedef OTF2_CallbackCode(* OTF2_DefReaderCallback_CallpathParameter) (void *userData, OTF2_CallpathRef callpath, OTF2_ParameterRef parameter, OTF2_Type type, OTF2_AttributeValue value)
 Function pointer definition for the callback which is triggered by a CallpathParameter definition record. More...
 

Functions

OTF2_DefReaderCallbacksOTF2_DefReaderCallbacks_New (void)
 Allocates a new struct for the definition callbacks. More...
 
void OTF2_DefReaderCallbacks_Delete (OTF2_DefReaderCallbacks *defReaderCallbacks)
 Deallocates a struct for the definition callbacks. More...
 
void OTF2_DefReaderCallbacks_Clear (OTF2_DefReaderCallbacks *defReaderCallbacks)
 Clears a struct for the definition callbacks. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetUnknownCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_Unknown unknownCallback)
 Registers the callback for an unknown definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetMappingTableCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_MappingTable mappingTableCallback)
 Registers the callback for the MappingTable definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetClockOffsetCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_ClockOffset clockOffsetCallback)
 Registers the callback for the ClockOffset definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetStringCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_String stringCallback)
 Registers the callback for the String definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetAttributeCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_Attribute attributeCallback)
 Registers the callback for the Attribute definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetSystemTreeNodeCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_SystemTreeNode systemTreeNodeCallback)
 Registers the callback for the SystemTreeNode definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetLocationGroupCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_LocationGroup locationGroupCallback)
 Registers the callback for the LocationGroup definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetLocationCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_Location locationCallback)
 Registers the callback for the Location definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetRegionCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_Region regionCallback)
 Registers the callback for the Region definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetCallsiteCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_Callsite callsiteCallback)
 Registers the callback for the Callsite definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetCallpathCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_Callpath callpathCallback)
 Registers the callback for the Callpath definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetGroupCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_Group groupCallback)
 Registers the callback for the Group definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetMetricMemberCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_MetricMember metricMemberCallback)
 Registers the callback for the MetricMember definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetMetricClassCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_MetricClass metricClassCallback)
 Registers the callback for the MetricClass definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetMetricInstanceCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_MetricInstance metricInstanceCallback)
 Registers the callback for the MetricInstance definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetCommCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_Comm commCallback)
 Registers the callback for the Comm definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetParameterCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_Parameter parameterCallback)
 Registers the callback for the Parameter definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetRmaWinCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_RmaWin rmaWinCallback)
 Registers the callback for the RmaWin definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetMetricClassRecorderCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_MetricClassRecorder metricClassRecorderCallback)
 Registers the callback for the MetricClassRecorder definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetSystemTreeNodePropertyCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_SystemTreeNodeProperty systemTreeNodePropertyCallback)
 Registers the callback for the SystemTreeNodeProperty definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetSystemTreeNodeDomainCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_SystemTreeNodeDomain systemTreeNodeDomainCallback)
 Registers the callback for the SystemTreeNodeDomain definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetLocationGroupPropertyCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_LocationGroupProperty locationGroupPropertyCallback)
 Registers the callback for the LocationGroupProperty definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetLocationPropertyCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_LocationProperty locationPropertyCallback)
 Registers the callback for the LocationProperty definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetCartDimensionCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_CartDimension cartDimensionCallback)
 Registers the callback for the CartDimension definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetCartTopologyCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_CartTopology cartTopologyCallback)
 Registers the callback for the CartTopology definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetCartCoordinateCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_CartCoordinate cartCoordinateCallback)
 Registers the callback for the CartCoordinate definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetSourceCodeLocationCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_SourceCodeLocation sourceCodeLocationCallback)
 Registers the callback for the SourceCodeLocation definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetCallingContextCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_CallingContext callingContextCallback)
 Registers the callback for the CallingContext definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetCallingContextPropertyCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_CallingContextProperty callingContextPropertyCallback)
 Registers the callback for the CallingContextProperty definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetInterruptGeneratorCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_InterruptGenerator interruptGeneratorCallback)
 Registers the callback for the InterruptGenerator definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetIoFilePropertyCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_IoFileProperty ioFilePropertyCallback)
 Registers the callback for the IoFileProperty definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetIoRegularFileCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_IoRegularFile ioRegularFileCallback)
 Registers the callback for the IoRegularFile definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetIoDirectoryCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_IoDirectory ioDirectoryCallback)
 Registers the callback for the IoDirectory definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetIoHandleCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_IoHandle ioHandleCallback)
 Registers the callback for the IoHandle definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetIoPreCreatedHandleStateCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_IoPreCreatedHandleState ioPreCreatedHandleStateCallback)
 Registers the callback for the IoPreCreatedHandleState definition. More...
 
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetCallpathParameterCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_CallpathParameter callpathParameterCallback)
 Registers the callback for the CallpathParameter definition. More...
 

Detailed Description

This defines the callbacks for the definition reader.

Source template^^ templates/OTF2_DefReaderCallbacks.tmpl.h

Typedef Documentation

typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_Unknown) (void *userData)

Function pointer definition for the callback which is triggered for an unknown definition.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_MappingTable) (void *userData, OTF2_MappingType mappingType, const OTF2_IdMap *idMap)

Function pointer definition for the callback which is triggered by a MappingTable definition record.

Mapping tables are needed for situations where an ID is not globally known at measurement time. They are applied automatically at reading.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
mappingTypeSays to what type of ID the mapping table has to be applied.
idMapMapping table.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_ClockOffset) (void *userData, OTF2_TimeStamp time, int64_t offset, double standardDeviation)

Function pointer definition for the callback which is triggered by a ClockOffset definition record.

Clock offsets are used for clock corrections.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
timeTime when this offset was determined.
offsetThe offset to the global clock which was determined at time.
standardDeviationA possible standard deviation, which can be used as a metric for the quality of the offset.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_String) (void *userData, OTF2_StringRef self, const char *string)

Function pointer definition for the callback which is triggered by a String definition record.

The string definition.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this String definition.
stringThe string, null terminated.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_Attribute) (void *userData, OTF2_AttributeRef self, OTF2_StringRef name, OTF2_StringRef description, OTF2_Type type)

Function pointer definition for the callback which is triggered by a Attribute definition record.

The attribute definition.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this Attribute definition.
nameName of the attribute. References a String definition.
descriptionDescription of the attribute. References a String definition. Since version 1.4.
typeType of the attribute value.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_SystemTreeNode) (void *userData, OTF2_SystemTreeNodeRef self, OTF2_StringRef name, OTF2_StringRef className, OTF2_SystemTreeNodeRef parent)

Function pointer definition for the callback which is triggered by a SystemTreeNode definition record.

The system tree node definition.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this SystemTreeNode definition.
nameFree form instance name of this node. References a String definition.
classNameFree form class name of this node References a String definition.
parentParent id of this node. May be OTF2_UNDEFINED_SYSTEM_TREE_NODE to indicate that there is no parent. References a SystemTreeNode definition.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_LocationGroup) (void *userData, OTF2_LocationGroupRef self, OTF2_StringRef name, OTF2_LocationGroupType locationGroupType, OTF2_SystemTreeNodeRef systemTreeParent)

Function pointer definition for the callback which is triggered by a LocationGroup definition record.

The location group definition.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this LocationGroup definition.
nameName of the group. References a String definition.
locationGroupTypeType of this group.
systemTreeParentParent of this location group in the system tree. References a SystemTreeNode definition.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_Location) (void *userData, OTF2_LocationRef self, OTF2_StringRef name, OTF2_LocationType locationType, uint64_t numberOfEvents, OTF2_LocationGroupRef locationGroup)

Function pointer definition for the callback which is triggered by a Location definition record.

The location definition.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this Location definition.
nameName of the location References a String definition.
locationTypeLocation type.
numberOfEventsNumber of events this location has recorded.
locationGroupLocation group which includes this location. References a LocationGroup definition.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_Region) (void *userData, 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)

Function pointer definition for the callback which is triggered by a Region definition record.

The region definition.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this Region definition.
nameName of the region (demangled name if available). References a String definition.
canonicalNameAlternative name of the region (e.g. mangled name). References a String definition. Since version 1.1.
descriptionA more detailed description of this region. References a String definition.
regionRoleRegion role. Since version 1.1.
paradigmParadigm. Since version 1.1.
regionFlagsRegion flags. Since version 1.1.
sourceFileThe source file where this region was declared. References a String definition.
beginLineNumberStarting line number of this region in the source file.
endLineNumberEnding line number of this region in the source file.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_Callsite) (void *userData, OTF2_CallsiteRef self, OTF2_StringRef sourceFile, uint32_t lineNumber, OTF2_RegionRef enteredRegion, OTF2_RegionRef leftRegion)

Function pointer definition for the callback which is triggered by a Callsite definition record.

The callsite definition.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this Callsite definition.
sourceFileThe source file where this call was made. References a String definition.
lineNumberLine number in the source file where this call was made.
enteredRegionThe region which was called. References a Region definition.
leftRegionThe region which made the call. References a Region definition.
Since
Version 1.0
Deprecated:
In version 2.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_Callpath) (void *userData, OTF2_CallpathRef self, OTF2_CallpathRef parent, OTF2_RegionRef region)

Function pointer definition for the callback which is triggered by a Callpath definition record.

The callpath definition.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this Callpath definition.
parentThe parent of this callpath. References a Callpath definition.
regionThe region of this callpath. References a Region definition.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_Group) (void *userData, OTF2_GroupRef self, OTF2_StringRef name, OTF2_GroupType groupType, OTF2_Paradigm paradigm, OTF2_GroupFlag groupFlags, uint32_t numberOfMembers, const uint64_t *members)

Function pointer definition for the callback which is triggered by a Group definition record.

The group definition.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this Group definition.
nameName of this group References a String definition.
groupTypeThe type of this group. Since version 1.2.
paradigmThe paradigm of this communication group. Since version 1.2.
groupFlagsFlags for this group. Since version 1.2.
numberOfMembersThe number of members in this group.
membersThe identifiers of the group members.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_MetricMember) (void *userData, 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)

Function pointer definition for the callback which is triggered by a MetricMember definition record.

A metric is defined by a metric member definition. A metric member is always a member of a metric class. Therefore, a single metric is a special case of a metric class with only one member. It is not allowed to reference a metric member id in a metric event, but only metric class IDs.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this MetricMember definition.
nameName of the metric. References a String definition.
descriptionDescription of the metric. References a String definition.
metricTypeMetric type: PAPI, etc.
metricModeMetric mode: accumulative, fix, relative, etc.
valueTypeType of the value. Only OTF2_TYPE_INT64, OTF2_TYPE_UINT64, and OTF2_TYPE_DOUBLE are valid types. If this metric member is recorded in a Metric event, than this type and the type in the event must match.
baseThe recorded values should be handled in this given base, either binary or decimal. This information can be used if the value needs to be scaled.
exponentThe values inside the Metric events should be scaled by the factor base^exponent, to get the value in its base unit. For example, if the metric values come in as KiBi, than the base should be OTF2_BASE_BINARY and the exponent 10. Than the writer does not need to scale the values up to bytes, but can directly write the KiBi values into the Metric event. At reading time, the reader can apply the scaling factor to get the value in its base unit, ie. in bytes.
unitUnit of the metric. This needs to be the scale free base unit, ie. "bytes", "operations", or "seconds". In particular this unit should not have any scale prefix. References a String definition.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_MetricClass) (void *userData, OTF2_MetricRef self, uint8_t numberOfMetrics, const OTF2_MetricMemberRef *metricMembers, OTF2_MetricOccurrence metricOccurrence, OTF2_RecorderKind recorderKind)

Function pointer definition for the callback which is triggered by a MetricClass definition record.

For a metric class it is implicitly given that the event stream that records the metric is also the scope. A metric class can contain multiple different metrics.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this MetricClass definition.
numberOfMetricsNumber of metrics within the set.
metricMembersList of metric members. References a MetricMember definition.
metricOccurrenceDefines occurrence of a metric set.
recorderKindWhat kind of locations will record this metric class, or will this metric class only be recorded by metric instances. Since version 1.2.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_MetricInstance) (void *userData, OTF2_MetricRef self, OTF2_MetricRef metricClass, OTF2_LocationRef recorder, OTF2_MetricScope metricScope, uint64_t scope)

Function pointer definition for the callback which is triggered by a MetricInstance definition record.

A metric instance is used to define metrics that are recorded at one location for multiple locations or for another location. The occurrence of a metric instance is implicitly of type OTF2_METRIC_ASYNCHRONOUS.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this MetricClass definition.
metricClassThe instanced MetricClass. This metric class must be of kind OTF2_RECORDER_KIND_ABSTRACT. References a MetricClass, or a MetricInstance definition.
recorderRecorder of the metric: location ID. References a Location definition.
metricScopeDefines type of scope: location, location group, system tree node, or a generic group of locations.
scopeScope of metric: ID of a location, location group, system tree node, or a generic group of locations.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_Comm) (void *userData, OTF2_CommRef self, OTF2_StringRef name, OTF2_GroupRef group, OTF2_CommRef parent)

Function pointer definition for the callback which is triggered by a Comm definition record.

The communicator definition.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this Comm definition.
nameThe name given by calling MPI_Comm_set_name on this communicator. Or the empty name to indicate that no name was given. References a String definition.
groupThe describing MPI group of this MPI communicator The group needs to be of type OTF2_GROUP_TYPE_COMM_GROUP or OTF2_GROUP_TYPE_COMM_SELF. References a Group definition.
parentThe parent MPI communicator from which this communicator was created, if any. Use OTF2_UNDEFINED_COMM to indicate no parent. References a Comm definition.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_Parameter) (void *userData, OTF2_ParameterRef self, OTF2_StringRef name, OTF2_ParameterType parameterType)

Function pointer definition for the callback which is triggered by a Parameter definition record.

The parameter definition.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this Parameter definition.
nameName of the parameter (variable name etc.) References a String definition.
parameterTypeType of the parameter, OTF2_ParameterType for possible types.
Since
Version 1.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_RmaWin) (void *userData, OTF2_RmaWinRef self, OTF2_StringRef name, OTF2_CommRef comm)

Function pointer definition for the callback which is triggered by a RmaWin definition record.

A window defines the communication context for any remote-memory access operation.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this RmaWin definition.
nameName, e.g. 'GASPI Queue 1', 'NVidia Card 2', etc.. References a String definition.
commCommunicator object used to create the window. References a Comm definition.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_MetricClassRecorder) (void *userData, OTF2_MetricRef metric, OTF2_LocationRef recorder)

Function pointer definition for the callback which is triggered by a MetricClassRecorder definition record.

The metric class recorder definition.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
metricParent MetricClass, or MetricInstance definition to which this one is a supplementary definition. References a MetricClass, or a MetricInstance definition.
recorderThe location which recorded the referenced metric class. References a Location definition.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_SystemTreeNodeProperty) (void *userData, OTF2_SystemTreeNodeRef systemTreeNode, OTF2_StringRef name, OTF2_Type type, OTF2_AttributeValue value)

Function pointer definition for the callback which is triggered by a SystemTreeNodeProperty definition record.

An arbitrary key/value property for a SystemTreeNode definition.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
systemTreeNodeParent SystemTreeNode definition to which this one is a supplementary definition. References a SystemTreeNode definition.
nameName of the property. References a String definition.
typeThe type of this property. Since version 2.0.
valueThe value of this property. Since version 2.0.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_SystemTreeNodeDomain) (void *userData, OTF2_SystemTreeNodeRef systemTreeNode, OTF2_SystemTreeDomain systemTreeDomain)

Function pointer definition for the callback which is triggered by a SystemTreeNodeDomain definition record.

The system tree node domain definition.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
systemTreeNodeParent SystemTreeNode definition to which this one is a supplementary definition. References a SystemTreeNode definition.
systemTreeDomainThe domain in which the referenced SystemTreeNode operates in.
Since
Version 1.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_LocationGroupProperty) (void *userData, OTF2_LocationGroupRef locationGroup, OTF2_StringRef name, OTF2_Type type, OTF2_AttributeValue value)

Function pointer definition for the callback which is triggered by a LocationGroupProperty definition record.

An arbitrary key/value property for a LocationGroup definition.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
locationGroupParent LocationGroup definition to which this one is a supplementary definition. References a LocationGroup definition.
nameName of the property. References a String definition.
typeThe type of this property. Since version 2.0.
valueThe value of this property. Since version 2.0.
Since
Version 1.3
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_LocationProperty) (void *userData, OTF2_LocationRef location, OTF2_StringRef name, OTF2_Type type, OTF2_AttributeValue value)

Function pointer definition for the callback which is triggered by a LocationProperty definition record.

An arbitrary key/value property for a Location definition.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
locationParent Location definition to which this one is a supplementary definition. References a Location definition.
nameName of the property. References a String definition.
typeThe type of this property. Since version 2.0.
valueThe value of this property. Since version 2.0.
Since
Version 1.3
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_CartDimension) (void *userData, OTF2_CartDimensionRef self, OTF2_StringRef name, uint32_t size, OTF2_CartPeriodicity cartPeriodicity)

Function pointer definition for the callback which is triggered by a CartDimension definition record.

Each dimension in a Cartesian topology is composed of a global id, a name, its size, and whether it is periodic or not.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this CartDimension definition.
nameThe name of the cartesian topology dimension. References a String definition.
sizeThe size of the cartesian topology dimension.
cartPeriodicityPeriodicity of the cartesian topology dimension.
Since
Version 1.3
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_CartTopology) (void *userData, OTF2_CartTopologyRef self, OTF2_StringRef name, OTF2_CommRef communicator, uint8_t numberOfDimensions, const OTF2_CartDimensionRef *cartDimensions)

Function pointer definition for the callback which is triggered by a CartTopology definition record.

Each topology is described by a global id, a reference to its name, a reference to a communicator, the number of dimensions, and references to those dimensions. The topology type is defined by the paradigm of the group referenced by the associated communicator.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this CartTopology definition.
nameThe name of the topology. References a String definition.
communicatorCommunicator object used to create the topology. References a Comm definition.
numberOfDimensionsNumber of dimensions.
cartDimensionsThe dimensions of this topology. References a CartDimension definition.
Since
Version 1.3
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_CartCoordinate) (void *userData, OTF2_CartTopologyRef cartTopology, uint32_t rank, uint8_t numberOfDimensions, const uint32_t *coordinates)

Function pointer definition for the callback which is triggered by a CartCoordinate definition record.

Defines the coordinate of the location referenced by the given rank (w.r.t. the communicator associated to the topology) in the referenced topology.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
cartTopologyParent CartTopology definition to which this one is a supplementary definition. References a CartTopology definition.
rankThe rank w.r.t. the communicator associated to the topology referencing this coordinate.
numberOfDimensionsNumber of dimensions.
coordinatesCoordinates, indexed by dimension.
Since
Version 1.3
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_SourceCodeLocation) (void *userData, OTF2_SourceCodeLocationRef self, OTF2_StringRef file, uint32_t lineNumber)

Function pointer definition for the callback which is triggered by a SourceCodeLocation definition record.

The definition of a source code location as tuple of the corresponding file name and line number.

When used to attach source code annotations to events, use the OTF2_AttributeList with a Attribute definition named "SOURCE_CODE_LOCATION" and typed OTF2_TYPE_SOURCE_CODE_LOCATION.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this SourceCodeLocation definition.
fileThe name of the file for the source code location. References a String definition.
lineNumberThe line number for the source code location.
Since
Version 1.5
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_CallingContext) (void *userData, OTF2_CallingContextRef self, OTF2_RegionRef region, OTF2_SourceCodeLocationRef sourceCodeLocation, OTF2_CallingContextRef parent)

Function pointer definition for the callback which is triggered by a CallingContext definition record.

Defines a node in the calling context tree. These nodes are referenced in the CallingContextSample, CallingContextEnter, and CallingContextLeave events.

The referenced CallingContext node in these events form a path which represents the calling context at this time. This path will be partitioned into at most three sub-paths by the unwindDistance attribute. For the CallingContextLeave event, the unwindDistance is defined to be 1.

Starting from the referenced CallingContext node, the first $ N \ge 0 $ nodes were newly entered regions since the previous calling context event. The next node is a region which was not left but made progress since the previous calling context event. All other nodes did not make progress at all, and thus the regions were neither left nor entered again. The unwindDistance is then $ N + 1 $. In case the unwindDistance is $ 0 $, there are neither newly entered regions nor regions which made progress.

It is guaranteed, that the node referenced by the unwindDistance exists in the previous and current calling context. All descendants of this node's child in the previous calling context were left since the previous calling context event.

It is valid that this node is the OTF2_UNDEFINED_CALLING_CONTEXT node and that this node is already reached after unwindDistance $ - 1 $ steps. In the latter case, there exists no region which made progress, all regions in the previous calling context were left and all regions in the current calling context were newly entered.

Note that for CallingContextLeave events, the parent of the referenced CallingContext must be used as the previous calling context for the next event.

Regions which were entered with a CallingContextEnter event form an upper bound for the unwind distance, i.e., the unwindDistance points either to the parent of the last such entered region, or a node which is a descendant to this parent.

To summarize, an unwindDistance of $ 0 $ means that no regions were left, newly entered, or made any progress. An unwindDistance of $ 1 $ means that some regions were left regarding the previous calling context, no regions were newly entered, and there was progress in the region of the first node. An unwindDistance greater than $ 1 $ means that some regions were left regarding the previous calling context, there was progress in one region, and the first unwindDistance $ - 1 $ regions were newly entered.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this CallingContext definition.
regionThe region. References a Region definition.
sourceCodeLocationThe absolute source code location of this calling context. References a SourceCodeLocation definition.
parentParent id of this context. References a CallingContext definition.
Since
Version 1.5
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_CallingContextProperty) (void *userData, OTF2_CallingContextRef callingContext, OTF2_StringRef name, OTF2_Type type, OTF2_AttributeValue value)

Function pointer definition for the callback which is triggered by a CallingContextProperty definition record.

An arbitrary key/value property for a CallingContext definition.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
callingContextParent CallingContext definition to which this one is a supplementary definition. References a CallingContext definition.
nameProperty name. References a String definition.
typeThe type of this property. Must match with the defined type of the property.
valueThe value of this property.
Since
Version 2.0
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_InterruptGenerator) (void *userData, OTF2_InterruptGeneratorRef self, OTF2_StringRef name, OTF2_InterruptGeneratorMode interruptGeneratorMode, OTF2_Base base, int64_t exponent, uint64_t period)

Function pointer definition for the callback which is triggered by a InterruptGenerator definition record.

Defines an interrupt generator which periodically triggers CallingContextSample events. If the mode of the interrupt generator is set to OTF2_INTERRUPT_GENERATOR_MODE_TIME, the generator produces interrupts which are uniformly distributed over time, and the unit of the period is implicitly in seconds. If the mode is OTF2_INTERRUPT_GENERATOR_MODE_COUNT, the interrupt is triggered if a specific counter threshold is reached in the system. Therefore these samples are unlikely to be uniformly distributed over time. The unit of the period is then implicitly a number (threshold value).

The interrupts period in base unit (which is implicitly seconds or number, based on the mode) is derived out of the base, the exponent, and the period attributes by this formula:

base-period = period x base^exponent

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this InterruptGenerator definition.
nameThe name of this interrupt generator. References a String definition.
interruptGeneratorModeMode of the interrupt generator.
baseThe base for the period calculation.
exponentThe exponent for the period calculation.
periodThe period this interrupt generator generates interrupts.
Since
Version 1.5
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_IoFileProperty) (void *userData, OTF2_IoFileRef ioFile, OTF2_StringRef name, OTF2_Type type, OTF2_AttributeValue value)

Function pointer definition for the callback which is triggered by a IoFileProperty definition record.

Extensible annotation for the polymorphic IoFile definition class.

The tuple (ioFile, name) must be unique.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
ioFileParent IoRegularFile definition to which this one is a supplementary definition. References a IoRegularFile definition.
nameProperty name. References a String definition.
typeThe type of this property.
valueThe value of this property.
Since
Version 2.1
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_IoRegularFile) (void *userData, OTF2_IoFileRef self, OTF2_StringRef name, OTF2_SystemTreeNodeRef scope)

Function pointer definition for the callback which is triggered by a IoRegularFile definition record.

Defines a regular file from which an IoHandle can be created.

This definition is member of the polymorphic IoFile definition class. All definitions of this polymorphic definition class share the same global identifier namespace.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this IoRegularFile definition.
nameName of the file. References a String definition.
scopeDefines the physical scope of this IoRegularFile in the system tree. E.g., two IoRegularFile definitions with the same name but different scope values are physically different, thus I/O operations through IoHandles do not operate on the same file. References a SystemTreeNode definition.
Since
Version 2.1
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_IoDirectory) (void *userData, OTF2_IoFileRef self, OTF2_StringRef name, OTF2_SystemTreeNodeRef scope)

Function pointer definition for the callback which is triggered by a IoDirectory definition record.

Defines a directory from which an IoHandle can be created.

This definition is member of the polymorphic IoFile definition class. All definitions of this polymorphic definition class share the same global identifier namespace.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this IoRegularFile definition.
nameName of the directory. References a String definition.
scopeDefines the physical scope of this IoDirectory in the system tree. E.g., two IoDirectory definitions with the same name but different scope values are physically different, thus I/O operations through IoHandles do not operate on the same directory. References a SystemTreeNode definition.
Since
Version 2.1
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_IoHandle) (void *userData, OTF2_IoHandleRef self, OTF2_StringRef name, OTF2_IoFileRef file, OTF2_IoParadigmRef ioParadigm, OTF2_IoHandleFlag ioHandleFlags, OTF2_CommRef comm, OTF2_IoHandleRef parent)

Function pointer definition for the callback which is triggered by a IoHandle definition record.

Defines an I/O handle which will be used by subsequent I/O operations. I/O operations can only be applied to active I/O handles. An I/O handle gets active either if it was marked with the OTF2_IO_HANDLE_FLAG_PRE_CREATED flag, after it was referenced in an IoCreateHandle event, or it was referenced in the newHandle attribute of an IoDuplicateHandle event. It gets inactive if it was referenced in an IoDestroyHandle event. This life cycle can be repeated indefinitely. Though the OTF2_IO_HANDLE_FLAG_PRE_CREATED flag is unset after a IoDuplicateHandle event. All Locations of a LocationGroup have access to an active IoHandle, regardless which Location of the LocationGroup activated the IoHandle.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
selfThe unique identifier for this IoHandle definition.
nameHandle name. References a String definition.
fileFile identifier. References a IoRegularFile, or a IoDirectory definition.
ioParadigmThe I/O paradigm. References a IoParadigm definition.
ioHandleFlagsSpecial characteristics of this handle.
commScope of the file handle. This scope defines which process can access this file via this handle and also defines the collective context for this handle. References a Comm definition.
parentParent, in case this I/O handle was created and operated by an higher-level I/O paradigm. References a IoHandle definition.
Since
Version 2.1
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_IoPreCreatedHandleState) (void *userData, OTF2_IoHandleRef ioHandle, OTF2_IoAccessMode mode, OTF2_IoStatusFlag statusFlags)

Function pointer definition for the callback which is triggered by a IoPreCreatedHandleState definition record.

Provide the I/O access mode and status flags for pre-created IoHandles.

Only allowed once for a IoHandle definition with the OTF2_IO_HANDLE_FLAG_PRE_CREATED flag set.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
ioHandleParent IoHandle definition to which this one is a supplementary definition. References a IoHandle definition.
modeThe access mode of the pre-created IoHandle.
statusFlagsThe status flags of the pre-created IoHandle.
Since
Version 2.1
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_CallpathParameter) (void *userData, OTF2_CallpathRef callpath, OTF2_ParameterRef parameter, OTF2_Type type, OTF2_AttributeValue value)

Function pointer definition for the callback which is triggered by a CallpathParameter definition record.

A parameter for a callpath definition.

Parameters
userDataUser data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks.
callpathParent Callpath definition to which this one is a supplementary definition. References a Callpath definition.
parameterThe parameter of this callpath. References a Parameter definition.
typeThe type of the attribute value. Must match the type of the parameter.
valueThe value of the parameter for this callpath.
Since
Version 2.2
Returns
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.

Function Documentation

OTF2_DefReaderCallbacks* OTF2_DefReaderCallbacks_New ( void  )

Allocates a new struct for the definition callbacks.

Returns
A newly allocated struct of type OTF2_DefReaderCallbacks.
void OTF2_DefReaderCallbacks_Delete ( OTF2_DefReaderCallbacks defReaderCallbacks)

Deallocates a struct for the definition callbacks.

Parameters
defReaderCallbacksHandle to a struct previously allocated with OTF2_DefReaderCallbacks_New.
void OTF2_DefReaderCallbacks_Clear ( OTF2_DefReaderCallbacks defReaderCallbacks)

Clears a struct for the definition callbacks.

Parameters
defReaderCallbacksHandle to a struct previously allocated with OTF2_DefReaderCallbacks_New.
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetUnknownCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_Unknown  unknownCallback 
)

Registers the callback for an unknown definition.

Parameters
defReaderCallbacksStruct for all callbacks.
unknownCallbackFunction which should be called for all unknown definitions.
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetMappingTableCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_MappingTable  mappingTableCallback 
)

Registers the callback for the MappingTable definition.

Parameters
defReaderCallbacksStruct for all callbacks.
mappingTableCallbackFunction which should be called for all MappingTable definitions.
Since
Version 1.0
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetClockOffsetCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_ClockOffset  clockOffsetCallback 
)

Registers the callback for the ClockOffset definition.

Parameters
defReaderCallbacksStruct for all callbacks.
clockOffsetCallbackFunction which should be called for all ClockOffset definitions.
Since
Version 1.0
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetStringCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_String  stringCallback 
)

Registers the callback for the String definition.

Parameters
defReaderCallbacksStruct for all callbacks.
stringCallbackFunction which should be called for all String definitions.
Since
Version 1.0
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetAttributeCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_Attribute  attributeCallback 
)

Registers the callback for the Attribute definition.

Parameters
defReaderCallbacksStruct for all callbacks.
attributeCallbackFunction which should be called for all Attribute definitions.
Since
Version 1.0
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetSystemTreeNodeCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_SystemTreeNode  systemTreeNodeCallback 
)

Registers the callback for the SystemTreeNode definition.

Parameters
defReaderCallbacksStruct for all callbacks.
systemTreeNodeCallbackFunction which should be called for all SystemTreeNode definitions.
Since
Version 1.0
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetLocationGroupCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_LocationGroup  locationGroupCallback 
)

Registers the callback for the LocationGroup definition.

Parameters
defReaderCallbacksStruct for all callbacks.
locationGroupCallbackFunction which should be called for all LocationGroup definitions.
Since
Version 1.0
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetLocationCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_Location  locationCallback 
)

Registers the callback for the Location definition.

Parameters
defReaderCallbacksStruct for all callbacks.
locationCallbackFunction which should be called for all Location definitions.
Since
Version 1.0
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetRegionCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_Region  regionCallback 
)

Registers the callback for the Region definition.

Parameters
defReaderCallbacksStruct for all callbacks.
regionCallbackFunction which should be called for all Region definitions.
Since
Version 1.0
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetCallsiteCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_Callsite  callsiteCallback 
)

Registers the callback for the Callsite definition.

Parameters
defReaderCallbacksStruct for all callbacks.
callsiteCallbackFunction which should be called for all Callsite definitions.
Since
Version 1.0
Deprecated:
In version 2.0
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetCallpathCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_Callpath  callpathCallback 
)

Registers the callback for the Callpath definition.

Parameters
defReaderCallbacksStruct for all callbacks.
callpathCallbackFunction which should be called for all Callpath definitions.
Since
Version 1.0
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetGroupCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_Group  groupCallback 
)

Registers the callback for the Group definition.

Parameters
defReaderCallbacksStruct for all callbacks.
groupCallbackFunction which should be called for all Group definitions.
Since
Version 1.0
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetMetricMemberCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_MetricMember  metricMemberCallback 
)

Registers the callback for the MetricMember definition.

Parameters
defReaderCallbacksStruct for all callbacks.
metricMemberCallbackFunction which should be called for all MetricMember definitions.
Since
Version 1.0
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetMetricClassCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_MetricClass  metricClassCallback 
)

Registers the callback for the MetricClass definition.

Parameters
defReaderCallbacksStruct for all callbacks.
metricClassCallbackFunction which should be called for all MetricClass definitions.
Since
Version 1.0
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetMetricInstanceCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_MetricInstance  metricInstanceCallback 
)

Registers the callback for the MetricInstance definition.

Parameters
defReaderCallbacksStruct for all callbacks.
metricInstanceCallbackFunction which should be called for all MetricInstance definitions.
Since
Version 1.0
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetCommCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_Comm  commCallback 
)

Registers the callback for the Comm definition.

Parameters
defReaderCallbacksStruct for all callbacks.
commCallbackFunction which should be called for all Comm definitions.
Since
Version 1.0
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetParameterCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_Parameter  parameterCallback 
)

Registers the callback for the Parameter definition.

Parameters
defReaderCallbacksStruct for all callbacks.
parameterCallbackFunction which should be called for all Parameter definitions.
Since
Version 1.0
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetRmaWinCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_RmaWin  rmaWinCallback 
)

Registers the callback for the RmaWin definition.

Parameters
defReaderCallbacksStruct for all callbacks.
rmaWinCallbackFunction which should be called for all RmaWin definitions.
Since
Version 1.2
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetMetricClassRecorderCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_MetricClassRecorder  metricClassRecorderCallback 
)

Registers the callback for the MetricClassRecorder definition.

Parameters
defReaderCallbacksStruct for all callbacks.
metricClassRecorderCallbackFunction which should be called for all MetricClassRecorder definitions.
Since
Version 1.2
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetSystemTreeNodePropertyCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_SystemTreeNodeProperty  systemTreeNodePropertyCallback 
)

Registers the callback for the SystemTreeNodeProperty definition.

Parameters
defReaderCallbacksStruct for all callbacks.
systemTreeNodePropertyCallbackFunction which should be called for all SystemTreeNodeProperty definitions.
Since
Version 1.2
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetSystemTreeNodeDomainCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_SystemTreeNodeDomain  systemTreeNodeDomainCallback 
)

Registers the callback for the SystemTreeNodeDomain definition.

Parameters
defReaderCallbacksStruct for all callbacks.
systemTreeNodeDomainCallbackFunction which should be called for all SystemTreeNodeDomain definitions.
Since
Version 1.2
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetLocationGroupPropertyCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_LocationGroupProperty  locationGroupPropertyCallback 
)

Registers the callback for the LocationGroupProperty definition.

Parameters
defReaderCallbacksStruct for all callbacks.
locationGroupPropertyCallbackFunction which should be called for all LocationGroupProperty definitions.
Since
Version 1.3
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetLocationPropertyCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_LocationProperty  locationPropertyCallback 
)

Registers the callback for the LocationProperty definition.

Parameters
defReaderCallbacksStruct for all callbacks.
locationPropertyCallbackFunction which should be called for all LocationProperty definitions.
Since
Version 1.3
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetCartDimensionCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_CartDimension  cartDimensionCallback 
)

Registers the callback for the CartDimension definition.

Parameters
defReaderCallbacksStruct for all callbacks.
cartDimensionCallbackFunction which should be called for all CartDimension definitions.
Since
Version 1.3
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetCartTopologyCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_CartTopology  cartTopologyCallback 
)

Registers the callback for the CartTopology definition.

Parameters
defReaderCallbacksStruct for all callbacks.
cartTopologyCallbackFunction which should be called for all CartTopology definitions.
Since
Version 1.3
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetCartCoordinateCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_CartCoordinate  cartCoordinateCallback 
)

Registers the callback for the CartCoordinate definition.

Parameters
defReaderCallbacksStruct for all callbacks.
cartCoordinateCallbackFunction which should be called for all CartCoordinate definitions.
Since
Version 1.3
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetSourceCodeLocationCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_SourceCodeLocation  sourceCodeLocationCallback 
)

Registers the callback for the SourceCodeLocation definition.

Parameters
defReaderCallbacksStruct for all callbacks.
sourceCodeLocationCallbackFunction which should be called for all SourceCodeLocation definitions.
Since
Version 1.5
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetCallingContextCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_CallingContext  callingContextCallback 
)

Registers the callback for the CallingContext definition.

Parameters
defReaderCallbacksStruct for all callbacks.
callingContextCallbackFunction which should be called for all CallingContext definitions.
Since
Version 1.5
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetCallingContextPropertyCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_CallingContextProperty  callingContextPropertyCallback 
)

Registers the callback for the CallingContextProperty definition.

Parameters
defReaderCallbacksStruct for all callbacks.
callingContextPropertyCallbackFunction which should be called for all CallingContextProperty definitions.
Since
Version 2.0
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetInterruptGeneratorCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_InterruptGenerator  interruptGeneratorCallback 
)

Registers the callback for the InterruptGenerator definition.

Parameters
defReaderCallbacksStruct for all callbacks.
interruptGeneratorCallbackFunction which should be called for all InterruptGenerator definitions.
Since
Version 1.5
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetIoFilePropertyCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_IoFileProperty  ioFilePropertyCallback 
)

Registers the callback for the IoFileProperty definition.

Parameters
defReaderCallbacksStruct for all callbacks.
ioFilePropertyCallbackFunction which should be called for all IoFileProperty definitions.
Since
Version 2.1
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetIoRegularFileCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_IoRegularFile  ioRegularFileCallback 
)

Registers the callback for the IoRegularFile definition.

Parameters
defReaderCallbacksStruct for all callbacks.
ioRegularFileCallbackFunction which should be called for all IoRegularFile definitions.
Since
Version 2.1
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetIoDirectoryCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_IoDirectory  ioDirectoryCallback 
)

Registers the callback for the IoDirectory definition.

Parameters
defReaderCallbacksStruct for all callbacks.
ioDirectoryCallbackFunction which should be called for all IoDirectory definitions.
Since
Version 2.1
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetIoHandleCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_IoHandle  ioHandleCallback 
)

Registers the callback for the IoHandle definition.

Parameters
defReaderCallbacksStruct for all callbacks.
ioHandleCallbackFunction which should be called for all IoHandle definitions.
Since
Version 2.1
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetIoPreCreatedHandleStateCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_IoPreCreatedHandleState  ioPreCreatedHandleStateCallback 
)

Registers the callback for the IoPreCreatedHandleState definition.

Parameters
defReaderCallbacksStruct for all callbacks.
ioPreCreatedHandleStateCallbackFunction which should be called for all IoPreCreatedHandleState definitions.
Since
Version 2.1
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^

OTF2_ErrorCode OTF2_DefReaderCallbacks_SetCallpathParameterCallback ( OTF2_DefReaderCallbacks defReaderCallbacks,
OTF2_DefReaderCallback_CallpathParameter  callpathParameterCallback 
)

Registers the callback for the CallpathParameter definition.

Parameters
defReaderCallbacksStruct for all callbacks.
callpathParameterCallbackFunction which should be called for all CallpathParameter definitions.
Since
Version 2.2
Returns

OTF2_SUCCESS if successful^^

OTF2_ERROR_INVALID_ARGUMENT for an invalid defReaderCallbacks argument^^

^^