Reference¶
definitions¶
- class Attribute(registry, ref, name=None, *args, **kwargs)[source]¶
Bases:
_NamedRefDefinition
- Parameters:
name (str) – required argument
description (str) – default value ‘’
type (otf2.Type) – default value Type.STRING
- class CallingContext(registry, ref, *args, **kwargs)[source]¶
Bases:
_RefDefinition
Note
Use None as parent to indicate that this is the topmost CallingContext
- Parameters:
region (otf2.definitions.Region) – required argument
source_code_location (otf2.definitions.SourceCodeLocation) – default value None
parent (otf2.definitions.CallingContext) – required argument
- class CallingContextProperty(registry, arg0, arg1, type_id=None, value=None)[source]¶
Bases:
_PropertyDefinition
- Parameters:
calling_context (otf2.definitions.CallingContext) – required argument
name (str) – required argument
type (otf2.Type) – The type is inferred from the current value and should not be provided by the user.
value (value_type) – required argument
- class Callpath(registry, ref, *args, **kwargs)[source]¶
Bases:
_RefDefinition
Note
Use None as parent to indicate that this is the topmost region in the Callpath.
- Parameters:
parent (otf2.definitions.Callpath) – required argument
region (otf2.definitions.Region) – required argument
- class CallpathParameter(registry, arg0, arg1, type_id=None, value=None)[source]¶
Bases:
_PropertyDefinition
- Parameters:
callpath (otf2.definitions.Callpath) – required argument
parameter (otf2.definitions.Parameter) – required argument
type (otf2.Type) – The type is inferred from the current value and should not be provided by the user.
value (value_type) – required argument
- class Callsite(registry, ref, *args, **kwargs)[source]¶
Bases:
_RefDefinition
- Parameters:
source_file (str) – default value None
line_number (builtins.int) – default value 0
entered_region (otf2.definitions.Region) – required argument
left_region (otf2.definitions.Region) – required argument
- class CartCoordinate(registry, *args, **kwargs)[source]¶
Bases:
_Definition
Note
Coordinates is a tuple of integers.
- Parameters:
topology (otf2.definitions.CartTopology) – required argument
rank (builtins.int) – required argument
coordinates (builtins.tuple) – required argument
- class CartDimension(registry, ref, name=None, *args, **kwargs)[source]¶
Bases:
_NamedRefDefinition
- Parameters:
name (str) – required argument
size (builtins.int) – required argument
cart_periodicity (otf2.CartPeriodicity) – default value CartPeriodicity.FALSE
- class CartTopology(registry, ref, name=None, *args, **kwargs)[source]¶
Bases:
_NamedRefDefinition
Note
Dimensions is a tuple of
otf2.definitions.CartDimension
.- Parameters:
name (str) – required argument
communicator (otf2.definitions.Comm) – required argument
dimensions (builtins.tuple) – required argument
- class ClockProperties(registry, *args, **kwargs)[source]¶
Bases:
_Definition
- Parameters:
timer_resolution (builtins.int) – required argument
global_offset (builtins.int) – default value 0
trace_length (builtins.int) – default value 0
realtime_timestamp (builtins.int) – default value 18446744073709551615
- class Comm(registry, ref, name=None, *args, **kwargs)[source]¶
Bases:
_NamedRefDefinition
- Parameters:
name (str) – required argument
group (otf2.definitions.Group) – required argument
parent (otf2.definitions.Comm) – default value None
flags (otf2.CommFlag) – default value CommFlag.NONE
- class Group(registry, ref, name=None, group_type=<object object>, paradigm=Paradigm.NONE, group_flags=GroupFlag.NONE, members=<object object>)[source]¶
Bases:
_NamedRefDefinition
Groups of type COMM_GROUP may be constructed from a sequence of either ranks or location objects as members argument. All other group types must be constructed using a sequence of their respective Definition objects. The members property is always a sequence of Definition objects, even when the Group is constructed using a sequence of ranks.
- Parameters:
name (str) – required argument
group_type (otf2.GroupType) – required argument
paradigm (otf2.Paradigm) – default value Paradigm.NONE
group_flags (otf2.GroupFlag) – default value GroupFlag.NONE
members (builtins.tuple) – required argument
- class InterComm(registry, ref, name=None, *args, **kwargs)[source]¶
Bases:
Comm
- Parameters:
name (str) – required argument
group (otf2.definitions.Group) – required argument
parent (otf2.definitions.InterComm) – default value None
flags (otf2.CommFlag) – default value CommFlag.NONE
groupA (otf2.definitions.Group) – required argument
groupB (otf2.definitions.Group) – required argument
parent – default value None
flags – default value CommFlag.NONE
- class InterruptGenerator(registry, ref, name=None, *args, **kwargs)[source]¶
Bases:
_NamedRefDefinition
- Parameters:
name (str) – required argument
interrupt_generator_mode (otf2.InterruptGeneratorMode) – default value InterruptGeneratorMode.TIME
base (otf2.Base) – default value Base.DECIMAL
exponent (builtins.int) – default value 0
period (builtins.int) – required argument
- class IoDirectory(registry, ref, name=None, *args, **kwargs)[source]¶
Bases:
IoFile
- Parameters:
name (str) – required argument
scope (otf2.definitions.SystemTreeNode) – required argument
- class IoFile(registry, ref, name=None, *args, **kwargs)[source]¶
Bases:
_NamedRefDefinition
Abstract base class for
IoRegularFile
andIoDirectory
definitions.- Parameters:
name (str) – required argument
- class IoFileProperty(registry, arg0, arg1, type_id=None, value=None)[source]¶
Bases:
_PropertyDefinition
- Parameters:
io_file (otf2.definitions.IoFile) – required argument
name (str) – required argument
type (otf2.Type) – The type is inferred from the current value and should not be provided by the user.
value (value_type) – required argument
- class IoHandle(registry, ref, name=None, *args, **kwargs)[source]¶
Bases:
_NamedRefDefinition
- Parameters:
name (str) – required argument
file (otf2.definitions.IoFile) – required argument
io_paradigm (otf2.definitions.IoParadigm) – required argument
io_handle_flags (otf2.IoHandleFlag) – default value IoHandleFlag.NONE
comm (otf2.definitions.Comm) – default value None
parent (otf2.definitions.IoHandle) – default value None
- class IoParadigm(registry, ref, identification, name, io_paradigm_class, io_paradigm_flags, properties=None)[source]¶
Bases:
_RefDefinition
- Parameters:
identification (str) – required argument
name (str) – required argument
io_paradigm_class (otf2.IoParadigmClass) – default value IoParadigmClass.SERIAL
io_paradigm_flags (otf2.IoParadigmFlag) – default value IoParadigmFlag.NONE
- class IoPreCreatedHandleState(registry, *args, **kwargs)[source]¶
Bases:
_Definition
- Parameters:
io_handle (otf2.definitions.IoHandle) – required argument
io_access_mode (otf2.IoAccessMode) – required argument
io_status_flags (otf2.IoStatusFlag) – default value IoStatusFlag.NONE
- class IoRegularFile(registry, ref, name=None, *args, **kwargs)[source]¶
Bases:
IoFile
- Parameters:
name (str) – required argument
scope (otf2.definitions.SystemTreeNode) – required argument
- class Location(registry, ref, name=None, *args, **kwargs)[source]¶
Bases:
_NamedRefDefinition
Note
The number of events is managed automatically when writing traces. Do not use the attribute when writing.
- Parameters:
name (str) – required argument
type (otf2.LocationType) – default value LocationType.CPU_THREAD
number_of_events (builtins.int) – default value 0
group (otf2.definitions.LocationGroup) – required argument
- class LocationGroup(registry, ref, name=None, *args, **kwargs)[source]¶
Bases:
_NamedRefDefinition
- Parameters:
name (str) – required argument
location_group_type (otf2.LocationGroupType) – default value LocationGroupType.PROCESS
system_tree_parent (otf2.definitions.SystemTreeNode) – required argument
creating_location_group (otf2.definitions.LocationGroup) – default value None
- class LocationGroupProperty(registry, arg0, arg1, type_id=None, value=None)[source]¶
Bases:
_PropertyDefinition
- Parameters:
location_group (otf2.definitions.LocationGroup) – required argument
name (str) – required argument
type (otf2.Type) – The type is inferred from the current value and should not be provided by the user.
value (value_type) – required argument
- class LocationProperty(registry, arg0, arg1, type_id=None, value=None)[source]¶
Bases:
_PropertyDefinition
- Parameters:
location (otf2.definitions.Location) – required argument
name (str) – required argument
type (otf2.Type) – The type is inferred from the current value and should not be provided by the user.
value (value_type) – required argument
- class Metric(registry, ref, *args, **kwargs)[source]¶
Bases:
_RefDefinition
Abstract base class for
MetricClass
andMetricInstance
definitions.
- class MetricClass(registry, ref, *args, **kwargs)[source]¶
Bases:
Metric
- Parameters:
members (builtins.tuple) – required argument
occurrence (otf2.MetricOccurrence) – default value MetricOccurrence.ASYNCHRONOUS
recorder_kind (otf2.RecorderKind) – default value RecorderKind.UNKNOWN
- class MetricClassRecorder(registry, *args, **kwargs)[source]¶
Bases:
_Definition
- Parameters:
metric_class (otf2.definitions.MetricClass) – required argument
recorder (otf2.definitions.Location) – required argument
- class MetricInstance(registry, ref, metric_class, recorder, metric_scope=None, scope=None)[source]¶
Bases:
Metric
Note
The metric_scope is always computed based on the type of the current scope. Do not explicitly provide that argument.
- Parameters:
metric_class (otf2.definitions.MetricClass) – required argument
recorder (otf2.definitions.Location) – required argument
metric_scope (otf2.MetricScope) – default value None
scope (otf2.definitions._RefDefinition) – required argument
- class MetricMember(registry, ref, name=None, *args, **kwargs)[source]¶
Bases:
_NamedRefDefinition
- Parameters:
name (str) – required argument
description (str) – default value ‘’
metric_type (otf2.MetricType) – default value MetricType.OTHER
metric_mode (otf2.MetricMode) – default value MetricMode.ABSOLUTE_POINT
value_type (otf2.Type) – default value Type.DOUBLE
base (otf2.Base) – default value Base.DECIMAL
exponent (builtins.int) – default value 0
unit (str) – default value ‘’
- class Paradigm(registry, *args, **kwargs)[source]¶
Bases:
_Definition
Note
This definition has no reference. It describes an enum.
- Parameters:
paradigm (otf2.Paradigm) – required argument
name (str) – required argument
paradigm_class (otf2.ParadigmClass) – required argument
- class ParadigmProperty(registry, arg0, arg1, type_id=None, value=None)[source]¶
Bases:
_PropertyDefinition
Warning
Does not refer to a
otf2.definitions.Paradigm
, butotf2.Paradigm
!- Parameters:
paradigm (otf2.Paradigm) – required argument
property (otf2.ParadigmProperty) – required argument
type (otf2.Type) – The type is inferred from the current value and should not be provided by the user.
value (value_type) – required argument
- class Parameter(registry, ref, name=None, *args, **kwargs)[source]¶
Bases:
_NamedRefDefinition
- Parameters:
name (str) – required argument
parameter_type (otf2.ParameterType) – default value ParameterType.STRING
- class Region(registry, ref, name=None, canonical_name=None, *args, **kwargs)[source]¶
Bases:
_NamedRefDefinition
- Parameters:
name (str) – required argument
canonical_name (str) – default value None
description (str) – default value ‘’
region_role (otf2.RegionRole) – default value RegionRole.FUNCTION
paradigm (otf2.Paradigm) – default value Paradigm.NONE
region_flags (otf2.RegionFlag) – default value RegionFlag.NONE
source_file (str) – default value None
begin_line_number (builtins.int) – default value 0
end_line_number (builtins.int) – default value 0
- class RmaWin(registry, ref, name=None, *args, **kwargs)[source]¶
Bases:
_NamedRefDefinition
- Parameters:
name (str) – required argument
comm (otf2.definitions.Comm) – required argument
flags (otf2.RmaWinFlag) – default value RmaWinFlag.NONE
- class SourceCodeLocation(registry, ref, *args, **kwargs)[source]¶
Bases:
_RefDefinition
- Parameters:
file (str) – required argument
line_number (builtins.int) – default value 0
- class String(registry, ref, *args, **kwargs)[source]¶
Bases:
_RefDefinition
- Parameters:
name (builtins.str) – required argument
- class SystemTreeNode(registry, ref, name=None, *args, **kwargs)[source]¶
Bases:
_NamedRefDefinition
Note
The root of the tree should have the parent None
- Parameters:
name (str) – required argument
class_name (str) – default value ‘’
parent (otf2.definitions.SystemTreeNode) – default value None
- class SystemTreeNodeDomain(registry, *args, **kwargs)[source]¶
Bases:
_Definition
- Parameters:
system_tree_node (otf2.definitions.SystemTreeNode) – required argument
system_tree_node_domain (otf2.SystemTreeDomain) – required argument
- class SystemTreeNodeProperty(registry, arg0, arg1, type_id=None, value=None)[source]¶
Bases:
_PropertyDefinition
- Parameters:
system_tree_node (otf2.definitions.SystemTreeNode) – required argument
name (str) – required argument
type (otf2.Type) – The type is inferred from the current value and should not be provided by the user.
value (value_type) – required argument
enums¶
- class CartPeriodicity[source]¶
Bases:
EnumBase
,c_ubyte
- FALSE = CartPeriodicity.FALSE¶
- TRUE = CartPeriodicity.TRUE¶
- class CollectiveOp[source]¶
Bases:
EnumBase
,c_ubyte
- ALLGATHER = CollectiveOp.ALLGATHER¶
- ALLGATHERV = CollectiveOp.ALLGATHERV¶
- ALLOCATE = CollectiveOp.ALLOCATE¶
- ALLREDUCE = CollectiveOp.ALLREDUCE¶
- ALLTOALL = CollectiveOp.ALLTOALL¶
- ALLTOALLV = CollectiveOp.ALLTOALLV¶
- ALLTOALLW = CollectiveOp.ALLTOALLW¶
- BARRIER = CollectiveOp.BARRIER¶
- BCAST = CollectiveOp.BCAST¶
- CREATE_HANDLE = CollectiveOp.CREATE_HANDLE¶
- CREATE_HANDLE_AND_ALLOCATE = CollectiveOp.CREATE_HANDLE_AND_ALLOCATE¶
- DEALLOCATE = CollectiveOp.DEALLOCATE¶
- DESTROY_HANDLE = CollectiveOp.DESTROY_HANDLE¶
- DESTROY_HANDLE_AND_DEALLOCATE = CollectiveOp.DESTROY_HANDLE_AND_DEALLOCATE¶
- EXSCAN = CollectiveOp.EXSCAN¶
- GATHER = CollectiveOp.GATHER¶
- GATHERV = CollectiveOp.GATHERV¶
- REDUCE = CollectiveOp.REDUCE¶
- REDUCE_SCATTER = CollectiveOp.REDUCE_SCATTER¶
- REDUCE_SCATTER_BLOCK = CollectiveOp.REDUCE_SCATTER_BLOCK¶
- SCAN = CollectiveOp.SCAN¶
- SCATTER = CollectiveOp.SCATTER¶
- SCATTERV = CollectiveOp.SCATTERV¶
- class CollectiveRoot[source]¶
Bases:
EnumBase
,c_uint
- NONE = CollectiveRoot.NONE¶
- SELF = CollectiveRoot.SELF¶
- THIS_GROUP = CollectiveRoot.THIS_GROUP¶
- class CommFlag[source]¶
Bases:
EnumBitset
,c_uint
- CREATE_DESTROY_EVENTS = CommFlag.CREATE_DESTROY_EVENTS¶
- NONE = CommFlag.NONE¶
- class Compression[source]¶
Bases:
EnumBase
,c_ubyte
- NONE = Compression.NONE¶
- UNDEFINED = Compression.UNDEFINED¶
- ZLIB = Compression.ZLIB¶
- class FileMode[source]¶
Bases:
EnumBase
,c_ubyte
- MODIFY = FileMode.MODIFY¶
- READ = FileMode.READ¶
- WRITE = FileMode.WRITE¶
- class FileSubstrate[source]¶
Bases:
EnumBase
,c_ubyte
- NONE = FileSubstrate.NONE¶
- POSIX = FileSubstrate.POSIX¶
- SION = FileSubstrate.SION¶
- UNDEFINED = FileSubstrate.UNDEFINED¶
- class FileType[source]¶
Bases:
EnumBase
,c_ubyte
- ANCHOR = FileType.ANCHOR¶
- EVENTS = FileType.EVENTS¶
- GLOBAL_DEFS = FileType.GLOBAL_DEFS¶
- LOCAL_DEFS = FileType.LOCAL_DEFS¶
- MARKER = FileType.MARKER¶
- SIONRANKMAP = FileType.SIONRANKMAP¶
- SNAPSHOTS = FileType.SNAPSHOTS¶
- THUMBNAIL = FileType.THUMBNAIL¶
- class FlushType[source]¶
Bases:
EnumBase
,c_ubyte
- FLUSH = FlushType.FLUSH¶
- NO_FLUSH = FlushType.NO_FLUSH¶
- class GroupFlag[source]¶
Bases:
EnumBitset
,c_uint
- GLOBAL_MEMBERS = GroupFlag.GLOBAL_MEMBERS¶
- NONE = GroupFlag.NONE¶
- class GroupType[source]¶
Bases:
EnumBase
,c_ubyte
- COMM_GROUP = GroupType.COMM_GROUP¶
- COMM_LOCATIONS = GroupType.COMM_LOCATIONS¶
- COMM_SELF = GroupType.COMM_SELF¶
- LOCATIONS = GroupType.LOCATIONS¶
- METRIC = GroupType.METRIC¶
- REGIONS = GroupType.REGIONS¶
- UNKNOWN = GroupType.UNKNOWN¶
- class InterruptGeneratorMode[source]¶
Bases:
EnumBase
,c_ubyte
- COUNT = InterruptGeneratorMode.COUNT¶
- TIME = InterruptGeneratorMode.TIME¶
- class IoAccessMode[source]¶
Bases:
EnumBase
,c_ubyte
- EXECUTE_ONLY = IoAccessMode.EXECUTE_ONLY¶
- READ_ONLY = IoAccessMode.READ_ONLY¶
- READ_WRITE = IoAccessMode.READ_WRITE¶
- SEARCH_ONLY = IoAccessMode.SEARCH_ONLY¶
- WRITE_ONLY = IoAccessMode.WRITE_ONLY¶
- class IoCreationFlag[source]¶
Bases:
EnumBitset
,c_uint
- CREATE = IoCreationFlag.CREATE¶
- DIRECTORY = IoCreationFlag.DIRECTORY¶
- EXCLUSIVE = IoCreationFlag.EXCLUSIVE¶
- LARGEFILE = IoCreationFlag.LARGEFILE¶
- NONE = IoCreationFlag.NONE¶
- NO_CONTROLLING_TERMINAL = IoCreationFlag.NO_CONTROLLING_TERMINAL¶
- NO_FOLLOW = IoCreationFlag.NO_FOLLOW¶
- NO_SEEK = IoCreationFlag.NO_SEEK¶
- PATH = IoCreationFlag.PATH¶
- TEMPORARY_FILE = IoCreationFlag.TEMPORARY_FILE¶
- TRUNCATE = IoCreationFlag.TRUNCATE¶
- UNIQUE = IoCreationFlag.UNIQUE¶
- class IoHandleFlag[source]¶
Bases:
EnumBitset
,c_uint
- ALL_PROXY = IoHandleFlag.ALL_PROXY¶
- NONE = IoHandleFlag.NONE¶
- PRE_CREATED = IoHandleFlag.PRE_CREATED¶
- class IoOperationFlag[source]¶
Bases:
EnumBitset
,c_uint
- COLLECTIVE = IoOperationFlag.COLLECTIVE¶
- NONE = IoOperationFlag.NONE¶
- NON_BLOCKING = IoOperationFlag.NON_BLOCKING¶
- class IoOperationMode[source]¶
Bases:
EnumBase
,c_ubyte
- FLUSH = IoOperationMode.FLUSH¶
- READ = IoOperationMode.READ¶
- WRITE = IoOperationMode.WRITE¶
- class IoParadigmClass[source]¶
Bases:
EnumBase
,c_ubyte
- PARALLEL = IoParadigmClass.PARALLEL¶
- SERIAL = IoParadigmClass.SERIAL¶
- class IoParadigmFlag[source]¶
Bases:
EnumBitset
,c_uint
- NONE = IoParadigmFlag.NONE¶
- OS = IoParadigmFlag.OS¶
- class IoSeekOption[source]¶
Bases:
EnumBase
,c_ubyte
- DATA = IoSeekOption.DATA¶
- FROM_CURRENT = IoSeekOption.FROM_CURRENT¶
- FROM_END = IoSeekOption.FROM_END¶
- FROM_START = IoSeekOption.FROM_START¶
- HOLE = IoSeekOption.HOLE¶
- class IoStatusFlag[source]¶
Bases:
EnumBitset
,c_uint
- APPEND = IoStatusFlag.APPEND¶
- ASYNC = IoStatusFlag.ASYNC¶
- AVOID_CACHING = IoStatusFlag.AVOID_CACHING¶
- CLOSE_ON_EXEC = IoStatusFlag.CLOSE_ON_EXEC¶
- DATA_SYNC = IoStatusFlag.DATA_SYNC¶
- DELETE_ON_CLOSE = IoStatusFlag.DELETE_ON_CLOSE¶
- NONE = IoStatusFlag.NONE¶
- NON_BLOCKING = IoStatusFlag.NON_BLOCKING¶
- NO_ACCESS_TIME = IoStatusFlag.NO_ACCESS_TIME¶
- SYNC = IoStatusFlag.SYNC¶
- class LocationGroupType[source]¶
Bases:
EnumBase
,c_ubyte
- ACCELERATOR = LocationGroupType.ACCELERATOR¶
- PROCESS = LocationGroupType.PROCESS¶
- UNKNOWN = LocationGroupType.UNKNOWN¶
- class LocationType[source]¶
Bases:
EnumBase
,c_ubyte
- ACCELERATOR_STREAM = LocationType.GPU¶
- CPU_THREAD = LocationType.CPU_THREAD¶
- GPU = LocationType.GPU¶
- METRIC = LocationType.METRIC¶
- UNKNOWN = LocationType.UNKNOWN¶
- class LockType[source]¶
Bases:
EnumBase
,c_ubyte
- EXCLUSIVE = LockType.EXCLUSIVE¶
- SHARED = LockType.SHARED¶
- class MappingType[source]¶
Bases:
EnumBase
,c_ubyte
- ATTRIBUTE = MappingType.ATTRIBUTE¶
- CALLING_CONTEXT = MappingType.CALLING_CONTEXT¶
- COMM = MappingType.COMM¶
- GROUP = MappingType.GROUP¶
- INTERRUPT_GENERATOR = MappingType.INTERRUPT_GENERATOR¶
- IO_FILE = MappingType.IO_FILE¶
- IO_HANDLE = MappingType.IO_HANDLE¶
- LOCATION = MappingType.LOCATION¶
- LOCATION_GROUP = MappingType.LOCATION_GROUP¶
- METRIC = MappingType.METRIC¶
- PARAMETER = MappingType.PARAMETER¶
- REGION = MappingType.REGION¶
- RMA_WIN = MappingType.RMA_WIN¶
- SOURCE_CODE_LOCATION = MappingType.SOURCE_CODE_LOCATION¶
- STRING = MappingType.STRING¶
- class MeasurementMode[source]¶
Bases:
EnumBase
,c_ubyte
- OFF = MeasurementMode.OFF¶
- ON = MeasurementMode.ON¶
- class MetricMode[source]¶
Bases:
EnumBase
,c_ubyte
- ABSOLUTE_LAST = MetricMode.ABSOLUTE_LAST¶
- ABSOLUTE_NEXT = MetricMode.ABSOLUTE_NEXT¶
- ABSOLUTE_POINT = MetricMode.ABSOLUTE_POINT¶
- ACCUMULATED_LAST = MetricMode.ACCUMULATED_LAST¶
- ACCUMULATED_NEXT = MetricMode.ACCUMULATED_NEXT¶
- ACCUMULATED_POINT = MetricMode.ACCUMULATED_POINT¶
- ACCUMULATED_START = MetricMode.ACCUMULATED_START¶
- RELATIVE_LAST = MetricMode.RELATIVE_LAST¶
- RELATIVE_NEXT = MetricMode.RELATIVE_NEXT¶
- RELATIVE_POINT = MetricMode.RELATIVE_POINT¶
- class MetricOccurrence[source]¶
Bases:
EnumBase
,c_ubyte
- ASYNCHRONOUS = MetricOccurrence.ASYNCHRONOUS¶
- SYNCHRONOUS = MetricOccurrence.SYNCHRONOUS¶
- SYNCHRONOUS_STRICT = MetricOccurrence.SYNCHRONOUS_STRICT¶
- class MetricScope[source]¶
Bases:
EnumBase
,c_ubyte
- GROUP = MetricScope.GROUP¶
- LOCATION = MetricScope.LOCATION¶
- LOCATION_GROUP = MetricScope.LOCATION_GROUP¶
- SYSTEM_TREE_NODE = MetricScope.SYSTEM_TREE_NODE¶
- class MetricTiming[source]¶
Bases:
EnumBase
,c_ubyte
- LAST = MetricTiming.LAST¶
- NEXT = MetricTiming.NEXT¶
- POINT = MetricTiming.POINT¶
- START = MetricTiming.START¶
- class MetricType[source]¶
Bases:
EnumBase
,c_ubyte
- OTHER = MetricType.OTHER¶
- PAPI = MetricType.PAPI¶
- RUSAGE = MetricType.RUSAGE¶
- USER = MetricType.USER¶
- class MetricValueProperty[source]¶
Bases:
EnumBase
,c_ubyte
- ABSOLUTE = MetricValueProperty.ABSOLUTE¶
- ACCUMULATED = MetricValueProperty.ACCUMULATED¶
- RELATIVE = MetricValueProperty.RELATIVE¶
- class Paradigm[source]¶
Bases:
EnumBase
,c_ubyte
- ACETHREAD = Paradigm.ACETHREAD¶
- COMPILER = Paradigm.COMPILER¶
- CUDA = Paradigm.CUDA¶
- GASPI = Paradigm.GASPI¶
- HARDWARE = Paradigm.HARDWARE¶
- HIP = Paradigm.HIP¶
- HMPP = Paradigm.HMPP¶
- KOKKOS = Paradigm.KOKKOS¶
- MEASUREMENT_SYSTEM = Paradigm.MEASUREMENT_SYSTEM¶
- MPI = Paradigm.MPI¶
- MTAPI = Paradigm.MTAPI¶
- NONE = Paradigm.NONE¶
- OMPSS = Paradigm.OMPSS¶
- OPENACC = Paradigm.OPENACC¶
- OPENCL = Paradigm.OPENCL¶
- OPENMP = Paradigm.OPENMP¶
- OPENMP_TARGET = Paradigm.OPENMP_TARGET¶
- PTHREAD = Paradigm.PTHREAD¶
- QTTHREAD = Paradigm.QTTHREAD¶
- SAMPLING = Paradigm.SAMPLING¶
- SHMEM = Paradigm.SHMEM¶
- TBBTHREAD = Paradigm.TBBTHREAD¶
- UNKNOWN = Paradigm.UNKNOWN¶
- UPC = Paradigm.UPC¶
- USER = Paradigm.USER¶
- WINTHREAD = Paradigm.WINTHREAD¶
- class ParadigmClass[source]¶
Bases:
EnumBase
,c_ubyte
- ACCELERATOR = ParadigmClass.ACCELERATOR¶
- PROCESS = ParadigmClass.PROCESS¶
- THREAD_CREATE_WAIT = ParadigmClass.THREAD_CREATE_WAIT¶
- THREAD_FORK_JOIN = ParadigmClass.THREAD_FORK_JOIN¶
- class ParadigmProperty[source]¶
Bases:
EnumBase
,c_ubyte
- COMM_NAME_TEMPLATE = ParadigmProperty.COMM_NAME_TEMPLATE¶
- RMA_ONLY = ParadigmProperty.RMA_ONLY¶
- RMA_WIN_NAME_TEMPLATE = ParadigmProperty.RMA_WIN_NAME_TEMPLATE¶
- class ParameterType[source]¶
Bases:
EnumBase
,c_ubyte
- INT64 = ParameterType.INT64¶
- STRING = ParameterType.STRING¶
- UINT64 = ParameterType.UINT64¶
- class RecorderKind[source]¶
Bases:
EnumBase
,c_ubyte
- ABSTRACT = RecorderKind.ABSTRACT¶
- CPU = RecorderKind.CPU¶
- GPU = RecorderKind.GPU¶
- UNKNOWN = RecorderKind.UNKNOWN¶
- class RegionFlag[source]¶
Bases:
EnumBitset
,c_uint
- DYNAMIC = RegionFlag.DYNAMIC¶
- NONE = RegionFlag.NONE¶
- PHASE = RegionFlag.PHASE¶
- class RegionRole[source]¶
Bases:
EnumBase
,c_ubyte
- ALLOCATE = RegionRole.ALLOCATE¶
- ARTIFICIAL = RegionRole.ARTIFICIAL¶
- ATOMIC = RegionRole.ATOMIC¶
- BARRIER = RegionRole.BARRIER¶
- CANCEL = RegionRole.CANCEL¶
- CODE = RegionRole.CODE¶
- COLL_ALL2ALL = RegionRole.COLL_ALL2ALL¶
- COLL_ALL2ONE = RegionRole.COLL_ALL2ONE¶
- COLL_ONE2ALL = RegionRole.COLL_ONE2ALL¶
- COLL_OTHER = RegionRole.COLL_OTHER¶
- CRITICAL = RegionRole.CRITICAL¶
- CRITICAL_SBLOCK = RegionRole.CRITICAL_SBLOCK¶
- DATA_TRANSFER = RegionRole.DATA_TRANSFER¶
- DEALLOCATE = RegionRole.DEALLOCATE¶
- FILE_IO = RegionRole.FILE_IO¶
- FILE_IO_METADATA = RegionRole.FILE_IO_METADATA¶
- FLUSH = RegionRole.FLUSH¶
- FUNCTION = RegionRole.FUNCTION¶
- IMPLICIT_BARRIER = RegionRole.IMPLICIT_BARRIER¶
- KERNEL = RegionRole.KERNEL¶
- LOOP = RegionRole.LOOP¶
- MASTER = RegionRole.MASTER¶
- ORDERED = RegionRole.ORDERED¶
- ORDERED_SBLOCK = RegionRole.ORDERED_SBLOCK¶
- PARALLEL = RegionRole.PARALLEL¶
- POINT2POINT = RegionRole.POINT2POINT¶
- REALLOCATE = RegionRole.REALLOCATE¶
- RMA = RegionRole.RMA¶
- SECTION = RegionRole.SECTION¶
- SECTIONS = RegionRole.SECTIONS¶
- SINGLE = RegionRole.SINGLE¶
- SINGLE_SBLOCK = RegionRole.SINGLE_SBLOCK¶
- TASK = RegionRole.TASK¶
- TASK_CREATE = RegionRole.TASK_CREATE¶
- TASK_UNTIED = RegionRole.TASK_UNTIED¶
- TASK_WAIT = RegionRole.TASK_WAIT¶
- THREAD_CREATE = RegionRole.THREAD_CREATE¶
- THREAD_WAIT = RegionRole.THREAD_WAIT¶
- UNKNOWN = RegionRole.UNKNOWN¶
- WORKSHARE = RegionRole.WORKSHARE¶
- WRAPPER = RegionRole.WRAPPER¶
- class RmaAtomicType[source]¶
Bases:
EnumBase
,c_ubyte
- ACCUMULATE = RmaAtomicType.ACCUMULATE¶
- COMPARE_AND_SWAP = RmaAtomicType.COMPARE_AND_SWAP¶
- FETCH_AND_ACCUMULATE = RmaAtomicType.FETCH_AND_ACCUMULATE¶
- FETCH_AND_ADD = RmaAtomicType.FETCH_AND_ADD¶
- FETCH_AND_INCREMENT = RmaAtomicType.FETCH_AND_INCREMENT¶
- INCREMENT = RmaAtomicType.INCREMENT¶
- SWAP = RmaAtomicType.SWAP¶
- TEST_AND_SET = RmaAtomicType.TEST_AND_SET¶
- class RmaSyncLevel[source]¶
Bases:
EnumBitset
,c_uint
- MEMORY = RmaSyncLevel.MEMORY¶
- NONE = RmaSyncLevel.NONE¶
- PROCESS = RmaSyncLevel.PROCESS¶
- class RmaSyncType[source]¶
Bases:
EnumBase
,c_ubyte
- MEMORY = RmaSyncType.MEMORY¶
- NOTIFY_IN = RmaSyncType.NOTIFY_IN¶
- NOTIFY_OUT = RmaSyncType.NOTIFY_OUT¶
- class RmaWinFlag[source]¶
Bases:
EnumBitset
,c_uint
- CREATE_DESTROY_EVENTS = RmaWinFlag.CREATE_DESTROY_EVENTS¶
- NONE = RmaWinFlag.NONE¶
- class SystemTreeDomain[source]¶
Bases:
EnumBase
,c_ubyte
- ACCELERATOR_DEVICE = SystemTreeDomain.ACCELERATOR_DEVICE¶
- CACHE = SystemTreeDomain.CACHE¶
- CORE = SystemTreeDomain.CORE¶
- MACHINE = SystemTreeDomain.MACHINE¶
- NETWORKING_DEVICE = SystemTreeDomain.NETWORKING_DEVICE¶
- NUMA = SystemTreeDomain.NUMA¶
- PU = SystemTreeDomain.PU¶
- SHARED_MEMORY = SystemTreeDomain.SHARED_MEMORY¶
- SOCKET = SystemTreeDomain.SOCKET¶
- class ThumbnailType[source]¶
Bases:
EnumBase
,c_ubyte
- ATTRIBUTES = ThumbnailType.ATTRIBUTES¶
- COMM = ThumbnailType.COMM¶
- IO_HANDLE = ThumbnailType.IO_HANDLE¶
- METRIC = ThumbnailType.METRIC¶
- REGION = ThumbnailType.REGION¶
- RMA_WIN = ThumbnailType.RMA_WIN¶
- class Type[source]¶
Bases:
EnumBase
,c_ubyte
- ATTRIBUTE = Type.ATTRIBUTE¶
- CALLING_CONTEXT = Type.CALLING_CONTEXT¶
- COMM = Type.COMM¶
- DOUBLE = Type.DOUBLE¶
- FLOAT = Type.FLOAT¶
- GROUP = Type.GROUP¶
- INT16 = Type.INT16¶
- INT32 = Type.INT32¶
- INT64 = Type.INT64¶
- INT8 = Type.INT8¶
- INTERRUPT_GENERATOR = Type.INTERRUPT_GENERATOR¶
- IO_FILE = Type.IO_FILE¶
- IO_HANDLE = Type.IO_HANDLE¶
- LOCATION = Type.LOCATION¶
- LOCATION_GROUP = Type.LOCATION_GROUP¶
- METRIC = Type.METRIC¶
- NONE = Type.NONE¶
- PARAMETER = Type.PARAMETER¶
- REGION = Type.REGION¶
- RMA_WIN = Type.RMA_WIN¶
- SOURCE_CODE_LOCATION = Type.SOURCE_CODE_LOCATION¶
- STRING = Type.STRING¶
- UINT16 = Type.UINT16¶
- UINT32 = Type.UINT32¶
- UINT64 = Type.UINT64¶
- UINT8 = Type.UINT8¶
event_writer¶
- class EventWriter(archive, location)[source]¶
- buffer_flush(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.BufferFlush
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
stopTime (otf2.TimeStamp) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- calling_context_enter(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.CallingContextEnter
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
callingContext (otf2.definitions.CallingContext) –
unwindDistance (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- calling_context_leave(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.CallingContextLeave
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
callingContext (otf2.definitions.CallingContext) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- calling_context_sample(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.CallingContextSample
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
callingContext (otf2.definitions.CallingContext) –
unwindDistance (int) –
interruptGenerator (otf2.definitions.InterruptGenerator) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- comm_create(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.CommCreate
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
communicator (otf2.definitions.Comm) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- comm_destroy(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.CommDestroy
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
communicator (otf2.definitions.Comm) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- enter(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.Enter
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
region (otf2.definitions.Region) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- property handle¶
Gives access to the underlaying OTF2 event writer
- io_acquire_lock(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.IoAcquireLock
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
handle (otf2.definitions.IoHandle) –
lockType (otf2.LockType) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- io_change_status_flags(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.IoChangeStatusFlags
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
handle (otf2.definitions.IoHandle) –
statusFlags (otf2.IoStatusFlag) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- io_create_handle(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.IoCreateHandle
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
handle (otf2.definitions.IoHandle) –
mode (otf2.IoAccessMode) –
creationFlags (otf2.IoCreationFlag) –
statusFlags (otf2.IoStatusFlag) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- io_delete_file(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.IoDeleteFile
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
ioParadigm (otf2.definitions.IoParadigm) –
file (otf2.definitions.IoFile) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- io_destroy_handle(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.IoDestroyHandle
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
handle (otf2.definitions.IoHandle) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- io_duplicate_handle(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.IoDuplicateHandle
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
oldHandle (otf2.definitions.IoHandle) –
newHandle (otf2.definitions.IoHandle) –
statusFlags (otf2.IoStatusFlag) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- io_operation_begin(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.IoOperationBegin
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
handle (otf2.definitions.IoHandle) –
mode (otf2.IoOperationMode) –
operationFlags (otf2.IoOperationFlag) –
bytesRequest (int) –
matchingId (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- io_operation_cancelled(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.IoOperationCancelled
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
handle (otf2.definitions.IoHandle) –
matchingId (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- io_operation_complete(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.IoOperationComplete
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
handle (otf2.definitions.IoHandle) –
bytesResult (int) –
matchingId (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- io_operation_issued(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.IoOperationIssued
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
handle (otf2.definitions.IoHandle) –
matchingId (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- io_operation_test(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.IoOperationTest
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
handle (otf2.definitions.IoHandle) –
matchingId (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- io_release_lock(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.IoReleaseLock
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
handle (otf2.definitions.IoHandle) –
lockType (otf2.LockType) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- io_seek(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.IoSeek
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
handle (otf2.definitions.IoHandle) –
offsetRequest (int) –
whence (otf2.IoSeekOption) –
offsetResult (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- io_try_lock(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.IoTryLock
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
handle (otf2.definitions.IoHandle) –
lockType (otf2.LockType) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- leave(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.Leave
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
region (otf2.definitions.Region) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- measurement_on_off(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.MeasurementOnOff
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
measurementMode (otf2.MeasurementMode) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- metric(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.Metric
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
metric (otf2.definitions.Metric) – the
otf2.definitions.MetricClass
orotf2.definitions.MetricInstance
values (array) – an array of values, one for each
otf2.definitions.MetricMember
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- mpi_collective_begin(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.MpiCollectiveBegin
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- mpi_collective_end(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.MpiCollectiveEnd
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
collectiveOp (otf2.CollectiveOp) –
communicator (otf2.definitions.Comm) –
root (int) –
sizeSent (int) –
sizeReceived (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- mpi_irecv(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.MpiIrecv
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
sender (int) –
communicator (otf2.definitions.Comm) –
msgTag (int) –
msgLength (int) –
requestID (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- mpi_irecv_request(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.MpiIrecvRequest
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
requestID (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- mpi_isend(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.MpiIsend
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
receiver (int) –
communicator (otf2.definitions.Comm) –
msgTag (int) –
msgLength (int) –
requestID (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- mpi_isend_complete(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.MpiIsendComplete
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
requestID (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- mpi_recv(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.MpiRecv
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
sender (int) –
communicator (otf2.definitions.Comm) –
msgTag (int) –
msgLength (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- mpi_request_cancelled(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.MpiRequestCancelled
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
requestID (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- mpi_request_test(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.MpiRequestTest
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
requestID (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- mpi_send(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.MpiSend
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
receiver (int) –
communicator (otf2.definitions.Comm) –
msgTag (int) –
msgLength (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- non_blocking_collective_complete(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.NonBlockingCollectiveComplete
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
collectiveOp (otf2.CollectiveOp) –
communicator (otf2.definitions.Comm) –
root (int) –
sizeSent (int) –
sizeReceived (int) –
requestID (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- non_blocking_collective_request(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.NonBlockingCollectiveRequest
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
requestID (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- omp_acquire_lock(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.OmpAcquireLock
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
lockID (int) –
acquisitionOrder (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- omp_fork(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.OmpFork
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
numberOfRequestedThreads (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- omp_join(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.OmpJoin
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- omp_release_lock(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.OmpReleaseLock
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
lockID (int) –
acquisitionOrder (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- omp_task_complete(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.OmpTaskComplete
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
taskID (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- omp_task_create(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.OmpTaskCreate
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
taskID (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- omp_task_switch(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.OmpTaskSwitch
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
taskID (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- parameter_int(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.ParameterInt
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
parameter (otf2.definitions.Parameter) –
value (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- parameter_string(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.ParameterString
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
parameter (otf2.definitions.Parameter) –
string (otf2.definitions.String) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- parameter_unsigned_int(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.ParameterUnsignedInt
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
parameter (otf2.definitions.Parameter) –
value (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- program_begin(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.ProgramBegin
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
programName (otf2.definitions.String) –
programArguments (array) – an array of program arguments
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- program_end(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.ProgramEnd
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
exitStatus (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- rma_acquire_lock(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.RmaAcquireLock
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
win (otf2.definitions.RmaWin) –
remote (int) –
lockId (int) –
lockType (otf2.LockType) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- rma_atomic(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.RmaAtomic
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
win (otf2.definitions.RmaWin) –
remote (int) –
type (otf2.RmaAtomicType) –
bytesSent (int) –
bytesReceived (int) –
matchingId (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- rma_collective_begin(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.RmaCollectiveBegin
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- rma_collective_end(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.RmaCollectiveEnd
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
collectiveOp (otf2.CollectiveOp) –
syncLevel (otf2.RmaSyncLevel) –
win (otf2.definitions.RmaWin) –
root (int) –
bytesSent (int) –
bytesReceived (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- rma_get(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.RmaGet
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
win (otf2.definitions.RmaWin) –
remote (int) –
bytes (int) –
matchingId (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- rma_group_sync(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.RmaGroupSync
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
syncLevel (otf2.RmaSyncLevel) –
win (otf2.definitions.RmaWin) –
group (otf2.definitions.Group) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- rma_op_complete_blocking(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.RmaOpCompleteBlocking
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
win (otf2.definitions.RmaWin) –
matchingId (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- rma_op_complete_non_blocking(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.RmaOpCompleteNonBlocking
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
win (otf2.definitions.RmaWin) –
matchingId (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- rma_op_complete_remote(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.RmaOpCompleteRemote
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
win (otf2.definitions.RmaWin) –
matchingId (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- rma_op_test(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.RmaOpTest
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
win (otf2.definitions.RmaWin) –
matchingId (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- rma_put(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.RmaPut
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
win (otf2.definitions.RmaWin) –
remote (int) –
bytes (int) –
matchingId (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- rma_release_lock(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.RmaReleaseLock
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
win (otf2.definitions.RmaWin) –
remote (int) –
lockId (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- rma_request_lock(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.RmaRequestLock
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
win (otf2.definitions.RmaWin) –
remote (int) –
lockId (int) –
lockType (otf2.LockType) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- rma_sync(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.RmaSync
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
win (otf2.definitions.RmaWin) –
remote (int) –
syncType (otf2.RmaSyncType) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- rma_try_lock(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.RmaTryLock
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
win (otf2.definitions.RmaWin) –
remote (int) –
lockId (int) –
lockType (otf2.LockType) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- rma_wait_change(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.RmaWaitChange
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
win (otf2.definitions.RmaWin) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- rma_win_create(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.RmaWinCreate
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
win (otf2.definitions.RmaWin) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- rma_win_destroy(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.RmaWinDestroy
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
win (otf2.definitions.RmaWin) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- thread_acquire_lock(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.ThreadAcquireLock
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
model (otf2.Paradigm) –
lockID (int) –
acquisitionOrder (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- thread_begin(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.ThreadBegin
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
threadContingent (otf2.definitions.Comm) –
sequenceCount (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- thread_create(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.ThreadCreate
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
threadContingent (otf2.definitions.Comm) –
sequenceCount (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- thread_end(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.ThreadEnd
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
threadContingent (otf2.definitions.Comm) –
sequenceCount (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- thread_fork(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.ThreadFork
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
model (otf2.Paradigm) –
numberOfRequestedThreads (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- thread_join(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.ThreadJoin
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
model (otf2.Paradigm) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- thread_release_lock(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.ThreadReleaseLock
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
model (otf2.Paradigm) –
lockID (int) –
acquisitionOrder (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- thread_task_complete(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.ThreadTaskComplete
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
threadTeam (otf2.definitions.Comm) –
creatingThread (int) –
generationNumber (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- thread_task_create(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.ThreadTaskCreate
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
threadTeam (otf2.definitions.Comm) –
creatingThread (int) –
generationNumber (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- thread_task_switch(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.ThreadTaskSwitch
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
threadTeam (otf2.definitions.Comm) –
creatingThread (int) –
generationNumber (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- thread_team_begin(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.ThreadTeamBegin
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
threadTeam (otf2.definitions.Comm) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- thread_team_end(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.ThreadTeamEnd
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
threadTeam (otf2.definitions.Comm) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
- thread_wait(time, *args, **kwargs)[source]¶
Writes a new
otf2.events.ThreadWait
event to the corresponding location of the writer.- Parameters:
time (int) – the timestamp
threadContingent (otf2.definitions.Comm) –
sequenceCount (int) –
attributes (dict) – a dict with an
otf2.definitions.Attribute
referencing a suitable value.
events¶
- class BufferFlush(time, stop_time, attributes=None)[source]¶
Bases:
_Event
This event signals that the internal buffer was flushed at the given time.
- class CallingContextEnter(time, calling_context, unwind_distance, attributes=None)[source]¶
Bases:
_Event
The thread entered an instrumented region, represented by the referenced
CallingContext
. In contrast to theEnter
event, it gives the full calling context through theCallingContext
tree.Events based on the
CallingContext
definition are mutually exclusive with theEnter
/Leave
events in a trace.If no callback for this event is set but a callback for
Enter
events is defined, the reader will automatically generate anEnter
callback call for theRegion
referenced by theCallingContext
attribute of this event. Note that this emulation does not re-create the full calling context! It only re-creates the event order for instrumented regions.
- class CallingContextLeave(time, calling_context, attributes=None)[source]¶
Bases:
_Event
The thread left an instrumented region, represented by the referenced
CallingContext
. In contrast to theLeave
event, it gives the full calling context through theCallingContext
tree.The unwind distance for this
CallingContext
is defined to be 1. Because it must be assumed that the instrumented region made progress since the previousCallingContext
event.Events based on the
CallingContext
definition are mutually exclusive with theEnter
/Leave
events in a trace.The parent of the
CallingContext
must be used as the previous calling context for the next event.If no callback for this event is set but a callback for
Leave
events is defined, the reader will automatically generate anLeave
callback call for theRegion
referenced by theCallingContext
attribute of this event. Note that this emulation does not re-create the full calling context! It only re-creates the event order for instrumented regions.
- class CallingContextSample(time, calling_context, unwind_distance, interrupt_generator, attributes=None)[source]¶
Bases:
_Event
The thread was interrupted to take a sample of its current state (region and source code location).
Events based on the
CallingContext
definition are mutually exclusive with theEnter
/Leave
events in a trace.
- class CommCreate(time, communicator, attributes=None)[source]¶
Bases:
_Event
A @e CommCreate record denotes the creation of a communicator. Only valid if the
Comm
definition was flagged withOTF2_COMM_FLAG_CREATE_DESTROY_EVENTS
. This event must be enclosed by anMpiCollectiveBegin
andMpiCollectiveEnd
orNonBlockingCollectiveRequest
andNonBlockingCollectiveComplete
event pair withOTF2_COLLECTIVE_OP_CREATE_HANDLE
as the operation type.
- class CommDestroy(time, communicator, attributes=None)[source]¶
Bases:
_Event
A @e CommDestroy record marks the communicator for destruction at the end of the enclosing
MpiCollectiveBegin
andMpiCollectiveEnd
event pair. Only valid if theComm
definition was flagged withOTF2_COMM_FLAG_CREATE_DESTROY_EVENTS
. This event must be enclosed by anMpiCollectiveBegin
andMpiCollectiveEnd
event pair withOTF2_COLLECTIVE_OP_DESTROY_HANDLE
as the operation type.
- class Enter(time, region, attributes=None)[source]¶
Bases:
_Event
An @e Enter record indicates that the program enters a code region.
- class IoAcquireLock(time, handle, lock_type, attributes=None)[source]¶
Bases:
_Event
An @e IoAcquireLock record marks the acquisition of an I/O lock.
- class IoChangeStatusFlags(time, handle, status_flags, attributes=None)[source]¶
Bases:
_Event
An @e IoChangeStatusFlags record marks a change to the status flags associated with an @emph{active} I/O handle.
- class IoCreateHandle(time, handle, mode, creation_flags, status_flags, attributes=None)[source]¶
Bases:
_Event
An @e IoCreateHandle record marks the creation of a new @emph{active} I/O handle that can be used by subsequent I/O operation events.
An
IoHandle
is @emph{active} between a pair of consecutiveIoCreateHandle
andIoDestroyHandle
events. AllLocation`s of a :py:class:`LocationGroup
have access to an @emph{active}IoHandle
.If the
Comm
attribute of theIoHandle
handle is notOTF2_UNDEFINED_COMM
, this is a collective operation overComm
.
- class IoDeleteFile(time, io_paradigm, file, attributes=None)[source]¶
Bases:
_Event
An @e IoDeleteFile record marks the deletion of an I/O file.
- class IoDestroyHandle(time, handle, attributes=None)[source]¶
Bases:
_Event
An @e IoDestroyHandle record marks the end of an @emph{active} I/O handle’s lifetime.
An
IoHandle
is @emph{active} between a pair of consecutiveIoCreateHandle
andIoDestroyHandle
events. AllLocation`s of a :py:class:`LocationGroup
have access to an @emph{active}IoHandle
.If the
Comm
attribute of theIoHandle
handle is notOTF2_UNDEFINED_COMM
, this is a collective operation overComm
.
- class IoDuplicateHandle(time, old_handle, new_handle, status_flags, attributes=None)[source]¶
Bases:
_Event
An @e IoDuplicateHandle record marks the duplication of an already existing @emph{active} I/O handle.
The new I/O handle @p newHandle is @emph{active} after this event.
Both
IoHandle`s must reference the same :py:class:`Comm
definition or beOTF2_UNDEFINED_COMM
. If theComm
attribute of theIoHandle
handles is notOTF2_UNDEFINED_COMM
, this is a collective operation overComm
.
- class IoOperationBegin(time, handle, mode, operation_flags, bytes_request, matching_id, attributes=None)[source]¶
Bases:
_Event
An @e IoOperationBegin record marks the begin of a file operation (read, write, etc.).
See @ref otf2_io_operation_event_order for the possible event orders.
- class IoOperationCancelled(time, handle, matching_id, attributes=None)[source]¶
Bases:
_Event
An @e IoOperationCancelled record marks the successful cancellation of a non-blocking operation (read, write, etc.) on an @emph{active} I/O handle.
See @ref otf2_io_operation_event_order for the possible event orders.
- class IoOperationComplete(time, handle, bytes_result, matching_id, attributes=None)[source]¶
Bases:
_Event
An @e IoOperationComplete record marks the end of a file operation (read, write, etc.) on an @emph{active} I/O handle.
See @ref otf2_io_operation_event_order for the possible event orders.
- class IoOperationIssued(time, handle, matching_id, attributes=None)[source]¶
Bases:
_Event
An @e IoOperationIssued record marks the successful initiation of a non-blocking operation (read, write, etc.) on an @emph{active} I/O handle.
See @ref otf2_io_operation_event_order for the possible event orders.
- class IoOperationTest(time, handle, matching_id, attributes=None)[source]¶
Bases:
_Event
An @e IoOperationTest record marks an unsuccessful test whether an I/O operation has already finished.
See @ref otf2_io_operation_event_order for the possible event orders.
- class IoReleaseLock(time, handle, lock_type, attributes=None)[source]¶
Bases:
_Event
An @e IoReleaseLock record marks the release of an I/O lock.
- class IoSeek(time, handle, offset_request, whence, offset_result, attributes=None)[source]¶
Bases:
_Event
An @e IoSeek record marks a change of the position, e.g., within a file.
- class IoTryLock(time, handle, lock_type, attributes=None)[source]¶
Bases:
_Event
An @e IoTryLock record marks when an I/O lock was requested but not granted.
- class Leave(time, region, attributes=None)[source]¶
Bases:
_Event
A @e Leave record indicates that the program leaves a code region.
- class MeasurementOnOff(time, measurement_mode, attributes=None)[source]¶
Bases:
_Event
This event signals where the measurement system turned measurement on or off.
- class Metric(time, metric, values, attributes=None)[source]¶
Bases:
_Event
This event represents a measurement point.
- class MpiCollectiveBegin(time, attributes=None)[source]¶
Bases:
_Event
An @e MpiCollectiveBegin record marks the begin of an MPI collective operation (MPI_GATHER, MPI_SCATTER etc.).
- class MpiCollectiveEnd(time, collective_op, communicator, root, size_sent, size_received, attributes=None)[source]¶
Bases:
_Event
An @e MpiCollectiveEnd record marks the end of an MPI collective operation (MPI_GATHER, MPI_SCATTER etc.). It keeps the necessary information for this event: type of collective operation, communicator, the root of this collective operation. You can optionally add further information like sent and received bytes.
- class MpiIrecv(time, sender, communicator, msg_tag, msg_length, request_id, attributes=None)[source]¶
Bases:
_Event
An @e MpiIrecv record indicates the completion of a non-blocking MPI receive operation completed (MPI_IRECV). It keeps the necessary information for this event: sender of the message, communicator, and the message tag. You can optionally add further information like the message length (size of the receive buffer).
- class MpiIrecvRequest(time, request_id, attributes=None)[source]¶
Bases:
_Event
An @e MpiIrecvRequest record indicates that a non-blocking MPI receive operation was initiated (MPI_IRECV).
- class MpiIsend(time, receiver, communicator, msg_tag, msg_length, request_id, attributes=None)[source]¶
Bases:
_Event
An @e MpiIsend record indicates that a non-blocking MPI send operation was initiated (MPI_ISEND). It keeps the necessary information for this event: receiver of the message, communicator, and the message tag. You can optionally add further information like the message length (size of the send buffer).
- class MpiIsendComplete(time, request_id, attributes=None)[source]¶
Bases:
_Event
An @e MpiIsendComplete record indicates the completion of a non-blocking MPI send operation. In the case where the send request is released before it is completed by MPI, this record will only indicate the release, as it becomes impossible to track the completion of the send operation afterwards. This case may be identified by the surrounding events.
- class MpiRecv(time, sender, communicator, msg_tag, msg_length, attributes=None)[source]¶
Bases:
_Event
An @e MpiRecv record indicates that an MPI message was received (MPI_RECV). It keeps the necessary information for this event: sender of the message, communicator, and the message tag. You can optionally add further information like the message length (size of the receive buffer).
- class MpiRequestCancelled(time, request_id, attributes=None)[source]¶
Bases:
_Event
This events appears if the program canceled a request.
- class MpiRequestTest(time, request_id, attributes=None)[source]¶
Bases:
_Event
This events appears if the program tests if a request has already completed but the test failed.
- class MpiSend(time, receiver, communicator, msg_tag, msg_length, attributes=None)[source]¶
Bases:
_Event
An @e MpiSend record indicates that an MPI send operation was initiated (MPI_SEND). It keeps the necessary information for this event: receiver of the message, communicator, and the message tag. You can optionally add further information like the message length (size of the send buffer).
- class NonBlockingCollectiveComplete(time, collective_op, communicator, root, size_sent, size_received, request_id, attributes=None)[source]¶
Bases:
_Event
A @e NonBlockingCollectiveComplete record indicates that a non-blocking collective operation completed.
- class NonBlockingCollectiveRequest(time, request_id, attributes=None)[source]¶
Bases:
_Event
A @e NonBlockingCollectiveRequest record indicates that a non-blocking collective operation was initiated.
- class OmpAcquireLock(time, lock_id, acquisition_order, attributes=None)[source]¶
Bases:
_Event
An @e OmpAcquireLock record marks that a thread acquires an OpenMP lock.
This event record is superseded by the
ThreadAcquireLock
event record and should not be used when theThreadAcquireLock
event record is in use.
- class OmpFork(time, number_of_requested_threads, attributes=None)[source]¶
Bases:
_Event
An @e OmpFork record marks that an OpenMP Thread forks a thread team.
This event record is superseded by the
ThreadFork
event record and should not be used when theThreadFork
event record is in use.
- class OmpJoin(time, attributes=None)[source]¶
Bases:
_Event
An @e OmpJoin record marks that a team of threads is joint and only the master thread continues execution.
This event record is superseded by the
ThreadJoin
event record and should not be used when theThreadJoin
event record is in use.
- class OmpReleaseLock(time, lock_id, acquisition_order, attributes=None)[source]¶
Bases:
_Event
An @e OmpReleaseLock record marks that a thread releases an OpenMP lock.
This event record is superseded by the
ThreadReleaseLock
event record and should not be used when theThreadReleaseLock
event record is in use.
- class OmpTaskComplete(time, task_id, attributes=None)[source]¶
Bases:
_Event
An @e OmpTaskComplete record indicates that the execution of an OpenMP task has finished.
This event record is superseded by the
ThreadTaskComplete
event record and should not be used when theThreadTaskComplete
event record is in use.
- class OmpTaskCreate(time, task_id, attributes=None)[source]¶
Bases:
_Event
An @e OmpTaskCreate record marks that an OpenMP Task was/will be created in the current region.
This event record is superseded by the
ThreadTaskCreate
event record and should not be used when theThreadTaskCreate
event record is in use.
- class OmpTaskSwitch(time, task_id, attributes=None)[source]¶
Bases:
_Event
An @e OmpTaskSwitch record indicates that the execution of the current task will be suspended and another task starts/restarts its execution. Please note that this may change the current call stack of the executing location.
This event record is superseded by the
ThreadTaskSwitch
event record and should not be used when theThreadTaskSwitch
event record is in use.
- class ParameterInt(time, parameter, value, attributes=None)[source]¶
Bases:
_Event
A @e ParameterInt record marks that in the current region, the specified integer parameter has the specified value.
- class ParameterString(time, parameter, string, attributes=None)[source]¶
Bases:
_Event
A ParameterString record marks that in the current region, the specified string parameter has the specified value.
- class ParameterUnsignedInt(time, parameter, value, attributes=None)[source]¶
Bases:
_Event
A @e ParameterUnsignedInt record marks that in the current region, the specified unsigned integer parameter has the specified value.
- class ProgramBegin(time, program_name, program_arguments, attributes=None)[source]¶
Bases:
_Event
The ProgramBegin record marks the begin of the program.
This event is restricted to happen at most once on any
Location
in aLocationGroup
that is of typeOTF2_LOCATION_GROUP_TYPE_PROCESS
.If there is a ProgramBegin record, a corresponding
ProgramEnd
record on anyLocation
in the sameLocationGroup
is mandatory and vice versa.None of the timestamps recorded within the same
LocationGroup
must be smaller than ProgramBegin’s timestamp.
- class ProgramEnd(time, exit_status, attributes=None)[source]¶
Bases:
_Event
The @e ProgramEnd record marks the end of the program.
This event is restricted to happen at most once on any
Location
in aLocationGroup
that is of typeOTF2_LOCATION_GROUP_TYPE_PROCESS
.If there is a ProgramEnd record, a corresponding
ProgramBegin
record on anyLocation
in the sameLocationGroup
is mandatory, and vice versa.None of the timestamps recorded within the same
LocationGroup
must be larger than ProgramEnd’s timestamp.
- class RmaAcquireLock(time, win, remote, lock_id, lock_type, attributes=None)[source]¶
Bases:
_Event
An @e RmaAcquireLock record denotes the time a lock was acquired by the process.
- class RmaAtomic(time, win, remote, type, bytes_sent, bytes_received, matching_id, attributes=None)[source]¶
Bases:
_Event
An @e RmaAtomic record denotes the time an atomic RMA operation was issued.
- class RmaCollectiveBegin(time, attributes=None)[source]¶
Bases:
_Event
An @e RmaCollectiveBegin record denotes the beginning of a collective RMA operation.
- class RmaCollectiveEnd(time, collective_op, sync_level, win, root, bytes_sent, bytes_received, attributes=None)[source]¶
Bases:
_Event
An @e RmaCollectiveEnd record denotes the end of a collective RMA operation.
- class RmaGet(time, win, remote, bytes, matching_id, attributes=None)[source]¶
Bases:
_Event
An @e RmaGet record denotes the time a get operation was issued.
- class RmaGroupSync(time, sync_level, win, group, attributes=None)[source]¶
Bases:
_Event
An @e RmaGroupSync record denotes the synchronization with a subgroup of processes on an RMA window.
- class RmaOpCompleteBlocking(time, win, matching_id, attributes=None)[source]¶
Bases:
_Event
An @e RmaOpCompleteBlocking record denotes the local completion of a blocking RMA operation.
- class RmaOpCompleteNonBlocking(time, win, matching_id, attributes=None)[source]¶
Bases:
_Event
An @e RmaOpCompleteNonBlocking record denotes the local completion of a non-blocking RMA operation.
- class RmaOpCompleteRemote(time, win, matching_id, attributes=None)[source]¶
Bases:
_Event
An @e RmaOpCompleteRemote record denotes the remote completion of an RMA operation.
- class RmaOpTest(time, win, matching_id, attributes=None)[source]¶
Bases:
_Event
An @e RmaOpTest record denotes that a non-blocking RMA operation has been tested for completion unsuccessfully.
- class RmaPut(time, win, remote, bytes, matching_id, attributes=None)[source]¶
Bases:
_Event
An @e RmaPut record denotes the time a put operation was issued.
- class RmaReleaseLock(time, win, remote, lock_id, attributes=None)[source]¶
Bases:
_Event
An @e RmaReleaseLock record denotes the time the lock was released.
- class RmaRequestLock(time, win, remote, lock_id, lock_type, attributes=None)[source]¶
Bases:
_Event
An @e RmaRequestLock record denotes the time a lock was requested and with it the earliest time it could have been granted. It is used to mark (possibly) non-blocking lock request, as defined by the MPI standard.
- class RmaSync(time, win, remote, sync_type, attributes=None)[source]¶
Bases:
_Event
An @e RmaSync record denotes the direct synchronization with a possibly remote process.
- class RmaTryLock(time, win, remote, lock_id, lock_type, attributes=None)[source]¶
Bases:
_Event
An @e RmaTryLock record denotes the time of an unsuccessful attempt to acquire the lock.
- class RmaWaitChange(time, win, attributes=None)[source]¶
Bases:
_Event
An @e RmaWaitChange record denotes the change of a window that was waited for.
- class RmaWinCreate(time, win, attributes=None)[source]¶
Bases:
_Event
An @e RmaWinCreate record denotes the creation of an RMA window. Only valid if the
RmaWin
definition was flagged withOTF2_RMA_WIN_FLAG_CREATE_DESTROY_EVENTS
. This event can be enclosed by anRmaCollectiveBegin
andRmaCollectiveEnd
event pair either withOTF2_COLLECTIVE_OP_CREATE_HANDLE
orOTF2_COLLECTIVE_OP_CREATE_HANDLE_AND_ALLOCATE
as the operation type.
- class RmaWinDestroy(time, win, attributes=None)[source]¶
Bases:
_Event
An @e RmaWinDestroy record denotes the destruction of an RMA window. Only valid if the
RmaWin
definition was flagged withOTF2_RMA_WIN_FLAG_CREATE_DESTROY_EVENTS
. This event can be enclosed by anRmaCollectiveBegin
andRmaCollectiveEnd
event pair either withOTF2_COLLECTIVE_OP_DESTROY_HANDLE
orOTF2_COLLECTIVE_OP_DESTROY_HANDLE_AND_DEALLOCATE
as the operation type. In this case the RMA window is only marked for destruction, which will happen with theRmaCollectiveEnd
event.
- class ThreadAcquireLock(time, model, lock_id, acquisition_order, attributes=None)[source]¶
Bases:
_Event
A @e ThreadAcquireLock record marks that a thread acquires a lock.
- class ThreadBegin(time, thread_contingent, sequence_count, attributes=None)[source]¶
Bases:
_Event
Marks the begin of a thread created by another thread.
- class ThreadCreate(time, thread_contingent, sequence_count, attributes=None)[source]¶
Bases:
_Event
The location created successfully a new thread.
- class ThreadEnd(time, thread_contingent, sequence_count, attributes=None)[source]¶
Bases:
_Event
Marks the end of a thread.
- class ThreadFork(time, model, number_of_requested_threads, attributes=None)[source]¶
Bases:
_Event
A @e ThreadFork record marks that a thread forks a thread team.
- class ThreadJoin(time, model, attributes=None)[source]¶
Bases:
_Event
A @e ThreadJoin record marks that a team of threads is joint and only the master thread continues execution.
- class ThreadReleaseLock(time, model, lock_id, acquisition_order, attributes=None)[source]¶
Bases:
_Event
A @e ThreadReleaseLock record marks that a thread releases a lock.
- class ThreadTaskComplete(time, thread_team, creating_thread, generation_number, attributes=None)[source]¶
Bases:
_Event
A @e ThreadTaskComplete record indicates that the execution of an OpenMP task has finished.
- class ThreadTaskCreate(time, thread_team, creating_thread, generation_number, attributes=None)[source]¶
Bases:
_Event
A @e ThreadTaskCreate record marks that a task in was/will be created and will be processed by the specified thread team.
- class ThreadTaskSwitch(time, thread_team, creating_thread, generation_number, attributes=None)[source]¶
Bases:
_Event
A @e ThreadTaskSwitch record indicates that the execution of the current task will be suspended and another task starts/restarts its execution. Please note that this may change the current call stack of the executing location.
- class ThreadTeamBegin(time, thread_team, attributes=None)[source]¶
Bases:
_Event
The current location enters the specified thread team.
reader¶
- class Reader(anchor_file_path, batch_events=100, collective_callbacks=None, collective_data=None, global_comm_context=None, local_comm_context=None)[source]¶
Bases:
object
This class is used to read existing traces
- Parameters:
anchor_file_path (str) – the path to the anchor file (mostly ‘some/path/trace.otf2’)
batch_events (int) – the number of events, which are batched while reading the events from the trace (default: 100)
- property definitions¶
Returns a
otf2.registry.DefinitionRegistry
object representing all definitions in the trace.
- property events¶
Returns an iterable object representing all events in the opened trace.
Example:
for location, event in trace.events(location_foo): print("Encountered event at {}".format(event.time))
- Parameters:
locations (Iterable) – all locations, for which events will be read, (None means for every location)
- property handle¶
Returns the handle to the underlaying OTF2 Reader.
- property timer_resolution¶
Returns the resolution of the timer of the read trace
- open(*args, **kwargs)[source]¶
Returns a
otf2.reader.Reader
object usable within awith
statement.- Parameters:
anchor_file_path (str) – the path to the anchor file (mostly ‘some/path/trace.otf2’)
batch_events (int) – the number of events, which are batched while reading the events from the trace (default: 100)
registry¶
- class DefinitionRegistry[source]¶
Bases:
object
This class stores all definitions.
- attribute(*args, **kwargs)[source]¶
Returns the Attribute definition with matching arguments
- Parameters:
name (str) – required argument
description (str) – default value ‘’
type (otf2.Type) – default value Type.STRING
- property attributes¶
A
_Registry
instance representing all Attribute definitons.
- calling_context(*args, **kwargs)[source]¶
Returns the CallingContext definition with matching arguments
Note
Use None as parent to indicate that this is the topmost CallingContext
- Parameters:
region (otf2.definitions.Region) – required argument
source_code_location (otf2.definitions.SourceCodeLocation) – default value None
parent (otf2.definitions.CallingContext) – required argument
- property calling_context_properties¶
A
_Registry
instance representing all CallingContextProperty definitons.
- calling_context_property(*args, **kwargs)[source]¶
Returns the CallingContextProperty definition with matching arguments
- Parameters:
calling_context (otf2.definitions.CallingContext) – required argument
name (str) – required argument
type (otf2.Type) – The type is inferred from the current value and should not be provided by the user.
value (value_type) – required argument
- property calling_contexts¶
A
_Registry
instance representing all CallingContext definitons.
- callpath(*args, **kwargs)[source]¶
Returns the Callpath definition with matching arguments
Note
Use None as parent to indicate that this is the topmost region in the Callpath.
- Parameters:
parent (otf2.definitions.Callpath) – required argument
region (otf2.definitions.Region) – required argument
- callpath_parameter(*args, **kwargs)[source]¶
Returns the CallpathParameter definition with matching arguments
- Parameters:
callpath (otf2.definitions.Callpath) – required argument
parameter (otf2.definitions.Parameter) – required argument
type (otf2.Type) – The type is inferred from the current value and should not be provided by the user.
value (value_type) – required argument
- property callpath_parameters¶
A
_Registry
instance representing all CallpathParameter definitons.
- property callpaths¶
A
_Registry
instance representing all Callpath definitons.
- callsite(*args, **kwargs)[source]¶
Returns the Callsite definition with matching arguments
- Parameters:
source_file (str) – default value None
line_number (builtins.int) – default value 0
entered_region (otf2.definitions.Region) – required argument
left_region (otf2.definitions.Region) – required argument
- property callsites¶
A
_Registry
instance representing all Callsite definitons.
- cart_coordinate(*args, **kwargs)[source]¶
Returns the CartCoordinate definition with matching arguments
Note
Coordinates is a tuple of integers.
- Parameters:
topology (otf2.definitions.CartTopology) – required argument
rank (builtins.int) – required argument
coordinates (builtins.tuple) – required argument
- property cart_coordinates¶
A
_Registry
instance representing all CartCoordinate definitons.
- cart_dimension(*args, **kwargs)[source]¶
Returns the CartDimension definition with matching arguments
- Parameters:
name (str) – required argument
size (builtins.int) – required argument
cart_periodicity (otf2.CartPeriodicity) – default value CartPeriodicity.FALSE
- property cart_dimensions¶
A
_Registry
instance representing all CartDimension definitons.
- property cart_topologies¶
A
_Registry
instance representing all CartTopology definitons.
- cart_topology(*args, **kwargs)[source]¶
Returns the CartTopology definition with matching arguments
Note
Dimensions is a tuple of
otf2.definitions.CartDimension
.- Parameters:
name (str) – required argument
communicator (otf2.definitions.Comm) – required argument
dimensions (builtins.tuple) – required argument
- comm(*args, **kwargs)[source]¶
Returns the Comm definition with matching arguments
- Parameters:
name (str) – required argument
group (otf2.definitions.Group) – required argument
parent (otf2.definitions.Comm) – default value None
flags (otf2.CommFlag) – default value CommFlag.NONE
- property comms¶
A
_Registry
instance representing all Comm definitons.
- group(*args, **kwargs)[source]¶
Returns the Group definition with matching arguments
Groups of type COMM_GROUP may be constructed from a sequence of either ranks or location objects as members argument. All other group types must be constructed using a sequence of their respective Definition objects. The members property is always a sequence of Definition objects, even when the Group is constructed using a sequence of ranks.
- Parameters:
name (str) – required argument
group_type (otf2.GroupType) – required argument
paradigm (otf2.Paradigm) – default value Paradigm.NONE
group_flags (otf2.GroupFlag) – default value GroupFlag.NONE
members (builtins.tuple) – required argument
- property groups¶
A
_Registry
instance representing all Group definitons.
- inter_comm(*args, **kwargs)[source]¶
Returns the InterComm definition with matching arguments
- Parameters:
name (str) – required argument
group (otf2.definitions.Group) – required argument
parent (otf2.definitions.InterComm) – default value None
flags (otf2.CommFlag) – default value CommFlag.NONE
groupA (otf2.definitions.Group) – required argument
groupB (otf2.definitions.Group) – required argument
parent – default value None
flags – default value CommFlag.NONE
- interrupt_generator(*args, **kwargs)[source]¶
Returns the InterruptGenerator definition with matching arguments
- Parameters:
name (str) – required argument
interrupt_generator_mode (otf2.InterruptGeneratorMode) – default value InterruptGeneratorMode.TIME
base (otf2.Base) – default value Base.DECIMAL
exponent (builtins.int) – default value 0
period (builtins.int) – required argument
- property interrupt_generators¶
A
_Registry
instance representing all InterruptGenerator definitons.
- io_directory(*args, **kwargs)[source]¶
Returns the IoDirectory definition with matching arguments
- Parameters:
name (str) – required argument
scope (otf2.definitions.SystemTreeNode) – required argument
- property io_file_properties¶
A
_Registry
instance representing all IoFileProperty definitons.
- io_file_property(*args, **kwargs)[source]¶
Returns the IoFileProperty definition with matching arguments
- Parameters:
io_file (otf2.definitions.IoFile) – required argument
name (str) – required argument
type (otf2.Type) – The type is inferred from the current value and should not be provided by the user.
value (value_type) – required argument
- property io_files¶
A
_Registry
instance representing all IoFile definitons.
- io_handle(*args, **kwargs)[source]¶
Returns the IoHandle definition with matching arguments
- Parameters:
name (str) – required argument
file (otf2.definitions.IoFile) – required argument
io_paradigm (otf2.definitions.IoParadigm) – required argument
io_handle_flags (otf2.IoHandleFlag) – default value IoHandleFlag.NONE
comm (otf2.definitions.Comm) – default value None
parent (otf2.definitions.IoHandle) – default value None
- property io_handles¶
A
_Registry
instance representing all IoHandle definitons.
- io_paradigm(*args, **kwargs)[source]¶
Returns the IoParadigm definition with matching arguments
- Parameters:
identification (str) – required argument
name (str) – required argument
io_paradigm_class (otf2.IoParadigmClass) – default value IoParadigmClass.SERIAL
io_paradigm_flags (otf2.IoParadigmFlag) – default value IoParadigmFlag.NONE
- property io_paradigms¶
A
_Registry
instance representing all IoParadigm definitons.
- io_pre_created_handle_state(*args, **kwargs)[source]¶
Returns the IoPreCreatedHandleState definition with matching arguments
- Parameters:
io_handle (otf2.definitions.IoHandle) – required argument
io_access_mode (otf2.IoAccessMode) – required argument
io_status_flags (otf2.IoStatusFlag) – default value IoStatusFlag.NONE
- property io_pre_created_handle_states¶
A
_Registry
instance representing all IoPreCreatedHandleState definitons.
- io_regular_file(*args, **kwargs)[source]¶
Returns the IoRegularFile definition with matching arguments
- Parameters:
name (str) – required argument
scope (otf2.definitions.SystemTreeNode) – required argument
- location(*args, **kwargs)[source]¶
Returns the Location definition with matching arguments
Note
The number of events is managed automatically when writing traces. Do not use the attribute when writing.
- Parameters:
name (str) – required argument
type (otf2.LocationType) – default value LocationType.CPU_THREAD
number_of_events (builtins.int) – default value 0
group (otf2.definitions.LocationGroup) – required argument
- location_group(*args, **kwargs)[source]¶
Returns the LocationGroup definition with matching arguments
- Parameters:
name (str) – required argument
location_group_type (otf2.LocationGroupType) – default value LocationGroupType.PROCESS
system_tree_parent (otf2.definitions.SystemTreeNode) – required argument
creating_location_group (otf2.definitions.LocationGroup) – default value None
- property location_group_properties¶
A
_Registry
instance representing all LocationGroupProperty definitons.
- location_group_property(*args, **kwargs)[source]¶
Returns the LocationGroupProperty definition with matching arguments
- Parameters:
location_group (otf2.definitions.LocationGroup) – required argument
name (str) – required argument
type (otf2.Type) – The type is inferred from the current value and should not be provided by the user.
value (value_type) – required argument
- property location_groups¶
A
_Registry
instance representing all LocationGroup definitons.
- property location_properties¶
A
_Registry
instance representing all LocationProperty definitons.
- location_property(*args, **kwargs)[source]¶
Returns the LocationProperty definition with matching arguments
- Parameters:
location (otf2.definitions.Location) – required argument
name (str) – required argument
type (otf2.Type) – The type is inferred from the current value and should not be provided by the user.
value (value_type) – required argument
- property locations¶
A
_Registry
instance representing all Location definitons.
- metric(name, *args, **kwargs)[source]¶
A convenience method to create a magic metric. Details may change in future.
- Parameters:
name (str) – The name for the metric, required argument
- metric_class(*args, **kwargs)[source]¶
Returns the MetricClass definition with matching arguments
- Parameters:
members (builtins.tuple) – required argument
occurrence (otf2.MetricOccurrence) – default value MetricOccurrence.ASYNCHRONOUS
recorder_kind (otf2.RecorderKind) – default value RecorderKind.UNKNOWN
- metric_class_recorder(*args, **kwargs)[source]¶
Returns the MetricClassRecorder definition with matching arguments
- Parameters:
metric_class (otf2.definitions.MetricClass) – required argument
recorder (otf2.definitions.Location) – required argument
- property metric_class_recorders¶
A
_Registry
instance representing all MetricClassRecorder definitons.
- metric_instance(*args, **kwargs)[source]¶
Returns the MetricInstance definition with matching arguments
Note
The metric_scope is always computed based on the type of the current scope. Do not explicitly provide that argument.
- Parameters:
metric_class (otf2.definitions.MetricClass) – required argument
recorder (otf2.definitions.Location) – required argument
metric_scope (otf2.MetricScope) – default value None
scope (otf2.definitions._RefDefinition) – required argument
- metric_member(*args, **kwargs)[source]¶
Returns the MetricMember definition with matching arguments
- Parameters:
name (str) – required argument
description (str) – default value ‘’
metric_type (otf2.MetricType) – default value MetricType.OTHER
metric_mode (otf2.MetricMode) – default value MetricMode.ABSOLUTE_POINT
value_type (otf2.Type) – default value Type.DOUBLE
base (otf2.Base) – default value Base.DECIMAL
exponent (builtins.int) – default value 0
unit (str) – default value ‘’
- property metric_members¶
A
_Registry
instance representing all MetricMember definitons.
- property metrics¶
A
_Registry
instance representing all Metric definitons.
- paradigm(*args, **kwargs)[source]¶
Returns the Paradigm definition with matching arguments
Note
This definition has no reference. It describes an enum.
- Parameters:
paradigm (otf2.Paradigm) – required argument
name (str) – required argument
paradigm_class (otf2.ParadigmClass) – required argument
- property paradigm_properties¶
A
_Registry
instance representing all ParadigmProperty definitons.
- paradigm_property(*args, **kwargs)[source]¶
Returns the ParadigmProperty definition with matching arguments
Warning
Does not refer to a
otf2.definitions.Paradigm
, butotf2.Paradigm
!- Parameters:
paradigm (otf2.Paradigm) – required argument
property (otf2.ParadigmProperty) – required argument
type (otf2.Type) – The type is inferred from the current value and should not be provided by the user.
value (value_type) – required argument
- property paradigms¶
A
_Registry
instance representing all Paradigm definitons.
- parameter(*args, **kwargs)[source]¶
Returns the Parameter definition with matching arguments
- Parameters:
name (str) – required argument
parameter_type (otf2.ParameterType) – default value ParameterType.STRING
- property parameters¶
A
_Registry
instance representing all Parameter definitons.
- region(*args, **kwargs)[source]¶
Returns the Region definition with matching arguments
- Parameters:
name (str) – required argument
canonical_name (str) – default value None
description (str) – default value ‘’
region_role (otf2.RegionRole) – default value RegionRole.FUNCTION
paradigm (otf2.Paradigm) – default value Paradigm.NONE
region_flags (otf2.RegionFlag) – default value RegionFlag.NONE
source_file (str) – default value None
begin_line_number (builtins.int) – default value 0
end_line_number (builtins.int) – default value 0
- property regions¶
A
_Registry
instance representing all Region definitons.
- rma_win(*args, **kwargs)[source]¶
Returns the RmaWin definition with matching arguments
- Parameters:
name (str) – required argument
comm (otf2.definitions.Comm) – required argument
flags (otf2.RmaWinFlag) – default value RmaWinFlag.NONE
- property rma_wins¶
A
_Registry
instance representing all RmaWin definitons.
- source_code_location(*args, **kwargs)[source]¶
Returns the SourceCodeLocation definition with matching arguments
- Parameters:
file (str) – required argument
line_number (builtins.int) – default value 0
- property source_code_locations¶
A
_Registry
instance representing all SourceCodeLocation definitons.
- property strings¶
A
_Registry
instance representing all String definitons.
- system_tree_node(*args, **kwargs)[source]¶
Returns the SystemTreeNode definition with matching arguments
Note
The root of the tree should have the parent None
- Parameters:
name (str) – required argument
class_name (str) – default value ‘’
parent (otf2.definitions.SystemTreeNode) – default value None
- system_tree_node_domain(*args, **kwargs)[source]¶
Returns the SystemTreeNodeDomain definition with matching arguments
- Parameters:
system_tree_node (otf2.definitions.SystemTreeNode) – required argument
system_tree_node_domain (otf2.SystemTreeDomain) – required argument
- property system_tree_node_domains¶
A
_Registry
instance representing all SystemTreeNodeDomain definitons.
- property system_tree_node_properties¶
A
_Registry
instance representing all SystemTreeNodeProperty definitons.
- system_tree_node_property(*args, **kwargs)[source]¶
Returns the SystemTreeNodeProperty definition with matching arguments
- Parameters:
system_tree_node (otf2.definitions.SystemTreeNode) – required argument
name (str) – required argument
type (otf2.Type) – The type is inferred from the current value and should not be provided by the user.
value (value_type) – required argument
- property system_tree_nodes¶
A
_Registry
instance representing all SystemTreeNode definitons.
writer¶
- class Writer(archive_path, archive_name='traces', file_mode=FileMode.WRITE, chunk_size_events=1048576, chunk_size_definitions=4194304, file_substrate=FileSubstrate.POSIX, compression=Compression.NONE, pre_flush=<function _default_pre_flush>, post_flush=None, flush_data=None, collective_callbacks=None, collective_data=None, global_comm_context=None, local_comm_context=None, memory_callbacks=None, memory_data=None, timer_resolution=None, definitions=None)[source]¶
Bases:
object
This class is used to write a new trace file.
Warning
Parallel trace writing using collective callbacks is currently not supported.
- Parameters:
anchor_path (str) – the path to the trace root directory
archive_name (str) – the name of the trace archive (default: ‘traces’)
timer_resolution (int) – the resolution of the used timer (default: 1)
definitions (otf2.registry.DefinitionRegistry) – used to share definitions with other
otf2.writer.Writer
andotf2.reader.Reader
(default: None)
- property definitions¶
Provides access to the global trace definitions. In the parallel case, all calls to the definitions must be collective.
- Returns:
- event_writer(*args, **kwargs)[source]¶
Returns an
otf2.event_writer.EventWriter
for theotf2.definitions.Location
equivalent to the given arguments.Note
The number of events is managed automatically when writing traces. Do not use the attribute when writing.
- Parameters:
name (str) – required argument
type (otf2.LocationType) – default value LocationType.CPU_THREAD
number_of_events (builtins.int) – default value 0
group (otf2.definitions.LocationGroup) – required argument
- Returns:
- event_writer_from_location(location)[source]¶
Returns an
otf2.event_writer.EventWriter
for the givenotf2.definitions.Location
.- Parameters:
location (otf2.definitions.Location) – the location definition
- Returns:
- property handle¶
Returns the handle to the underlaying OTF2 Archive.
- property timer_resolution¶
Returns the resolution of the used timer
- open(*args, **kwargs)[source]¶
Returns a
otf2.reader.Reader
object usable within awith
statement.- Parameters:
anchor_path (str) – the path to the trace root directory
archive_name (str) – the name of the trace archive (default: “traces”)