1.4 (revision 3771)
Typedefs | Functions
otf2/OTF2_EventSizeEstimator.h File Reference

Provides a interface to estimate the size of an resulting trace file. More...

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

Go to the source code of this file.

Typedefs

typedef struct
OTF2_EventSizeEstimator 
OTF2_EventSizeEstimator
 Keeps all necessary information about the event size estimator. See OTF2_EventSizeEstimator_struct for detailed information.

Functions

OTF2_ErrorCode OTF2_EventSizeEstimator_Delete (OTF2_EventSizeEstimator *estimator)
 Deletes an OTF2_EventSizeEstimator object.
size_t OTF2_EventSizeEstimator_GetSizeOfAttributeList (const OTF2_EventSizeEstimator *estimator, const OTF2_AttributeList *attributeList)
 Returns the size estimate for an attribute list.
size_t OTF2_EventSizeEstimator_GetSizeOfBufferFlushEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the BufferFlush event.
size_t OTF2_EventSizeEstimator_GetSizeOfEnterEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the Enter event.
size_t OTF2_EventSizeEstimator_GetSizeOfLeaveEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the Leave event.
size_t OTF2_EventSizeEstimator_GetSizeOfMeasurementOnOffEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the MeasurementOnOff event.
size_t OTF2_EventSizeEstimator_GetSizeOfMetricEvent (OTF2_EventSizeEstimator *estimator, uint8_t numberOfMetrics)
 Calculates the size estimate for the Metric event.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiCollectiveBeginEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the MpiCollectiveBegin event.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiCollectiveEndEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the MpiCollectiveEnd event.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiIrecvEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the MpiIrecv event.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiIrecvRequestEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the MpiIrecvRequest event.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiIsendCompleteEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the MpiIsendComplete event.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiIsendEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the MpiIsend event.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiRecvEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the MpiRecv event.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiRequestCancelledEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the MpiRequestCancelled event.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiRequestTestEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the MpiRequestTest event.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiSendEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the MpiSend event.
size_t OTF2_EventSizeEstimator_GetSizeOfOmpAcquireLockEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the OmpAcquireLock event.
size_t OTF2_EventSizeEstimator_GetSizeOfOmpForkEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the OmpFork event.
size_t OTF2_EventSizeEstimator_GetSizeOfOmpJoinEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the OmpJoin event.
size_t OTF2_EventSizeEstimator_GetSizeOfOmpReleaseLockEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the OmpReleaseLock event.
size_t OTF2_EventSizeEstimator_GetSizeOfOmpTaskCompleteEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the OmpTaskComplete event.
size_t OTF2_EventSizeEstimator_GetSizeOfOmpTaskCreateEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the OmpTaskCreate event.
size_t OTF2_EventSizeEstimator_GetSizeOfOmpTaskSwitchEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the OmpTaskSwitch event.
size_t OTF2_EventSizeEstimator_GetSizeOfParameterIntEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the ParameterInt event.
size_t OTF2_EventSizeEstimator_GetSizeOfParameterStringEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the ParameterString event.
size_t OTF2_EventSizeEstimator_GetSizeOfParameterUnsignedIntEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the ParameterUnsignedInt event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaAcquireLockEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the RmaAcquireLock event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaAtomicEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the RmaAtomic event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaCollectiveBeginEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the RmaCollectiveBegin event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaCollectiveEndEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the RmaCollectiveEnd event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaGetEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the RmaGet event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaGroupSyncEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the RmaGroupSync event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaOpCompleteBlockingEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the RmaOpCompleteBlocking event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaOpCompleteNonBlockingEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the RmaOpCompleteNonBlocking event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaOpCompleteRemoteEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the RmaOpCompleteRemote event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaOpTestEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the RmaOpTest event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaPutEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the RmaPut event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaReleaseLockEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the RmaReleaseLock event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaRequestLockEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the RmaRequestLock event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaSyncEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the RmaSync event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaTryLockEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the RmaTryLock event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaWaitChangeEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the RmaWaitChange event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaWinCreateEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the RmaWinCreate event.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaWinDestroyEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the RmaWinDestroy event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadAcquireLockEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the ThreadAcquireLock event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadBeginEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the ThreadBegin event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadCreateEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the ThreadCreate event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadEndEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the ThreadEnd event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadForkEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the ThreadFork event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadJoinEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the ThreadJoin event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadReleaseLockEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the ThreadReleaseLock event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadTaskCompleteEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the ThreadTaskComplete event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadTaskCreateEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the ThreadTaskCreate event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadTaskSwitchEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the ThreadTaskSwitch event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadTeamBeginEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the ThreadTeamBegin event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadTeamEndEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the ThreadTeamEnd event.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadWaitEvent (OTF2_EventSizeEstimator *estimator)
 Calculates the size estimate for the ThreadWait event.
size_t OTF2_EventSizeEstimator_GetSizeOfTimestamp (OTF2_EventSizeEstimator *estimator)
 Returns the size for an timestamp record.
