2.0 (revision 4408)
Typedefs | Functions
OTF2_EvtWriter.h File Reference

This lowest user-visible layer provides write routines to write event data of 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_EvtWriter_struct OTF2_EvtWriter
 Keeps all necessary information about the event writer. See OTF2_EvtWriter_struct for detailed information.
 

Functions

OTF2_ErrorCode OTF2_EvtWriter_GetLocationID (const OTF2_EvtWriter *writer, OTF2_LocationRef *locationID)
 Function to get the location ID of a writer object. More...
 
OTF2_ErrorCode OTF2_EvtWriter_SetUserData (OTF2_EvtWriter *writer, void *userData)
 Function to set user defined data to a writer object. More...
 
OTF2_ErrorCode OTF2_EvtWriter_GetUserData (const OTF2_EvtWriter *writer, void **userData)
 Function to get the location of a writer object. More...
 
OTF2_ErrorCode OTF2_EvtWriter_SetLocationID (OTF2_EvtWriter *writer, OTF2_LocationRef location)
 The location ID is not always known on measurement start, and only needed on the first buffer flush to generate the file name. This function enables setting of the location ID after generating the buffer object. More...
 
OTF2_ErrorCode OTF2_EvtWriter_GetNumberOfEvents (OTF2_EvtWriter *writer, uint64_t *numberOfEvents)
 Get the number of events. More...
 
OTF2_ErrorCode OTF2_EvtWriter_BufferFlush (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_TimeStamp stopTime)
 Records a BufferFlush event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_MeasurementOnOff (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_MeasurementMode measurementMode)
 Records a MeasurementOnOff event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_Enter (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RegionRef region)
 Records a Enter event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_Leave (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RegionRef region)
 Records a Leave event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_MpiSend (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint32_t receiver, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength)
 Records a MpiSend event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_MpiIsend (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint32_t receiver, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength, uint64_t requestID)
 Records a MpiIsend event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_MpiIsendComplete (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t requestID)
 Records a MpiIsendComplete event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_MpiIrecvRequest (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t requestID)
 Records a MpiIrecvRequest event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_MpiRecv (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint32_t sender, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength)
 Records a MpiRecv event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_MpiIrecv (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint32_t sender, OTF2_CommRef communicator, uint32_t msgTag, uint64_t msgLength, uint64_t requestID)
 Records a MpiIrecv event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_MpiRequestTest (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t requestID)
 Records a MpiRequestTest event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_MpiRequestCancelled (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t requestID)
 Records a MpiRequestCancelled event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_MpiCollectiveBegin (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time)
 Records a MpiCollectiveBegin event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_MpiCollectiveEnd (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CollectiveOp collectiveOp, OTF2_CommRef communicator, uint32_t root, uint64_t sizeSent, uint64_t sizeReceived)
 Records a MpiCollectiveEnd event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_OmpFork (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint32_t numberOfRequestedThreads)
 Records a OmpFork event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_OmpJoin (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time)
 Records a OmpJoin event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_OmpAcquireLock (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint32_t lockID, uint32_t acquisitionOrder)
 Records a OmpAcquireLock event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_OmpReleaseLock (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint32_t lockID, uint32_t acquisitionOrder)
 Records a OmpReleaseLock event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_OmpTaskCreate (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t taskID)
 Records a OmpTaskCreate event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_OmpTaskSwitch (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t taskID)
 Records a OmpTaskSwitch event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_OmpTaskComplete (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, uint64_t taskID)
 Records a OmpTaskComplete event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_Metric (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_MetricRef metric, uint8_t numberOfMetrics, const OTF2_Type *typeIDs, const OTF2_MetricValue *metricValues)
 Records a Metric event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_ParameterString (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_ParameterRef parameter, OTF2_StringRef string)
 Records a ParameterString event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_ParameterInt (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_ParameterRef parameter, int64_t value)
 Records a ParameterInt event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_ParameterUnsignedInt (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_ParameterRef parameter, uint64_t value)
 Records a ParameterUnsignedInt event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_RmaWinCreate (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win)
 Records a RmaWinCreate event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_RmaWinDestroy (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win)
 Records a RmaWinDestroy event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_RmaCollectiveBegin (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time)
 Records a RmaCollectiveBegin event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_RmaCollectiveEnd (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CollectiveOp collectiveOp, OTF2_RmaSyncLevel syncLevel, OTF2_RmaWinRef win, uint32_t root, uint64_t bytesSent, uint64_t bytesReceived)
 Records a RmaCollectiveEnd event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_RmaGroupSync (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaSyncLevel syncLevel, OTF2_RmaWinRef win, OTF2_GroupRef group)
 Records a RmaGroupSync event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_RmaRequestLock (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId, OTF2_LockType lockType)
 Records a RmaRequestLock event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_RmaAcquireLock (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId, OTF2_LockType lockType)
 Records a RmaAcquireLock event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_RmaTryLock (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId, OTF2_LockType lockType)
 Records a RmaTryLock event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_RmaReleaseLock (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, uint64_t lockId)
 Records a RmaReleaseLock event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_RmaSync (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, OTF2_RmaSyncType syncType)
 Records a RmaSync event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_RmaWaitChange (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win)
 Records a RmaWaitChange event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_RmaPut (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, uint64_t bytes, uint64_t matchingId)
 Records a RmaPut event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_RmaGet (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, uint64_t bytes, uint64_t matchingId)
 Records a RmaGet event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_RmaAtomic (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint32_t remote, OTF2_RmaAtomicType type, uint64_t bytesSent, uint64_t bytesReceived, uint64_t matchingId)
 Records a RmaAtomic event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_RmaOpCompleteBlocking (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint64_t matchingId)
 Records a RmaOpCompleteBlocking event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_RmaOpCompleteNonBlocking (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint64_t matchingId)
 Records a RmaOpCompleteNonBlocking event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_RmaOpTest (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint64_t matchingId)
 Records a RmaOpTest event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_RmaOpCompleteRemote (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_RmaWinRef win, uint64_t matchingId)
 Records a RmaOpCompleteRemote event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_ThreadFork (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_Paradigm model, uint32_t numberOfRequestedThreads)
 Records a ThreadFork event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_ThreadJoin (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_Paradigm model)
 Records a ThreadJoin event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_ThreadTeamBegin (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadTeam)
 Records a ThreadTeamBegin event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_ThreadTeamEnd (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadTeam)
 Records a ThreadTeamEnd event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_ThreadAcquireLock (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_Paradigm model, uint32_t lockID, uint32_t acquisitionOrder)
 Records a ThreadAcquireLock event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_ThreadReleaseLock (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_Paradigm model, uint32_t lockID, uint32_t acquisitionOrder)
 Records a ThreadReleaseLock event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_ThreadTaskCreate (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadTeam, uint32_t creatingThread, uint32_t generationNumber)
 Records a ThreadTaskCreate event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_ThreadTaskSwitch (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadTeam, uint32_t creatingThread, uint32_t generationNumber)
 Records a ThreadTaskSwitch event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_ThreadTaskComplete (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadTeam, uint32_t creatingThread, uint32_t generationNumber)
 Records a ThreadTaskComplete event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_ThreadCreate (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadContingent, uint64_t sequenceCount)
 Records a ThreadCreate event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_ThreadBegin (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadContingent, uint64_t sequenceCount)
 Records a ThreadBegin event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_ThreadWait (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadContingent, uint64_t sequenceCount)
 Records a ThreadWait event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_ThreadEnd (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CommRef threadContingent, uint64_t sequenceCount)
 Records a ThreadEnd event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_CallingContextEnter (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CallingContextRef callingContext, uint32_t unwindDistance)
 Records a CallingContextEnter event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_CallingContextLeave (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CallingContextRef callingContext)
 Records a CallingContextLeave event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_CallingContextSample (OTF2_EvtWriter *writer, OTF2_AttributeList *attributeList, OTF2_TimeStamp time, OTF2_CallingContextRef callingContext, uint32_t unwindDistance, OTF2_InterruptGeneratorRef interruptGenerator)
 Records a CallingContextSample event. More...
 
OTF2_ErrorCode OTF2_EvtWriter_StoreRewindPoint (OTF2_EvtWriter *writer, uint32_t rewindId)
 Please give me a documentation. More...
 
OTF2_ErrorCode OTF2_EvtWriter_Rewind (OTF2_EvtWriter *writer, uint32_t rewindId)
 Please give me a documentation. More...
 
OTF2_ErrorCode OTF2_EvtWriter_ClearRewindPoint (OTF2_EvtWriter *writer, uint32_t rewindId)
 Please give me a documentation. More...
 

Detailed Description

This lowest user-visible layer provides write routines to write event data of a single location.

Source Template:
templates/OTF2_EvtWriter.tmpl.h

Function Documentation

OTF2_ErrorCode OTF2_EvtWriter_GetLocationID ( const OTF2_EvtWriter writer,
OTF2_LocationRef locationID 
)

Function to get the location ID of a writer object.

Parameters
writerWriter object which has to be deleted
locationIDPointer to a variable where the ID is returned in
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_SetUserData ( OTF2_EvtWriter writer,
void *  userData 
)

Function to set user defined data to a writer object.

Parameters
writerWriter object.
userDataUser provided data. Can be queried with OTF2_EvtWriter_GetUserData.
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_GetUserData ( const OTF2_EvtWriter writer,
void **  userData 
)

Function to get the location of a writer object.

Parameters
writerWriter object.
[out]userDataPointer to a variable where the pointer to the location is returned in.
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_SetLocationID ( OTF2_EvtWriter writer,
OTF2_LocationRef  location 
)

The location ID is not always known on measurement start, and only needed on the first buffer flush to generate the file name. This function enables setting of the location ID after generating the buffer object.

Parameters
writerWriter object.
locationLocation ID.
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_GetNumberOfEvents ( OTF2_EvtWriter writer,
uint64_t *  numberOfEvents 
)

Get the number of events.

Get the number of events written with this event writer. You should call this function right before closing the event writer to get the correct number of stored event records.

Parameters
writerWriter object.
[out]numberOfEventsReturn pointer to the number of events.
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_BufferFlush ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_TimeStamp  stopTime 
)

Records a BufferFlush event.

This event signals that the internal buffer was flushed at the given time.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
stopTimeThe time the buffer flush finished.
Since
Version 1.0
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_MeasurementOnOff ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_MeasurementMode  measurementMode 
)

Records a MeasurementOnOff event.

This event signals where the measurement system turned measurement on or off.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
measurementModeIs the measurement turned on (OTF2_MEASUREMENT_ON) or off (OTF2_MEASUREMENT_OFF)?
Since
Version 1.0
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_Enter ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_RegionRef  region 
)

Records a Enter event.

An enter record indicates that the program enters a code region.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
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.0
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
Examples:
otf2_mpi_writer_example.c, otf2_openmp_writer_example.c, otf2_pthread_writer_example.c, and otf2_writer_example.c.
OTF2_ErrorCode OTF2_EvtWriter_Leave ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_RegionRef  region 
)

Records a Leave event.

A leave record indicates that the program leaves a code region.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
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.0
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
Examples:
otf2_mpi_writer_example.c, otf2_openmp_writer_example.c, otf2_pthread_writer_example.c, and otf2_writer_example.c.
OTF2_ErrorCode OTF2_EvtWriter_MpiSend ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
uint32_t  receiver,
OTF2_CommRef  communicator,
uint32_t  msgTag,
uint64_t  msgLength 
)

Records a MpiSend 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).

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
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.0
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_MpiIsend ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
uint32_t  receiver,
OTF2_CommRef  communicator,
uint32_t  msgTag,
uint64_t  msgLength,
uint64_t  requestID 
)

Records a MpiIsend 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).

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
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.0
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_MpiIsendComplete ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
uint64_t  requestID 
)

Records a MpiIsendComplete event.

Signals the completion of non-blocking send request.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
requestIDID of the related request
Since
Version 1.0
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_MpiIrecvRequest ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
uint64_t  requestID 
)

