1.4 (revision 3771)
List of all snapshot records
OTF2 records

SnapshotStart
This record marks the start of a snapshot.

A snapshot consists of an timestamp and a set of snapshot records. All these snapshot records have the same snapshot time. A snapshot starts with one SnapshotStart record and closes with one SnapshotEnd record. All snapshot records inbetween are ordered by the origEventTime, which are also less than the snapshot timestamp. Ie. The timestamp of the next event read from the event stream is greater or equal to the snapshot time.

Attributes:
OTF2_LocationRef location The location of the snapshot.
OTF2_TimeStamp timestamp The snapshot time of this record.
uint64_t numberOfRecords Number of snapshot event records in this snapshot. Excluding the SnapshotEnd record.
See also:
OTF2_SnapWriter_SnapshotStart()
Since:
Version 1.2

SnapshotEnd
This record marks the end of a snapshot. It contains the position to continue reading in the event trace for this location. Use OTF2_EvtReader_Seek with contReadPos as the position.

Attributes:
OTF2_LocationRef location The location of the snapshot.
OTF2_TimeStamp timestamp The snapshot time of this record.
uint64_t contReadPos Position to continue reading in the event trace.
See also:
OTF2_SnapWriter_SnapshotEnd()
Since:
Version 1.2

MeasurementOnOffSnap
The last occurrence of an MeasurementOnOff event of this location, if any.

Attributes:
OTF2_LocationRef location The location of the snapshot.
OTF2_TimeStamp timestamp The snapshot time of this record.
OTF2_TimeStamp origEventTime The original time this event happended.
OTF2_MeasurementMode measurementMode Is the measurement turned on (OTF2_MEASUREMENT_ON) or off (OTF2_MEASUREMENT_OFF)?
See also:
MeasurementOnOff event
OTF2_SnapWriter_MeasurementOnOff()
Since:
Version 1.2

EnterSnap
This record exists for each Enter event where the corresponding Leave event did not occur before the snapshot.

Attributes:
OTF2_LocationRef location The location of the snapshot.
OTF2_TimeStamp timestamp The snapshot time of this record.
OTF2_TimeStamp origEventTime The original time this event happended.
OTF2_RegionRef region Needs to be defined in a definition record References a Region definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_REGION is available.
See also:
Enter event
OTF2_SnapWriter_Enter()
Since:
Version 1.2

MpiSendSnap
This record exists for each MpiSend event where the matching receive message event did not occur on the remote location before the snapshot. This could either be an MpiRecv or an MpiIrecv event. Note that it may so, that a previous MpiIsend with the same envelope than this one is neither completed not canceled yet, thus the matching receive may already occurred, but the matching couldn't be done yet.

Attributes:
OTF2_LocationRef location The location of the snapshot.
OTF2_TimeStamp timestamp The snapshot time of this record.
OTF2_TimeStamp origEventTime The original time this event happended.
uint32_t receiver MPI rank of receiver in communicator.
OTF2_CommRef communicator Communicator ID. References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
uint32_t msgTag Message tag
uint64_t msgLength Message length
See also:
MpiSend event
OTF2_SnapWriter_MpiSend()
Since:
Version 1.2

MpiIsendSnap
This record exists for each MpiIsend event where an corresponding MpiIsendComplete or MpiRequestCancelled event did not occur on this location before the snapshot. Or the corresponding MpiIsendComplete did occurred (the MpiIsendCompleteSnap record exists in the snapshot) but the matching receive message event did not occur on the remote location before the snapshot. (This could either be anMpiRecv or an MpiIrecv event.)

Attributes:
OTF2_LocationRef location The location of the snapshot.
OTF2_TimeStamp timestamp The snapshot time of this record.
OTF2_TimeStamp origEventTime The original time this event happended.
uint32_t receiver MPI rank of receiver in communicator.
OTF2_CommRef communicator Communicator ID. References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
uint32_t msgTag Message tag
uint64_t msgLength Message length
uint64_t requestID ID of the related request
See also:
MpiIsend event
OTF2_SnapWriter_MpiIsend()
Since:
Version 1.2

MpiIsendCompleteSnap
This record exists for each MpiIsend event where the corresponding MpiIsendComplete event occurred, but where the matching receive message event did not occur on the remote location before the snapshot. (This could either be an MpiRecv or an MpiIrecv event.) .

Attributes:
OTF2_LocationRef location The location of the snapshot.
OTF2_TimeStamp timestamp The snapshot time of this record.
OTF2_TimeStamp origEventTime The original time this event happended.
uint64_t requestID ID of the related request
See also:
MpiIsendComplete event
OTF2_SnapWriter_MpiIsendComplete()
Since:
Version 1.2

