2.2 (revision 4737)
List of all definition records

ClockProperties
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).

This definition is only valid as a global definition.

Attributes:
uint64_t timerResolution Ticks per seconds.
uint64_t globalOffset A timestamp smaller than all event timestamps.
uint64_t traceLength A timespan which includes the timespan between the smallest and greatest timestamp of all event timestamps.
See also
OTF2_GlobalDefWriter_WriteClockProperties()
OTF2_GlobalDefReaderCallbacks_SetClockPropertiesCallback()
Since
Version 1.0

Paradigm
Attests that the following parallel paradigm was available at the time when the trace was recorded, and vice versa. Note that this does not attest that the paradigm was used. For convenience, this also includes a proper name for the paradigm and a classification. This definition is only allowed to appear at most once in the definitions per Paradigm.

This definition is only valid as a global definition.

Attributes:
OTF2_Paradigm paradigm The paradigm to attest.
OTF2_StringRef name The name of the paradigm. References a String definition.
OTF2_ParadigmClass paradigmClass The class of this paradigm.
See also
OTF2_GlobalDefWriter_WriteParadigm()
OTF2_GlobalDefReaderCallbacks_SetParadigmCallback()
Since
Version 1.5

ParadigmProperty
Extensible annotation for the Paradigm definition.

The tuple (paradigm, property) must be unique.

This definition is only valid as a global definition.

Attributes:
OTF2_Paradigm paradigm The paradigm to annotate.
OTF2_ParadigmProperty property The property.
OTF2_Type type The type of this property. Must match with the defined type of the property.
OTF2_AttributeValue value The value of this property.
See also
OTF2_GlobalDefWriter_WriteParadigmProperty()
OTF2_GlobalDefReaderCallbacks_SetParadigmPropertyCallback()
Since
Version 1.5

OTF2_IoParadigmRef IoParadigm
Attests that the following I/O paradigm was available at the time when the trace was recorded, and vice versa. Note that this does not attest that the paradigm was used. For convenience, this also includes a proper name for the paradigm and a classification.

This definition is only valid as a global definition.

Attributes:
OTF2_StringRef identification The I/O paradigm identification. This should be used programmatically to identify a specific I/O paradigm. For a human-readable name use the name attribute. If this identification matches one of the known I/O paradigms listed in the OTF2 documentation Known OTF2 I/O paradigms, then the attributes of this definition must match those specified there. References a String definition.
OTF2_StringRef name The name of the I/O paradigm. This should be presented to humans as the name of this I/O paradigm. References a String definition.
OTF2_IoParadigmClass ioParadigmClass The class of this I/O paradigm.
OTF2_IoParadigmFlag ioParadigmFlags Boolean properties of this I/O paradigm.
uint8_t numberOfProperties Number of properties.
OTF2_IoParadigmProperty properties [ numberOfProperties ] The property.
OTF2_Type types [ numberOfProperties ] The type of this property. Must match with the defined type of the property.
OTF2_AttributeValue values [ numberOfProperties ] The value of this property.
See also
OTF2_GlobalDefWriter_WriteIoParadigm()
OTF2_GlobalDefReaderCallbacks_SetIoParadigmCallback()
Since
Version 2.1

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

This definition is only valid as a local definition.

Attributes:
OTF2_MappingType mappingType Says to what type of ID the mapping table has to be applied.
const OTF2_IdMap* idMap Mapping table.
See also
OTF2_DefWriter_WriteMappingTable()
OTF2_DefReaderCallbacks_SetMappingTableCallback()
Since
Version 1.0

ClockOffset
Clock offsets are used for clock corrections.

This definition is only valid as a local definition.

Attributes:
OTF2_TimeStamp time Time when this offset was determined.
int64_t offset The offset to the global clock which was determined at time.
double standardDeviation A possible standard deviation, which can be used as a metric for the quality of the offset.
See also
OTF2_DefWriter_WriteClockOffset()
OTF2_DefReaderCallbacks_SetClockOffsetCallback()
Since
Version 1.0

The string definition.

Attributes:
const char* string The string, null terminated.
See also
OTF2_GlobalDefWriter_WriteString()
OTF2_GlobalDefReaderCallbacks_SetStringCallback()
OTF2_DefWriter_WriteString()
OTF2_DefReaderCallbacks_SetStringCallback()
Since
Version 1.0

OTF2_AttributeRef Attribute
The attribute definition.

