Update build script to install tools

build_openroad.sh would previously just copy the build folder.
Installing the tool to a local folder is cleaner.

Author: rovinski

.gitignore

@@ -1,5 +1,5 @@
 # Build working directories
-tools/build/
+tools/install/
 
 # Test working directories
 flow/results

Dockerfile

@@ -8,8 +8,8 @@ RUN yum update -y \
 
 WORKDIR /OpenROAD-flow-scripts
 
-COPY --from=openroad/yosys /build ./tools/build/yosys
-COPY --from=openroad/centos7-builder-gcc /OpenROAD/build ./tools/build/OpenROAD
+COPY --from=openroad/yosys /install ./tools/install/yosys
+COPY --from=openroad/centos7-builder-gcc /OpenROAD/build/src/openroad ./tools/install/OpenROAD/bin/openroad
 COPY --from=openroad/centos7-builder-gcc /OpenROAD/etc/DependencyInstaller.sh /etc/DependencyInstaller.sh
 RUN /etc/DependencyInstaller.sh -runtime
 COPY --from=openroad/lsoracle /LSOracle/build/core/lsoracle ./tools/build/LSOracle/bin/lsoracle

build_openroad.sh

@@ -14,6 +14,7 @@ function usage() {
   echo "  --or_branch BRANCH      build using the head of branch BRANCH for OpenROAD"
   echo "  --or_repo REPO-URL      build using a fork at REPO-URL(https/ssh) for OpenROAD"
   echo "  -n, --nice              build using all cpus but nice the jobs"
+  echo "  --no_init               Skip initializing submodules"
   echo "  -c, --copy-platforms"   copy platforms to inside docker image
 
   echo "This script builds the openroad tools (OpenROAD, yosys)"
@@ -64,16 +65,16 @@ while (( "$#" )); do
       UPDATE_PLATFORM=1
       shift
       ;;
-    -n|--no_init)
-      NO_INIT=1
+    --no_init)
+      OPENROAD_FLOW_NO_INIT=1
       shift
       ;;
     -c|--copy-platforms)
       COPY_PLATFORMS="YES"
       shift
       ;;
     -*|--*=) # unsupported flags
-      echo "[ERROR][FLOW-1000] Unsupported flag $1" >&2
+      echo "[ERROR][FLOW-0004] Unsupported flag $1" >&2
       exit 1
       ;;
     *) # preserve positional arguments
@@ -85,10 +86,10 @@ done
 
 # Choose install method
 if [ -z ${BUILD_METHOD+x} ] && which docker &> /dev/null; then
-  echo "[INFO][FLOW-0000] using docker build method. This will create a docker image tagged '${DOCKER_TAG}'"
+  echo "[INFO FLOW-0000] Using docker build method. This will create a docker image tagged '${DOCKER_TAG}'"
   build_method="DOCKER"
 else
-  echo "[INFO][FLOW-0000] using local build method. This will create binaries at tools/build/"
+  echo "[INFO FLOW-0000] Using local build method. This will create binaries at tools/install/"
   build_method="LOCAL"
 fi
 
@@ -113,7 +114,7 @@ fi
 
 
 if [ ! -z ${UPDATE_OR+x} ]; then
