librelane 2.4.0.dev0__py3-none-any.whl → 2.4.0.dev2__py3-none-any.whl

librelane/__main__.py

@@ -1,3 +1,7 @@
+# Copyright 2025 The American University in Cairo
+#
+# Adapted from OpenLane
+#
 # Copyright 2023 Efabless Corporation
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -202,7 +206,8 @@ def print_version(ctx: click.Context, param: click.Parameter, value: bool):
         f"""
         LibreLane v{__version__}
 
-        Copyright ©2020-2023 Efabless Corporation and other contributors.
+        Copyright ©2020-2025 Efabless Corporation, The American University in
+        Cairo, and other contributors.
 
         Available under the Apache License, version 2. Included with the source code,
         but you can also get a copy at https://www.apache.org/licenses/LICENSE-2.0

librelane/config/config.py

@@ -102,7 +102,7 @@ class PassedDirectoryError(ValueError):
     def __init__(self, config: AnyPath) -> None:
         self.config = str(config)
         super().__init__(
-            "Passing design directories as arguments is unsupported in LibreLane 2 or higher: please pass the configuration file(s) directly."
+            "Passing design directories as arguments is unsupported in LibreLane: please pass the configuration file(s) directly."
         )
 
 
@@ -960,7 +960,7 @@ class Config(GenericImmutableDict[str, Any]):
                 pass
             if not isinstance(dis, int) or dis in [1, 2, 5] or dis > 6:
                 errors.append(
-                    f"DIODE_INSERTION_STRATEGY '{dis}' is not available in LibreLane 2 or higher. See 'Migrating DIODE_INSERTION_STRATEGY' in the docs for more info."
+                    f"DIODE_INSERTION_STRATEGY '{dis}' is not available in LibreLane 2.0 or higher. See 'Migrating DIODE_INSERTION_STRATEGY' in the docs for more info."
                 )
             else:
                 warnings.append(

librelane/container.py

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-## This file is internal to LibreLane 2 and is not part of the API.
+## This file is internal to LibreLane and is not part of the API.
 import os
 import re
 import uuid

librelane/env_info.py

@@ -18,7 +18,7 @@
 # environment surveys. Please ensure all code as compatible as possible
 # with ancient versions of Python.
 
-## This file is internal to LibreLane 2 and is not part of the API.
+## This file is internal to LibreLane and is not part of the API.
 import os
 import re
 import sys

librelane/flows/classic.py

@@ -30,11 +30,8 @@ from ..steps import (
 @Flow.factory.register()
 class Classic(SequentialFlow):
     """
-    **Note: While LibreLane 2 has a stable release, the default flow is in beta
-    pending silicon validation. Use at your own risk.**
-
     A flow of type :class:`librelane.flows.SequentialFlow` that is the most
-    similar to the original LibreLane 1.0 flow, running the Verilog RTL through
+    similar to the original OpenLane flow, running the Verilog RTL through
     Yosys, OpenROAD, KLayout and Magic to produce a valid GDSII for simpler designs.
 
     This is the default when using LibreLane via the command-line.

librelane/flows/optimizing.py

@@ -23,7 +23,7 @@ from ..steps import Step, Yosys, OpenROAD, StepError
 from ..logging import get_log_level, set_log_level, LogLevels, success, info
 
 
-#   "Optimizing" is a custom demo flow to show what's possible with non-sequential Flows in LibreLane 2+.
+#   "Optimizing" is a custom demo flow to show what's possible with non-sequential Flows in LibreLan
 #   It works across two steps:
 #   * The Synthesis Exploration - tries multiple synthesis strategies in *parallel*.
 #       The best-performing strategy in terms of minimizing the area makes it to the next stage.

librelane/scripts/odbpy/ioplace_parser/__init__.py

