[chiselsim] Add, use HasSimulator type class #4678
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jackkoenig
reviewed
Feb 11, 2025
jackkoenig
reviewed
Feb 11, 2025
There was a problem hiding this comment.
It would be good to add a test that shows explicitly "overriding" the simulator to verilator. This obviously is no different than using the default but it shows the API. As written that would look something like:
class MyTestSpec ... {
implicit val simulator: HasSimulator = chisel3.simulator.HasSimulator.verilator
...
}Or in Scala 3
class MyTestSpec ... {
given HasSimulator = chisel3.simulator.HasSimulator.verilator
...
}I think this is reasonable, but an alternative could be to move verilator and vcs to some other object, and make them implicits. Then the override would be:
import chisel3.simulator.HasSimulator.simulators.verilatorI am not sure if this is better, but it is something to consider.
a312ee8 to
386d24d
Compare
Add a new type class, `HasSimulator`, which provides a method to get a simulator. Provide two implementations: one for Verilator and one for VCS. Additionally, provide a low-priority default that maps to Verilator. This is working towards refactoring Chiselsim to improve the customizability of its APIs while not dramatically changing how a user interacts with it. Additionally, this is trying to work towards providing Scalatest-specific implementations of `HasSimulator` which allow the simulator to be chosen on the command line. Much of the code for this is currently sequestered in either ChiselSpec (part of the tests which are not published) or in internal code. Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>
Refactor the Chiselsim's `DefaultSimulator` to no longer create an instance of a private Verilator simulator class. Instead, use what is provided by a `HasSimulator` type class implementation. This is done to slim down `DefaultSimulator` (and transitively `EphemeralSimulator`) to essentially nothing other than objects that define convenience APIs for running simulation like the existing `simulate` method. Signed-off-by: Schuyler Eldridge <schuyler.eldridge@sifive.com>
386d24d to
ba49fcc
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add a new type class,
HasSimulator, which provides a method to get asimulator. Provide two implementations: one for Verilator and one for
VCS. Additionally, provide a low-priority default that maps to Verilator.
This is working towards refactoring Chiselsim to improve the
customizability of its APIs while not dramatically changing how a user
interacts with it. Additionally, this is trying to work towards providing
Scalatest-specific implementations of
HasSimulatorwhich allow thesimulator to be chosen on the command line. Much of the code for this is
currently sequestered in either ChiselSpec (part of the tests which are
not published) or in internal code.
Refactor the Chiselsim's
DefaultSimulatorto no longer create aninstance of a private Verilator simulator class. Instead, use what is
provided by a
HasSimulatortype class implementation.This is done to slim down
DefaultSimulator(and transitivelyEphemeralSimulator) to essentially nothing other than objects thatdefine convenience APIs for running simulation like the existing
simulatemethod.Release Notes
HasSimulatortype class to Chiselsim. This allows for customization of the simulator used byDefaultSimulator.