variables: move code from Makefile to scripts/defaults.py

ported platforms/nangate45/config.mk to config.py.

Next up is porting all the rest of the platforms/**/config.mk files
to config.py, after which more stuff from Makefile can be moved
into scripts/config.py

The flow.sh and synth.sh scripts and they won't be ready
before all platforms/**/config.mk are ported to config.py.

The interface will probably be something like:

$ make DESIGN_CONFIG=designs/nangate45/config.mk clean_synth floorplan
$ DESIGN_NAME=gcd CORE_UTILIZATION=55 PLACE_DENSITY_LB_ADDON=0.20 PLATFORM=nangate45 PLATFORM_DIR=platforms/nangate45 scripts/flow.sh 2_1_floorplan floorplan
Running floorplan.tcl, stage 2_1_floorplan
[deleted]
Design area 650 u^2 57% utilization.
Elapsed time: 0:00.40[h:]min:sec. CPU time: user 0.33 sys 0.09 (106%). Peak memory: 121724KB.
$

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

Author: oharboe

flow/Makefile

@@ -90,6 +90,7 @@ DESIGN_CONFIG ?= ./designs/nangate45/gcd/config.mk
 # this file.
 include $(DESIGN_CONFIG)
 export DESIGN_NICKNAME?=$(DESIGN_NAME)
+export DESIGN_DIR = $(dir $(DESIGN_CONFIG))
 # default value "base" is duplicated from variables.yaml because we need it
 # earlier in the flow for BLOCKS. BLOCKS is a feature specific to Makefile
 # that will not be ported to bazel-orfs.
@@ -174,85 +175,39 @@ else
   $(error [ERROR][FLOW] Platform '$(PLATFORM)' not found.)
 endif
 
-include $(PLATFORM_DIR)/config.mk
+ifneq ($(wildcard $(PLATFORM_DIR)/config.mk),)
+  include $(PLATFORM_DIR)/config.mk
+endif
 
 # __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))))
-
-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)
-
-#-------------------------------------------------------------------------------
-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
-
-#-------------------------------------------------------------------------------
-# 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)
-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
+#
+# Note! We need to explicitly pass in the environment variables that
+# defaults.py *uses* to compute the list of default values. We do NOT
+# need to pass in *all* environment variables. defaults.py does not
+# use the default value to modify the environment, it computes default
+# values for environment variables and has options to print out
+# the information in different formats.
+$(foreach line,$(shell \
+  PLATFORM_DIR=$(PLATFORM_DIR) \
+  FLOW_HOME=$(FLOW_HOME) \
+  DESIGN_NAME=$(DESIGN_NAME) \
+  DESIGN_NICKNAME=$(DESIGN_NICKNAME) \
+  WORK_HOME=$(WORK_HOME) \
+  PLATFORM=$(PLATFORM) \
+  NUM_CORES=$(NUM_CORES) \
+  TIME_BIN=$(TIME_BIN) \
+  IN_NIX_SHELL=$(IN_NIX_SHELL) \
+  OPENROAD_EXE=$(OPENROAD_EXE) \
+  OPENSTA_EXE=$(OPENSTA_EXE) \
+  YOSYS_EXE=$(YOSYS_EXE) \
+  KLAYOUT_CMD=$(KLAYOUT_CMD) \
+  SCRIPTS_DIR=$(SCRIPTS_DIR) \
+  ADDITIONAL_LIBS="$(ADDITIONAL_LIBS)" \
+  ADDITIONAL_GDS="$(ADDITIONAL_GDS)" \
+  ADDITIONAL_LEFS="$(ADDITIONAL_LEFS)" \
+  $(SCRIPTS_DIR)/defaults.py make),$(eval export $(subst __SPACE__, ,$(line))))
 
-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),)
@@ -444,13 +399,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
@@ -557,13 +510,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/nangate45/config.mk