Records a MpiIrecvRequest event.

Signals the request of a receive, which can be completed later.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
requestIDID of the requested receive
Since
Version 1.0
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_MpiRecv ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
uint32_t  sender,
OTF2_CommRef  communicator,
uint32_t  msgTag,
uint64_t  msgLength 
)

Records a MpiRecv 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).

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
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.0
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_MpiIrecv ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
uint32_t  sender,
OTF2_CommRef  communicator,
uint32_t  msgTag,
uint64_t  msgLength,
uint64_t  requestID 
)

Records a MpiIrecv 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).

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
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.0
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_MpiRequestTest ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
uint64_t  requestID 
)

Records a MpiRequestTest event.

This events appears if the program tests if a request has already completed but the test failed.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
requestIDID of the related request
Since
Version 1.0
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_MpiRequestCancelled ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
uint64_t  requestID 
)

Records a MpiRequestCancelled event.

This events appears if the program canceled a request.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
requestIDID of the related request
Since
Version 1.0
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_MpiCollectiveBegin ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time 
)

Records a MpiCollectiveBegin event.

A MpiCollectiveBegin record marks the begin of a MPI collective operation (MPI_GATHER, MPI_SCATTER etc.).

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
Since
Version 1.0
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
Examples:
otf2_mpi_writer_example.c.
OTF2_ErrorCode OTF2_EvtWriter_MpiCollectiveEnd ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_CollectiveOp  collectiveOp,
OTF2_CommRef  communicator,
uint32_t  root,
uint64_t  sizeSent,
uint64_t  sizeReceived 
)

Records a MpiCollectiveEnd 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.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
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.0
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
Examples:
otf2_mpi_writer_example.c.
OTF2_ErrorCode OTF2_EvtWriter_OmpFork ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
uint32_t  numberOfRequestedThreads 
)

Records a OmpFork 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.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
numberOfRequestedThreadsRequested size of the team.
Since
Version 1.0
Deprecated:
In version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_OmpJoin ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time 
)

Records a OmpJoin 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.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
Since
Version 1.0
Deprecated:
In version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_OmpAcquireLock ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
uint32_t  lockID,
uint32_t  acquisitionOrder 
)

Records a OmpAcquireLock 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.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
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.0
Deprecated:
In version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_OmpReleaseLock ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
uint32_t  lockID,
uint32_t  acquisitionOrder 
)

Records a OmpReleaseLock 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.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
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.0
Deprecated:
In version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_OmpTaskCreate ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
uint64_t  taskID 
)

Records a OmpTaskCreate 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.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
taskIDIdentifier of the newly created task instance.
Since
Version 1.0
Deprecated:
In version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_OmpTaskSwitch ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
uint64_t  taskID 
)

Records a OmpTaskSwitch 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.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
taskIDIdentifier of the now active task instance.
Since
Version 1.0
Deprecated:
In version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_OmpTaskComplete ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
uint64_t  taskID 
)

Records a OmpTaskComplete 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.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
taskIDIdentifier of the completed task instance.
Since
Version 1.0
Deprecated:
In version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_Metric ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_MetricRef  metric,
uint8_t  numberOfMetrics,
const OTF2_Type typeIDs,
const OTF2_MetricValue metricValues 
)

Records a Metric event.

A metric event is always stored at the location that recorded the metric. A metric event can reference a metric class or metric instance. Therefore, metric classes and instances share same ID space. Synchronous metrics are always located right before the according enter and leave event.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
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.0
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_ParameterString ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_ParameterRef  parameter,
OTF2_StringRef  string 
)

Records a ParameterString event.

A ParameterString record marks that in the current region, the specified string parameter has the specified value.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
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.0
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_ParameterInt ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_ParameterRef  parameter,
int64_t  value 
)

Records a ParameterInt event.

A ParameterInt record marks that in the current region, the specified integer parameter has the specified value.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
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.0
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_ParameterUnsignedInt ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_ParameterRef  parameter,
uint64_t  value 
)

