resolve conflicts with master

Author: soheilshahrouz

.github/scripts/install_noble_dependencies.sh

@@ -0,0 +1,67 @@
+#!/usr/bin/env bash
+
+sudo apt update
+
+sudo apt install -y \
+  autoconf \
+  automake \
+  bash \
+  bison \
+  binutils \
+  binutils-gold \
+  build-essential \
+  capnproto \
+  exuberant-ctags \
+  curl \
+  doxygen \
+  flex \
+  fontconfig \
+  gdb \
+  git \
+  gperf \
+  libcairo2-dev \
+  libcapnp-dev \
+  libgtk-3-dev \
+  libevent-dev \
+  libfontconfig1-dev \
+  liblist-moreutils-perl \
+  libncurses5-dev \
+  libx11-dev \
+  libxft-dev \
+  libxml2-utils \
+  libxml++2.6-dev \
+  libreadline-dev \
+  tcllib \
+  tcl8.6-dev \
+  libffi-dev \
+  perl \
+  pkg-config \
+  texinfo \
+  time \
+  valgrind \
+  zip \
+  qtbase5-dev \
+  uuid-dev \
+  default-jdk \
+  g++-9 \
+  gcc-9 \
+  g++-10 \
+  gcc-10 \
+  g++-11 \
+  gcc-11 \
+  g++-12 \
+  gcc-12 \
+  g++-13 \
+  gcc-13 \
+  clang-14 \
+  clang-18 \
+  clang-format-14 \
+  libtbb-dev
+
+pip install -r requirements.txt
+
+git clone https://github.com/capnproto/capnproto-java.git $GITHUB_WORKSPACE/env/capnproto-java
+pushd $GITHUB_WORKSPACE/env/capnproto-java
+make
+sudo make install
+popd

.github/workflows/containers.yml

@@ -1,12 +1,34 @@
 name: Containers
 
 on:
+  # We want to run the CI when anything is pushed to master.
+  # Since master is a protected branch this only happens when a PR is merged.
+  # This is a double check in case the PR was stale and had some issues.
   push:
+    branches:
+      - master
+    paths-ignore: # Prevents from running if only docs are updated
+      - 'doc/**'
+      - '**/*README*'
+      - '**.md'
+      - '**.rst'
   pull_request:
+    paths-ignore: # Prevents from running if only docs are updated
+      - 'doc/**'
+      - '**/*README*'
+      - '**.md'
+      - '**.rst'
   workflow_dispatch:
   schedule:
   - cron: '0 0 * * 0' # weekly
 
+# We want to cancel previous runs for a given PR or branch / ref if another CI
+# run is requested.
+# See: https://docs.github.com/en/actions/using-jobs/using-concurrency
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 jobs:
 
   Image:
@@ -24,7 +46,7 @@ jobs:
         id: generate
         run: |
           REPO='${{ github.repository }}'
-          echo "::set-output name=image::ghcr.io/${REPO,,}/ubuntu/focal/build"
+          echo "image=ghcr.io/${REPO,,}/ubuntu/focal/build" >> $GITHUB_OUTPUT
 
       - name: ⛴️ Build container image
         run: docker build -t ${{ steps.generate.outputs.image }} -f Dockerfile .

.github/workflows/noble.yml

