log-setup command controls the output generated by the logging system, such as trace set up using the breakpoint manager.
When called without any arguments, the current log settings are printed.
The -time-stamp flag will cause future log output to include virtual time stamps: the name of the current processor, its current program counter value, and its current cycle count. If the current "processor" does not execute instructions (such as the clock), the program counter value is omitted. Time stamps are disabled with -no-time-stamp.
The -pico-seconds flag will cause future log output to include virtual time stamps in picoseconds. Picosecond time stamps are disabled with -no-pico-seconds.
The -real-time flag will cause log output to include wall clock time stamps. It is disabled with -no-real-time.
A file that receives all log output can be specified with the logfile argument. -no-log-file disables an existing log file. To overwrite an existing file, the -overwrite flag has to be given.
The -console and -no-console flags turn output from the log system to the command line console on or off.
The -group and -no-group flags controls if the log group should be part of the output. Default is not to include the log group.
The -level and -no-level flags controls if the log level should be part of the output. Default is not to include the log level.
The -disassemble and -no-disassemble flags control whether disassembly of the current instruction on the current "processor" is included in the output. Default is to not show disassembly.
Any log messages printed at a level below or equal to the current log level (see the log-level command) will always be stored in the in-memory log buffer (see the log command).
The default format of log output is [object log-type] {processor address cycle} [real-time] {pico-seconds ps} message. The second, third and fourth groups, in curly, square and curly brackets, respectively, are optional.
The object argument can be used to apply the configuration to the specified object only. The global command is used to reset object specific settings, meaning that doing a change without the object argument will override that setting for all objects, even for the objects that have had that setting set specially.
It is also possible to set a custom format strings for the log by setting format. When setting format, this will override other flags which specify log properties. In the format string, log properties are specified with the %x syntax, where x is one of the following: 'd' (disassembly), 'g' (log group), 'l' (log level), 't' (log type), 'm' (message), 'o' (object), 'p' (pico-seconds), 'r' (real-time), 'v' (virtual time-stamp).
To remove a custom log format, either set format to the empty string, "" or specify at least on of the (- or -no-) for real-time, level, group, time-stamp, pico-seconds, disassemble. This will restore the default format and default settings for all properties, for an object or for all objects if no object is specified.