![]() |
1.2.1 (revision 3238)
|
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_Definitions.h>
#include <otf2/OTF2_IdMap.h>
Go to the source code of this file.
Typedefs | |
typedef OTF2_CallbackCode(* | OTF2_DefReaderCallback_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_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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
typedef OTF2_CallbackCode(* | OTF2_DefReaderCallback_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_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. | |
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_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_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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
typedef OTF2_CallbackCode(* | OTF2_DefReaderCallback_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_DefReaderCallback_Unknown )(void *userData) |
Function pointer definition for the callback which is triggered for an unknown definition. | |
typedef struct OTF2_DefReaderCallbacks_struct | OTF2_DefReaderCallbacks |
Opaque struct which holdes all definition record callbacks. | |
Functions | |
void | OTF2_DefReaderCallbacks_Clear (OTF2_DefReaderCallbacks *defReaderCallbacks) |
Clears a struct for the definition callbacks. | |
void | OTF2_DefReaderCallbacks_Delete (OTF2_DefReaderCallbacks *defReaderCallbacks) |
Deallocates a struct for the definition callbacks. | |
OTF2_DefReaderCallbacks * | OTF2_DefReaderCallbacks_New (void) |
Allocates a new struct for the definition callbacks. | |
OTF2_ErrorCode | OTF2_DefReaderCallbacks_SetAttributeCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_Attribute attributeCallback) |
Registers the callback for the Attribute definition. | |
OTF2_ErrorCode | OTF2_DefReaderCallbacks_SetCallpathCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_Callpath callpathCallback) |
Registers the callback for the Callpath definition. | |
OTF2_ErrorCode | OTF2_DefReaderCallbacks_SetCallsiteCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_Callsite callsiteCallback) |
Registers the callback for the Callsite definition. | |
OTF2_ErrorCode | OTF2_DefReaderCallbacks_SetClockOffsetCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_ClockOffset clockOffsetCallback) |
Registers the callback for the ClockOffset definition. | |
OTF2_ErrorCode | OTF2_DefReaderCallbacks_SetCommCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_Comm commCallback) |
Registers the callback for the Comm definition. | |
OTF2_ErrorCode | OTF2_DefReaderCallbacks_SetGroupCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_Group groupCallback) |
Registers the callback for the Group definition. | |
OTF2_ErrorCode | OTF2_DefReaderCallbacks_SetLocationCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_Location locationCallback) |
Registers the callback for the Location definition. | |
OTF2_ErrorCode | OTF2_DefReaderCallbacks_SetLocationGroupCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_LocationGroup locationGroupCallback) |
Registers the callback for the LocationGroup definition. | |
OTF2_ErrorCode | OTF2_DefReaderCallbacks_SetMappingTableCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_MappingTable mappingTableCallback) |
Registers the callback for the MappingTable definition. | |
OTF2_ErrorCode | OTF2_DefReaderCallbacks_SetMetricClassCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_MetricClass metricClassCallback) |
Registers the callback for the MetricClass definition. | |
OTF2_ErrorCode | OTF2_DefReaderCallbacks_SetMetricClassRecorderCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_MetricClassRecorder metricClassRecorderCallback) |
Registers the callback for the MetricClassRecorder definition. | |
OTF2_ErrorCode | OTF2_DefReaderCallbacks_SetMetricInstanceCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_MetricInstance metricInstanceCallback) |
Registers the callback for the MetricInstance definition. | |
OTF2_ErrorCode | OTF2_DefReaderCallbacks_SetMetricMemberCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_MetricMember metricMemberCallback) |
Registers the callback for the MetricMember definition. | |
OTF2_ErrorCode | OTF2_DefReaderCallbacks_SetParameterCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_Parameter parameterCallback) |
Registers the callback for the Parameter definition. | |
OTF2_ErrorCode | OTF2_DefReaderCallbacks_SetRegionCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_Region regionCallback) |
Registers the callback for the Region definition. | |
OTF2_ErrorCode | OTF2_DefReaderCallbacks_SetRmaWinCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_RmaWin rmaWinCallback) |
Registers the callback for the RmaWin definition. | |
OTF2_ErrorCode | OTF2_DefReaderCallbacks_SetStringCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_String stringCallback) |
Registers the callback for the String definition. | |
OTF2_ErrorCode | OTF2_DefReaderCallbacks_SetSystemTreeNodeCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_SystemTreeNode systemTreeNodeCallback) |
Registers the callback for the SystemTreeNode definition. | |
OTF2_ErrorCode | OTF2_DefReaderCallbacks_SetSystemTreeNodeDomainCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_SystemTreeNodeDomain systemTreeNodeDomainCallback) |
Registers the callback for the SystemTreeNodeDomain definition. | |
OTF2_ErrorCode | OTF2_DefReaderCallbacks_SetSystemTreeNodePropertyCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_SystemTreeNodeProperty systemTreeNodePropertyCallback) |
Registers the callback for the SystemTreeNodeProperty definition. | |
OTF2_ErrorCode | OTF2_DefReaderCallbacks_SetUnknownCallback (OTF2_DefReaderCallbacks *defReaderCallbacks, OTF2_DefReaderCallback_Unknown unknownCallback) |
Registers the callback for an unknown definition. |
This defines the callbacks for the definition reader.
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_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.
userData | User data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks. |
self | The unique identifier for this Attribute definition. |
name | Name of the attribute. References a String definition. |
type | Type of the attribute value. |
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.
userData | User data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks. |
self | The unique identifier for this Callpath definition. |
parent | References a Callpath definition. |
region | References a Region definition. |
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.
userData | User data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks. |
self | The unique identifier for this Callsite definition. |
sourceFile | The source file where this call was made. References a String definition. |
lineNumber | Line number in the source file where this call was made. |
enteredRegion | The region which was called. References a Region definition. |
leftRegion | The region which made the call. References a Region definition. |
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.
userData | User data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks. |
time | Time when this offset was determined. |
offset | The offset to the global clock which was determined at time. |
standardDeviation | A possible standard deviation, which can be used as a metric for the quality of the offset. |
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.
userData | User data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks. |
self | The unique identifier for this Comm definition. |
name | The 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. |
group | The 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. |
parent | The parent MPI communicator from which this communicator was created, if any. Use OTF2_UNDEFINED_COMM to indicate no parent. References a Comm definition. |
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.
userData | User data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks. |
self | The unique identifier for this Group definition. |
name | Name of this group References a String definition. |
groupType | The type of this group. Since version 1.2. |
paradigm | The paradigm of this communication group. Since version 1.2. |
groupFlags | Flags for this group. Since version 1.2. |
numberOfMembers | The number of members in this group. |
members | The identifiers of the group members. |
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.
userData | User data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks. |
self | The unique identifier for this Location definition. |
name | Name of the location References a String definition. |
locationType | Location type. |
numberOfEvents | Number of events this location has recorded. |
locationGroup | Location group which includes this location. References a LocationGroup definition. |
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.
userData | User data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks. |
self | The unique identifier for this LocationGroup definition. |
name | Name of the group. References a String definition. |
locationGroupType | Type of this group. |
systemTreeParent | Parent of this location group in the system tree. References a SystemTreeNode definition. |
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.
userData | User data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks. |
mappingType | Says to what type of ID the mapping table has to be applied. |
idMap | Mapping table. |
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.
userData | User data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks. |
self | The unique identifier for this MetricClass definition. |
numberOfMetrics | Number of metrics within the set. |
metricMembers | List of metric members. References a MetricMember definition. |
metricOccurrence | Defines occurrence of a metric set. |
recorderKind | What kind of locations will record this metric class, or will this metric class only be recorded by metric instances. Since version 1.2. |
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_MetricClassRecorder)(void *userData, OTF2_MetricRef metricClass, OTF2_LocationRef recorder) |
Function pointer definition for the callback which is triggered by a MetricClassRecorder definition record.
userData | User data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks. |
metricClass | Parent MetricClass definition to which this one is a supplementary definition. References a MetricClass definition. |
recorder | The location which recorded the referenced metric class. References a Location definition. |
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.
userData | User data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks. |
self | The unique identifier for this MetricClass definition. |
metricClass | The instanced MetricClass. This metric class must be of kind OTF2_RECORDER_KIND_ABSTRACT. References a MetricClass definition. |
recorder | Recorder of the metric: location ID. References a Location definition. |
metricScope | Defines type of scope: location, location group, system tree node, or a generic group of locations. |
scope | Scope of metric: ID of a location, location group, system tree node, or a generic group of locations. |
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_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.
userData | User data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks. |
self | The unique identifier for this MetricMember definition. |
name | Name of the metric. References a String definition. |
description | Description of the metric. References a String definition. |
metricType | Metric type: PAPI, etc. |
metricMode | Metric mode: accumulative, fix, relative, etc. |
valueType | Type of the value: int64_t, uint64_t, or double. |
metricBase | The 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. |
exponent | The 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. |
unit | Unit 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. |
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.
userData | User data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks. |
self | The unique identifier for this Parameter definition. |
name | Name of the parameter (variable name etc.) References a String definition. |
parameterType | Type of the parameter, OTF2_ParameterType for possible types. |
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.
userData | User data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks. |
self | The unique identifier for this Region definition. |
name | Name of the region (demangled name if available). References a String definition. |
canonicalName | Alternative name of the region (e.g. mangled name). References a String definition. Since version 1.1. |
description | A more detailed description of this region. References a String definition. |
regionRole | Region role. Since version 1.1. |
paradigm | Paradigm. Since version 1.1. |
regionFlags | Region flags. Since version 1.1. |
sourceFile | The source file where this region was declared. References a String definition. |
beginLineNumber | Starting line number of this region in the source file. |
endLineNumber | Ending line number of this region in the source file. |
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.
userData | User data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks. |
self | The unique identifier for this RmaWin definition. |
name | Name, e.g. 'GASPI Queue 1', 'NVidia Card 2', etc.. References a String definition. |
comm | Communicator object used to create the window. References a Comm definition. |
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.
userData | User data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks. |
self | The unique identifier for this String definition. |
string | The string, null terminated. |
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.
userData | User data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks. |
self | The unique identifier for this SystemTreeNode definition. |
name | Free form instance name of this node. References a String definition. |
className | Free form class name of this node References a String definition. |
parent | Parent id of this node. May be OTF2_UNDEFINED_SYSTEM_TREE_NODE to indicate that there is no parent. References a SystemTreeNode definition. |
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.
userData | User data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks. |
systemTreeNode | Parent SystemTreeNode definition to which this one is a supplementary definition. References a SystemTreeNode definition. |
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_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.
userData | User data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks. |
systemTreeNode | Parent SystemTreeNode definition to which this one is a supplementary definition. References a SystemTreeNode definition. |
name | Name of the property. References a String definition. |
value | Property value. References a String definition. |
typedef OTF2_CallbackCode( * OTF2_DefReaderCallback_Unknown)(void *userData) |
Function pointer definition for the callback which is triggered for an unknown definition.
userData | User data as set by OTF2_Reader_RegisterDefCallbacks or OTF2_DefReader_SetCallbacks. |
void OTF2_DefReaderCallbacks_Clear | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks | ) |
Clears a struct for the definition callbacks.
defReaderCallbacks | Handle to a struct previously allocated with OTF2_DefReaderCallbacks_New. |
void OTF2_DefReaderCallbacks_Delete | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks | ) |
Deallocates a struct for the definition callbacks.
defReaderCallbacks | Handle to a struct previously allocated with OTF2_DefReaderCallbacks_New. |
OTF2_DefReaderCallbacks* OTF2_DefReaderCallbacks_New | ( | void | ) |
Allocates a new struct for the definition callbacks.
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetAttributeCallback | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks, |
OTF2_DefReaderCallback_Attribute | attributeCallback | ||
) |
Registers the callback for the Attribute definition.
defReaderCallbacks | Struct for all callbacks. |
attributeCallback | Function which should be called for all Attribute definitions. |
if successful
for an invalid defReaderCallbacks
argument
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetCallpathCallback | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks, |
OTF2_DefReaderCallback_Callpath | callpathCallback | ||
) |
Registers the callback for the Callpath definition.
defReaderCallbacks | Struct for all callbacks. |
callpathCallback | Function which should be called for all Callpath definitions. |
if successful
for an invalid defReaderCallbacks
argument
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetCallsiteCallback | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks, |
OTF2_DefReaderCallback_Callsite | callsiteCallback | ||
) |
Registers the callback for the Callsite definition.
defReaderCallbacks | Struct for all callbacks. |
callsiteCallback | Function which should be called for all Callsite definitions. |
if successful
for an invalid defReaderCallbacks
argument
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetClockOffsetCallback | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks, |
OTF2_DefReaderCallback_ClockOffset | clockOffsetCallback | ||
) |
Registers the callback for the ClockOffset definition.
defReaderCallbacks | Struct for all callbacks. |
clockOffsetCallback | Function which should be called for all ClockOffset definitions. |
if successful
for an invalid defReaderCallbacks
argument
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetCommCallback | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks, |
OTF2_DefReaderCallback_Comm | commCallback | ||
) |
Registers the callback for the Comm definition.
defReaderCallbacks | Struct for all callbacks. |
commCallback | Function which should be called for all Comm definitions. |
if successful
for an invalid defReaderCallbacks
argument
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetGroupCallback | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks, |
OTF2_DefReaderCallback_Group | groupCallback | ||
) |
Registers the callback for the Group definition.
defReaderCallbacks | Struct for all callbacks. |
groupCallback | Function which should be called for all Group definitions. |
if successful
for an invalid defReaderCallbacks
argument
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetLocationCallback | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks, |
OTF2_DefReaderCallback_Location | locationCallback | ||
) |
Registers the callback for the Location definition.
defReaderCallbacks | Struct for all callbacks. |
locationCallback | Function which should be called for all Location definitions. |
if successful
for an invalid defReaderCallbacks
argument
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetLocationGroupCallback | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks, |
OTF2_DefReaderCallback_LocationGroup | locationGroupCallback | ||
) |
Registers the callback for the LocationGroup definition.
defReaderCallbacks | Struct for all callbacks. |
locationGroupCallback | Function which should be called for all LocationGroup definitions. |
if successful
for an invalid defReaderCallbacks
argument
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetMappingTableCallback | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks, |
OTF2_DefReaderCallback_MappingTable | mappingTableCallback | ||
) |
Registers the callback for the MappingTable definition.
defReaderCallbacks | Struct for all callbacks. |
mappingTableCallback | Function which should be called for all MappingTable definitions. |
if successful
for an invalid defReaderCallbacks
argument
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetMetricClassCallback | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks, |
OTF2_DefReaderCallback_MetricClass | metricClassCallback | ||
) |
Registers the callback for the MetricClass definition.
defReaderCallbacks | Struct for all callbacks. |
metricClassCallback | Function which should be called for all MetricClass definitions. |
if successful
for an invalid defReaderCallbacks
argument
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetMetricClassRecorderCallback | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks, |
OTF2_DefReaderCallback_MetricClassRecorder | metricClassRecorderCallback | ||
) |
Registers the callback for the MetricClassRecorder definition.
defReaderCallbacks | Struct for all callbacks. |
metricClassRecorderCallback | Function which should be called for all MetricClassRecorder definitions. |
if successful
for an invalid defReaderCallbacks
argument
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetMetricInstanceCallback | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks, |
OTF2_DefReaderCallback_MetricInstance | metricInstanceCallback | ||
) |
Registers the callback for the MetricInstance definition.
defReaderCallbacks | Struct for all callbacks. |
metricInstanceCallback | Function which should be called for all MetricInstance definitions. |
if successful
for an invalid defReaderCallbacks
argument
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetMetricMemberCallback | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks, |
OTF2_DefReaderCallback_MetricMember | metricMemberCallback | ||
) |
Registers the callback for the MetricMember definition.
defReaderCallbacks | Struct for all callbacks. |
metricMemberCallback | Function which should be called for all MetricMember definitions. |
if successful
for an invalid defReaderCallbacks
argument
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetParameterCallback | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks, |
OTF2_DefReaderCallback_Parameter | parameterCallback | ||
) |
Registers the callback for the Parameter definition.
defReaderCallbacks | Struct for all callbacks. |
parameterCallback | Function which should be called for all Parameter definitions. |
if successful
for an invalid defReaderCallbacks
argument
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetRegionCallback | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks, |
OTF2_DefReaderCallback_Region | regionCallback | ||
) |
Registers the callback for the Region definition.
defReaderCallbacks | Struct for all callbacks. |
regionCallback | Function which should be called for all Region definitions. |
if successful
for an invalid defReaderCallbacks
argument
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetRmaWinCallback | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks, |
OTF2_DefReaderCallback_RmaWin | rmaWinCallback | ||
) |
Registers the callback for the RmaWin definition.
defReaderCallbacks | Struct for all callbacks. |
rmaWinCallback | Function which should be called for all RmaWin definitions. |
if successful
for an invalid defReaderCallbacks
argument
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetStringCallback | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks, |
OTF2_DefReaderCallback_String | stringCallback | ||
) |
Registers the callback for the String definition.
defReaderCallbacks | Struct for all callbacks. |
stringCallback | Function which should be called for all String definitions. |
if successful
for an invalid defReaderCallbacks
argument
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetSystemTreeNodeCallback | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks, |
OTF2_DefReaderCallback_SystemTreeNode | systemTreeNodeCallback | ||
) |
Registers the callback for the SystemTreeNode definition.
defReaderCallbacks | Struct for all callbacks. |
systemTreeNodeCallback | Function which should be called for all SystemTreeNode definitions. |
if successful
for an invalid defReaderCallbacks
argument
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetSystemTreeNodeDomainCallback | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks, |
OTF2_DefReaderCallback_SystemTreeNodeDomain | systemTreeNodeDomainCallback | ||
) |
Registers the callback for the SystemTreeNodeDomain definition.
defReaderCallbacks | Struct for all callbacks. |
systemTreeNodeDomainCallback | Function which should be called for all SystemTreeNodeDomain definitions. |
if successful
for an invalid defReaderCallbacks
argument
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetSystemTreeNodePropertyCallback | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks, |
OTF2_DefReaderCallback_SystemTreeNodeProperty | systemTreeNodePropertyCallback | ||
) |
Registers the callback for the SystemTreeNodeProperty definition.
defReaderCallbacks | Struct for all callbacks. |
systemTreeNodePropertyCallback | Function which should be called for all SystemTreeNodeProperty definitions. |
if successful
for an invalid defReaderCallbacks
argument
OTF2_ErrorCode OTF2_DefReaderCallbacks_SetUnknownCallback | ( | OTF2_DefReaderCallbacks * | defReaderCallbacks, |
OTF2_DefReaderCallback_Unknown | unknownCallback | ||
) |
Registers the callback for an unknown definition.
defReaderCallbacks | Struct for all callbacks. |
unknownCallback | Function which should be called for all unknown definitions. |
if successful
for an invalid defReaderCallbacks
argument