This file: README.txt
Location: $(RSTRACERv5_WS)/README.txt
Date: 2005.10.10

1. rstracer-v5

Rstracer-v5 is an RST trace generated for SAM v5. It uses the vtracer
(VCPU tracer) interface implemented in SAM v5.

Rstracer is a loadable module that is loaded using the "mod load"
command. When a module is loaded, SAM activates the vtracer
interface. However, rstracer does not generate rst records unless
instructed to do so using the "rstrace" command.

The tracer always generates value records and can be run in
multithreaded mode. It generates split trace files (one per simulated
CPU).

The tracer uses the latest rst trace format and rstzip3 compressed
trace format (at the time of writing). The traces produced by
rstracer are readable only by analyzers built against the latest
rstf and rstzip releases.

2. Usage

At the SAM v5 prompt, stop the blaze system (if not already stopped)

  run: stop
  stop:

Once stopped, load the tracer:

  stop: mod load rstrace <path>/rstracer.so

This command may fail if the shared library is not found, or is of the
wrong ELF class (ELF32 vs ELF64), or is not from the same SAM package.

Once loaded, SAM execution can be continued using the "run" command,
or a tracing command can be issued immediately.

The typical tracing command looks like this:

  stop: rstrace -o <basename> -d <delay-cycles> -n <trace-cycles>

Where "cycles" refers to instructions-per-cpu (assuming no variable CPI, timing models etc.)

When done tracing, issue the "mod unload" command to unload the tracer module

  stop: mod unload rstrace