orfs-installation.md

Installing OpenROAD Flow Scripts

This assumes you are on a Unix machine or are using WSL.

In this method, Docker will provide the binaries, but you first need to install Docker depending on your OS.

Check Docker

Check that Docker is working by running:

$ docker run -it hello-world
Unable to find image 'hello-world:latest' locally
latest: Pulling from library/hello-world
e6590344b1a5: Pull complete
Digest: sha256:0b6a027b5cf322f09f6706c754e086a232ec1ddba835c8a15c6cb74ef0d43c29
Status: Downloaded newer image for hello-world:latest

Hello from Docker!
This message shows that your installation appears to be working correctly.

To generate this message, Docker took the following steps:
 1. The Docker client contacted the Docker daemon.
 2. The Docker daemon pulled the "hello-world" image from the Docker Hub.
    (amd64)
 3. The Docker daemon created a new container from that image which runs the
    executable that produces the output you are currently reading.
 4. The Docker daemon streamed that output to the Docker client, which sent it
    to your terminal.

To try something more ambitious, you can run an Ubuntu container with:
 $ docker run -it ubuntu bash

Share images, automate workflows, and more with a free Docker ID:
 https://hub.docker.com/

For more examples and ideas, visit:
 https://docs.docker.com/get-started/

Install ORFS

First, clone ORFS to get the designs and scripts:

git clone https://github.com/The-OpenROAD-Project/OpenROAD-flow-scripts.git
cd OpepNROAD-flow-scripts

Then, I use a bash script that I created to run ORFS:

# !/bin/bash
TAG="${1:-latest}"
echo "Running OpenROAD flow with tag: ${TAG}"
docker run --rm -it \
 -u $(id -u ${USER}):$(id -g ${USER}) \
 -v $(pwd)/flow:/OpenROAD-flow-scripts/flow \
 -e DISPLAY=${DISPLAY} \
 -v /tmp/.X11-unix:/tmp/.X11-unix \
 -v ${HOME}/.Xauthority:/.Xauthority \
 --network host \
 --security-opt seccomp=unconfined \
 openroad/orfs:${TAG}

This will not only export your display so you can run GUI applicatios in the Docker, but it also mounts the directory "flow" on your local filesystem in the Docker image. This directory contains the designs, scripts, and the results when you run the designs.

Add the runorfs.sh to your filesystem in the ORFS cloned directory as a file called runorfs.sh and make it executable:

chmod +x runorfs.sh

You can run the latest by just executing the script, or you can specify a particular tag. If you don't specify the tag, it will pull the most recent version every time and you may get updates that you don't expect. If you want to use a specific version, you can specify it like this:

# for the latest version

./runorfs.sh

# for a specific version
# make sure ORFS repository is the same version
git checkout v3.0-3141-gb6d79b23
# run a particular version
./runofs.sh v3.0-3141-gb6d79b23

Beware, your cloned version of ORFS should match the version of the Docker image that you run. If it doesn't, you may get differences if the command interfaces change.

Smoke Test

To check your installation, run a smoke test:

I have no name!@diode:/OpenROAD-flow-scripts$ cd flow
I have no name!@diode:/OpenROAD-flow-scripts/flow$ make

You will get a lot of output, but it should end with something like this:

1_1_yosys                                    0             42
1_1_yosys_canonicalize                       0             38
2_1_floorplan                                0             97
2_2_floorplan_macro                          0             93
2_3_floorplan_tapcell                        0             93
2_4_floorplan_pdn                            0             95
3_1_place_gp_skip_io                         0             94
3_2_place_iop                                0             94
3_3_place_gp                                 1            194
3_4_place_resized                            0            113
3_5_place_dp                                 0             99
4_1_cts                                      4            120
5_1_grt                                     10            213
5_2_route                                   17           1175
5_3_fillcell                                 0             97
6_1_fill                                     0             95
6_1_merge                                    1            390
6_report                                     0            137
Total                                       33           1175

Note, there might be a few "WARNING" messages, but that is ok. To view the final result, you can run:

I have no name!@diode:/OpenROAD-flow-scripts/flow$ make gui_final

which should open the GCD design like this:

Troubleshooting

You may get the following error if you try to run GUI applications from the docker.

Authorization required, but no authorization protocol specified
Could not load the Qt platform plugin "xcb" in "" even though it was found.

You can resolve this by running:

xhost +local:

before you start the Docker image. This will give the docker container permission to access your display server (X11).

License

Copyright 2024 VLSI-DA (see LICENSE for use)