OTF2_EventSizeEstimatorOTF2_EventSizeEstimator_New (void)
 Creates a new OTF2_EventSizeEstimator object.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfAttributeDefinitions (OTF2_EventSizeEstimator *estimator, uint32_t numberOfAttributeDefinitions)
 Sets the number of Attribute definitions used.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfCommDefinitions (OTF2_EventSizeEstimator *estimator, uint32_t numberOfCommDefinitions)
 Sets the number of Comm definitions used.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfGroupDefinitions (OTF2_EventSizeEstimator *estimator, uint32_t numberOfGroupDefinitions)
 Sets the number of Group definitions used.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfLocationDefinitions (OTF2_EventSizeEstimator *estimator, uint64_t numberOfLocationDefinitions)
 Sets the number of Location definitions used.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfMetricDefinitions (OTF2_EventSizeEstimator *estimator, uint32_t numberOfMetricDefinitions)
 Sets the number of Metric definitions used.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfParameterDefinitions (OTF2_EventSizeEstimator *estimator, uint32_t numberOfParameterDefinitions)
 Sets the number of Parameter definitions used.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfRegionDefinitions (OTF2_EventSizeEstimator *estimator, uint32_t numberOfRegionDefinitions)
 Sets the number of Region definitions used.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfRmaWinDefinitions (OTF2_EventSizeEstimator *estimator, uint32_t numberOfRmaWinDefinitions)
 Sets the number of RmaWin definitions used.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfStringDefinitions (OTF2_EventSizeEstimator *estimator, uint32_t numberOfStringDefinitions)
 Sets the number of String definitions used.

Detailed Description

Provides a interface to estimate the size of an resulting trace file.

Source Template:
templates/OTF2_EventSizeEstimator.tmpl.h

Function Documentation

OTF2_ErrorCode OTF2_EventSizeEstimator_Delete ( OTF2_EventSizeEstimator estimator)

Deletes an OTF2_EventSizeEstimator object.

Parameters:
estimatorEstimator object.
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
size_t OTF2_EventSizeEstimator_GetSizeOfAttributeList ( const OTF2_EventSizeEstimator estimator,
const OTF2_AttributeList attributeList 
)

Returns the size estimate for an attribute list.

The attribute list should be filled with the used types. The attribute references are taken from the number of attribute definitions and the values are the upper bounds for integral and floating point types, and the estimates for definition references.

Parameters:
estimatorEstimator object.
attributeListAttribute List.
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfBufferFlushEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the BufferFlush event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfEnterEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the Enter event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfLeaveEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the Leave event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfMeasurementOnOffEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the MeasurementOnOff event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfMetricEvent ( OTF2_EventSizeEstimator estimator,
uint8_t  numberOfMetrics 
)

Calculates the size estimate for the Metric event.

Parameters:
estimatorEstimator object.
numberOfMetricsNumber of metrics with in the set.
Since:
Version 1.0
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiCollectiveBeginEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the MpiCollectiveBegin event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiCollectiveEndEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the MpiCollectiveEnd event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiIrecvEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the MpiIrecv event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiIrecvRequestEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the MpiIrecvRequest event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiIsendCompleteEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the MpiIsendComplete event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiIsendEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the MpiIsend event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiRecvEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the MpiRecv event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiRequestCancelledEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the MpiRequestCancelled event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiRequestTestEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the MpiRequestTest event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfMpiSendEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the MpiSend event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfOmpAcquireLockEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the OmpAcquireLock event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Deprecated:
In version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfOmpForkEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the OmpFork event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Deprecated:
In version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfOmpJoinEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the OmpJoin event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Deprecated:
In version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfOmpReleaseLockEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the OmpReleaseLock event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Deprecated:
In version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfOmpTaskCompleteEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the OmpTaskComplete event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Deprecated:
In version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfOmpTaskCreateEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the OmpTaskCreate event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Deprecated:
In version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfOmpTaskSwitchEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the OmpTaskSwitch event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Deprecated:
In version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfParameterIntEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the ParameterInt event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfParameterStringEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the ParameterString event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfParameterUnsignedIntEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the ParameterUnsignedInt event.

Parameters:
estimatorEstimator object.
Since:
Version 1.0
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaAcquireLockEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the RmaAcquireLock event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaAtomicEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the RmaAtomic event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaCollectiveBeginEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the RmaCollectiveBegin event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaCollectiveEndEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the RmaCollectiveEnd event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaGetEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the RmaGet event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaGroupSyncEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the RmaGroupSync event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaOpCompleteBlockingEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the RmaOpCompleteBlocking event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaOpCompleteNonBlockingEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the RmaOpCompleteNonBlocking event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaOpCompleteRemoteEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the RmaOpCompleteRemote event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaOpTestEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the RmaOpTest event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaPutEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the RmaPut event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaReleaseLockEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the RmaReleaseLock event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaRequestLockEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the RmaRequestLock event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaSyncEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the RmaSync event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaTryLockEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the RmaTryLock event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaWaitChangeEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the RmaWaitChange event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaWinCreateEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the RmaWinCreate event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfRmaWinDestroyEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the RmaWinDestroy event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadAcquireLockEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the ThreadAcquireLock event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadBeginEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the ThreadBegin event.

