How to Use the ULogger Configuration File

This topic provides details of the uloggerconfig.ini configuration file and which paths it can be stored in. It also explains the behaviour of the ULogger server when accessing the configurations, according to the configuration file availability in different drives with varying permissions:

• The enabling of primary and secondary filters

• The activation of input and output plug-ins

• The input and output plug-in settings

• The trace buffer mode, buffer size, and the threshold for data notification.

The ULogger server looks for a configuration file in the following locations. If it cannot find a configuration file in the first instance, it looks in the next location, until it finds a configuration file. If it cannot find a configuration file the ULogger server will not run.

The ULogger server will look for a configuration file in these locations in order of preference:

1. Public modifiable location: X:/ulogger/

2. Default modifiable location: C:/private/10273881

3. Default ROM build non-modifiable location: Z:\private\10273881

If the Trace Collector has not provided a configuration file, the ULogger server uses the configuration file that is in the C:/private/10273881 location, and if the file is missing, the ULogger server copies the file from z:/private/10273881 to c: in order to have a modifiable configuration file.

Note: In order for the Trace Collector to change any settings the configuration file used by the ULogger server must be modifiable.

The default configuration file is an ini file and has the following settings:

[ACTIVE_INPUT_CHANNEL] 
[ACTIVE_OUTPUT_CHANNEL] 
1=uloggerfileplugin
[PRIMARY_FILTERS]
 001=3
[SECONDARY_FILTERS] 
[TRACE]
buffer_mode=straight
buffer_size=1024
data_notification_size=64
secondary_global_filter=enable
[uloggerfileplugin]
max_size=10000000
output_path=c:\logs\Ulogger.log
[uloggerserialplugin]
output_port=1
[uloggerusbplugin]
mode = raw

A modifiable public configuration file can be created by Trace Collector by using the preceding format for their specific requirements. If the file is present the ULogger server uses it instead of the default configuration file. The Trace Collector should save the file in the following location:

X:/ulogger/uloggerconfig.ini

Where X is any public drive, but usually the MMU card.

The Trace Collector can make changes to this file by using command line tool or RULogger client interface.

Note: The configuration changes are registered only when the ULogger server is restarted, because its configuration is locked while tracing is in process.

The following table details the contents of a ULogger configuration file:

The following code contains the ULogger command syntax that is used to update the configuration file by:

• The active input plug-in, when communicating with the ULogger server, and

• The non-OS UTrace extension reference command line tool, when communicating with the client APIs.

/** ULogger command syntax

SYNOPSIS: ulogger [-rqtvhioH][-edl <config_options>...][-fsSoicbmn]...

DESCRIPTION:

ULogger groups the commands into execution and configuration commands where the options
 -rqtvhH belong to the former group and -edlbnmfsSoic to the latter.

Execution commands: -rqtvhH, require no other arguments.

Configuration commands are further divided into groups:

    -edl, these require one of the following options '-fsSoic' to be present, these will fail if too many or missing options are given.
    -fsSoicg, these will apply the arguments depending on the provided option -edl.
    
OPTIONS:

Execution commands:

-h        Quick help, displays a list of the options.
-H        The command syntax presented as a man page.
-version  The version of this tool.
-r        Start logging (Run)
-q        Stop logging (Quit)
-t        Restart (restarT) while logging, to update configurations
-o        List the active output plug-in.
-I        List the active input plug-in.
-v        Verbose mode, lists all results.
 
Otherwise, silent mode is assumed and only error codes will be returned
Configuration commands:

-e <-fsSoicgbmn options> ... Enable/set one of the options -fsSoicgbmn
-d <-fsSoicg options> ...    Disable/delete one of the options -fsSoicg
-l <-fsSoicgbmn options> ... List one of the options -fsSoicgbmn
-f [<filter> ...]            Enable/disable/list primary filter 0-255
-s [<filter> ...]            Enable/disable/list secondary filter 0-4294967295
-S                           Enable/disable/list secondary filtering. 
                             Enable this to filter on secondary filters. 
                             Disable to log all traces irrespective of secondary filter. 
                             By default filtering is enabled.
-o [<filename>]              Enable/disable an output
                             plug-in, list all output plugins
-I [<filename>]              Enable/disable an input
                             plug-in, list all input plugins
                             If <filename> is missing, the configuration will be applied 
                             to the active plug-in(s) for 
                             both the above options.
-c [<filename> <config> ...] Enable(set)/delete/list plug-in configurations.
                             If <filename> is missing, an error is returned as it is not 
                             possible to resolve whether the active
                             plug-in would be referring to the input
                             or the output plug-in.
                             The first argument in <config> must be the name of the configuration 
                             to be changed and any following arguments are treated as values of 
                             this   configuration.
                             The configuration keyword can not use any white characters 
                             (e.g. the space or tabulation key)
-b [<size> ...]              Buffer size,
                             1-1024 Kb rounded up to nearest page size, 4Kb.
-n [<size> ...]              Notification size,
                             0-1024 Kb rounded up to nearest page size, 4Kb.
-m [<mode> ...]              Buffer mode, 'circular' or 'straight'. Default is straight

The ULogger server will not start, if any of the following is true:

• The file contains insufficient settings.

• The file is corrupt.

• The file does not exist in either the public or private path.

So either the Trace Collector has to ensure that the public configuration file contains sensible data or the ROM creator has to ensure the default private file is included in the ROM build.

See also

How to run the ULogger server