makefile: move code out of make into bash

A step in the right direction to getting rid of makefile dependency

Signed-off-by: Øyvind Harboe <oyvind.harboe@zylin.com>

Author: oharboe

flow/Makefile

@@ -89,6 +89,24 @@ DESIGN_CONFIG ?= ./designs/nangate45/gcd/config.mk
 # in this file. This allows the DESIGN_CONFIG to set different defaults than
 # this file.
 include $(DESIGN_CONFIG)
+export DESIGN_NICKNAME?=$(DESIGN_NAME)
+export FLOW_VARIANT?=base
+ifneq ($(BLOCKS),)
+  # Normally this comes from variables.yaml, but we need it here to set up these variables
+  # which are part of the DESIGN_CONFIG. BLOCKS is a Makefile specific concept.
+  $(foreach block,$(BLOCKS),$(eval BLOCK_LEFS += ./results/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/${block}.lef))
+  $(foreach block,$(BLOCKS),$(eval BLOCK_LIBS += ./results/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/${block}.lib))
+  $(foreach block,$(BLOCKS),$(eval BLOCK_GDS += ./results/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/6_final.gds))
+  $(foreach block,$(BLOCKS),$(eval BLOCK_CDL += ./results/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/6_final.cdl))
+  $(foreach block,$(BLOCKS),$(eval BLOCK_LOG_FOLDERS += ./logs/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/))
+  export ADDITIONAL_LEFS += $(BLOCK_LEFS)
+  export ADDITIONAL_LIBS += $(BLOCK_LIBS)
+  export ADDITIONAL_GDS += $(BLOCK_GDS)
+  export GDS_FILES += $(BLOCK_GDS)
+  ifneq ($(CDL_FILES),)
+    export CDL_FILES += $(BLOCK_CDL)
+  endif
+endif
 
 # If we are running headless use offscreen rendering for save_image
 ifeq ($(DISPLAY),)
@@ -117,151 +135,40 @@ MAKEFLAGS += --no-builtin-rules
 SHELL          := /usr/bin/env bash
 .SHELLFLAGS    := -o pipefail -c
 
-#-------------------------------------------------------------------------------
-# Setup variables to point to root / head of the OpenROAD directory
-# - the following settings allowed user to point OpenROAD binaries to different
-#   location
-# - default is current install / clone directory
 ifeq ($(origin FLOW_HOME), undefined)
 FLOW_HOME := $(abspath $(dir $(firstword $(MAKEFILE_LIST))))
 endif
 export FLOW_HOME
 
-#-------------------------------------------------------------------------------
-# Setup variables to point to other location for the following sub directory
-# - designs - default is under current directory
-# - platforms - default is under current directory
-# - work home - default is current directory
-# - utils, scripts, test - default is under current directory
-export DESIGN_HOME   ?= $(FLOW_HOME)/designs
-export PLATFORM_HOME ?= $(FLOW_HOME)/platforms
-export WORK_HOME     ?= .
-
-export UTILS_DIR     ?= $(FLOW_HOME)/util
-export SCRIPTS_DIR   ?= $(FLOW_HOME)/scripts
-export TEST_DIR      ?= $(FLOW_HOME)/test
-
-PUBLIC=nangate45 sky130hd sky130hs asap7 ihp-sg13g2 gf180
-
-ifneq ($(wildcard $(PLATFORM_HOME)/$(PLATFORM)),)
-  export PLATFORM_DIR = $(PLATFORM_HOME)/$(PLATFORM)
-else ifneq ($(findstring $(PLATFORM),$(PUBLIC)),)
-  export PLATFORM_DIR = ./platforms/$(PLATFORM)
-else ifneq ($(wildcard ../../$(PLATFORM)),)
-  export PLATFORM_DIR = ../../$(PLATFORM)
-else
-  $(error [ERROR][FLOW] Platform '$(PLATFORM)' not found.)
-endif
-
-include $(PLATFORM_DIR)/config.mk
-
+# The plan is to migrate all variables to .sh so that
+# ORFS is no longer dependent on make.
+#
+# Explicitly enumerate the environment variables we need $SCRIPTS/config.sh
+# to see since make doesn't pass its environment to subshells.
+#
 # __SPACE__ is a workaround for whitespace hell in "foreach"; there
 # is no way to escape space in defaults.py and get "foreach" to work.
