librelane 3.1.0.dev3__tar.gz → 3.1.0.dev4__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: librelane
-Version: 3.1.0.dev3
+Version: 3.1.0.dev4
 Summary: An infrastructure for implementing chip design flows
 License-Expression: Apache-2.0
 Maintainer: Mohamed Gaber
@@ -12,7 +12,8 @@ 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)
+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)

{librelane-3.1.0.dev3 → 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.dev3 → 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.dev3 → 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.dev3 → 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.dev3 → 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.dev3 → 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");
@@ -815,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.dev3 → 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.dev3 → 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");
@@ -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

{librelane-3.1.0.dev3 → librelane-3.1.0.dev4}/librelane/config/preprocessor.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.dev3 → librelane-3.1.0.dev4}/librelane/config/removals.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.dev3 → librelane-3.1.0.dev4}/librelane/config/variable.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.dev3 → librelane-3.1.0.dev4}/librelane/flows/cli.py

@@ -43,7 +43,7 @@ from cloup.constraints import (
 from cloup.typing import Decorator
 
 from .flow import Flow
-from ..common import set_tpe, cli, get_pdk_hash, _get_process_limit
+from ..common import set_tpe, cli, get_ciel_pdk_hash, _get_process_limit
 from ..logging import set_log_level, verbose, err, options, LogLevels
 from ..state import State, InvalidState
 
@@ -517,8 +517,7 @@ def cloup_flow_opts(
                     import ciel
                     from ciel.source import StaticWebDataSource
 
-                    opdks_rev = volare_pdk_override or get_pdk_hash(pdk)
-                    ciel_home = ciel.get_ciel_home(pdk_root)
+                    ciel_home = str(ciel.get_ciel_home(pdk_root))
 
                     include_libraries = ["default"]
                     if scl is not None:
@@ -527,32 +526,35 @@ def cloup_flow_opts(
                     if pad is not None:
                         include_libraries.append(pad)
 
-                    pdk_family = None
-                    if family := ciel.Family.by_name.get(pdk):
-                        pdk = family.default_variant
-                        pdk_family = family.name
-                        verbose(f"Resolved PDK variant {family.default_variant}.")
-                    else:
-                        for family in ciel.Family.by_name.values():
-                            if pdk in family.variants:
-                                pdk_family = family.name
-                                break
-
-                    if pdk_family is None:
-                        err(f"Could not resolve the PDK '{pdk}'.")
+                    selector = pdk
+
+                    try:
+                        pdk = ciel.resolve_pdk_variant(pdk)
+                        if pdk != selector:
+                            verbose(f"Resolved PDK variant {pdk}.")
+                    except ValueError as e:
+                        err(str(e))
+                        err("If you're using a non-Ciel PDK, please pass --manual-pdk.")
+                        exit(1)
+
+                    try:
+                        opdks_rev = volare_pdk_override or get_ciel_pdk_hash(pdk)
+                    except ValueError as e:
+                        err(str(e))
+                        err("Please specify a PDK manually with '--manual-pdk'.")
                         exit(1)
 
                     try:
                         version = ciel.fetch(
                             ciel_home,
-                            pdk_family,
+                            pdk,  # only pull default libraries for resolved variant since we have a message saying "Resolved variant {pdk}..."
                             opdks_rev,
                             data_source=StaticWebDataSource(
                                 "https://fossi-foundation.github.io/ciel-releases"
                             ),
                             include_libraries=include_libraries,
                         )
-                        pdk_root = version.get_dir(ciel_home)
+                        pdk_root = str(version.get_dir(ciel_home))
                     except ValueError as e:
                         err(f"Failed to download PDK: {e}")
                         exit(1)

{librelane-3.1.0.dev3 → librelane-3.1.0.dev4}/librelane/flows/synth_explore.py

@@ -79,6 +79,7 @@ class SynthesisExploration(Flow):
         options.set_condensed_mode(True)
 
         for strategy in [
+            "DEFAULT",
             "AREA 0",
             "AREA 1",
             "AREA 2",

librelane-3.1.0.dev4/librelane/pdk_hashes.yaml

@@ -0,0 +1,4 @@
+sky130: 792ef67037d74c8c51811eab3ce23cf793491296
+gf180mcu: 792ef67037d74c8c51811eab3ce23cf793491296
+ihp-sg13: 89d42ee6d2fd9b50b86a1aada6fee6673c3e6008
+freepdk45: 784b1a483a5f4de362d6f3629378de1199453f3c

{librelane-3.1.0.dev3 → librelane-3.1.0.dev4}/librelane/scripts/odbpy/check_antenna_properties.py

@@ -65,7 +65,7 @@ def check_cells(odb_cells):
         }
         report.append(entry)
 
-        return report
+    return report
 
 
 def get_top_level_cell(input_lefs, design_lef, cell_name):

{librelane-3.1.0.dev3 → librelane-3.1.0.dev4}/librelane/scripts/odbpy/defutil.py

@@ -562,7 +562,10 @@ def remove_obstructions(reader, input_lefs, obstructions):
             if (odb_layer, odb_bbox) == (layer, bbox):
                 print(f"Removing obstruction on {layer} at {bbox} (DBU)…")
                 found = True
-                odb.dbObstruction_destroy(odb_obj)
+                if not odb_obj.isSystemReserved():
+                    odb.dbObstruction_destroy(odb_obj)
+                else:
+                    print("[WARNING] Obstruction is system-reserved.")
             if found:
                 break
         if not found:

{librelane-3.1.0.dev3 → librelane-3.1.0.dev4}/librelane/scripts/openroad/common/io.tcl

@@ -19,11 +19,23 @@ source $::env(_TCL_ENV_IN)
 source $::env(SCRIPTS_DIR)/openroad/common/set_global_connections.tcl
 
 namespace eval lln {
+    proc scene_name {scene} {
+        # OpenSTA >= 3.1 (commit 998806cb, 2026-06-30) bridges scenes as SWIG
+        # objects instead of strings. Older OpenSTA 3 bridges them as strings,
+        # in which case the value already is the name.
+        if { [sta::is_object $scene] } {
+            return [sta::get_property $scene name]
+        }
+        return $scene
+    }
     proc get_corner_names {} {
         # returns: names as a Tcl list, compatible with both OpenSTA 2 and 3
         if {[string length [namespace which sta::scenes]] != 0} {
-            # scenes are bridged as a list of strings
-            return [sta::scenes]
+            set result [list]
+            foreach scene [sta::scenes] {
+                lappend result [scene_name $scene]
+            }
+            return $result
         } else {
             # corners are not bridged as strings
             set result [list]
@@ -36,12 +48,14 @@ namespace eval lln {
     proc get_corner_dict {} {
         # returns: Tcl dictionary from corner names to whatever object is
         # interpreted as a corner for internal commands that expect corners:
-        # - in OpenSTA 3, that's the scene's name again
+        # - in OpenSTA 3, that's whatever sta::find_scene returns (a name in
+        #   OpenSTA 3.0, a Scene object since 3.1)
         # - in OpenSTA 2, that's an opaque Tcl pointer
         set result [dict create]
         if {[string length [namespace which sta::scenes]] != 0} {
             foreach scene [sta::scenes] {
-                dict set result $scene $scene
+                set name [scene_name $scene]
+                dict set result $name [sta::find_scene $name]
             }
         } else {
             foreach corner [sta::corners] {
@@ -52,7 +66,11 @@ namespace eval lln {
     }
 
     proc set_sta_cmd_corner {corner_name} {
-        if {[string length [namespace which sta::set_cmd_scene]] != 0} {
+        # sta::set_scene takes a name in every OpenSTA 3; sta::set_cmd_scene
+        # takes a name before 998806cb and a Scene object after.
+        if {[string length [namespace which sta::set_scene]] != 0} {
+            sta::set_scene $corner_name
+        } elseif {[string length [namespace which sta::set_cmd_scene]] != 0} {
             sta::set_cmd_scene $corner_name
         } else {
             set corner_object [sta::find_corner $corner_name]

{librelane-3.1.0.dev3 → librelane-3.1.0.dev4}/librelane/scripts/openroad/repair_design.tcl

@@ -49,11 +49,11 @@ lappend arg_list -verbose
 lappend arg_list -max_wire_length $::env(DESIGN_REPAIR_MAX_WIRE_LENGTH)
 lappend arg_list -slew_margin $::env(DESIGN_REPAIR_MAX_SLEW_PCT)
 lappend arg_list -cap_margin $::env(DESIGN_REPAIR_MAX_CAP_PCT)
-if { [info exists ::env(DESIGN_REPAIR_MAX_UTILIZATION)] } {
+if { $::env(DESIGN_REPAIR_MAX_UTILIZATION) > 0 } {
     lappend arg_list -max_utilization $::env(DESIGN_REPAIR_MAX_UTILIZATION)
 }
-if { [info exists ::env(DESIGN_REPAIR_BUFFER_GAIN)] } {
-    lappend arg_list -buffer_gain $::env(DESIGN_REPAIR_BUFFER_GAIN)
+if { $::env(DESIGN_REPAIR_PRE_PLACEMENT) } {
+    lappend arg_list -pre_placement
 }
 # Repair Design
 log_cmd repair_design {*}$arg_list

{librelane-3.1.0.dev3 → librelane-3.1.0.dev4}/librelane/scripts/openroad/repair_design_postgrt.tcl

@@ -36,12 +36,9 @@ lappend arg_list -verbose
 lappend arg_list -max_wire_length $::env(GRT_DESIGN_REPAIR_MAX_WIRE_LENGTH)
 lappend arg_list -slew_margin $::env(GRT_DESIGN_REPAIR_MAX_SLEW_PCT)
 lappend arg_list -cap_margin $::env(GRT_DESIGN_REPAIR_MAX_CAP_PCT)
-if { [info exists ::env(GRT_DESIGN_REPAIR_MAX_UTILIZATION)] } {
+if { $::env(GRT_DESIGN_REPAIR_MAX_UTILIZATION) > 0 } {
     lappend arg_list -max_utilization $::env(GRT_DESIGN_REPAIR_MAX_UTILIZATION)
 }
-if { [info exists ::env(GRT_DESIGN_REPAIR_BUFFER_GAIN)] } {
-    lappend arg_list -buffer_gain $::env(GRT_DESIGN_REPAIR_BUFFER_GAIN)
-}
 log_cmd repair_design {*}$arg_list
 
 # Re-DPL and GRT

{librelane-3.1.0.dev3 → librelane-3.1.0.dev4}/librelane/scripts/pyosys/synthesize.py

@@ -257,6 +257,10 @@ def synthesize(
     config = json.load(open(config_in))
     extra = json.load(open(extra_in))
 
+    lib_dont_use_args = []
+    for excluded_cell in extra["excluded_cell_patterns"]:
+        lib_dont_use_args.extend(("-dont_use", excluded_cell))
+
     includes = config.get("VERILOG_INCLUDE_DIRS") or []
     defines = (
         (config.get("VERILOG_DEFINES") or [])
@@ -288,7 +292,7 @@ def synthesize(
     # https://github.com/YosysHQ/abc/blob/28d955ca97a1c4be3aed4062aec0241a734fac5d/src/map/scl/sclUtil.c#L257
     sdc_path = os.path.join(step_dir, "synthesis.abc.sdc")
     with open(sdc_path, "w") as f:
-        print(f"set_driving_cell {config['SYNTH_DRIVING_CELL']}", file=f)
+        print(f"set_driving_cell {config['SYNTH_DRIVING_CELL'].split('/')[0]}", file=f)
         print(f"set_load {config['OUTPUT_CAP_LOAD']}", file=f)
 
     ys.log(f"[INFO] Using SDC file '{sdc_path}' for ABC…")
@@ -434,6 +438,7 @@ def synthesize(
         cg_min_width = config["SYNTH_CLOCKGATE_MIN_WIDTH"]
         posedge = ()
         negedge = ()
+        tie_lo = ()
         if posedge_raw := config["SYNTH_CLOCKGATE_POSEDGE_ICG"]:
             cell, ce, clk, gclk = posedge_raw.rsplit("/", maxsplit=4)
             posedge = ("-pos", cell, f"{ce}:{clk}:{gclk}")
@@ -444,18 +449,21 @@ def synthesize(
             ys.log(
                 "[WARNING] A minimum width for clock gating is set; but no ICGs are configured."
             )
+        if tie_lo_raw := config["SYNTH_CLOCKGATE_TIE_LO"]:
+            tie_lo = ("-tie_lo", tie_lo_raw)
         d.run_pass(
             "clockgate",
             "-min_net_size",
             str(cg_min_width),
             *posedge,
             *negedge,
+            *tie_lo,
         )
 
     dfflibmap_args = []
     for lib in libs:
         dfflibmap_args.extend(["-liberty", lib])
-    d.run_pass("dfflibmap", *dfflibmap_args)
+    d.run_pass("dfflibmap", *dfflibmap_args, *lib_dont_use_args)
 
     d.tee("stat", "-json", *lib_arguments, o=os.path.join(report_dir, "post_dff.json"))
     d.tee("stat", *lib_arguments, o=os.path.join(report_dir, "post_dff.rpt"))
@@ -465,24 +473,35 @@ def synthesize(
     def run_strategy(d):
         abc_script = config["SYNTH_ABC_STRATEGY_SCRIPT"]
         if abc_script:
-            ys.log(f"[INFO] Using custom ABC strategy script '{abc_script}'…")
-        else:
-            abc_script = script_creator.generate_abc_script(
-                step_dir,
-                config["SYNTH_STRATEGY"],
-            )
-            ys.log(f"[INFO] Using generated ABC strategy script '{abc_script}'…")
-
-        d.run_pass(
-            "abc",
-            "-script",
-            abc_script,
+            ys.log(f"[INFO] Using custom ABC strategy script '{abc_script}'…\n")
+        elif config["SYNTH_STRATEGY"] != "DEFAULT":
+            if config["SYNTH_ABC_NEW"]:
+                ys.log(
+                    "[WARN] Using Yosys-provided synthesis strategy for experimental abc_new pass: use SYNTH_ABC_STRATEGY_SCRIPT to provide your own synthesis scripts."
+                )
+            else:
+                abc_script = script_creator.generate_abc_script(
+                    step_dir,
+                    config["SYNTH_STRATEGY"],
+                )
+                ys.log(f"[INFO] Using generated ABC strategy script '{abc_script}'…\n")
+        ys.log_flush()
+
+        extra_args = ["-script", abc_script] * bool(abc_script)
+        if not config["SYNTH_ABC_NEW"]:
+            extra_args += ["-showtmp"]
+            if config["SYNTH_ABC_DFF"]:
+                extra_args += ["-dff"]
+
+        abc_pass = [
+            "abc_new" if config["SYNTH_ABC_NEW"] else "abc",
             "-constr",
             sdc_path,
-            "-showtmp",
             *lib_arguments,
-            *(["-dff"] if config["SYNTH_ABC_DFF"] else []),
-        )
+            *extra_args,
+            *lib_dont_use_args,
+        ]
+        d.run_pass(*abc_pass)
 
         if value := config.get("SYNTH_TIE_UNDEFINED"):
             flag = "-zero" if value == "low" else "-one"

{librelane-3.1.0.dev3 → librelane-3.1.0.dev4}/librelane/scripts/pyosys/ys_common.py

@@ -18,6 +18,7 @@
 import os
 import re
 import sys
+import shlex
 from typing import Iterable, List, Optional, Tuple, Union
 
 try:
@@ -64,6 +65,9 @@ def yosys_version_at_least(*target: Tuple[int, ...]) -> Tuple[int, int]:
 
 
 def _Design_run_pass(self, *command):
+    if pass_dump := os.getenv("_LIBRELANE_YOSYS_DUMP_PASSES_TO"):
+        with open(pass_dump, "a+", encoding="utf8") as f:
+            print(shlex.join(command), file=f)
     ys.Pass.call(self, command)
 
 
@@ -151,6 +155,8 @@ def _Design_add_blackbox_models(
                 "-sv",
                 "-setattr",
                 "keep_hierarchy",
+                "-setattr",
+                "blackbox",
                 "-lib",
                 *include_args,
                 *define_args,
@@ -165,6 +171,7 @@ def _Design_add_blackbox_models(
                 "blackbox",
                 "-setattr",
                 "keep_hierarchy",
+                "-unit_delay",
                 model,
             )
         else: