Skip to content

Conversation

vinicius-r-silva
Copy link
Collaborator

@vinicius-r-silva vinicius-r-silva commented Aug 21, 2025

This PR introduces the Trace Archive Tool along with improvements in the documentation at traces/stf_trace_archive/README.md.

The trace archive tools comes with four different commands

  • Upload. Upload workload and/or trace.
  • List. List items by category.
  • Get. Download a specified trace file.
  • Setup. Create or edit current tool configurations.

This PR files follows this structure:

README.md                  # Main documentation file
src/
├── data/                  # Core data models and classes
│   └── storage/           # Storage backend implementations (local, cloud, etc.)
├── handlers/              # Command handlers (upload, get, list, setup)
├── utils/                 # Utility functions and helpers
└── trace_archive.py       # Main CLI entry point

Quickstart

# Install dependencies
pip install -r requirements.txt

# Configure initial storage (local)
python trace_archive.py setup

# Upload a workload and trace
python trace_archive.py upload --workload ../../stf_metadata/example/dhrystone --trace ../../stf_metadata/example/dhrystone.zstf

command definitions and examples are present in the README file.

Assumptions:

  • Every metadata file for simpointed traces will contain the property stf -> trace_interval -> start_instruction_index
  • Traces files has a .zstf file type

Missing Work / Next Steps:

  • Add Bundle / Suite grouping
  • Add script to generate metadata for traces
  • Add search command
  • Make possible to upload workload related files, like objdump
  • Add a test class

Copy link
Collaborator

@jaksa-mips jaksa-mips left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM
For the sake of not holding progress back, I did a quick pass. Glancing through the code it looks very well structured and organized. Any details I did go a bit deeper into I could follow and understand. The readme looks good, and if code does what the readme says it is doing, they we will be good. Approved.

@vinicius-r-silva vinicius-r-silva merged commit b873570 into riscv-software-src:master Sep 4, 2025
4 checks passed
@vinicius-r-silva vinicius-r-silva deleted the vinicius-r-silva/stf-trace-archive-tool branch September 4, 2025 23:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants