bdb1b56f58
* Only `read_verilog` if there's no CURRENT_DEF: see https://github.com/The-OpenROAD-Project/OpenROAD/issues/1305#issuecomment-968336079 (Practically didn't cause an issue as all DEFs are used without the standalone flag) * or_issue now supports netlist inputs and no longer generates tarballs: encourages inspecting and running the code before uploading a tarball * or_issue now also creates tcl, gdb and lldb files * OpenROAD commit now sedded in instead of GITDIR-NOTFOUND: See last paragraph of https://github.com/Cloud-V/DFFRAM/issues/115
3.0 KiB
or_issue.py
This script creates a reproducible, self-contained package of files to demonstrate OpenROAD behavior in a vaccum, suitable for filing issues.
It outputs a tarball with a small run script that you can then submit as an issue to OpenROAD.
Usage
You'll have to extract three key elements from the error:
- The Script Where The Failure Occurred -> script
- The Final Layout Before The Failure Occurred -> input
- The Run Path -> run_path
- The run path can be derived from the input, so typically, you do not have to explicitly specify it.
You must run or_issue.py from the same filesystem you've run OpenLane with. i.e., if you ran it inside the Docker container, you need to make mount first.
As a practical example, for this log from flow_summary.txt:
[INFO]: Changing layout from /openlane/designs/spm/runs/config_TEST_fastestTestSet1/results/cts/spm.cts.def to /openlane/designs/spm/runs/config_TEST_fastestTestSet1/tmp/placement/12-resizer_timing.def
[...]
[INFO]: Running Global Routing...
[INFO]: current step index: 15
[INFO]: Changing layout from /openlane/designs/spm/runs/config_TEST_fastestTestSet1/tmp/placement/12-resizer_timing.def to /openlane/designs/spm/runs/config_TEST_fastestTestSet1/tmp/routing/15-fastroute.def
The three elements would be:
- input:
./designs/spm/runs/config_TEST_fastestTestSet1/tmp/placement/12-resizer_timing.def - script:
./scripts/openroad/groute.tcl - run_path:
./designs/spm/runs/config_TEST_fastestTestSet1
Then you'd want to run this script as follows, from the root of the OpenLane Repo:
python3 ./scripts/or_issue.py\
-s ./scripts/openroad/groute.tcl\
./designs/spm/runs/config_TEST_fastestTestSet1/tmp/placement/12-resizer_timing.def
# run path is implicitly specified by input def: ./designs/spm/runs/config_TEST_fastestTestSet1
Which will create a folder called _build, with a single sub entry:
config_TEST_fastestTestSet1_or_groute_packaged/
Ensure that you inspect this folder manually and the output of this script. This script only attempts a best effort, and it is very likely that it might miss something, in which case, feel free to file an issue.
You can then verify that the script worked by running:
cd _build/config_TEST_fastestTestSet1_or_groute_packaged
./run
You can override the OpenROAD binary used as follows:
cd _build/config_TEST_fastestTestSet1_or_groute_packaged
OPENROAD_BIN=/usr/local/bin/whatever ./run
Warning about proprietary files
When working with a proprietary PDK, also inspect the tarball and ensure no proprietary data resulting ends up in there. This is critical, if something leaks, this scripts' authors take no responsibility and you are very much on your own. We will try our best to output warnings for your own good if something looks like a part of a proprietary PDK, but the absence of this message does not necessarily indicate that your folder is free of confidential material.