module ti.uia.events.UIAThreadCtx

UIA Thread Context Instrumentation

C synopsis
Individual elements
DETAILS
EXAMPLES
XDCscript usage
Individual elements

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

C synopsis target-domain sourced in ti/uia/events/UIAThreadCtx.xdc

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

Functions
macro Int	UIAThreadCtx_getCtxId// Get the ID for the current thread();
Bool	UIAThreadCtx_isLoggingEnabled// returns true if the new context matches the value to enable logging with(UInt newThreadId);
UInt	UIAThreadCtx_setOldValue// sets ti_uia_events_UIAThreadCtx_gLastValue to the new value and returns the old value before it was updated(UInt newValue);
Functions common to all target modules
	UIAThreadCtx_Module_getMask// Returns the diagnostics mask for this module, UIAThreadCtx_Module_hasMask// Test whether this module has a diagnostics mask, UIAThreadCtx_Module_heap// The heap from which this module allocates memory, UIAThreadCtx_Module_id// Get this module's unique id, UIAThreadCtx_Module_setMask// Set the diagnostics mask for this module, UIAThreadCtx_Module_startupDone// Test if this module has completed startup
Typedefs
typedef Bool	(*UIAThreadCtx_IsLoggingEnabledFxn// )(Int);
Constants
extern const Log_Event	UIAThreadCtx_ctxChg// threadSwitch Context Change event;
extern const Log_Event	UIAThreadCtx_ctxChgWithFunc// threadSwitch Context Change event with prempted function and resumed function addresses;
extern const Bits16	UIAThreadCtx_ENABLEMASK// Ctx Filter Enable Mask;
extern const IUIACtx_IsLoggingEnabledFxn	UIAThreadCtx_isLoggingEnabledFxn// ;
extern const Bits16	UIAThreadCtx_SYNCID// Trace Synchronization ID;

DETAILS

The UIAThreadCtx module defines context change events and methods that allow tooling to identify thread context switches and to enable thread-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 store the return value of the function in ti_uia_runtime_CtxFilter_gIsLoggingEnabled, which is used to determine whether or not to log events.

The generation of UIAThreadCtx events is also controlled by a module's diagnostics mask, which is described in details in xdc.runtime.Diags. 'UIAThreadCtx` 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: This is part of the XDC configuration file for the application:

  var LogCtxChg = xdc.useModule('ti.uia.runtime.LogCtxChg'); 
  var Diags = xdc.useModule('xdc.runtime.Diags'); 
  var LoggerSys = xdc.useModule('xdc.runtime.LoggerSys'); 
  var Defaults = xdc.useModule('xdc.runtime.Defaults'); 
  var logger = LoggerSys.create(); 
   
  Defaults.common$.diags_ANALYSIS = Diags.ALWAYS_ON;  
  Defaults.common$.logger = logger;

Example 2: The following example configures a module to support logging of ANALYSIS events, but defers the actual activation and deactivation of the logging until runtime. See the Diags_setMask() function for details on specifying the control string.

This is a part of the XDC configuration file for the application:

  var LogCtxChg = xdc.useModule('ti.uia.runtime.LogCtxChg'); 
  var Diags = xdc.useModule('xdc.runtime.Diags'); 
  var Mod = xdc.useModule('my.pkg.Mod'); 
 
  Mod.common$.diags_ANALYSIS = Diags.RUNTIME_OFF;

This is a part of the C code for the application:

  // 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 UIAThreadCtx_IsLoggingEnabledFxn