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

Bad error message when using Signal in add_clock_constraint not actually used in the design #374

rroohhh opened this issue Apr 30, 2020 · 4 comments


Copy link

rroohhh commented Apr 30, 2020

This snippet:

from nmigen import *
from nmigen_boards.zturn_lite_z010 import *

class Test(Elaboratable):
    def elaborate(self, plat):
        m = Module()

        clk = Signal()
        plat.add_clock_constraint(clk, 100_000_000)

        return m

plat = ZTurnLiteZ010Platform()

t = Test()

causes the following error:

Traceback (most recent call last):
  File "", line 18, in <module>
  File "/home/robin/.guix-profile/lib/python3.7/site-packages/nmigen/build/", line 90, in build
    plan = self.prepare(elaboratable, name, **kwargs)
  File "/home/robin/.guix-profile/lib/python3.7/site-packages/nmigen/build/", line 163, in prepare
    return self.toolchain_prepare(fragment, name, **kwargs)
  File "/home/robin/.guix-profile/lib/python3.7/site-packages/nmigen/build/", line 411, in toolchain_prepare
    render(content_tpl, origin=content_tpl))
  File "/home/robin/.guix-profile/lib/python3.7/site-packages/nmigen/build/", line 405, in render
    "autogenerated": autogenerated,
  File "/home/robin/.guix-profile/lib/python3.7/site-packages/jinja2/", line 1090, in render
  File "/home/robin/.guix-profile/lib/python3.7/site-packages/jinja2/", line 832, in handle_exception
  File "/home/robin/.guix-profile/lib/python3.7/site-packages/jinja2/", line 28, in reraise
    raise value.with_traceback(tb)
  File "<template>", line 12, in top-level template code
  File "/home/robin/.guix-profile/lib/python3.7/site-packages/nmigen/build/", line 369, in hierarchy
    return separator.join(name_map[signal][1:])
  File "/home/robin/.guix-profile/lib/python3.7/site-packages/nmigen/hdl/", line 1440, in __getitem__
    return self._storage[key]
KeyError: <nmigen.hdl.ast.SignalKey (sig clk)>

This is probably not likely to happen in a real design, but it is still not a really useful error message.

Copy link

whitequark commented Apr 30, 2020

This kind of thing is actually fairly likely in a generic design with a bunch of it disabled at elaboration time, so it's very important to fix it. (Suppose you request a clock at toplevel and then never pass it to a submodule later.)

Copy link
Contributor Author

rroohhh commented Apr 30, 2020

Ah makes perfect sense.

Copy link

whitequark commented May 2, 2020

Hm, this is somewhat annoying to fix because iter_clock_constraints doesn't know if the net ended up as a part of the design or not.

Copy link

whitequark commented May 2, 2020

Architecturally, I'm not sure what the best way to fix this is. I'm going to avoid thinking about this until I get around to fixing this issue, or if someone has a burning desire to get it to work they can ask here, too.

@whitequark whitequark added this to the 0.3 milestone May 20, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

No branches or pull requests

2 participants