Attributes:
OTF2_StringRef name Name of the attribute. References a String definition.
OTF2_StringRef description Description of the attribute. References a String definition. Since version 1.4.
OTF2_Type type Type of the attribute value.
See also
OTF2_GlobalDefWriter_WriteAttribute()
OTF2_GlobalDefReaderCallbacks_SetAttributeCallback()
OTF2_DefWriter_WriteAttribute()
OTF2_DefReaderCallbacks_SetAttributeCallback()
Since
Version 1.0

OTF2_SystemTreeNodeRef SystemTreeNode
The system tree node definition.

Attributes:
OTF2_StringRef name Free form instance name of this node. References a String definition.
OTF2_StringRef className Free form class name of this node References a String definition.
OTF2_SystemTreeNodeRef parent Parent id of this node. May be OTF2_UNDEFINED_SYSTEM_TREE_NODE to indicate that there is no parent. References a SystemTreeNode definition.
Supplements:
SystemTreeNodeProperty
SystemTreeNodeDomain
See also
OTF2_GlobalDefWriter_WriteSystemTreeNode()
OTF2_GlobalDefReaderCallbacks_SetSystemTreeNodeCallback()
OTF2_DefWriter_WriteSystemTreeNode()
OTF2_DefReaderCallbacks_SetSystemTreeNodeCallback()
Since
Version 1.0

OTF2_LocationGroupRef LocationGroup
The location group definition.

Attributes:
OTF2_StringRef name Name of the group. References a String definition.
OTF2_LocationGroupType locationGroupType Type of this group.
OTF2_SystemTreeNodeRef systemTreeParent Parent of this location group in the system tree. References a SystemTreeNode definition.
Supplements:
LocationGroupProperty
See also
OTF2_GlobalDefWriter_WriteLocationGroup()
OTF2_GlobalDefReaderCallbacks_SetLocationGroupCallback()
OTF2_DefWriter_WriteLocationGroup()
OTF2_DefReaderCallbacks_SetLocationGroupCallback()
Since
Version 1.0

OTF2_LocationRef Location
The location definition.

Attributes:
OTF2_StringRef name Name of the location References a String definition.
OTF2_LocationType locationType Location type.
uint64_t numberOfEvents Number of events this location has recorded.
OTF2_LocationGroupRef locationGroup Location group which includes this location. References a LocationGroup definition.
Supplements:
LocationProperty
See also
OTF2_GlobalDefWriter_WriteLocation()
OTF2_GlobalDefReaderCallbacks_SetLocationCallback()
OTF2_DefWriter_WriteLocation()
OTF2_DefReaderCallbacks_SetLocationCallback()
Since
Version 1.0

The region definition.

Attributes:
OTF2_StringRef name Name of the region (demangled name if available). References a String definition.
OTF2_StringRef canonicalName Alternative name of the region (e.g. mangled name). References a String definition. Since version 1.1.
OTF2_StringRef description A more detailed description of this region. References a String definition.
OTF2_RegionRole regionRole Region role. Since version 1.1.
OTF2_Paradigm paradigm Paradigm. Since version 1.1.
OTF2_RegionFlag regionFlags Region flags. Since version 1.1.
OTF2_StringRef sourceFile The source file where this region was declared. References a String definition.
uint32_t beginLineNumber Starting line number of this region in the source file.
uint32_t endLineNumber Ending line number of this region in the source file.
See also
OTF2_GlobalDefWriter_WriteRegion()
OTF2_GlobalDefReaderCallbacks_SetRegionCallback()
OTF2_DefWriter_WriteRegion()
OTF2_DefReaderCallbacks_SetRegionCallback()
Since
Version 1.0

OTF2_CallsiteRef Callsite
The callsite definition.

Attributes:
OTF2_StringRef sourceFile The source file where this call was made. References a String definition.
uint32_t lineNumber Line number in the source file where this call was made.
OTF2_RegionRef enteredRegion The region which was called. References a Region definition.
OTF2_RegionRef leftRegion The region which made the call. References a Region definition.
See also
OTF2_GlobalDefWriter_WriteCallsite()
OTF2_GlobalDefReaderCallbacks_SetCallsiteCallback()
OTF2_DefWriter_WriteCallsite()
OTF2_DefReaderCallbacks_SetCallsiteCallback()
Since
Version 1.0
Deprecated:
In version 2.0

OTF2_CallpathRef Callpath
The callpath definition.

