Percepio Trace Recorder v4.8.0.hotfix1
Loading...
Searching...
No Matches
Trace Runnable APIs

Macros

#define xTraceRunnableStart(xRunnableHandle)   xTraceEventCreate1(PSF_EVENT_RUNNABLE_START, (TraceUnsignedBaseType_t)(xRunnableHandle))
 Creates an event indicating a runnable started.
 
#define xTraceRunnableStop()   xTraceEventCreate0(PSF_EVENT_RUNNABLE_STOP)
 Creates an event indicating a runnable stopped.
 
#define xTraceRunnableRegisterStaticSet(szName, uiMajor, uiMinor, uiPatch, uiRunnableCount, pxRunnableSetHandle)   xTraceExtensionCreate(szName, uiMajor, uiMinor, uiPatch, uiRunnableCount, pxRunnableSetHandle)
 Registers a set of static runnables. Requires XML configuration to properly interpret.
 
#define xTraceRunnableStartStatic(xRunnableSetHandle, uiRunnableId)   xTraceEventCreate0(xTraceExtensionGetEventId(xRunnableSetHandle, uiRunnableId))
 Start a static runnable. Requires XML configuration to properly interpret.
 
#define xTraceRunnableStopStatic()   xTraceRunnableStop()
 Stop a static runnable. Requires XML configuration to properly interpret.
 

Functions

traceResult xTraceRunnableRegister (const char *szName, TraceRunnableRegisterMethod_t uxRegisterMethod, TraceRunnableHandle_t *pxRunnableHandle)
 Registers a runnable. Can be called multiple times, will not create additional entries.
 

Detailed Description

Macro Definition Documentation

◆ xTraceRunnableRegisterStaticSet

#define xTraceRunnableRegisterStaticSet (   szName,
  uiMajor,
  uiMinor,
  uiPatch,
  uiRunnableCount,
  pxRunnableSetHandle 
)    xTraceExtensionCreate(szName, uiMajor, uiMinor, uiPatch, uiRunnableCount, pxRunnableSetHandle)

Registers a set of static runnables. Requires XML configuration to properly interpret.

Parameters
[in]szNameName.
[in]uiMajorMajor version.
[in]uiMinorMinor version.
[in]uiPatchPatch version.
[in]uiRunnableCountRunnables count.
[out]pxRunnableSetHandlePointer to uninitialized TraceRunnableStaticSetHandle_t.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceRunnableStart

#define xTraceRunnableStart (   xRunnableHandle)    xTraceEventCreate1(PSF_EVENT_RUNNABLE_START, (TraceUnsignedBaseType_t)(xRunnableHandle))

Creates an event indicating a runnable started.

Parameters
[in]xRunnableHandleRunnable handle.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceRunnableStartStatic

#define xTraceRunnableStartStatic (   xRunnableSetHandle,
  uiRunnableId 
)    xTraceEventCreate0(xTraceExtensionGetEventId(xRunnableSetHandle, uiRunnableId))

Start a static runnable. Requires XML configuration to properly interpret.

Parameters
[in]xRunnableSetHandlePointer to initialized runnable set handle.
[out]puiBaseEventIdBase event id.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceRunnableStop

#define xTraceRunnableStop ( )    xTraceEventCreate0(PSF_EVENT_RUNNABLE_STOP)

Creates an event indicating a runnable stopped.

Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceRunnableStopStatic

#define xTraceRunnableStopStatic ( )    xTraceRunnableStop()

Stop a static runnable. Requires XML configuration to properly interpret.

Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

Function Documentation

◆ xTraceRunnableRegister()

traceResult xTraceRunnableRegister ( const char *  szName,
TraceRunnableRegisterMethod_t  uxRegisterMethod,
TraceRunnableHandle_t *  pxRunnableHandle 
)

Registers a runnable. Can be called multiple times, will not create additional entries.

Parameters
[in]szNameName.
[in]uxRegisterMethodIndicates how to register the runnable. Since there can be thousands of runnables, storing in entry table is not always a good idea. TRC_RUNNABLE_REGISTER_METHOD_USE_ENTRY_TABLE: Store in entry table normally and handle will point to entry. TRC_RUNNABLE_REGISTER_METHOD_USE_STRING_ADDRESS: For this method the string address must be unique and will be used as handle value. TRC_RUNNABLE_REGISTER_METHOD_USE_HANDLE_ADDRESS: For this method the handle address must be unique and will be used as handle value.
[out]pxRunnableHandlePointer to 0 initialized TraceRunnableHandle_t. If handle that is pointed to is not 0 no entry will be created.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess