1.4 (revision 3771)
Typedefs | Functions
otf2/OTF2_DefWriter.h File Reference

This file provides all routines that write definition records of a single location. More...

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

Go to the source code of this file.

Typedefs

typedef struct
OTF2_DefWriter_struct 
OTF2_DefWriter
 Handle definition for the external definition writer.

Functions

OTF2_ErrorCode OTF2_DefWriter_GetLocationID (const OTF2_DefWriter *writer, OTF2_LocationRef *location)
 Returns the location ID of the location which is related to the writer object.
OTF2_ErrorCode OTF2_DefWriter_WriteAttribute (OTF2_DefWriter *writer, OTF2_AttributeRef self, OTF2_StringRef name, OTF2_StringRef description, OTF2_Type type)
 Writes a Attribute definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteCallpath (OTF2_DefWriter *writer, OTF2_CallpathRef self, OTF2_CallpathRef parent, OTF2_RegionRef region)
 Writes a Callpath definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteCallsite (OTF2_DefWriter *writer, OTF2_CallsiteRef self, OTF2_StringRef sourceFile, uint32_t lineNumber, OTF2_RegionRef enteredRegion, OTF2_RegionRef leftRegion)
 Writes a Callsite definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteCartCoordinate (OTF2_DefWriter *writer, OTF2_CartTopologyRef cartTopology, uint32_t rank, uint8_t numberOfDimensions, const uint32_t *coordinates)
 Writes a CartCoordinate definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteCartDimension (OTF2_DefWriter *writer, OTF2_CartDimensionRef self, OTF2_StringRef name, uint32_t size, OTF2_CartPeriodicity cartPeriodicity)
 Writes a CartDimension definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteCartTopology (OTF2_DefWriter *writer, OTF2_CartTopologyRef self, OTF2_StringRef name, OTF2_CommRef communicator, uint8_t numberOfDimensions, const OTF2_CartDimensionRef *cartDimensions)
 Writes a CartTopology definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteClockOffset (OTF2_DefWriter *writer, OTF2_TimeStamp time, int64_t offset, double standardDeviation)
 Writes a ClockOffset definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteComm (OTF2_DefWriter *writer, OTF2_CommRef self, OTF2_StringRef name, OTF2_GroupRef group, OTF2_CommRef parent)
 Writes a Comm definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteGroup (OTF2_DefWriter *writer, OTF2_GroupRef self, OTF2_StringRef name, OTF2_GroupType groupType, OTF2_Paradigm paradigm, OTF2_GroupFlag groupFlags, uint32_t numberOfMembers, const uint64_t *members)
 Writes a Group definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteLocation (OTF2_DefWriter *writer, OTF2_LocationRef self, OTF2_StringRef name, OTF2_LocationType locationType, uint64_t numberOfEvents, OTF2_LocationGroupRef locationGroup)
 Writes a Location definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteLocationGroup (OTF2_DefWriter *writer, OTF2_LocationGroupRef self, OTF2_StringRef name, OTF2_LocationGroupType locationGroupType, OTF2_SystemTreeNodeRef systemTreeParent)
 Writes a LocationGroup definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteLocationGroupProperty (OTF2_DefWriter *writer, OTF2_LocationGroupRef locationGroup, OTF2_StringRef name, OTF2_StringRef value)
 Writes a LocationGroupProperty definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteLocationProperty (OTF2_DefWriter *writer, OTF2_LocationRef location, OTF2_StringRef name, OTF2_StringRef value)
 Writes a LocationProperty definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteMappingTable (OTF2_DefWriter *writer, OTF2_MappingType mappingType, const OTF2_IdMap *idMap)
 Writes a MappingTable definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteMetricClass (OTF2_DefWriter *writer, OTF2_MetricRef self, uint8_t numberOfMetrics, const OTF2_MetricMemberRef *metricMembers, OTF2_MetricOccurrence metricOccurrence, OTF2_RecorderKind recorderKind)
 Writes a MetricClass definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteMetricClassRecorder (OTF2_DefWriter *writer, OTF2_MetricRef metricClass, OTF2_LocationRef recorder)
 Writes a MetricClassRecorder definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteMetricInstance (OTF2_DefWriter *writer, OTF2_MetricRef self, OTF2_MetricRef metricClass, OTF2_LocationRef recorder, OTF2_MetricScope metricScope, uint64_t scope)
 Writes a MetricInstance definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteMetricMember (OTF2_DefWriter *writer, 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)
 Writes a MetricMember definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteParameter (OTF2_DefWriter *writer, OTF2_ParameterRef self, OTF2_StringRef name, OTF2_ParameterType parameterType)
 Writes a Parameter definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteRegion (OTF2_DefWriter *writer, 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)
 Writes a Region definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteRmaWin (OTF2_DefWriter *writer, OTF2_RmaWinRef self, OTF2_StringRef name, OTF2_CommRef comm)
 Writes a RmaWin definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteString (OTF2_DefWriter *writer, OTF2_StringRef self, const char *string)
 Writes a String definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteSystemTreeNode (OTF2_DefWriter *writer, OTF2_SystemTreeNodeRef self, OTF2_StringRef name, OTF2_StringRef className, OTF2_SystemTreeNodeRef parent)
 Writes a SystemTreeNode definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteSystemTreeNodeDomain (OTF2_DefWriter *writer, OTF2_SystemTreeNodeRef systemTreeNode, OTF2_SystemTreeDomain systemTreeDomain)
 Writes a SystemTreeNodeDomain definition record into the DefWriter.
