variables: demonstrate migration path from make to bash

Signed-off-by: Øyvind Harboe <[email protected]>

Author: oharboe

flow/Makefile

@@ -113,61 +113,36 @@ 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)
+$(foreach line,$(shell \
+ DESIGN_NAME=$(DESIGN_NAME) \
+ FLOW_HOME=$(FLOW_HOME) \
+ DESIGN_CONFIG=$(DESIGN_CONFIG) \
+ PLATFORM=$(PLATFORM) \
+ FLOW_VARIANT=$(FLOW_VARIANT) \
+ $(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 ($(BLOCKS),)
   $(foreach block,$(BLOCKS),$(eval BLOCK_LEFS += ./results/$(PLATFORM)/$(DESIGN_NICKNAME)_$(block)/$(FLOW_VARIANT)/${block}.lef))
@@ -208,16 +183,7 @@ ifeq (,$(strip $(NUM_CORES)))
 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
+export YOSYS_FLAGS += -v 3
 
 # The following determine the executable location for each tool used by this flow.
 # Priority is given to
@@ -226,12 +192,12 @@ endif
 export OPENROAD_EXE      ?= $(abspath $(FLOW_HOME)/../tools/install/OpenROAD/bin/openroad)
 export OPENSTA_EXE       ?= $(abspath $(FLOW_HOME)/../tools/install/OpenROAD/bin/sta)
 
-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)
+export OPENROAD_ARGS            = -no_init -threads $(NUM_CORES) $(OR_ARGS)
+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)
 
-YOSYS_EXE               ?= $(abspath $(FLOW_HOME)/../tools/install/yosys/bin/yosys)
+export YOSYS_EXE               ?= $(abspath $(FLOW_HOME)/../tools/install/yosys/bin/yosys)
 
 # Use locally installed and built klayout if it exists, otherwise use klayout in path
 KLAYOUT_DIR = $(abspath $(FLOW_HOME)/../tools/install/klayout/)
@@ -435,14 +401,11 @@ yosys-dependencies: $(YOSYS_DEPENDENCIES)
 
 .PHONY: do-yosys
 do-yosys: $(DONT_USE_SC_LIB)
-	mkdir -p $(RESULTS_DIR) $(LOG_DIR) $(REPORTS_DIR) $(OBJECTS_DIR)
-	(export VERILOG_FILES=$(RESULTS_DIR)/1_synth.rtlil; \
-	$(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
@@ -555,13 +518,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,51 @@
+#!/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")

flow/scripts/defaults.py

@@ -12,4 +12,6 @@
 for key, value in data.items():
     if value.get("default", None) is None:
         continue
-    print(f'export {key}?={str(value["default"]).replace(" ", "__SPACE__")}')
+    print(
+        f'export {key}="${{{key}:-{str(value["default"]).replace(" ", "__SPACE__")}}}"'
+    )

flow/scripts/env.sh

@@ -0,0 +1,35 @@
+#!/bin/bash
+# Print out make variables that have changed so that
+# make can set them up in "make". This vile script has to
+# be in bash, because we're sourcing the script that we're
+# checking for changes to environment variables.
+set -e
+# Get the environment file from the first argument
+envfile="$1"
+
+# Save the current environment variables
+declare -A env_vars
+
+while IFS= read -r -d '' entry; do
+  var="${entry%%=*}"  # Extract the variable name
+  val="${entry#*=}"   # Extract the variable value
+  env_vars["$var"]="$val"
+done < <(env -0)
+
+# Source the environment file to load new variables
+if [[ -f "$envfile" ]]; then
+  source "$envfile"
+else
+  echo "Error: Environment file '$envfile' not found."
+  exit 1
+fi
+
+# Compare the new environment variables with the original ones
+while IFS= read -r -d '' entry; do
+  var="${entry%%=*}"  # Extract the variable name
+  val="${entry#*=}"   # Extract the variable value
+  if [[ "${env_vars[$var]+_}" && "${env_vars[$var]}" != "$val" ]] || [[ ! "${env_vars[$var]+_}" ]]; then
+    val=$(echo "$val" | sed 's/ /__SPACE__/g')
+    echo "export $var:=$val"
+  fi
+done < <(env -0)

flow/scripts/flow.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+set -u -eo pipefail
+mkdir -p $RESULTS_DIR $LOG_DIR $REPORTS_DIR $OBJECTS_DIR
+echo Running $2.tcl, stage $1
+(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; \
+ eval "$TIME_CMD $OPENROAD_CMD -no_splash $SCRIPTS_DIR/$2.tcl -metrics $LOG_DIR/$1.json" 2>&1 | \
+ tee -a $(realpath $LOG_DIR/$1.tmp.log))