2.3-rc2 (revision v2.3-rc2)
|
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. | |
This lowest user-visible layer provides write routines to write event data of a single location.
OTF2_ErrorCode OTF2_EvtWriter_GetLocationID | ( | const OTF2_EvtWriter * | writer, |
OTF2_LocationRef * | locationID | ||
) |
Function to get the location ID of a writer object.
writer | Writer object which has to be deleted |
locationID | Pointer to a variable where the ID is returned in |
OTF2_ErrorCode OTF2_EvtWriter_SetUserData | ( | OTF2_EvtWriter * | writer, |
void * | userData | ||
) |
Function to set user defined data to a writer object.
writer | Writer object. |
userData | User provided data. Can be queried with OTF2_EvtWriter_GetUserData. |
OTF2_ErrorCode OTF2_EvtWriter_GetUserData | ( | const OTF2_EvtWriter * | writer, |
void ** | userData | ||
) |
Function to get the location of a writer object.
writer | Writer object. | |
[out] | userData | Pointer to a variable where the pointer to the location is returned in. |
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.
writer | Writer object. |
location | Location ID. |
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.
writer | Writer object. | |
[out] | numberOfEvents | Return pointer to the number of events. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
stopTime | The time the buffer flush finished. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
measurementMode | Is the measurement turned on (OTF2_MEASUREMENT_ON) or off (OTF2_MEASUREMENT_OFF)? |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
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. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
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. |
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).
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
receiver | MPI rank of receiver in communicator . |
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. |
msgTag | Message tag |
msgLength | Message length |
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).
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
receiver | MPI rank of receiver in communicator . |
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. |
msgTag | Message tag |
msgLength | Message length |
requestID | ID of the related request |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
requestID | ID of the related request |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
requestID | ID of the requested receive |
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).
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
sender | MPI rank of sender in communicator . |
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. |
msgTag | Message tag |
msgLength | Message length |
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).
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
sender | MPI rank of sender in communicator . |
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. |
msgTag | Message tag |
msgLength | Message length |
requestID | ID of the related request |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
requestID | ID of the related request |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
requestID | ID of the related request |
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.).
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
collectiveOp | Determines which collective operation it is. |
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. |
root | MPI rank of root in communicator or OTF2_UNDEFINED_UINT32 if the call has no root rank. |
sizeSent | Size of the sent message. |
sizeReceived | Size of the received message. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
numberOfRequestedThreads | Requested size of the team. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
lockID | ID of the lock. |
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. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
lockID | ID of the lock. |
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. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
taskID | Identifier of the newly created task instance. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
taskID | Identifier of the now active task instance. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
taskID | Identifier of the completed task instance. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
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. |
numberOfMetrics | Number of metrics with in the set. |
typeIDs | List of metric types. These types must match that of the corresponding MetricMember definitions. |
metricValues | List of metric values. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
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. |
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. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
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. |
value | Value of the recorded parameter. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
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. |
value | Value of the recorded parameter. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
win | ID 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. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
win | ID 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. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
collectiveOp | Determines which collective operation it is. |
syncLevel | Synchronization level of this collective operation. |
win | ID 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. |
root | Root process for this operation or OTF2_UNDEFINED_UINT32 if the call has no root rank. |
bytesSent | Bytes sent in operation. |
bytesReceived | Bytes receives in operation. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
syncLevel | Synchronization level of this collective operation. |
win | ID 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. |
group | Group 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. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
win | ID 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. |
remote | Rank of the locked remote process or OTF2_UNDEFINED_UINT32 if all processes of the specified window are locked. |
lockId | ID of the lock acquired, if multiple locks are defined on a window. |
lockType | Type of lock acquired. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
win | ID 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. |
remote | Rank of the locked remote process or OTF2_UNDEFINED_UINT32 if all processes of the specified window are locked. |
lockId | ID of the lock acquired, if multiple locks are defined on a window. |
lockType | Type of lock acquired. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
win | ID 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. |
remote | Rank of the locked remote process or OTF2_UNDEFINED_UINT32 if all processes of the specified window are locked. |
lockId | ID of the lock acquired, if multiple locks are defined on a window. |
lockType | Type of lock acquired. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
win | ID 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. |
remote | Rank of the locked remote process or OTF2_UNDEFINED_UINT32 if all processes of the specified window are locked. |
lockId | ID of the lock released, if multiple locks are defined on a window. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
win | ID 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. |
remote | Rank of the locked remote process. |
syncType | Type of synchronization. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
win | ID 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. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
win | ID 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. |
remote | Rank of the target process. |
bytes | Bytes sent to target. |
matchingId | ID used for matching the corresponding completion record. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
win | ID 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. |
remote | Rank of the target process. |
bytes | Bytes received from target. |
matchingId | ID used for matching the corresponding completion record. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
win | ID 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. |
remote | Rank of the target process. |
type | Type of atomic operation. |
bytesSent | Bytes sent to target. |
bytesReceived | Bytes received from target. |
matchingId | ID used for matching the corresponding completion record. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
win | ID 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. |
matchingId | ID used for matching the corresponding RMA operation record. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
win | ID 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. |
matchingId | ID used for matching the corresponding RMA operation record. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
win | ID 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. |
matchingId | ID used for matching the corresponding RMA operation record. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
win | ID 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. |
matchingId | ID used for matching the corresponding RMA operation record. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
model | The threading paradigm this event took place. |
numberOfRequestedThreads | Requested size of the team. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
model | The threading paradigm this event took place. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
threadTeam | Thread team References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
threadTeam | Thread team References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
model | The threading paradigm this event took place. |
lockID | ID of the lock. |
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. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
model | The threading paradigm this event took place. |
lockID | ID of the lock. |
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. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
threadTeam | Thread team References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available. |
creatingThread | Creating thread of this task. |
generationNumber | Thread-private generation number of task's creating thread. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
threadTeam | Thread team References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available. |
creatingThread | Creating thread of this task. |
generationNumber | Thread-private generation number of task's creating thread. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
threadTeam | Thread team References a Comm definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_COMM is available. |
creatingThread | Creating thread of this task. |
generationNumber | Thread-private generation number of task's creating thread. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
threadContingent | The 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. |
sequenceCount | A threadContingent unique number. The corresponding ThreadBegin event does have the same number. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
threadContingent | The 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. |
sequenceCount | A threadContingent unique number. The corresponding ThreadCreate event does have the same number. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
threadContingent | The 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. |
sequenceCount | A threadContingent unique number. The corresponding ThreadEnd event does have the same number. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
threadContingent | The 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. |
sequenceCount | A threadContingent unique number. The corresponding ThreadWait event does have the same number. OTF2_UNDEFINED_UINT64 in case no corresponding ThreadWait event exists. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
callingContext | The 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. |
unwindDistance | The unwindDistance for this callingContext . See the description in CallingContext. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
callingContext | The 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. |
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.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
callingContext | Describes 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. |
unwindDistance | The unwindDistance for this callingContext . See the description in CallingContext. |
interruptGenerator | References a InterruptGenerator definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_INTERRUPT_GENERATOR is available. |
OTF2_ErrorCode OTF2_EvtWriter_IoCreateHandle | ( | OTF2_EvtWriter * | writer, |
OTF2_AttributeList * | attributeList, | ||
OTF2_TimeStamp | time, | ||
OTF2_IoHandleRef | handle, | ||
OTF2_IoAccessMode | mode, | ||
OTF2_IoCreationFlag | creationFlags, | ||
OTF2_IoStatusFlag | statusFlags | ||
) |
Records a IoCreateHandle event.
An IoCreateHandle record marks the creation of a new active I/O handle that can be used by subsequent I/O operation events.
An IoHandle is active between a pair of consecutive IoCreateHandle and IoDestroyHandle events. All Locations of a LocationGroup have access to an active IoHandle.
If the Comm attribute of the IoHandle handle is not OTF2_UNDEFINED_COMM, this is a collective operation over Comm.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
handle | A previously inactive I/O handle which will be activated by this record. References a IoHandle definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_IO_HANDLE is available. |
mode | Determines which I/O operations can be applied to this I/O handle (e.g., read-only, write-only, read- write). |
creationFlags | Requested I/O handle creation flags (e.g., create, exclusive, etc.). |
statusFlags | I/O handle status flags which will be associated with the handle attribute (e.g., append, create, close-on-exec, async, etc). |
OTF2_ErrorCode OTF2_EvtWriter_IoDestroyHandle | ( | OTF2_EvtWriter * | writer, |
OTF2_AttributeList * | attributeList, | ||
OTF2_TimeStamp | time, | ||
OTF2_IoHandleRef | handle | ||
) |
Records a IoDestroyHandle event.
An IoDestroyHandle record marks the end of an active I/O handle's lifetime.
An IoHandle is active between a pair of consecutive IoCreateHandle and IoDestroyHandle events. All Locations of a LocationGroup have access to an active IoHandle.
If the Comm attribute of the IoHandle handle is not OTF2_UNDEFINED_COMM, this is a collective operation over Comm.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
handle | An active I/O handle which will be inactivated by this records. References a IoHandle definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_IO_HANDLE is available. |
OTF2_ErrorCode OTF2_EvtWriter_IoDuplicateHandle | ( | OTF2_EvtWriter * | writer, |
OTF2_AttributeList * | attributeList, | ||
OTF2_TimeStamp | time, | ||
OTF2_IoHandleRef | oldHandle, | ||
OTF2_IoHandleRef | newHandle, | ||
OTF2_IoStatusFlag | statusFlags | ||
) |
Records a IoDuplicateHandle event.
An IoDuplicateHandle record marks the duplication of an already existing active I/O handle.
The new I/O handle newHandle
is active after this event.
Both IoHandles must reference the same Comm definition or be OTF2_UNDEFINED_COMM. If the Comm attribute of the IoHandle handles is not OTF2_UNDEFINED_COMM, this is a collective operation over Comm.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
oldHandle | An active I/O handle. References a IoHandle definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_IO_HANDLE is available. |
newHandle | A previously inactive I/O handle which will be activated by this record. References a IoHandle definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_IO_HANDLE is available. |
statusFlags | The status flag for the new I/O handle newHandle . No status flags will be inherited from the I/O handle oldHandle . |
OTF2_ErrorCode OTF2_EvtWriter_IoSeek | ( | OTF2_EvtWriter * | writer, |
OTF2_AttributeList * | attributeList, | ||
OTF2_TimeStamp | time, | ||
OTF2_IoHandleRef | handle, | ||
int64_t | offsetRequest, | ||
OTF2_IoSeekOption | whence, | ||
uint64_t | offsetResult | ||
) |
Records a IoSeek event.
An IoSeek record marks a change of the position, e.g., within a file.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
handle | An active I/O handle. References a IoHandle definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_IO_HANDLE is available. |
offsetRequest | Requested offset. |
whence | Position inside the file from where offsetRequest should be applied (e.g., absolute from the start or end, relative to the current position). |
offsetResult | Resulting offset, e.g., within the file relative to the beginning of the file. |
OTF2_ErrorCode OTF2_EvtWriter_IoChangeStatusFlags | ( | OTF2_EvtWriter * | writer, |
OTF2_AttributeList * | attributeList, | ||
OTF2_TimeStamp | time, | ||
OTF2_IoHandleRef | handle, | ||
OTF2_IoStatusFlag | statusFlags | ||
) |
Records a IoChangeStatusFlags event.
An IoChangeStatusFlags record marks a change to the status flags associated with an active I/O handle.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
handle | An active I/O handle. References a IoHandle definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_IO_HANDLE is available. |
statusFlags | Set flags (e.g., close-on-exec, append, etc.). |
OTF2_ErrorCode OTF2_EvtWriter_IoDeleteFile | ( | OTF2_EvtWriter * | writer, |
OTF2_AttributeList * | attributeList, | ||
OTF2_TimeStamp | time, | ||
OTF2_IoParadigmRef | ioParadigm, | ||
OTF2_IoFileRef | file | ||
) |
Records a IoDeleteFile event.
An IoDeleteFile record marks the deletion of an I/O file.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
ioParadigm | The I/O paradigm which induced the deletion. References a IoParadigm definition. |
file | File identifier. References a IoRegularFile, or a IoDirectory definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_IO_FILE is available. |
OTF2_ErrorCode OTF2_EvtWriter_IoOperationBegin | ( | OTF2_EvtWriter * | writer, |
OTF2_AttributeList * | attributeList, | ||
OTF2_TimeStamp | time, | ||
OTF2_IoHandleRef | handle, | ||
OTF2_IoOperationMode | mode, | ||
OTF2_IoOperationFlag | operationFlags, | ||
uint64_t | bytesRequest, | ||
uint64_t | matchingId | ||
) |
Records a IoOperationBegin event.
An IoOperationBegin record marks the begin of a file operation (read, write, etc.).
See Event order for I/O operation records for the possible event orders.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
handle | An active I/O handle. References a IoHandle definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_IO_HANDLE is available. |
mode | Mode of an I/O handle operation (e.g., read or write). |
operationFlags | Special semantic of this operation. |
bytesRequest | Requested bytes to write/read. |
matchingId | Identifier used to correlate associated event records of an I/O operation. This identifier is unique for the referenced IoHandle. |
OTF2_ErrorCode OTF2_EvtWriter_IoOperationTest | ( | OTF2_EvtWriter * | writer, |
OTF2_AttributeList * | attributeList, | ||
OTF2_TimeStamp | time, | ||
OTF2_IoHandleRef | handle, | ||
uint64_t | matchingId | ||
) |
Records a IoOperationTest event.
An IoOperationTest record marks an unsuccessful test whether an I/O operation has already finished.
See Event order for I/O operation records for the possible event orders.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
handle | An active I/O handle. References a IoHandle definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_IO_HANDLE is available. |
matchingId | Identifier used to correlate associated event records of an I/O operation. This identifier is unique for the referenced IoHandle. |
OTF2_ErrorCode OTF2_EvtWriter_IoOperationIssued | ( | OTF2_EvtWriter * | writer, |
OTF2_AttributeList * | attributeList, | ||
OTF2_TimeStamp | time, | ||
OTF2_IoHandleRef | handle, | ||
uint64_t | matchingId | ||
) |
Records a IoOperationIssued event.
An IoOperationIssued record marks the successful initiation of a non- blocking operation (read, write etc.) on an active I/O handle.
See Event order for I/O operation records for the possible event orders.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
handle | An active I/O handle. References a IoHandle definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_IO_HANDLE is available. |
matchingId | Identifier used to correlate associated event records of an I/O operation. This identifier is unique for the referenced IoHandle. |
OTF2_ErrorCode OTF2_EvtWriter_IoOperationComplete | ( | OTF2_EvtWriter * | writer, |
OTF2_AttributeList * | attributeList, | ||
OTF2_TimeStamp | time, | ||
OTF2_IoHandleRef | handle, | ||
uint64_t | bytesResult, | ||
uint64_t | matchingId | ||
) |
Records a IoOperationComplete event.
An IoOperationComplete record marks the end of a file operation (read, write etc.) on an active I/O handle.
See Event order for I/O operation records for the possible event orders.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
handle | An active I/O handle. References a IoHandle definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_IO_HANDLE is available. |
bytesResult | Number of actual transferred bytes. |
matchingId | Identifier used to correlate associated event records of an I/O operation. This identifier is unique for the referenced IoHandle. |
OTF2_ErrorCode OTF2_EvtWriter_IoOperationCancelled | ( | OTF2_EvtWriter * | writer, |
OTF2_AttributeList * | attributeList, | ||
OTF2_TimeStamp | time, | ||
OTF2_IoHandleRef | handle, | ||
uint64_t | matchingId | ||
) |
Records a IoOperationCancelled event.
An IoOperationCancelled record marks the successful cancellation of a non-blocking operation (read, write etc.) on an active I/O handle.
See Event order for I/O operation records for the possible event orders.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
handle | An active I/O handle. References a IoHandle definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_IO_HANDLE is available. |
matchingId | Identifier used to correlate associated event records of an I/O operation. This identifier is unique for the referenced IoHandle. |
OTF2_ErrorCode OTF2_EvtWriter_IoAcquireLock | ( | OTF2_EvtWriter * | writer, |
OTF2_AttributeList * | attributeList, | ||
OTF2_TimeStamp | time, | ||
OTF2_IoHandleRef | handle, | ||
OTF2_LockType | lockType | ||
) |
Records a IoAcquireLock event.
An IoAcquireLock record marks the acquisition of an I/O lock.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
handle | An active I/O handle. References a IoHandle definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_IO_HANDLE is available. |
lockType | Type of the lock. |
OTF2_ErrorCode OTF2_EvtWriter_IoReleaseLock | ( | OTF2_EvtWriter * | writer, |
OTF2_AttributeList * | attributeList, | ||
OTF2_TimeStamp | time, | ||
OTF2_IoHandleRef | handle, | ||
OTF2_LockType | lockType | ||
) |
Records a IoReleaseLock event.
An IoReleaseLock record marks the release of an I/O lock.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
handle | An active I/O handle. References a IoHandle definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_IO_HANDLE is available. |
lockType | Type of the lock. |
OTF2_ErrorCode OTF2_EvtWriter_IoTryLock | ( | OTF2_EvtWriter * | writer, |
OTF2_AttributeList * | attributeList, | ||
OTF2_TimeStamp | time, | ||
OTF2_IoHandleRef | handle, | ||
OTF2_LockType | lockType | ||
) |
Records a IoTryLock event.
An IoTryLock record marks when an I/O lock was requested but not granted.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
handle | An active I/O handle. References a IoHandle definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_IO_HANDLE is available. |
lockType | Type of the lock. |
OTF2_ErrorCode OTF2_EvtWriter_ProgramBegin | ( | OTF2_EvtWriter * | writer, |
OTF2_AttributeList * | attributeList, | ||
OTF2_TimeStamp | time, | ||
OTF2_StringRef | programName, | ||
uint32_t | numberOfArguments, | ||
const OTF2_StringRef * | programArguments | ||
) |
Records a ProgramBegin event.
The ProgramBegin record marks the begin of the program.
This event is restricted to happen at most once on any Location in a LocationGroup that is of type OTF2_LOCATION_GROUP_TYPE_PROCESS.
If there is a ProgramBegin record, a corresponding ProgramEnd record on any Location in the same LocationGroup is mandatory and vice versa.
None of the timestamps recorded within the same LocationGroup must be smaller than ProgramBegin's timestamp.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
programName | The name of the program. References a String definition and will be mapped to the global definition if a mapping table of type OTF2_MAPPING_STRING is available. |
numberOfArguments | Number of additional arguments to the program. |
programArguments | List of additional arguments to the program. |
OTF2_ErrorCode OTF2_EvtWriter_ProgramEnd | ( | OTF2_EvtWriter * | writer, |
OTF2_AttributeList * | attributeList, | ||
OTF2_TimeStamp | time, | ||
int64_t | exitStatus | ||
) |
Records a ProgramEnd event.
The ProgramEnd record marks the end of the program.
This event is restricted to happen at most once on any Location in a LocationGroup that is of type OTF2_LOCATION_GROUP_TYPE_PROCESS.
If there is a ProgramEnd record, a corresponding ProgramBegin record on any Location in the same LocationGroup is mandatory, and vice versa.
None of the timestamps recorded within the same LocationGroup must be larger than ProgramEnd's timestamp.
writer | Writer object. |
attributeList | Generic attributes for the event. |
time | The time for this event. |
exitStatus | The exit status of the program. Note, that on some systems only the least significant 8 bits may be visible to other processes. Use OTF2_UNDEFINED_INT64, if the exit status was not available. |
OTF2_ErrorCode OTF2_EvtWriter_StoreRewindPoint | ( | OTF2_EvtWriter * | writer, |
uint32_t | rewindId | ||
) |
Please give me a documentation.
writer | Writer object. |
rewindId | Generic attributes for the event. |
OTF2_ErrorCode OTF2_EvtWriter_Rewind | ( | OTF2_EvtWriter * | writer, |
uint32_t | rewindId | ||
) |
Please give me a documentation.
writer | Writer object. |
rewindId | Generic attributes for the event. |
OTF2_ErrorCode OTF2_EvtWriter_ClearRewindPoint | ( | OTF2_EvtWriter * | writer, |
uint32_t | rewindId | ||
) |
Please give me a documentation.
writer | Writer object. |
rewindId | Generic attributes for the event. |