module ti.uia.runtime.LogCtxChg

Context Change Event logging manager for logging context change events

Allows context change events to be logged to a logger that is different from the one used by xdc.runtime.Log. [ more ... ]
C synopsis target-domain sourced in ti/uia/runtime/LogCtxChg.xdc
#include <ti/uia/runtime/LogCtxChg.h>
Functions
macro Void 
macro Void 
macro Void 
macro Void 
macro Void 
macro UInt32 
macro UInt32 
macro UInt32 
macro Void 
macro Void 
macro Void 
macro Void 
macro Void 
Functions common to all target modules
Constants
extern const Bool 
extern const Bool 
extern const Bool 
extern const Types_LoggerFxn2 
extern const Types_LoggerFxn8 
extern const Ptr 
 
DETAILS
Allows context change events to be logged to a logger that is different from the one used by xdc.runtime.Log.
Users can provide a special function to inject context change information into trace or log sync points whenever a context change is logged. See ctxFilterEnabled config parameter for more info.
 
config LogCtxChg_ctxFilterEnabled  // module-wide

set to true in the configuration script in order to enable context filtering

C synopsis target-domain
extern const Bool LogCtxChg_ctxFilterEnabled;
 
DETAILS
User can implement a custom function that is called instead of ti_uia_runtime_CtxFilter_isCtxEnabled() to control context-aware filtering. This function can also e.g. inject context information into the GEM trace or log sync point information if desired.
SEE
 
config LogCtxChg_isTimestampEnabled  // module-wide

used to enable or disable logging the 64b local CPU timestamp at the start of each event

C synopsis target-domain
extern const Bool LogCtxChg_isTimestampEnabled;
 
 
config LogCtxChg_loggerDefined  // module-wide

set to true in the configuration script when a logger that implements ILoggerSnapshot is attached

C synopsis target-domain
extern const Bool LogCtxChg_loggerDefined;
 
 
config LogCtxChg_loggerFxn2  // module-wide
C synopsis target-domain
extern const Types_LoggerFxn2 LogCtxChg_loggerFxn2;
 
 
config LogCtxChg_loggerFxn8  // module-wide
C synopsis target-domain
extern const Types_LoggerFxn8 LogCtxChg_loggerFxn8;
 
 
config LogCtxChg_loggerObj  // module-wide

handle of the logger that is to be used to log snapshot events

C synopsis target-domain
extern const Ptr LogCtxChg_loggerObj;
 
 
LogCtxChg_app()  // module-wide

Log a context change event that can be used to enable context-aware event filtering, context-aware profiling, etc

C synopsis target-domain
macro Void LogCtxChg_app(String fmt, IArg newAppId);
 
SEE
 
LogCtxChg_channel()  // module-wide

Log a context change event that can be used to enable context-aware event filtering, context-aware profiling, etc

C synopsis target-domain
macro Void LogCtxChg_channel(String fmt, IArg newChanId);
 
SEE
 
LogCtxChg_frame()  // module-wide

Log a context change event that can be used to enable context-aware event filtering, context-aware profiling, etc

C synopsis target-domain
macro Void LogCtxChg_frame(String fmt, IArg newFrameId);
 
SEE
 
LogCtxChg_hwiStart()  // module-wide

Log a context change event that can be used to enable context-aware event filtering, context-aware profiling, etc

C synopsis target-domain
macro Void LogCtxChg_hwiStart(String fmt, IArg hwiId);
 
SEE
 
LogCtxChg_hwiStop()  // module-wide

Log a context change event that can be used to enable context-aware event filtering, context-aware profiling, etc

C synopsis target-domain
macro Void LogCtxChg_hwiStop(String fmt, IArg hwiId);
 
SEE
 
LogCtxChg_putCtxChg1()  // module-wide

Unconditionally put the specified Types event along with file name, line number, fmt string and 1 arg

C synopsis target-domain
macro UInt32 LogCtxChg_putCtxChg1(Types_Event evt, Types_ModuleId mid, UInt32 syncPtSeqNum, IArg fmt, IArg arg1);
 
ARGUMENTS
evt — the Types event to put into the log
mask — the diags mask of the event
syncPtSeqNum — the sync point sequence number to log with the event for correlation with trace
fmt — a constant string that provides format specifiers for up to 6 additional parameters
arg1 — the context change argument to log
DETAILS
This method unconditionally puts the specified context changeTypes.Event evt into the log along with the fmt string, line and file name that the event was logged from, and one parameter
 
LogCtxChg_putCtxChg2()  // module-wide

Unconditionally put the specified Types event along with file name, line number, fmt string and 2 args

C synopsis target-domain
macro UInt32 LogCtxChg_putCtxChg2(Types_Event evt, Types_ModuleId mid, IArg a1, IArg a2);
 
