module xdc.runtime.LoggerSys

A logger which routes events to the System_printf function

C synopsis
Individual elements
DETAILS
EXAMPLES
Configuration settings
Individual elements

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	LoggerSys_construct// Initialize a new instance object inside the provided structure(LoggerSys_Struct structP, const LoggerSys_Params params);
LoggerSys_Handle	LoggerSys_create// Allocate and initialize a new instance object and return its handle(const LoggerSys_Params params, Error_Block eb);
Void	LoggerSys_delete// Finalize and free this previously allocated instance object, setting the referenced handle to NULL(LoggerSys_Handle *handleP);
Void	LoggerSys_destruct// Finalize the instance object inside the provided structure(LoggerSys_Struct *structP);
Void	LoggerSys_Params_init// Initialize this config-params structure with supplier-specified defaults before instance creation(LoggerSys_Params *params);
Functions common to all ILogger modules
Bool	LoggerSys_disable// Disable a log(LoggerSys_Handle handle);
Bool	LoggerSys_enable// Enable a log(LoggerSys_Handle handle);
Void	LoggerSys_write0// Process a log event with 0 arguments(LoggerSys_Handle handle, Log_Event evt, Types_ModuleId mid);
Void	LoggerSys_write1// Process a log event with 1 arguments(LoggerSys_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1);
Void	LoggerSys_write2// Process a log event with 2 arguments(LoggerSys_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1, IArg a2);
Void	LoggerSys_write4// Process a log event with up to 4 arguments(LoggerSys_Handle handle, Log_Event evt, Types_ModuleId mid, IArg a1, IArg a2, IArg a3, IArg a4);
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
	LoggerSys_handle// Convert this instance structure pointer into an instance handle, LoggerSys_Handle_downCast// conditionally move one level down the inheritance hierarchy; NULL upon failure, LoggerSys_Handle_label// The label associated with this instance object, LoggerSys_Handle_name// The name of this instance object, LoggerSys_Handle_upCast// unconditionally move one level up the inheritance hierarchy, LoggerSys_Object_count// The number of statically-created instance objects, LoggerSys_Object_first// The handle of the first dynamically-created instance object, or NULL, LoggerSys_Object_get// The handle of the i-th statically-created instance object (array == NULL), LoggerSys_Object_heap// The heap used to allocate dynamically-created instance objects, LoggerSys_Object_next// The handle of the next dynamically-created instance object, or NULL, LoggerSys_struct// Convert this instance handle into an instance structure pointer
Functions common to all target modules
	LoggerSys_Module_getMask// Returns the diagnostics mask for this module, LoggerSys_Module_hasMask// Test whether this module has a diagnostics mask, LoggerSys_Module_heap// The heap from which this module allocates memory, LoggerSys_Module_id// Get this module's unique id, LoggerSys_Module_setMask// Set the diagnostics mask for this module, LoggerSys_Module_startupDone// Test if this module has completed startup
Typedefs
typedef LoggerSys_Object *	LoggerSys_Handle// Client reference to an instance object;
typedef struct	LoggerSys_Object// Opaque internal representation of an instance object LoggerSys_Object;
typedef struct	LoggerSys_Params// Instance config-params structure ...
typedef struct	LoggerSys_Struct// Opaque client structure large enough to hold an instance object LoggerSys_Struct;

DETAILS

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