-$(foreach line,$(shell $(SCRIPTS_DIR)/defaults.py),$(eval export $(subst __SPACE__, ,$(line))))
-
-# Not normally adjusted by user
-export SYNTH_OPERATIONS_ARGS ?= -extra-map $(FLOW_HOME)/platforms/common/lcu_kogge_stone.v
-export SYNTH_FULL_ARGS ?= $(SYNTH_ARGS) $(SYNTH_OPERATIONS_ARGS)
-
-# Setup working directories
-export DESIGN_NICKNAME ?= $(DESIGN_NAME)
-
-export DESIGN_CONFIG
-export DESIGN_DIR  = $(dir $(DESIGN_CONFIG))
-export LOG_DIR     = $(WORK_HOME)/logs/$(PLATFORM)/$(DESIGN_NICKNAME)/$(FLOW_VARIANT)
-export OBJECTS_DIR = $(WORK_HOME)/objects/$(PLATFORM)/$(DESIGN_NICKNAME)/$(FLOW_VARIANT)
-export REPORTS_DIR = $(WORK_HOME)/reports/$(PLATFORM)/$(DESIGN_NICKNAME)/$(FLOW_VARIANT)
-export RESULTS_DIR = $(WORK_HOME)/results/$(PLATFORM)/$(DESIGN_NICKNAME)/$(FLOW_VARIANT)
-
-ifneq ($(BLOCKS),)
-  $(foreach block,$(BLOCKS),$(eval BLOCK_LEFS += ./results/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/${block}.lef))
-  $(foreach block,$(BLOCKS),$(eval BLOCK_LIBS += ./results/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/${block}.lib))
-  $(foreach block,$(BLOCKS),$(eval BLOCK_GDS += ./results/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/6_final.gds))
-  $(foreach block,$(BLOCKS),$(eval BLOCK_CDL += ./results/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/6_final.cdl))
-  $(foreach block,$(BLOCKS),$(eval BLOCK_LOG_FOLDERS += ./logs/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/))
-  export ADDITIONAL_LEFS += $(BLOCK_LEFS)
-  export ADDITIONAL_LIBS += $(BLOCK_LIBS)
-  export ADDITIONAL_GDS += $(BLOCK_GDS)
-  export GDS_FILES += $(BLOCK_GDS)
-  ifneq ($(CDL_FILES),)
-    export CDL_FILES += $(BLOCK_CDL)
-  endif
-endif
-
-#-------------------------------------------------------------------------------
-ifeq (,$(strip $(NUM_CORES)))
-  # Linux (utility program)
-  NUM_CORES := $(shell nproc 2>/dev/null)
-
-  ifeq (,$(strip $(NUM_CORES)))
-    # Linux (generic)
-    NUM_CORES := $(shell grep -c ^processor /proc/cpuinfo 2>/dev/null)
-  endif
-  ifeq (,$(strip $(NUM_CORES)))
-    # BSD (at least FreeBSD and Mac OSX)
-    NUM_CORES := $(shell sysctl -n hw.ncpu 2>/dev/null)
-  endif
-  ifeq (,$(strip $(NUM_CORES)))
-    # Fallback
-    NUM_CORES := 1
-  endif
-endif
-export NUM_CORES
-
-YOSYS_FLAGS += -v 3
-
-#-------------------------------------------------------------------------------
-# setup all commands used within this flow
-export TIME_BIN   ?= env time
-TIME_CMD = $(TIME_BIN) -f 'Elapsed time: %E[h:]min:sec. CPU time: user %U sys %S (%P). Peak memory: %MKB.'
-TIME_TEST = $(shell $(TIME_CMD) echo foo 2>/dev/null)
-ifeq (,$(strip $(TIME_TEST)))
-  TIME_CMD = $(TIME_BIN)
-endif
-
-# The following determine the executable location for each tool used by this flow.
-# Priority is given to
-#       1 user explicit set with variable in Makefile or command line, for instance setting OPENROAD_EXE
-#       2 ORFS compiled tools: openroad, yosys
-ifneq (${IN_NIX_SHELL},)
-  export OPENROAD_EXE := $(shell command -v openroad)
-else
-  export OPENROAD_EXE ?= $(abspath $(FLOW_HOME)/../tools/install/OpenROAD/bin/openroad)
+$(foreach line,$(shell \
+ DESIGN_NAME=$(DESIGN_NAME) \
+ FLOW_HOME=$(FLOW_HOME) \
+ DESIGN_CONFIG=$(DESIGN_CONFIG) \
+ PLATFORM=$(PLATFORM) \
+ FLOW_VARIANT=$(FLOW_VARIANT) \
+ DESIGN_NICKNAME=$(DESIGN_NICKNAME) \
+ $(FLOW_HOME)/scripts/env.sh $(FLOW_HOME)/scripts/config.sh),$(eval $(subst __SPACE__, ,$(line))))
+
+# check some critical variables in a loop
+$(foreach var,DESIGN_NAME DESIGN_NICKNAME PLATFORM,\
+  $(if $(strip $($(var))),,$(error $(var) is not set)))
+
+# The plan is to move all config.mk variables into $(PLATFORM_DIR)/config.sh and
+# delete this include below
+ifneq ($(wildcard $(PLATFORM_DIR)/config.mk),)
+  include $(PLATFORM_DIR)/config.mk
 endif
