Merge branch 'master' into fredt_check_all_legality_flip

Author: gigeresk

.github/workflows/stale.yml

@@ -10,6 +10,11 @@ jobs:
     steps:
       - uses: actions/stale@v9
         with:
+          # Set default number of days before being marked stale to 100 years
+          # This will be overriden by "days-before-issue-stale" and "days-before-pr-stale"
+          # This is done to avoid marking PRs as stale, as it is not something
+          # we want to do.
+          days-before-stale: 36500
           # The message to be shown for stale issues
           stale-issue-message: 'This issue has been inactive for a year and has been marked as stale. It will be closed in 15 days if it continues to be stale. If you believe this is still an issue, please add a comment.'
           close-issue-message: 'This issue has been marked stale for 15 days and has been automatically closed.'
@@ -20,6 +25,11 @@ jobs:
           # Start from the oldest issues
           ascending: true
 
+          # Upper limit for number of API calls per day
+          # This worklfow does 2-3 API calls per issue
+          # including issues that have been marked stale
+          operations-per-run: 300
+
           # The configuration below can be used to allow the same behaviour with PRs.
           # Since we currently don't want to close old PRs, it is commented out but 
           # left here in case we change our mind.

Dockerfile

@@ -1,10 +1,13 @@
-FROM ubuntu:22.04
+FROM ubuntu:24.04
 ARG DEBIAN_FRONTEND=noninteractive
 # set out workspace
 ENV WORKSPACE=/workspace
 RUN mkdir -p ${WORKSPACE}
 WORKDIR ${WORKSPACE}
 COPY . ${WORKSPACE}
+# Required to bypass Python's protection on system-wide package installations in Ubuntu 23.04+.
+# This allows pip to install packages globally without using a virtual environment.
+ENV PIP_BREAK_SYSTEM_PACKAGES=1
 # Install and cleanup is done in one command to minimize the build cache size
 RUN apt-get update -qq \
 # Extract package names from install_apt_packages.sh
@@ -29,4 +32,4 @@ RUN apt-get update -qq \
 # Build VTR
 RUN rm -rf build && make -j$(nproc) && make install
 # Container's default launch command
-SHELL ["/bin/bash", "-c"]
+SHELL ["/bin/bash", "-c"]

doc/src/api/vtrutil/containers.rst

@@ -8,6 +8,12 @@ vtr_vector
    :project: vtr
    :sections: briefdescription detaileddescription innernamespace innerclass public-func typedef func
 
+vtr_array
+----------
+.. doxygenfile:: vtr_array.h
+   :project: vtr
+   :sections: briefdescription detaileddescription innernamespace innerclass public-func typedef func
+
 vtr_small_vector
 ----------------
 .. doxygenclass:: vtr::small_vector

doc/src/quickstart/index.rst

@@ -23,8 +23,23 @@ If you cloned the repository, you will need to set up the git submodules (if you
 
     > git submodule init
     > git submodule update
-    
-VTR requires several system packages and Python packages to build and run the flow. Ubuntu users can install the required system packages using the following command (this works on Ubuntu 18.04, 20.04, 22.04 and 24.04, but you may require different packages on other Linux distributions). Our CI testing is on Ubuntu 24.04, so that is the best tested platform and recommended for development.
+
+VTR requires several system and Python packages to build and run the flow. Ubuntu users can install the required system packages using the provided script or the command below. This setup works on Ubuntu 18.04, 20.04, 22.04, and 24.04, but note that some packages (such as ``clang-format-18``) are only available by default on Ubuntu 24.04. On older versions, this package will not be installed unless you manually add the appropriate LLVM APT repository.
+
+To install ``clang-format-18`` on older Ubuntu versions (e.g., 20.04 or 22.04), you must add the LLVM repository manually. Note that this tool is only required if you want to run ``make format`` to automatically fix formatting issues in the code. It is not necessary for building or running VPR.
+
+.. code-block:: bash
+
+   sudo apt install wget gnupg lsb-release
+   wget https://apt.llvm.org/llvm.sh
+   chmod +x llvm.sh
+   sudo ./llvm.sh 18
+
+After that, you can install ``clang-format-18`` using:
+
+.. code-block:: bash
+
+   sudo apt install clang-format-18
 
 .. code-block:: bash
 

doc/src/vpr/command_line_usage.rst

@@ -1730,6 +1730,16 @@ Analysis Options
 
     **Default:** ``unconnected``
 
+.. option:: --post_synth_netlist_module_parameters { on | off }
+
+    Controls whether the post-synthesis netlist output by VTR can use Verilog parameters
+    or not. When using the post-synthesis netlist for external timing analysis,
+    some tools cannot accept the netlist if it contains parameters. By setting
+    this option to ``off``, VPR will try to represent the netlist using non-parameterized
+    modules.
+
+    **Default:** ``on``
+
 .. option:: --timing_report_npaths <int>
 
     Controls how many timing paths are reported.

install_apt_packages.sh

@@ -40,3 +40,8 @@ sudo apt-get install -y \
 # Required to build the documentation
 sudo apt-get install -y \
     sphinx-common
+
+# Required for code formatting
+sudo apt-get install -y \
+    clang-format-18
+

libs/EXTERNAL/libblifparse/CMakeLists.txt

@@ -13,7 +13,7 @@ if(${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_CURRENT_SOURCE_DIR})
 endif()
 
 #Flex and Bison are used to generate the parser
-find_package(BISON REQUIRED 3.0)
+find_package(BISON REQUIRED 3.3)
 find_package(FLEX REQUIRED)
 
 file(GLOB_RECURSE LIB_SOURCES src/blif*.cpp)

libs/EXTERNAL/libblifparse/src/blif_parser.y

@@ -1,5 +1,5 @@
-/* C++ parsers require Bison 3 */
-%require "3.0"
+/* C++ parsers require Bison 3.3 */
+%require "3.3"
 %language "C++"
 
 /* Write-out tokens header file */
@@ -34,7 +34,7 @@
 %define api.namespace {blifparse}
 
 /* Name the parser class */
-%define parser_class_name {Parser}
+%define api.parser.class {Parser}
 
 /* Match the flex prefix */
 %define api.prefix {blifparse_}

libs/EXTERNAL/libsdcparse/CMakeLists.txt

@@ -13,7 +13,7 @@ if(${CMAKE_SOURCE_DIR} STREQUAL ${CMAKE_CURRENT_SOURCE_DIR})
 endif()
 
 #Flex and Bison are used to generate the parser
-find_package(BISON REQUIRED 3.0)
+find_package(BISON REQUIRED 3.3)
 find_package(FLEX REQUIRED)
 
 file(GLOB_RECURSE LIB_SOURCES src/sdc*.cpp)

libs/EXTERNAL/libsdcparse/src/sdc_parser.y

@@ -1,5 +1,5 @@
-/* C++ parsers require Bison 3 */
-%require "3.0"
+/* C++ parsers require Bison 3.3 */
+%require "3.3"
 %language "C++"
 
 /* Write-out tokens header file */
@@ -34,7 +34,7 @@
 %define api.namespace {sdcparse}
 
 /* Name the parser class */
-%define parser_class_name {Parser}
+%define api.parser.class {Parser}
 
 /* Match the flex prefix */
 %define api.prefix {sdcparse_}