@@ -0,0 +1,23 @@
+# Copyright 2025 The American University in Cairo
+#
+# Adapted from ioplace_parser
+#
+# Copyright 2020-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.
+"""
+This is a modified version of https://github.com/efabless/ioplace_parser that
+does NOT use Antlr4 and instead uses a custom parser that is faster and
+dependency-free.
+"""
+from .parse import Side, Order, parse

librelane/scripts/odbpy/ioplace_parser/parse.py

@@ -0,0 +1,147 @@
+# Copyright 2025 The American University in Cairo
+#
+# Adapted from ioplace_parser
+#
+# Copyright 2020-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 re
+from enum import IntEnum
+from typing import Literal, Optional, Dict, List, Union
+from decimal import Decimal
+import warnings
+
+from dataclasses import dataclass, field
+
+
+class Order(IntEnum):
+    busMajor = 0
+    bitMajor = 1
+
+
+@dataclass
+class Side:
+    min_distance: Optional[Decimal] = None
+    reverse_result: bool = False
+    pins: List[Union[str, int]] = field(default_factory=list)
+    sort_mode: Optional[Order] = Order.busMajor
+
+
+VALUE_ANNOTATIONS = ["min_distance"]
+STANDALONE_ANNOTATIONS = [
+    "bus_major",
+    "bit_major",
+]
+
+
+def parse(string: str) -> Dict[Literal["N", "E", "W", "S"], Side]:
+    """
+    Parses a pin configuration into a dictionary of the four cardinal sides.
+
+    :param string: The input configuration as a string (not a file path)
+    :returns: A dictionary where each cardinal direction points to a Side object.
+    :raises ValueError: On syntax or token recognition errors
+    """
+    sides = {}
+    current_side: Optional[Side] = None
+    global_sort_mode: Order = Order.busMajor
+    global_min_distance: Optional[Decimal] = None
+
+    string_mut = string
+
+    ws_rx = re.compile(r"^\s+")
+    annotation_rx = re.compile(r"^@\s*(\w+)(?:\s*=\s*([0-9]+(?:.[0-9]+)?))?")
+    direction_rx = re.compile(r"^#\s*([NEWS]R?|BUS_SORT)")
+    virtual_pin_rx = re.compile(r"^\$\s*([0-9]+)")
+    non_ws_rx = re.compile(r"^\S+")
+    while len(string_mut):
+        # annotation
+        if skip_match := ws_rx.search(string_mut):
+            string_mut = string_mut[skip_match.end() :]
+        elif anno_match := annotation_rx.search(string_mut):
+            annotation = anno_match[1]
+            if annotation in VALUE_ANNOTATIONS:
+                if anno_match[2] is None:
+                    raise ValueError(f"Annotation {annotation} requires a value")
+                value = anno_match[2]
+                if annotation == "min_distance":
+                    if current_side is None:
+                        global_min_distance = Decimal(value)
+                    else:
+                        current_side.min_distance = Decimal(value)
+            elif annotation in STANDALONE_ANNOTATIONS:
+                if anno_match[2] is not None:
+                    raise ValueError(
+                        f"Annotation {annotation} cannot be assigned a value"
+                    )
+                if annotation == "bus_major":
+                    if current_side is None:
+                        global_sort_mode = Order.busMajor
+                    else:
+                        current_side.sort_mode = Order.busMajor
+                elif annotation == "bit_major":
+                    if current_side is None:
+                        global_sort_mode = Order.bitMajor
+                    else:
+                        current_side.sort_mode = Order.bitMajor
+            else:
+                raise ValueError(f"Unknown annotation '{annotation}'")
+            string_mut = string_mut[anno_match.end() :]
+        elif dir_match := direction_rx.search(string_mut):
+            direction = dir_match[1]
+            if direction == "BUS_SORT":
+                warnings.warn(
+                    "Specifying bit-major using the direction token ('#BUS_SORT') is deprecated: use @bit_major."
+                )
+                global_sort_mode = Order.bitMajor
+            else:
+                current_side = Side(
+                    min_distance=global_min_distance,
+                    reverse_result=len(direction) == 2,
+                    sort_mode=global_sort_mode,
+                )
+                side: Literal["N", "E", "W", "S"] = direction[0]  # type: ignore
+                sides[side] = current_side
+            string_mut = string_mut[dir_match.end() :]
+        elif vp_match := virtual_pin_rx.search(string_mut):
+            count = int(vp_match[1])
+            if current_side is None:
+                raise ValueError(
+                    f"virtual pin declaration ${count} requires a direction to be set first"
+                )
+            current_side.pins.append(count)
+            string_mut = string_mut[vp_match.end() :]
+        elif nonws_match := non_ws_rx.match(string_mut):
+            # assume regex
+            if current_side is None:
+                raise ValueError(
+                    f"identifier/regex '{nonws_match[0]}' requires a direction to be set first"
+                )
+            current_side.pins.append(nonws_match[0])
+            string_mut = string_mut[nonws_match.end() :]
+        else:
+            raise ValueError(
+                f"Syntax Error: Unexpected character starting at {string_mut[:10]}…"
+            )
+
+    all_sides: List[Literal["N", "E", "W", "S"]] = ["N", "E", "W", "S"]
+    for side in all_sides:
+        if side in sides:
+            continue
+        sides[side] = Side(
+            min_distance=global_min_distance,
+            reverse_result=False,
+            sort_mode=global_sort_mode,
+        )
+
+    return sides

librelane/steps/__main__.py

@@ -418,7 +418,7 @@ def create_reproducible(
         * The current working directory
 
     These reproducibles are filesystem-independent, i.e. they can be run
-    on any computer that has the appropriate version of LibreLane 2 installed
+    on any computer that has the appropriate version of LibreLane installed
     (as well as the underlying utility for that specific step.)
 
     The reproducible will report an error if LibreLane is not installed and will

{librelane-2.4.0.dev0.dist-info → librelane-2.4.0.dev2.dist-info}/METADATA

@@ -1,7 +1,8 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.1
 Name: librelane
-Version: 2.4.0.dev0
+Version: 2.4.0.dev2
 Summary: An infrastructure for implementing chip design flows
+Home-page: https://github.com/librelane/librelane
 License: Apache-2.0
 Author: Mohamed Gaber
 Author-email: me@donn.website
@@ -19,8 +20,7 @@ Requires-Dist: click (>=8,<9)
 Requires-Dist: cloup (>=3.0.5,<4)
 Requires-Dist: deprecated (>=1.2.10,<2)
 Requires-Dist: httpx (>=0.22.0,<0.29)
-Requires-Dist: ioplace-parser (>=0.3.0,<0.5.0)
-Requires-Dist: klayout (>=0.29.0,<0.30.0)
+Requires-Dist: klayout (>=0.29.0,<0.31.0)
 Requires-Dist: libparse (>=0.3.1,<1)
 Requires-Dist: lxml (>=4.9.0)
 Requires-Dist: psutil (>=5.9.0)
@@ -49,8 +49,10 @@ Description-Content-Type: text/markdown
 
 LibreLane is an ASIC infrastructure library based on several components including
 OpenROAD, Yosys, Magic, Netgen, CVC, KLayout and a number of custom scripts for
-design exploration and optimization, currently developed and maintained by the
-American University in Cairo Open Hardware Lab (AUCOHL.)
+design exploration and optimization, currently developed and maintained by
+members and affiliates of the
+[American University in Cairo Open Hardware Lab](https://github.com/aucohl)
+under the stewardship of the [FOSSi Foundation](https://fossi-foundation.org).
 
 A reference flow, "Classic", performs all ASIC implementation steps from RTL all
 the way down to GDSII.
@@ -142,10 +144,27 @@ If you use LibreLane in your research, please cite the following paper.
 
 ## License and Legal Info
 
-LibreLane is a trademark of the FOSSi Foundation.
+LibreLane is a trademark of the [FOSSi Foundation](https://fossi-foundation.org).
 
+LibreLane code and binaries are available under
 [The Apache License, version 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt).
 
-LibreLane is based on OpenLane 2.0 by Efabless Corporation
-(https://github.com/efabless/openlane2) under the same license. 
+LibreLane is based on [OpenLane 2](https://github.com/efabless/openlane2)
+by Efabless Corporation:
+
+```
+Copyright 2022-2025 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.
+``` 
 

{librelane-2.4.0.dev0.dist-info → librelane-2.4.0.dev2.dist-info}/RECORD

@@ -1,5 +1,5 @@
 librelane/__init__.py,sha256=EMpoZrRmS_wsweKjhyAg52OXCK7HWQ8o8CVrYaX4ub0,1220
-librelane/__main__.py,sha256=fcJnSzIGqtQMK0jsr5o5bmdH0_i6eiInl6rUl0dZANM,14681
+librelane/__main__.py,sha256=48sW8mh1MNbG0Mf75f5LekXzerbaEASLInQSrvQqPw4,14802
 librelane/__version__.py,sha256=dbE4stCACDmIoxgKksesAkTa-_hi5dW6nPLWw9Pfq3Q,1486
 librelane/common/__init__.py,sha256=LrzxjZKJu3-i8oEYdXtV1IxkXicHtoSUNRcOGrGVGsw,1516
 librelane/common/cli.py,sha256=Ob7mDR77qX1DZ7MXBQ4EPGS3dAO0o7b4njIloOxoB-Q,2351
@@ -18,14 +18,14 @@ librelane/common/tpe.py,sha256=Txj0fVscXSDJTYmEKZ2ESFHOeqrhHnaPPiwWBgyx4g8,1285
 librelane/common/types.py,sha256=oclAQkeluz_iopI_28clHzxvac7gN5moT8Rzipy5mgM,3468
 librelane/config/__init__.py,sha256=lbJmD5CbrrrnaNdIUWqFIK488ea0uyej3iExh-9mkgE,1107
 librelane/config/__main__.py,sha256=6KSXxM4qNE2yJhizUsF1kdMsY1kY7hLHoPoz50POsS8,4532
-librelane/config/config.py,sha256=79wDEleGg7Q6dRvbDiOcwN7b3usKUw0xBH3vQDblPHE,34974
+librelane/config/config.py,sha256=WUznKnVYLn7ZNbUL4YMkMX7akmyc2S26ksQSicKeN1c,34964
 librelane/config/flow.py,sha256=qCGaUOj12j57gORzoE10m7_WG-n600llnFDMlZagUF4,16660
 librelane/config/pdk_compat.py,sha256=rznq5xIny9M0PmddhPOGtCIrSdv98ysAoYgkpyM0gUA,8450
 librelane/config/preprocessor.py,sha256=I239Y01dC2o5eb1UtcSbLdybVrZgqGyDr7ecT234I4Y,14913
 librelane/config/removals.py,sha256=lJ0xpkCqnZAdA_ug4yq0NDjRBFuw4XsdORwymbEVGyQ,2907
 librelane/config/variable.py,sha256=NbR4h1Y8h4pFr6ZLUPVTUzpWB9nmlgbD-zb1Z2Ct-ww,26057
-librelane/container.py,sha256=nM3sZPlfuUdROn2kInv99bTKpeT9MMQvl4oGteAsmEU,7556
-librelane/env_info.py,sha256=p2IyhEILUgcM-zeZaWNHvOya7KPc8_WexVLhhGLoKzM,10462
+librelane/container.py,sha256=3KHxs3dUSVUZVYsS6fsA7dD3Q4QEQEzRxgXZZh9dzi0,7554
+librelane/env_info.py,sha256=vAE9AZ_vDFLt7Srtg4ZywPzE6vgVhCrIvg8PP25-BJ8,10460
 librelane/examples/spm/config.yaml,sha256=YKBm0lsY3AJZNcxAh1sQ1QMmJeVCpOpil6dw_RgQh4c,633
 librelane/examples/spm/pin_order.cfg,sha256=-8mTGFKnES0vhQATfaE2TXN_mdCZ3SZIN90Src1l6fY,52
 librelane/examples/spm/src/impl.sdc,sha256=wP18UoVlOJ9q4lmUoa3XpgcpPdyzEqHBNxCgOOU7QH0,2961
@@ -41,11 +41,11 @@ librelane/examples/spm-user_project_wrapper/template.def,sha256=7kl9l-oh4BDKuFHh
 librelane/examples/spm-user_project_wrapper/user_project_wrapper.v,sha256=zc6GC583muuWtzw3p6v_B1k8j-Oo9WypuQf_8doA4uo,3364
 librelane/flows/__init__.py,sha256=ghtmUG-taVpHJ3CKJRYZGn3dU0r93araT1EIGlBEsxg,896
 librelane/flows/builtins.py,sha256=tR14Qc1ZUey2w-Ar4DWOvxuP7LGPtMecCJq8WgcYJpk,773
-librelane/flows/classic.py,sha256=MTyAJz5SVJq4S2NAHYbUjLxv0w3wPx1GD5HrkMoTh7w,11082
+librelane/flows/classic.py,sha256=fI-LNhrvi7lzfsHRyJv_yjgFbpbWBVxN-9QpsgDxpTQ,10940
 librelane/flows/cli.py,sha256=P2LCFn5_RQ88yB0WuetpLAuWeKQXd-DrpCOMgnVh9Mg,16705
 librelane/flows/flow.py,sha256=wyYw-w6NIbCCfyfgwiq3BpztLlvZkRFUUeePoI9DpaU,34167
 librelane/flows/misc.py,sha256=32Om3isexesfKKiJZCajNmINc-xdv7eVx_tgoh9SR6U,2015
-librelane/flows/optimizing.py,sha256=oBzXOiZqOnLTaGi3YTs1cU72EKKO36dCCK-czkpywKU,6081
+librelane/flows/optimizing.py,sha256=OwZz6WGmXpliwO8vtmhjKHD-kzDyNv-zoCECZIigXsI,6076
 librelane/flows/sequential.py,sha256=DLzgvHKq0cO-U-eLO98zIFRnhGLfRv80_ozSX973TlI,13350
 librelane/flows/synth_explore.py,sha256=8mpeuG6oxeEXVQi4NwS4I415eCu7Ak6DN4oK30h1eCQ,7418
 librelane/logging/__init__.py,sha256=mrTnzjpH6AOu2CiDZYfOMCVByAS2Xeg9HS4FJyXsJOE,1043
@@ -88,6 +88,8 @@ librelane/scripts/odbpy/disconnected_pins.py,sha256=hS_Iletg7N6K6yN_ccvWxZ3nWNZp
 librelane/scripts/odbpy/exception_codes.py,sha256=VXReNio2d9uxU4cXL1PpRxWhhK2_OSs5DeCpVqTDYJE,648
 librelane/scripts/odbpy/filter_unannotated.py,sha256=Gvcaj_WNr6TPiHk-36nkMu4betNHZo1g2lD3UcA9hDQ,2950
 librelane/scripts/odbpy/io_place.py,sha256=LSJIJQDLSOpENyQOg_kVTIbh1AbYLiHIXx0siduo-lg,15589
+librelane/scripts/odbpy/ioplace_parser/__init__.py,sha256=TMKTIWwGJfdSr7dJcsoisUuKlbTKJdHV6-0kB77v2P8,887
+librelane/scripts/odbpy/ioplace_parser/parse.py,sha256=LDncc8r1nDmcTCVtxqBu7xswiesVX6-snYiIKFB_kxs,5594
 librelane/scripts/odbpy/label_macro_pins.py,sha256=n3o9-_g6HkVP8k49yNnCkQJms9f_ykCE0Rye7bVFtIk,8620
 librelane/scripts/odbpy/lefutil.py,sha256=XhfWSGHdn96yZWYQAPisgJM0iuY3xw4SW7jmMTzbpZs,3064
 librelane/scripts/odbpy/placers.py,sha256=mgy_-GYeLDPMG41YAopMTtJyCHP6ucJRk7cJzI9PLRQ,4572
@@ -144,7 +146,7 @@ librelane/state/__main__.py,sha256=Ici4Ejg1ICUZNSYZRguC3BfEk_wFxsmE0ag0Vv8iY1I,1
 librelane/state/design_format.py,sha256=9mWBbHrhzludtv3dKB6P4UQncBVTMMtoj69kNgRvh5o,5306
 librelane/state/state.py,sha256=J05gAeSVDiF76ITuw4WJZ7WkMyG4oTjt_7kpsI3E3PE,11957
 librelane/steps/__init__.py,sha256=8jTPCsrzJWjNctKUSXOjxYqqeMQjYkAKslcIXS3GDzg,1647
-librelane/steps/__main__.py,sha256=d5tajnx3fscBrDeZsCIySxCiImO0OD6aCCtu4j1qltE,13378
+librelane/steps/__main__.py,sha256=GviXtDLISKJCufKxK3oFPOSMF1GyShZbG5RXpVCYFkk,13376
 librelane/steps/checker.py,sha256=vul1D0cT03144qKK5QAKswClKKICK7kNB4PB6xXykvc,21353
 librelane/steps/common_variables.py,sha256=qT0VeIstFsDbe8VGAyqXrXxQw69OZ08haM6u1IbdFiE,10429
 librelane/steps/cvc_rv.py,sha256=32vxFIbzSbrDtE0fXvdoQ-v3LVMrfi3r88f8Y-TKPKg,5531
@@ -160,7 +162,7 @@ librelane/steps/step.py,sha256=YkUWbxx2dOz0QR90jM5NC7neFkWO1RW5zJc0I_XxRyc,54975
 librelane/steps/tclstep.py,sha256=0PMWJ6C3dKnlQf9mA9rZntgxUBCiByE9csHcEcM1iq0,10027
 librelane/steps/verilator.py,sha256=MWx2TpLqYyea9_jSeLG9c2S5ujvYERQZRFNaMhfHxZE,7916
 librelane/steps/yosys.py,sha256=GX6rTiQG-ZhDxfB9SxrPQ9Sab3WC84p0OUtqiL1Nubk,12533
-librelane-2.4.0.dev0.dist-info/METADATA,sha256=WjPPsHVB6NankUUSViUO1KpbjVrpVHyel06ogwlr46w,5841
-librelane-2.4.0.dev0.dist-info/WHEEL,sha256=fGIA9gx4Qxk2KDKeNJCbOEwSrmLtjWCwzBz351GyrPQ,88
-librelane-2.4.0.dev0.dist-info/entry_points.txt,sha256=GTBvXykNMMFsNKiJFgtEw7P1wb_VZIqVM35EFSpyZQE,263
-librelane-2.4.0.dev0.dist-info/RECORD,,
+librelane-2.4.0.dev2.dist-info/METADATA,sha256=JlRl6zQcZGwcjn6ZgcLHZivozmfzMWx0EqDzvFvuY-g,6600
+librelane-2.4.0.dev2.dist-info/WHEEL,sha256=Nq82e9rUAnEjt98J6MlVmMCZb-t9cYE2Ir1kpBmnWfs,88
+librelane-2.4.0.dev2.dist-info/entry_points.txt,sha256=GTBvXykNMMFsNKiJFgtEw7P1wb_VZIqVM35EFSpyZQE,263
+librelane-2.4.0.dev2.dist-info/RECORD,,

{librelane-2.4.0.dev0.dist-info → librelane-2.4.0.dev2.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: poetry-core 2.1.2
+Generator: poetry-core 1.9.1
 Root-Is-Purelib: true
 Tag: py3-none-any