1.2 (revision 3183)
Typedefs | Functions

OTF2_GlobalDefReaderCallbacks.h File Reference

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

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

Go to the source code of this file.

Typedefs

typedef OTF2_CallbackCode(* OTF2_GlobalDefReaderCallback_Attribute )(void *userData, OTF2_AttributeRef self, OTF2_StringRef name, OTF2_Type type)
 Function pointer definition for the callback which is triggered by a Attribute definition record.
typedef OTF2_CallbackCode(* OTF2_GlobalDefReaderCallback_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.
typedef OTF2_CallbackCode(* OTF2_GlobalDefReaderCallback_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.
typedef OTF2_CallbackCode(* OTF2_GlobalDefReaderCallback_ClockProperties )(void *userData, uint64_t timerResolution, uint64_t globalOffset, uint64_t traceLength)
 Function pointer definition for the callback which is triggered by a ClockProperties definition record.
typedef OTF2_CallbackCode(* OTF2_GlobalDefReaderCallback_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.
typedef OTF2_CallbackCode(* OTF2_GlobalDefReaderCallback_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.
typedef OTF2_CallbackCode(* OTF2_GlobalDefReaderCallback_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.
typedef OTF2_CallbackCode(* OTF2_GlobalDefReaderCallback_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.
typedef OTF2_CallbackCode(* OTF2_GlobalDefReaderCallback_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.
typedef OTF2_CallbackCode(* OTF2_GlobalDefReaderCallback_MetricClassRecorder )(void *userData, OTF2_MetricRef metricClass, OTF2_LocationRef recorder)
 Function pointer definition for the callback which is triggered by a MetricClassRecorder definition record.
typedef OTF2_CallbackCode(* OTF2_GlobalDefReaderCallback_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.
typedef OTF2_CallbackCode(* OTF2_GlobalDefReaderCallback_MetricMember )(void *userData, OTF2_MetricMemberRef self, OTF2_StringRef name, OTF2_StringRef description, OTF2_MetricType metricType, OTF2_MetricMode metricMode, OTF2_Type valueType, OTF2_MetricBase metricBase, int64_t exponent, OTF2_StringRef unit)
 Function pointer definition for the callback which is triggered by a MetricMember definition record.
typedef OTF2_CallbackCode(* OTF2_GlobalDefReaderCallback_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.
typedef OTF2_CallbackCode(* OTF2_GlobalDefReaderCallback_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.
typedef OTF2_CallbackCode(* OTF2_GlobalDefReaderCallback_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.
typedef OTF2_CallbackCode(* OTF2_GlobalDefReaderCallback_String )(void *userData, OTF2_StringRef self, const char *string)
 Function pointer definition for the callback which is triggered by a String definition record.
typedef OTF2_CallbackCode(* OTF2_GlobalDefReaderCallback_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.
typedef OTF2_CallbackCode(* OTF2_GlobalDefReaderCallback_SystemTreeNodeDomain )(void *userData, OTF2_SystemTreeNodeRef systemTreeNode, OTF2_SystemTreeDomain systemTreeDomain)
 Function pointer definition for the callback which is triggered by a SystemTreeNodeDomain definition record.
typedef OTF2_CallbackCode(* OTF2_GlobalDefReaderCallback_SystemTreeNodeProperty )(void *userData, OTF2_SystemTreeNodeRef systemTreeNode, OTF2_StringRef name, OTF2_StringRef value)
 Function pointer definition for the callback which is triggered by a SystemTreeNodeProperty definition record.
typedef OTF2_CallbackCode(* OTF2_GlobalDefReaderCallback_Unknown )(void *userData)
 Function pointer definition for the callback which is triggered by an unknown definition record.
typedef struct
OTF2_GlobalDefReaderCallbacks_struct 
OTF2_GlobalDefReaderCallbacks
 Opaque struct which holdes all global definition record callbacks.

Functions

void OTF2_GlobalDefReaderCallbacks_Clear (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks)
 Clears a struct for the global definition callbacks.
void OTF2_GlobalDefReaderCallbacks_Delete (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks)
 Deallocates a struct for the global definition callbacks.
OTF2_GlobalDefReaderCallbacksOTF2_GlobalDefReaderCallbacks_New (void)
 Allocates a new struct for the global definition callbacks.
OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetAttributeCallback (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks, OTF2_GlobalDefReaderCallback_Attribute attributeCallback)
 Registers the callback for the Attribute definition.
OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetCallpathCallback (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks, OTF2_GlobalDefReaderCallback_Callpath callpathCallback)
 Registers the callback for the Callpath definition.
OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetCallsiteCallback (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks, OTF2_GlobalDefReaderCallback_Callsite callsiteCallback)
 Registers the callback for the Callsite definition.
OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetClockPropertiesCallback (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks, OTF2_GlobalDefReaderCallback_ClockProperties clockPropertiesCallback)
 Registers the callback for the ClockProperties definition.
OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetCommCallback (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks, OTF2_GlobalDefReaderCallback_Comm commCallback)
 Registers the callback for the Comm definition.
OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetGroupCallback (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks, OTF2_GlobalDefReaderCallback_Group groupCallback)
 Registers the callback for the Group definition.
OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetLocationCallback (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks, OTF2_GlobalDefReaderCallback_Location locationCallback)
 Registers the callback for the Location definition.
OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetLocationGroupCallback (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks, OTF2_GlobalDefReaderCallback_LocationGroup locationGroupCallback)
 Registers the callback for the LocationGroup definition.
OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetMetricClassCallback (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks, OTF2_GlobalDefReaderCallback_MetricClass metricClassCallback)
 Registers the callback for the MetricClass definition.
OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetMetricClassRecorderCallback (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks, OTF2_GlobalDefReaderCallback_MetricClassRecorder metricClassRecorderCallback)
 Registers the callback for the MetricClassRecorder definition.
OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetMetricInstanceCallback (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks, OTF2_GlobalDefReaderCallback_MetricInstance metricInstanceCallback)
 Registers the callback for the MetricInstance definition.
OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetMetricMemberCallback (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks, OTF2_GlobalDefReaderCallback_MetricMember metricMemberCallback)
 Registers the callback for the MetricMember definition.
OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetParameterCallback (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks, OTF2_GlobalDefReaderCallback_Parameter parameterCallback)
 Registers the callback for the Parameter definition.
OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetRegionCallback (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks, OTF2_GlobalDefReaderCallback_Region regionCallback)
 Registers the callback for the Region definition.
OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetRmaWinCallback (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks, OTF2_GlobalDefReaderCallback_RmaWin rmaWinCallback)
 Registers the callback for the RmaWin definition.
OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetStringCallback (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks, OTF2_GlobalDefReaderCallback_String stringCallback)
 Registers the callback for the String definition.
OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetSystemTreeNodeCallback (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks, OTF2_GlobalDefReaderCallback_SystemTreeNode systemTreeNodeCallback)
 Registers the callback for the SystemTreeNode definition.
OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetSystemTreeNodeDomainCallback (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks, OTF2_GlobalDefReaderCallback_SystemTreeNodeDomain systemTreeNodeDomainCallback)
 Registers the callback for the SystemTreeNodeDomain definition.
OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetSystemTreeNodePropertyCallback (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks, OTF2_GlobalDefReaderCallback_SystemTreeNodeProperty systemTreeNodePropertyCallback)
 Registers the callback for the SystemTreeNodeProperty definition.
OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetUnknownCallback (OTF2_GlobalDefReaderCallbacks *globalDefReaderCallbacks, OTF2_GlobalDefReaderCallback_Unknown unknownCallback)
 Registers the callback for an unknown definition.

Detailed Description

This defines the callbacks for the global definition reader.

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

Typedef Documentation

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

Parameters:
userDataUser data as set by OTF2_Reader_RegisterGlobalDefCallbacks or OTF2_GlobalDefReader_SetCallbacks.
selfThe unique identifier for this Attribute definition.
nameName of the attribute. References a String definition.
typeType of the attribute value.
Since:
Version 1.0
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.

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

Parameters:
userDataUser data as set by OTF2_Reader_RegisterGlobalDefCallbacks or OTF2_GlobalDefReader_SetCallbacks.
selfThe unique identifier for this Callpath definition.
parentReferences a Callpath definition.
regionReferences a Region definition.
Since:
Version 1.0
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_GlobalDefReaderCallback_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.

Parameters:
userDataUser data as set by OTF2_Reader_RegisterGlobalDefCallbacks or OTF2_GlobalDefReader_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
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.
typedef OTF2_CallbackCode( * OTF2_GlobalDefReaderCallback_ClockProperties)(void *userData, uint64_t timerResolution, uint64_t globalOffset, uint64_t traceLength)

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

Defines the timer resolution and time range of this trace. There will be no event with a timestamp less than globalOffset, and no event with timestamp greater than (globalOffset + traceLength).

Parameters:
userDataUser data as set by OTF2_Reader_RegisterGlobalDefCallbacks or OTF2_GlobalDefReader_SetCallbacks.
timerResolutionTicks per seconds.
globalOffsetA timestamp smaller than all event timestamps.
traceLengthA timespan which includes the timespan between the smallest and greatest timestamp of all event timestamps.
Since:
Version 1.0
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.

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

Parameters:
userDataUser data as set by OTF2_Reader_RegisterGlobalDefCallbacks or OTF2_GlobalDefReader_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_MPI_GROUP or OTF2_GROUP_TYPE_MPI_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_GlobalDefReaderCallback_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.

Parameters:
userDataUser data as set by OTF2_Reader_RegisterGlobalDefCallbacks or OTF2_GlobalDefReader_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_GlobalDefReaderCallback_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.

Parameters:
userDataUser data as set by OTF2_Reader_RegisterGlobalDefCallbacks or OTF2_GlobalDefReader_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.

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

Parameters:
userDataUser data as set by OTF2_Reader_RegisterGlobalDefCallbacks or OTF2_GlobalDefReader_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_GlobalDefReaderCallback_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_RegisterGlobalDefCallbacks or OTF2_GlobalDefReader_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.

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

Parameters:
userDataUser data as set by OTF2_Reader_RegisterGlobalDefCallbacks or OTF2_GlobalDefReader_SetCallbacks.
metricClassParent MetricClass definition to which this one is a supplementary definition. References a MetricClass 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_GlobalDefReaderCallback_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_RegisterGlobalDefCallbacks or OTF2_GlobalDefReader_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 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_GlobalDefReaderCallback_MetricMember)(void *userData, OTF2_MetricMemberRef self, OTF2_StringRef name, OTF2_StringRef description, OTF2_MetricType metricType, OTF2_MetricMode metricMode, OTF2_Type valueType, OTF2_MetricBase metricBase, 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_RegisterGlobalDefCallbacks or OTF2_GlobalDefReader_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: int64_t, uint64_t, or double.
metricBaseThe 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.

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

Parameters:
userDataUser data as set by OTF2_Reader_RegisterGlobalDefCallbacks or OTF2_GlobalDefReader_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_GlobalDefReaderCallback_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.

Parameters:
userDataUser data as set by OTF2_Reader_RegisterGlobalDefCallbacks or OTF2_GlobalDefReader_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.

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_RegisterGlobalDefCallbacks or OTF2_GlobalDefReader_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_GlobalDefReaderCallback_String)(void *userData, OTF2_StringRef self, const char *string)

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

Parameters:
userDataUser data as set by OTF2_Reader_RegisterGlobalDefCallbacks or OTF2_GlobalDefReader_SetCallbacks.
selfThe unique identifier for this String definition.
stringThe string, null terminated.
Since:
Version 1.0
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.

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

Parameters:
userDataUser data as set by OTF2_Reader_RegisterGlobalDefCallbacks or OTF2_GlobalDefReader_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.

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

Parameters:
userDataUser data as set by OTF2_Reader_RegisterGlobalDefCallbacks or OTF2_GlobalDefReader_SetCallbacks.
systemTreeNodeParent SystemTreeNode definition to which this one is a supplementary definition. References a SystemTreeNode definition.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.

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

Parameters:
userDataUser data as set by OTF2_Reader_RegisterGlobalDefCallbacks or OTF2_GlobalDefReader_SetCallbacks.
systemTreeNodeParent SystemTreeNode definition to which this one is a supplementary definition. References a SystemTreeNode definition.
nameName of the property. References a String definition.
valueProperty value. References a String definition.
Since:
Version 1.2
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.

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

Parameters:
userDataUser data as set by OTF2_Reader_RegisterGlobalDefCallbacks or OTF2_GlobalDefReader_SetCallbacks.
Returns:
OTF2_CALLBACK_SUCCESS or OTF2_CALLBACK_INTERRUPT.

Function Documentation

void OTF2_GlobalDefReaderCallbacks_Clear ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks)

Clears a struct for the global definition callbacks.

Parameters:
globalDefReaderCallbacksHandle to a struct previously allocated with OTF2_GlobalDefReaderCallbacks_New.
void OTF2_GlobalDefReaderCallbacks_Delete ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks)

Deallocates a struct for the global definition callbacks.

Parameters:
globalDefReaderCallbacksHandle to a struct previously allocated with OTF2_GlobalDefReaderCallbacks_New.
OTF2_GlobalDefReaderCallbacks* OTF2_GlobalDefReaderCallbacks_New ( void  )

Allocates a new struct for the global definition callbacks.

Returns:
A newly allocated struct of type OTF2_GlobalDefReaderCallbacks.
OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetAttributeCallback ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks,
OTF2_GlobalDefReaderCallback_Attribute  attributeCallback 
)

Registers the callback for the Attribute definition.

Parameters:
globalDefReaderCallbacksStruct for all callbacks.
attributeCallbackFunction which should be called for all Attribute definitions.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetCallpathCallback ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks,
OTF2_GlobalDefReaderCallback_Callpath  callpathCallback 
)

Registers the callback for the Callpath definition.

Parameters:
globalDefReaderCallbacksStruct for all callbacks.
callpathCallbackFunction which should be called for all Callpath definitions.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetCallsiteCallback ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks,
OTF2_GlobalDefReaderCallback_Callsite  callsiteCallback 
)

Registers the callback for the Callsite definition.

Parameters:
globalDefReaderCallbacksStruct for all callbacks.
callsiteCallbackFunction which should be called for all Callsite definitions.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetClockPropertiesCallback ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks,
OTF2_GlobalDefReaderCallback_ClockProperties  clockPropertiesCallback 
)

Registers the callback for the ClockProperties definition.

Parameters:
globalDefReaderCallbacksStruct for all callbacks.
clockPropertiesCallbackFunction which should be called for all ClockProperties definitions.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetCommCallback ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks,
OTF2_GlobalDefReaderCallback_Comm  commCallback 
)

Registers the callback for the Comm definition.

Parameters:
globalDefReaderCallbacksStruct for all callbacks.
commCallbackFunction which should be called for all Comm definitions.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetGroupCallback ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks,
OTF2_GlobalDefReaderCallback_Group  groupCallback 
)

Registers the callback for the Group definition.

Parameters:
globalDefReaderCallbacksStruct for all callbacks.
groupCallbackFunction which should be called for all Group definitions.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetLocationCallback ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks,
OTF2_GlobalDefReaderCallback_Location  locationCallback 
)

Registers the callback for the Location definition.

Parameters:
globalDefReaderCallbacksStruct for all callbacks.
locationCallbackFunction which should be called for all Location definitions.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetLocationGroupCallback ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks,
OTF2_GlobalDefReaderCallback_LocationGroup  locationGroupCallback 
)

Registers the callback for the LocationGroup definition.

Parameters:
globalDefReaderCallbacksStruct for all callbacks.
locationGroupCallbackFunction which should be called for all LocationGroup definitions.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetMetricClassCallback ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks,
OTF2_GlobalDefReaderCallback_MetricClass  metricClassCallback 
)

Registers the callback for the MetricClass definition.

Parameters:
globalDefReaderCallbacksStruct for all callbacks.
metricClassCallbackFunction which should be called for all MetricClass definitions.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetMetricClassRecorderCallback ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks,
OTF2_GlobalDefReaderCallback_MetricClassRecorder  metricClassRecorderCallback 
)

Registers the callback for the MetricClassRecorder definition.

Parameters:
globalDefReaderCallbacksStruct for all callbacks.
metricClassRecorderCallbackFunction which should be called for all MetricClassRecorder definitions.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetMetricInstanceCallback ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks,
OTF2_GlobalDefReaderCallback_MetricInstance  metricInstanceCallback 
)

Registers the callback for the MetricInstance definition.

Parameters:
globalDefReaderCallbacksStruct for all callbacks.
metricInstanceCallbackFunction which should be called for all MetricInstance definitions.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetMetricMemberCallback ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks,
OTF2_GlobalDefReaderCallback_MetricMember  metricMemberCallback 
)

Registers the callback for the MetricMember definition.

Parameters:
globalDefReaderCallbacksStruct for all callbacks.
metricMemberCallbackFunction which should be called for all MetricMember definitions.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetParameterCallback ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks,
OTF2_GlobalDefReaderCallback_Parameter  parameterCallback 
)

