module xdc.runtime.LoggerSys

A logger which routes events to the System_printf function

This logger processes log events as they are generated and routes them through the System_printf() function. The final disposition of the log event is dependent on which system provider has been assigned to the System.SupportProxy configuration parameter. [ more ... ]
C synopsis target-domain sourced in xdc/runtime/LoggerSys.xdc
#include <xdc/runtime/LoggerSys.h>
Functions
Void
Void
Void
Void
Functions common to all ILogger modules
Bool 
Bool 
Void 
Void 
Void 
Void 
Void 
LoggerSys_write8// Process a log event with up to 8 arguments(LoggerSys_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1, IArg a2, IArg a3, IArg a4, IArg a5, IArg a6, IArg a7, IArg a8);
Functions common to all target instances
Functions common to all target modules
Typedefs
typedef struct
typedef struct
typedef struct
 
DETAILS
This logger processes log events as they are generated and routes them through the System_printf() function. The final disposition of the log event is dependent on which system provider has been assigned to the System.SupportProxy configuration parameter.
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.
EXAMPLES
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);
Module-Wide Built-Ins

C synopsis target-domain
Types_ModuleId LoggerSys_Module_id();
// Get this module's unique id
 
Bool LoggerSys_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle LoggerSys_Module_heap();
// The heap from which this module allocates memory
 
Bool LoggerSys_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 LoggerSys_Module_getMask();
// Returns the diagnostics mask for this module
 
Void LoggerSys_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
Instance Object Types

C synopsis target-domain
typedef struct LoggerSys_Object LoggerSys_Object;
// Opaque internal representation of an instance object
 
typedef LoggerSys_Object *LoggerSys_Handle;
// Client reference to an instance object
 
typedef struct LoggerSys_Struct LoggerSys_Struct;
// Opaque client structure large enough to hold an instance object
 
LoggerSys_Handle LoggerSys_handle(LoggerSys_Struct *structP);
// Convert this instance structure pointer into an instance handle
 
LoggerSys_Struct *LoggerSys_struct(LoggerSys_Handle handle);
// Convert this instance handle into an instance structure pointer
Instance Config Parameters

C synopsis target-domain
typedef struct LoggerSys_Params {
// Instance config-params structure
    IInstance_Params *instance;
    // Common per-instance configs
} LoggerSys_Params;
 
Void LoggerSys_Params_init(LoggerSys_Params *params);
// Initialize this config-params structure with supplier-specified defaults before instance creation
Runtime Instance Creation

C synopsis target-domain
LoggerSys_Handle LoggerSys_create(const LoggerSys_Params *params, Error_Block *eb);
// Allocate and initialize a new instance object and return its handle
 
Void LoggerSys_construct(LoggerSys_Struct *structP, const LoggerSys_Params *params);
// 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

C synopsis target-domain
Void LoggerSys_delete(LoggerSys_Handle *handleP);
// Finalize and free this previously allocated instance object, setting the referenced handle to NULL
 
Void LoggerSys_destruct(LoggerSys_Struct *structP);
// Finalize the instance object inside the provided structure
 
LoggerSys_disable()  // instance

Disable a log

C synopsis target-domain
Bool LoggerSys_disable(LoggerSys_Handle handle);
 
ARGUMENTS
handle — handle of a previously-created LoggerSys 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.
 
LoggerSys_enable()  // instance

Enable a log

C synopsis target-domain
Bool LoggerSys_enable(LoggerSys_Handle handle);
 
ARGUMENTS
handle — handle of a previously-created LoggerSys 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.
 
LoggerSys_write0()  // instance

Process a log event with 0 arguments

C synopsis target-domain
Void LoggerSys_write0(LoggerSys_Handle handle, Log_Event evt, Types_ModuleId mid);
 
ARGUMENTS
handle — handle of a previously-created LoggerSys instance object
DETAILS
Same as write4 except with 0 arguments rather than 4.
SEE
 
LoggerSys_write1()  // instance

Process a log event with 1 arguments

C synopsis target-domain
Void LoggerSys_write1(LoggerSys_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1);
 
ARGUMENTS
handle — handle of a previously-created LoggerSys instance object
DETAILS
Same as write4 except with 1 arguments rather than 4.
SEE
 
LoggerSys_write2()  // instance

Process a log event with 2 arguments

C synopsis target-domain
Void LoggerSys_write2(LoggerSys_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1, IArg a2);
 
ARGUMENTS
handle — handle of a previously-created LoggerSys instance object
DETAILS
Same as write4 except with 2 arguments rather than 4.
SEE
 
LoggerSys_write4()  // instance

Process a log event with up to 4 arguments

C synopsis target-domain
Void LoggerSys_write4(LoggerSys_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1, IArg a2, IArg a3, IArg a4);
 
ARGUMENTS
handle — handle of a previously-created LoggerSys 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
 
LoggerSys_write8()  // instance

Process a log event with up to 8 arguments

C synopsis target-domain
Void LoggerSys_write8(LoggerSys_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 LoggerSys instance object
DETAILS
Same as write4 except with 8 arguments rather than 4.
SEE
Instance Convertors

C synopsis target-domain
ILogger_Handle LoggerSys_Handle_upCast(LoggerSys_Handle handle);
// unconditionally move one level up the inheritance hierarchy
 
LoggerSys_Handle LoggerSys_Handle_downCast(ILogger_Handle handle);
// conditionally move one level down the inheritance hierarchy; NULL upon failure
Instance Built-Ins

C synopsis target-domain
Int LoggerSys_Object_count();
// The number of statically-created instance objects
 
LoggerSys_Handle LoggerSys_Object_get(LoggerSys_Object *array, Int i);
// The handle of the i-th statically-created instance object (array == NULL)
 
LoggerSys_Handle LoggerSys_Object_first();
// The handle of the first dynamically-created instance object, or NULL
 
LoggerSys_Handle LoggerSys_Object_next(LoggerSys_Handle handle);
// The handle of the next dynamically-created instance object, or NULL
 
IHeap_Handle LoggerSys_Object_heap();
// The heap used to allocate dynamically-created instance objects
 
Types_Label *LoggerSys_Handle_label(LoggerSys_Handle handle, Types_Label *buf);
// The label associated with this instance object
 
String LoggerSys_Handle_name(LoggerSys_Handle handle);
// The name of this instance object
 
Configuration settings sourced in xdc/runtime/LoggerSys.xdc
var LoggerSys = xdc.useModule('xdc.runtime.LoggerSys');
local proxy modules
        LoggerSys.TimestampProxy.delegate$ = ITimestampClient.Module null
module-wide config parameters
module-wide functions
per-instance config parameters
    var params = new LoggerSys.Params// Instance config-params object;
per-instance creation
    var inst = LoggerSys.create// Create an instance-object(params);
 
 
proxy LoggerSys.TimestampProxy

User supplied time-stamp proxy

Configuration settings
LoggerSys.TimestampProxy = ITimestampClient.Module null
// some delegate module inheriting the ITimestampClient interface
    LoggerSys.TimestampProxy.delegate$ = ITimestampClient.Module null
    // explicit access to the currently bound delegate module
 
DETAILS
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.
 
metaonly config LoggerSys.common$  // module-wide

Common module configuration parameters

Configuration settings
LoggerSys.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.
 
metaonly LoggerSys.getMetaArgs()  // module-wide

Returns any meta data needed to support RTA

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

Configuration settings
var params = new LoggerSys.Params;
// Instance config-params object
Static Instance Creation

Configuration settings
var params = new LoggerSys.Params;
// Allocate instance config-params
params.config =   ...
// Assign individual configs
 
var inst = LoggerSys.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.
generated on Fri, 28 Feb 2014 04:56:45 GMT