llvm / llvm/circt

[firrtl] Passes don't indicate they "preserve all" analyses when they don't do anything

Open
#1,264 2 comments 0 reactions 0 assignees View on GitHub
FIRRTL
Dominant language
C++
Stars
2.2k
Forks
524
Avg merge
3d 2h
Merged PRs (30d)
46

Description

The BlackBoxReader pass often doesn't do anything, and ExpandWhens doesn't when run on low firrtl. They should indicate that they preserves all, which prevents it from invalidating analyses and will provide a speedup when/if this gets resolved: https://bugs.llvm.org/show_bug.cgi?id=50701

The pass just needs to call `markAllAnalysesPreserved();`

### Todo

- [x] BlackBoxMemory (#1274)
- [x] BlackBoxReader (#1274)
- [x] InferWidths (#1274)
- [x] ExpandWhens (#1272)
- [ ] IMConstPop
- [ ] LowerTypes
- [ ] ModuleInliner
- [ ] GeneratorCallout
- [ ] HWStubExternalModulesPass
- [ ] SVExtractTestCode

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the implementations of the remaining passes listed in the Todo section: IMConstPop, LowerTypes, ModuleInliner, GeneratorCallout, HWStubExternalModulesPass, and SVExtractTestCode. Check how each pass handles the no-op case and use the existing markAllAnalysesPreserved() call pattern; done means the remaining unchecked passes indicate that all analyses are preserved when appropriate.

Written by the indexing model from the issue text.

Assessment

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