1.5.1 (revision 4026)
Typedefs | Functions
otf2/OTF2_SnapWriter.h File Reference

This lowest user-visible layer provides write routines to write snapshot records for a single location. More...

#include <stdint.h>
#include <otf2/OTF2_ErrorCodes.h>
#include <otf2/OTF2_Events.h>
#include <otf2/OTF2_AttributeList.h>

Go to the source code of this file.

Typedefs

typedef struct
OTF2_SnapWriter_struct 
OTF2_SnapWriter
 Keeps all necessary information about the snap writer. See OTF2_SnapWriter_struct for detailed information.

Functions

OTF2_ErrorCode OTF2_SnapWriter_Enter (OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, OTF2_RegionRef region)
 Records an Enter snapshot record.
OTF2_ErrorCode OTF2_SnapWriter_GetLocationID (const OTF2_SnapWriter *writer, OTF2_LocationRef *locationID)
 Function to get the location ID of a snap writer object.
OTF2_ErrorCode OTF2_SnapWriter_MeasurementOnOff (OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, OTF2_MeasurementMode measurementMode)
 Records an MeasurementOnOff snapshot record.
OTF2_ErrorCode OTF2_SnapWriter_Metric (OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, OTF2_MetricRef metric, uint8_t numberOfMetrics, const OTF2_Type *typeIDs, const OTF2_MetricValue *metricValues)
 Records an Metric snapshot record.
OTF2_ErrorCode OTF2_SnapWriter_MpiCollectiveBegin (OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime)
 Records an MpiCollectiveBegin snapshot record.
OTF2_ErrorCode OTF2_SnapWriter_MpiCollectiveEnd (OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, OTF2_CollectiveOp collectiveOp, OTF2_CommRef communicator, uint32_t root, uint64_t sizeSent, uint64_t sizeReceived)
 Records an MpiCollectiveEnd snapshot record.
OTF2_ErrorCode OTF2_SnapWriter_MpiIrecv (OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, uint32_t sender, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength, uint64_t requestID)
 Records an MpiIrecv snapshot record.
OTF2_ErrorCode OTF2_SnapWriter_MpiIrecvRequest (OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, uint64_t requestID)
 Records an MpiIrecvRequest snapshot record.
OTF2_ErrorCode OTF2_SnapWriter_MpiIsend (OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, uint32_t receiver, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength, uint64_t requestID)
 Records an MpiIsend snapshot record.
OTF2_ErrorCode OTF2_SnapWriter_MpiIsendComplete (OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, uint64_t requestID)
 Records an MpiIsendComplete snapshot record.
OTF2_ErrorCode OTF2_SnapWriter_MpiRecv (OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, uint32_t sender, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength)
 Records an MpiRecv snapshot record.
OTF2_ErrorCode OTF2_SnapWriter_MpiSend (OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, uint32_t receiver, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength)
 Records an MpiSend snapshot record.
OTF2_ErrorCode OTF2_SnapWriter_OmpAcquireLock (OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, uint32_t lockID, uint32_t acquisitionOrder)
 Records an OmpAcquireLock snapshot record.
OTF2_ErrorCode OTF2_SnapWriter_OmpFork (OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, uint32_t numberOfRequestedThreads)
 Records an OmpFork snapshot record.
OTF2_ErrorCode OTF2_SnapWriter_OmpTaskCreate (OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, uint64_t taskID)
 Records an OmpTaskCreate snapshot record.
OTF2_ErrorCode OTF2_SnapWriter_OmpTaskSwitch (OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, uint64_t taskID)
 Records an OmpTaskSwitch snapshot record.
OTF2_ErrorCode OTF2_SnapWriter_ParameterInt (OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, OTF2_ParameterRef parameter, int64_t value)
 Records an ParameterInt snapshot record.
OTF2_ErrorCode OTF2_SnapWriter_ParameterString (OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, OTF2_ParameterRef parameter, OTF2_StringRef string)
 Records an ParameterString snapshot record.
OTF2_ErrorCode OTF2_SnapWriter_ParameterUnsignedInt (OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, OTF2_TimeStamp origEventTime, OTF2_ParameterRef parameter, uint64_t value)
 Records an ParameterUnsignedInt snapshot record.
OTF2_ErrorCode OTF2_SnapWriter_SnapshotEnd (OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, uint64_t contReadPos)
 Records an SnapshotEnd snapshot record.
OTF2_ErrorCode OTF2_SnapWriter_SnapshotStart (OTF2_SnapWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp snapTime, uint64_t numberOfRecords)
 Records an SnapshotStart snapshot record.

Detailed Description

This lowest user-visible layer provides write routines to write snapshot records for a single location.

Source Template:
templates/OTF2_SnapWriter.tmpl.h

Typedef Documentation

typedef struct OTF2_SnapWriter_struct OTF2_SnapWriter

Keeps all necessary information about the snap writer. See OTF2_SnapWriter_struct for detailed information.

Since:
Version 1.2

Function Documentation

OTF2_ErrorCode OTF2_SnapWriter_Enter ( OTF2_SnapWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  snapTime,
OTF2_TimeStamp  origEventTime,
OTF2_RegionRef  region 
)

