librelane 2.4.0.dev0__py3-none-any.whl

librelane/common/tpe.py

@@ -0,0 +1,41 @@
+# Copyright 2024 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.
+from .misc import _get_process_limit
+
+from concurrent.futures import ThreadPoolExecutor
+
+TPE = ThreadPoolExecutor(max_workers=_get_process_limit())
+
+
+def set_tpe(tpe: ThreadPoolExecutor):
+    """
+    Allows replacing LibreLane's global ``ThreadPoolExecutor`` with a customized
+    one.
+
+    It will be used inside steps, so use different TPEs inside steps to avoid
+    a deadlock.
+
+    :param tpe: The replacement ThreadPoolExecutor
+    """
+    global TPE
+    TPE = tpe
+
+
+def get_tpe() -> ThreadPoolExecutor:
+    """
+    :returns: LibreLane's global ``ThreadPoolExecutor``. This is used to run
+        steps, so do not use them inside steps to avoid a deadlock.
+    """
+    global TPE
+    return TPE

librelane/common/types.py

@@ -0,0 +1,117 @@
+# 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 sys
+import tempfile
+from math import isfinite
+from decimal import Decimal
+from collections import UserString
+from typing import Any, Union, ClassVar, Tuple, Optional
+
+
+def is_string(obj: Any) -> bool:
+    return isinstance(obj, str) or isinstance(obj, UserString)
+
+
+Number = Union[int, float, Decimal]
+
+
+def is_number(obj: Any) -> bool:
+    return isinstance(obj, int) or isinstance(obj, float) or isinstance(obj, Decimal)
+
+
+def is_real_number(obj: Any) -> bool:
+    return is_number(obj) and isfinite(obj)
+
+
+class Path(UserString, os.PathLike):
+    """
+    A Path type for LibreLane configuration variables.
+
+    Basically just a string.
+    """
+
+    # This path will pass the validate() call, but will
+    # fail to open. It should be used for deprecated variable
+    # translation only.
+    _dummy_path: ClassVar[str] = "__librelane_dummy_path"
+
+    def __fspath__(self) -> str:
+        return str(self)
+
+    def __repr__(self) -> str:
+        return f"{self.__class__.__qualname__}('{self}')"
+
+    def exists(self) -> bool:
+        """
+        A convenience method calling :meth:`os.path.exists`
+        """
+        return os.path.exists(self)
+
+    def validate(self, message_on_err: str = ""):
+        """
+        Raises an error if the path does not exist.
+        """
+        if not self.exists() and not self == Path._dummy_path:
+            raise ValueError(f"{message_on_err}: '{self}' does not exist")
+
+    def startswith(
+        self,
+        prefix: Union[str, Tuple[str, ...], UserString, os.PathLike],
+        start: Optional[int] = 0,
+        end: Optional[int] = sys.maxsize,
+    ) -> bool:
+        if isinstance(prefix, UserString) or isinstance(prefix, os.PathLike):
+            prefix = str(prefix)
+        return super().startswith(prefix, start, end)
+
+    def rel_if_child(
+        self,
+        start: Union[str, os.PathLike] = os.getcwd(),
+        *,
+        relative_prefix: str = "",
+    ) -> "Path":
+        my_abspath = os.path.abspath(self)
+        start_abspath = os.path.abspath(start)
+        if my_abspath.startswith(start_abspath):
+            return Path(relative_prefix + os.path.relpath(self, start_abspath))
+        else:
+            return Path(my_abspath)
+
+
+AnyPath = Union[str, os.PathLike]
+
+
+class ScopedFile(Path):
+    """
+    Creates a temporary file that remains valid while this variable is in scope,
+    and is deleted upon deconstruction.
+
+    The object itself is a string pointing to that file path.
+
+    :param contents: The contents of the temporary file to create.
+    """
+
+    def __init__(self, *, contents="") -> None:
+        self._ntf = tempfile.NamedTemporaryFile(
+            "w",
+            delete=False,
+            encoding="utf8",
+        )
+        super().__init__(self._ntf.name)
+        self._ntf.write(contents)
+        self._ntf.close()
+
+    def __del__(self):
+        os.unlink(self._ntf.name)

librelane/config/__init__.py

@@ -0,0 +1,32 @@
+# 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.
+"""
+The Configuration Module
+------------------------
+
+This modules includes various functions for importing and/or generating LibreLane
+configuration objects. Configuration objects are the primary input to a flow.
+"""
+from .preprocessor import Keys
+from .variable import Instance, Macro, Variable
+from .config import (
+    Meta,
+    Config,
+    InvalidConfig,
+    AnyConfig,
+    AnyConfigs,
+    PassedDirectoryError,
+    UnknownExtensionError,
+)
+from .flow import flow_common_variables as universal_flow_config_variables

