orfs_sweep: rename variables to arguments for consistency

and check for valid keys in the sweep dictionary to avoid silent errors Signed-off-by: Øyvind Harboe <[email protected]>
The-OpenROAD-Project · Jan 19, 2025 · 4c0e4c2 · 4c0e4c2
1 parent 8bc8ad3
commit 4c0e4c2
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 8 deletions.
diff --git a/BUILD b/BUILD
@@ -296,25 +296,25 @@ orfs_sweep(
     },
     sweep = {
         "1": {
-            "variables": {
+            "arguments": {
                 "PLACE_DENSITY": "0.65",
             },
             "previous_stage": {"floorplan": "lb_32x128_synth"},
         },
         "2": {
-            "variables": {
+            "arguments": {
                 "PLACE_DENSITY": "0.70",
             },
             "previous_stage": {"place": "lb_32x128_floorplan"},
         },
         "3": {
-            "variables": {
+            "arguments": {
                 "PLACE_DENSITY": "0.75",
             },
             "previous_stage": {"cts": "lb_32x128_place"},
         },
         "4": {
-            "variables": {
+            "arguments": {
                 "PLACE_DENSITY": "0.80",
             },
         },

diff --git a/sweep.bzl b/sweep.bzl
@@ -54,9 +54,13 @@ def orfs_sweep(
     all_variants = sweep | other_variants
 
     for variant in all_variants:
+        for key in all_variants[variant].keys():
+            if key not in ["arguments", "dissolve", "macros", "previous_stage", "renamed_inputs", "stage_arguments", "stage_sources"]:
+                fail("Unknown orfs_sweep() key \"" + key + "\" in " + variant)
+
         orfs_flow(
             name = name,
-            arguments = arguments | all_variants[variant].get("variables", {}),
+            arguments = arguments | all_variants[variant].get("arguments", {}),
             macros = [
                 m
                 for m in macros

diff --git a/wns_report.py b/wns_report.py
@@ -149,7 +149,7 @@ def main():
     logs_dir = os.path.join(log_dir, "..")
 
     variables = sorted(
-        set(k for v in sweep.values() for k in v.get("variables", {}).keys())
+        set(k for v in sweep.values() for k in v.get("arguments", {}).keys())
     )
 
     def read_file(variant):
@@ -164,7 +164,7 @@ def read_file(variant):
     stats = {variant: parse_stats(read_file(variant)) for variant in sweep}
     names = sorted({name for stat in stats.values() for name in stat.keys()})
     variable_names = sorted(
-        set(k for v in sweep.values() for k in v.get("variables", {}).keys())
+        set(k for v in sweep.values() for k in v.get("arguments", {}).keys())
     )
 
     table_data = None
@@ -184,7 +184,7 @@ def previous_stage(previous_stage):
                 + ["dissolve", "previous_stage"]
                 + logs
             ]
-        variables = sweep[variant].get("variables", {})
+        variables = sweep[variant].get("arguments", {})
         table_data.append(
             (
                 [variant, sweep[variant].get("description", "")]