Merge remote-tracking branch 'origin/master' into HEAD

Author: oharboe

docs/user/InstructionsForAutoTuner.md

@@ -23,17 +23,17 @@ User-defined coefficient values (`coeff_perform`, `coeff_power`, `coeff_area`) o
 
 ## Setting up AutoTuner
 
-We have provided two convenience scripts, `./install.sh` and `./setup.sh`
+We have provided two convenience scripts, `./installer.sh` and `./setup.sh`
 that works in Python3.8 for installation and configuration of AutoTuner,
 as shown below:
 
 ```{note}
-Make sure you run the following commands in `./tools/AutoTuner/src/autotuner`.
+Make sure you run the following commands in the ORFS root directory.
 ```
 
 ```shell
 # Install prerequisites
-./tools/AutoTuner/install.sh
+./tools/AutoTuner/installer.sh
 
 # Start virtual environment
 ./tools/AutoTuner/setup.sh
@@ -104,14 +104,15 @@ For Global Routing parameters that are set on `fastroute.tcl` you can use:
 
 ### General Information
 
-The `distributed.py` script uses Ray's job scheduling and management to
+The `distributed.py` script located in `./tools/AutoTuner/src/autotuner` uses [Ray's](https://docs.ray.io/en/latest/index.html) job scheduling and management to
 fully utilize available hardware resources from a single server 
-configuration, on-premies or over the cloud with multiple CPUs. 
-The two modes of operation: `sweep`, where every possible parameter
-combination in the search space is tested; and `tune`, where we use
-Ray's Tune feature to intelligently search the space and optimize
-hyperparameters using one of the algorithms listed above. The `sweep`
-mode is useful when we want to isolate or test a single or very few
+configuration, on-premise or over the cloud with multiple CPUs.
+
+The two modes of operation:
+- `sweep`, where every possible parameter combination in the search space is tested
+- `tune`, where we use Ray's Tune feature to intelligently search the space and optimize hyperparameters using one of the algorithms listed above.
+
+The `sweep` mode is useful when we want to isolate or test a single or very few
 parameters. On the other hand, `tune` is more suitable for finding
 the best combination of a complex and large number of flow 
 parameters. Both modes rely on user-specified search space that is 
@@ -120,7 +121,7 @@ though some features may not be available for sweeping.
 
 ```{note}
 The order of the parameters matter. Arguments `--design`, `--platform` and