Attributes:
OTF2_CallpathRef parent The parent of this callpath. References a Callpath definition.
OTF2_RegionRef region The region of this callpath. References a Region definition.
Supplements:
CallpathParameter
See also
OTF2_GlobalDefWriter_WriteCallpath()
OTF2_GlobalDefReaderCallbacks_SetCallpathCallback()
OTF2_DefWriter_WriteCallpath()
OTF2_DefReaderCallbacks_SetCallpathCallback()
Since
Version 1.0

The group definition.

Attributes:
OTF2_StringRef name Name of this group References a String definition.
OTF2_GroupType groupType The type of this group. Since version 1.2.
OTF2_Paradigm paradigm The paradigm of this communication group. Since version 1.2.
OTF2_GroupFlag groupFlags Flags for this group. Since version 1.2.
uint32_t numberOfMembers The number of members in this group.
uint32_t members [ numberOfMembers ] The identifiers of the group members.
See also
OTF2_GlobalDefWriter_WriteGroup()
OTF2_GlobalDefReaderCallbacks_SetGroupCallback()
OTF2_DefWriter_WriteGroup()
OTF2_DefReaderCallbacks_SetGroupCallback()
Since
Version 1.0

OTF2_MetricMemberRef MetricMember
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.

Attributes:
OTF2_StringRef name Name of the metric. References a String definition.
OTF2_StringRef description Description of the metric. References a String definition.
OTF2_MetricType metricType Metric type: PAPI, etc.
OTF2_MetricMode metricMode Metric mode: accumulative, fix, relative, etc.
OTF2_Type valueType Type 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.
OTF2_Base base 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.
int64_t 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.
OTF2_StringRef 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.
See also
OTF2_GlobalDefWriter_WriteMetricMember()
OTF2_GlobalDefReaderCallbacks_SetMetricMemberCallback()
OTF2_DefWriter_WriteMetricMember()
OTF2_DefReaderCallbacks_SetMetricMemberCallback()
Since
Version 1.0

This is a polymorphic definition class.

Derivations:
MetricClass
MetricInstance

OTF2_MetricRef MetricClass
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.

Attributes:
uint8_t numberOfMetrics Number of metrics within the set.
OTF2_MetricMemberRef metricMembers [ numberOfMetrics ] List of metric members. References a MetricMember definition.
OTF2_MetricOccurrence metricOccurrence Defines occurrence of a metric set.
OTF2_RecorderKind 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.
Supplements:
MetricClassRecorder
See also
OTF2_GlobalDefWriter_WriteMetricClass()
OTF2_GlobalDefReaderCallbacks_SetMetricClassCallback()
OTF2_DefWriter_WriteMetricClass()
OTF2_DefReaderCallbacks_SetMetricClassCallback()
Since
Version 1.0

OTF2_MetricRef MetricInstance
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.

Attributes:
OTF2_MetricRef metricClass The instanced MetricClass. This metric class must be of kind OTF2_RECORDER_KIND_ABSTRACT. References a MetricClass, or a MetricInstance definition.
OTF2_LocationRef recorder Recorder of the metric: location ID. References a Location definition.
OTF2_MetricScope metricScope Defines type of scope: location, location group, system tree node, or a generic group of locations.
uint64_t scope Scope of metric: ID of a location, location group, system tree node, or a generic group of locations.
See also
OTF2_GlobalDefWriter_WriteMetricInstance()
OTF2_GlobalDefReaderCallbacks_SetMetricInstanceCallback()
OTF2_DefWriter_WriteMetricInstance()
OTF2_DefReaderCallbacks_SetMetricInstanceCallback()
Since
Version 1.0

The communicator definition.

Attributes:
OTF2_StringRef 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.
OTF2_GroupRef group The 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.

OTF2_CommRef 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.
See also
OTF2_GlobalDefWriter_WriteComm()
OTF2_GlobalDefReaderCallbacks_SetCommCallback()
OTF2_DefWriter_WriteComm()
OTF2_DefReaderCallbacks_SetCommCallback()
Since
Version 1.0

OTF2_ParameterRef Parameter
The parameter definition.

Attributes:
OTF2_StringRef name Name of the parameter (variable name etc.) References a String definition.
OTF2_ParameterType parameterType Type of the parameter, OTF2_ParameterType for possible types.
See also
OTF2_GlobalDefWriter_WriteParameter()
OTF2_GlobalDefReaderCallbacks_SetParameterCallback()
OTF2_DefWriter_WriteParameter()
OTF2_DefReaderCallbacks_SetParameterCallback()
Since
Version 1.0

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

