Merge branch 'master' into master

Author: Minchan-Kwon

.codespellrc

@@ -40,6 +40,8 @@ quiet-level = 3
 # correctly.
 ignore-words-list = subtile,
                     subtiles,
+                    # yosys ff cell type name (dff with enable + reset).
+                    dffer,
                     fle,
                     EArch,
                     FPT,

.github/workflows/test.yml

@@ -756,6 +756,97 @@ jobs:
           vtr_flow/**/parse_results*.txt
 
 
+  RegressionWithMosaic:
+    runs-on: ubuntu-24.04
+    needs: [BuildVTR]
+    strategy:
+      fail-fast: false
+      matrix:
+        include: [
+          {
+            name: 'Mosaic_regression',
+            suite: 'vtr_reg_basic_mosaic',
+            extra_pkgs: 'verilator'
+          }
+        ]
+    name: 'R: ${{ matrix.name }}'
+    steps:
+
+    - uses: actions/setup-python@v7
+      with:
+        python-version: 3.12.3
+
+    - uses: actions/checkout@v7
+      with:
+        submodules: 'true'
+
+    - name: Get number of CPU cores
+      uses: SimenB/github-actions-cpu-cores@v3
+      id: cpu-cores
+
+    - name: Install dependencies
+      run: ./install_apt_packages.sh
+
+    - name: Install Extra Dependencies
+      if: ${{ matrix.extra_pkgs != '' }}
+      run: |
+        sudo apt update
+        sudo apt install -y ${{ matrix.extra_pkgs }}
+
+    - name: Install Python Requirements
+      run: |
+        pip install -r requirements.txt
+
+    - name: Download Build Artifact
+      uses: actions/download-artifact@v8
+      with:
+        name: build-release.tar.gz
+
+    - name: Unpack Build
+      shell: bash
+      run: |
+        tar -xvzf build.tar.gz
+
+    - name: Test
+      timeout-minutes: 60
+      run: |
+        ./run_reg_test.py ${{ matrix.suite }} -show_failures -j${{ steps.cpu-cores.outputs.count}}
+
+    - name: Require mosaic verilator-check pass
+      timeout-minutes: 5
+      run: |
+        python3 mosaic/scripts/verify_regression_vcheck.py --suite ${{ matrix.suite }}
+
+    - name: Compare Parmys and Mosaic hardblock BLIF models
+      timeout-minutes: 20
+      run: |
+        python3 mosaic/scripts/compare_frontend_blif_models.py --run \
+          --circuit vtr_flow/benchmarks/verilog/diffeq1.v \
+          --arch vtr_flow/arch/timing/k6_frac_N10_frac_chain_mem32K_40nm.xml \
+          --work-dir mosaic_blif_model_compare
+
+    - name: Upload regression run files
+      if: ${{ !cancelled() }}
+      uses: actions/upload-artifact@v7
+      with:
+        name: ${{matrix.name}}_run_files
+        path: |
+          vtr_flow/**/*.out
+          # 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@v7
+      with:
+        name: ${{matrix.name}}_results
+        path: |
+          vtr_flow/**/*.log
+          vtr_flow/**/parse_results*.txt
+
+
   Sanitized:
     runs-on: ubuntu-24.04
     strategy:

.gitignore

@@ -175,3 +175,8 @@ compile_commands.json
 
 vpr/test/gui/golden/tmp/*
 
+#
+# Mosaic QoR compare output
+#
+/compare_output_*/
+mosaic/scripts/compare_output_*/

CMakeLists.txt

@@ -54,10 +54,24 @@ option(ODIN_COVERAGE "Enable building odin with coverage flags" OFF)
 option(ODIN_TIDY "Enable building odin with clang tidy" OFF)
 option(ODIN_SANITIZE "Enable building odin with sanitize flags" OFF)
 
-# Allow the user to enable building Yosys
+# Yosys plugins. Yosys is built when WITH_PARMYS or WITH_MOSAIC is on.
 option(WITH_PARMYS "Enable Yosys as elaborator and parmys-plugin as partial mapper" ON)
+option(WITH_MOSAIC "Enable mosaic yosys plugin as an alternative synthesis frontend" ON)
 option(SLANG_SYSTEMVERILOG "Enable building and installing Yosys-Slang plugin for parsing SystemVerilog" ON)
 
+
+if(${WITH_PARMYS} OR ${WITH_MOSAIC})
+    set(WITH_YOSYS ON)
+else()
+    set(WITH_YOSYS OFF)
+endif()
+
+# slang is a yosys plugin, so skip it when neither frontend builds yosys
+if(${SLANG_SYSTEMVERILOG} AND NOT ${WITH_YOSYS})
+    message(WARNING "Yosys is not enabled, disabling Yosys-Slang as well.")
+    set(SLANG_SYSTEMVERILOG OFF)
+endif()
+
 set(VTR_VERSION_MAJOR 9)
 set(VTR_VERSION_MINOR 0)
 set(VTR_VERSION_PATCH 0)
@@ -521,6 +535,10 @@ if(${WITH_PARMYS})
     add_subdirectory(parmys)
 endif()
 
+if(${WITH_MOSAIC})
+    add_subdirectory(mosaic)
+endif()
+
 #Add the various tools
 add_compile_options(${WARN_FLAGS}) #Add warn flags for VTR tools
 add_compile_options(${ADDITIONAL_FLAGS})
@@ -539,15 +557,6 @@ if(${WITH_ODIN})
     endif()
 endif()
 
-# handle cmake params to compile yosys-slang plugin for Yosys
-if(${SLANG_SYSTEMVERILOG})
-    # avoid compiling yosys-slang plugin in case the Parmys frontend is not active
-    if(NOT ${WITH_PARMYS})
-        message(WARNING "Parmys is not enabled, disabling Yosys-Slang as well.")
-        set(SLANG_SYSTEMVERILOG OFF)
-    endif()
-endif()
-
 #Add extra compilation flags to suppress warnings from some libraries/tools
 # Note that target_compile_options() *appends* to the current compilation options of
 # the specified target

Makefile

@@ -57,11 +57,11 @@ ifeq ($(OS),Windows_NT)
 CURL_PATH:=$(shell where curl.exe 2>nul | head -n 1)
 # VCPKG root is a system variable env:VCPKG in power shell. User can override by using VCPKG_PATH when calling the makefile
 VCPKG_CMAKE_PATH:=$(subst \,/,$(VCPKG_PATH))
-override CMAKE_PARAMS := ${CMAKE_PARAMS} -DWITH_PARMYS=OFF -DSLANG_SYSTEMVERILOG=OFF -DVTR_IPO_BUILD=OFF -DWITH_ABC=OFF
+override CMAKE_PARAMS := ${CMAKE_PARAMS} -DWITH_PARMYS=OFF -DWITH_MOSAIC=OFF -DSLANG_SYSTEMVERILOG=OFF -DVTR_IPO_BUILD=OFF -DWITH_ABC=OFF
 # Msys2 can still use Linux gcc
 ifneq ($(MSYSTEM),MINGW64)
 override CMAKE_PARAMS := ${CMAKE_PARAMS} -DWGET="${CURL_PATH}" -DCMAKE_TOOLCHAIN_FILE="${VCPKG_CMAKE_PATH}/scripts/buildsystems/vcpkg.cmake" -DVCPKG_TARGET_TRIPLET=x64-windows-release -DVCPKG_MANIFEST_MODE=OFF
-#	override CMAKE_PARAMS := ${CMAKE_PARAMS} -DWITH_PARMYS=OFF -DSLANG_SYSTEMVERILOG=OFF -DVTR_IPO_BUILD=OFF -DWITH_ABC=OFF
+#	override CMAKE_PARAMS := ${CMAKE_PARAMS} -DWITH_PARMYS=OFF -DWITH_MOSAIC=OFF -DSLANG_SYSTEMVERILOG=OFF -DVTR_IPO_BUILD=OFF -DWITH_ABC=OFF
 endif
 endif
 

dev/pylint_check.py

@@ -23,6 +23,7 @@
 paths_to_lint = [
     (repo_path, False),
     (repo_path / "dev", True),
+    (repo_path / "mosaic", True),
     (repo_path / "odin_ii", True),
     (repo_path / "ace2", True),
     (repo_path / "doc", True),

doc/agents/build.md

@@ -37,6 +37,9 @@ Pass via `CMAKE_PARAMS="-DOPTION=value"`:
 - `VTR_ENABLE_SANITIZE` — address/leak/UB sanitizers
 - `VTR_ENABLE_PROFILING` — gprof profiling
 - `VPR_USE_EZGL` — graphics library (auto/on/off)
-- `WITH_PARMYS` — build Yosys frontend (default ON)
+- `WITH_PARMYS` — build Parmys Yosys plugin (default ON)
+- `WITH_MOSAIC` — build mosaic Yosys plugin (default ON)
 - `WITH_ODIN` — build legacy Odin frontend (default OFF)
 - `VTR_IPO_BUILD` — interprocedural optimization (default auto/on); set to `off` during development to reduce build times and improve debuggability
+
+Yosys is built when `WITH_PARMYS` or `WITH_MOSAIC` is on. At least one of those two options must be on.

doc/agents/codebase.md

@@ -6,6 +6,7 @@
 |-----------|---------|
 | `vpr/` | Core FPGA CAD tool: pack, place, route, timing |
 | `parmys/` | Yosys-based synthesis frontend (replaces Odin) |
+| `mosaic/` | Yosys mosaic frontend (`-start mosaic`; see `mosaic/README.md`) |
 | `odin_ii/` | Legacy synthesis frontend (disabled by default) |
 | `abc/` | Logic optimization (external, do not modify directly) |
 | `ace2/` | Activity estimation for power analysis |