OTF2_ErrorCode OTF2_DefWriter_WriteSystemTreeNodeProperty (OTF2_DefWriter *writer, OTF2_SystemTreeNodeRef systemTreeNode, OTF2_StringRef name, OTF2_StringRef value)
 Writes a SystemTreeNodeProperty definition record into the DefWriter.

Detailed Description

This file provides all routines that write definition records of a single location.

Source Template:
templates/OTF2_DefWriter.tmpl.h

Function Documentation

OTF2_ErrorCode OTF2_DefWriter_GetLocationID ( const OTF2_DefWriter writer,
OTF2_LocationRef location 
)

Returns the location ID of the location which is related to the writer object.

Parameters:
writerWriter object.
locationReturn location reference.
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteAttribute ( OTF2_DefWriter writer,
OTF2_AttributeRef  self,
OTF2_StringRef  name,
OTF2_StringRef  description,
OTF2_Type  type 
)

Writes a Attribute definition record into the DefWriter.

The attribute definition.

Parameters:
writerWriter object.
selfThe unique identifier for this Attribute definition.
nameName of the attribute. References a String definition.
descriptionDescription of the attribute. References a String definition. Since version 1.4.
typeType of the attribute value.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteCallpath ( OTF2_DefWriter writer,
OTF2_CallpathRef  self,
OTF2_CallpathRef  parent,
OTF2_RegionRef  region 
)

Writes a Callpath definition record into the DefWriter.

The callpath definition.

Parameters:
writerWriter object.
selfThe unique identifier for this Callpath definition.
parentThe parent of this callpath. References a Callpath definition.
regionThe region of this callpath. References a Region definition.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteCallsite ( OTF2_DefWriter writer,
OTF2_CallsiteRef  self,
OTF2_StringRef  sourceFile,
uint32_t  lineNumber,
OTF2_RegionRef  enteredRegion,
OTF2_RegionRef  leftRegion 
)

Writes a Callsite definition record into the DefWriter.

The callsite definition.

Parameters:
writerWriter object.
selfThe unique identifier for this Callsite definition.
sourceFileThe source file where this call was made. References a String definition.
lineNumberLine number in the source file where this call was made.
enteredRegionThe region which was called. References a Region definition.
leftRegionThe region which made the call. References a Region definition.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteCartCoordinate ( OTF2_DefWriter writer,
OTF2_CartTopologyRef  cartTopology,
uint32_t  rank,
uint8_t  numberOfDimensions,
const uint32_t *  coordinates 
)

Writes a CartCoordinate definition record into the DefWriter.

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

Parameters:
writerWriter object.
cartTopologyParent CartTopology definition to which this one is a supplementary definition. References a CartTopology definition.
rankThe rank w.r.t. the communicator associated to the topology referencing this coordinate.
numberOfDimensionsNumber of dimensions.
coordinatesCoordinates, indexed by dimension.
Since:
Version 1.3
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteCartDimension ( OTF2_DefWriter writer,
OTF2_CartDimensionRef  self,
OTF2_StringRef  name,
uint32_t  size,
OTF2_CartPeriodicity  cartPeriodicity 
)