MpiRecvSnap
This record exists for each MpiRecv event where the matching send message event did not occur on the remote location before the snapshot. This could either be an MpiSend or an MpiIsendComplete event. Or an MpiIrecvRequest occurred before this event but the corresponding MpiIrecv event did not occurred before this snapshot. In this case the message matching couldn't performed yet, because the envelope of the ongoing MpiIrecvRequest is not yet known.

Attributes:
OTF2_LocationRef location The location of the snapshot.
OTF2_TimeStamp timestamp The snapshot time of this record.
OTF2_TimeStamp origEventTime The original time this event happended.
uint32_t sender MPI rank of sender in communicator.
OTF2_CommRef communicator Communicator ID. References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
uint32_t msgTag Message tag
uint64_t msgLength Message length
See also:
MpiRecv event
OTF2_SnapWriter_MpiRecv()
Since:
Version 1.2

MpiIrecvRequestSnap
This record exists for each MpiIrecvRequest event where an corresponding MpiIrecv or MpiRequestCancelled event did not occur on this location before the snapshot. Or the corresponding MpiIrecv did occurred (the MpiIrecvSnap record exists in the snapshot) but the matching receive message event did not occur on the remote location before the snapshot. This could either be an MpiRecv or an MpiIrecv event.

Attributes:
OTF2_LocationRef location The location of the snapshot.
OTF2_TimeStamp timestamp The snapshot time of this record.
OTF2_TimeStamp origEventTime The original time this event happended.
uint64_t requestID ID of the requested receive
See also:
MpiIrecvRequest event
OTF2_SnapWriter_MpiIrecvRequest()
Since:
Version 1.2

MpiIrecvSnap
This record exists for each MpiIrecv event where the matching send message event did not occur on the remote location before the snapshot. This could either be an MpiSend or an MpiIsendComplete event. Or an MpiIrecvRequest occurred before this event but the corresponding MpiIrecv event did not occurred before this snapshot. In this case the message matching couldn't performed yet, because the envelope of the ongoing MpiIrecvRequest is not yet known.

Attributes:
OTF2_LocationRef location The location of the snapshot.
OTF2_TimeStamp timestamp The snapshot time of this record.
OTF2_TimeStamp origEventTime The original time this event happended.
uint32_t sender MPI rank of sender in communicator.
OTF2_CommRef communicator Communicator ID. References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
uint32_t msgTag Message tag
uint64_t msgLength Message length
uint64_t requestID ID of the related request
See also:
MpiIrecv event
OTF2_SnapWriter_MpiIrecv()
Since:
Version 1.2

MpiCollectiveBeginSnap
Indicates that this location started a collective operation but not all of the participating locations completed the operation yet, including this location.

Attributes:
OTF2_LocationRef location The location of the snapshot.
OTF2_TimeStamp timestamp The snapshot time of this record.
OTF2_TimeStamp origEventTime The original time this event happended.
See also:
MpiCollectiveBegin event
OTF2_SnapWriter_MpiCollectiveBegin()
Since:
Version 1.2

MpiCollectiveEndSnap
Indicates that this location completed a collective operation localy but not all of the participating locations completed the operation yet. The corresponding MpiCollectiveBeginSnap record is still in the snapshot though.

Attributes:
OTF2_LocationRef location The location of the snapshot.
OTF2_TimeStamp timestamp The snapshot time of this record.
OTF2_TimeStamp origEventTime The original time this event happended.
OTF2_CollectiveOp collectiveOp Determines which collective operation it is.
OTF2_CommRef communicator Communicator References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
uint32_t root MPI rank of root in communicator.
uint64_t sizeSent Size of the sent message.
uint64_t sizeReceived Size of the received message.
See also:
MpiCollectiveEnd event
OTF2_SnapWriter_MpiCollectiveEnd()
Since:
Version 1.2

OmpForkSnap
This record exists for each OmpFork event where the corresponding OmpJoin did not occurred before this snapshot.

Attributes:
OTF2_LocationRef location The location of the snapshot.
OTF2_TimeStamp timestamp The snapshot time of this record.
OTF2_TimeStamp origEventTime The original time this event happended.
uint32_t numberOfRequestedThreads Requested size of the team.
See also:
OmpFork event
OTF2_SnapWriter_OmpFork()
Since:
Version 1.2

OmpAcquireLockSnap
This record exists for each OmpAcquireLock event where the corresponding OmpReleaseLock did not occurred before this snapshot yet.

