https://github.com/ucb-bar/tacit_decoder
https://github.com/ucb-bar/tacit_decoder
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/ucb-bar/tacit_decoder
- Owner: ucb-bar
- Created: 2024-10-07T23:42:14.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-04-14T06:10:32.000Z (about 2 months ago)
- Last Synced: 2025-04-14T07:24:17.356Z (about 2 months ago)
- Language: Rust
- Size: 657 KB
- Stars: 4
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RISC-V TACIT Decoder
## What is TACIT?
TACIT is the **timing-accurate core instruction trace** format that is simple, efficient, and profiler-friendly.
It is also named "L-trace" under some cases, to match other risc-v trace standard naming conventions.
Comparing to other trace formats that focus on compression efficiency, it tries to capture timestamps for all control flow changes.
This includes precise timing of taken and non-taken branches, inferable and uninferable jumps.
TACIT provides rich timing information to profilers while trying to be simple and efficient in encoding.
## Running TACIT Decoder
```bash
cargo run -- --binary [binary] --encoded-trace [/path/to/trace] [optional arguments]
```
### Optional Arguments
* `--to_txt` - attach an analysis endpoint to dump all trace events and instructions decoded to a text file for reading
* `--to-json` - attach an analysis endpoint to dump all trace events to a json file
* `--to-afdo` - attach an analysis endpoint to convert traces to branch counts and range counts, for afdo tools to consume
* `--to_gcda` - attach an analysis endpoint to convert traces to a .gcda file. Needs to speicify the source gcno file
* `--gcno [path/to/.gcno]` - specify the path to the .gcno file for the gcda endpoint to use
* `--to_speedscope` - attach an analysis endpoint to convert traces to speedscope json format for stack frame visualization
* `--to_vpp` - attach an analysis endpoint to analyze traces for the path variation time for identifying optimization opportunities
### Adding Your Own Analysis Endpoint
TACIT decoder is designed with effortless integration of new analysis endpoints.
To do this, the user need to:
1. Add an argument to enable the analysis in `src/main.rs`.
2. Implement the interface in `backend/abstract_receiver.rs`, including:
1. `_bump_checksum`. This can be however the analysis wish to check for the integrity of the generated alaysis.
2. `_receive_entry`. This is what the analyzer should behave upon each new trace event.
3. `_flush`. This is the behavior of the analyzer after all events are processed.