Writes a CartDimension definition record into the DefWriter.

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

Parameters:
writerWriter object.
selfThe unique identifier for this CartDimension definition.
nameThe name of the cartesian topology dimension. References a String definition.
sizeThe size of the cartesian topology dimension.
cartPeriodicityPeriodicity of the cartesian topology dimension.
Since:
Version 1.3
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteCartTopology ( OTF2_DefWriter writer,
OTF2_CartTopologyRef  self,
OTF2_StringRef  name,
OTF2_CommRef  communicator,
uint8_t  numberOfDimensions,
const OTF2_CartDimensionRef cartDimensions 
)

Writes a CartTopology definition record into the DefWriter.

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.

Parameters:
writerWriter object.
selfThe unique identifier for this CartTopology definition.
nameThe name of the topology. References a String definition.
communicatorCommunicator object used to create the topology. References a Comm definition.
numberOfDimensionsNumber of dimensions.
cartDimensionsThe dimensions of this topology. References a CartDimension definition.
Since:
Version 1.3
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteClockOffset ( OTF2_DefWriter writer,
OTF2_TimeStamp  time,
int64_t  offset,
double  standardDeviation 
)

Writes a ClockOffset definition record into the DefWriter.

Clock offsets are used for clock corrections.

Parameters:
writerWriter object.
timeTime when this offset was determined.
offsetThe offset to the global clock which was determined at time.
standardDeviationA possible standard deviation, which can be used as a metric for the quality of the offset.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteComm ( OTF2_DefWriter writer,
OTF2_CommRef  self,
OTF2_StringRef  name,
OTF2_GroupRef  group,
OTF2_CommRef  parent 
)

Writes a Comm definition record into the DefWriter.

The communicator definition.

Parameters:
writerWriter object.
selfThe unique identifier for this Comm definition.
nameThe name given by calling MPI_Comm_set_name on this communicator. Or the empty name to indicate that no name was given. References a String definition.
groupThe describing MPI group of this MPI communicator The group needs to be of type OTF2_GROUP_TYPE_COMM_GROUP or OTF2_GROUP_TYPE_COMM_SELF. References a Group definition.
parentThe parent MPI communicator from which this communicator was created, if any. Use OTF2_UNDEFINED_COMM to indicate no parent. References a Comm definition.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteGroup ( OTF2_DefWriter writer,
OTF2_GroupRef  self,
OTF2_StringRef  name,
OTF2_GroupType  groupType,
OTF2_Paradigm  paradigm,
OTF2_GroupFlag  groupFlags,
uint32_t  numberOfMembers,
const uint64_t *  members 
)

Writes a Group definition record into the DefWriter.

The group definition.

Parameters:
writerWriter object.
selfThe unique identifier for this Group definition.
nameName of this group References a String definition.
groupTypeThe type of this group. Since version 1.2.
paradigmThe paradigm of this communication group. Since version 1.2.
groupFlagsFlags for this group. Since version 1.2.
numberOfMembersThe number of members in this group.
membersThe identifiers of the group members.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteLocation ( OTF2_DefWriter writer,
OTF2_LocationRef  self,
OTF2_StringRef  name,
OTF2_LocationType  locationType,
uint64_t  numberOfEvents,
OTF2_LocationGroupRef  locationGroup 
)

Writes a Location definition record into the DefWriter.

The location definition.

Parameters:
writerWriter object.
selfThe unique identifier for this Location definition.
nameName of the location References a String definition.
locationTypeLocation type.
numberOfEventsNumber of events this location has recorded.
locationGroupLocation group which includes this location. References a LocationGroup definition.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteLocationGroup ( OTF2_DefWriter writer,
OTF2_LocationGroupRef  self,
OTF2_StringRef  name,
OTF2_LocationGroupType  locationGroupType,
OTF2_SystemTreeNodeRef  systemTreeParent 
)

Writes a LocationGroup definition record into the DefWriter.

The location group definition.

Parameters:
writerWriter object.
selfThe unique identifier for this LocationGroup definition.
nameName of the group. References a String definition.
locationGroupTypeType of this group.
systemTreeParentParent of this location group in the system tree. References a SystemTreeNode definition.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteLocationGroupProperty ( OTF2_DefWriter writer,
OTF2_LocationGroupRef  locationGroup,
OTF2_StringRef  name,
OTF2_StringRef  value 
)

Writes a LocationGroupProperty definition record into the DefWriter.

An arbitrary key/value property for a LocationGroup definition.

Parameters:
writerWriter object.
locationGroupParent LocationGroup definition to which this one is a supplementary definition. References a LocationGroup definition.
nameName of the property. References a String definition.
valueProperty value. References a String definition.
Since:
Version 1.3
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteLocationProperty ( OTF2_DefWriter writer,
OTF2_LocationRef  location,
OTF2_StringRef  name,
OTF2_StringRef  value 
)

Writes a LocationProperty definition record into the DefWriter.

An arbitrary key/value property for a Location definition.

Parameters:
writerWriter object.
locationParent Location definition to which this one is a supplementary definition. References a Location definition.
nameName of the property. References a String definition.
valueProperty value. References a String definition.
Since:
Version 1.3
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteMappingTable ( OTF2_DefWriter writer,
OTF2_MappingType  mappingType,
const OTF2_IdMap idMap 
)

Writes a MappingTable definition record into the DefWriter.

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

Parameters:
writerWriter object.
mappingTypeSays to what type of ID the mapping table has to be applied.
idMapMapping table.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteMetricClass ( OTF2_DefWriter writer,
OTF2_MetricRef  self,
uint8_t  numberOfMetrics,
const OTF2_MetricMemberRef metricMembers,
OTF2_MetricOccurrence  metricOccurrence,
OTF2_RecorderKind  recorderKind 
)

Writes a MetricClass definition record into the DefWriter.

For a metric class it is implicitly given that the event stream that records the metric is also the scope. A metric class can contain multiple different metrics.

Parameters:
writerWriter object.
selfThe unique identifier for this MetricClass definition.
numberOfMetricsNumber of metrics within the set.
metricMembersList of metric members. References a MetricMember definition.
metricOccurrenceDefines occurrence of a metric set.
recorderKindWhat kind of locations will record this metric class, or will this metric class only be recorded by metric instances. Since version 1.2.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteMetricClassRecorder ( OTF2_DefWriter writer,
OTF2_MetricRef  metricClass,
OTF2_LocationRef  recorder 
)

Writes a MetricClassRecorder definition record into the DefWriter.

The metric class recorder definition.

Parameters:
writerWriter object.
metricClassParent MetricClass definition to which this one is a supplementary definition. References a MetricClass definition.
recorderThe location which recorded the referenced metric class. References a Location definition.
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteMetricInstance ( OTF2_DefWriter writer,
OTF2_MetricRef  self,
OTF2_MetricRef  metricClass,
OTF2_LocationRef  recorder,
OTF2_MetricScope  metricScope,
uint64_t  scope 
)

Writes a MetricInstance definition record into the DefWriter.

A metric instance is used to define metrics that are recorded at one location for multiple locations or for another location. The occurrence of a metric instance is implicitly of type OTF2_METRIC_ASYNCHRONOUS.

Parameters:
writerWriter object.
selfThe unique identifier for this MetricClass definition.
metricClassThe instanced MetricClass. This metric class must be of kind OTF2_RECORDER_KIND_ABSTRACT. References a MetricClass definition.
recorderRecorder of the metric: location ID. References a Location definition.
metricScopeDefines type of scope: location, location group, system tree node, or a generic group of locations.
scopeScope of metric: ID of a location, location group, system tree node, or a generic group of locations.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteMetricMember ( OTF2_DefWriter writer,
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 
)

Writes a MetricMember definition record into the DefWriter.

A metric is defined by a metric member definition. A metric member is always a member of a metric class. Therefore, a single metric is a special case of a metric class with only one member. It is not allowed to reference a metric member id in a metric event, but only metric class IDs.

