Added system_rdl rules (#4)

Author: abrisco

.github/workflows/compile-requirements.yaml

@@ -9,7 +9,7 @@ on:
     inputs:
       target:
         description: "The py_reqs_compiler target to run"
-        default: "//python/3rdparty:requirements.update"
+        default: "//tools/requirements:update"
 
 jobs:
   build:
@@ -19,8 +19,6 @@ jobs:
         include:
           - os: linux_x86_64
             runs-on: ubuntu-latest
-          - os: linux_aarch64
-            runs-on: ubuntu-24.04-arm
           - os: macos_aarch64
             runs-on: macos-latest
           - os: windows_x86_64
@@ -49,7 +47,7 @@ jobs:
           echo "<details>" >> "${GITHUB_STEP_SUMMARY}"
           echo "" >> "${GITHUB_STEP_SUMMARY}"
           echo '```' >> "${GITHUB_STEP_SUMMARY}"
-          cat "python/3rdparty/requirements_${{ matrix.os }}.txt" >> "${GITHUB_STEP_SUMMARY}"
+          cat "tools/requirements/requirements_${{ matrix.os }}.txt" >> "${GITHUB_STEP_SUMMARY}"
           echo '```' >> "${GITHUB_STEP_SUMMARY}"
           echo "" >> "${GITHUB_STEP_SUMMARY}"
           echo "</details>" >> "${GITHUB_STEP_SUMMARY}"

MODULE.bazel

@@ -9,12 +9,53 @@ bazel_dep(name = "bazel_skylib", version = "1.8.2")
 bazel_dep(name = "platforms", version = "1.0.0")
 bazel_dep(name = "rules_cc", version = "0.2.4")
 bazel_dep(name = "verilator", version = "5.036.bcr.1")
+bazel_dep(name = "rules_venv", version = "0.7.1")
 
 register_toolchains(
     "//verilator/toolchain",
+    "//system_rdl/toolchain",
     dev_dependency = True,
 )
 
 bazel_dep(name = "stardoc", version = "0.8.0", dev_dependency = True, repo_name = "io_bazel_stardoc")
 bazel_dep(name = "rules_rust_mdbook", version = "0.65.0", dev_dependency = True)
-bazel_dep(name = "rules_shell", version = "0.5.1", dev_dependency = True)
+bazel_dep(name = "rules_shell", version = "0.6.1", dev_dependency = True)
+bazel_dep(name = "rules_req_compile", version = "1.0.0rc41", dev_dependency = True)
+
+python = use_extension("@rules_venv//python/extensions:python.bzl", "python", dev_dependency = True)
+python.toolchain(
+    configure_coverage_tool = True,
+    # Working around a rules_python issue with docker
+    # https://github.com/bazelbuild/rules_python/pull/713
+    ignore_root_user_error = True,
+    is_default = True,
+    python_version = "3.11",
+)
+use_repo(
+    python,
+    "python_3_11_aarch64-apple-darwin",
+    "python_3_11_aarch64-unknown-linux-gnu",
+    "python_3_11_x86_64-apple-darwin",
+    "python_3_11_x86_64-pc-windows-msvc",
+    "python_3_11_x86_64-unknown-linux-gnu",
+    python311 = "python_3_11",
+)
+
+requirements = use_extension("@rules_req_compile//extensions:python.bzl", "requirements", dev_dependency = True)
+requirements.parse(
+    name = "pip_deps",
+    requirements_locks = {
+        "//tools/requirements:requirements_linux_x86_64.txt": "//tools/requirements:linux_x86_64",
+        "//tools/requirements:requirements_macos_aarch64.txt": "//tools/requirements:macos_aarch64",
+        "//tools/requirements:requirements_windows_x86_64.txt": "//tools/requirements:windows_x86_64",
+    },
+)
+use_repo(requirements, "pip_deps")
+
+register_toolchains(
+    "//tools/toolchains:black_toolchain",
+    "//tools/toolchains:isort_toolchain",
+    "//tools/toolchains:mypy_toolchain",
+    "//tools/toolchains:pylint_toolchain",
+    dev_dependency = True,
+)

MODULE.bazel.lock

@@ -2,6 +2,15 @@ load("@io_bazel_stardoc//stardoc:stardoc.bzl", "stardoc")
 load("@rules_rust_mdbook//:defs.bzl", "mdbook", "mdbook_server")
 load("@rules_shell//shell:sh_binary.bzl", "sh_binary")
 
+stardoc(
+    name = "system_rdl",
+    out = "src/system_rdl.md",
+    input = "//system_rdl:defs.bzl",
+    table_of_contents_template = "@io_bazel_stardoc//stardoc:templates/markdown_tables/table_of_contents.vm",
+    tags = ["manual"],
+    deps = ["//system_rdl:defs_bzl"],
+)
+
 stardoc(
     name = "verilator",
     out = "src/verilator.md",
@@ -23,6 +32,7 @@ stardoc(
 mdbook(
     name = "book",
     srcs = glob(["src/**/*.md"]) + [
+        ":system_rdl",
         ":verilator",
         ":verilog",
     ],

docs/BUILD.bazel

@@ -4,3 +4,4 @@
 
 - [verilog](./verilog.md)
 - [verilator](./verilator.md)
+- [system_rdl](./system_rdl.md)

docs/src/SUMMARY.md

@@ -0,0 +1,27 @@
+load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
+
+exports_files(
+    [
+        "defs.bzl",
+        "requirements.in",
+        "system_rdl_info.bzl",
+        "system_rdl_library.bzl",
+        "system_rdl_toolchain.bzl",
+        "verilog_system_rdl_library.bzl",
+    ],
+)
+
+toolchain_type(
+    name = "toolchain_type",
+    visibility = ["//visibility:public"],
+)
+
+bzl_library(
+    name = "defs_bzl",
+    srcs = glob(["*.bzl"]),
+    visibility = ["//visibility:public"],
+    deps = [
+        "//system_rdl/private:bzl_lib",
+        "//verilog:verilog_info_bzl",
+    ],
+)

system_rdl/BUILD.bazel

@@ -0,0 +1,37 @@
+"""# SystemRDL rules.
+
+Bazel rules for [SystemRDL](https://peakrdl.readthedocs.io/en/latest/systemrdl-tutorial.html)
+
+## Setup
+
+```python
+bazel_dep(name = "rules_verilog", version = "{version}")
+
+register_toolchain(
+    # Define a custom toolchain or use the `rules_verilog` provided toolchain.
+    "@rules_verilog//system_rdl/toolchain",
+)
+```
+"""
+
+load(
+    ":system_rdl_info.bzl",
+    _SystemRdlInfo = "SystemRdlInfo",
+)
+load(
+    ":system_rdl_library.bzl",
+    _system_rdl_library = "system_rdl_library",
+)
+load(
+    ":system_rdl_toolchain.bzl",
+    _system_rdl_toolchain = "system_rdl_toolchain",
+)
+load(
+    ":verilog_system_rdl_library.bzl",
+    _verilog_system_rdl_library = "verilog_system_rdl_library",
+)
+
+SystemRdlInfo = _SystemRdlInfo
+system_rdl_library = _system_rdl_library
+system_rdl_toolchain = _system_rdl_toolchain
+verilog_system_rdl_library = _verilog_system_rdl_library

system_rdl/defs.bzl

@@ -0,0 +1,27 @@
+load("@bazel_skylib//:bzl_library.bzl", "bzl_library")
+load("@rules_venv//python:py_binary.bzl", "py_binary")
+load(":system_rdl.bzl", "current_system_rdl_peakrdl_toolchain")
+
+current_system_rdl_peakrdl_toolchain(
+    name = "current_system_rdl_peakrdl_toolchain",
+)
+
+py_binary(
+    name = "peakrdl",
+    srcs = [
+        "peakrdl.py",
+    ],
+    main = "peakrdl.py",
+    deps = [
+        ":current_system_rdl_peakrdl_toolchain",
+    ],
+)
+
+bzl_library(
+    name = "bzl_lib",
+    srcs = glob(["*.bzl"]),
+    visibility = ["//system_rdl:__pkg__"],
+    deps = [
+        "@rules_venv//python:defs_bzl",
+    ],
+)

system_rdl/private/BUILD.bazel

@@ -0,0 +1,6 @@
+"""The PeakRDL Bazel entrypoint for use in system_rdl rules."""
+
+from peakrdl.main import main as peakrdl_main
+
+if __name__ == "__main__":
+    peakrdl_main()