librelane 3.1.0.dev2__tar.gz → 3.1.0.dev4__tar.gz

{librelane-3.1.0.dev2 → librelane-3.1.0.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: librelane
-Version: 3.1.0.dev2
+Version: 3.1.0.dev4
 Summary: An infrastructure for implementing chip design flows
 License-Expression: Apache-2.0
 Maintainer: Mohamed Gaber
@@ -12,8 +12,9 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
-Requires-Dist: ciel (>=2.3.1,<3)
-Requires-Dist: click (>=8,<8.3)
+Classifier: Programming Language :: Python :: 3.15
+Requires-Dist: ciel (>=3.2.0,<4)
+Requires-Dist: click (>=8,<8.4)
 Requires-Dist: cloup (>=3.0.5,<4)
 Requires-Dist: deprecated (>=1.2.10,<2)
 Requires-Dist: httpx (>=0.22.0,<0.29)
@@ -23,7 +24,7 @@ Requires-Dist: lxml (>=4.9.0)
 Requires-Dist: psutil (>=5.9.0)
 Requires-Dist: pyyaml (>=5,<7)
 Requires-Dist: rapidfuzz (>=3.9.0,<4)
-Requires-Dist: rich (>=12,<15)
+Requires-Dist: rich (>=12,<16)
 Requires-Dist: semver (>=3.0.2,<4)
 Requires-Dist: yamlcore (>=0.0.2,<0.1.0)
 Project-URL: Bug Tracker, https://github.com/librelane/librelane/issues

{librelane-3.1.0.dev2 → librelane-3.1.0.dev4}/librelane/__main__.py

@@ -94,7 +94,7 @@ def run(
                         )
                         ctx.exit(1)
                 elif isinstance(meta.flow, list):
-                    TargetFlow = SequentialFlow.make(meta.flow)
+                    TargetFlow = SequentialFlow.Make(meta.flow)
                 if meta.substituting_steps is not None:
                     if meta.flow is None:
                         err("config_file has substituting_steps set with no flow.")

{librelane-3.1.0.dev2 → librelane-3.1.0.dev4}/librelane/common/__init__.py

@@ -33,6 +33,7 @@ from .misc import (
     get_librelane_root,
     get_script_dir,
     get_pdk_hash,
+    get_ciel_pdk_hash,
     slugify,
     protected,
     final,

{librelane-3.1.0.dev2 → librelane-3.1.0.dev4}/librelane/common/metrics/__main__.py

@@ -1,3 +1,7 @@
+# Copyright 2026 LibreLane Contributors
+#
+# Adapted from OpenLane 2
+#
 # Copyright 2023 Efabless Corporation
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,42 +24,16 @@ import tarfile
 import tempfile
 from io import BytesIO
 from decimal import Decimal
-from typing import Optional, Set, Tuple
+from typing import Optional, Tuple
 
 import cloup
 import httpx
 
 from .util import MetricDiff, TableVerbosity
+from .compare import compare_metric_directories, default_filter_set
 from ..misc import Filter, get_httpx_session, mkdirp
 from ..cli import formatter_settings, IntEnumChoice
 
-default_filter_set = [
-    "design__*__area",
-    "design__max_*",
-    "design__lvs_error__count",
-    "antenna__violating*",
-    "clock__*",
-    "ir__*",
-    "power__*",
-    "timing__*_vio__*",
-    "timing*wns*",
-    "timing*tns*",
-    "*error*",
-    "!*__iter:*",
-]
-
-# passing_filter_set = [
-#     "design__*__area",
-#     "route__wirelength__max",
-#     "design__instance__utilization",
-#     "antenna__violating*",
-#     "timing__*__ws",
-#     "clock__skew__*",
-#     "ir__*",
-#     "power__*",
-#     "!*__iter:*",
-# ]
-
 
 @cloup.group(
     no_args_is_help=True,
@@ -141,130 +119,25 @@ def compare(
 cli.add_command(compare)
 
 
-def _compare_metric_folders(
-    filter_wildcards: Tuple[str, ...],
-    table_verbosity: TableVerbosity,
-    path_a: str,
-    path_b: str,
-    significant_figures: int,
-) -> Tuple[str, str]:  # (summary, table)
-    a: Set[Tuple[str, str, str]] = set()
-    b: Set[Tuple[str, str, str]] = set()
-
-    def add_designs(in_dir: str, to_set: Set[Tuple[str, str, str]]):
-        for file in os.listdir(in_dir):
-            basename = os.path.basename(file)
-            if not basename.endswith(".metrics.json"):
-                continue
-            basename = basename[: -len(".metrics.json")]
-
-            # We have to rsplit, since ihp-sg13g2 contains a "-"
-            parts = basename.rsplit("-", maxsplit=2)
-            if len(parts) != 3:
-                raise ValueError(
-                    f"Invalid filename {basename}: not in the format {{pdk}}-{{scl}}-{{design_name}}"
-                )
-            pdk, scl, design = parts
-            to_set.add((pdk, scl, design))
-
-    add_designs(path_a, a)
-    add_designs(path_b, b)
-
-    not_in_a = b - a
-    not_in_b = a - b
-    common = a.intersection(b)
-    difference_report = ""
-    for tup in not_in_a:
-        pdk, scl, design = tup
-        difference_report += f"* Results for a new test, `{'/'.join(tup)}`, detected.\n"
-    for tup in not_in_b:
-        pdk, scl, design = tup
-        difference_report += (
-            f"* ‼️ Results for `{'/'.join(tup)}` appear to be missing!\n"
-        )
-
-    final_filters = []
-    for wildcard in filter_wildcards:
-        if wildcard == "DEFAULT":
-            final_filters += default_filter_set
-        else:
-            final_filters.append(wildcard)
-
-    filter = Filter(final_filters)
-    critical_change_report = ""
-    tables = ""
-    total_critical = 0
-    for pdk, scl, design in sorted(common):
-        metrics_a = json.load(
-            open(
-                os.path.join(path_a, f"{pdk}-{scl}-{design}.metrics.json"),
-                encoding="utf8",
-            ),
-            parse_float=Decimal,
-        )
-
-        metrics_b = json.load(
-            open(
-                os.path.join(path_b, f"{pdk}-{scl}-{design}.metrics.json"),
-                encoding="utf8",
-            ),
-            parse_float=Decimal,
-        )
-
-        diff = MetricDiff.from_metrics(
-            metrics_a,
-            metrics_b,
-            significant_figures,
-            filter=filter,
-        )
-
-        stats = diff.stats()
-
-        total_critical += stats.critical
-        if stats.critical > 0:
-            critical_change_report += f"  * `{pdk}/{scl}/{design}` \n"
-        if table_verbosity != "NONE":
-            rendered = diff.render_md(("corner", ""), table_verbosity)
-            if rendered.strip() != "":
-                tables += f"<details><summary><code>{pdk}/{scl}/{design}</code></summary>\n{rendered}\n</details>\n\n"
-
-    if total_critical == 0:
-        critical_change_report = (
-            "* No changes to critical metrics were detected in analyzed designs.\n"
-            + critical_change_report
-        )
-    else:
-        critical_change_report = (
-            "* **Changes to critical metrics were detected in the following designs:**\n"
-            + critical_change_report
-        )
-
-    report = ""
-    report += difference_report
-    report += critical_change_report
-
-    return report, tables.strip()
-
-
 @cloup.command(no_args_is_help=True)
 @common_opts
-@cloup.argument("metric_folders", nargs=2)
+@cloup.argument("metric_directories", nargs=2)
 def compare_multiple(
     filter_wildcards: Tuple[str, ...],
     table_verbosity: TableVerbosity,
-    metric_folders: Tuple[str, str],
+    metric_directories: Tuple[str, str],
     table_out: Optional[str],
     significant_figures: int,
 ):
     """
-    Creates a small summary/report of the differences between two folders with
+    Creates a small summary/report of the differences between two directories with
     metrics files.
 
     The metrics files must be named in the format ``{pdk}-{scl}-{design}.metrics.json``.
     All other files are ignored.
     """
-    path_a, path_b = metric_folders
-    summary, tables = _compare_metric_folders(
+    path_a, path_b = metric_directories
+    summary, tables = compare_metric_directories(
         filter_wildcards, table_verbosity, path_a, path_b, significant_figures
     )
     print(summary)
@@ -309,7 +182,7 @@ cli.add_command(compare_multiple)
     help="A GitHub token to use to query the API and fetch the metrics. Not strictly required, but helps avoid rate-limiting.",
 )
 @common_opts
-@cloup.argument("metric_folder", nargs=1)
+@cloup.argument("metric_directory", nargs=1)
 def compare_remote(
     filter_wildcards: Tuple[str, ...],
     table_verbosity: TableVerbosity,
@@ -317,13 +190,13 @@ def compare_remote(
     metric_repo: str,
     commit: Optional[str],
     token: str,
-    metric_folder: str,
+    metric_directory: str,
     table_out: Optional[str],
     significant_figures: int,
     branch: str,
 ):
     """
-    Creates a small summary/report of the differences between a folder and
+    Creates a small summary/report of the differences between a directory and
     a set of metrics stored in --metric-repo. Requires Internet access and
     access to GitHub.
 
@@ -379,11 +252,11 @@ def compare_remote(
                         with open(final_path, "wb") as f:
                             f.write(io.read())
 
-            summary, tables = _compare_metric_folders(
+            summary, tables = compare_metric_directories(
                 filter_wildcards,
                 table_verbosity,
                 d,
-                metric_folder,
+                metric_directory,
                 significant_figures,
             )
             print(summary)

librelane-3.1.0.dev4/librelane/common/metrics/compare.py

@@ -0,0 +1,156 @@
+# Copyright 2026 LibreLane Contributors
+#
+# Adapted from OpenLane 2
+#
+# Copyright 2023 Efabless Corporation
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+import os
+import json
+from decimal import Decimal
+from typing import Set, Tuple
+
+from .util import MetricDiff, TableVerbosity
+from ..misc import Filter
+
+default_filter_set = [
+    "design__*__area",
+    "design__max_*",
+    "design__lvs_error__count",
+    "antenna__violating*",
+    "clock__*",
+    "ir__*",
+    "power__*",
+    "timing__*_vio__*",
+    "timing*wns*",
+    "timing*tns*",
+    "*error*",
+    "!*__iter:*",
+]
+
+# passing_filter_set = [
+#     "design__*__area",
+#     "route__wirelength__max",
+#     "design__instance__utilization",
+#     "antenna__violating*",
+#     "timing__*__ws",
+#     "clock__skew__*",
+#     "ir__*",
+#     "power__*",
+#     "!*__iter:*",
+# ]
+
+
+def compare_metric_directories(
+    filter_wildcards: Tuple[str, ...],
+    table_verbosity: TableVerbosity,
+    path_a: str,
+    path_b: str,
+    significant_figures: int,
+) -> Tuple[str, str]:  # (summary, table)
+    a: Set[Tuple[str, str, str]] = set()
+    b: Set[Tuple[str, str, str]] = set()
+
+    def add_designs(in_dir: str, to_set: Set[Tuple[str, str, str]]):
+        for file in os.listdir(in_dir):
+            basename = os.path.basename(file)
+            if not basename.endswith(".metrics.json"):
+                continue
+            basename = basename[: -len(".metrics.json")]
+
+            # We have to rsplit, since ihp-sg13g2 contains a "-"
+            parts = basename.rsplit("-", maxsplit=2)
+            if len(parts) != 3:
+                raise ValueError(
+                    f"Invalid filename {basename}: not in the format {{pdk}}-{{scl}}-{{design_name}}"
+                )
+            pdk, scl, design = parts
+            to_set.add((pdk, scl, design))
+
+    add_designs(path_a, a)
+    add_designs(path_b, b)
+
+    not_in_a = b - a
+    not_in_b = a - b
+    common = a.intersection(b)
+    difference_report = ""
+    for tup in not_in_a:
+        pdk, scl, design = tup
+        difference_report += f"* Results for a new test, `{'/'.join(tup)}`, detected.\n"
+    for tup in not_in_b:
+        pdk, scl, design = tup
+        difference_report += (
+            f"* ‼️ Results for `{'/'.join(tup)}` appear to be missing!\n"
+        )
+
+    final_filters = []
+    for wildcard in filter_wildcards:
+        if wildcard == "DEFAULT":
+            final_filters += default_filter_set
+        else:
+            final_filters.append(wildcard)
+
+    filter = Filter(final_filters)
+    critical_change_report = ""
+    tables = ""
+    total_critical = 0
+    for pdk, scl, design in sorted(common):
+        metrics_a = json.load(
+            open(
+                os.path.join(path_a, f"{pdk}-{scl}-{design}.metrics.json"),
+                encoding="utf8",
+            ),
+            parse_float=Decimal,
+        )
+
+        metrics_b = json.load(
+            open(
+                os.path.join(path_b, f"{pdk}-{scl}-{design}.metrics.json"),
+                encoding="utf8",
+            ),
+            parse_float=Decimal,
+        )
+
+        diff = MetricDiff.from_metrics(
+            metrics_a,
+            metrics_b,
+            significant_figures,
+            filter=filter,
+        )
+
+        stats = diff.stats()
+
+        total_critical += stats.critical
+        if stats.critical > 0:
+            critical_change_report += f"  * `{pdk}/{scl}/{design}` \n"
+        if table_verbosity != "NONE":
+            rendered = diff.render_md(("corner", ""), table_verbosity)
+            if rendered.strip() != "":
+                tables += f"<details><summary><code>{pdk}/{scl}/{design}</code></summary>\n{rendered}\n</details>\n\n"
+
+    if total_critical == 0:
+        critical_change_report = (
+            "* No changes to critical metrics were detected in analyzed designs.\n"
+            + critical_change_report
+        )
+    else:
+        critical_change_report = (
+            "* **Changes to critical metrics were detected in the following designs:**\n"
+            + critical_change_report
+        )
+
+    report = ""
+    report += difference_report
+    report += critical_change_report
+
+    return report, tables.strip()

{librelane-3.1.0.dev2 → librelane-3.1.0.dev4}/librelane/common/misc.py

@@ -40,6 +40,7 @@ from typing import (
 )
 
 import httpx
+from deprecated.sphinx import deprecated
 
 from ..__version__ import __version__
 from .types import AnyPath, Path
@@ -75,6 +76,11 @@ def get_script_dir() -> str:
     )
 
 
+@deprecated(
+    version="3.1.0",
+    reason="Use get_ciel_pdk_hash, this method can force an exit in some codepaths",
+    action="once",
+)
 def get_pdk_hash(pdk_variant) -> str:
     """
     Gets the PDK version hash confirmed compatible with this version of LibreLane.
@@ -92,6 +98,27 @@ def get_pdk_hash(pdk_variant) -> str:
     exit(1)
 
 
+def get_ciel_pdk_hash(pdk_variant: str) -> str:
+    """
+    Gets the PDK version hash confirmed compatible with this version of LibreLane.
+
+    Requires ciel
+    """
+    import ciel
+
+    with open(os.path.join(get_librelane_root(), "pdk_hashes.yaml"), "r") as file:
+        pdk_hashes = yaml.safe_load(file)
+
+    pdk_family = ciel.resolve_pdk_family(pdk_variant)
+
+    if pdk_family not in pdk_hashes:
+        raise ValueError(
+            f"LibreLane does not have a validated version for Ciel PDK family {pdk_family}."
+        )
+
+    return pdk_hashes[pdk_family]
+
+
 # The following code snippet has been adapted under the following license:
 #
 # Copyright (c) Django Software Foundation and individual contributors.

{librelane-3.1.0.dev2 → librelane-3.1.0.dev4}/librelane/common/toolbox.py

@@ -367,6 +367,11 @@ class Toolbox(object):
             warn(f"Failed to generate preview: {e}.")
             return None
 
+    @deprecated(
+        version="3.1.0",
+        reason="No longer needed by internal LibreLane steps and will be removed in LibreLane 4.0.",
+        action="once",
+    )
     def remove_cells_from_lib(
         self,
         input_lib_files: FrozenSet[str],

{librelane-3.1.0.dev2 → librelane-3.1.0.dev4}/librelane/config/__init__.py

@@ -1,3 +1,7 @@
+# Copyright 2025 LibreLane Contributors
+#
+# Adapted from OpenLane 2
+#
 # Copyright 2023 Efabless Corporation
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

{librelane-3.1.0.dev2 → librelane-3.1.0.dev4}/librelane/config/__main__.py

@@ -1,3 +1,7 @@
+# Copyright 2025 LibreLane Contributors
+#
+# Adapted from OpenLane 2
+#
 # Copyright 2023 Efabless Corporation
 #
 # Licensed under the Apache License, Version 2.0 (the "License");

{librelane-3.1.0.dev2 → librelane-3.1.0.dev4}/librelane/config/config.py

@@ -1,3 +1,7 @@
+# Copyright 2025 LibreLane Contributors
+#
+# Adapted from OpenLane 2
+#
 # Copyright 2023 Efabless Corporation
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -678,6 +682,7 @@ class Config(GenericImmutableDict[str, Any]):
                 raw,
                 only_extract_process_info=True,
                 design_dir=design_dir,
+                version=meta.version,
             )
         )
 
@@ -715,6 +720,7 @@ class Config(GenericImmutableDict[str, Any]):
                 scl=mutable[SpecialKeys.scl],
                 pad=mutable.get(SpecialKeys.pad, pad),
                 design_dir=design_dir,
+                version=meta.version,
             )
         )
 
@@ -775,6 +781,9 @@ class Config(GenericImmutableDict[str, Any]):
             tcl_config,
             only_extract_process_info=True,
             design_dir=design_dir,
+            # Tcl is version 1 by default I believe; on par with JSON
+            # also this path is deprecated anyways
+            version=1,
         )
 
         pdk = process_info.get(SpecialKeys.pdk) or pdk
@@ -810,7 +819,7 @@ class Config(GenericImmutableDict[str, Any]):
             try:
                 import ciel
 
-                pdk_root = ciel.get_ciel_home(pdk_root)
+                pdk_root = str(ciel.get_ciel_home(pdk_root))
             except ImportError:
                 raise ValueError(
                     "The pdk_root argument is required as Ciel is not installed."

{librelane-3.1.0.dev2 → librelane-3.1.0.dev4}/librelane/config/flow.py

@@ -1,6 +1,6 @@
 # Copyright 2025 LibreLane Contributors
 #
-# Adapted from OpenLane
+# Adapted from OpenLane 2
 #
 # Copyright 2023 Efabless Corporation
 #

{librelane-3.1.0.dev2 → librelane-3.1.0.dev4}/librelane/config/pdk_compat.py

@@ -1,3 +1,7 @@
+# Copyright 2025 LibreLane Contributors
+#
+# Adapted from OpenLane 2
+#
 # Copyright 2023-2025 Efabless Corporation
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -325,9 +329,9 @@ def migrate_old_config(config: Mapping[str, Any]) -> Dict[str, Any]:
         if "CLOCK_TRANSITION_CONSTRAINT" not in config:
             new["CLOCK_TRANSITION_CONSTRAINT"] = 0.15
         if "TIME_DERATING_CONSTRAINT" not in config:
-            new["TIME_DERATING_CONSTRAINT"] = 5
+            new["TIME_DERATING_CONSTRAINT"] = 5.0
         if "IO_DELAY_CONSTRAINT" not in config:
-            new["IO_DELAY_CONSTRAINT"] = 20
+            new["IO_DELAY_CONSTRAINT"] = 20.0
 
         # Unspecififed is fine
         # if "FP_IO_MIN_DISTANCE" not in config:
@@ -350,4 +354,20 @@ def migrate_old_config(config: Mapping[str, Any]) -> Dict[str, Any]:
         if "HEURISTIC_ANTENNA_THRESHOLD" not in config:
             new["HEURISTIC_ANTENNA_THRESHOLD"] = 130
 
+    # x7. KLAYOUT_DRC_OPTIONS to defines
+    if new["PDK"].startswith("sky130") and "KLAYOUT_DRC_OPTIONS" in new:
+        tcl_dict = new["KLAYOUT_DRC_OPTIONS"]
+        ws_rx = re.compile(r"\s+")
+        del new["KLAYOUT_DRC_OPTIONS"]
+        new["KLAYOUT_DRC_DEFINES"] = {}
+        # deliberately not checking for bad dicts or dicts that require quoting
+        # it's already overkill to assume people modified the PDK files here
+        #
+        # if someone complains we can parse a Tcl dict later
+        tcl_dict_entries = ws_rx.split(tcl_dict)
+        while len(tcl_dict_entries):
+            key = tcl_dict_entries.pop(0)
+            value = tcl_dict_entries.pop(0)
+            new["KLAYOUT_DRC_DEFINES"][key] = value
+
     return new