Attributes:
OTF2_StringRef name Name, e.g. 'GASPI Queue 1', 'NVidia Card 2', etc.. References a String definition.
OTF2_CommRef comm Communicator object used to create the window. References a Comm definition.
See also
OTF2_GlobalDefWriter_WriteRmaWin()
OTF2_GlobalDefReaderCallbacks_SetRmaWinCallback()
OTF2_DefWriter_WriteRmaWin()
OTF2_DefReaderCallbacks_SetRmaWinCallback()
Since
Version 1.2

MetricClassRecorder
The metric class recorder definition.

Attributes:
OTF2_MetricRef metric Parent MetricClass, or MetricInstance definition to which this one is a supplementary definition. References a MetricClass, or a MetricInstance definition.
OTF2_LocationRef recorder The location which recorded the referenced metric class. References a Location definition.
See also
OTF2_GlobalDefWriter_WriteMetricClassRecorder()
OTF2_GlobalDefReaderCallbacks_SetMetricClassRecorderCallback()
OTF2_DefWriter_WriteMetricClassRecorder()
OTF2_DefReaderCallbacks_SetMetricClassRecorderCallback()
Since
Version 1.2

SystemTreeNodeProperty
An arbitrary key/value property for a SystemTreeNode definition.

Attributes:
OTF2_SystemTreeNodeRef systemTreeNode Parent SystemTreeNode definition to which this one is a supplementary definition. References a SystemTreeNode definition.
OTF2_StringRef name Name of the property. References a String definition.
OTF2_Type type The type of this property. Since version 2.0.
OTF2_AttributeValue value The value of this property. Since version 2.0.
See also
OTF2_GlobalDefWriter_WriteSystemTreeNodeProperty()
OTF2_GlobalDefReaderCallbacks_SetSystemTreeNodePropertyCallback()
OTF2_DefWriter_WriteSystemTreeNodeProperty()
OTF2_DefReaderCallbacks_SetSystemTreeNodePropertyCallback()
Since
Version 1.2

SystemTreeNodeDomain
The system tree node domain definition.

Attributes:
OTF2_SystemTreeNodeRef systemTreeNode Parent SystemTreeNode definition to which this one is a supplementary definition. References a SystemTreeNode definition.
OTF2_SystemTreeDomain systemTreeDomain The domain in which the referenced SystemTreeNode operates in.
See also
OTF2_GlobalDefWriter_WriteSystemTreeNodeDomain()
OTF2_GlobalDefReaderCallbacks_SetSystemTreeNodeDomainCallback()
OTF2_DefWriter_WriteSystemTreeNodeDomain()
OTF2_DefReaderCallbacks_SetSystemTreeNodeDomainCallback()
Since
Version 1.2

LocationGroupProperty
An arbitrary key/value property for a LocationGroup definition.

Attributes:
OTF2_LocationGroupRef locationGroup Parent LocationGroup definition to which this one is a supplementary definition. References a LocationGroup definition.
OTF2_StringRef name Name of the property. References a String definition.
OTF2_Type type The type of this property. Since version 2.0.
OTF2_AttributeValue value The value of this property. Since version 2.0.
See also
OTF2_GlobalDefWriter_WriteLocationGroupProperty()
OTF2_GlobalDefReaderCallbacks_SetLocationGroupPropertyCallback()
OTF2_DefWriter_WriteLocationGroupProperty()
OTF2_DefReaderCallbacks_SetLocationGroupPropertyCallback()
Since
Version 1.3

LocationProperty
An arbitrary key/value property for a Location definition.

Attributes:
OTF2_LocationRef location Parent Location definition to which this one is a supplementary definition. References a Location definition.
OTF2_StringRef name Name of the property. References a String definition.
OTF2_Type type The type of this property. Since version 2.0.
OTF2_AttributeValue value The value of this property. Since version 2.0.
See also
OTF2_GlobalDefWriter_WriteLocationProperty()
OTF2_GlobalDefReaderCallbacks_SetLocationPropertyCallback()
OTF2_DefWriter_WriteLocationProperty()
OTF2_DefReaderCallbacks_SetLocationPropertyCallback()
Since
Version 1.3

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