-ifneq (${IN_NIX_SHELL},)
-  export OPENSTA_EXE := $(shell command -v sta)
-else
-  export OPENSTA_EXE ?= $(abspath $(FLOW_HOME)/../tools/install/OpenROAD/bin/sta)
-endif
-
-OPENROAD_ARGS            = -no_init -threads $(NUM_CORES) $(OR_ARGS)
-OPENROAD_CMD             = $(OPENROAD_EXE) -exit $(OPENROAD_ARGS)
-OPENROAD_NO_EXIT_CMD     = $(OPENROAD_EXE) $(OPENROAD_ARGS)
-OPENROAD_GUI_CMD         = $(OPENROAD_EXE) -gui $(OR_ARGS)
-
-ifneq (${IN_NIX_SHELL},)
-  YOSYS_EXE := $(shell command -v yosys)
-else
-  YOSYS_EXE ?= $(abspath $(FLOW_HOME)/../tools/install/yosys/bin/yosys)
-endif
-
-# Use locally installed and built klayout if it exists, otherwise use klayout in path
-KLAYOUT_DIR = $(abspath $(FLOW_HOME)/../tools/install/klayout/)
-KLAYOUT_BIN_FROM_DIR = $(KLAYOUT_DIR)/klayout
 
-ifeq ($(wildcard $(KLAYOUT_BIN_FROM_DIR)), $(KLAYOUT_BIN_FROM_DIR))
-KLAYOUT_CMD ?= sh -c 'LD_LIBRARY_PATH=$(dir $(KLAYOUT_BIN_FROM_DIR)) $$0 "$$@"' $(KLAYOUT_BIN_FROM_DIR)
-else
-ifeq ($(KLAYOUT_CMD),)
-KLAYOUT_CMD := $(shell command -v klayout)
-endif
-endif
 KLAYOUT_FOUND            = $(if $(KLAYOUT_CMD),,$(error KLayout not found in PATH))
 
-ifneq ($(shell command -v stdbuf),)
-  STDBUF_CMD ?= stdbuf -o L
-endif
-
 #-------------------------------------------------------------------------------
 WRAPPED_LEFS = $(foreach lef,$(notdir $(WRAP_LEFS)),$(OBJECTS_DIR)/lef/$(lef:.lef=_mod.lef))
 WRAPPED_LIBS = $(foreach lib,$(notdir $(WRAP_LIBS)),$(OBJECTS_DIR)/$(lib:.lib=_mod.lib))