Registers the callback for the Parameter definition.

Parameters:
globalDefReaderCallbacksStruct for all callbacks.
parameterCallbackFunction which should be called for all Parameter definitions.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetRegionCallback ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks,
OTF2_GlobalDefReaderCallback_Region  regionCallback 
)

Registers the callback for the Region definition.

Parameters:
globalDefReaderCallbacksStruct for all callbacks.
regionCallbackFunction which should be called for all Region definitions.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetRmaWinCallback ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks,
OTF2_GlobalDefReaderCallback_RmaWin  rmaWinCallback 
)

Registers the callback for the RmaWin definition.

Parameters:
globalDefReaderCallbacksStruct for all callbacks.
rmaWinCallbackFunction which should be called for all RmaWin definitions.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetStringCallback ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks,
OTF2_GlobalDefReaderCallback_String  stringCallback 
)

Registers the callback for the String definition.

Parameters:
globalDefReaderCallbacksStruct for all callbacks.
stringCallbackFunction which should be called for all String definitions.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetSystemTreeNodeCallback ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks,
OTF2_GlobalDefReaderCallback_SystemTreeNode  systemTreeNodeCallback 
)

Registers the callback for the SystemTreeNode definition.

Parameters:
globalDefReaderCallbacksStruct for all callbacks.
systemTreeNodeCallbackFunction which should be called for all SystemTreeNode definitions.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetSystemTreeNodeDomainCallback ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks,
OTF2_GlobalDefReaderCallback_SystemTreeNodeDomain  systemTreeNodeDomainCallback 
)

Registers the callback for the SystemTreeNodeDomain definition.

Parameters:
globalDefReaderCallbacksStruct for all callbacks.
systemTreeNodeDomainCallbackFunction which should be called for all SystemTreeNodeDomain definitions.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetSystemTreeNodePropertyCallback ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks,
OTF2_GlobalDefReaderCallback_SystemTreeNodeProperty  systemTreeNodePropertyCallback 
)

Registers the callback for the SystemTreeNodeProperty definition.

Parameters:
globalDefReaderCallbacksStruct for all callbacks.
systemTreeNodePropertyCallbackFunction which should be called for all SystemTreeNodeProperty definitions.
Returns:
OTF2_SUCCESS

if successful

OTF2_ERROR_INVALID_ARGUMENT

for an invalid defReaderCallbacks argument

OTF2_ErrorCode OTF2_GlobalDefReaderCallbacks_SetUnknownCallback ( OTF2_GlobalDefReaderCallbacks globalDefReaderCallbacks,
OTF2_GlobalDefReaderCallback_Unknown  unknownCallback 
)

Registers the callback for an unknown definition.

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