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

Fix using Definitions as arguments to Definitions #3726

Merged
merged 1 commit into from
Jan 12, 2024

Conversation

jackkoenig
Copy link
Contributor

@jackkoenig jackkoenig commented Jan 11, 2024

Chisel creates new contexts whenever you're constructing a Definition. Previously, if you had a Definition in the parent context, the actual object would not be available in the child context (because it's a new context, Builder.components is cleared when you go to a new context). Now, we keep track of definitions explicitly including definitions from parent/outer scopes. This is implemented using a nested List for efficiency of constructing the datastructure while still allowing for efficient iteration.

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 - but probably not measurable
  • Bugfix

Desired Merge Strategy

  • Squash

Release Notes

Fixes #3708

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.5.x, 3.6.x, or 5.x depending on impact, API modification or big change: 6.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 Bugfix Fixes a bug, will be included in release notes label Jan 11, 2024
@jackkoenig jackkoenig added this to the 3.5.x milestone Jan 12, 2024
@jackkoenig jackkoenig force-pushed the jackkoenig/definition-dependency-injection branch from a0aa409 to a3c6238 Compare January 12, 2024 00:03
@jackkoenig jackkoenig force-pushed the jackkoenig/definition-dependency-injection branch from a3c6238 to eaedc9f Compare January 12, 2024 01:09
Copy link
Contributor

@azidar azidar left a comment

Choose a reason for hiding this comment

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

Awesome! Good catch

@jackkoenig
Copy link
Contributor Author

Awesome! Good catch

@tymcauley caught it, I just stared at the code until it fixed itself 🙂

@jackkoenig jackkoenig merged commit a050b8c into main Jan 12, 2024
14 checks passed
@jackkoenig jackkoenig deleted the jackkoenig/definition-dependency-injection branch January 12, 2024 03:48
@mergify mergify bot added the Backported This PR has been backported label Jan 12, 2024
mergify bot pushed a commit that referenced this pull request Jan 12, 2024
(cherry picked from commit a050b8c)

# Conflicts:
#	core/src/main/scala/chisel3/Module.scala
#	core/src/main/scala/chisel3/experimental/hierarchy/Definition.scala
#	core/src/main/scala/chisel3/experimental/hierarchy/Instance.scala
#	core/src/main/scala/chisel3/internal/Builder.scala
#	src/main/scala/chisel3/aop/injecting/InjectingAspect.scala
#	src/main/scala/chisel3/stage/phases/Elaborate.scala
mergify bot pushed a commit that referenced this pull request Jan 12, 2024
(cherry picked from commit a050b8c)

# Conflicts:
#	core/src/main/scala/chisel3/Module.scala
#	core/src/main/scala/chisel3/experimental/hierarchy/core/Definition.scala
#	core/src/main/scala/chisel3/experimental/hierarchy/core/Instance.scala
#	core/src/main/scala/chisel3/internal/Builder.scala
#	src/main/scala/chisel3/aop/injecting/InjectingAspect.scala
#	src/main/scala/chisel3/stage/phases/Elaborate.scala
mergify bot pushed a commit that referenced this pull request Jan 12, 2024
(cherry picked from commit a050b8c)

# Conflicts:
#	core/src/main/scala/chisel3/Module.scala
#	core/src/main/scala/chisel3/experimental/hierarchy/core/Definition.scala
#	core/src/main/scala/chisel3/experimental/hierarchy/core/Instance.scala
#	core/src/main/scala/chisel3/internal/Builder.scala
@tymcauley
Copy link
Contributor

Thanks so much for fixing this @jackkoenig!

mergify bot added a commit that referenced this pull request Jan 13, 2024
…3731)

* Fix using Definitions as arguments to Definitions (#3726)

(cherry picked from commit a050b8c)

# Conflicts:
#	core/src/main/scala/chisel3/Module.scala
#	core/src/main/scala/chisel3/experimental/hierarchy/core/Definition.scala
#	core/src/main/scala/chisel3/experimental/hierarchy/core/Instance.scala
#	core/src/main/scala/chisel3/internal/Builder.scala

* Resolve backport conflicts

---------

Co-authored-by: Jack Koenig <koenig@sifive.com>
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 Bugfix Fixes a bug, will be included in release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Error creating Instance inside an Instance
3 participants