module ti.uia.runtime.CtxFilter

Context-aware Instrumentation Event Filtering infrastructure

C synopsis target-domain sourced in ti/uia/runtime/CtxFilter.xdc
#include <ti/uia/runtime/CtxFilter.h>
Functions
Bool 
Bool 
Bool 
Bool 
Bool 
Bool 
Void 
Bool 
Functions common to all target modules
Defines
#define
#define
#define
Typedefs
typedef Bits16 
 
 
const CtxFilter_ALWAYS_ENABLED

Event logging is not qualified by context

C synopsis target-domain
#define CtxFilter_ALWAYS_ENABLED (CtxFilter_Mask)0x0000
 
 
const CtxFilter_CONTEXT_DISABLED

Disable logging at the call site

C synopsis target-domain
#define CtxFilter_CONTEXT_DISABLED (CtxFilter_Mask)false
 
 
const CtxFilter_CONTEXT_ENABLED

Enable logging at the call site (subject to Diags.Mask)

C synopsis target-domain
#define CtxFilter_CONTEXT_ENABLED (CtxFilter_Mask)true
 
 
typedef CtxFilter_Mask

Type used to specify bits in the context mask

C synopsis target-domain
typedef Bits16 CtxFilter_Mask;
 
 
CtxFilter_isCtxEnabled()  // module-wide
C synopsis target-domain
Bool CtxFilter_isCtxEnabled();
 
 
CtxFilter_isLoggingEnabledForAppCtx()  // module-wide

optional function to enable context-aware filtering based on application context

C synopsis target-domain
Bool CtxFilter_isLoggingEnabledForAppCtx(Int newAppCtx);
 
ARGUMENTS
newAppCtx — the new application context id that has just been switched to
DETAILS
Configure the ti.uia.events.UIAAppCtx.IsLoggingEnabledFxn with the address of this function in order to enable context-aware filtering based on application context. Alternatively, you can write your own isLoggingEnabled function that provides additional filtering and logging capabilities (e.g. it can log sync points whenever the context changes).
RETURN
true if logging is enabled for this user context.
 
CtxFilter_isLoggingEnabledForChanCtx()  // module-wide

optional function to enable context-aware filtering based on channel context

C synopsis target-domain
Bool CtxFilter_isLoggingEnabledForChanCtx(Int newChanId);
 
ARGUMENTS
newChanId — the new channel ID that has just been switched to
DETAILS
Configure the ti.uia.events.UIAChanCtx.IsLoggingEnabledFxn with the address of this function in order to enable context-aware filtering based on channel context. Alternatively, you can write your own isLoggingEnabled function that provides additional filtering and logging capabilities (e.g. it can log sync points whenever the context changes).
RETURN
true if logging is enabled for this user context.
 
CtxFilter_isLoggingEnabledForFrameCtx()  // module-wide

optional function to enable context-aware filtering based on frame context

C synopsis target-domain
Bool CtxFilter_isLoggingEnabledForFrameCtx(Int newFrameId);
 
ARGUMENTS
newFrameId — the new Frame ID that has just been switched to
DETAILS
Configure the ti.uia.events.UIAFrameCtx.IsLoggingEnabledFxn with the address of this function in order to enable context-aware filtering based on frame context. Alternatively, you can write your own isLoggingEnabled function that provides additional filtering and logging capabilities (e.g. it can log sync points whenever the context changes).
RETURN
true if logging is enabled for this user context.
 
CtxFilter_isLoggingEnabledForThreadCtx()  // module-wide

optional function to enable context-aware filtering based on user context

C synopsis target-domain
Bool CtxFilter_isLoggingEnabledForThreadCtx(Int newThreadId);
 
ARGUMENTS
newThreadId — the new thread ID that has just been switched to
DETAILS
Configure the ti.uia.events.UIAThreadCtx.IsLoggingEnabledFxn with the address of this function in order to enable context-aware filtering based on thread context. Alternatively, you can write your own isLoggingEnabled function that provides additional filtering and logging capabilities (e.g. it can log sync points whenever the context changes).
RETURN
true if logging is enabled for this user context.
 
CtxFilter_isLoggingEnabledForUserCtx()  // module-wide

optional function to enable context-aware filtering based on user context

C synopsis target-domain
Bool CtxFilter_isLoggingEnabledForUserCtx(Int newUserCtx);
 
ARGUMENTS
newUserCtx — the new user context that has just been switched to
DETAILS
Configure the ti.uia.events.UIAUserCtx.IsLoggingEnabledFxn with the address of this function in order to enable context-aware filtering based on user context. Alternatively, you can write your own isLoggingEnabled function that provides additional filtering and logging capabilities (e.g. it can log sync points whenever the context changes).
RETURN
true if logging is enabled for this user context.
 
CtxFilter_setContextFilterFlags()  // module-wide

sets the context filter flags

C synopsis target-domain
Void CtxFilter_setContextFilterFlags(Bits16 flags);
 
ARGUMENTS
flags — bitfield of flags, one per context filter type
 
CtxFilter_setCtxEnabled()  // module-wide
C synopsis target-domain
Bool CtxFilter_setCtxEnabled(Bool value);
 
Module-Wide Built-Ins

C synopsis target-domain
Types_ModuleId CtxFilter_Module_id();
// Get this module's unique id
 
Bool CtxFilter_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle CtxFilter_Module_heap();
// The heap from which this module allocates memory
 
Bool CtxFilter_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 CtxFilter_Module_getMask();
// Returns the diagnostics mask for this module
 
Void CtxFilter_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
Configuration settings sourced in ti/uia/runtime/CtxFilter.xdc
var CtxFilter = xdc.useModule('ti.uia.runtime.CtxFilter');
module-wide constants & types
module-wide config parameters
 
 
const CtxFilter.ALWAYS_ENABLED

Event logging is not qualified by context

Configuration settings
const CtxFilter.ALWAYS_ENABLED = 0x0000;
 
C SYNOPSIS
 
const CtxFilter.CONTEXT_DISABLED

Disable logging at the call site

Configuration settings
const CtxFilter.CONTEXT_DISABLED = false;
 
C SYNOPSIS
 
const CtxFilter.CONTEXT_ENABLED

Enable logging at the call site (subject to Diags.Mask)

Configuration settings
const CtxFilter.CONTEXT_ENABLED = true;
 
C SYNOPSIS
 
metaonly config CtxFilter.common$  // module-wide

Common module configuration parameters

Configuration settings
CtxFilter.common$ = Types.Common$ undefined;
 
DETAILS
All modules have this configuration parameter. Its name contains the '$' character to ensure it does not conflict with configuration parameters declared by the module. This allows new configuration parameters to be added in the future without any chance of breaking existing modules.
generated on Tue, 14 Feb 2017 00:15:16 GMT