Attributes:
OTF2_StringRef name The name of the cartesian topology dimension. References a String definition.
uint32_t size The size of the cartesian topology dimension.
OTF2_CartPeriodicity cartPeriodicity Periodicity of the cartesian topology dimension.
See also
OTF2_GlobalDefWriter_WriteCartDimension()
OTF2_GlobalDefReaderCallbacks_SetCartDimensionCallback()
OTF2_DefWriter_WriteCartDimension()
OTF2_DefReaderCallbacks_SetCartDimensionCallback()
Since
Version 1.3

OTF2_CartTopologyRef CartTopology
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.

Attributes:
OTF2_StringRef name The name of the topology. References a String definition.
OTF2_CommRef communicator Communicator object used to create the topology. References a Comm definition.
uint8_t numberOfDimensions Number of dimensions.
OTF2_CartDimensionRef cartDimensions [ numberOfDimensions ] The dimensions of this topology. References a CartDimension definition.
Supplements:
CartCoordinate
See also
OTF2_GlobalDefWriter_WriteCartTopology()
OTF2_GlobalDefReaderCallbacks_SetCartTopologyCallback()
OTF2_DefWriter_WriteCartTopology()
OTF2_DefReaderCallbacks_SetCartTopologyCallback()
Since
Version 1.3

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

Attributes:
OTF2_CartTopologyRef cartTopology Parent CartTopology definition to which this one is a supplementary definition. References a CartTopology definition.
uint32_t rank The rank w.r.t. the communicator associated to the topology referencing this coordinate.
uint8_t numberOfDimensions Number of dimensions.
uint8_t coordinates [ numberOfDimensions ] Coordinates, indexed by dimension.
See also
OTF2_GlobalDefWriter_WriteCartCoordinate()
OTF2_GlobalDefReaderCallbacks_SetCartCoordinateCallback()
OTF2_DefWriter_WriteCartCoordinate()
OTF2_DefReaderCallbacks_SetCartCoordinateCallback()
Since
Version 1.3

OTF2_SourceCodeLocationRef SourceCodeLocation
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.

Attributes:
OTF2_StringRef file The name of the file for the source code location. References a String definition.
uint32_t lineNumber The line number for the source code location.
See also
OTF2_GlobalDefWriter_WriteSourceCodeLocation()
OTF2_GlobalDefReaderCallbacks_SetSourceCodeLocationCallback()
OTF2_DefWriter_WriteSourceCodeLocation()
OTF2_DefReaderCallbacks_SetSourceCodeLocationCallback()
Since
Version 1.5

OTF2_CallingContextRef CallingContext
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.

Attributes:
OTF2_RegionRef region The region. References a Region definition.
OTF2_SourceCodeLocationRef sourceCodeLocation The absolute source code location of this calling context. References a SourceCodeLocation definition.
OTF2_CallingContextRef parent Parent id of this context. References a CallingContext definition.
Supplements:
CallingContextProperty
See also
OTF2_GlobalDefWriter_WriteCallingContext()
OTF2_GlobalDefReaderCallbacks_SetCallingContextCallback()
OTF2_DefWriter_WriteCallingContext()
OTF2_DefReaderCallbacks_SetCallingContextCallback()
Since
Version 1.5

CallingContextProperty
An arbitrary key/value property for a CallingContext definition.

Attributes:
OTF2_CallingContextRef callingContext Parent CallingContext definition to which this one is a supplementary definition. References a CallingContext definition.
OTF2_StringRef name Property name. References a String definition.
OTF2_Type type The type of this property. Must match with the defined type of the property.
OTF2_AttributeValue value The value of this property.
See also
OTF2_GlobalDefWriter_WriteCallingContextProperty()
OTF2_GlobalDefReaderCallbacks_SetCallingContextPropertyCallback()
OTF2_DefWriter_WriteCallingContextProperty()
OTF2_DefReaderCallbacks_SetCallingContextPropertyCallback()
Since
Version 2.0

OTF2_InterruptGeneratorRef InterruptGenerator
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

Attributes:
OTF2_StringRef name The name of this interrupt generator. References a String definition.
OTF2_InterruptGeneratorMode interruptGeneratorMode Mode of the interrupt generator.
OTF2_Base base The base for the period calculation.
int64_t exponent The exponent for the period calculation.
uint64_t period The period this interrupt generator generates interrupts.
See also
OTF2_GlobalDefWriter_WriteInterruptGenerator()
OTF2_GlobalDefReaderCallbacks_SetInterruptGeneratorCallback()
OTF2_DefWriter_WriteInterruptGenerator()
OTF2_DefReaderCallbacks_SetInterruptGeneratorCallback()
Since
Version 1.5

