![]() |
1.5.1 (revision 4026)
|
ClockProperties |
globalOffset
, and no event with timestamp greater than (globalOffset
+ traceLength
).
This definition is only valid as a global definition.
Paradigm |
This definition is only valid as a global definition.
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. |
ParadigmProperty |
The tuple (paradigm, property) must be unique.
This definition is only valid as a global definition.
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 | attributeValue | The value of this property.value |
MappingTable |
This definition is only valid as a local definition.
OTF2_MappingType | mappingType | Says to what type of ID the mapping table has to be applied. |
const OTF2_IdMap* | idMap | Mapping table. |
ClockOffset |
This definition is only valid as a local definition.
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. |
OTF2_AttributeRef Attribute |
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. |
OTF2_SystemTreeNodeRef SystemTreeNode |
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. |
OTF2_LocationGroupRef LocationGroup |
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. |
OTF2_LocationRef Location |
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. |
OTF2_RegionRef Region |
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. |
OTF2_CallsiteRef Callsite |
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. |
OTF2_CallpathRef Callpath |
OTF2_CallpathRef | parent | The parent of this callpath. References a Callpath definition. |
OTF2_RegionRef | region | The region of this callpath. References a Region definition. |
OTF2_GroupRef Group |
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. |
OTF2_MetricMemberRef MetricMember |
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. |
OTF2_MetricRef MetricClass |
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. |
OTF2_MetricRef MetricInstance |
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. |
OTF2_CommRef Comm |
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. |
OTF2_ParameterRef Parameter |
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. |
OTF2_RmaWinRef RmaWin |
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. |
MetricClassRecorder |
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. |
SystemTreeNodeProperty |
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. |
SystemTreeNodeDomain |
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. |
LocationGroupProperty |
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. |
LocationProperty |
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. |
OTF2_CartDimensionRef CartDimension |
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. |
OTF2_CartTopologyRef CartTopology |
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. |
CartCoordinate |
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. |
OTF2_SourceCodeLocationRef SourceCodeLocation |
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.
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. |
OTF2_CallingContextRef CallingContext |
uint64_t | ip | Instruction pointer as the offset to the start of the function. |
OTF2_RegionRef | region | The region. References a Region definition. |
uint32_t | offsetLineNumber | The line offset inside the region. |
OTF2_CallingContextRef | parent | Parent id of this context. References a CallingContext definition. |
OTF2_InterruptGeneratorRef InterruptGenerator |
OTF2_StringRef | name | The name of this interrupt generator. References a String definition. |
OTF2_StringRef | unit | The unit used by this interrupt generator for the period. References a String definition. |
uint64_t | period | The period this interrupt generator generates interrupts. |