Attributes:
OTF2_LocationRef location The location of the snapshot.
OTF2_TimeStamp timestamp The snapshot time of this record.
OTF2_TimeStamp origEventTime The original time this event happended.
uint32_t lockID ID of the lock.
uint32_t acquisitionOrder A monotonically increasing number to determine the order of lock acquisitions (with unsynchronized clocks this is otherwise not possible). Corresponding acquire-release events have same number.
See also:
OmpAcquireLock event
OTF2_SnapWriter_OmpAcquireLock()
Since:
Version 1.2

OmpTaskCreateSnap
This record exists for each OmpTaskCreate event where the corresponding OmpTaskComplete event did not occurred before this snapshot. Neither on this location nor on any other location in the current thread team.

Attributes:
OTF2_LocationRef location The location of the snapshot.
OTF2_TimeStamp timestamp The snapshot time of this record.
OTF2_TimeStamp origEventTime The original time this event happended.
uint64_t taskID Identifier of the newly created task instance.
See also:
OmpTaskCreate event
OTF2_SnapWriter_OmpTaskCreate()
Since:
Version 1.2

OmpTaskSwitchSnap
This record exists for each OmpTaskSwitch event where the corresponding OmpTaskComplete event did not occurred before this snapshot. Neither on this location nor on any other location in the current thread team.

Attributes:
OTF2_LocationRef location The location of the snapshot.
OTF2_TimeStamp timestamp The snapshot time of this record.
OTF2_TimeStamp origEventTime The original time this event happended.
uint64_t taskID Identifier of the now active task instance.
See also:
OmpTaskSwitch event
OTF2_SnapWriter_OmpTaskSwitch()
Since:
Version 1.2

MetricSnap
This record exists for each referenced metric class or metric instance event this location recorded metrics before and provides the last known recorded metric values.

As an exception for metric classes where the metric mode detontes an OTF2_METRIC_VALUE_RELATIVE mode the value indicates the accumulation of all previous metric values recorded.

Attributes:
OTF2_LocationRef location The location of the snapshot.
OTF2_TimeStamp timestamp The snapshot time of this record.
OTF2_TimeStamp origEventTime The original time this event happended.
OTF2_MetricRef metric Could be a metric class or a metric instance. References a MetricClass, or a MetricInstance definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_METRIC is available.
uint8_t numberOfMetrics Number of metrics with in the set.
OTF2_Type typeIDs [ numberOfMetrics ] List of metric types. These types must match that of the corresponding MetricMember definitions.
OTF2_MetricValue metricValues [ numberOfMetrics ] List of metric values.
See also:
Metric event
OTF2_SnapWriter_Metric()
Since:
Version 1.2

ParameterStringSnap
This record must be included in the snapshot until the leave event for the enter event occurs which has the greates timestamp less or equal the timestamp of this record.

Attributes:
OTF2_LocationRef location The location of the snapshot.
OTF2_TimeStamp timestamp The snapshot time of this record.
OTF2_TimeStamp origEventTime The original time this event happended.
OTF2_ParameterRef parameter Parameter ID. References a Parameter definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_PARAMETER is available.
OTF2_StringRef string Value: Handle of a string definition References a String definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_STRING is available.
See also:
ParameterString event
OTF2_SnapWriter_ParameterString()
Since:
Version 1.2

ParameterIntSnap
This record must be included in the snapshot until the leave event for the enter event occurs which has the greates timestamp less or equal the timestamp of this record.

Attributes:
OTF2_LocationRef location The location of the snapshot.
OTF2_TimeStamp timestamp The snapshot time of this record.
OTF2_TimeStamp origEventTime The original time this event happended.
OTF2_ParameterRef parameter Parameter ID. References a Parameter definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_PARAMETER is available.
int64_t value Value of the recorded parameter.
See also:
ParameterInt event
OTF2_SnapWriter_ParameterInt()
Since:
Version 1.2

ParameterUnsignedIntSnap
This record must be included in the snapshot until the leave event for the enter event occurs which has the greates timestamp less or equal the timestamp of this record.

Attributes:
OTF2_LocationRef location The location of the snapshot.
OTF2_TimeStamp timestamp The snapshot time of this record.
OTF2_TimeStamp origEventTime The original time this event happended.
OTF2_ParameterRef parameter Parameter ID. References a Parameter definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_PARAMETER is available.
uint64_t value Value of the recorded parameter.
See also:
ParameterUnsignedInt event
OTF2_SnapWriter_ParameterUnsignedInt()
Since:
Version 1.2