Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Optimize BitPat factory from UInt literals #3988

Merged
merged 1 commit into from
Apr 11, 2024
Merged

Conversation

jackkoenig
Copy link
Contributor

Benchmarked using #3987,

For BitPat(0xdeadbeefL.U) 72x speedup:

Benchmark                           Mode  Cnt   Score   Error   Units
ChiselBenchmark.BitPatFromUInt     thrpt   10  42.105 ± 1.364  ops/us
ChiselBenchmark.BitPatFromUIntOld  thrpt   10   0.582 ± 0.005  ops/us

For BitPat(3.U) 7x speedup:

Benchmark                           Mode  Cnt   Score   Error   Units
ChiselBenchmark.BitPatFromUInt     thrpt    3  44.501 ± 7.054  ops/us
ChiselBenchmark.BitPatFromUIntOld  thrpt   10   5.819 ± 0.049  ops/us

For real design, reduced amount of time in BitPat.apply from 116 seconds to 12.5 seconds (9x speedup)

Contributor Checklist

  • Did you add Scaladoc to every public function/method?
  • Did you add at least one test demonstrating the PR?
  • Did you delete any extraneous printlns/debugging code?
  • Did you specify the type of improvement?
  • Did you add appropriate documentation in docs/src?
  • Did you request a desired merge strategy?
  • Did you add text to be included in the Release Notes for this change?

Type of Improvement

  • Performance improvement

Desired Merge Strategy

  • Squash

Release Notes

Speeds up conversion of UInt literals to BitPat by ~9x in practice, ~70x for large UInts.

Reviewer Checklist (only modified by reviewer)

  • Did you add the appropriate labels? (Select the most appropriate one based on the "Type of Improvement")
  • Did you mark the proper milestone (Bug fix: 3.6.x, 5.x, or 6.x depending on impact, API modification or big change: 7.0)?
  • Did you review?
  • Did you check whether all relevant Contributor checkboxes have been checked?
  • Did you do one of the following when ready to merge:
    • Squash: You/ the contributor Enable auto-merge (squash), clean up the commit message, and label with Please Merge.
    • Merge: Ensure that contributor has cleaned up their commit history, then merge with Create a merge commit.

@jackkoenig jackkoenig added the Performance Improves performance, will be included in release notes label Apr 11, 2024
@jackkoenig jackkoenig added this to the 6.x milestone Apr 11, 2024
Copy link
Member

@sequencer sequencer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Every time I saw this, I wanna refactor this...
IIRC, Similar dirty codes also exist in the parsing BitPat from String...

@jackkoenig jackkoenig enabled auto-merge (squash) April 11, 2024 21:57
@jackkoenig
Copy link
Contributor Author

IIRC, Similar dirty codes also exist in the parsing BitPat from String...

BitPat.parse is okay (could be slightly optimized) but there are lots of places in TruthTable that could be sped up, I have another PR coming, just trying to figure out the best way to test and benchmark it as it's a private method.

@jackkoenig
Copy link
Contributor Author

TruthTable.fromString could definitely be optimized a bit 🙂

@jackkoenig jackkoenig merged commit 121b265 into main Apr 11, 2024
16 checks passed
@jackkoenig jackkoenig deleted the optimize-bitpat-apply branch April 11, 2024 22:02
@mergify mergify bot added the Backported This PR has been backported label Apr 11, 2024
mergify bot pushed a commit that referenced this pull request Apr 11, 2024
@sequencer
Copy link
Member

TruthTable.fromString could definitely be optimized a bit 🙂

Sorry for my ancient dirty hack 🫣

chiselbot pushed a commit that referenced this pull request Apr 11, 2024
(cherry picked from commit 121b265)

Co-authored-by: Jack Koenig <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Backported This PR has been backported Performance Improves performance, will be included in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants