Initial Flow Script for riscv-perf-model #275
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The amount of files in the |
|
@vinicius-r-silva Thanks for your review! I've made some improvements to the code, but there's still more to be done (e.g., better documentation and removing redundant lines/functions, PEP8 compliance ...). It's a work in progress. I've implemented the changes you suggested, as I had the same thoughts. I'd appreciate any additional feedback you have! |
vinicius-r-silva
force-pushed
the
jatin/initial-flow
branch
from
80c2fec to
df96b8c
Compare
jaksa-mips
approved these changes
Sep 4, 2025
Jatin-exe
force-pushed
the
jatin/initial-flow
branch
from
bfea9db to
c71307e
Compare
Merged
Jatin-exe
pushed a commit
that referenced
this pull request
Sep 16, 2025
This PR introduces the Trace Generator Tool along with improvements in
the documentation at traces/stf_trace_archive/README.md and
traces/docker_stf_trace_gen/README.md. The main goal of this tool is to
create STF trace and it's metadata file for workload using docker.
The trace generator tool comes with three different modes
- **Macro** → uses `START_TRACE` and `STOP_TRACE` macros embedded in the
workload
- **Instruction Count (`insn_count`)** → traces a fixed number of
instructions after skipping some
- **Program Counter (`pc_count`)** → traces after a specific program
counter (PC) is reached
Other options included in the tool are:
* **`--isa ISA`**. Instruction set architecture (e.g., `rv64imafdc`).
* **`--dump`**. Create a trace file dump.
* **`--pk`**. Run Spike with **pk (proxy kernel)**.
This PR files follows this structure:
```text
README.md # Main documentation file
README.md # Trace generator documentation file
src/
├── data/ # Core data models and classes
├── converters/ # Converter classes
├── factories/ # Factory classes
├── utils/ # Utility functions and helpers
└── generate_trace.py # Main CLI entry point
```
### Quickstart
1. **Macro mode (SPIKE only)**
Trace using `START_TRACE` / `STOP_TRACE` markers inside the workload:
```bash
python generate_trace.py --emulator spike macro workload.elf
```
2. **Instruction Count mode**
Skip 1000 instructions, then trace 5000 instructions:
```bash
python generate_trace.py --emulator qemu insn_count \
--num-instructions 5000 --start-instruction 1000 workload.elf
```
3. **Program Counter mode (QEMU only)**
Start tracing after PC `0x80000000` is hit 5 times, trace 2000
instructions:
```bash
python generate_trace.py --emulator qemu pc_count \
--num-instructions 2000 --start-pc 0x80000000 --pc-threshold 5
workload.elf
```
### Next Steps:
* Integrate `utils/docker_orchestrator.py` with all docker related
function created on PR #275
* Add a simpoint option, passing a simpoint file as input and generating
traces from it
* Validate and compare trace results generated by both Spike and QEMU
* Look at including a Macro mode for the qemu plugin
* Create test classes
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
riscv-gnu-toolchain(get-tool.sh) for baremetal, Linux, 32-bit, and 64-bit support, including newlib for diverse workloads./outputs/.main()orbenchmark(). Includes emulator-specific stubs, entry points, linker script, and UART stdout support..cfgfor easier_building_x_benchmarkdefinitions and support workload-specificcrt0.Sandlink.ldoverrides.doc/.doc/emulator-comparison.mdfor detailed QEMU vs. Spike STF generation analysis. Alogn with a reproducible script.full_flow.pyscript for an interactive Docker-based workflow.board.cfgin environment for streamlined workload-specific flag and configuration declarations.Next Steps:
trace_archive.pyfor metadata storage and trace upload.