Records an Enter snapshot record.

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

Parameters:
writerWriter object.
attributeListGeneric attributes for the snap.
snapTimeSnapshot time.
origEventTimeThe original time this event happended.
regionNeeds 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.
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_SnapWriter_GetLocationID ( const OTF2_SnapWriter writer,
OTF2_LocationRef locationID 
)

Function to get the location ID of a snap writer object.

Parameters:
writerSnap writer object of interest
locationIDPointer to a variable where the ID is returned in
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_SnapWriter_MeasurementOnOff ( OTF2_SnapWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  snapTime,
OTF2_TimeStamp  origEventTime,
OTF2_MeasurementMode  measurementMode 
)

Records an MeasurementOnOff snapshot record.

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

Parameters:
writerWriter object.
attributeListGeneric attributes for the snap.
snapTimeSnapshot time.
origEventTimeThe original time this event happended.
measurementModeIs the measurement turned on (OTF2_MEASUREMENT_ON) or off (OTF2_MEASUREMENT_OFF)?
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_SnapWriter_Metric ( OTF2_SnapWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  snapTime,
OTF2_TimeStamp  origEventTime,
OTF2_MetricRef  metric,
uint8_t  numberOfMetrics,
const OTF2_Type typeIDs,
const OTF2_MetricValue *  metricValues 
)

Records an Metric snapshot record.

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.

Parameters:
writerWriter object.
attributeListGeneric attributes for the snap.
snapTimeSnapshot time.
origEventTimeThe original time this event happended.
metricCould 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.
numberOfMetricsNumber of metrics with in the set.
typeIDsList of metric types. These types must match that of the corresponding MetricMember definitions.
metricValuesList of metric values.
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_SnapWriter_MpiCollectiveBegin ( OTF2_SnapWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  snapTime,
OTF2_TimeStamp  origEventTime 
)

Records an MpiCollectiveBegin snapshot record.

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

Parameters:
writerWriter object.
attributeListGeneric attributes for the snap.
snapTimeSnapshot time.
origEventTimeThe original time this event happended.
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_SnapWriter_MpiCollectiveEnd ( OTF2_SnapWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  snapTime,
OTF2_TimeStamp  origEventTime,
OTF2_CollectiveOp  collectiveOp,
OTF2_CommRef  communicator,
uint32_t  root,
uint64_t  sizeSent,
uint64_t  sizeReceived 
)

Records an MpiCollectiveEnd snapshot record.

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.

Parameters:
writerWriter object.
attributeListGeneric attributes for the snap.
snapTimeSnapshot time.
origEventTimeThe original time this event happended.
collectiveOpDetermines which collective operation it is.
communicatorCommunicator References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
rootMPI rank of root in communicator.
sizeSentSize of the sent message.
sizeReceivedSize of the received message.
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_SnapWriter_MpiIrecv ( OTF2_SnapWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  snapTime,
OTF2_TimeStamp  origEventTime,
uint32_t  sender,
OTF2_CommRef  communicator,
uint32_t  msgTag,
uint64_t  msgLength,
uint64_t  requestID 
)

Records an MpiIrecv snapshot record.

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.

Parameters:
writerWriter object.
attributeListGeneric attributes for the snap.
snapTimeSnapshot time.
origEventTimeThe original time this event happended.
senderMPI rank of sender in communicator.
communicatorCommunicator ID. References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
msgTagMessage tag
msgLengthMessage length
requestIDID of the related request
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_SnapWriter_MpiIrecvRequest ( OTF2_SnapWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  snapTime,
OTF2_TimeStamp  origEventTime,
uint64_t  requestID 
)

Records an MpiIrecvRequest snapshot record.

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.

Parameters:
writerWriter object.
attributeListGeneric attributes for the snap.
snapTimeSnapshot time.
origEventTimeThe original time this event happended.
requestIDID of the requested receive
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_SnapWriter_MpiIsend ( OTF2_SnapWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  snapTime,
OTF2_TimeStamp  origEventTime,
uint32_t  receiver,
OTF2_CommRef  communicator,
uint32_t  msgTag,
uint64_t  msgLength,
uint64_t  requestID 
)

Records an MpiIsend snapshot record.

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.)

Parameters:
writerWriter object.
attributeListGeneric attributes for the snap.
snapTimeSnapshot time.
origEventTimeThe original time this event happended.
receiverMPI rank of receiver in communicator.
communicatorCommunicator ID. References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
msgTagMessage tag
msgLengthMessage length
requestIDID of the related request
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_SnapWriter_MpiIsendComplete ( OTF2_SnapWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  snapTime,
OTF2_TimeStamp  origEventTime,
uint64_t  requestID 
)

Records an MpiIsendComplete snapshot record.

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.) .

Parameters:
writerWriter object.
attributeListGeneric attributes for the snap.
snapTimeSnapshot time.
origEventTimeThe original time this event happended.
requestIDID of the related request
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_SnapWriter_MpiRecv ( OTF2_SnapWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  snapTime,
OTF2_TimeStamp  origEventTime,
uint32_t  sender,
OTF2_CommRef  communicator,
uint32_t  msgTag,
uint64_t  msgLength 
)

