[BUG] December 2024 commits adding assertions broke SystemRDL builds

[paul-demo]

The changes from 1.27.3 -> 1.29.0 of systemrdl-compiler broke builds due to assertions failing in the commit here:
0e1dfac

Details like these can be helpful:

Traceback (most recent call last):
  File "/some/path/python/3.9.17/lib/python3.9/runpy.py", line 197, in _run_module_as_main
    return _run_code(code, main_globals, None,
  File "/some/path/python/3.9.17/lib/python3.9/runpy.py", line 87, in _run_code
    exec(code, run_globals)
  File /some/other/path/lib/python3.9/site-packages/peakrdl/__main__.py", line 3, in <module>
    main()
  File /some/other/path/lib/python3.9/site-packages/peakrdl/main.py", line 183, in main
    options.subcommand.main(importers, options)
  File /some/other/path/lib/python3.9/site-packages/peakrdl/subcommand.py", line 154, in main
    self.do_export(top, options)
  File /some/other/path/lib/python3.9/site-packages/peakrdl_regblock/__peakrdl__.py", line 207, in do_export
    x.export(
  File /some/other/path/lib/python3.9/site-packages/peakrdl_regblock/exporter.py", line 157, in export
    DesignValidator(self).do_validate()
  File /some/other/path/lib/python3.9/site-packages/peakrdl_regblock/validate_design.py", line 32, in do_validate
    RDLWalker().walk(self.top_node, self)
  File /some/other/path/lib/python3.9/site-packages/systemrdl/walker.py", line 159, in walk
    self.walk(child, *listeners)
  File /some/other/path/lib/python3.9/site-packages/systemrdl/walker.py", line 159, in walk
    self.walk(child, *listeners)
  File /some/other/path/lib/python3.9/site-packages/systemrdl/walker.py", line 150, in walk
    self.current_action = self.do_enter(node, listener)
  File /some/other/path/lib/python3.9/site-packages/systemrdl/walker.py", line 176, in do_enter
    action = listener.enter_Component(node) or WalkerAction.Continue
  File /some/other/path/lib/python3.9/site-packages/peakrdl_regblock/validate_design.py", line 47, in enter_Component
    if not ref_is_internal(self.top_node, value):
  File /some/other/path/lib/python3.9/site-packages/peakrdl_regblock/utils.py", line 59, in ref_is_internal
    if current_node.external:
  File /some/other/path/lib/python3.9/site-packages/systemrdl/node.py", line 789, in external
    assert self.inst.external is not None
AssertionError

• I have reviewed this project's contribution guidelines

[paul-demo]

Apparently this is not actually guaranteed after elaboration as the comment says:

[amykyta3]

Thanks! Can you provide a minimal rdl example that reproduces this? I must have a testcase gap

…

On Mon, Jan 6, 2025, 11:16 AM Paul Swirhun ***@***.***> wrote: The changes from 1.27.3 -> 1.29.0 of systemrdl-compiler broke builds due to assertions failing in the commit here: 0e1dfac <0e1dfac> Details like these can be helpful: Traceback (most recent call last): File "/some/path/python/3.9.17/lib/python3.9/runpy.py", line 197, in _run_module_as_main return _run_code(code, main_globals, None, File "/some/path/python/3.9.17/lib/python3.9/runpy.py", line 87, in _run_code exec(code, run_globals) File /some/other/path/lib/python3.9/site-packages/peakrdl/__main__.py", line 3, in <module> main() File /some/other/path/lib/python3.9/site-packages/peakrdl/main.py", line 183, in main options.subcommand.main(importers, options) File /some/other/path/lib/python3.9/site-packages/peakrdl/subcommand.py", line 154, in main self.do_export(top, options) File /some/other/path/lib/python3.9/site-packages/peakrdl_regblock/__peakrdl__.py", line 207, in do_export x.export( File /some/other/path/lib/python3.9/site-packages/peakrdl_regblock/exporter.py", line 157, in export DesignValidator(self).do_validate() File /some/other/path/lib/python3.9/site-packages/peakrdl_regblock/validate_design.py", line 32, in do_validate RDLWalker().walk(self.top_node, self) File /some/other/path/lib/python3.9/site-packages/systemrdl/walker.py", line 159, in walk self.walk(child, *listeners) File /some/other/path/lib/python3.9/site-packages/systemrdl/walker.py", line 159, in walk self.walk(child, *listeners) File /some/other/path/lib/python3.9/site-packages/systemrdl/walker.py", line 150, in walk self.current_action = self.do_enter(node, listener) File /some/other/path/lib/python3.9/site-packages/systemrdl/walker.py", line 176, in do_enter action = listener.enter_Component(node) or WalkerAction.Continue File /some/other/path/lib/python3.9/site-packages/peakrdl_regblock/validate_design.py", line 47, in enter_Component if not ref_is_internal(self.top_node, value): File /some/other/path/lib/python3.9/site-packages/peakrdl_regblock/utils.py", line 59, in ref_is_internal if current_node.external: File /some/other/path/lib/python3.9/site-packages/systemrdl/node.py", line 789, in external assert self.inst.external is not NoneAssertionError - I have reviewed this project's contribution guidelines <https://github.com/SystemRDL/systemrdl-compiler/blob/main/CONTRIBUTING.md> — Reply to this email directly, view it on GitHub <#245>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AC3W6I35R6ODIPTSDAUNFST2JLJAVAVCNFSM6AAAAABUWGTUUWVHI2DSMVQWIX3LMV43ASLTON2WKOZSG43TCMRYGEYTIOI> . You are receiving this because you are subscribed to this thread.Message ID: ***@***.***>

[paul-demo]

EDITED: Looks like it's due to external signals (used for read double-buffering and hwclr):

Short example:

// Minimal example to demonstrate issue:
// https://github.com/SystemRDL/systemrdl-compiler/issues/245

default regwidth = 32;
default accesswidth = 32;
default addressing = compact;
default littleendian = true;
default reset = 0;
default sw = r;
default hw = w;

property buffer_reads {
    component = reg;
    type = boolean;
};

property rbuffer_trigger {
    component = reg;
    type = ref;
};

signal {
    sync;
    activehigh;
} latch_stats;

regfile foo {
    default hw = na;
    default counter;

    // Including these two lines causes the elaboration error:
    default buffer_reads = true;
    default rbuffer_trigger = latch_stats;

    // Including this line also causes the elaboration error:
    default hwclr = latch_stats;

    reg {
        field {} cnt[31:0];
    } num;
};

addrmap my_csr {
    foo bar[16] %= 0x100;
};

[amykyta3]

Thanks! Will fix tonight

…

On Mon, Jan 6, 2025, 11:30 AM Paul Swirhun ***@***.***> wrote: Looks like it's due to hwclr usage: Short example: // Minimal example to demonstrate issue: // #245 default regwidth = 32; default accesswidth = 32; default addressing = compact; default littleendian = true; default reset = 0; default sw = r; default hw = w; signal { sync; activehigh; } latch_stats; regfile foo { default hw = na; default counter; // Issue appears to be related to including this line: default hwclr = latch_stats; reg { field {} cnt[31:0]; } num; }; addrmap my_csr { foo bar[16] %= 0x100; }; — Reply to this email directly, view it on GitHub <#245 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AC3W6I5M4F776MQ3QS7RKCL2JLKT3AVCNFSM6AAAAABUWGTUUWVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDKNZTG43TENRUHE> . You are receiving this because you commented.Message ID: ***@***.***>

[amykyta3]

Turns out this was only a partial fix. Re-opening.
I yanked the problematic releases from Pypi in the meantime.