build

Builds

Creating Builds

⚠️ At this time, we are currently recommending the use of precompiled binaries for Centos 6. See README on installing builds. We plan to address some immediate build/install issues and are working to overhaul the tools to make them more cohesive. Support for newer linux distributions is also planned. We welcome any patches to improve support for other Linux distributions and operating systems as long as they do not overly complicate the build process.

The build framework has a dependency on docker. You will need docker Docker 18.09 (or later) installed. It is also necessary to setup an ssh-agent. You can run ssh-add -L to check if the agent is setup or eval $(ssh-agent -s) to start the agent

Run the following commands to build an export

git clone [email protected]:The-OpenROAD-Project/alpha-release.git
cd build
make build-tools
make export-tools

Once the export is built (in the exports directory), it can be uploaded to the github releases.

Other interesting make targets

• make build-% This will build the specified tool (e.g. yosys, utd, replace, etc)
• make run-% This will run the specified tool image with a $USER session inside the image
• make runasroot-% This will run the specified tool image with a root session inside the image
• make export-tools This will create a tar.gz export of all tools

Builds test

To ease use, we support a simple docker image.

git clone [email protected]:The-OpenROAD-Project/alpha-release.git
cd build
make build-tools
make export-tools-docker

• make export-tools-docker This will build a docker image for test and generate a new docker container to test the compiled binaries.

The make export-tools-docker will generate a new bash shell that a user can test. Type below commands to test your compiled binaries in a docker shell.

source /openroad/setenv.sh
cd /flow/
make clean_all
make

Installing Builds

The builds can be installed to any Redhad 6 based machine. We recommend using CentOS 6.10-minimal to run a build. Download a build (OpenROAD-XXXX-XX-XX_XX-XX.tar.gz) from the release tab and perform the following steps to install.

Prerequisites on run system

1. Python3 (and the following libraries: queuelib, matplotlib)
2. tcl8.5 & tk8.5
3. libreadline6 for yosys
4. libffi.so.5 for yosys

Install procedure

tar -xzf Openroad{version}.tar.gz
cd openroad
source setup.sh

Once installed, all OpenROAD binaries should now be in your system path.

Docker install

You can pull a docker image which will have the tools and all dependencies pre-installed. To do this, you will need docker installed and have rights to run docker images. The docker image is versioned aligned with the releases.

Follow these instructions to get started

1. Pull the docker image

docker pull openroad/alpha-release

2. Run the docker image The following command will run the image as root:

docker run -i -t  openroad/alpha-release

3. You should now be able to clone the flow (this repository) or map to it and run the tools from the docker image.