Records an MpiRecv snapshot record.

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.

Parameters:
writerWriter object.
attributeListGeneric attributes for the snap.
snapTimeSnapshot time.
origEventTimeThe original time this event happended.
senderMPI rank of sender in communicator.
communicatorCommunicator ID. References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
msgTagMessage tag
msgLengthMessage length
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_SnapWriter_MpiSend ( OTF2_SnapWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  snapTime,
OTF2_TimeStamp  origEventTime,
uint32_t  receiver,
OTF2_CommRef  communicator,
uint32_t  msgTag,
uint64_t  msgLength 
)

Records an MpiSend snapshot record.

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.

Parameters:
writerWriter object.
attributeListGeneric attributes for the snap.
snapTimeSnapshot time.
origEventTimeThe original time this event happended.
receiverMPI rank of receiver in communicator.
communicatorCommunicator ID. References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
msgTagMessage tag
msgLengthMessage length
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_SnapWriter_OmpAcquireLock ( OTF2_SnapWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  snapTime,
OTF2_TimeStamp  origEventTime,
uint32_t  lockID,
uint32_t  acquisitionOrder 
)

Records an OmpAcquireLock snapshot record.

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

Parameters:
writerWriter object.
attributeListGeneric attributes for the snap.
snapTimeSnapshot time.
origEventTimeThe original time this event happended.
lockIDID of the lock.
acquisitionOrderA 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.
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_SnapWriter_OmpFork ( OTF2_SnapWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  snapTime,
OTF2_TimeStamp  origEventTime,
uint32_t  numberOfRequestedThreads 
)

Records an OmpFork snapshot record.

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

Parameters:
writerWriter object.
attributeListGeneric attributes for the snap.
snapTimeSnapshot time.
origEventTimeThe original time this event happended.
numberOfRequestedThreadsRequested size of the team.
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_SnapWriter_OmpTaskCreate ( OTF2_SnapWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  snapTime,
OTF2_TimeStamp  origEventTime,
uint64_t  taskID 
)

Records an OmpTaskCreate snapshot record.

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.

Parameters:
writerWriter object.
attributeListGeneric attributes for the snap.
snapTimeSnapshot time.
origEventTimeThe original time this event happended.
taskIDIdentifier of the newly created task instance.
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_SnapWriter_OmpTaskSwitch ( OTF2_SnapWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  snapTime,
OTF2_TimeStamp  origEventTime,
uint64_t  taskID 
)

Records an OmpTaskSwitch snapshot record.

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.

Parameters:
writerWriter object.
attributeListGeneric attributes for the snap.
snapTimeSnapshot time.
origEventTimeThe original time this event happended.
taskIDIdentifier of the now active task instance.
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_SnapWriter_ParameterInt ( OTF2_SnapWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  snapTime,
OTF2_TimeStamp  origEventTime,
OTF2_ParameterRef  parameter,
int64_t  value 
)

Records an ParameterInt snapshot record.

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.

Parameters:
writerWriter object.
attributeListGeneric attributes for the snap.
snapTimeSnapshot time.
origEventTimeThe original time this event happended.
parameterParameter ID. References a Parameter definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_PARAMETER is available.
valueValue of the recorded parameter.
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_SnapWriter_ParameterString ( OTF2_SnapWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  snapTime,
OTF2_TimeStamp  origEventTime,
OTF2_ParameterRef  parameter,
OTF2_StringRef  string 
)

Records an ParameterString snapshot record.

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.

Parameters:
writerWriter object.
attributeListGeneric attributes for the snap.
snapTimeSnapshot time.
origEventTimeThe original time this event happended.
parameterParameter ID. References a Parameter definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_PARAMETER is available.
stringValue: 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.
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_SnapWriter_ParameterUnsignedInt ( OTF2_SnapWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  snapTime,
OTF2_TimeStamp  origEventTime,
OTF2_ParameterRef  parameter,
uint64_t  value 
)

Records an ParameterUnsignedInt snapshot record.

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.

Parameters:
writerWriter object.
attributeListGeneric attributes for the snap.
snapTimeSnapshot time.
origEventTimeThe original time this event happended.
parameterParameter ID. References a Parameter definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_PARAMETER is available.
valueValue of the recorded parameter.
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_SnapWriter_SnapshotEnd ( OTF2_SnapWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  snapTime,
uint64_t  contReadPos 
)

Records an SnapshotEnd snapshot record.

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.

Parameters:
writerWriter object.
attributeListGeneric attributes for the snap.
snapTimeSnapshot time.
contReadPosPosition to continue reading in the event trace.
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_SnapWriter_SnapshotStart ( OTF2_SnapWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  snapTime,
uint64_t  numberOfRecords 
)

Records an SnapshotStart snapshot record.

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.

Parameters:
writerWriter object.
attributeListGeneric attributes for the snap.
snapTimeSnapshot time.
numberOfRecordsNumber of snapshot event records in this snapshot. Excluding the SnapshotEnd record.
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.