@@ -432,10 +339,6 @@ memory:
 
 # Run Synthesis using yosys
 #-------------------------------------------------------------------------------
-
-export SYNTH_SCRIPT ?= $(SCRIPTS_DIR)/synth.tcl
-export SDC_FILE_CLOCK_PERIOD = $(RESULTS_DIR)/clock_period.txt
-
 $(SDC_FILE_CLOCK_PERIOD): $(SDC_FILE)
 	mkdir -p $(dir $@)
 	echo $(ABC_CLOCK_PERIOD_IN_PS) > $@
@@ -447,13 +350,11 @@ yosys-dependencies: $(YOSYS_DEPENDENCIES)
 
 .PHONY: do-yosys
 do-yosys: $(DONT_USE_SC_LIB)
-	mkdir -p $(RESULTS_DIR) $(LOG_DIR) $(REPORTS_DIR) $(OBJECTS_DIR)
-	($(TIME_CMD) $(YOSYS_EXE) $(YOSYS_FLAGS) -c $(SYNTH_SCRIPT)) 2>&1 | tee $(abspath $(LOG_DIR)/1_1_yosys.log)
+	$(SCRIPTS_DIR)/synth.sh $(SYNTH_SCRIPT) $(LOG_DIR)/1_1_yosys.log
 
 .PHONY: do-yosys-canonicalize
 do-yosys-canonicalize: yosys-dependencies $(DONT_USE_SC_LIB)
-	mkdir -p $(RESULTS_DIR) $(LOG_DIR) $(REPORTS_DIR) $(OBJECTS_DIR)
-	($(TIME_CMD) $(YOSYS_EXE) $(YOSYS_FLAGS) -c $(SCRIPTS_DIR)/synth_canonicalize.tcl) 2>&1 | tee $(abspath $(LOG_DIR)/1_1_yosys_canonicalize.log)
+	$(SCRIPTS_DIR)/synth.sh $(SCRIPTS_DIR)/synth_canonicalize.tcl $(LOG_DIR)/1_1_yosys_canonicalize.log
 
 $(RESULTS_DIR)/1_synth.rtlil: $(YOSYS_DEPENDENCIES)
 	$(UNSET_AND_MAKE) do-yosys-canonicalize
@@ -560,13 +461,7 @@ endif
 
 .PHONY: do-$(1)
 do-$(1): $(OBJECTS_DIR)/copyright.txt
-	@mkdir -p $(RESULTS_DIR) $(LOG_DIR) $(REPORTS_DIR) $(OBJECTS_DIR)
-	@echo Running $(3).tcl, stage $(1)
-	@(set -eo pipefail; \
-	trap 'mv $(LOG_DIR)/$(1).tmp.log $(LOG_DIR)/$(1).log' EXIT; \
-	$(OPENROAD_EXE) $(OPENROAD_ARGS) -exit $(SCRIPTS_DIR)/noop.tcl 2>&1 >$(LOG_DIR)/$(1).tmp.log; \
-	$(TIME_CMD) $(OPENROAD_CMD) -no_splash $(SCRIPTS_DIR)/$(3).tcl -metrics $(LOG_DIR)/$(1).json 2>&1 | \
-	tee -a $(abspath $(LOG_DIR)/$(1).tmp.log))
+	$(SCRIPTS_DIR)/flow.sh $(1) $(3)
 endef
 
 # generate make rules to copy a file, if a dependency change and

flow/platforms/asap7/config.mk

@@ -1,6 +1,3 @@
-export PLATFORM                = asap7
-export PROCESS                 = 7
-
 ifeq ($(LIB_MODEL),)
    export LIB_MODEL = NLDM
 endif

flow/platforms/asap7/config.sh

@@ -0,0 +1 @@
+export PROCESS=7

flow/platforms/nangate45/config.mk

