Note that the log events are processed within the runtime context
of the
Log_write() or
Log_print() function
that generated the event. It is important to account for the processing
overhead and stack usage imposed on the runtime context. The cost of
this processing is defined by the implementation of the system provider.
Configuration example: The following XDC configuration statements
create a logger instance, assign it as the default logger for all
modules, and enable
USER1 logging in all modules of the package
my.pkg. See the
Diags.setMaskMeta() function
for details on specifying the module names.
var Defaults = xdc.useModule('xdc.runtime.Defaults');
var Diags = xdc.useModule('xdc.runtime.Diags');
var LoggerSys = xdc.useModule('xdc.runtime.LoggerSys');
var LoggerSysParams = new LoggerSys.Params();
Defaults.common$.logger = LoggerSys.create(LoggerSysParams);
Diags.setMaskMeta("my.pkg.%", Diags.USER1, Diags.RUNTIME_ON);
enum LoggerSysTID_Cmd |
 |
Commands that can be sent to control function
typedef enum LoggerSysTID_Cmd {
LoggerSysTID_SETTRACE
// Set the trace output format based on the arg data
passed to the control() function
} LoggerSysTID_Cmd;
enum LoggerSysTID_TSMode |
 |
Timestamp display format
typedef enum LoggerSysTID_TSMode {
LoggerSysTID_TSMode_USEC,
// Timestamps displayed in microseconds
LoggerSysTID_TSMode_SEC,
// Timestamps displayed in seconds
LoggerSysTID_TSMode_DELTAUSEC,
// Timestamp differences in microseconds
LoggerSysTID_TSMode_TICKS
// Timestamps displayed in timer counter ticks
} LoggerSysTID_TSMode;
config LoggerSysTID_gate // module-wide |
 |
LoggerSysTID_control() // module-wide |
 |
A hook for sending commands to the logger. For example, this can
be used to re-configure the timestamp display format
Void LoggerSysTID_control(Int cmd, UArg cmdArgs);
ARGUMENTS
cmd
control command
cmdArgs
command argument
Module-Wide Built-Ins |
 |
// Get this module's unique id
Bool LoggerSysTID_Module_startupDone();
// Test if this module has completed startup
// The heap from which this module allocates memory
Bool LoggerSysTID_Module_hasMask();
// Test whether this module has a diagnostics mask
Bits16 LoggerSysTID_Module_getMask();
// Returns the diagnostics mask for this module
Void LoggerSysTID_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types |
 |
typedef struct LoggerSysTID_Object LoggerSysTID_Object;
// Opaque internal representation of an instance object
// Client reference to an instance object
typedef struct LoggerSysTID_Struct LoggerSysTID_Struct;
// Opaque client structure large enough to hold an instance object
// Convert this instance structure pointer into an instance handle
// Convert this instance handle into an instance structure pointer
Instance Config Parameters |
 |
typedef struct LoggerSysTID_Params {
// Instance config-params structure
// Common per-instance configs
} LoggerSysTID_Params;
// Initialize this config-params structure with supplier-specified defaults before instance creation
Instance Creation |
 |
// Allocate and initialize a new instance object and return its handle
// Initialize a new instance object inside the provided structure
ARGUMENTS
params
per-instance config params, or NULL to select default values (target-domain only)
eb
active error-handling block, or NULL to select default policy (target-domain only)
DETAILS
The logger instance will route all log events it receives to
the
System.printf function.
Instance Deletion |
 |
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
// Finalize the instance object inside the provided structure
LoggerSysTID_disable() // instance |
 |
Disable a log
ARGUMENTS
handle
handle of a previously-created LoggerSysTID instance object
DETAILS
Events written to a disabled log are silently discarded.
RETURNS
The function returns the state of the log (TRUE if enabled,
FALSE if disabled) before the call. This return value allows
clients to restore the previous state.
Note: not thread safe.
LoggerSysTID_enable() // instance |
 |
Enable a log
ARGUMENTS
handle
handle of a previously-created LoggerSysTID instance object
RETURNS
The function returns the state of the log (TRUE if enabled,
FALSE if disabled) before the call. This return value allows
clients to restore the previous state.
Note: not thread safe.
LoggerSysTID_write0() // instance |
 |
Process a log event with 0 arguments
ARGUMENTS
handle
handle of a previously-created LoggerSysTID instance object
DETAILS
Same as write4 except with 0 arguments rather than 4.
SEE
LoggerSysTID_write1() // instance |
 |
Process a log event with 1 arguments
ARGUMENTS
handle
handle of a previously-created LoggerSysTID instance object
DETAILS
Same as write4 except with 1 arguments rather than 4.
SEE
LoggerSysTID_write2() // instance |
 |
Process a log event with 2 arguments
ARGUMENTS
handle
handle of a previously-created LoggerSysTID instance object
DETAILS
Same as write4 except with 2 arguments rather than 4.
SEE
LoggerSysTID_write4() // instance |
 |
Process a log event with up to 4 arguments
ARGUMENTS
handle
handle of a previously-created LoggerSysTID instance object
evt
event to be logged
mid
module ID of the module which logged the event
a1
arbitrary argument passed by caller
DETAILS
The
evt argument is of type Log.Event, which encodes the
Log.EventId, the
Diags.Mask, and the
Diags.EventLevel of the event. The event ID can be obtained
via
Types.getEventId(evt), the Diags mask can be obtained via
Diags.getMask(evt), and the event level can be obtained via
Diags.getLevel(evt).
The modId argument is the module ID of the module that logged the
event.
The event information can be used by the logger to handle different
events specially. For example, the event ID can be used to compare
against other known Log.Events.
if (Log_getEventId(MY_EVENT) == Log_getEventId(evt)) {
:
}
The Diags mask and event level can be used for filtering of events
based on event level (see
IFilterLogger), or even routing
events to separate loggers based on diags category (see, for example,
LoggerBuf.statusLogger).
The Diags mask and event level are useful for handling the event, but
are generally not recorded by the logger because they are not needed in
decoding and displaying the event. A more suitable value to record is a
Types.Event, which encodes the event ID and module ID. For
example, the
Log.EventRec type stores a
Types.Event
in its record definition. A
Types.Event can be created using
the
Types.makeEvent API given the event ID and module ID.
The event ID value of
0 is used to indicate an event triggered by a
call to one of the
Log_print[0-6] methods. These
methods take a format string rather than a
Log_Event argument and,
as a result, the event ID encoded in
evt is
0 and the parameter
a1 is the format string.
Non-zero event IDs can also be used to access the
msg string
associated with the
Log.EventDesc that originally
defined the
Log event.
Log_EventId id = Log_getEventId(evt));
if (id != 0) {
String msg = Text_ropeText(id);
System_aprintf(msg, a1, a2, a3, a4);
}
This works because an event's ID is simply an offset into a table
of characters (maintained by the
Text module)
containing the event's msg string.
The arguments a1, a2, etc. are parameters that are to be interpreted
according to the message format string associated with evt.
SEE
LoggerSysTID_write8() // instance |
 |
Process a log event with up to 8 arguments
Void LoggerSysTID_write8(
LoggerSysTID_Handle handle,
Log_Event evt,
Types_ModuleId mid,
IArg a1,
IArg a2,
IArg a3,
IArg a4,
IArg a5,
IArg a6,
IArg a7,
IArg a8);
ARGUMENTS
handle
handle of a previously-created LoggerSysTID instance object
DETAILS
Same as write4 except with 8 arguments rather than 4.
SEE
Instance Convertors |
 |
// unconditionally move one level up the inheritance hierarchy
// conditionally move one level down the inheritance hierarchy; NULL upon failure
// unconditionally move 2 levels up the inheritance hierarchy
// conditionally move 2 levels down the inheritance hierarchy; NULL upon failure
Instance Built-Ins |
 |
Int LoggerSysTID_Object_count();
// The number of statically-created instance objects
// The handle of the i-th statically-created instance object (array == NULL)
// The handle of the first dynamically-created instance object, or NULL
// The handle of the next dynamically-created instance object, or NULL
// The heap used to allocate dynamically-created instance objects
// The label associated with this instance object
// The name of this instance object
proxy LoggerSysTID.TimestampProxy |
 |
A hook for sending commands to the logger. For example, this can
be used to re-configure the timestamp display format
XDCscript usage |
meta-domain |
// explicit access to the currently bound delegate module
VALUES
cmd
control command
cmdArgs
command argument
User supplied time-stamp proxy
This proxy allows
LoggerSys to use a timestamp server different
from the server used by
xdc.runtime.Timestamp. However, if
not supplied by a user, this proxy defaults to whichever timestamp
server is used by
Timestamp.
enum LoggerSysTID.Cmd |
 |
Commands that can be sent to control function
XDCscript usage |
meta-domain |
values of type LoggerSysTID.Cmd
const LoggerSysTID.SETTRACE;
// Set the trace output format based on the arg data
passed to the control() function
C SYNOPSIS
enum LoggerSysTID.TSMode |
 |
Timestamp display format
XDCscript usage |
meta-domain |
values of type LoggerSysTID.TSMode
const LoggerSysTID.TSMode_USEC;
// Timestamps displayed in microseconds
const LoggerSysTID.TSMode_SEC;
// Timestamps displayed in seconds
const LoggerSysTID.TSMode_DELTAUSEC;
// Timestamp differences in microseconds
const LoggerSysTID.TSMode_TICKS;
// Timestamps displayed in timer counter ticks
C SYNOPSIS
config LoggerSysTID.gate // module-wide |
 |
XDCscript usage |
meta-domain |
C SYNOPSIS
metaonly config LoggerSysTID.common$ // module-wide |
 |
Common module configuration parameters
XDCscript usage |
meta-domain |
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.
metaonly LoggerSysTID.getMetaArgs() // module-wide |
 |
Returns any meta data needed to support RTA
XDCscript usage |
meta-domain |
LoggerSysTID.getMetaArgs(Any inst, Any instNum) returns Any
DETAILS
This meta data should be returned in the form of a structure which
can be converted into XML. This data is added to the RTA XML file
during the application's configuration, and can be accessed later
through the xdc.rta.MetaData module.
The MetaData is returned per instance of the ILogger module. The
instance object is passed to the function as the first argument.
The second argument is the index of the instance in the list of
the ILogger's static instances.
Instance Config Parameters |
 |
XDCscript usage |
meta-domain |
var params = new LoggerSysTID.Params;
// Instance config-params object
Instance Creation |
 |
XDCscript usage |
meta-domain |
var params =
new LoggerSysTID.
Params;
// Allocate instance config-params
params.config = ...
// Assign individual configs
var inst = LoggerSysTID.create(params);
// Create an instance-object
ARGUMENTS
params
per-instance config params, or NULL to select default values (target-domain only)
eb
active error-handling block, or NULL to select default policy (target-domain only)
DETAILS
The logger instance will route all log events it receives to
the
System.printf function.