Skip to content

Commit 2a7c8d8

Browse files
authored
Merge pull request #7827 from Pinata-Consulting/bazel-orfs-local-design-folder-readme
bazel-orfs: more debug README.md to demystify
2 parents 8c6268d + a67aa7b commit 2a7c8d8

1 file changed

Lines changed: 15 additions & 1 deletion

File tree

test/orfs/README.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,28 @@ The `WORK_HOME` is in `/tmp/place/_main`:
6262
Archiving issue to global_place_skip_io_Element_asap7_base_2025-07-16_08-44.tar.gz
6363
Using pigz to compress tar file
6464

65-
To use a local ORFS and OpenROAD built by CMake:
65+
## Using a local ORFS
66+
67+
bazel-orfs can set up ORFS design files locally for debugging purposes, leaving bazel-orfs entirely out of the equation when chasing down issues. Such a setup is most often a lot more convenient than using `--sandbox_debug`.
68+
69+
NOTE! keep in mind that these local ORFS design files have the depndencies `_deps` to run a particular stage only. Hence, use the `do-` prefix for doing `do-place`, `do-2_1_floorplan`, etc. so that `make` dependency checking is not used. If you use `make floorplan`, this will try to run synthesis first and not find the prequisite files, nor variables in config.mk, for synthesis and it will fail with bogus and confusing error messages.
70+
71+
If you're interested in some other stage, replace `place` with `synth`, `floorplan`, `cts`, `grt`, `route` or `final` below.
72+
73+
The `/tmp/place/make` script, if `FLOW_HOME` is set, will use a local ORFS and OpenROAD built by CMake:
6674

6775
$ . ~/OpenROAD-flow-scripts/env.sh
6876
$ /tmp/place/make print-FLOW_HOME print-OPENROAD_EXE
6977
[deleted]
7078
FLOW_HOME = /home/<username>/OpenROAD-flow-scripts/flow
7179
OPENROAD_EXE = /home/<username>/OpenROAD-flow-scripts/tools/install/OpenROAD/bin/openroad
7280

81+
More explictly ORFS only:
82+
83+
make --file=~/OpenROAD-flow-scripts/flow/Makefile -C /tmp/place/_main/ DESIGN_CONFIG=config.mk do-place
84+
85+
This is a bit more verbose, but eliminates any concerns about what the `/tmp/place/make` might be doing differently than ORFS only.
86+
7387
## Running a `make issue` with `cfg=exec` configuraiton
7488

7589
[TL;DR](../../docs/user/Bazel-targets.md), `bazelisk test ...` builds and uses the `cfg=exec` configuration when setting up paths:

0 commit comments

Comments
 (0)