librelane/config/__main__.py

@@ -0,0 +1,158 @@
+# 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 sys
+import json
+import functools
+from decimal import Decimal
+
+import click
+
+from .config import Config
+from ..flows.flow import universal_flow_config_variables
+from ..steps.yosys import verilog_rtl_cfg_vars
+from ..flows.cli import cloup_flow_opts
+
+
+@click.group
+def cli():
+    pass
+
+
+@click.command()
+@click.option(
+    "--file-name",
+    type=click.Path(exists=False, file_okay=True, dir_okay=False),
+    default="config.json",
+    prompt="Please input the file name for the configuration file",
+    help="The file name of the configuration file.",
+)
+@click.option(
+    "--design-dir",
+    type=click.Path(exists=True, dir_okay=True, file_okay=False),
+    default=".",
+    prompt="Enter the base directory for your design",
+    help="The top-level design directory. Typically, the configuration file goes in the design directory as well.",
+)
+@click.option(
+    "--design-name",
+    "--top-module",
+    type=str,
+    prompt="Enter the design name (which should be equal to the HDL name of your top module)",
+    help="The name of the design, i.e. the name of the top-level module of the design.",
+)
+@click.option(
+    "--clock-port",
+    type=str,
+    prompt="Enter the name of your design's clock port",
+    help="The identifier for the clock port.",
+)
+@click.option(
+    "--clock-period",
+    type=Decimal,
+    prompt="Enter your desired clock period in nanoseconds",
+    help="The clock period, in nanoseconds.",
+)
+@cloup_flow_opts(
+    config_options=False,
+    run_options=False,
+    sequential_flow_controls=False,
+    jobs=False,
+    accept_config_files=False,
+)
+@click.argument(
+    "source_rtl",
+    type=click.Path(
+        exists=True,
+        dir_okay=False,
+        file_okay=True,
+    ),
+    nargs=-1,
+)
+def create_config(
+    pdk_root,
+    pdk,
+    scl,
+    file_name,
+    design_name,
+    design_dir,
+    clock_port,
+    clock_period,
+    source_rtl,
+):
+    """
+    Generates an LibreLane JSON configuration file for a design interactively.
+    """
+    if len(source_rtl) == 0:
+        source_rtl = []
+        try:
+            while True:
+                file = input(
+                    f"Input the RTL source file #{len(source_rtl)} (Ctrl+D to stop): "
+                )
+                if not os.path.isfile(file):
+                    print(f"Invalid file {file}.", file=sys.stderr)
+                    exit(1)
+                source_rtl.append(file)
+        except EOFError:
+            print("")
+            if len(source_rtl) == 0:
+                print("At least one source RTL file is required.", file=sys.stderr)
+                exit(1)
+    source_rtl_key = "VERILOG_FILES"
+    if not functools.reduce(
+        lambda acc, x: acc and (x.endswith(".sv") or x.endswith(".v")), source_rtl, True
+    ):
+        print(
+            "Only Verilog/SystemVerilog files are supported by create-config.",
+            file=sys.stderr,
+        )
+        exit(-1)
+    source_rtl_rel = [f"dir::{os.path.relpath(x, design_dir)}" for x in source_rtl]
+    config_dict = {
+        "DESIGN_NAME": design_name,
+        "CLOCK_PORT": clock_port,
+        "CLOCK_PERIOD": clock_period,
+        source_rtl_key: source_rtl_rel,
+        "meta": {
+            "version": 2,
+        },
+    }
+    config, _ = Config.load(
+        config_dict,
+        universal_flow_config_variables + verilog_rtl_cfg_vars,
+        design_dir=design_dir,
+        pdk=pdk,
+        pdk_root=pdk_root,
+        scl=scl,
+    )
+    with open(file_name, "w") as f:
+        print(
+            json.dumps(config_dict, cls=config.get_encoder(), indent=4),
+            file=f,
+        )
+
+    design_dir_opt = ""
+    if os.path.abspath(design_dir) != os.path.abspath(os.path.dirname(file_name)):
+        design_dir_opt = f"--design-dir {design_dir} "
+
+    print(f"Wrote config to '{file_name}'.")
+    print("To run this design, invoke:")
+    print(f"\tlibrelane {design_dir_opt}{file_name}")
+
+
+cli.add_command(create_config)
+
+if __name__ == "__main__":
+    cli()