mirrors/yosys
3
0
Fork 0
mirror of https://github.com/YosysHQ/yosys synced 2025-06-27 16:38:46 +00:00
Code Activity

advanced_bugpoint.rst: --dump-design

Browse source 
Also fix missing double backtick.
This commit is contained in:
Krystine Sherwin 2025-06-14 14:53:35 +12:00
parent d5e48ce75a
commit 3d9fcea581
No known key found for this signature in database
1 changed files with 20 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

25
docs/source/yosys_internals/extending_yosys/advanced_bugpoint.rst
View file

@ -213,16 +213,31 @@ in the right direction:
Try running the unminimized script and search the log for the names of the Try running the unminimized script and search the log for the names of the
objects in your minimized design. In the case of cells you can also search for objects in your minimized design. In the case of cells you can also search for
the type of the cell. Remember that calling `stat` will list all the types of the type of the cell. Remember that calling `stat` will list all the types of
cells currently used in the design, and `select -list =*` will list the names of cells currently used in the design, and ``select -list =*`` will list the names
of all the current objects. You can add these commands to your script, or use of of all the current objects. You can add these commands to your script, or
an interactive terminal to run each command individually. Adding them to the use an interactive terminal to run each command individually. Adding them to
script can be more repeatable, but if it takes a long time to run to the point the script can be more repeatable, but if it takes a long time to run to the
you're interested in then an interactive shell session can give you more point you're interested in then an interactive shell session can give you more
flexibility once you reach that point. You can also add a call to the `shell` flexibility once you reach that point. You can also add a call to the `shell`
command at any point in a script to start an interactive session at a given command at any point in a script to start an interactive session at a given
point; allowing you to script any preparation steps, then come back once it's point; allowing you to script any preparation steps, then come back once it's
done. done.
The ``--dump-design`` option
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Yosys provides the ``--dump-design`` option (or ``-P`` for short) for dumping
the design at specific steps of the script based on the log header. If the last
step before an error is ``7.2. Executing MEMORY_MAP pass (converting memories to
logic and flip-flops)``, then calling Yosys with ``--dump-design 7.2:bad.il``
will save the design *before* this command runs, in the file ``bad.il``.
It is also possible to use this option multiple times, e.g. ``-P2:hierarchy.il
-P7 -P7.2:bad.il``, to get multiple dumps in the same run. This can make it
easier to follow the design through each step to find where certain cells or
connections are coming from. ``--dump-design ALL`` is also allowed, writing out
the design at each log header.
A worked example A worked example
~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~