Specifications

142 System Software Diagnostics Guide — September 2006
Runtime Trace Facility (RTF) Reference
• Utility program (rtftool.exe for Windows, rtftool for Linux): Command line application that
allows you to execute RTF functionality from command line or shell scripts.
• Utility program (RtfTrace.exe): Command line application that allows you to execute RTF
functionality from command line or shell scripts. This is provided for backward compatibility
only. All of this utility’s functionality is covered in rtftool.exe.
28.2 Installing RTF
RTF files are installed as part of the Intel Dialogic system software installation. The RTF
configuration file’s default installation directory is determined by the INTEL_DIALOGIC_CFG
environment variable. Refer to the Intel Dialogic System Release Software Installation Guide for
information about Intel Dialogic system software environment variables. Because the RTF
configuration file’s trace attribute is set to 1, RTF tracing is enabled by default. Other than editing
the RTF configuration file to customize trace settings for your development environment, there are
no special configuration steps for starting RTF.
28.3 RTF Configuration File
To make full use of RTF, you will want to modify the RTF configuration file (RtfConfigLinux.xml
for Linux, RtfConfigWin.xml for Windows). This configuration file allows you to define which
trace messages will be included in the RTF output. This subsection provides some guidelines for
modifying the RTF configuration file and reference information about the file’s XML tags and
attributes.
Note: You must have administrative rights to modify the RtfConfig*.xml files.
The RTF configuration file uses several terms that should be understood before attempting to edit
the file. The following definitions should be kept in mind as you edit the RTF configuration file:
module
a binary file, typically an executable or a shared object library file (.so). An RTF module
corresponds to a library or software module that has internal RTF APIs incorporated into its
source code.
client
an entity for identifying a device (e.g. “dxxxB1C1”), component (e.g. “WaveFileSource”) or a
function (e.g. “dx_play( )”) that is to be traced by RTF.
label
an attribute associated with a trace statement (e.g. “Error”, “Warning”, “Info”, “External API
entry”, “External API exit” etc.). A trace statement’s label is used by the trace data output for
categorization purposes.
trace entry
individual entries in the trace data output. The trace data output is typically sent to a file or
debug stream.
0
when a 0 appears next to a configuration item in the RTF configuration file, it indicates that the
configuration item is disabled.