@@ -0,0 +1,51 @@
+# This workflow is designed to test that VTR can run on Ubuntu 24.04. Since
+# the Ubuntu 24.04 GitHub runners are still in Beta, this is left as a workflow
+# that must be dispatched manually. In the future this workflow should be
+# removed and made the default (integrated into test.yml).
+name: Noble
+
+on:
+  workflow_dispatch:
+  schedule:
+  - cron: '0 0 * * *' # daily
+
+# We want to cancel previous runs for a given PR or branch / ref if another CI
+# run is requested.
+# See: https://docs.github.com/en/actions/using-jobs/using-concurrency
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+env:
+  MATRIX_EVAL: "CC=gcc-13 && CXX=g++-13"
+
+jobs:
+  FutureCompatibility:
+    runs-on: ubuntu-24.04
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - { name: 'GCC 13 (Ubuntu Noble - 24.04)',    eval: 'CC=gcc-13 && CXX=g++-13',         }
+        - { name: 'Clang 18 (Ubuntu Noble - 24.04)',  eval: 'CC=clang-18 && CXX=clang++-18',   }
+    name: 'B: ${{ matrix.name }}'
+    steps:
+    - uses: actions/setup-python@v5
+      with:
+        python-version: 3.12.3
+    - uses: actions/checkout@v4
+      with:
+        submodules: 'true'
+    - run: ./.github/scripts/install_noble_dependencies.sh
+
+    - uses: hendrikmuhs/[email protected]
+
+    - name: Test
+      env:
+        CMAKE_PARAMS: "-DVTR_ASSERT_LEVEL=3 -DVTR_IPO_BUILD=off"
+        MATRIX_EVAL: ${{ matrix.eval }}
+        BUILD_TYPE: release
+      run: |
+        export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
+        ./.github/scripts/build.sh
+

.github/workflows/test.yml

@@ -1,12 +1,34 @@
 name: Test
 
 on:
+  # We want to run the CI when anything is pushed to master.
+  # Since master is a protected branch this only happens when a PR is merged.
+  # This is a double check in case the PR was stale and had some issues.
   push:
+    branches:
+      - master
+    paths-ignore: # Prevents from running if only docs are updated
+      - 'doc/**'
+      - '**/*README*'
+      - '**.md'
+      - '**.rst'
   pull_request:
+    paths-ignore: # Prevents from running if only docs are updated
+      - 'doc/**'
+      - '**/*README*'
+      - '**.md'
+      - '**.rst'
   workflow_dispatch:
   schedule:
   - cron: '0 0 * * *' # daily
 
+# We want to cancel previous runs for a given PR or branch / ref if another CI
+# run is requested.
+# See: https://docs.github.com/en/actions/using-jobs/using-concurrency
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 env:
   # default compiler for all non-compatibility tests
   MATRIX_EVAL: "CC=gcc-11 && CXX=g++-11"
@@ -74,6 +96,10 @@ jobs:
         NUM_CORES: ${{ matrix.cores }}
 
     - name: Upload test results
+      # If the job was not cancelled, we want to save the result (this includes
+      # when the job fails). See warning here:
+      # https://docs.github.com/en/actions/learn-github-actions/expressions#always
+      if: ${{ !cancelled() }}
       # TODO: This runnner is running on a self-hosted CPU. In order to upgrade
       #       to v4, need to upgrade the machine to support node20.
       uses: actions/upload-artifact@v3
@@ -260,17 +286,19 @@ jobs:
         ./run_reg_test.py ${{ matrix.suite }} -show_failures -j2
 
     - name: Upload regression run files
+      if: ${{ !cancelled() }}
       uses: actions/upload-artifact@v4
       with:
         name: ${{matrix.name}}_run_files
         path: |
           vtr_flow/**/*.out
-          vtr_flow/**/*.blif
+          # vtr_flow/**/*.blif  # Removed since it was taking too much space and was hardly used.
           vtr_flow/**/*.p
           vtr_flow/**/*.net
           vtr_flow/**/*.r
 
     - name: Upload regression results
+      if: ${{ !cancelled() }}
       uses: actions/upload-artifact@v4
       with:
         name: ${{matrix.name}}_results
@@ -406,9 +434,9 @@ jobs:
       matrix:
         include:
         - { name: 'GCC 9 (Ubuntu Jammy - 22.04)',     eval: 'CC=gcc-9 && CXX=g++-9',           }
