llvm / llvm/circt

[ExportVerilog][Comb] Improve namings of temporary wires

Open
#2,462 0 comments 0 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

Currently, most of comb operations is not handled in inferStructuralNameForTemporary.
https://github.com/llvm/circt/blob/e3f2c4eec39146127e56b8ba5894515d909674af/lib/Conversion/ExportVerilog/ExportVerilog.cpp#L858-L860

It would be arguable how much we should do namings for temporaries but it would be good to implement some trivial patterns to improve verilog readablity.

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 in lib/Conversion/ExportVerilog/ExportVerilog.cpp at inferStructuralNameForTemporary, especially the referenced lines handling combinational operations. Review which trivial comb-operation patterns are currently omitted and implement naming improvements for them. Done means generated Verilog uses more readable names for those temporary wires.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
compilers
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.