llvm / llvm/circt

[hw] Revise the design of "doNotPrint"

Open
#2,231 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

The current support for bind operations is based on an undeclared "doNotPrint" attribute on hw.instance. This is a bit of a wormhole that isn't documented or really defined in the IR

I think it would be cleaner to:
1) Rename this to "emitAsBind" since that is what it does (it certainly prints!)
2) Declare this in ODS so it is a documented part of the contract that hw.instance provides, and so it gets type checked.
3) Mention this in the HW dialect rationale.

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 locating the HW dialect's hw.instance definition and the existing doNotPrint uses, then inspect the related ODS and HW dialect rationale. Done means the attribute is consistently renamed to emitAsBind, declared in ODS, and documented in the rationale.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
compilers
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 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.