Records a ParameterUnsignedInt event.

A ParameterUnsignedInt record marks that in the current region, the specified unsigned integer parameter has the specified value.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
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.0
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_RmaWinCreate ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_RmaWinRef  win 
)

Records a RmaWinCreate event.

A RmaWinCreate record denotes the creation of a RMA window.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
winID of the window created. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_RmaWinDestroy ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_RmaWinRef  win 
)

Records a RmaWinDestroy event.

A RmaWinDestroy record denotes the destruction of a RMA window.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
winID of the window destructed. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_RmaCollectiveBegin ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time 
)

Records a RmaCollectiveBegin event.

A RmaCollectiveBegin record denotes the beginning of a collective RMA operation.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_RmaCollectiveEnd ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_CollectiveOp  collectiveOp,
OTF2_RmaSyncLevel  syncLevel,
OTF2_RmaWinRef  win,
uint32_t  root,
uint64_t  bytesSent,
uint64_t  bytesReceived 
)

Records a RmaCollectiveEnd event.

A RmaCollectiveEnd record denotes the end of a collective RMA operation.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
collectiveOpDetermines which collective operation it is.
syncLevelSynchronization level of this collective operation.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
rootRoot process for this operation.
bytesSentBytes sent in operation.
bytesReceivedBytes receives in operation.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_RmaGroupSync ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_RmaSyncLevel  syncLevel,
OTF2_RmaWinRef  win,
OTF2_GroupRef  group 
)

Records a RmaGroupSync event.

A RmaGroupSync record denotes the synchronization with a subgroup of processes on a window.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
syncLevelSynchronization level of this collective operation.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
groupGroup of remote processes involved in synchronization. References a Group definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_GROUP is available.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_RmaRequestLock ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_RmaWinRef  win,
uint32_t  remote,
uint64_t  lockId,
OTF2_LockType  lockType 
)

Records a RmaRequestLock 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.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
remoteRank of the locked remote process.
lockIdID of the lock acquired, if multiple locks are defined on a window.
lockTypeType of lock acquired.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_RmaAcquireLock ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_RmaWinRef  win,
uint32_t  remote,
uint64_t  lockId,
OTF2_LockType  lockType 
)

Records a RmaAcquireLock event.

A RmaAcquireLock record denotes the time a lock was acquired by the process.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
remoteRank of the locked remote process.
lockIdID of the lock acquired, if multiple locks are defined on a window.
lockTypeType of lock acquired.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_RmaTryLock ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_RmaWinRef  win,
uint32_t  remote,
uint64_t  lockId,
OTF2_LockType  lockType 
)

Records a RmaTryLock event.

A RmaTryLock record denotes the time of an unsuccessful attempt to acquire the lock.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
remoteRank of the locked remote process.
lockIdID of the lock acquired, if multiple locks are defined on a window.
lockTypeType of lock acquired.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_RmaReleaseLock ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_RmaWinRef  win,
uint32_t  remote,
uint64_t  lockId 
)

Records a RmaReleaseLock event.

A RmaReleaseLock record denotes the time the lock was released.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
remoteRank of the locked remote process.
lockIdID of the lock released, if multiple locks are defined on a window.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_RmaSync ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_RmaWinRef  win,
uint32_t  remote,
OTF2_RmaSyncType  syncType 
)

Records a RmaSync event.

A RmaSync record denotes the direct synchronization with a possibly remote process.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
remoteRank of the locked remote process.
syncTypeType of synchronization.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_RmaWaitChange ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_RmaWinRef  win 
)

Records a RmaWaitChange event.

A RmaWaitChange record denotes the change of a window that was waited for.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_RmaPut ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_RmaWinRef  win,
uint32_t  remote,
uint64_t  bytes,
uint64_t  matchingId 
)

Records a RmaPut event.

A RmaPut record denotes the time a put operation was issued.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
remoteRank of the target process.
bytesBytes sent to target.
matchingIdID used for matching the corresponding completion record.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_RmaGet ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_RmaWinRef  win,
uint32_t  remote,
uint64_t  bytes,
uint64_t  matchingId 
)

