librelane 2.4.0.dev9__py3-none-any.whl → 3.0.0.dev23__py3-none-any.whl

librelane/state/state.py

@@ -22,7 +22,6 @@ from typing import Callable, List, Mapping, Tuple, Union, Optional, Dict, Any
 
 from .design_format import (
     DesignFormat,
-    DesignFormatObject,
 )
 
 from ..common import (
@@ -91,26 +90,21 @@ class State(GenericImmutableDict[str, StateElement]):
         if c_mapping := copying:
             for key, value in c_mapping.items():
                 if isinstance(key, DesignFormat):
-                    copying_resolved[key.value.id] = value
+                    copying_resolved[key.id] = value
                 else:
                     copying_resolved[key] = value
 
-        for format in DesignFormat:
-            assert isinstance(format.value, DesignFormatObject)  # type checker shut up
-            if format.value.id not in copying_resolved:
-                copying_resolved[format.value.id] = None
-
         overrides_resolved = {}
         if o_mapping := overrides:
             for k, value in o_mapping.items():
                 if isinstance(k, DesignFormat):
-                    assert isinstance(
-                        k.value, DesignFormatObject
-                    )  # type checker shut up
-                    k = k.value.id
+                    k = k.id
                 overrides_resolved[k] = value
 
         self.metrics = GenericImmutableDict(metrics or {})
+        for key in list(copying_resolved.keys()):
+            if copying_resolved[key] is None:
+                del copying_resolved[key]
 
         super().__init__(
             copying_resolved,
@@ -119,21 +113,24 @@ class State(GenericImmutableDict[str, StateElement]):
             **kwargs,
         )
 
+    def get_by_df(self, key: DesignFormat) -> StateElement:
+        return self.get(key.id)
+
     def __getitem__(self, key: Union[DesignFormat, str]) -> StateElement:
         if isinstance(key, DesignFormat):
-            id: str = key.value.id
+            id: str = key.id
             key = id
         return super().__getitem__(key)
 
     def __setitem__(self, key: Union[DesignFormat, str], item: StateElement):
         if isinstance(key, DesignFormat):
-            id: str = key.value.id
+            id: str = key.id
             key = id
         return super().__setitem__(key, item)
 
     def __delitem__(self, key: Union[DesignFormat, str]):
         if isinstance(key, DesignFormat):
-            id: str = key.value.id
+            id: str = key.id
             key = id
         return super().__delitem__(key)
 
@@ -164,10 +161,8 @@ class State(GenericImmutableDict[str, StateElement]):
             if current_top_key is None:
                 current_top_key = key
             current_folder = key.strip("_*")
-            if df := DesignFormat.by_id(key):
-                # For type-checker: all guaranteed to be DesignFormatObjects
-                assert isinstance(df.value, DesignFormatObject)
-                current_folder = df.value.folder
+            if df := DesignFormat.factory.get(key):
+                current_folder = df.folder
 
             target_dir = os.path.join(save_directory, current_folder)
 
@@ -228,7 +223,11 @@ class State(GenericImmutableDict[str, StateElement]):
         """
 
         def visitor(key, value, top_key, _, depth):
-            if depth == 0 and DesignFormat.by_id(top_key) is None:
+            if (
+                depth == 0
+                and DesignFormat.factory.get(top_key) is None
+                and value is not None
+            ):
                 raise InvalidState(
                     f"Key '{top_key}' does not match a known design format."
                 )
@@ -314,8 +313,8 @@ class State(GenericImmutableDict[str, StateElement]):
                 continue
 
             key_content = id
-            if format := DesignFormat.by_id(id):
-                key_content = format.value.id
+            if format := DesignFormat.factory.get(id):
+                key_content = format.id
 
             value_content = str(value)
             if isinstance(value, Mapping):

librelane/steps/checker.py

@@ -266,7 +266,16 @@ class WireLength(MetricChecker):
         default=True,
         deprecated_names=["QUIT_ON_LONG_WIRE"],
     )
-    config_vars = [error_on_var]
+    config_vars = [
+        error_on_var,
+        Variable(
+            "WIRE_LENGTH_THRESHOLD",
+            Optional[Decimal],
+            "A value above which wire lengths generate warnings.",
+            units="µm",
+            pdk=True,
+        ),
+    ]
 
     def get_threshold(self) -> Optional[Decimal]:
         threshold = self.config["WIRE_LENGTH_THRESHOLD"]
@@ -477,6 +486,7 @@ class TimingViolations(MetricChecker):
             cls.base_corner_var_name.replace("TIMING", replace_by),
             Optional[List[str]],
             f"A list of wildcards matching IPVT corners to use during checking for {cls.violation_type} violations.",
+            pdk=True,
         )
         if cls.corner_override:
             variable.default = cls.corner_override
@@ -635,3 +645,4 @@ class HoldViolations(TimingViolations):
     violation_type = "hold"
 
     metric_name = "timing__hold_vio__count"
+    corner_override = ["*"]

librelane/steps/common_variables.py

@@ -261,21 +261,21 @@ dpl_variables = [
     ),
     Variable(
         "PL_MAX_DISPLACEMENT_X",
-        Decimal,
+        int,
         "Specifies how far an instance can be moved along the X-axis when finding a site where it can be placed during detailed placement.",
         default=500,
         units="µm",
     ),
     Variable(
         "PL_MAX_DISPLACEMENT_Y",
-        Decimal,
+        int,
         "Specifies how far an instance can be moved along the Y-axis when finding a site where it can be placed during detailed placement.",
         default=100,
         units="µm",
     ),
     Variable(
         "DPL_CELL_PADDING",
-        Decimal,
+        int,
         "Cell padding value (in sites) for detailed placement. The number will be integer divided by 2 and placed on both sides. Should be <= global placement.",
         units="sites",
         pdk=True,
@@ -335,6 +335,6 @@ rsz_variables = dpl_variables + [
     Variable(
         "RSZ_CORNERS",
         Optional[List[str]],
-        "A list of fully-qualified IPVT corners to use during resizer optimizations. If unspecified, the value for `STA_CORNERS` from the PDK will be used.",
+        "Resizer step-specific override for PNR_CORNERS.",
     ),
 ]

librelane/steps/cvc_rv.py

@@ -165,5 +165,5 @@ class ERC(Step):
             )
             return {}, {}
         except CVCNoSupport as e:
-            self.warn(f"Could not run CVC: {e}. Skipping…")
+            self.warn(f"Could not run CVC: {e}. Skipping '{self.id}'…")
             return {}, {}

librelane/steps/klayout.py

@@ -29,6 +29,14 @@ from ..state import DesignFormat, State
 from ..common import Path, get_script_dir, mkdirp, _get_process_limit
 
 
+DesignFormat(
+    "klayout_gds",
+    "klayout.gds",
+    "GDSII Stream (KLayout)",
+    alts=["KLAYOUT_GDS"],
+).register()
+
+
 class KLayoutStep(Step):
     config_vars = [
         Variable(
@@ -116,14 +124,14 @@ class KLayoutStep(Step):
             result += lef_args
 
         if include_gds:
-            gds_args = []
+            gds_args: List[str] = []
             for gds in self.config["CELL_GDS"]:
                 gds_args.append("--with-gds-file")
                 gds_args.append(gds)
             for gds in self.toolbox.get_macro_views(self.config, DesignFormat.GDS):
                 gds_args.append("--with-gds-file")
-                gds_args.append(gds)
-            if extra_gds := self.config["EXTRA_GDS_FILES"]:
+                gds_args.append(str(gds))
+            if extra_gds := self.config["EXTRA_GDS"]:
                 for gds in extra_gds:
                     gds_args.append("--with-gds-file")
                     gds_args.append(gds)
@@ -149,7 +157,7 @@ class Render(KLayoutStep):
 
     def run(self, state_in: State, **kwargs) -> Tuple[ViewsUpdate, MetricsUpdate]:
         input_view = state_in[DesignFormat.DEF]
-        if gds := state_in[DesignFormat.GDS]:
+        if gds := state_in.get(DesignFormat.GDS):
             input_view = gds
 
         assert isinstance(input_view, Path)
@@ -193,7 +201,7 @@ class StreamOut(KLayoutStep):
 
         klayout_gds_out = os.path.join(
             self.step_dir,
-            f"{self.config['DESIGN_NAME']}.{DesignFormat.KLAYOUT_GDS.value.extension}",
+            f"{self.config['DESIGN_NAME']}.{DesignFormat.KLAYOUT_GDS.extension}",
         )
         kwargs, env = self.extract_env(kwargs)
 
@@ -205,7 +213,7 @@ class StreamOut(KLayoutStep):
                     "klayout",
                     "stream_out.py",
                 ),
-                state_in[DesignFormat.DEF.value.id],
+                state_in[DesignFormat.DEF.id],
                 "--output",
                 abspath(klayout_gds_out),
                 "--top",

librelane/steps/magic.py

@@ -37,6 +37,22 @@ from ..config import Variable
 from ..common import get_script_dir, DRC as DRCObject, Path, mkdirp
 
 
+DesignFormat(
+    "mag",
+    "mag",
+    "Magic VLSI View",
+    alts=["MAG"],
+).register()
+
+
+DesignFormat(
+    "mag_gds",
+    "magic.gds",
+    "GDSII Stream (Magic)",
+    alts=["MAG_GDS"],
+).register()
+
+
 class MagicOutputProcessor(OutputProcessor):
     _error_patterns = [
         re.compile(rx)
@@ -192,10 +208,10 @@ class MagicStep(TclStep):
 
         views_updates: ViewsUpdate = {}
         for output in self.outputs:
-            if output.value.multiple:
+            if output.multiple:
                 # Too step-specific.
                 continue
-            path = Path(env[f"SAVE_{output.name}"])
+            path = Path(env[f"SAVE_{output.id.upper()}"])
             if not path.exists():
                 continue
             views_updates[output] = path

librelane/steps/misc.py

@@ -39,7 +39,7 @@ class LoadBaseSDC(Step):
     outputs = [DesignFormat.SDC]
 
     def run(self, state_in: State, **kwargs) -> Tuple[ViewsUpdate, MetricsUpdate]:
-        path = self.config["FALLBACK_SDC_FILE"]
+        path = self.config["FALLBACK_SDC"]
 
         target = os.path.join(self.step_dir, f"{self.config['DESIGN_NAME']}.sdc")
 

librelane/steps/odb.py

@@ -76,9 +76,9 @@ class OdbpyStep(Step):
         views_updates: ViewsUpdate = {}
         command = self.get_command()
         for output in automatic_outputs:
-            filename = f"{self.config['DESIGN_NAME']}.{output.value.extension}"
+            filename = f"{self.config['DESIGN_NAME']}.{output.extension}"
             file_path = os.path.join(self.step_dir, filename)
-            command.append(f"--output-{output.value.id}")
+            command.append(f"--output-{output.id}")
             command.append(file_path)
             views_updates[output] = Path(file_path)
 
@@ -148,7 +148,7 @@ class OdbpyStep(Step):
             for lef in extra_lefs:
                 lefs.append("--input-lef")
                 lefs.append(lef)
-        if (design_lef := self.state_in.result()[DesignFormat.LEF]) and (
+        if (design_lef := self.state_in.result().get(DesignFormat.LEF)) and (
             DesignFormat.LEF in self.inputs
         ):
             lefs.append("--design-lef")
@@ -207,7 +207,7 @@ class CheckMacroAntennaProperties(OdbpyStep):
 
     def run(self, state_in: State, **kwargs) -> Tuple[ViewsUpdate, MetricsUpdate]:
         if not self.get_cells():
-            info("No cells provided, skipping…")
+            info(f"No cells provided, skipping '{self.id}'…")
             return {}, {}
         return super().run(state_in, **kwargs)
 
@@ -271,7 +271,7 @@ class ApplyDEFTemplate(OdbpyStep):
 
     def run(self, state_in: State, **kwargs) -> Tuple[ViewsUpdate, MetricsUpdate]:
         if self.config["FP_DEF_TEMPLATE"] is None:
-            info("No DEF template provided, skipping…")
+            info(f"No DEF template provided, skipping '{self.id}'…")
             return {}, {}
 
         views_updates, metrics_updates = super().run(state_in, **kwargs)
@@ -527,9 +527,9 @@ class AddRoutingObstructions(OdbpyStep):
     config_vars = [
         Variable(
             "ROUTING_OBSTRUCTIONS",
-            Optional[List[str]],
+            Optional[List[Tuple[str, Decimal, Decimal, Decimal, Decimal]]],
             "Add routing obstructions to the design. If set to `None`, this step is skipped."
-            + " Format of each obstruction item is: layer llx lly urx ury.",
+            + " Format of each obstruction item is a tuple of: layer name, llx, lly, urx, ury.",
             units="µm",
             default=None,
             deprecated_names=["GRT_OBS"],
@@ -550,7 +550,7 @@ class AddRoutingObstructions(OdbpyStep):
         if obstructions := self.config[self.config_vars[0].name]:
             for obstruction in obstructions:
                 command.append("--obstructions")
-                command.append(obstruction)
+                command.append(" ".join([str(o) for o in obstruction]))
         return command
 
     def run(self, state_in: State, **kwargs) -> Tuple[ViewsUpdate, MetricsUpdate]:
@@ -579,9 +579,9 @@ class AddPDNObstructions(AddRoutingObstructions):
     config_vars = [
         Variable(
             "PDN_OBSTRUCTIONS",
-            Optional[List[str]],
+            Optional[List[Tuple[str, Decimal, Decimal, Decimal, Decimal]]],
             "Add routing obstructions to the design before PDN stage. If set to `None`, this step is skipped."
-            + " Format of each obstruction item is: layer llx lly urx ury.",
+            + " Format of each obstruction item is a tuple of: layer name, llx, lly, urx, ury,.",
             units="µm",
             default=None,
         ),
@@ -686,7 +686,7 @@ class CustomIOPlacement(OdbpyStep):
 
     def run(self, state_in: State, **kwargs) -> Tuple[ViewsUpdate, MetricsUpdate]:
         if self.config["FP_PIN_ORDER_CFG"] is None:
-            info("No custom floorplan file configured, skipping…")
+            info(f"No custom floorplan file configured, skipping '{self.id}'…")
             return {}, {}
         return super().run(state_in, **kwargs)
 
@@ -715,7 +715,7 @@ class PortDiodePlacement(OdbpyStep):
         ),
         Variable(
             "GPL_CELL_PADDING",
-            Decimal,
+            int,
             "Cell padding value (in sites) for global placement. Used by this step only to emit a warning if it's 0.",
             units="sites",
             pdk=True,
@@ -744,7 +744,11 @@ class PortDiodePlacement(OdbpyStep):
 
     def run(self, state_in: State, **kwargs) -> Tuple[ViewsUpdate, MetricsUpdate]:
         if self.config["DIODE_ON_PORTS"] == "none":
-            info("'DIODE_ON_PORTS' is set to 'none': skipping…")
+            info(f"'DIODE_ON_PORTS' is set to 'none': skipping '{self.id}'…")
+            return {}, {}
+
+        if self.config["DIODE_CELL"] is None:
+            info(f"'DIODE_CELL' not set. Skipping '{self.id}'…")
             return {}, {}
 
         if self.config["GPL_CELL_PADDING"] == 0:
@@ -784,7 +788,10 @@ class DiodesOnPorts(CompositeStep):
 
     def run(self, state_in: State, **kwargs) -> Tuple[ViewsUpdate, MetricsUpdate]:
         if self.config["DIODE_ON_PORTS"] == "none":
-            info("'DIODE_ON_PORTS' is set to 'none': skipping…")
+            info(f"'DIODE_ON_PORTS' is set to 'none': skipping '{self.id}'…")
+            return {}, {}
+        if self.config["DIODE_CELL"] is None:
+            info(f"'DIODE_CELL' not set. Skipping '{self.id}'…")
             return {}, {}
         return super().run(state_in, **kwargs)
 
@@ -811,14 +818,14 @@ class FuzzyDiodePlacement(OdbpyStep):
     config_vars = [
         Variable(
             "HEURISTIC_ANTENNA_THRESHOLD",
-            Decimal,
+            Optional[Decimal],
             "A Manhattan distance above which a diode is recommended to be inserted by the heuristic inserter. If not specified, the heuristic algorithm.",
             units="µm",
             pdk=True,
         ),
         Variable(
             "GPL_CELL_PADDING",
-            Decimal,
+            int,
             "Cell padding value (in sites) for global placement. Used by this step only to emit a warning if it's 0.",
             units="sites",
             pdk=True,
@@ -834,20 +841,14 @@ class FuzzyDiodePlacement(OdbpyStep):
     def get_command(self) -> List[str]:
         cell, pin = self.config["DIODE_CELL"].split("/")
 
-        threshold_opts = []
-        if threshold := self.config["HEURISTIC_ANTENNA_THRESHOLD"]:
-            threshold_opts = ["--threshold", threshold]
-
-        return (
-            super().get_command()
-            + [
-                "--diode-cell",
-                cell,
-                "--diode-pin",
-                pin,
-            ]
-            + threshold_opts
-        )
+        return super().get_command() + [
+            "--diode-cell",
+            cell,
+            "--diode-pin",
+            pin,
+            "--threshold",
+            str(self.config["HEURISTIC_ANTENNA_THRESHOLD"]),
+        ]
 
     def run(self, state_in: State, **kwargs) -> Tuple[ViewsUpdate, MetricsUpdate]:
         if self.config["GPL_CELL_PADDING"] == 0:
@@ -855,6 +856,14 @@ class FuzzyDiodePlacement(OdbpyStep):
                 "'GPL_CELL_PADDING' is set to 0. This step may cause overlap failures."
             )
 
+        if self.config["DIODE_CELL"] is None:
+            info(f"'DIODE_CELL' not set. Skipping '{self.id}'…")
+            return {}, {}
+
+        if self.config["HEURISTIC_ANTENNA_THRESHOLD"] is None:
+            info(f"'HEURISTIC_ANTENNA_THRESHOLD' not set. Skipping '{self.id}'…")
+            return {}, {}
+
         return super().run(state_in, **kwargs)
 
 
@@ -889,6 +898,16 @@ class HeuristicDiodeInsertion(CompositeStep):
         GlobalRouting,
     ]
 
+    def run(self, state_in: State, **kwargs) -> Tuple[ViewsUpdate, MetricsUpdate]:
+        if self.config["DIODE_CELL"] is None:
+            info(f"'DIODE_CELL' not set. Skipping '{self.id}'…")
+            return {}, {}
+        if self.config["HEURISTIC_ANTENNA_THRESHOLD"] is None:
+            info(f"'HEURISTIC_ANTENNA_THRESHOLD' not set. Skipping '{self.id}'…")
+            return {}, {}
+
+        return super().run(state_in, **kwargs)
+
 
 @Step.factory.register()
 class CellFrequencyTables(OdbpyStep):
@@ -975,7 +994,7 @@ class ManualGlobalPlacement(OdbpyStep):
 
     def run(self, state_in: State, **kwargs) -> Tuple[ViewsUpdate, MetricsUpdate]:
         if self.config["MANUAL_GLOBAL_PLACEMENTS"] is None:
-            info("'MANUAL_GLOBAL_PLACEMENTS' not set, skipping…")
+            info(f"'MANUAL_GLOBAL_PLACEMENTS' not set, skipping '{self.id}'…")
             return {}, {}
         return super().run(state_in, **kwargs)