ROHD Hierarchy: an API for compact, generic traversal of a remote design#653
Open
desmonddak wants to merge 7 commits into
Open
ROHD Hierarchy: an API for compact, generic traversal of a remote design#653desmonddak wants to merge 7 commits into
desmonddak wants to merge 7 commits into
Conversation
mkorbel1
reviewed
May 7, 2026
Contributor
mkorbel1
left a comment
mkorbel1
left a comment
There was a problem hiding this comment.
Will be reviewing this next, couple quick comments until I have a moment to continue. This looks really great so far!
Contributor
|
Question: how do you imagine this package being used/depended on? Would we release it as a separate package on pub.dev? |
mkorbel1
reviewed
May 7, 2026
Contributor
Author
|
It is unclear if this really should be a separate package or integrated into ROHD. The waveform viewer depends on it and that is somewhat independent of ROHD. So I created it as a package because other capabilities will come that are in ROHD proper that use it as well. |
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.
…pact, canonical addresses
Description & Motivation
It would be nice to have a hierarchy api that allows us to remotely traverse a design hierarchy using compact addressing to support a devtools-based debugger. For example, if we receive a dictionary of the design, we can communicate requests for more data from the design by using a compressed addressing scheme like (5th instance, 4th instance below that, 15th signal) to receive a set of data on that signal. If we need 1000s of simulation values, for example, we do not need to transmit all names, providing an order of magnitude savings in transmission bandwidth.
This capability allows us to traverse an occurrence view over multiple data requests incrementally. For now, we primarily have two views: a 'slim' view, which displays the full hierarchy with names, and a full view, which shows all connectivity. This can be extended to allow for a more incremental dictionary load to allow a remote agent to use limited memory to transit a very large design.
Related Issue(s)
None.
Testing
Tests are provided with a small design fixture using a new netlist format in JSON, equivalent to Yosys JSON. A future netlist synthesizer will provide design data nd this
rohd_hierarchy adapterwill allow us to communicate between remote agents.Backwards-compatibility
No
Documentation
A
README.mdis included to describe the motivation, architecture, and key features of the api.