misc: maintain openlane

This PR migrates OpenLane away from Efabless infrastructure so old designs taped-out using OpenLane may be taped out again in the future.

A message clarifying the maintenance status of OpenLane has been added. Ciel has been replaced with Volare. The CI has been updated appropriately, and the repository now uses the GitHub Container Repository.)

All Python files have been re-linted using more modern tools.

This commit has no effect on the logical operation of OpenLane.

Author: donn

.flake8

@@ -1,5 +1,5 @@
 [flake8]
-ignore = E203,E266,E302,E501,W503
+ignore = E203,E266,E302,E501,W503,F824
 exclude =
     .git,
     __pycache__,
@@ -8,4 +8,7 @@ exclude =
     install/,
     venv/,
     pdks/,
-    dependencies/includedyaml
+    dependencies/includedyaml
+per-file-ignores =
+    dependencies/env_info.py:F401,
+    dependencies/version.py:F401

.github/actions/docker_build/action.yml

@@ -16,11 +16,11 @@ inputs:
   tool_repository:
     description: The Docker repository in which to store tools
     required: false
-    default: "efabless/openlane-tools"
+    default: "ghcr.io/the-openroad-project/openlane-tools"
 runs:
   using: "composite"
   steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - uses: docker/setup-buildx-action@v2
     - uses: ./.github/actions/set_env_variables
 
@@ -37,9 +37,6 @@ runs:
         username: ${{ inputs.dockerhub_user }}
         password: ${{ inputs.dockerhub_password }}
 
-    - name: Set up QEMU
-      uses: docker/setup-qemu-action@v1
-
     - name: Docker Build
       shell: bash
       run: |

.github/scripts/update_tools.py

@@ -32,6 +32,7 @@
 
 tools = Tool.from_metadata_yaml(open(metadata_path).read())
 
+
 # Handle Multiline Strings Properly / https://stackoverflow.com/a/33300001
 def represent_str(dumper: yaml.Dumper, data: str):
     if "\n" in data:

.github/workflows/lint.yml

@@ -10,10 +10,10 @@ on:
 jobs:
   lint_python:
     name: Lint Python Code
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     steps:
       - name: Check out Git repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Install Linters
         run: python3 -m pip install -r ./requirements_lint.txt
       - name: Ensure Black Formatting

.github/workflows/openlane_ci.yml

@@ -14,7 +14,7 @@ on:
 jobs:
   pdk_build:
     name: Fetch or Build PDK
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       matrix:
         pdk: [sky130A, gf180mcuC]
@@ -24,13 +24,6 @@ jobs:
       - name: Set up environment variables
         uses: ./.github/actions/set_env_variables
 
-      - name: Get Volare Build/Push Dependencies
-        run: |
-          # Magic Build Dependencies
-          sudo apt-get install -y tcsh tcl-dev tk-dev libcairo2-dev m4
-          # GHR (Pushing)
-          go install github.com/tcnksm/ghr@latest
-
       - name: Build (or Get) PDK
         run: |
           export PATH=$PATH:$(go env GOPATH)/bin
@@ -41,11 +34,11 @@ jobs:
           sudo mkdir -p ${{ env.PDK_ROOT }}
           sudo chown -R $USER:$USER ${{ env.PDK_ROOT }}
 
-          python3 -m pip install --upgrade --no-cache-dir volare
+          python3 -m pip install --upgrade --no-cache-dir 'ciel>=2.0.1,<3'
           export OPDKS_VER="$(python3 ./dependencies/tool.py open_pdks -f commit)"
-          volare enable\
+          ciel enable\
             --pdk $PDK_FAMILY\
-            --token ${{ secrets.MY_TOKEN }}\
+            --token ${{ secrets.GITHUB_TOKEN }}\
             $OPDKS_VER
 
       - name: Tarball PDK
@@ -59,7 +52,7 @@ jobs:
           path: /tmp/${{ matrix.pdk }}.tar
   prepare_test_matrices:
     name: Prepare Test Matrices
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     outputs:
       design_matrix: ${{ steps.set-matrix.outputs.design_matrix }}
       issue_regression_matrix: ${{ steps.set-matrix.outputs.issue_regression_matrix }}
@@ -86,32 +79,32 @@ jobs:
 
   docker_build_amd64:
     name: Docker Build (amd64)
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
+    permissions:
+      packages: write
     steps:
       - uses: actions/checkout@v4
       - name: Build
         uses: ./.github/actions/docker_build
         with:
           arch: amd64
-          dockerhub_user: ${{ secrets.DOCKERHUB_USER }}
-          dockerhub_password: ${{ secrets.DOCKERHUB_PASSWORD }}
           tool_repository: ${{ vars.TOOL_DOCKER_IMAGE }}
   docker_build_arm64v8:
     name: Docker Build (arm64v8)
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04-arm
+    permissions:
+      packages: write
     steps:
       - uses: actions/checkout@v4
       - name: Build
         uses: ./.github/actions/docker_build
         with:
           arch: arm64v8
-          dockerhub_user: ${{ secrets.DOCKERHUB_USER }}
-          dockerhub_password: ${{ secrets.DOCKERHUB_PASSWORD }}
           tool_repository: ${{ vars.TOOL_DOCKER_IMAGE }}
   issue_regression_test:
     name: Regression Test (Test ${{ matrix.test }})
     needs: [docker_build_amd64, pdk_build, prepare_test_matrices]
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
       matrix: ${{ fromJSON(needs.prepare_test_matrices.outputs.issue_regression_matrix) }}
@@ -159,7 +152,7 @@ jobs:
   test:
     name: Test Design ${{ matrix.design.name }} (${{ matrix.design.pdk }}/${{matrix.design.scl}})
     needs: [docker_build_amd64, pdk_build, prepare_test_matrices]
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     strategy:
       fail-fast: false
       matrix: ${{ fromJSON(needs.prepare_test_matrices.outputs.design_matrix) }}
@@ -226,14 +219,16 @@ jobs:
     needs:
       [docker_build_amd64, docker_build_arm64v8, test, issue_regression_test]
     if: always()
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
+    permissions:
+      packages: write
     steps:
       - name: Check If Going To Push An Image To Docker
         # # Uncomment the next line if you want to only build & push a container if entire test set succeeds
         # if: needs.test.result == 'success'
         # Ruby snippet to print 0 if this is a PR or if there is no DOCKERHUB_USER secret set, otherwise, 1
         run: |
-          export PUSHING=$(ruby -e 'if ("${{ github.event_name }}" != "pull_request" && "${{ secrets.DOCKERHUB_USER }}" != ""); print(1) else print(0) end')
+          export PUSHING=$(ruby -e 'if ("${{ github.event_name }}" != "pull_request"); print(1) else print(0) end')
           echo "PUSHING=$PUSHING" >> $GITHUB_ENV
 
       - uses: actions/checkout@v4
@@ -290,14 +285,7 @@ jobs:
         uses: tvdias/[email protected]
         with:
           tag: "${{ env.NEW_TAG }}"
-          repo-token: "${{ secrets.MY_TOKEN }}"
-
-      - name: Login to DockerHub
-        if: ${{ env.PUSHING == '1' }}
-        uses: docker/login-action@v1
-        with:
-          username: ${{ secrets.DOCKERHUB_USER }}
-          password: ${{ secrets.DOCKERHUB_PASSWORD }}
+          repo-token: "${{ secrets.BOT_TOKEN }}"
 
       - name: Start Tag List
         if: ${{ env.PUSHING == '1' }}

.github/workflows/tool_updater.yml

@@ -10,10 +10,10 @@ on:
 jobs:
   check_variables:
     name: Check Variables
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     steps:
       - name: Check out Git repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Install Ripgrep
         run: sudo apt install -y ripgrep
       - name: Check for missing documentation

.github/workflows/variables_documentation_check.yml

@@ -57,7 +57,7 @@ PRINT_REM_DESIGNS_TIME ?= 0
 SKYWATER_COMMIT ?= $(shell $(PYTHON_BIN) ./dependencies/tool.py sky130 -f commit)
 OPEN_PDKS_COMMIT ?= $(shell $(PYTHON_BIN) ./dependencies/tool.py open_pdks -f commit)
 
-export PDK_ROOT ?= $(HOME)/.volare
+export PDK_ROOT ?= $(HOME)/.ciel
 export PDK_ROOT := $(shell $(PYTHON_BIN) -c "import os; print(os.path.realpath('$(PDK_ROOT)'), end='')")
 PDK_OPTS = -v $(PDK_ROOT):$(PDK_ROOT) -e PDK_ROOT=$(PDK_ROOT)
 
@@ -124,8 +124,8 @@ mount:
 
 .PHONY: pdk
 pdk: venv/created
-	PYTHONPATH= ./venv/bin/$(PYTHON_BIN) -m pip install --upgrade --no-cache-dir volare
-	./venv/bin/volare enable --pdk $(PDK_FAMILY)
+	PYTHONPATH= ./venv/bin/$(PYTHON_BIN) -m pip install --upgrade --no-cache-dir ciel
+	./venv/bin/ciel enable --pdk $(PDK_FAMILY)
 
 .PHONY: survey
 survey:

Makefile

@@ -1,20 +1,28 @@
+<h3 align="center"> OpenLane is currently in maintenance mode.</h3>
+
+The versions of OpenLane currently being offered and supported are currently
+versions 1.0.X, as they were used for countless tape outs for the Google MPW and
+Efabless chipIgnite shuttles. Only critical bugfixes will be merged at this
+point. The intent is that tape-outs on older shuttles may be reproduced.
+
+<p align="center">
+    <a href="https://github.com/librelane/librelane"><img src="./docs/_static/librelane_banner.svg" width="50%" alt="LibreLane: Meet the successor to OpenLane — community-driven and rewritten from scratch with a modular architecture. Configure your designs using one file just like OpenLane, or use Python to implement advanced flows."></a>
+</p>
+
+---
+
 <h1 align="center">OpenLane</h1>
 <p align="center">
-    <a href="https://colab.research.google.com/github/chipsalliance/silicon-notebooks/blob/main/digital-inverter-openlane.ipynb"><img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open in Colab"></a>
     <a href="https://opensource.org/licenses/Apache-2.0"><img src="https://img.shields.io/badge/License-Apache%202.0-blue.svg" alt="License: Apache 2.0"/></a>
-    <img src="https://github.com/efabless/volare/actions/workflows/ci.yml/badge.svg?branch=main" alt="GitHub Actions Status Badge" />
+    <img src="https://github.com/The-OpenROAD-Project/OpenLane/actions/workflows/openlane_ci.yml/badge.svg?branch=superstable" alt="GitHub Actions Status Badge" />
     <a href="https://openlane.readthedocs.io/"><img src="https://readthedocs.org/projects/openlane/badge/?version=latest" alt="Documentation Build Status Badge"/></a>
-    <a href="https://invite.skywater.tools"><img src="https://img.shields.io/badge/Community-Open%20Source%20Silicon%20Slack-ff69b4?logo=slack" alt="Invite to the Open Source Silicon Slack"/></a>
-    <a href="https://github.com/psf/black"><img src="https://img.shields.io/badge/python%20code%20style-black-000000.svg" alt="Python Code Style: black"/></a>
+    <a href="https://matrix.to/#/#openlane:fossi-chat.org"><img src="https://img.shields.io/badge/Community-FOSSi%20Chat-1bb378?logo=element" alt="Invite to FOSSi Chat"/></a>
 </p>
 
 OpenLane is an automated RTL to GDSII flow based on several components including OpenROAD, Yosys, Magic, Netgen, CVC, SPEF-Extractor, KLayout and a number of custom scripts for design exploration and optimization. The flow performs all ASIC implementation steps from RTL all the way down to GDSII.
 
 You can check out the documentation, including in-depth guides and reference manuals at [ReadTheDocs](https://openlane.readthedocs.io/).
 
-## Quick-start Guide
-If you just want to try OpenLane out, try [this Colaboratory](https://colab.research.google.com/github/chipsalliance/silicon-notebooks/blob/main/digital-inverter-openlane.ipynb) by our friends at Google and ChipsAlliance. It's an online Python-based utility, and the best part is, *you don't need to install anything.*
-
 ## Installation, the short version
 The short version is, to install the OpenLane environment...
 
@@ -43,7 +51,7 @@ make test
 If everything's gone smoothly, that's it. OpenLane is set up on your computer. To enter the OpenLane environment, `cd $HOME/OpenLane` and then `make mount`.
 
 ## Installation, the long version
-See the installation docs at https://openlane.readthedocs.io/en/latest/getting_started/installation/index.html.
+See the installation docs at https://openlane.readthedocs.io/en/superstable/getting_started/installation/index.html.
 
 ## Usage
 After entering the OpenLane environment, you can start hardening chips: the following command, for example, runs the included [spm design](./designs/spm).
@@ -52,9 +60,6 @@ After entering the OpenLane environment, you can start hardening chips: the foll
 ./flow.tcl -design spm
 ```
 
-## Need more help?
-You can join the [Open Source Silicon Slack](https://invite.skywater.tools), where you can ask thousands of other open source hardware enthusiasts for help with setting up or running OpenLane.
-
 ## Publication
 If you use OpenLane in your research, please cite the following paper.
 
@@ -73,10 +78,16 @@ If you use OpenLane in your research, please cite the following paper.
 ```
 
 
-## License
-[The Apache License, version 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt).
+## Legal Stuff
 
-Docker images distributed by Efabless Corporation under the same license.
+OpenLane is ©2020-2024 Efabless Corporation and is available under
+[the Apache License, version 2.0](https://www.apache.org/licenses/LICENSE-2.0.txt).
 
-Binaries in OpenLane distributions may fall under stricter open source licenses.
+Newer container images (downloaded from
+`ghcr.io/the-openroad-project/openlane`) are distributed by Somnium Consulting
+LLC under the same license.
 
+Older container images (downloaded from `docker.io/efabless/openlane`) were
+distributed by Efabless Corporation under the same license.
+
+Binaries in OpenLane distributions may fall under stricter open source licenses.

README.md

@@ -4,6 +4,6 @@ __DIRNAME__ := $(dir $(abspath $(lastword $(MAKEFILE_LIST))))
 ifeq ($(OPENLANE_IMAGE_NAME),)
 OPENLANE_DOCKER_TAG ?= $(shell $(PYTHON_BIN) $(__DIRNAME__)/get_tag.py)
 ifneq ($(OPENLANE_DOCKER_TAG),)
-export OPENLANE_IMAGE_NAME ?= efabless/openlane:$(OPENLANE_DOCKER_TAG)
+export OPENLANE_IMAGE_NAME ?= ghcr.io/the-openroad-project/openlane:$(OPENLANE_DOCKER_TAG)
 endif
 endif