Bases: otf2.definitions._RefDefinition
Parameters: | name (basestring) – required argument |
---|
Bases: otf2.definitions._Definition
Parameters: |
|
---|
Bases: otf2.definitions._NamedRefDefinition
Parameters: |
|
---|
Bases: otf2.definitions._NamedRefDefinition
Note
The root of the tree should have the parent None
Parameters: |
|
---|
Bases: otf2.definitions._NamedRefDefinition
Parameters: |
|
---|
Bases: otf2.definitions._NamedRefDefinition
Note
The number of events is managed automatically when writing traces. Do not use the attribute when writing.
Parameters: |
|
---|
Bases: otf2.definitions._NamedRefDefinition
Parameters: |
|
---|
Bases: otf2.definitions._RefDefinition
Parameters: |
|
---|
Bases: otf2.definitions._RefDefinition
Note
Use None as parent to indicate that this is the topmost region in the Callpath.
Parameters: |
|
---|
Bases: otf2.definitions._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: |
|
---|
Bases: otf2.definitions._NamedRefDefinition
Parameters: |
|
---|
Bases: otf2.definitions._RefDefinition
Abstract base class for MetricClass and MetricInstance definitions.
Bases: otf2.definitions.Metric
Parameters: |
|
---|
Bases: otf2.definitions.Metric
Note
The metric_scope is always computed based on the type of the current scope. Do not explicitly provide that argument.
Parameters: |
|
---|
Bases: otf2.definitions._NamedRefDefinition
Parameters: |
|
---|
Bases: otf2.definitions._NamedRefDefinition
Parameters: |
|
---|
Bases: otf2.definitions._NamedRefDefinition
Parameters: |
|
---|
Bases: otf2.definitions._Definition
Parameters: |
|
---|
Bases: otf2.definitions._PropertyDefinition
Parameters: |
|
---|
Bases: otf2.definitions._Definition
Parameters: |
|
---|
Bases: otf2.definitions._PropertyDefinition
Parameters: |
|
---|
Bases: otf2.definitions._PropertyDefinition
Parameters: |
|
---|
Bases: otf2.definitions._NamedRefDefinition
Parameters: |
|
---|
Bases: otf2.definitions._NamedRefDefinition
Note
Dimensions is a tuple of otf2.definitions.CartDimension.
Parameters: |
|
---|
Bases: otf2.definitions._Definition
Note
Coordinates is a tuple of integers.
Parameters: |
|
---|
Bases: otf2.definitions._RefDefinition
Parameters: |
|
---|
Bases: otf2.definitions._RefDefinition
Note
Use None as parent to indicate that this is the topmost CallingContext
Parameters: |
|
---|
Bases: otf2.definitions._PropertyDefinition
Parameters: |
|
---|
Bases: otf2.definitions._NamedRefDefinition
Parameters: |
|
---|
Bases: otf2.definitions._Definition
Note
This definition has no reference. It describes an enum.
Parameters: |
|
---|
Bases: otf2.definitions._PropertyDefinition
Warning
Does not refer to a otf2.definitions.Paradigm, but otf2.Paradigm!
Parameters: |
|
---|
Bases: otf2.definitions._NamedRefDefinition
Abstract base class for IoRegularFile and IoDirectory definitions.
Parameters: | name (str) – required argument |
---|
Bases: otf2.definitions.IoFile
Parameters: |
|
---|
Bases: otf2.definitions.IoFile
Parameters: |
|
---|
Bases: otf2.definitions._PropertyDefinition
Parameters: |
|
---|
Bases: otf2.definitions._RefDefinition
Parameters: |
|
---|
Bases: otf2.definitions._NamedRefDefinition
Parameters: |
|
---|
Bases: otf2.definitions._Definition
Parameters: |
|
---|
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBitset, ctypes.c_uint
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBitset, ctypes.c_uint
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBitset, ctypes.c_uint
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBitset, ctypes.c_uint
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBitset, ctypes.c_uint
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Bases: _otf2.Config.EnumBitset, ctypes.c_uint
Bases: _otf2.Config.EnumBitset, ctypes.c_uint
Bases: _otf2.Config.EnumBase, ctypes.c_ubyte
Writes a new otf2.events.BufferFlush event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.CallingContextEnter event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.CallingContextLeave event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.CallingContextSample event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.Enter event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.IoAcquireLock event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.IoChangeStatusFlags event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.IoCreateHandle event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.IoDeleteFile event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.IoDestroyHandle event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.IoDuplicateHandle event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.IoOperationBegin event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.IoOperationCancelled event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.IoOperationComplete event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.IoOperationIssued event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.IoOperationTest event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.IoReleaseLock event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.IoSeek event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.IoTryLock event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.Leave event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.MeasurementOnOff event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.Metric event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.MpiCollectiveBegin event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.MpiCollectiveEnd event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.MpiIrecv event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.MpiIrecvRequest event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.MpiIsend event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.MpiIsendComplete event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.MpiRecv event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.MpiRequestCancelled event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.MpiRequestTest event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.MpiSend event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.OmpAcquireLock event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.OmpFork event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.OmpJoin event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.OmpReleaseLock event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.OmpTaskComplete event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.OmpTaskCreate event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.OmpTaskSwitch event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.ParameterInt event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.ParameterString event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.ParameterUnsignedInt event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.ProgramBegin event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.ProgramEnd event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.RmaAcquireLock event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.RmaAtomic event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.RmaCollectiveBegin event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.RmaCollectiveEnd event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.RmaGet event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.RmaGroupSync event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.RmaOpCompleteBlocking event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.RmaOpCompleteNonBlocking event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.RmaOpCompleteRemote event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.RmaOpTest event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.RmaPut event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.RmaReleaseLock event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.RmaRequestLock event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.RmaSync event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.RmaTryLock event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.RmaWaitChange event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.RmaWinCreate event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.RmaWinDestroy event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.ThreadAcquireLock event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.ThreadBegin event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.ThreadCreate event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.ThreadEnd event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.ThreadFork event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.ThreadJoin event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.ThreadReleaseLock event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.ThreadTaskComplete event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.ThreadTaskCreate event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.ThreadTaskSwitch event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.ThreadTeamBegin event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.ThreadTeamEnd event to the corresponding location of the writer.
Parameters: |
|
---|
Writes a new otf2.events.ThreadWait event to the corresponding location of the writer.
Parameters: |
|
---|
Bases: otf2.events._Event
This event signals that the internal buffer was flushed at the given time.
Bases: otf2.events._Event
The thread entered an instrumented region, represented by the referenced CallingContext. In contrast to the Enter event, it gives the full calling context through the CallingContext tree.
Events based on the CallingContext definition are mutually exclusive with the Enter/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 an Enter callback call for the Region referenced by the CallingContext 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.
Bases: otf2.events._Event
The thread left an instrumented region, represented by the referenced CallingContext. In contrast to the Leave event, it gives the full calling context through the CallingContext 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 previous CallingContext event.
Events based on the CallingContext definition are mutually exclusive with the Enter/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 an Leave callback call for the Region referenced by the CallingContext 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.
Bases: otf2.events._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 the Enter/Leave events in a trace.
Bases: otf2.events._Event
An enter record indicates that the program enters a code region.
Bases: otf2.events._Event
An IoAcquireLock record marks the acquisition of an I/O lock.
Bases: otf2.events._Event
An IoChangeStatusFlags record marks a change to the status flags associated with an @emph{active} I/O handle.
Bases: otf2.events._Event
An 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 consecutive IoCreateHandle and IoDestroyHandle events. All Location`s of a :py:class:`LocationGroup have access to an @emph{active} IoHandle.
If the Comm attribute of the IoHandle handle is not OTF2_UNDEFINED_COMM, this is a collective operation over Comm.
Bases: otf2.events._Event
An IoDeleteFile record marks the deletion of an I/O file.
Bases: otf2.events._Event
An IoDestroyHandle record marks the end of an @emph{active} I/O handle’s lifetime.
An IoHandle is @emph{active} between a pair of consecutive IoCreateHandle and IoDestroyHandle events. All Location`s of a :py:class:`LocationGroup have access to an @emph{active} IoHandle.
If the Comm attribute of the IoHandle handle is not OTF2_UNDEFINED_COMM, this is a collective operation over Comm.
Bases: otf2.events._Event
An 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 be OTF2_UNDEFINED_COMM. If the Comm attribute of the IoHandle handles is not OTF2_UNDEFINED_COMM, this is a collective operation over Comm.
Bases: otf2.events._Event
An IoOperationBegin record marks the begin of a file operation (read, write, etc.).
See @ref otf2_io_operation_event_order for the possible event orders.
Bases: otf2.events._Event
An 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.
Bases: otf2.events._Event
An 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.
Bases: otf2.events._Event
An 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.
Bases: otf2.events._Event
An 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.
Bases: otf2.events._Event
An IoReleaseLock record marks the release of an I/O lock.
Bases: otf2.events._Event
An IoSeek record marks a change of the position, e.g., within a file.
Bases: otf2.events._Event
An IoTryLock record marks when an I/O lock was requested but not granted.
Bases: otf2.events._Event
A leave record indicates that the program leaves a code region.
Bases: otf2.events._Event
This event signals where the measurement system turned measurement on or off.
Bases: otf2.events._Event
This event represents a measurement point.
Bases: otf2.events._Event
A MpiCollectiveBegin record marks the begin of a MPI collective operation (MPI_GATHER, MPI_SCATTER etc.).
Bases: otf2.events._Event
A MpiCollectiveEnd record marks the end of a 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.
Bases: otf2.events._Event
A MpiIrecv record indicates that a MPI message was received (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).
Bases: otf2.events._Event
Signals the request of a receive, which can be completed later.
Bases: otf2.events._Event
A MpiIsend record indicates that a MPI message send process 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).
Bases: otf2.events._Event
Signals the completion of non-blocking send request.
Bases: otf2.events._Event
A MpiRecv record indicates that a 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).
Bases: otf2.events._Event
This events appears if the program canceled a request.
Bases: otf2.events._Event
This events appears if the program tests if a request has already completed but the test failed.
Bases: otf2.events._Event
A MpiSend record indicates that a MPI message send process 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).
Bases: otf2.events._Event
An 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 the ThreadAcquireLock event record is in use.
Bases: otf2.events._Event
An 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 the ThreadFork event record is in use.
Bases: otf2.events._Event
An 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 the ThreadJoin event record is in use.
Bases: otf2.events._Event
An 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 the ThreadReleaseLock event record is in use.
Bases: otf2.events._Event
An 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 the ThreadTaskComplete event record is in use.
Bases: otf2.events._Event
An 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 the ThreadTaskCreate event record is in use.
Bases: otf2.events._Event
An 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 the ThreadTaskSwitch event record is in use.
Bases: otf2.events._Event
A ParameterInt record marks that in the current region, the specified integer parameter has the specified value.
Bases: otf2.events._Event
A ParameterString record marks that in the current region, the specified string parameter has the specified value.
Bases: otf2.events._Event
A ParameterUnsignedInt record marks that in the current region, the specified unsigned integer parameter has the specified value.
Bases: otf2.events._Event
The ProgramBegin record marks the begin of the program.
This event is restricted to happen at most once on any Location in a LocationGroup that is of type OTF2_LOCATION_GROUP_TYPE_PROCESS.
If there is a ProgramBegin record, a corresponding ProgramEnd record on any Location in the same LocationGroup is mandatory and vice versa.
None of the timestamps recorded within the same LocationGroup must be smaller than ProgramBegin’s timestamp.
Bases: otf2.events._Event
The ProgramEnd record marks the end of the program.
This event is restricted to happen at most once on any Location in a LocationGroup that is of type OTF2_LOCATION_GROUP_TYPE_PROCESS.
If there is a ProgramEnd record, a corresponding ProgramBegin record on any Location in the same LocationGroup is mandatory, and vice versa.
None of the timestamps recorded within the same LocationGroup must be larger than ProgramEnd’s timestamp.
Bases: otf2.events._Event
A RmaAcquireLock record denotes the time a lock was acquired by the process.
Bases: otf2.events._Event
A RmaAtomic record denotes the time a atomic operation was issued.
Bases: otf2.events._Event
A RmaCollectiveBegin record denotes the beginning of a collective RMA operation.
Bases: otf2.events._Event
A RmaCollectiveEnd record denotes the end of a collective RMA operation.
Bases: otf2.events._Event
A RmaGet record denotes the time a get operation was issued.
Bases: otf2.events._Event
A RmaGroupSync record denotes the synchronization with a subgroup of processes on a window.
Bases: otf2.events._Event
A RmaOpCompleteBlocking record denotes the local completion of a blocking RMA operation.
Bases: otf2.events._Event
A RmaOpCompleteNonBlocking record denotes the local completion of a non-blocking RMA operation.
Bases: otf2.events._Event
A RmaOpCompleteRemote record denotes the remote completion of a RMA operation.
Bases: otf2.events._Event
A RmaOpTest record denotes that a non-blocking RMA operation has been tested for completion unsuccessfully.
Bases: otf2.events._Event
A RmaPut record denotes the time a put operation was issued.
Bases: otf2.events._Event
A RmaReleaseLock record denotes the time the lock was released.
Bases: otf2.events._Event
A 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.
Bases: otf2.events._Event
A RmaSync record denotes the direct synchronization with a possibly remote process.
Bases: otf2.events._Event
A RmaTryLock record denotes the time of an unsuccessful attempt to acquire the lock.
Bases: otf2.events._Event
A RmaWaitChange record denotes the change of a window that was waited for.
Bases: otf2.events._Event
A RmaWinCreate record denotes the creation of a RMA window.
Bases: otf2.events._Event
A RmaWinDestroy record denotes the destruction of a RMA window.
Bases: otf2.events._Event
A ThreadAcquireLock record marks that a thread acquires a lock.
Bases: otf2.events._Event
Marks the begin of a thread created by another thread.
Bases: otf2.events._Event
The location created successfully a new thread.
Bases: otf2.events._Event
Marks the end of a thread.
Bases: otf2.events._Event
A ThreadFork record marks that a thread forks a thread team.
Bases: otf2.events._Event
A ThreadJoin record marks that a team of threads is joint and only the master thread continues execution.
Bases: otf2.events._Event
A ThreadReleaseLock record marks that a thread releases a lock.
Bases: otf2.events._Event
A ThreadTaskComplete record indicates that the execution of an OpenMP task has finished.
Bases: otf2.events._Event
A ThreadTaskCreate record marks that a task in was/will be created and will be processed by the specified thread team.
Bases: otf2.events._Event
A 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.
Bases: otf2.events._Event
The current location enters the specified thread team.
Bases: object
This class is used to read existing traces
Parameters: |
|
---|
Returns a otf2.registry.DefinitionRegistry object representing all definitions in the trace.
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) |
---|
Returns a otf2.reader.Reader object usable within a with statement.
Parameters: |
|
---|
Bases: object
This class stores all definitions.
Returns the Attribute definition with matching arguments
Parameters: |
|
---|
Returns the CallingContext definition with matching arguments
Note
Use None as parent to indicate that this is the topmost CallingContext
Parameters: |
|
---|
A _Registry instance representing all CallingContextProperty definitons.
Returns the CallingContextProperty definition with matching arguments
Parameters: |
|
---|
Returns the Callpath definition with matching arguments
Note
Use None as parent to indicate that this is the topmost region in the Callpath.
Parameters: |
|
---|
Returns the Callsite definition with matching arguments
Parameters: |
|
---|
Returns the CartCoordinate definition with matching arguments
Note
Coordinates is a tuple of integers.
Parameters: |
|
---|
Returns the CartDimension definition with matching arguments
Parameters: |
|
---|
Returns the CartTopology definition with matching arguments
Note
Dimensions is a tuple of otf2.definitions.CartDimension.
Parameters: |
|
---|
Returns the Comm definition with matching arguments
Parameters: |
|
---|
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: |
|
---|
Returns the InterruptGenerator definition with matching arguments
Parameters: |
|
---|
Returns the IoDirectory definition with matching arguments
Parameters: |
|
---|
Returns the IoFileProperty definition with matching arguments
Parameters: |
|
---|
Returns the IoHandle definition with matching arguments
Parameters: |
|
---|
Returns the IoParadigm definition with matching arguments
Parameters: |
|
---|
Returns the IoPreCreatedHandleState definition with matching arguments
Parameters: |
|
---|
A _Registry instance representing all IoPreCreatedHandleState definitons.
Returns the IoRegularFile definition with matching arguments
Parameters: |
|
---|
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: |
|
---|
Returns the LocationGroup definition with matching arguments
Parameters: |
|
---|
A _Registry instance representing all LocationGroupProperty definitons.
Returns the LocationGroupProperty definition with matching arguments
Parameters: |
|
---|
Returns the LocationProperty definition with matching arguments
Parameters: |
|
---|
A convenience method to create a magic metric. Details may change in future.
Parameters: | name (str) – The name for the metric, required argument |
---|
Returns the MetricClass definition with matching arguments
Parameters: |
|
---|
Returns the MetricClassRecorder definition with matching arguments
Parameters: |
|
---|
A _Registry instance representing all MetricClassRecorder definitons.
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: |
|
---|
Returns the MetricMember definition with matching arguments
Parameters: |
|
---|
Returns the Paradigm definition with matching arguments
Note
This definition has no reference. It describes an enum.
Parameters: |
|
---|
Returns the ParadigmProperty definition with matching arguments
Warning
Does not refer to a otf2.definitions.Paradigm, but otf2.Paradigm!
Parameters: |
|
---|
Returns the Parameter definition with matching arguments
Parameters: |
|
---|
Returns the Region definition with matching arguments
Parameters: |
|
---|
Returns the RmaWin definition with matching arguments
Parameters: |
|
---|
Returns the SourceCodeLocation definition with matching arguments
Parameters: |
|
---|
Returns the SystemTreeNode definition with matching arguments
Note
The root of the tree should have the parent None
Parameters: |
|
---|
Returns the SystemTreeNodeDomain definition with matching arguments
Parameters: |
|
---|
A _Registry instance representing all SystemTreeNodeDomain definitons.
A _Registry instance representing all SystemTreeNodeProperty definitons.
Returns the SystemTreeNodeProperty definition with matching arguments
Parameters: |
|
---|
Bases: object
This class is used to write a new trace file.
Warning
Parallel trace writing using collective callbacks is currently not supported.
Parameters: |
|
---|
Provides access to the global trace definitions. In the parallel case, all calls to the definitions must be collective.
Returns: | otf2.registry.DefinitionRegistry |
---|
Returns an otf2.event_writer.EventWriter for the otf2.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: |
|
---|---|
Returns: |
Returns an otf2.event_writer.EventWriter for the given otf2.definitions.Location.
Parameters: | location (otf2.definitions.Location) – the location definition |
---|---|
Returns: | otf2.event_writer.EventWriter |
Returns a otf2.reader.Reader object usable within a with statement.
Parameters: |
|
---|