1.4 (revision 3771)
List of all definition records
OTF2 records
dot_inline_dotgraph_1.png
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()
Since:
Version 1.0
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()
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()
Since:
Version 1.0
The string definitions.

Attributes:
const char* string The string, null terminated.
See also:
OTF2_GlobalDefWriter_WriteString()
OTF2_DefWriter_WriteString()
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_DefWriter_WriteAttribute()
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_DefWriter_WriteSystemTreeNode()
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_DefWriter_WriteLocationGroup()
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_DefWriter_WriteLocation()
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_DefWriter_WriteRegion()
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_DefWriter_WriteCallsite()
Since:
Version 1.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.
See also:
OTF2_GlobalDefWriter_WriteCallpath()
OTF2_DefWriter_WriteCallpath()
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.
uint64_t members [ numberOfMembers ] The identifiers of the group members.
See also:
OTF2_GlobalDefWriter_WriteGroup()
OTF2_DefWriter_WriteGroup()
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 an Metric event, than this type and the type in the event must match.
OTF2_MetricBase 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.
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_DefWriter_WriteMetricMember()
Since:
Version 1.0
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_DefWriter_WriteMetricClass()
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 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_DefWriter_WriteMetricInstance()
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_DefWriter_WriteComm()
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_DefWriter_WriteParameter()
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_DefWriter_WriteRmaWin()
Since:
Version 1.2
MetricClassRecorder
The metric class recorder definition.

Attributes:
OTF2_MetricRef metricClass Parent MetricClass definition to which this one is a supplementary definition. References a MetricClass definition.
OTF2_LocationRef recorder The location which recorded the referenced metric class. References a Location definition.
See also:
OTF2_GlobalDefWriter_WriteMetricClassRecorder()
OTF2_DefWriter_WriteMetricClassRecorder()
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_StringRef value Property value. References a String definition.
See also:
OTF2_GlobalDefWriter_WriteSystemTreeNodeProperty()
OTF2_DefWriter_WriteSystemTreeNodeProperty()
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_DefWriter_WriteSystemTreeNodeDomain()
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_StringRef value Property value. References a String definition.
See also:
OTF2_GlobalDefWriter_WriteLocationGroupProperty()
OTF2_DefWriter_WriteLocationGroupProperty()
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_StringRef value Property value. References a String definition.
See also:
OTF2_GlobalDefWriter_WriteLocationProperty()
OTF2_DefWriter_WriteLocationProperty()
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_DefWriter_WriteCartDimension()
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_DefWriter_WriteCartTopology()
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.
uint32_t coordinates [ numberOfDimensions ] Coordinates, indexed by dimension.
See also:
OTF2_GlobalDefWriter_WriteCartCoordinate()
OTF2_DefWriter_WriteCartCoordinate()
Since:
Version 1.3