-        - { name: 'GCC 10 (Ubuntu Jammy - 22.04)',  eval: 'CC=gcc-10 && CXX=g++-10',         }
-        - { name: 'GCC 11 (Ubuntu Jammy - 22.04)',                  eval: 'CC=gcc-11 && CXX=g++-11',         }
-        - { name: 'GCC 12 (Ubuntu Jammy - 22.04)',                  eval: 'CC=gcc-12 && CXX=g++-12',         }
+        - { name: 'GCC 10 (Ubuntu Jammy - 22.04)',    eval: 'CC=gcc-10 && CXX=g++-10',         }
+        - { name: 'GCC 11 (Ubuntu Jammy - 22.04)',    eval: 'CC=gcc-11 && CXX=g++-11',         }
+        - { name: 'GCC 12 (Ubuntu Jammy - 22.04)',    eval: 'CC=gcc-12 && CXX=g++-12',         }
         - { name: 'Clang 11 (Ubuntu Jammy - 22.04)',  eval: 'CC=clang-11 && CXX=clang++-11',   }
         - { name: 'Clang 12 (Ubuntu Jammy - 22.04)',  eval: 'CC=clang-12 && CXX=clang++-12',   }
         - { name: 'Clang 13 (Ubuntu Jammy - 22.04)',  eval: 'CC=clang-13 && CXX=clang++-13',   }
@@ -435,7 +463,6 @@ jobs:
         export PATH="/usr/lib/ccache:/usr/local/opt/ccache/libexec:$PATH"
         ./.github/scripts/build.sh
 
-
   Coverity:
     name: 'Coverity Scan'
     needs:

.gitmodules

@@ -3,5 +3,4 @@
 	url = https://github.com/catchorg/Catch2.git
 [submodule "libs/EXTERNAL/sockpp"]
 	path = libs/EXTERNAL/sockpp
-	#url = [email protected]:fpagliughi/sockpp.git
-	url = [email protected]:w0lek/sockpp.git # fork where in branch v1.0.0_no_complication_warnings there are compilation warnings fixes for upstream tag v1.0.0 of sockpp
+	url = https://github.com/w0lek/sockpp.git # fork where in branch v1.0.0_no_complication_warnings there are compilation warnings fixes for upstream tag v1.0.0 of sockpp

CMakeLists.txt

@@ -46,6 +46,7 @@ option(VPR_USE_SERVER "Specify whether vpr enables the server mode" ON)
 #VPR option --enable_analytic_placer is also required for Analytic Placement
 option(VPR_ANALYTIC_PLACE "Enable analytic placement in VPR." ON)
 option(VPR_ENABLE_INTERCHANGE "Enable FPGA interchange." ON)
+option(VPR_ENABLE_NOC_SAT_ROUTING "Enable NoC SAT routing." OFF)
 
 option(WITH_BLIFEXPLORER "Enable build with blifexplorer" OFF)
 
@@ -220,12 +221,12 @@ endforeach()
 set(FLEX_BISON_WARN_SUPPRESS_FLAGS "")
 set(FLEX_BISON_WARN_SUPPRESS_FLAGS_TO_CHECK
     "-Wno-redundant-decls"  #Flex/bison generate code with redundant declarations
-    "-Wno-switch-default"   #Flex/bison generate switch statments w/o default cases
+    "-Wno-switch-default"   #Flex/bison generate switch statements w/o default cases
     "-Wno-unused-parameter" #Flex produces functions with unused params in re-entrant mode
     "-Wno-missing-declarations" #Flex misses some declarations in re-entrant mode
     "-Wimplicit-fallthrough=0" #Bison produces some cases with explicit
     "-Wno-sign-compare" #Flex generates code which performs some signed/unsigned comparison
-    "-Wno-null-dereference" #Bison produces some cases with potenetial null derefs
+    "-Wno-null-dereference" #Bison produces some cases with potential null derefs
     )
 foreach(flag ${FLEX_BISON_WARN_SUPPRESS_FLAGS_TO_CHECK})
     CHECK_CXX_COMPILER_FLAG(${flag} CXX_COMPILER_SUPPORTS_${flag})

README.developers.md

@@ -1326,13 +1326,51 @@ Code included in VTR by subtrees should *not be modified within the VTR source t
 Instead changes should be made in the relevant up-stream repository, and then synced into the VTR tree.
 
 ## Updating an existing Subtree