-  echo "updating OpenROAD tool to the latest"
+  echo "[INFO FLOW-0005] Updating OpenROAD tool to the latest"
   (cd tools/OpenROAD && git fetch $CURRENT_REMOTE $OR_BRANCH \
     && git checkout $CURRENT_REMOTE/$OR_BRANCH \
     && git pull $CURRENT_REMOTE $OR_BRANCH \
@@ -124,21 +125,21 @@ fi
 if [ ! -z ${UPDATE_PLATFORM+x} ]; then
   for dir in flow/platforms/*/ ; do
     if [ -d $dir/.git ]; then
-      echo "[INFO][FLOW-0001] updating git repository '$dir'"
+      echo "[INFO FLOW-0001] Updating git repository '$dir'"
       (cd $dir && git pull)
     else
-      echo "[INFO][FLOW-0002] directory '$dir' is not a git repository. Skipping update."
+      echo "[INFO FLOW-0002] Directory '$dir' is not a git repository. Skipping update."
     fi
   done
 fi
 
 # Update developer repos
 if [ ! -z ${UPDATE_PRIVATE+x} ]; then
   if [ -d flow/private ]; then
-    echo "[INFO][FLOW-0001] updating git repository 'private'"
+    echo "[INFO FLOW-0001] Updating git repository 'private'"
     (cd flow/private && git pull)
   else
-    echo "[INFO][FLOW-0002] directory 'flow/private' is not a git repository. Skipping update."
+    echo "[INFO FLOW-0002] Directory 'flow/private' is not a git repository. Skipping update."
   fi
 fi
 
@@ -158,20 +159,19 @@ if [ "$build_method" == "DOCKER" ]; then
 
 # Local build
 elif [ "$build_method" == "LOCAL" ]; then
-  mkdir -p tools/build/yosys
-  (cd tools/yosys && $NICE make install -j$PROC PREFIX=../build/yosys CONFIG=gcc)
+  $NICE make install -C tools/yosys -j$PROC PREFIX=$(pwd)/tools/install/yosys CONFIG=gcc
 
-  mkdir -p tools/build/OpenROAD
-  (cd tools/build/OpenROAD && cmake ../../OpenROAD && $NICE make -j$PROC)
+  cmake -B tools/OpenROAD/build tools/OpenROAD -DCMAKE_INSTALL_PREFIX=tools/install/OpenROAD
+  $NICE cmake --build tools/OpenROAD/build --target install -j$PROC
 
   cmake -B tools/LSOracle/build tools/LSOracle \
         -D CMAKE_BUILD_TYPE=RELEASE \
         -D YOSYS_INCLUDE_DIR=$(pwd)/tools/yosys \
         -D YOSYS_PLUGIN=ON \
-        -D YOSYS_SHARE_DIR=$(pwd)/tools/build/yosys/share/yosys \
-        -D CMAKE_INSTALL_PREFIX=$(pwd)/tools/build/LSOracle
+        -D YOSYS_SHARE_DIR=$(pwd)/tools/install/yosys/share/yosys \
+        -D CMAKE_INSTALL_PREFIX=$(pwd)/tools/install/LSOracle
   $NICE cmake --build tools/LSOracle/build -j$PROC --target install
 else
-  echo "ERROR: No valid build method found"
+  echo "[ERROR FLOW-0003] No valid build method found"
   exit 1
 fi

flow/Makefile

@@ -200,11 +200,11 @@ export NUM_CORES := $(NPROC)
 
 export LSORACLE_CMD ?= $(shell command -v lsoracle)
 ifeq ($(LSORACLE_CMD),)
-  LSORACLE_CMD = $(abspath $(FLOW_HOME)/../tools/build/LSOracle/bin/lsoracle)
+  LSORACLE_CMD = $(abspath $(FLOW_HOME)/../tools/install/LSOracle/bin/lsoracle)
 endif
 
-LSORACLE_PLUGIN ?= $(abspath $(FLOW_HOME)/../tools/build/yosys/share/yosys/plugin/oracle.so)
-export LSORACLE_KAHYPAR_CONFIG ?= $(abspath $(FLOW_HOME)/../tools/build/LSOracle/share/lsoracle/test.ini)
+LSORACLE_PLUGIN ?= $(abspath $(FLOW_HOME)/../tools/install/yosys/share/yosys/plugin/oracle.so)
+export LSORACLE_KAHYPAR_CONFIG ?= $(abspath $(FLOW_HOME)/../tools/install/LSOracle/share/lsoracle/test.ini)
 ifneq ($(USE_LSORACLE),)
   YOSYS_FLAGS ?= -m $(LSORACLE_PLUGIN)
 endif
@@ -223,15 +223,15 @@ endif
 #       2 user explicity set with variable in Makefile or command line
 OPENROAD_EXE            ?= $(shell command -v openroad)
 ifeq ($(OPENROAD_EXE),)
-  OPENROAD_EXE           = $(abspath $(FLOW_HOME)/../tools/build/OpenROAD/src/openroad)
+  OPENROAD_EXE           = $(abspath $(FLOW_HOME)/../tools/install/OpenROAD/bin/openroad)
 endif
 OPENROAD_ARGS            = -no_init $(OR_ARGS)
 OPENROAD_CMD             = $(OPENROAD_EXE) -exit $(OPENROAD_ARGS)
 OPENROAD_NO_EXIT_CMD     = $(OPENROAD_EXE) $(OPENROAD_ARGS)
 
 YOSYS_CMD               ?= $(shell command -v yosys)
 ifeq ($(YOSYS_CMD),)
-  YOSYS_CMD              = $(abspath $(FLOW_HOME)/../tools/build/yosys/bin/yosys)
+  YOSYS_CMD              = $(abspath $(FLOW_HOME)/../tools/install/yosys/bin/yosys)
 endif
 
 KLAYOUT_CMD             ?= $(shell command -v klayout)

flow/scripts/write_ref_sdc.tcl

@@ -5,19 +5,19 @@ set margin 5
 
 set clks [all_clocks]
 if { [llength $clks] == 0 } {
-  utl::warn "FLW" 1 "No clocks found."
+  utl::warn "FLW" 6 "No clocks found."
 } else {
   set clk [lindex $clks 0]
   set clk_name [get_name $clk]
   set period [get_property $clk "period"]
   # Period is in sdc/liberty units.
-  utl::info "FLW" 2 "clock $clk_name period $period"
+  utl::info "FLW" 7 "clock $clk_name period $period"
 
   if { [llength $clks] == 1 } {
     set slack [sta::time_sta_ui [sta::worst_slack_cmd "max"]]
     set ref_period [expr ($period - $slack) * (1.0 - $margin/100.0)]
-    utl::info "FLW" 3 "Clock $clk_name period [format %.3f $ref_period]"
-    utl::info "FLW" 4 "Clock $clk_name slack [format %.3f $slack]"
+    utl::info "FLW" 8 "Clock $clk_name period [format %.3f $ref_period]"
+    utl::info "FLW" 9 "Clock $clk_name slack [format %.3f $slack]"
 
     set sources [$clk sources]
     # Redefine clock with updated period.
@@ -26,8 +26,8 @@ if { [llength $clks] == 0 } {
     unset_propagated_clock [all_clocks]
     write_sdc [file join $env(RESULTS_DIR) "updated_clks.sdc"]
   } else {
-    utl::warn "FLW" 5 "more than one clock found. Skipping sdc update."
+    utl::warn "FLW" 10 "more than one clock found. Skipping sdc update."
   }
 }
 
-utl::info "FLW" 6 "Path endpoint count [sta::endpoint_count]"
+utl::info "FLW" 11 "Path endpoint count [sta::endpoint_count]"