Module services - #669
Draft
desmonddak wants to merge 99 commits into
Draft
Conversation
…al/instance naming routine names
Clarify comment Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This aligns central_naming with the simplified naming approach already adopted by all downstream branches (module_services, netlist, source_debug, systemc_trace, fst-writer). Changes: - Remove Namer._instanceNames cache field - Remove Namer.instanceNameOf(Module) method - Update synthesizers to use Namer.allocateName(String) directly - Remove destination tracking from _BusSubsetForStructSlice Benefit: Eliminates duplication across 5+ branches, making each branch truly orthogonal and mergeable without conflicts. Trade-off: Instance names no longer cached across synthesis passes, but all downstreams already use this simpler approach.
# Conflicts: # tool/gh_codespaces/install_dart.sh
instanceNameOf(Module) allocates a collision-free instance name on the first call and returns the cached result thereafter. The _instanceNames Map is keyed by Module.instanceNameKey so repeated synthesis passes over the same hierarchy always produce stable names. This method belongs in central_naming because it is pure naming infrastructure with no dependency on any feature branch.
- Update comment: 'allocateName' → 'instanceNameOf' - Add 'submodule instance names are stable across repeated definitions' test (the canonical 'run synthesis twice, same names' regression test) Both belong here since they directly exercise Namer.instanceNameOf, which is now defined in central_naming.
Moved from Options to Configuration nomenclature. Dependency on rohd_hierarchy so we can use Occurrence classes Leverage Namer and eliminate residual naming functionality. Remove warnings and move to just throw on error.
…ells, and using enum for port dirs
Exact cumulative tree from original branch 7412bd260ddd235b6005d54ae7dadba372fad0b3 in the netlist-first merge order.
Exact cumulative tree from original branch a6e3a10b7d2693691fe99cac541614f028a9f8fb in the netlist-first merge order.
desmonddak
force-pushed
the
module_services
branch
from
August 24, 2026 21:20
6d5be53 to
142ac23
Compare
Exact cumulative tree from original branch 66a3353fc069018312982b94666735add2f81eb6 in the netlist-first merge order.
Exact cumulative tree from original branch 40652d1b2381cb39dff8c754f1ef1a43309615f9 in the netlist-first merge order.
Exact cumulative tree from original branch f61b48ae8deb1d65500df6174faeb47bd5adfceb in the netlist-first merge order.
Exact cumulative tree from original branch 4549040e58a47eb4f1518598537e0baed210a4fc in the netlist-first merge order.
Exact cumulative tree from original branch b110bbc4bf543a7f3d1ca7a705f237489f65732d in the netlist-first merge order.
desmonddak
force-pushed
the
module_services
branch
from
August 24, 2026 22:51
142ac23 to
c2c9e62
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description & Motivation
This is a new API for dealing with services after a module has been built. Rather than adding more methods to
Module, we create services that can operate on a builtModule, like writing out waveforms, or synthesizing outputs like SystemVerilog.So instead of
'module.generateSynth(outputPath: 'build/${module.definitionName}.sv')for outputing SystemVerilog andWaveDumper(module, outputPath: 'build/${module.definitionName}.vcd')for outputing Waveforms, we use:As we add more services, this is a more consistent API with fewer surprises.
Related Issue(s)
None
Testing
Tests are converted to the new Service apis and run through.
Backwards-compatibility
No. But eventually, we would like to deprecate existing methods in favor of a services model.
Documentation
Small changes in the README.md and throughout the tutorial and tests.