librelane 3.0.0.dev40__tar.gz → 3.0.0.dev42__tar.gz

{librelane-3.0.0.dev40 → librelane-3.0.0.dev42}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: librelane
-Version: 3.0.0.dev40
+Version: 3.0.0.dev42
 Summary: An infrastructure for implementing chip design flows
 License-Expression: Apache-2.0
 Maintainer: Mohamed Gaber

{librelane-3.0.0.dev40 → librelane-3.0.0.dev42}/librelane/__init__.py

@@ -13,7 +13,7 @@
 # limitations under the License.
 """
 The LibreLane API
-----------------
+-----------------
 
 Documented elements of this API represent the primary programming interface for
 the LibreLane infrastructure.

{librelane-3.0.0.dev40 → librelane-3.0.0.dev42}/librelane/__main__.py

@@ -217,7 +217,10 @@ def print_version(ctx: click.Context, param: click.Parameter, value: bool):
     if len(discovered_plugins) > 0:
         print("Discovered plugins:")
         for name, module in discovered_plugins.items():
-            print(f"{name} -> {module.__version__}")
+            if hasattr(module, "__version__"):
+                print(f"{name} -> {module.__version__}")
+            else:
+                print(f"{name}")
 
     ctx.exit(0)
 

{librelane-3.0.0.dev40 → librelane-3.0.0.dev42}/librelane/common/tcl.py

@@ -16,7 +16,6 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 import re
-import tkinter
 from typing import Dict, Mapping, Any, Iterable
 
 _env_rx = re.compile(r"(?:\:\:)?env\((\w+)\)")
@@ -59,6 +58,8 @@ class TclUtils(object):
 
     @staticmethod
     def _eval_env(env_in: Mapping[str, Any], tcl_in: str) -> Dict[str, Any]:
+        import tkinter
+
         interpreter = tkinter.Tcl()
 
         interpreter.eval("array unset ::env")

{librelane-3.0.0.dev40 → librelane-3.0.0.dev42}/librelane/config/variable.py

@@ -16,7 +16,6 @@ import inspect
 from enum import Enum
 from decimal import Decimal, InvalidOperation
 from dataclasses import (
-    _MISSING_TYPE,
     MISSING,
     asdict,
     dataclass,
@@ -24,6 +23,7 @@ from dataclasses import (
     fields,
     is_dataclass,
 )
+import types
 from typing import (
     ClassVar,
     Dict,
@@ -219,7 +219,8 @@ class Macro:
 
 def is_optional(t: Type[Any]) -> bool:
     type_args = get_args(t)
-    return get_origin(t) is Union and type(None) in type_args
+    origin = get_origin(t)
+    return (origin is Union or origin is types.UnionType) and type(None) in type_args
 
 
 def some_of(t: Type[Any]) -> Type[Any]:
@@ -229,11 +230,20 @@ def some_of(t: Type[Any]) -> Type[Any]:
     # t must be a Union with None if we're here
 
     type_args = get_args(t)
+    origin = get_origin(t)
 
-    args_without_none = [arg for arg in type_args if arg != type(None)]
+    args_without_none = [arg for arg in type_args if arg is not type(None)]
     if len(args_without_none) == 1:
         return args_without_none[0]
 
+    if origin is types.UnionType:
+        # Use the | operator to create a UnionType
+        result = args_without_none[0]
+        for arg in args_without_none[1:]:
+            result = result | arg
+        return result
+
+    # Otherwise, return a typing.Union
     new_union = Union[tuple(args_without_none)]  # type: ignore
     return new_union  # type: ignore
 
@@ -440,7 +450,7 @@ class Variable:
             return_value = list()
             raw = value
             if isinstance(raw, list) or isinstance(raw, tuple):
-                if type_origin == list and type_args == (str,):
+                if type_origin is list and type_args == (str,):
                     if any(isinstance(item, List) for item in raw):
                         Variable.__flatten_list(value)
                 pass
@@ -462,7 +472,7 @@ class Variable:
                     f"List provided for variable '{key_path}' is invalid: {value}"
                 )
 
-            if type_origin == tuple:
+            if type_origin is tuple:
                 if len(raw) != len(type_args):
                     raise ValueError(
                         f"Value provided for variable '{key_path}' of type {validating_type} is invalid: ({len(raw)}/{len(type_args)}) tuple entries provided"
@@ -481,11 +491,11 @@ class Variable:
                     )
                 )
 
-            if type_origin == tuple:
+            if type_origin is tuple:
                 return tuple(return_value)
 
             return return_value
-        elif type_origin == dict:
+        elif type_origin is dict:
             raw = value
             key_type, value_type = type_args
             if isinstance(raw, dict):
@@ -586,7 +596,7 @@ class Variable:
                 field_default = None
                 if (
                     current_field.default is not None
-                    and type(current_field.default) != _MISSING_TYPE
+                    and current_field.default != MISSING
                 ):
                     field_default = current_field.default
                 if current_field.default_factory != MISSING:
@@ -615,7 +625,7 @@ class Variable:
             result = Path(value)
             result.validate(f"Path provided for variable '{key_path}' is invalid")
             return result
-        elif validating_type == bool:
+        elif validating_type is bool:
             if not permissive_typing and not isinstance(value, bool):
                 raise ValueError(
                     f"Refusing to automatically convert '{value}' at '{key_path}' to a Boolean"
@@ -629,7 +639,7 @@ class Variable:
                     f"Value provided for variable '{key_path}' of type {validating_type.__name__} is invalid: '{value}'"
                 )
         elif issubclass(validating_type, Enum):
-            if type(value) == validating_type:
+            if type(value) is validating_type:
                 return value
             try:
                 return validating_type[value]

{librelane-3.0.0.dev40 → librelane-3.0.0.dev42}/librelane/container.py

@@ -57,10 +57,13 @@ def gui_args(osinfo: OSInfo) -> List[str]:
             args += [
                 "-e",
                 f"DISPLAY={os.environ.get('DISPLAY')}",
-                "-v",
-                "/tmp/.X11-unix:/tmp/.X11-unix",
-                "-v",
-                f"{os.path.expanduser('~')}/.Xauthority:/.Xauthority",
+            ]
+            if os.path.isdir("/tmp/.X11-unix"):
+                args += ["-v", "/tmp/.X11-unix:/tmp/.X11-unix"]
+            homedir = os.path.expanduser("~")
+            if os.path.isfile(f"{homedir}/.Xauthority"):
+                args += ["-v", f"{homedir}/.Xauthority:/.Xauthority"]
+            args += [
                 "--network",
                 "host",
                 "--security-opt",

librelane-3.0.0.dev42/librelane/examples/hold_eco_demo/config.yaml

@@ -0,0 +1,18 @@
+DESIGN_NAME: hold_violation
+CLOCK_PORT: clk
+CLOCK_PERIOD: 5
+VERILOG_FILES: dir::demo.v
+RUN_POST_CTS_RESIZER_TIMING: false
+RUN_POST_GRT_RESIZER_TIMING: false
+FP_SIZING: absolute
+DIE_AREA: [0, 0, 100, 100]
+INSERT_ECO_BUFFERS:
+  - target: u_ff1/Q
+    buffer: sky130_fd_sc_hd__buf_1
+  - target: u_ff1/Q
+    buffer: sky130_fd_sc_hd__buf_1
+meta:
+  flow: Classic
+  substituting_steps:
+    "+OpenROAD.DetailedRouting": "Odb.InsertECOBuffers"
+    "+Odb.InsertECOBuffers": "OpenROAD.DetailedRouting"

librelane-3.0.0.dev42/librelane/examples/hold_eco_demo/demo.v

@@ -0,0 +1,27 @@
+module hold_violation(
+    input clk,
+    input d,
+    output q
+);
+    wire intermediate;
+    wire clk_delayed;
+
+    sky130_fd_sc_hd__clkbuf_4 dly (
+        .A(clk),
+        .X(clk_delayed)
+    );
+
+    sky130_fd_sc_hd__dfrtp_4 u_ff1 (
+        .CLK(clk),
+        .D(d),
+        .RESET_B(1'b1),
+        .Q(intermediate)
+    );
+
+    sky130_fd_sc_hd__dfrtp_1 u_ff2 (
+        .CLK(clk_delayed),
+        .D(intermediate),
+        .RESET_B(1'b1),
+        .Q(q)
+    );
+endmodule

{librelane-3.0.0.dev40 → librelane-3.0.0.dev42}/librelane/flows/cli.py

@@ -43,7 +43,7 @@ from cloup.typing import Decorator
 
 from .flow import Flow
 from ..common import set_tpe, cli, get_pdk_hash, _get_process_limit
-from ..logging import set_log_level, verbose, err, options, LogLevels
+from ..logging import set_log_level, verbose, info, err, options, LogLevels
 from ..state import State, InvalidState
 
 
@@ -520,16 +520,29 @@ def cloup_flow_opts(
                         err(f"Could not resolve the PDK '{pdk}'.")
                         exit(1)
 
-                    version = ciel.fetch(
-                        ciel_home,
-                        pdk_family,
-                        opdks_rev,
-                        data_source=StaticWebDataSource(
-                            "https://fossi-foundation.github.io/ciel-releases"
-                        ),
-                        include_libraries=include_libraries,
-                    )
-                    pdk_root = version.get_dir(ciel_home)
+                    if pdk_family == "ihp-sg13g2":
+                        err(
+                            "The IHP Open PDK is only supported in the development version of LibreLane, specifically 3.0.0.dev28 or higher."
+                        )
+                        info(
+                            "If you're using Nix, switch to the 'dev' branch. If you're using the Python package, run \"python3 -m pip install 'librelane>=3.0.0.dev28'\"."
+                        )
+                        exit(1)
+
+                    try:
+                        version = ciel.fetch(
+                            ciel_home,
+                            pdk_family,
+                            opdks_rev,
+                            data_source=StaticWebDataSource(
+                                "https://fossi-foundation.github.io/ciel-releases"
+                            ),
+                            include_libraries=include_libraries,
+                        )
+                        pdk_root = version.get_dir(ciel_home)
+                    except ValueError as e:
+                        err(f"Failed to download PDK: {e}")
+                        exit(1)
 
                 return f(*args, pdk_root=pdk_root, pdk=pdk, scl=scl, **kwargs)
 

{librelane-3.0.0.dev40 → librelane-3.0.0.dev42}/librelane/scripts/odbpy/defutil.py

@@ -248,13 +248,19 @@ def relocate_pins(db, input_lefs, template_def, permissive, copy_def_power=False
             pin_name = bterm.getName()
             pin_net_name = bterm.getNet().getName()
             pin_net = output_block.findNet(pin_net_name)
+            new_net_created = False
             if pin_net is None:
                 pin_net = odb.dbNet.create(output_block, pin_net_name, True)
                 pin_net.setSpecial()
                 pin_net.setSigType(bterm.getSigType())
-            pin_bterm = odb.dbBTerm.create(pin_net, pin_name)
-            pin_bterm.setSigType(bterm.getSigType())
-            output_bterms.append(pin_bterm)
+                new_net_created = True
+            pin_bterm = output_block.findBTerm(pin_name)
+            if pin_bterm is None:
+                pin_bterm = odb.dbBTerm.create(pin_net, pin_name)
+                pin_bterm.setSigType(bterm.getSigType())
+                output_bterms.append(pin_bterm)
+            elif new_net_created:
+                pin_bterm.connect(pin_net)
 
     grid_errors = False
     for output_bterm in output_bterms:

{librelane-3.0.0.dev40 → librelane-3.0.0.dev42}/librelane/scripts/odbpy/eco_buffer.py

@@ -43,8 +43,9 @@ def cli(reader):
     grt_inc = GRT.IncrementalGRoute(grt, reader.block)
     i = 0
 
-    for target_info in reader.config["INSERT_ECO_BUFFERS"]:
-        target_name, target_pin = target_info["target"].rsplit("/", 1)
+    eco_buffers = reader.config["INSERT_ECO_BUFFERS"] or []
+    for target_info in eco_buffers:
+        target_name, target_pin = target_info["target"].split("/")
         name_escaped = reader.escape_verilog_name(target_name)
         buffer_master = target_info["buffer"]
 

{librelane-3.0.0.dev40 → librelane-3.0.0.dev42}/librelane/scripts/odbpy/eco_diode.py

@@ -38,9 +38,9 @@ def cli(reader):
     # print(grt)
     grt_inc = GRT.IncrementalGRoute(grt, reader.block)
     i = 0
-
-    for target_info in reader.config["INSERT_ECO_DIODES"]:
-        target_name, target_pin = target_info["target"].rsplit("/", 1)
+    diodes = reader.config["INSERT_ECO_DIODES"] or []
+    for target_info in diodes:
+        target_name, target_pin = target_info["target"].split("/")
         name_escaped = reader.escape_verilog_name(target_name)
 
         target = reader.block.findInst(name_escaped)

{librelane-3.0.0.dev40 → librelane-3.0.0.dev42}/librelane/steps/__main__.py

@@ -47,8 +47,9 @@ def load_step_from_inputs(
         if Found := Step.factory.get(id):
             Target = Found
         else:
-            err(
-                f"No step registered with id '{id}'. Ensure all relevant plugins are installed."
+            err(f"No step registered with id '{id}'.")
+            info(
+                f"If the step '{id}' is part of a plugin, make sure the plugin's parent directory is in the PYTHONPATH environment variable."
             )
             ctx.exit(-1)
 

{librelane-3.0.0.dev40 → librelane-3.0.0.dev42}/librelane/steps/checker.py

@@ -79,22 +79,21 @@ class MetricChecker(Step):
     deferred: ClassVar[bool] = True
     error_on_var: Optional[Variable] = None
 
-    @classmethod
-    def get_help_md(Self, **kwargs):  # pragma: no cover
-        threshold_string = Self.get_threshold_description(None)
+    def __init_subclass__(cls):
+        threshold_string = cls.get_threshold_description(None)
         if threshold_string is None:
-            threshold_string = str(Self.get_threshold(None))
+            threshold_string = str(cls.get_threshold(None))
         dynamic_docstring = "Raises"
-        if Self.deferred:
+        if cls.deferred:
             dynamic_docstring += " a deferred error"
         else:
             dynamic_docstring += " an immediate error"
-        dynamic_docstring += f" if {Self.metric_description} (metric: ``{Self.metric_name}``) are >= {threshold_string}."
+        dynamic_docstring += f" if {cls.metric_description} (metric: ``{cls.metric_name}``) are >= {threshold_string}."
         dynamic_docstring += (
             " Doesn't raise an error depending on error_on_var if defined."
         )
-
-        return super().get_help_md(docstring_override=dynamic_docstring, **kwargs)
+        cls.__doc__ = dynamic_docstring
+        return super().__init_subclass__()
 
     def get_threshold(self: Optional["MetricChecker"]) -> Optional[Decimal]:
         return Decimal(0)

{librelane-3.0.0.dev40 → librelane-3.0.0.dev42}/librelane/steps/klayout.py

@@ -353,6 +353,15 @@ class XOR(KLayoutStep):
 
 @Step.factory.register()
 class DRC(KLayoutStep):
+    """
+    Runs DRC using KLayout.
+
+    Unlike most steps, the KLayout scripts vary quite wildly by PDK. If a PDK
+    is not supported by this step, it will simply be skipped.
+
+    Currently, only sky130A and sky130B are supported.
+    """
+
     id = "KLayout.DRC"
     name = "Design Rule Check (KLayout)"
 

{librelane-3.0.0.dev40 → librelane-3.0.0.dev42}/librelane/steps/misc.py

@@ -53,6 +53,11 @@ class LoadBaseSDC(Step):
 
 @Step.factory.register()
 class ReportManufacturability(Step):
+    """
+    Logs a simple "manufacturability report", i.e., the status of DRC, LVS, and
+    antenna violations.
+    """
+
     id = "Misc.ReportManufacturability"
     name = "Report Manufacturability"
     long_name = "Report Manufacturability (DRC, LVS, Antenna)"

{librelane-3.0.0.dev40 → librelane-3.0.0.dev42}/librelane/steps/odb.py

@@ -184,6 +184,10 @@ class OdbpyStep(Step):
 
 @Step.factory.register()
 class CheckMacroAntennaProperties(OdbpyStep):
+    """
+    Prints warnings if the LEF views of macros are missing antenna information.
+    """
+
     id = "Odb.CheckMacroAntennaProperties"
     name = "Check Antenna Properties of Macros Pins in Their LEF Views"
     inputs = OdbpyStep.inputs
@@ -221,6 +225,10 @@ class CheckMacroAntennaProperties(OdbpyStep):
 
 @Step.factory.register()
 class CheckDesignAntennaProperties(CheckMacroAntennaProperties):
+    """
+    Prints warnings if the LEF view of the design is missing antenna information.
+    """
+
     id = "Odb.CheckDesignAntennaProperties"
     name = "Check Antenna Properties of Pins in The Generated Design LEF view"
     inputs = CheckMacroAntennaProperties.inputs + [DesignFormat.LEF]
@@ -527,6 +535,11 @@ class ReportDisconnectedPins(OdbpyStep):
 
 @Step.factory.register()
 class AddRoutingObstructions(OdbpyStep):
+    """
+    Adds obstructions on metal layers which prevent shapes from being created in
+    the designated areas.
+    """
+
     id = "Odb.AddRoutingObstructions"
     name = "Add Obstructions"
     config_vars = [
@@ -569,6 +582,11 @@ class AddRoutingObstructions(OdbpyStep):
 
 @Step.factory.register()
 class RemoveRoutingObstructions(AddRoutingObstructions):
+    """
+    Removes any routing obstructions previously placed by
+    <#Odb.AddRoutingObstructions>`_.
+    """
+
     id = "Odb.RemoveRoutingObstructions"
     name = "Remove Obstructions"
 
@@ -578,6 +596,15 @@ class RemoveRoutingObstructions(AddRoutingObstructions):
 
 @Step.factory.register()
 class AddPDNObstructions(AddRoutingObstructions):
+    """
+    Adds obstructions on metal layers which prevent shapes from being created in
+    the designated areas.
+
+    A soft-duplicate of <#Odb.AddRoutingObstructions>`_ , though this one uses
+    a different variable name so the obstructions can be restricted for PDN
+    steps only.
+    """
+
     id = "Odb.AddPDNObstructions"
     name = "Add PDN obstructions"
 
@@ -595,6 +622,11 @@ class AddPDNObstructions(AddRoutingObstructions):
 
 @Step.factory.register()
 class RemovePDNObstructions(RemoveRoutingObstructions):
+    """
+    Removes any PDN obstructions previously placed by
+    <#Odb.RemovePDNObstructions>`_.
+    """
+
     id = "Odb.RemovePDNObstructions"
     name = "Remove PDN obstructions"
 

{librelane-3.0.0.dev40 → librelane-3.0.0.dev42}/librelane/steps/openroad.py

@@ -1518,11 +1518,6 @@ class GlobalPlacementSkipIO(_GlobalPlacement):
             "Path to a custom pin configuration file.",
             deprecated_names=["FP_PIN_ORDER_CFG"],
         ),
-        Variable(
-            "FP_DEF_TEMPLATE",
-            Optional[Path],
-            "Points to the DEF file to be used as a template.",
-        ),
     ]
 
     def run(self, state_in: State, **kwargs) -> Tuple[ViewsUpdate, MetricsUpdate]:

{librelane-3.0.0.dev40 → librelane-3.0.0.dev42}/librelane/steps/pyosys.py

@@ -327,6 +327,12 @@ class VerilogStep(PyosysStep):
 
 @Step.factory.register()
 class JsonHeader(VerilogStep):
+    """
+    Extracts a high-level hierarchical view of the circuit in JSON format,
+    including power connections. The power connections are used in later steps
+    to ensure macros and cells are connected as desired.
+    """
+
     id = "Yosys.JsonHeader"
     name = "Generate JSON Header"
     long_name = "Generate JSON Header"

{librelane-3.0.0.dev40 → librelane-3.0.0.dev42}/librelane/steps/yosys.py

@@ -258,6 +258,14 @@ class YosysStep(TclStep):
 
 @Step.factory.register()
 class EQY(Step):
+    """
+    Experimental: Uses the `EQY <https://github.com/yosyshq/eqy>`_ utility to
+    perform an RTL vs. Netlist equivalence check.
+
+    Currently, you are expected to provide your own EQY script if you want this
+    to work properly.
+    """
+
     id = "Yosys.EQY"
     name = "Equivalence Check"
     long_name = "RTL/Netlist Equivalence Check"
@@ -272,7 +280,7 @@ class EQY(Step):
             Variable(
                 "EQY_SCRIPT",
                 Optional[Path],
-                "An optional override for the automatically generated EQY script for more complex designs.",
+                "The EQY script to use. If unset, a generic EQY script will be generated, but this fails in a number of scenarios.",
             ),
             Variable(
                 "MACRO_PLACEMENT_CFG",

{librelane-3.0.0.dev40 → librelane-3.0.0.dev42}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "librelane"
-version = "3.0.0.dev40"
+version = "3.0.0.dev42"
 description = "An infrastructure for implementing chip design flows"
 maintainers = [
     {name = "Mohamed Gaber", email = "me@donn.website"}
@@ -68,6 +68,12 @@ librelane = "librelane.__main__:cli"
 "librelane.help" = "librelane.help.__main__:cli"
 "librelane.env_info" = "librelane:env_info_cli"
 
+[tool.ruff]
+# syntax-only check, make sure files are parseable under py310
+# $ ruff check .
+target-version = "py310"
+lint.ignore = ["E", "F"] 
+
 [build-system]
 requires = ["poetry-core>=2.0.0,<3"]
 build-backend = "poetry.core.masonry.api"