llvm / llvm/circt

Elaborate chisel type annotation from firtool to generate debug information for the Tywaves project

Open
#6,983 2 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C++
Stars
2.2k
Forks
524
Avg merge
3d 2h
Merged PRs (30d)
46

Description

@fabianschuiki I created this issue to keep talking about the conversation we started here: https://github.com/chipsalliance/chisel/issues/4015#issuecomment-2077714172

I added attributes to debug variable to store the chisel type name and, eventually, the constructor parameters in the debug dialect (and maybe in `dbg.struct` and `dbg.array` as well).

However, I may need to create a dbg variable for each sub field, recursively, of aggregates.
Is there a reason why values in `dbg.struct`/`dbg.array` are of Firrtl types rather than `dbg.variable` type in `MaterializeDebugInfo`?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading MaterializeDebugInfo and the debug dialect definitions mentioned in the issue, especially dbg.struct, dbg.array, and dbg.variable. Clarify whether aggregate subfields require recursively created debug variables and how Chisel type names and constructor parameters should be represented before implementing the firtool change.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.