llvm / llvm/circt

[FIRRTL] Reject hierarchical paths on `EICG_wrapper` in `LowerIntrinsics`

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

Nobody has claimed this yet.

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

Description

@mwachs5 has uncovered an issue in `LowerIntrinsics` when she ran the following command:
```
firtool test/Dialect/FIRRTL/extract-instances.mlir --ir-fir --fixup-eicg-wrapper
```
This errors out because a `EICG_wrapper` instance is targeted by a non-local annotation (and thus an `hw.hierpath`). We probably want to completely forbid annotations on clock gates, since we can't really annotate the intrinsics on the FIRRTL side. In practice it seems like we're not adding any annotations to clock gates. It would be good to (1) accept `EICG_wrapper`s with and without `test_en` port in `LowerIntrinsics`, and (2) to error out if the intrinsic instance is targeted by a non-local annotation.

If we end up hitting that error and we see NLAs on clock gates in practice, a viable alternative might be to create a `firrtl.wire` after the clock gate to carry that annotation.

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 with the LowerIntrinsics entry point and reproduce the failure using firtool test/Dialect/FIRRTL/extract-instances.mlir --ir-fir --fixup-eicg-wrapper. Check handling of EICG_wrapper instances with and without a test_en port, and verify that an intrinsic targeted by a non-local annotation produces an error.】【。

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
compilers
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.