Parameters:
estimatorEstimator object.
Since:
Version 1.3
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadCreateEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the ThreadCreate event.

Parameters:
estimatorEstimator object.
Since:
Version 1.3
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadEndEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the ThreadEnd event.

Parameters:
estimatorEstimator object.
Since:
Version 1.3
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadForkEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the ThreadFork event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadJoinEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the ThreadJoin event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadReleaseLockEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the ThreadReleaseLock event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadTaskCompleteEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the ThreadTaskComplete event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadTaskCreateEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the ThreadTaskCreate event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadTaskSwitchEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the ThreadTaskSwitch event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadTeamBeginEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the ThreadTeamBegin event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadTeamEndEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the ThreadTeamEnd event.

Parameters:
estimatorEstimator object.
Since:
Version 1.2
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfThreadWaitEvent ( OTF2_EventSizeEstimator estimator)

Calculates the size estimate for the ThreadWait event.

Parameters:
estimatorEstimator object.
Since:
Version 1.3
Returns:
The estimated size.
size_t OTF2_EventSizeEstimator_GetSizeOfTimestamp ( OTF2_EventSizeEstimator estimator)

Returns the size for an timestamp record.

OTF2 does only store a timestamp, if it changed between two events.

Parameters:
estimatorEstimator object.
Returns:
The estimated size.
OTF2_EventSizeEstimator* OTF2_EventSizeEstimator_New ( void  )

Creates a new OTF2_EventSizeEstimator object.

Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfAttributeDefinitions ( OTF2_EventSizeEstimator estimator,
uint32_t  numberOfAttributeDefinitions 
)

Sets the number of Attribute definitions used.

Definition ids are considered to be in the range [0, numberOfAttributeDefinitions).

Parameters:
estimatorEstimator object.
numberOfAttributeDefinitionsThe number of definitions.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfCommDefinitions ( OTF2_EventSizeEstimator estimator,
uint32_t  numberOfCommDefinitions 
)

Sets the number of Comm definitions used.

Definition ids are considered to be in the range [0, numberOfCommDefinitions).

Parameters:
estimatorEstimator object.
numberOfCommDefinitionsThe number of definitions.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfGroupDefinitions ( OTF2_EventSizeEstimator estimator,
uint32_t  numberOfGroupDefinitions 
)

Sets the number of Group definitions used.

Definition ids are considered to be in the range [0, numberOfGroupDefinitions).

Parameters:
estimatorEstimator object.
numberOfGroupDefinitionsThe number of definitions.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfLocationDefinitions ( OTF2_EventSizeEstimator estimator,
uint64_t  numberOfLocationDefinitions 
)

Sets the number of Location definitions used.

Definition ids are considered to be in the range [0, numberOfLocationDefinitions).

Parameters:
estimatorEstimator object.
numberOfLocationDefinitionsThe number of definitions.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfMetricDefinitions ( OTF2_EventSizeEstimator estimator,
uint32_t  numberOfMetricDefinitions 
)

Sets the number of Metric definitions used.

Definition ids are considered to be in the range [0, numberOfMetricDefinitions).

Parameters:
estimatorEstimator object.
numberOfMetricDefinitionsThe number of definitions.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfParameterDefinitions ( OTF2_EventSizeEstimator estimator,
uint32_t  numberOfParameterDefinitions 
)

Sets the number of Parameter definitions used.

Definition ids are considered to be in the range [0, numberOfParameterDefinitions).

Parameters:
estimatorEstimator object.
numberOfParameterDefinitionsThe number of definitions.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfRegionDefinitions ( OTF2_EventSizeEstimator estimator,
uint32_t  numberOfRegionDefinitions 
)

Sets the number of Region definitions used.

Definition ids are considered to be in the range [0, numberOfRegionDefinitions).

Parameters:
estimatorEstimator object.
numberOfRegionDefinitionsThe number of definitions.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfRmaWinDefinitions ( OTF2_EventSizeEstimator estimator,
uint32_t  numberOfRmaWinDefinitions 
)

Sets the number of RmaWin definitions used.

Definition ids are considered to be in the range [0, numberOfRmaWinDefinitions).

Parameters:
estimatorEstimator object.
numberOfRmaWinDefinitionsThe number of definitions.
Since:
Version 1.2
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.
OTF2_ErrorCode OTF2_EventSizeEstimator_SetNumberOfStringDefinitions ( OTF2_EventSizeEstimator estimator,
uint32_t  numberOfStringDefinitions 
)

Sets the number of String definitions used.

Definition ids are considered to be in the range [0, numberOfStringDefinitions).

Parameters:
estimatorEstimator object.
numberOfStringDefinitionsThe number of definitions.
Since:
Version 1.0
Returns:
OTF2_SUCCESS if successful, an error code if an error occurs.