+
+The following are instructions on how to pull in external changes from an
+existing subtree. Which instructions to follow depend on if you are changing
+the external ref or not.
+
+### External Ref Does Not Change
+
+These instructions are for if the subtree is tracking a ref of a repo which has
+changes we want to pull in. For example, if the subtree is tracking main/master.
+
 1. From the VTR root run: `./dev/external_subtrees.py $SUBTREE_NAME`, where `$SUBTREE_NAME` is the name of an existing subtree.
 
     For example to update the `libtatum` subtree:
     ```shell
     ./dev/external_subtrees.py --update libtatum -m "commit message describing why component is being updated"
     ```
 
+### External Ref Changes
+
+These instructions are for if you want to change the ref that a subtree is
+tracking. For example, if you want to change the version of a subtree (which
+exists on a different branch).
+
+1. Update `./dev/subtree_config.xml` with the new external ref.
+
+2. Run `git log <internal_path>` and take note of any local changes to the
+   subtree. It is bad practice to have local changes to subtrees you cannot
+   modify; however, some changes must be made to allow the library to work in
+   VTR. The next step will clear all these changes, and they may be important
+   and need to be recreated.
+
+3. Delete the subtree folder (the internal path) entirely and commit it to git.
+   The issue is that changing the external ref basically creates a new subtree,
+   so the regular way of updating the subtree does not work. You need to
+   completely wipe all of the code from the old subtree. NOTE: This will remove
+   all changes locally made to the subtree.
+
+4. Run `./dev/external_subtrees.py --update $SUBTREE_NAME`. This will pull in
+   the most recent version of the subtree, squash the changes, and raise a
+   commit.
+
+5. Recreate the local changes from step 2 above, such that the library builds
+   without issue; preferrably in a concise way such that the library can be
+   easily updated in the future.
+
 ## Adding a new Subtree
 
 To add a new external subtree to VTR do the following:

dev/pylint_check.py

@@ -60,6 +60,7 @@
     repo_path / "doc/_exts/rrgraphdomain/__init__.py",
     repo_path / "doc/_exts/sdcdomain/__init__.py",
     repo_path / "doc/_exts/archdomain/__init__.py",
+    repo_path / "doc/_exts/constraintsdomain/__init__.py",
     repo_path / "vpr/scripts/compare_timing_reports.py",
     repo_path / "vpr/scripts/profile/util.py",
     repo_path / "vpr/scripts/profile/parse_and_plot_detailed.py",

dev/subtree_config.xml

@@ -33,7 +33,7 @@
         name="capnproto"
         internal_path="libs/EXTERNAL/capnproto"
         external_url="https://github.com/capnproto/capnproto.git"
-        default_external_ref="v0.9.1"/>
+        default_external_ref="v1.0.2"/>
     <subtree
         name="libinterchange"
         internal_path="libs/EXTERNAL/libinterchange"

doc/_exts/constraintsdomain/__init__.py

@@ -0,0 +1,27 @@
+from sphinxcontrib.domaintools import custom_domain
+from sphinx.util.docfields import *
+
+
+def setup(app):
+    app.add_domain(
+        custom_domain(
+            "VPRConstraintsDomain",
+            name="vpr_constraints",
+            label="Place and Route Constraints",
+            elements=dict(
+                tag=dict(
+                    objname="Attribute",
+                    indextemplate="pair: %s; Tag Attribute",
+                    fields=[
+                        GroupedField(
+                            "required_parameter", label="Required Attributes", names=["req_param"]
+                        ),
+                        GroupedField(
+                            "optional_parameter", label="Optional Attributes", names=["opt_param"]
+                        ),
+                        Field("required", label="Tag Required", names=["required"]),
+                    ],
+                ),
+            ),
+        )
+    )

doc/src/api/vpr/contexts.rst

@@ -43,3 +43,7 @@ Structures
 .. doxygenstruct:: TimingContext
    :project: vpr
    :members:
+
+.. doxygenstruct:: ServerContext
+   :project: vpr
+   :members:

doc/src/api/vpr/index.rst

@@ -11,3 +11,4 @@ VPR API
    netlist
    route_tree
    rr_graph
+   server