| 1 | This file: README.txt |
| 2 | Location: $(RSTRACERv5_WS)/README.txt |
| 3 | Date: 2005.10.10 |
| 4 | |
| 5 | 1. rstracer-v5 |
| 6 | |
| 7 | Rstracer-v5 is an RST trace generated for SAM v5. It uses the vtracer |
| 8 | (VCPU tracer) interface implemented in SAM v5. |
| 9 | |
| 10 | Rstracer is a loadable module that is loaded using the "mod load" |
| 11 | command. When a module is loaded, SAM activates the vtracer |
| 12 | interface. However, rstracer does not generate rst records unless |
| 13 | instructed to do so using the "rstrace" command. |
| 14 | |
| 15 | The tracer always generates value records and can be run in |
| 16 | multithreaded mode. It generates split trace files (one per simulated |
| 17 | CPU). |
| 18 | |
| 19 | The tracer uses the latest rst trace format and rstzip3 compressed |
| 20 | trace format (at the time of writing). The traces produced by |
| 21 | rstracer are readable only by analyzers built against the latest |
| 22 | rstf and rstzip releases. |
| 23 | |
| 24 | 2. Usage |
| 25 | |
| 26 | At the SAM v5 prompt, stop the blaze system (if not already stopped) |
| 27 | |
| 28 | run: stop |
| 29 | stop: |
| 30 | |
| 31 | Once stopped, load the tracer: |
| 32 | |
| 33 | stop: mod load rstrace <path>/rstracer.so |
| 34 | |
| 35 | This command may fail if the shared library is not found, or is of the |
| 36 | wrong ELF class (ELF32 vs ELF64), or is not from the same SAM package. |
| 37 | |
| 38 | Once loaded, SAM execution can be continued using the "run" command, |
| 39 | or a tracing command can be issued immediately. |
| 40 | |
| 41 | The typical tracing command looks like this: |
| 42 | |
| 43 | stop: rstrace -o <basename> -d <delay-cycles> -n <trace-cycles> |
| 44 | |
| 45 | Where "cycles" refers to instructions-per-cpu (assuming no variable CPI, timing models etc.) |
| 46 | |
| 47 | When done tracing, issue the "mod unload" command to unload the tracer module |
| 48 | |
| 49 | stop: mod unload rstrace |