@@ -1,6 +1,3 @@
-# Process node
-export PROCESS = 45
-
 #-----------------------------------------------------
 # Tech/Libs
 # ----------------------------------------------------

flow/platforms/nangate45/config.sh

@@ -0,0 +1,2 @@
+# Process node
+export PROCESS=45

flow/scripts/README.md

@@ -2,6 +2,14 @@
 
 Various scripts to support flow as well as utilities.
 
+## flow.sh/synth.sh - WORK IN PROGRESS
+
+This script is a low level script used to invoke a flow step. ORFS make or bazel-orfs will set up all the project specific variables before invoking this script where the rest of the variables are set up before invoking OpenROAD.
+
+    scripts/flow.sh 2_1_floorplan floorplan
+
+    scripts/synth.sh $SYNTH_SCRIPT $LOG_DIR/1_1_yosys.log
+
 ## make run-yosys
 
 Sets up all the ORFS environment variables and launches Yosys.

flow/scripts/config.sh

@@ -0,0 +1,119 @@
+#!/bin/bash
+set -u
+
+# Set default paths
+export PLATFORM_HOME="${PLATFORM_HOME:-${FLOW_HOME}/platforms}"
+export WORK_HOME="${WORK_HOME:-.}"
+export SCRIPTS_DIR="${SCRIPTS_DIR:-${FLOW_HOME}/scripts}"
+
+# Define public platforms
+PUBLIC="nangate45 sky130hd sky130hs asap7 ihp-sg13g2 gf180"
+
+# Determine PLATFORM_DIR based on PLATFORM
+if [[ -d "${PLATFORM_HOME}/${PLATFORM}" ]]; then
+  export PLATFORM_DIR="${PLATFORM_HOME}/${PLATFORM}"
+elif [[ " ${PUBLIC} " == *" ${PLATFORM} "* ]]; then
+  export PLATFORM_DIR="./platforms/${PLATFORM}"
+elif [[ -d "../../${PLATFORM}" ]]; then
+  export PLATFORM_DIR="../../${PLATFORM}"
+fi
+
+export DESIGN_HOME="${DESIGN_HOME:-${FLOW_HOME}/designs}"
+export UTILS_DIR="${UTILS_DIR:-${FLOW_HOME}/util}"
+export SCRIPTS_DIR="${SCRIPTS_DIR:-${FLOW_HOME}/scripts}"
+export TEST_DIR="${TEST_DIR:-${FLOW_HOME}/test}"
+
+# if $PLATFORM_DIR/config.sh exists, source it
+if [ -f "${PLATFORM_DIR}/config.sh" ]; then
+  source "${PLATFORM_DIR}/config.sh"
+fi
+
+export TIME_BIN="${TIME_BIN:-env time}"
+TIME_CMD="$TIME_BIN -f 'Elapsed time: %E[h:]min:sec. CPU time: user %U sys %S (%P). Peak memory: %MKB.'"
+if ! TIME_TEST=$(eval "$TIME_CMD echo foo" 2>/dev/null); then
+  TIME_CMD="$TIME_BIN"
+fi
+export TIME_CMD
+
+# Setup working directories
+export DESIGN_NICKNAME="${DESIGN_NICKNAME:=${DESIGN_NAME}}"
+
+export DESIGN_DIR="$(dirname "${DESIGN_CONFIG}")"
+export LOG_DIR="${WORK_HOME}/logs/${PLATFORM}/${DESIGN_NICKNAME}/${FLOW_VARIANT}"
+export OBJECTS_DIR="${WORK_HOME}/objects/${PLATFORM}/${DESIGN_NICKNAME}/${FLOW_VARIANT}"
+export REPORTS_DIR="${WORK_HOME}/reports/${PLATFORM}/${DESIGN_NICKNAME}/${FLOW_VARIANT}"
+export RESULTS_DIR="${WORK_HOME}/results/${PLATFORM}/${DESIGN_NICKNAME}/${FLOW_VARIANT}"
+
+# Run the defaults.py script and process its output
+while IFS= read -r line; do
+  # Replace "__SPACE__" with an actual space in the line
+  eval "${line//__SPACE__/ }"
+done < <("${FLOW_HOME}/scripts/defaults.py")
+
+
+# Determine the number of cores (NUM_CORES)
+if [[ -z "${NUM_CORES:-}" ]]; then
+  # Linux (utility program)
+  NUM_CORES=$(nproc 2>/dev/null || true)
+
+  if [[ -z "$NUM_CORES" ]]; then
+    # Linux (generic)
+    NUM_CORES=$(grep -c ^processor /proc/cpuinfo 2>/dev/null || true)
+  fi
+
+  if [[ -z "$NUM_CORES" ]]; then
+    # BSD (at least FreeBSD and macOS)
+    NUM_CORES=$(sysctl -n hw.ncpu 2>/dev/null || true)
+  fi
+
+  if [[ -z "$NUM_CORES" ]]; then
+    # Fallback
+    NUM_CORES=1
+  fi
+fi
+export NUM_CORES
+
+# Determine the executable location for each tool used by this flow.
+# Priority is given to:
+# 1. User explicitly setting the variable in the environment or command line (e.g., OPENROAD_EXE).
+# 2. Default ORFS compiled tools: openroad, yosys.
+
+# Set default paths for executables if not already set
+if [[ -n "${IN_NIX_SHELL:-}" ]]; then
+  export OPENROAD_EXE=$(command -v openroad)
+fi
+export OPENROAD_EXE="${OPENROAD_EXE:-$(realpath "${FLOW_HOME}/../tools/install/OpenROAD/bin/openroad")}"
+export OPENSTA_EXE="${OPENSTA_EXE:-$(realpath "${FLOW_HOME}/../tools/install/OpenROAD/bin/sta")}"
+if [[ -n "${IN_NIX_SHELL:-}" ]]; then
+  export YOSYS_EXE=$(command -v yosys)
+fi
+export YOSYS_EXE="${YOSYS_EXE:-$(realpath "${FLOW_HOME}/../tools/install/yosys/bin/yosys")}"
+
+# Define OpenROAD command-line arguments
+export OPENROAD_ARGS="-no_init -threads ${NUM_CORES} ${OR_ARGS:-}"
+
+# Define OpenROAD commands
+export OPENROAD_CMD="${OPENROAD_EXE} -exit ${OPENROAD_ARGS}"
+export OPENROAD_NO_EXIT_CMD="${OPENROAD_EXE} ${OPENROAD_ARGS}"
+export OPENROAD_GUI_CMD="${OPENROAD_EXE} -gui ${OR_ARGS:-}"
+
+# Use locally installed and built klayout if it exists, otherwise use klayout in path
+KLAYOUT_DIR="$(realpath "${FLOW_HOME}/../tools/install/klayout/")"
+KLAYOUT_BIN_FROM_DIR="${KLAYOUT_DIR}/klayout"
+
+if [[ -x "${KLAYOUT_BIN_FROM_DIR}" ]]; then
+  export KLAYOUT_CMD="sh -c 'LD_LIBRARY_PATH=$(dirname "${KLAYOUT_BIN_FROM_DIR}") \$0 \"\$@\"' ${KLAYOUT_BIN_FROM_DIR}"
+else
+  if [[ -z "${KLAYOUT_CMD:-}" ]]; then
+    KLAYOUT_CMD="$(command -v klayout || true)"
+  fi
+fi
+export KLAYOUT_CMD
+
+# Check if `stdbuf` is available and set STDBUF_CMD
+if command -v stdbuf &>/dev/null; then
+  export STDBUF_CMD="stdbuf -o L"
+fi
+
+export SYNTH_SCRIPT="${SYNTH_SCRIPT:-${SCRIPTS_DIR}/synth.tcl}"
+export SDC_FILE_CLOCK_PERIOD="${SDC_FILE_CLOCK_PERIOD:-${RESULTS_DIR}/clock_period.txt}"