Merge pull request #3262 from jeffng-or/at-add-stop-stage-support

added support for AutoTuner to stop after a specified stage

Author: maliberty

flow/Makefile

@@ -541,7 +541,8 @@ clean_cts:
 route: $(RESULTS_DIR)/5_route.odb \
        $(RESULTS_DIR)/5_route.sdc
 
-.PHONY: grt
+.PHONY: grt globalroute
+globalroute: grt
 grt: $(RESULTS_DIR)/5_1_grt.odb
 
 # ==============================================================================

tools/AutoTuner/src/autotuner/distributed.py

@@ -154,15 +154,16 @@ def step(self):
             install_path=INSTALL_PATH,
         )
         self.step_ += 1
-        (score, effective_clk_period, num_drc) = self.evaluate(
-            read_metrics(metrics_file)
+        (score, effective_clk_period, num_drc, die_area) = self.evaluate(
+            read_metrics(metrics_file, args.stop_stage)
         )
         # Feed the score back to Tune.
         # return must match 'metric' used in tune.run()
         return {
             METRIC: score,
             "effective_clk_period": effective_clk_period,
             "num_drc": num_drc,
+            "die_area": die_area,
         }
 
     def evaluate(self, metrics):
@@ -174,13 +175,13 @@ def evaluate(self, metrics):
         error = "ERR" in metrics.values()
         not_found = "N/A" in metrics.values()
         if error or not_found:
-            return (ERROR_METRIC, "-", "-")
+            return (ERROR_METRIC, "-", "-", "-")
         effective_clk_period = metrics["clk_period"] - metrics["worst_slack"]
         num_drc = metrics["num_drc"]
         gamma = effective_clk_period / 10
         score = effective_clk_period
         score = score * (100 / self.step_) + gamma * num_drc
-        return (score, effective_clk_period, num_drc)
+        return (score, effective_clk_period, num_drc, metrics["die_area"])
 
     def _is_valid_config(self, config):
         """
@@ -247,13 +248,13 @@ def evaluate(self, metrics):
         error = "ERR" in metrics.values() or "ERR" in reference.values()
         not_found = "N/A" in metrics.values() or "N/A" in reference.values()
         if error or not_found:
-            return (ERROR_METRIC, "-", "-")
+            return (ERROR_METRIC, "-", "-", "-")
         ppa = self.get_ppa(metrics)
         gamma = ppa / 10
         score = ppa * (self.step_ / 100) ** (-1) + (gamma * metrics["num_drc"])
         effective_clk_period = metrics["clk_period"] - metrics["worst_slack"]
         num_drc = metrics["num_drc"]
-        return (score, effective_clk_period, num_drc)
+        return (score, effective_clk_period, num_drc, metrics["die_area"])
 
 
 def parse_arguments():
@@ -307,6 +308,14 @@ def parse_arguments():
         default=None,
         help="Time limit (in hours) for each trial run. Default is no limit.",
     )
+    parser.add_argument(
+        "--stop_stage",
+        type=str,
+        metavar="<str>",
+        choices=["floorplan", "place", "cts", "globalroute", "route", "finish"],
+        default="finish",
+        help="Name of the stage to stop after. Default is finish.",
+    )
     tune_parser.add_argument(
         "--resume",
         action="store_true",
@@ -598,7 +607,7 @@ def main():
         TrainClass = set_training_class(args.eval)
         # PPAImprov requires a reference file to compute training scores.
         if args.eval == "ppa-improv":
-            reference = read_metrics(args.reference)
+            reference = read_metrics(args.reference, args.stop_stage)
 
         tune_args = dict(
             name=args.experiment,

tools/AutoTuner/src/autotuner/utils.py

@@ -330,6 +330,8 @@ def openroad(
     make_command += f" FLOW_VARIANT={flow_variant} {parameters}"
     make_command += " EQUIVALENCE_CHECK=0"
     make_command += f" NUM_CORES={args.openroad_threads} SHELL=bash"
+    if args.stop_stage != "finish":
+        make_command += f" {args.stop_stage}"
     run_command(
         args,
         make_command,
@@ -358,22 +360,29 @@ def openroad(
     return metrics_file
 
 
-def read_metrics(file_name):
+def read_metrics(file_name, stop_stage):
     """
     Collects metrics to evaluate the user-defined objective function.
+
+    stop_stage indicates the last stage executed, so get most of the metrics
+    from that stage. The default stop stage is "finish". But if the run stops
+    before "finish", then no need to extract the metrics from the route stage,
+    so set them to 0
     """
     with open(file_name) as file:
         data = json.load(file)
     clk_period = 9999999
     worst_slack = "ERR"
-    wirelength = "ERR"
-    num_drc = "ERR"
     total_power = "ERR"
     core_util = "ERR"
     final_util = "ERR"
     design_area = "ERR"
     die_area = "ERR"
     core_area = "ERR"
+    if stop_stage != "finish":
+        num_drc = wirelength = 0
+    else:
+        num_drc = wirelength = "ERR"
     for stage_name, value in data.items():
         if stage_name == "constraints" and len(value["clocks__details"]) > 0:
             clk_period = float(value["clocks__details"][0].split()[1])
@@ -383,17 +392,17 @@ def read_metrics(file_name):
             num_drc = value["route__drc_errors"]
         if stage_name == "detailedroute" and "route__wirelength" in value:
             wirelength = value["route__wirelength"]
-        if stage_name == "finish" and "timing__setup__ws" in value:
+        if stage_name == stop_stage and "timing__setup__ws" in value:
             worst_slack = value["timing__setup__ws"]
-        if stage_name == "finish" and "power__total" in value:
+        if stage_name == stop_stage and "power__total" in value:
             total_power = value["power__total"]
-        if stage_name == "finish" and "design__instance__utilization" in value:
+        if stage_name == stop_stage and "design__instance__utilization" in value:
             final_util = value["design__instance__utilization"]
-        if stage_name == "finish" and "design__instance__area" in value:
+        if stage_name == stop_stage and "design__instance__area" in value:
             design_area = value["design__instance__area"]
-        if stage_name == "finish" and "design__core__area" in value:
+        if stage_name == stop_stage and "design__core__area" in value:
             core_area = value["design__core__area"]
-        if stage_name == "finish" and "design__die__area" in value:
+        if stage_name == stop_stage and "design__die__area" in value:
             die_area = value["design__die__area"]
     ret = {
         "clk_period": clk_period,