Stuck on baseline OpenROAD-flow-scripts build with docker

[mguthaus]

I pretty much followed the instructions on building your own OR, but I get an error running a simple test:

git clone --recursive https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts
cd OpenROAD-flow-scripts
./build_openroad.sh
docker run --rm -it -u $(id -u ${USER}):$(id -g ${USER}) -v $(pwd)/flow:/OpenROAD-flow-scripts/flow openroad/flow-ubuntu22.04-builder

On commit 7dcbe03.

Then inside OR:

source ./env.sh
yosys -V
openroad -version
cd flow
make

And I get this:

I have no name!@6d331526d731:/OpenROAD-flow-scripts$ yosys -V
Yosys 0.42 (git sha1 9b6afcf3f, g++ 11.4.0-1ubuntu1~22.04 -fPIC -Os)
I have no name!@6d331526d731:/OpenROAD-flow-scripts$ openroad -version
v2.0-14264-g08c19394f
I have no name!@6d331526d731:/OpenROAD-flow-scripts$ cd flow
I have no name!@6d331526d731:/OpenROAD-flow-scripts/flow$ make
mkdir -p ./results/nangate45/gcd/base ./logs/nangate45/gcd/base ./reports/nangate45/gcd/base ./objects/nangate45/gcd/base
(env time -f 'Elapsed time: %E[h:]min:sec. CPU time: user %U sys %S (%P). Peak memory: %MKB.' /OpenROAD-flow-scripts/tools/install/yosys/bin/yosys -v 3 -c /OpenROAD-flow-scripts/flow/scripts/synth_canonicalize.tcl) 2>&1 | tee /OpenROAD-flow-scripts/flow/logs/nangate45/gcd/base/1_1_yosys_canonicalize.log
1. Executing Verilog-2005 frontend: /OpenROAD-flow-scripts/flow/designs/src/gcd/gcd.v
2. Executing Liberty frontend: ./objects/nangate45/gcd/base/lib/NangateOpenCellLibrary_typical.lib
ERROR: TCL interpreter returned an error: Yosys command produced an error
Command exited with non-zero status 1
Elapsed time: 0:00.13[h:]min:sec. CPU time: user 0.12 sys 0.00 (99%). Peak memory: 32980KB.
make[1]: *** [Makefile:475: do-yosys-canonicalize] Error 1
make: *** [Makefile:478: results/nangate45/gcd/base/1_synth.rtlil] Error 2
I have no name!@6d331526d731:/OpenROAD-flow-scripts/flow$

Any ideas?

[maliberty]

@vvbandeira suggestions?

[vvbandeira]

@mguthaus
What base OS are you using, and what kind of HW (num cores/threads and RAM)?
In the past, we have seen similar error codes when there's not enough HW available for Yosys to run.
Docker default values for Windows and MacOS are usually very conservative and limit access to 1-2 CPUs and 2-4GB of RAM.

[mguthaus]

This is a pretty decent machine. 12 cores, 64 gig of memory.

Ohh, maybe it is how Docker is configured and what it is allocating to the VM.

[mguthaus]

Host is Ubuntu 20.04

[mguthaus]

Seems reasonable:

CONTAINER ID NAME CPU % MEM USAGE / LIMIT MEM % NET I/O BLOCK I/O PIDS
17285f6070a1 beautiful_hellman 0.00% 1.621MiB / 62.73GiB 0.00% 9.1kB / 0B 0B / 0B 1

It fails really early, so I don't think it is a resource issue though.

[mguthaus]

I did a fresh clone, and used this commit 650e321 and it works. However, with the master version (650e321 as of now), it does not work and gives the above error.

[mguthaus]

I've been tracking this down and it fails in scripts/synth_preamble.tcl at this:

read_liberty -overwrite -setattr liberty_cell \
  -unit_delay -wb -ignore_miss_func -ignore_buses {*}$::env(DONT_USE_LIBS)

which was changed in d07d6d9. This uses some arguments that don't seem to be available in the Yosys version that is compiled:

$ yosys --version
Yosys 0.42 (git sha1 9b6afcf3f, g++ 11.4.0-1ubuntu1~22.04 -fPIC -Os)
I have no name!@46329beccc37:/OpenROAD-flow-scripts/flow$ yosys

 /----------------------------------------------------------------------------\
 |  yosys -- Yosys Open SYnthesis Suite                                       |
 |  Copyright (C) 2012 - 2024  Claire Xenia Wolf <[email protected]>         |
 |  Distributed under an ISC-like license, type "license" to see terms        |
 \----------------------------------------------------------------------------/
 Yosys 0.42 (git sha1 9b6afcf3f, g++ 11.4.0-1ubuntu1~22.04 -fPIC -Os)
yosys> help read_liberty

    read_liberty [filename]

Read cells from liberty file as modules into current design.

    -lib
        only create empty blackbox modules

    -wb
        mark imported cells as whiteboxes

    -nooverwrite
        ignore re-definitions of modules. (the default behavior is to
        create an error message if the existing module is not a blackbox
        module, and overwrite the existing module if it is  a blackbox module.)

    -overwrite
        overwrite existing modules with the same name

    -ignore_miss_func
        ignore cells with missing function specification of outputs

    -ignore_miss_dir
        ignore cells with a missing or invalid direction
        specification on a pin

    -ignore_miss_data_latch
        ignore latches with missing data and/or enable pins

    -setattr <attribute_name>
        set the specified attribute (to the value 1) on all loaded modules

Specifically, "-unit_delay" and "-ignore_buses" are not valid arguments. Did someone forget to bump the version of Yosys?

[mguthaus]

Further debugging, the build dir as Yosys 0.49:

OpenROAD-flow-scripts/tools/yosys ((HEAD detached at 427b5a251))$ git log -1
commit 427b5a251bfb511528a177bfa92567b4b3ada3dd (HEAD)
Author: Miodrag Milanovic [email protected]
Date: Tue Jan 21 14:59:09 2025 +0100

Release version 0.49

but this isn't compiled by the build_openroad.sh script.

[mguthaus]

This is related to my other discussion here: #2752

The docker build scripts aren't smart enough to detect when a submodule changes and recompile things. I imagine this is because the OR test suite also does a fresh checkout each time rather than re-compiling like a user would. I'm not sure what the best fix is now, but I do think that this is an error or at least should be documented in the build instructions.

If I made a small edit to build_openroad.sh it actually re-runs this command and rebuilds everything:

#22 [orfs-builder-base 2/2] RUN echo "" > tools/yosys/abc/.gitcommit && env CFLAGS="-D__TIME__=0 -D__DATE__=0 -D__TIMESTAMP__=0 -Wno-builtin-macro-redefined" CXXFLAGS="-D__TIME__=0 -D__DATE__=0 -D__TIMESTAMP__=0 -Wno-builtin-macro-redefined" ./build_openroad.sh --no_init --local --threads 12

[mguthaus]

The docker image still includes the old version of yosys though. :(

[mguthaus]

ah hah! The suggested command in the documentation runs an OLD docker image:

docker run --rm -it -u $(id -u ${USER}):$(id -g ${USER}) -v $(pwd)/flow:/OpenROAD-flow-scripts/flow openroad/flow-ubuntu22.04-builder

Needs to specify which version of the image to use:

docker run --rm -it -u $(id -u ${USER}):$(id -g ${USER}) -v $(pwd)/flow:/OpenROAD-flow-scripts/flow openroad/flow-ubuntu22.04-builder:770124

I'm going to clarify this in the documentation to help other people...

[mguthaus]

$ docker images | grep builder
openroad/flow-ubuntu22.04-builder        770124                                                                                       33fbf94607d1   7 minutes ago    4.75GB
openroad/flow-ubuntu22.04-builder        6d5491                                                                                       00ca0c2b00cb   24 minutes ago   4.75GB
openroad/flow-ubuntu22.04-builder        30f9b4                                                                                       1e032617a708   4 months ago     4.64GB
openroad/flow-ubuntu22.04-builder        latest                                                                                       3c433ba459b2   7 months ago     11.4GB

It runs the "latest" which was tagged 7 months ago...