ARGUMENTS
evt — the Types event to put into the log
mask — the diags mask of the event
a1 — the first context change argument to log
a2 — the second context change argument to log
DETAILS
This method unconditionally puts the specified context changeTypes.Event evt into the log along with the fmt string, line and file name that the event was logged from, and two parameters
 
LogCtxChg_putCtxChg8()  // module-wide

Unconditionally put the specified Types event along with file name, line number, fmt string and 4 args

C synopsis target-domain
macro UInt32 LogCtxChg_putCtxChg8(Types_Event evt, Types_ModuleId mid, IArg a1, IArg a2, IArg a3, IArg a4, IArg a5, IArg a6, IArg a7, IArg a8);
 
ARGUMENTS
evt — the Types event to put into the log
mask — the diags mask of the event
syncPtSeqNum — the sync point sequence number to log with the event for correlation with trace
fmt — a constant string that provides format specifiers for up to 6 additional parameters
a1 — the first context change argument to log
a2 — the second context change argument to log
a3 — the third context change argument to log
a4 — the fourth context change argument to log
a5 — the fifth context change argument to log
a6 — the sixth context change argument to log
a7 — the seventh context change argument to log
a8 — the eighth context change argument to log
DETAILS
This method unconditionally puts the specified context changeTypes.Event evt into the log along with the fmt string, line and file name that the event was logged from, and 4 parameters
 
LogCtxChg_swiStart()  // module-wide

Log a context change event that can be used to enable context-aware event filtering, context-aware profiling, etc

C synopsis target-domain
macro Void LogCtxChg_swiStart(String fmt, IArg swiId);
 
SEE
 
LogCtxChg_swiStop()  // module-wide

Log a context change event that can be used to enable context-aware event filtering, context-aware profiling, etc

C synopsis target-domain
macro Void LogCtxChg_swiStop(String fmt, IArg swiId);
 
SEE
 
LogCtxChg_thread()  // module-wide

Log a context change event that can be used to enable context-aware event filtering, context-aware profiling, etc

C synopsis target-domain
macro Void LogCtxChg_thread(String fmt, IArg newThreadId);
 
SEE
 
LogCtxChg_threadAndFunc()  // module-wide

Log a context change event that can be used to enable context-aware event filtering, context-aware profiling, etc

C synopsis target-domain
macro Void LogCtxChg_threadAndFunc(String fmt, IArg newThreadId, IArg oldFunc, IArg newFunc);
 
SEE
 
LogCtxChg_user()  // module-wide

Log a context change event that can be used to enable context-aware event filtering, context-aware profiling, etc

C synopsis target-domain
macro Void LogCtxChg_user(String fmt, IArg newCtxId);
 
SEE
Module-Wide Built-Ins

C synopsis target-domain
Types_ModuleId LogCtxChg_Module_id();
// Get this module's unique id
 
Bool LogCtxChg_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle LogCtxChg_Module_heap();
// The heap from which this module allocates memory
 
Bool LogCtxChg_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 LogCtxChg_Module_getMask();
// Returns the diagnostics mask for this module
 
Void LogCtxChg_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
Configuration settings sourced in ti/uia/runtime/LogCtxChg.xdc
 
config LogCtxChg.ctxFilterEnabled  // module-wide

set to true in the configuration script in order to enable context filtering

Configuration settings
LogCtxChg.ctxFilterEnabled = Bool false;
 
DETAILS
User can implement a custom function that is called instead of ti_uia_runtime_CtxFilter_isCtxEnabled() to control context-aware filtering. This function can also e.g. inject context information into the GEM trace or log sync point information if desired.
SEE
C SYNOPSIS
 
config LogCtxChg.isTimestampEnabled  // module-wide

used to enable or disable logging the 64b local CPU timestamp at the start of each event

Configuration settings
LogCtxChg.isTimestampEnabled = Bool true;
 
C SYNOPSIS
 
config LogCtxChg.loggerDefined  // module-wide

set to true in the configuration script when a logger that implements ILoggerSnapshot is attached

Configuration settings
LogCtxChg.loggerDefined = Bool false;
 
C SYNOPSIS
 
config LogCtxChg.loggerFxn2  // module-wide
Configuration settings
LogCtxChg.loggerFxn2 = Void(*)(Ptr,Types.LogEvent,Types.ModuleId,IArg,IArg) null;
 
C SYNOPSIS
 
config LogCtxChg.loggerFxn8  // module-wide
Configuration settings
LogCtxChg.loggerFxn8 = Void(*)(Ptr,Types.LogEvent,Types.ModuleId,IArg,IArg,IArg,IArg,IArg,IArg,IArg,IArg) null;
 
C SYNOPSIS
 
config LogCtxChg.loggerObj  // module-wide

handle of the logger that is to be used to log snapshot events

Configuration settings
LogCtxChg.loggerObj = Ptr null;
 
C SYNOPSIS
 
metaonly config LogCtxChg.common$  // module-wide

Common module configuration parameters

Configuration settings
LogCtxChg.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