| metaonly module ti.sdo.ce.utils.trace.TraceUtil |
 |
TraceUtil Configuration interface
| XDCspec summary | sourced in ti/sdo/ce/utils/trace/TraceUtil.xdc |
metaonly module TraceUtil { ...
| usage | meta-domain |
var TraceUtil = xdc.useModule('ti.sdo.ce.utils.trace.TraceUtil');
module-wide constants & types
const TraceUtil.DEFAULT_TRACING// Tracing that prints warnings and errors on the standard output = {
const TraceUtil.SOCRATES_TRACING// Tracing appropriate for the SoC Analyzer data collection tool = {
obj.localTraceMask// local tracing mask = String ...
obj.localTraceFile// local tracing file = String ...
obj.dsp0TraceMask// server's tracing mask = String ...
obj.dsp0TraceFile// server's tracing file = String ...
obj.dsp0BiosFile// server's BIOS tracing file = String ...
obj.traceFileFlags// flags for fopen()ing trace files = String ...
obj.refreshPeriod// number of ms before two DSP data gets = Int ...
obj.cmdPipeFile// named pipe to read commands from = String ...
obj.alias// alias for a group of pipe commands = String ...
obj.cmds// list of pipe commands for this alias = String[] ...
module-wide config parameters
TraceUtil.attrs// Tracing configuration; by default set to some very basic tracing = TraceUtil.Attrs TraceUtil.DEFAULT_TRACING;
| XDCspec declarations | sourced in ti/sdo/ce/utils/trace/TraceUtil.xdc |
package ti.sdo.ce.utils.trace;
metaonly module TraceUtil {
module-wide constants & types
const TraceUtil.Attrs DEFAULT_TRACING// Tracing that prints warnings and errors on the standard output = {
const TraceUtil.Attrs SOCRATES_TRACING// Tracing appropriate for the SoC Analyzer data collection tool = {
};
};
module-wide config parameters
config TraceUtil.Attrs attrs// Tracing configuration; by default set to some very basic tracing = TraceUtil.DEFAULT_TRACING;
}
| const TraceUtil.DEFAULT_TRACING |
|
Tracing that prints warnings and errors on the standard output
| usage | meta-domain |
const TraceUtil.DEFAULT_TRACING = {
| const TraceUtil.FULL_TRACING |
|
Enable all tracing
| usage | meta-domain |
const TraceUtil.FULL_TRACING = {
| const TraceUtil.NO_TRACING |
|
No tracing or logging of any kind
| usage | meta-domain |
const TraceUtil.NO_TRACING = {
| const TraceUtil.SOCRATES_TRACING |
|
Tracing appropriate for the SoC Analyzer data collection tool
| usage | meta-domain |
const TraceUtil.SOCRATES_TRACING = {
DETAILS
The default settings here place data files into the /tmp directory.
/tmp typically provides faster write access than other file
system files, so it is used to lower the overhead of tracing.
Using these default settings, the GPP and DSP generate approximately
400 characters of trace in *each* the localTraceFile and
dsp0TraceFile, for each round trip to/from the DSP. This includes the
typical process() and control() calls to each codec.
Using that figure, the user is encouraged to configure the
refreshPeriod and System trace buffers appropriately, so as to reduce
the likelyhood of data loss due to wrapping.
For example, consider an application which utilizes a 30
frame-per-second video codec in parallel with a 50 frame-per-second
audio codec. Additionally, the audio codec requires calling process()
*and* control() for each frame - the video only requires a single
process() call. This application alone will generate approximately
((50 * 2) + 30) * 400 = 52000 bytes of trace data each second. If the
default System trace buffer size is used (32768 bytes), the application
needs to ensure the refresh period is less than 650 milliseconds
*not including I/O overhead or potential for pre-emption*.
| struct TraceUtil.Attrs |
|
Configuration attributes
| usage | meta-domain |
var obj = new TraceUtil.Attrs;
obj.localTraceMask = String ...
// local tracing mask
obj.localTraceFile = String ...
// local tracing file
obj.dsp0TraceMask = String ...
// server's tracing mask
obj.dsp0TraceFile = String ...
// server's tracing file
obj.dsp0BiosFile = String ...
// server's BIOS tracing file
obj.traceFileFlags = String ...
// flags for fopen()ing trace files
obj.refreshPeriod = Int ...
// number of ms before two DSP data gets
obj.cmdPipeFile = String ...
// named pipe to read commands from
obj.cmdAliases = TraceUtil.PipeCmdAlias[] ...
// any aliases for the pipe commands
FIELDS
localTraceMask
— The trace mask to be used on the "local",
or application processor.
localTraceFile
— The name of the file into which trace output
will be generated. This can be a full path
(e.g. /tmp/local.txt), or a path relative
to the executing application.
dsp0TraceMask
— The trace mask to be used on the "remote"
server.
dsp0TraceFile
— The name of the file into which trace output
will be generated. This can be a full path
(e.g. /tmp/dsp0.txt), or a path relative
to the executing application.
dsp0BiosFile
— The name of the file into which DSP/BIOS log
output will be generated. This can be a
full path (e.g. /tmp/dspbios.dat), or a
path relative to the executing application.
traceFileFlags
— fopen flags used when opening the various
trace/log files. See fopen() documentation
for details. For example, to open the files
in "append" mode (i.e. add to existing file
content), use "a"; to open in "over-write"
mode, use "w".
refreshPeriod
— The number of milliseconds to sleep before
reading the content off the remote servers.
This will vary based on the amount of trace
generated, and the size of the trace logs.
Failure to set this low enough will result
in data loss.
DETAILS
This structure describes the initialization settings for the
TraceUtil module; see TraceUtil.attrs.
| struct TraceUtil.PipeCmdAlias |
|
Alias' to use for the cmd pipe
| usage | meta-domain |
var obj = new TraceUtil.PipeCmdAlias;
obj.alias = String ...
// alias for a group of pipe commands
obj.cmds = String[] ...
// list of pipe commands for this alias
| config TraceUtil.attrs // module-wide |
|
Tracing configuration; by default set to some very basic tracing
| usage | meta-domain |
generated on Thu, 02 Dec 2010 05:35:34 GMT