module ti.uia.events.UIAChanCtx

index URL

UIA Channel Context Instrumentation

*       C synopsis

*  Individual elements

*       DETAILS

*       EXAMPLES

The UIAChanCtx module defines context change events and methods that allow tooling to identify channel context switches and to enable channel-aware filtering, trace and analysis. [ more ... ]

C synopsis

target-domain

sourced in ti/uia/events/UIAChanCtx.h

#include <ti/uia/events/UIAChanCtx.h>

Functions

macro Int 

Bool 

UInt 

Typedefs

typedef Bool 

Constants

extern const Log_Event 

extern const Bits16 

extern const Bits16 

 

DETAILS

The UIAChanCtx module defines context change events and methods that allow tooling to identify channel context switches and to enable channel-aware filtering, trace and analysis.

It inherits IUIACtx, which defines a function pointer to an isLoggingEnabled function which, if configured to point to a function, will evaluate the function prior to logging the context change event and will determine whether to log the event based on the return value of the function. If the function is not configured, logging will be conditional upon ti_uia_runtime_CtxFilter_gIsLoggingEnabled.

The generation of UIAChanCtx events is also controlled by a module's diagnostics mask, which is described in details in xdc.runtime.Diags. UIAChanCtx` events are generated only when the Diags.ANALYSIS bit is set in the module's diagnostics mask.

The following configuration script demonstrates how the application might control the logging of ANALYSIS events embedded in the Mod module at configuration time. In this case, the configuration script arranges for the Log statements within modules to always generate ANALYSIS events. Without these configuration statements, no ANALYSIS events would be generated by any modules.

EXAMPLES

Example 1: The following example shows how to turn on and off logging of ANALYSIS event from the application source code. See the Diags_setMask() function for details on specifying the control string.

  // turn on logging of ANALYSIS events in the module
  Diags_setMask("my.pkg.Mod+Z");
 
  // turn off logging of ANALYSIS events in the module
  Diags_setMask("my.pkg.Mod-Z");

 

typedef UIAChanCtx_IsLoggingEnabledFxn

index URL

C synopsis

target-domain

typedef Bool (*UIAChanCtx_IsLoggingEnabledFxn)(Int);

 

 

config UIAChanCtx_ENABLEMASK  // module-wide

index URL

Ctx Filter Enable Mask

C synopsis

target-domain

extern const Bits16 UIAChanCtx_ENABLEMASK;

 

DETAILS

configures which bit of the ti_uia_runtime_CtxFilter_gFlags is assigned to control context aware filtering for frame context changes. Must be configured with a value that is 2**SYNCID.

 

config UIAChanCtx_SYNCID  // module-wide

index URL

Trace Synchronization ID

C synopsis

target-domain

extern const Bits16 UIAChanCtx_SYNCID;

 

DETAILS

configures the value to be written into the 4 bit context change type field used by the UIASync trace synchronization

 

config UIAChanCtx_ctxChg  // module-wide

index URL

Channel Context Change event

C synopsis

target-domain

extern const Log_Event UIAChanCtx_ctxChg;

 

VALUES

fmt — a constant string that describes the context change and provides a format specifier for newAppId

newChanId — an integer which uniquely identifies the new context

DETAILS

Used to log the start of a new channel Note that the previous channel Id is logged automatically by the ti_uia_runtime_LogCtxChg_thread API.

EXAMPLE

The following C code shows how to log a Context Change event that identifies a new channel ID

  #include <ti/uia/runtime/LogCtxChg.h>
  ...
  Void processChannel(Int chanId){
    ...
    LogCtxChg_channel("New chan ID=0x%x",chanId);
    ...
  }

This event prints the Log call site (%$F) and a format string (%$S) which is recursively formatted with any addition arguments. The following text is an example of what will be displayed for the event:

  "Channel Ctx Change at Line 123 in demo.c [Prev. chan ID=0x1234] New chan ID=0x1235"
 

 

config UIAChanCtx_isLoggingEnabledFxn  // module-wide

index URL

C synopsis

target-domain

extern const IUIACtx_IsLoggingEnabledFxn UIAChanCtx_isLoggingEnabledFxn;

 

 

UIAChanCtx_getCtxId()  // module-wide

index URL

Get the ID for the current channel

C synopsis

target-domain

macro Int UIAChanCtx_getCtxId();

 

RETURNS

returns the thread ID logged by the last call to UIAChanCtx_logCtxChg.

 

UIAChanCtx_isLoggingEnabled()  // module-wide

index URL

returns true if the new context matches the value to enable logging with

C synopsis

target-domain

Bool UIAChanCtx_isLoggingEnabled(UInt newChanId);

 

ARGUMENTS

newChanId — the new channel ID

DETAILS

Default implementation of the IUIACtx_IsLoggingEnabledFxn for user context. To enable context-aware filtering, assign UIAChanCtx_isLoggingEnabledFxn = &UIAChanCtx_isLoggingEnabled in the config script or programmatically, or assign your own implementation of this function.

RETURNS

true if logging is enabled

 

UIAChanCtx_setOldValue()  // module-wide

index URL

sets ti_uia_events_UIAChanCtx_gLastValue to the new value and returns the old value before it was updated

C synopsis

target-domain

UInt UIAChanCtx_setOldValue(UInt newValue);

 

ARGUMENTS

newValue — the new value to save in the global variable

(return0 the original value of the global variable before it was updated.

generated on Wed, 14 Mar 2012 16:46:04 GMT