Records a RmaGet event.

A RmaGet record denotes the time a get operation was issued.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
remoteRank of the target process.
bytesBytes received from target.
matchingIdID used for matching the corresponding completion record.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_RmaAtomic ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_RmaWinRef  win,
uint32_t  remote,
OTF2_RmaAtomicType  type,
uint64_t  bytesSent,
uint64_t  bytesReceived,
uint64_t  matchingId 
)

Records a RmaAtomic event.

A RmaAtomic record denotes the time a atomic operation was issued.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
remoteRank of the target process.
typeType of atomic operation.
bytesSentBytes sent to target.
bytesReceivedBytes received from target.
matchingIdID used for matching the corresponding completion record.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_RmaOpCompleteBlocking ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_RmaWinRef  win,
uint64_t  matchingId 
)

Records a RmaOpCompleteBlocking event.

A RmaOpCompleteBlocking record denotes the local completion of a blocking RMA operation.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
matchingIdID used for matching the corresponding RMA operation record.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_RmaOpCompleteNonBlocking ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_RmaWinRef  win,
uint64_t  matchingId 
)

Records a RmaOpCompleteNonBlocking event.

A RmaOpCompleteNonBlocking record denotes the local completion of a non-blocking RMA operation.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
matchingIdID used for matching the corresponding RMA operation record.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_RmaOpTest ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_RmaWinRef  win,
uint64_t  matchingId 
)

Records a RmaOpTest event.

A RmaOpTest record denotes that a non-blocking RMA operation has been tested for completion unsuccessfully.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
matchingIdID used for matching the corresponding RMA operation record.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_RmaOpCompleteRemote ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_RmaWinRef  win,
uint64_t  matchingId 
)

Records a RmaOpCompleteRemote event.

A RmaOpCompleteRemote record denotes the remote completion of a RMA operation.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
winID of the window used for this operation. References a RmaWin definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_RMA_WIN is available.
matchingIdID used for matching the corresponding RMA operation record.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_ThreadFork ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_Paradigm  model,
uint32_t  numberOfRequestedThreads 
)

Records a ThreadFork event.

A ThreadFork record marks that a thread forks a thread team.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
modelThe threading paradigm this event took place.
numberOfRequestedThreadsRequested size of the team.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_ThreadJoin ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_Paradigm  model 
)

Records a ThreadJoin event.

A ThreadJoin record marks that a team of threads is joint and only the master thread continues execution.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
modelThe threading paradigm this event took place.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_ThreadTeamBegin ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_CommRef  threadTeam 
)

Records a ThreadTeamBegin event.

The current location enters the specified thread team.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
threadTeamThread team References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_ThreadTeamEnd ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_CommRef  threadTeam 
)

Records a ThreadTeamEnd event.

The current location leaves the specified thread team.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
threadTeamThread team References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_ThreadAcquireLock ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_Paradigm  model,
uint32_t  lockID,
uint32_t  acquisitionOrder 
)

Records a ThreadAcquireLock event.

A ThreadAcquireLock record marks that a thread acquires a lock.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
modelThe threading paradigm this event took place.
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_EvtWriter_ThreadReleaseLock ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_Paradigm  model,
uint32_t  lockID,
uint32_t  acquisitionOrder 
)

Records a ThreadReleaseLock event.

A ThreadReleaseLock record marks that a thread releases a lock.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
modelThe threading paradigm this event took place.
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_EvtWriter_ThreadTaskCreate ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_CommRef  threadTeam,
uint32_t  creatingThread,
uint32_t  generationNumber 
)

Records a ThreadTaskCreate event.

A ThreadTaskCreate record marks that a task in was/will be created and will be processed by the specified thread team.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
threadTeamThread team References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
creatingThreadCreating thread of this task.
generationNumberThread-private generation number of task's creating thread.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_ThreadTaskSwitch ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_CommRef  threadTeam,
uint32_t  creatingThread,
uint32_t  generationNumber 
)

Records a ThreadTaskSwitch 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.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
threadTeamThread team References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
creatingThreadCreating thread of this task.
generationNumberThread-private generation number of task's creating thread.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_ThreadTaskComplete ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_CommRef  threadTeam,
uint32_t  creatingThread,
uint32_t  generationNumber 
)

Records a ThreadTaskComplete event.

A ThreadTaskComplete record indicates that the execution of an OpenMP task has finished.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
threadTeamThread team References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
creatingThreadCreating thread of this task.
generationNumberThread-private generation number of task's creating thread.
Since
Version 1.2
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_ThreadCreate ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_CommRef  threadContingent,
uint64_t  sequenceCount 
)

Records a ThreadCreate event.

The location created successfully a new thread.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
threadContingentThe thread contingent. References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
sequenceCountA threadContingent unique number. The corresponding ThreadBegin event does have the same number.
Since
Version 1.3
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_ThreadBegin ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_CommRef  threadContingent,
uint64_t  sequenceCount 
)

Records a ThreadBegin event.

Marks the begin of a thread created by another thread.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
threadContingentThe thread contingent. References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
sequenceCountA threadContingent unique number. The corresponding ThreadCreate event does have the same number.
Since
Version 1.3
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_ThreadWait ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_CommRef  threadContingent,
uint64_t  sequenceCount 
)

Records a ThreadWait event.

The location waits for the completion of another thread.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
threadContingentThe thread contingent. References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
sequenceCountA threadContingent unique number. The corresponding ThreadEnd event does have the same number.
Since
Version 1.3
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_ThreadEnd ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_CommRef  threadContingent,
uint64_t  sequenceCount 
)

Records a ThreadEnd event.

Marks the end of a thread.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
threadContingentThe thread contingent. References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available.
sequenceCountA threadContingent unique number. The corresponding ThreadWait event does have the same number. OTF2_UNDEFINED_UINT64 in case no corresponding ThreadWait event exists.
Since
Version 1.3
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_CallingContextEnter ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_CallingContextRef  callingContext,
uint32_t  unwindDistance 
)

Records a CallingContextEnter 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.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
callingContextThe entered region as referenced by the CallingContext definition. References a CallingContext definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_CALLING_CONTEXT is available.
unwindDistanceThe unwindDistance for this callingContext. See the description in CallingContext.
Since
Version 2.0
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_CallingContextLeave ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_CallingContextRef  callingContext 
)

Records a CallingContextLeave 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.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
callingContextThe left region as referenced by the CallingContext definition. References a CallingContext definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_CALLING_CONTEXT is available.
Since
Version 2.0
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_CallingContextSample ( OTF2_EvtWriter writer,
OTF2_AttributeList attributeList,
OTF2_TimeStamp  time,
OTF2_CallingContextRef  callingContext,
uint32_t  unwindDistance,
OTF2_InterruptGeneratorRef  interruptGenerator 
)

Records a CallingContextSample 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.

Parameters
writerWriter object.
attributeListGeneric attributes for the event.
timeThe time for this event.
callingContextDescribes the calling context of the thread when it was interrupted. References a CallingContext definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_CALLING_CONTEXT is available.
unwindDistanceThe unwindDistance for this callingContext. See the description in CallingContext.
interruptGeneratorReferences a InterruptGenerator definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_INTERRUPT_GENERATOR is available.
Since
Version 1.5
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_StoreRewindPoint ( OTF2_EvtWriter writer,
uint32_t  rewindId 
)

Please give me a documentation.

Parameters
writerWriter object.
rewindIdGeneric attributes for the event.
Since
Version 1.1
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_Rewind ( OTF2_EvtWriter writer,
uint32_t  rewindId 
)

Please give me a documentation.

Parameters
writerWriter object.
rewindIdGeneric attributes for the event.
Since
Version 1.1
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EvtWriter_ClearRewindPoint ( OTF2_EvtWriter writer,
uint32_t  rewindId 
)

Please give me a documentation.

Parameters
writerWriter object.
rewindIdGeneric attributes for the event.
Since
Version 1.1
Returns
OTF2_SUCCESS if successful, an error code if an error occurs.