Parameters:
writerWriter object.
selfThe unique identifier for this MetricMember definition.
nameName of the metric. References a String definition.
descriptionDescription of the metric. References a String definition.
metricTypeMetric type: PAPI, etc.
metricModeMetric mode: accumulative, fix, relative, etc.
valueTypeType of the value. 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.
metricBaseThe recorded values should be handled in this given base, either binary or decimal. This information can be used if the value needs to be scaled.
exponentThe values inside the Metric events should be scaled by the factor base^exponent, to get the value in its base unit. For example, if the metric values come in as KiBi, than the base should be OTF2_BASE_BINARY and the exponent 10. Than the writer does not need to scale the values up to bytes, but can directly write the KiBi values into the Metric event. At reading time, the reader can apply the scaling factor to get the value in its base unit, ie. in bytes.
unitUnit of the metric. This needs to be the scale free base unit, ie. "bytes", "operations", or "seconds". In particular this unit should not have any scale prefix. References a String definition.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteParameter ( OTF2_DefWriter writer,
OTF2_ParameterRef  self,
OTF2_StringRef  name,
OTF2_ParameterType  parameterType 
)

Writes a Parameter definition record into the DefWriter.

The parameter definition.

Parameters:
writerWriter object.
selfThe unique identifier for this Parameter definition.
nameName of the parameter (variable name etc.) References a String definition.
parameterTypeType of the parameter, OTF2_ParameterType for possible types.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteRegion ( OTF2_DefWriter writer,
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 
)

Writes a Region definition record into the DefWriter.

The region definition.

Parameters:
writerWriter object.
selfThe unique identifier for this Region definition.
nameName of the region (demangled name if available). References a String definition.
canonicalNameAlternative name of the region (e.g. mangled name). References a String definition. Since version 1.1.
descriptionA more detailed description of this region. References a String definition.
regionRoleRegion role. Since version 1.1.
paradigmParadigm. Since version 1.1.
regionFlagsRegion flags. Since version 1.1.
sourceFileThe source file where this region was declared. References a String definition.
beginLineNumberStarting line number of this region in the source file.
endLineNumberEnding line number of this region in the source file.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteRmaWin ( OTF2_DefWriter writer,
OTF2_RmaWinRef  self,
OTF2_StringRef  name,
OTF2_CommRef  comm 
)

Writes a RmaWin definition record into the DefWriter.

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

Parameters:
writerWriter object.
selfThe unique identifier for this RmaWin definition.
nameName, e.g. 'GASPI Queue 1', 'NVidia Card 2', etc.. References a String definition.
commCommunicator object used to create the window. References a Comm definition.
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteString ( OTF2_DefWriter writer,
OTF2_StringRef  self,
const char *  string 
)

Writes a String definition record into the DefWriter.

The string definitions.

Parameters:
writerWriter object.
selfThe unique identifier for this String definition.
stringThe string, null terminated.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteSystemTreeNode ( OTF2_DefWriter writer,
OTF2_SystemTreeNodeRef  self,
OTF2_StringRef  name,
OTF2_StringRef  className,
OTF2_SystemTreeNodeRef  parent 
)

Writes a SystemTreeNode definition record into the DefWriter.

The system tree node definition.

Parameters:
writerWriter object.
selfThe unique identifier for this SystemTreeNode definition.
nameFree form instance name of this node. References a String definition.
classNameFree form class name of this node References a String definition.
parentParent id of this node. May be OTF2_UNDEFINED_SYSTEM_TREE_NODE to indicate that there is no parent. References a SystemTreeNode definition.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteSystemTreeNodeDomain ( OTF2_DefWriter writer,
OTF2_SystemTreeNodeRef  systemTreeNode,
OTF2_SystemTreeDomain  systemTreeDomain 
)

Writes a SystemTreeNodeDomain definition record into the DefWriter.

The system tree node domain definition.

Parameters:
writerWriter object.
systemTreeNodeParent SystemTreeNode definition to which this one is a supplementary definition. References a SystemTreeNode definition.
systemTreeDomainThe domain in which the referenced SystemTreeNode operates in.
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_DefWriter_WriteSystemTreeNodeProperty ( OTF2_DefWriter writer,
OTF2_SystemTreeNodeRef  systemTreeNode,
OTF2_StringRef  name,
OTF2_StringRef  value 
)

Writes a SystemTreeNodeProperty definition record into the DefWriter.

An arbitrary key/value property for a SystemTreeNode definition.

Parameters:
writerWriter object.
systemTreeNodeParent SystemTreeNode definition to which this one is a supplementary definition. References a SystemTreeNode definition.
nameName of the property. References a String definition.
valueProperty value. References a String definition.
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.