IoFileProperty
Extensible annotation for the polymorphic IoFile definition class.

The tuple (ioFile, name) must be unique.

Attributes:
OTF2_IoFileRef ioFile Parent IoRegularFile definition to which this one is a supplementary definition. References a IoRegularFile definition.
OTF2_StringRef name Property name. References a String definition.
OTF2_Type type The type of this property.
OTF2_AttributeValue value The value of this property.
See also
OTF2_GlobalDefWriter_WriteIoFileProperty()
OTF2_GlobalDefReaderCallbacks_SetIoFilePropertyCallback()
OTF2_DefWriter_WriteIoFileProperty()
OTF2_DefReaderCallbacks_SetIoFilePropertyCallback()
Since
Version 2.1

This is a polymorphic definition class.

Derivations:
IoRegularFile
IoDirectory

OTF2_IoFileRef IoRegularFile
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.

Attributes:
OTF2_StringRef name Name of the file. References a String definition.
OTF2_SystemTreeNodeRef scope Defines 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.
Supplements:
IoFileProperty
See also
OTF2_GlobalDefWriter_WriteIoRegularFile()
OTF2_GlobalDefReaderCallbacks_SetIoRegularFileCallback()
OTF2_DefWriter_WriteIoRegularFile()
OTF2_DefReaderCallbacks_SetIoRegularFileCallback()
Since
Version 2.1

OTF2_IoFileRef IoDirectory
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.

Attributes:
OTF2_StringRef name Name of the directory. References a String definition.
OTF2_SystemTreeNodeRef scope Defines 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.
See also
OTF2_GlobalDefWriter_WriteIoDirectory()
OTF2_GlobalDefReaderCallbacks_SetIoDirectoryCallback()
OTF2_DefWriter_WriteIoDirectory()
OTF2_DefReaderCallbacks_SetIoDirectoryCallback()
Since
Version 2.1

OTF2_IoHandleRef IoHandle
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.

Attributes:
OTF2_StringRef name Handle name. References a String definition.
OTF2_IoFileRef file File identifier. References a IoRegularFile, or a IoDirectory definition.
OTF2_IoParadigmRef ioParadigm The I/O paradigm. References a IoParadigm definition.
OTF2_IoHandleFlag ioHandleFlags Special characteristics of this handle.
OTF2_CommRef comm Scope 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.
OTF2_IoHandleRef parent Parent, in case this I/O handle was created and operated by an higher- level I/O paradigm. References a IoHandle definition.
Supplements:
IoPreCreatedHandleState
See also
OTF2_GlobalDefWriter_WriteIoHandle()
OTF2_GlobalDefReaderCallbacks_SetIoHandleCallback()
OTF2_DefWriter_WriteIoHandle()
OTF2_DefReaderCallbacks_SetIoHandleCallback()
Since
Version 2.1

IoPreCreatedHandleState
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.

Attributes:
OTF2_IoHandleRef ioHandle Parent IoHandle definition to which this one is a supplementary definition. References a IoHandle definition.
OTF2_IoAccessMode mode The access mode of the pre-created IoHandle.
OTF2_IoStatusFlag statusFlags The status flags of the pre-created IoHandle.
See also
OTF2_GlobalDefWriter_WriteIoPreCreatedHandleState()
OTF2_GlobalDefReaderCallbacks_SetIoPreCreatedHandleStateCallback()
OTF2_DefWriter_WriteIoPreCreatedHandleState()
OTF2_DefReaderCallbacks_SetIoPreCreatedHandleStateCallback()
Since
Version 2.1

CallpathParameter
A parameter for a callpath definition.

Attributes:
OTF2_CallpathRef callpath Parent Callpath definition to which this one is a supplementary definition. References a Callpath definition.
OTF2_ParameterRef parameter The parameter of this callpath. References a Parameter definition.
OTF2_Type type The type of the attribute value. Must match the type of the parameter.
OTF2_AttributeValue value The value of the parameter for this callpath.
See also
OTF2_GlobalDefWriter_WriteCallpathParameter()
OTF2_GlobalDefReaderCallbacks_SetCallpathParameterCallback()
OTF2_DefWriter_WriteCallpathParameter()
OTF2_DefReaderCallbacks_SetCallpathParameterCallback()
Since
Version 2.2