@@ -0,0 +1,93 @@
+import glob
+import os
+
+
+def get_defaults(variables):
+    gds_files = (
+        " ".join(
+            sorted(glob.glob(os.path.join(variables["PLATFORM_DIR"], "gds", "*.gds")))
+        )
+        + " "
+        + variables.get("ADDITIONAL_GDS", "")
+    ).strip()
+    return {
+        "PROCESS": "45",
+        # -----------------------------------------------------
+        # Tech/Libs
+        # -----------------------------------------------------
+        "TECH_LEF": f"{variables['PLATFORM_DIR']}/lef/NangateOpenCellLibrary.tech.lef",
+        "SC_LEF": f"{variables['PLATFORM_DIR']}/lef/NangateOpenCellLibrary.macro.mod.lef",
+        "LIB_FILES": f"{variables['PLATFORM_DIR']}/lib/NangateOpenCellLibrary_typical.lib {variables.get('ADDITIONAL_LIBS', '')}",
+        "GDS_FILES": gds_files,
+        # Don't use cells to ease congestion
+        # Specify at least one filler cell if none
+        "DONT_USE_CELLS": "TAPCELL_X1 FILLCELL_X1 AOI211_X1 OAI211_X1",
+        # Fill cells used in fill cell insertion
+        "FILL_CELLS": "FILLCELL_X1 FILLCELL_X2 FILLCELL_X4 FILLCELL_X8 FILLCELL_X16 FILLCELL_X32",
+        # -----------------------------------------------------
+        # Yosys
+        # -----------------------------------------------------
+        # Ungroup size for hierarchical synthesis
+        "SYNTH_MINIMUM_KEEP_SIZE": 10000,
+        # Set the TIEHI/TIELO cells
+        # These are used in yosys synthesis to avoid logical 1/0's in the netlist
+        "TIEHI_CELL_AND_PORT": "LOGIC1_X1 Z",
+        "TIELO_CELL_AND_PORT": "LOGIC0_X1 Z",
+        # Used in synthesis
+        "MIN_BUF_CELL_AND_PORTS": "BUF_X1 A Z",
+        # Yosys mapping files
+        "LATCH_MAP_FILE": f"{variables['PLATFORM_DIR']}/cells_latch.v",
+        "CLKGATE_MAP_FILE": f"{variables['PLATFORM_DIR']}/cells_clkgate.v",
+        "ADDER_MAP_FILE": f"{variables['PLATFORM_DIR']}/cells_adders.v",
+        "ABC_DRIVER_CELL": "BUF_X1",
+        # BUF_X1, pin (A) = 0.974659. Arbitrarily multiply by 4
+        "ABC_LOAD_IN_FF": 3.898,
+        # --------------------------------------------------------
+        # Floorplan
+        # --------------------------------------------------------
+        # Placement site for core cells
+        # This can be found in the technology lef
+        "PLACE_SITE": "FreePDK45_38x28_10R_NP_162NW_34O",
+        # IO Placer pin layers
+        "IO_PLACER_H": "metal5",
+        "IO_PLACER_V": "metal6",
+        # Define default PDN config
+        "PDN_TCL": f"{variables['PLATFORM_DIR']}/grid_strategy-M1-M4-M7.tcl",
+        # Endcap and Welltie cells
+        "TAPCELL_TCL": f"{variables['PLATFORM_DIR']}/tapcell.tcl",
+        "TAP_CELL_NAME": "TAPCELL_X1",
+        "MACRO_PLACE_HALO": "22.4 15.12",
+        # ---------------------------------------------------------
+        # Place
+        # ---------------------------------------------------------
+        "PLACE_DENSITY": 0.30,
+        # ---------------------------------------------------------
+        # Route
+        # ---------------------------------------------------------
+        # FastRoute options
+        "MIN_ROUTING_LAYER": "metal2",
+        "MAX_ROUTING_LAYER": "metal10",
+        # Define fastRoute tcl
+        "FASTROUTE_TCL": f"{variables['PLATFORM_DIR']}/fastroute.tcl",
+        # KLayout technology file
+        "KLAYOUT_TECH_FILE": f"{variables['PLATFORM_DIR']}/FreePDK45.lyt",
+        # KLayout DRC ruledeck
+        "KLAYOUT_DRC_FILE": f"{variables['PLATFORM_DIR']}/drc/FreePDK45.lydrc",
+        # KLayout LVS ruledeck
+        "KLAYOUT_LVS_FILE": f"{variables['PLATFORM_DIR']}/lvs/FreePDK45.lylvs",
+        # Allow empty GDS cell
+        "GDS_ALLOW_EMPTY": "fakeram.*",
+        "CDL_FILE": f"{variables['PLATFORM_DIR']}/cdl/NangateOpenCellLibrary.cdl",
+        # Template definition for power grid analysis
+        "TEMPLATE_PGA_CFG": f"{variables['PLATFORM_DIR']}/template_pga.cfg",
+        # OpenRCX extRules
+        "RCX_RULES": f"{variables['PLATFORM_DIR']}/rcx_patterns.rules",
+        # ---------------------------------------------------------
+        # IR Drop
+        # ---------------------------------------------------------
+        # IR drop estimation supply net name to be analyzed and supply voltage variable
+        # For multiple nets: PWR_NETS_VOLTAGES = "VDD1 1.8 VDD2 1.2"
+        "PWR_NETS_VOLTAGES": "VDD 1.1",
+        "GND_NETS_VOLTAGES": "VSS 0.0",
+        "IR_DROP_LAYER": "metal1",
+    }