-`--config` are always required and should precede <mode>.
+`--config` are always required and should precede *mode*.
 ```
 
 #### Tune only 
@@ -169,7 +170,7 @@ GCP Setup Tutorial coming soon.
 | `--git_url`                   | OpenROAD-flow-scripts repo URL to use.                                                                |
 | `--build_args`                | Additional arguments given to ./build_openroad.sh                                                     |
 | `--algorithm`                 | Search algorithm to use for Autotuning.                                                               |
-| `--eval`                      | Evalaute function to use with search algorithm.  \                                                    |
+| `--eval`                      | Evaluate function to use with search algorithm.                                                       |
 | `--samples`                   | Number of samples for tuning.                                                                         |
 | `--iterations`                | Number of iterations for tuning.                                                                      |
 | `--resources_per_trial`       | Number of CPUs to request for each tuning job.                                                        |

flow/BUILD.bazel

@@ -70,7 +70,6 @@ orfs_flow(
             "SDC_FILE": "$(location :constraints-swerv)",
         },
         "floorplan": SWERV_ALL | {
-            "RTLMP_FLOW": "1",
             "RTLMP_MAX_INST": "30000",
             "RTLMP_MIN_INST": "5000",
             "RTLMP_MAX_MACRO": "30",
@@ -144,7 +143,6 @@ MOCK_ARRAY_FLOORPLAN_PLACE = {
             "CORE_AREA": "2.16 2.16 356.40000000000003 386.64000000000004",
             "MACRO_PLACE_HALO": "0 2.16",
             "RTLMP_BOUNDARY_WT": "0",
-            "RTLMP_FLOW": "1",
             "PDN_TCL": "$(PLATFORM_DIR)/openRoad/pdn/BLOCKS_grid_strategy.tcl",
             "MACRO_HALO_X": "0.5",
             "MACRO_HALO_Y": "0.5",

flow/Makefile

@@ -233,7 +233,6 @@ ifneq ($(BLOCKS),)
   endif
 endif
 
-export RTLMP_FLOW ?= 1
 export RTLMP_RPT_DIR ?= $(OBJECTS_DIR)/rtlmp
 export RTLMP_RPT_FILE ?= partition.txt
 export RTLMP_BLOCKAGE_FILE ?= $(OBJECTS_DIR)/rtlmp/partition.txt.blockage
@@ -642,31 +641,29 @@ endef
 #-------------------------------------------------------------------------------
 $(eval $(call do-step,2_1_floorplan,$(RESULTS_DIR)/1_synth.v $(RESULTS_DIR)/1_synth.sdc $(TECH_LEF) $(SC_LEF) $(ADDITIONAL_LEFS) $(FOOTPRINT) $(SIG_MAP_FILE) $(FOOTPRINT_TCL),floorplan))
 
-$(eval $(call do-step,2_2_floorplan_io,$(RESULTS_DIR)/2_1_floorplan.odb $(IO_CONSTRAINTS),io_placement_random))
-
-# STEP 3: Timing Driven Mixed Sized Placement
+# STEP 2: Random IO placement
 #-------------------------------------------------------------------------------
-$(eval $(call do-step,2_3_floorplan_tdms,$(RESULTS_DIR)/2_2_floorplan_io.odb $(RESULTS_DIR)/1_synth.v $(RESULTS_DIR)/1_synth.sdc $(LIB_FILES),tdms_place))
+$(eval $(call do-step,2_2_floorplan_io,$(RESULTS_DIR)/2_1_floorplan.odb $(IO_CONSTRAINTS),io_placement_random))
 
-# STEP 4: Macro Placement
+# STEP 3: Macro Placement
 #-------------------------------------------------------------------------------
-$(eval $(call do-step,2_4_floorplan_macro,$(RESULTS_DIR)/2_3_floorplan_tdms.odb $(RESULTS_DIR)/1_synth.v $(RESULTS_DIR)/1_synth.sdc $(MACRO_PLACEMENT) $(MACRO_PLACEMENT_TCL),macro_place))
+$(eval $(call do-step,2_3_floorplan_macro,$(RESULTS_DIR)/2_2_floorplan_io.odb $(RESULTS_DIR)/1_synth.v $(RESULTS_DIR)/1_synth.sdc $(MACRO_PLACEMENT) $(MACRO_PLACEMENT_TCL),macro_place))
 
-# STEP 5: Tapcell and Welltie insertion
+# STEP 4: Tapcell and Welltie insertion
 #-------------------------------------------------------------------------------
-$(eval $(call do-step,2_5_floorplan_tapcell,$(RESULTS_DIR)/2_4_floorplan_macro.odb $(TAPCELL_TCL),tapcell))
+$(eval $(call do-step,2_4_floorplan_tapcell,$(RESULTS_DIR)/2_3_floorplan_macro.odb $(TAPCELL_TCL),tapcell))
 
-# STEP 6: PDN generation
+# STEP 5: PDN generation
 #-------------------------------------------------------------------------------
-$(eval $(call do-step,2_6_floorplan_pdn,$(RESULTS_DIR)/2_5_floorplan_tapcell.odb $(PDN_TCL),pdn))
+$(eval $(call do-step,2_5_floorplan_pdn,$(RESULTS_DIR)/2_4_floorplan_tapcell.odb $(PDN_TCL),pdn))
 
-$(eval $(call do-copy,2_floorplan,2_6_floorplan_pdn.odb,))
+$(eval $(call do-copy,2_floorplan,2_5_floorplan_pdn.odb,))
 
 $(RESULTS_DIR)/2_floorplan.sdc: $(RESULTS_DIR)/2_1_floorplan.odb
 
 .PHONY: do-floorplan
 do-floorplan:
-	$(UNSET_AND_MAKE) do-2_1_floorplan do-2_2_floorplan_io do-2_3_floorplan_tdms do-2_4_floorplan_macro do-2_5_floorplan_tapcell do-2_6_floorplan_pdn do-2_floorplan
+	$(UNSET_AND_MAKE) do-2_1_floorplan do-2_2_floorplan_io do-2_3_floorplan_io do-2_4_floorplan_tapcell do-2_5_floorplan_pdn do-2_floorplan
 
 .PHONY: clean_floorplan
 clean_floorplan: