Merge remote-tracking branch 'origin/master' into mpl2-util

Signed-off-by: Matt Liberty <[email protected]>

Author: maliberty

.devcontainer/devcontainer.json

@@ -0,0 +1,13 @@
+// Copyright (c) 2024 Antmicro <www.antmicro.com>
+// SPDX-License-Identifier: Apache-2.0
+
+{
+  "image": "ghcr.io/the-openroad-project/openroad-flow-scripts:lxqt",
+  "forwardPorts": [6080],
+  "portsAttributes": {
+    "6080": {
+      "label": "desktop"
+    }
+  },
+  "postAttachCommand": "bash /usr/local/share/desktop-init.sh"
+}

.github/workflows/github-actions-publish-docker-images.yml

@@ -10,6 +10,8 @@ on:
       - flow/Makefile
       - docker/Dockerfile.dev
       - docker/Dockerfile.builder
+      - tools/codespace/scripts/**
+      - tools/codespace/Dockerfile-lxqt
   pull_request:
     paths:
       - etc/DependencyInstaller.sh
@@ -20,8 +22,40 @@ on:
       - flow/Makefile
       - docker/Dockerfile.dev
       - docker/Dockerfile.builder
+      - tools/codespace/scripts/**
+      - tools/codespace/Dockerfile-lxqt
 
 jobs:
+  buildCodespaceImage:
+    runs-on: ubuntu-latest
+    timeout-minutes: 600
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set environment variables
+        run: echo "IMAGE=ghcr.io/$(echo ${{ github.repository }} | tr '[:upper:]' '[:lower:]')" >> $GITHUB_ENV
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to GitHub Container Registry (GHCR)
+        if: github.event_name != 'pull_request'
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: gha
+          password: ${{ github.token }}
+
+      - name: Build and export codespaces image
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          tags: ${{ env.IMAGE }}:lxqt
+          file: tools/codespace/Dockerfile-lxqt
+          cache-from: type=registry,ref=${{ env.IMAGE }}:lxqtbuildcache
+          cache-to: type=registry,ref=${{ env.IMAGE }}:lxqtbuildcache
+
   buildDependenciesImage:
     strategy:
       fail-fast: false
@@ -30,7 +64,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Check out repository code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 1
           submodules: recursive
@@ -62,7 +96,6 @@ jobs:
           file: docker/Dockerfile.dev
           build-args: |
             fromImage=${{ matrix.os[1] }}
-            numThreads=$(nproc)
           cache-from: type=registry,ref=${{ env.IMAGE_DEPS }}:buildcache
           cache-to: type=registry,ref=${{ env.IMAGE_DEPS }}:buildcache,mode=max
 
@@ -80,7 +113,7 @@ jobs:
           tool-cache: false
 
       - name: Check out repository code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           fetch-depth: 1
           submodules: recursive
@@ -89,27 +122,11 @@ jobs:
         run: |
           echo "IMAGE=ghcr.io/$(echo ${{ github.repository }} | tr '[:upper:]' '[:lower:]')/${{ matrix.os }}" >> $GITHUB_ENV
           echo "IMAGE_DEPS=ghcr.io/$(echo ${{ github.repository }} | tr '[:upper:]' '[:lower:]')-dev/${{ matrix.os }}" >> $GITHUB_ENV
+          echo "NUM_THREADS=$(nproc)" >> $GITHUB_ENV
 
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 
-      # We don't use the build-push-action here because it hangs
-      - name: Build ORFS image
-        run: |
-          docker buildx build \
-            --load \
-            --build-arg fromImage=${{ env.IMAGE_DEPS }}:latest \
-            --build-arg numThreads=$(nproc) \
-            --cache-from type=registry,ref=${{ env.IMAGE }}:buildcache \
-            --tag ${{ env.IMAGE }}:latest \
-            --file docker/Dockerfile.builder \
-            .
-
-      - name: Test build
-        run: |
-          cmd="source ./env.sh && yosys -help && openroad -help && make -C flow ;"
-          docker run ${{ env.IMAGE }}:latest /bin/bash -c "${cmd}"
-
       - name: Login to GitHub Container Registry (GHCR)
         if: github.event_name != 'pull_request'
         uses: docker/login-action@v2
@@ -118,14 +135,15 @@ jobs:
           username: gha
           password: ${{ github.token }}
 
-      - name: Export ORFS image
-        run: |
-          docker buildx build \
-            --build-arg fromImage=${{ env.IMAGE_DEPS }}:latest \
-            --build-arg numThreads=$(nproc) \
-            --cache-from type=registry,ref=${{ env.IMAGE }}:buildcache \
-            --cache-to type=registry,ref=${{ env.IMAGE }}:buildcache,mode=max \
-            --tag ${{ env.IMAGE }}:latest \
-            --file docker/Dockerfile.builder \
-            --push \
-            .
+      - name: Build and export ORFS image
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          tags: ${{ env.IMAGE }}:latest
+          file: docker/Dockerfile.builder
+          build-args: |
+            fromImage=${{ env.IMAGE_DEPS }}
+            numThreads=${{ env.NUM_THREADS }}
+          cache-from: type=registry,ref=${{ env.IMAGE }}:buildcache
+          cache-to: type=registry,ref=${{ env.IMAGE }}:buildcache,mode=max

.gitignore

@@ -88,6 +88,9 @@ perf.data.old
 docs/main
 docs/build
 GitGuide.md
+SupportedOS.md
+index2.md
+Manpage.md
 mainREADME.md
 build
 .scala-build/

docker/Dockerfile.builder

@@ -1,27 +1,42 @@
+# syntax=docker/dockerfile:1.7-labs
+
 # Target with dependencies to build all flow tools from their sources.
 # i.e., "./build_openroad.sh --local" from inside a docker container
 # NOTE: don't use this file directly unless you know what you are doing,
 # instead use etc/DockerHelper.sh
+
 ARG fromImage=openroad/flow-ubuntu22.04-dev:latest
 
-FROM $fromImage AS openroad-builder-base
+FROM $fromImage AS orfs-base
 
-ARG numThreads=$(nproc)
-
-COPY . /OpenROAD-flow-scripts
 WORKDIR /OpenROAD-flow-scripts
+COPY --link dev_env.sh dev_env.sh
+COPY --link build_openroad.sh build_openroad.sh
 
-RUN ./build_openroad.sh --no_init --local --threads ${numThreads}
-
-FROM $fromImage AS openroad-flow-scripts-base
+FROM orfs-base AS orfs-builder-base
 
-COPY . /OpenROAD-flow-scripts
-
-RUN rm -rf /OpenROAD-flow-scripts/tools /OpenROAD-flow-scripts/.git
-
-COPY --from=openroad-builder-base /OpenROAD-flow-scripts/tools/install /OpenROAD-flow-scripts/tools/install
-
-FROM $fromImage
+COPY --link tools tools
+ARG numThreads=$(nproc)
 
-COPY --from=openroad-flow-scripts-base /OpenROAD-flow-scripts /OpenROAD-flow-scripts
-WORKDIR /OpenROAD-flow-scripts
+RUN echo "" > tools/yosys/abc/.gitcommit && \
+  ./build_openroad.sh --no_init --local --threads ${numThreads}
+
+FROM orfs-base
+
+# The order for copying the directories is based on the frequency of changes (ascending order),
+# and the layer size (descending order)
+COPY --link docker docker
+COPY --link flow/tutorials flow/tutorials
+COPY --link docs docs
+COPY --link flow/test flow/test
+COPY --link flow/platforms flow/platforms
+COPY --link flow/util flow/util
+COPY --link flow/scripts flow/scripts
+COPY --link flow/designs flow/designs
+
+COPY --link --from=orfs-builder-base /OpenROAD-flow-scripts/tools/install tools/install
+COPY --link \
+     --exclude=.git* --exclude=tools/ --exclude=docs/ --exclude=docker/ \
+     --exclude=flow/designs --exclude=flow/platforms --exclude=flow/scripts \
+     --exclude=flow/test --exclude=flow/tutorials --exclude=flow/util \
+  . ./

docs/conf.py

@@ -63,7 +63,7 @@
 source_suffix = ['.md']
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = 'index2.md'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
@@ -77,6 +77,7 @@
     'README.md',
     'docs/releases/PostAlpha2.1BranchMethodology.md',
     'main',
+    'index.md'
 ]
 
 # The name of the Pygments (syntax highlighting) style to use.
@@ -151,15 +152,55 @@ def setup(app):
     shutil.copy('../README.md', 'mainREADME.md')
     swap_prefix('mainREADME.md', '```mermaid', '```{mermaid}\n:align: center\n')   
 
+    # Grab the reference file from OR
     url = 'https://raw.githubusercontent.com/The-OpenROAD-Project/OpenROAD/master/docs/contrib/GitGuide.md'
     get_file_from_url(url, 'contrib/GitGuide.md') 
+    
+    # Temporarily using commit number, will change once OR commit merged.
+    url = 'https://raw.githubusercontent.com/The-OpenROAD-Project/OpenROAD/3563176d00daeb613eed2ccf9442137b0ae2cad3/docs/index.md'
+    get_file_from_url(url, 'SupportedOS.md')
 
     # edit OpenROAD to OpenROAD-flow-scripts for GitGuide
     with open('contrib/GitGuide.md', 'r') as f:
         content = f.read()
-
     content = content.replace('user/Build.md', '../index.md#build-or-installing-orfs-dependencies')
     content = content.replace('OpenROAD', 'OpenROAD-flow-scripts')
     content = content.replace('The-OpenROAD-flow-scripts', 'The-OpenROAD')
     with open('contrib/GitGuide.md', 'w') as f:
         f.write(content)
+
+    # Create a copy of the index.md file
+    import shutil
+    shutil.copy('index.md', 'index2.md')
+
+    # Use re to find the desired content 
+    start_pattern = '## Supported Operating Systems'
+    end_pattern = '## Code of conduct'
+    with open('SupportedOS.md', 'r') as f:
+        markdown_content = f.read()
+
+    match = re.search(f'{start_pattern}(.*?){end_pattern}', markdown_content, re.DOTALL)
+    
+    assert match is not None, 'No match found, check the OR Doc pattern on index.md'
+    extracted_content = match.group(1)
+    extracted_content = "\n#### Supported Operating Systems" + extracted_content
+    print(extracted_content)
+    
+    # Find insert position
+    with open('index2.md', 'r') as f:
+        existing_content = f.read()
+    match = re.search(r'### Setup', existing_content)
+    assert match is not None, 'Check search keyword.'
+    with open('index2.md', 'w') as f:
+        insert_position = match.end() + 1
+        before_insert = existing_content[:insert_position]
+        after_insert = existing_content[insert_position:]
+
+        # Combine the parts with the extracted content
+        updated_content = before_insert + extracted_content + after_insert
+    
+        f.write(updated_content)
+      
+    # Get Manpage file
+    url = 'https://raw.githubusercontent.com/The-OpenROAD-Project/OpenROAD/master/src/utl/README.md'
+    get_file_from_url(url, 'Manpage.md')

docs/images/configure_codespace.gif

@@ -3,7 +3,7 @@
 The OpenROAD ("Foundations and Realization of Open, Accessible Design")
 project was launched in June 2018 within the DARPA IDEA program. OpenROAD
 aims to bring down the barriers of cost, expertise and unpredictability that
-currently block designers' access to hardware implementation in advanced
+currently block designers access to hardware implementation in advanced
 technologies. The project team (Qualcomm, Arm and multiple universities and
 partners, led by UC San Diego) is developing a fully autonomous, open-source
 tool chain for digital SoC layout generation, focusing on the RTL-to-GDSII
@@ -46,33 +46,6 @@ See these [tips](user/FAQS.md#how-do-i-get-better-search-results) to help improv
 
 ### Setup
 
-#### Supported Operating Systems
-
-Note that depending on the installation method, we have varying levels of 
-support for various operating systems. 
-
-Legend:
-- `Y` for supported.
-- `-` for unsupported.
-
-| Operating System | Local Installation | Prebuilt Binaries | Docker Installation | Windows Subsystem for Linux | 
-| --- | --- | --- | --- | --- |
-| Ubuntu 20.04 | `Y` | `Y` | `Y` | `-` |  
-| Ubuntu 22.04 | `Y` | `Y` | `Y` | `-` |
-| CentOS 7     | `Y` | `-` | `Y` | `-` |
-| CentOS 8     | `Y` | `-` | `Y` | `-` |
-| Debian 10    | `Y` | `Y` | `Y` | `-` |
-| Debian 11    | `Y` | `Y` | `Y` | `-` |
-| RHEL         | `Y` | `-` | `Y` | `-` |
-| Windows 10 and above | `-` | `-` | `Y` | `Y` |
-| macOS        | `Y*` | `-` | `Y` | `-` |
-
-```{warning}
-For macOS, local compilation for the modules `par` and `mpl2` are not
-fully supported due to an upstream issue with `or-tools`. We recommend
-Docker installation wherever possible.
-```
-
 #### System Requirements
 
 To build the binaries and run `gcd` through the flow:
@@ -94,7 +67,7 @@ We support four major ways of installation:
 - [Windows Subsystem for Linux (WSL)](./user/BuildWithWSL.md)
 - [Local Installation](./user/BuildLocally.md)
 
-You may also choose use the build script to customise your build process.
+You may also choose and use the build script to customise your build process.
 See more in the next section.
 
 ##### Build Command and options
@@ -178,15 +151,19 @@ OpenROAD-flow-scripts supports Verilog to GDS for the following open platforms:
 - ASAP7
 - Nangate45 / FreePDK45
 - SKY130
+- GF180
 
 These platforms have a permissive license which allows us to
 redistribute the PDK and OpenROAD platform-specific files. The platform
 files and license(s) are located in `platforms/{platform}`.
 
 OpenROAD-flow-scripts also supports the following proprietary platforms:
 
+- GF55
 - GF12
-- TSMC65LP
+- Intel22
+- Intel16
+- TSMC65
 
 The PDKs and platform-specific files for these kits cannot be provided
 due to NDA restrictions. However, if you are able to access these

docs/images/create_codespace.gif

@@ -1,16 +1,16 @@
-root: index
+root: index2
 entries:
 
 - file: user/UserGuide.md
   title: User Guide
   entries:
+  - file: user/BuildWithPrebuilt.md
+    title: Build Using Pre-built Binaries
   - file: user/BuildWithDocker
     title: Build Using Docker
     entries:
     - file: user/DockerShell.md
       title: Docker Shell utility
-  - file: user/BuildWithPrebuilt.md
-    title: Build Using Pre-built Binaries
   - file: user/BuildLocally.md
     title: Build Locally
   - file: user/BuildWithWSL.md
@@ -22,6 +22,9 @@ entries:
   - file: user/InstructionsForAutoTuner.md
     title: AutoTuner
 
+- file: Manpage.md
+  title: Manpages
+
 - file: contrib/GettingInvolved.md
   title: Getting Involved
 
@@ -51,4 +54,4 @@ entries:
   - file: user/QoRDashboard.md
     title: Using the OpenROAD Dashboard to track and analyze QoR
   - file: user/Jenkins.md
-    title: Exploring CI Metrics with Jenkins
+    title: Exploring CI Metrics with Jenkins