OPEN: Snitch support integration

.github/workflows/CI.yml

@@ -89,6 +89,12 @@ jobs:
         simpleRegression
         WaveFormer 
 
+  ### Snitch Tests ###
+  snitch-kernels:
+    uses: ./.github/workflows/TestRunnerSnitch.yml
+    with:
+      test-names: |
+        testMatMul
 
   ### Mempool Tests ###
   mempool-kernels:

.github/workflows/TestRunnerSnitch.yml

@@ -0,0 +1,32 @@
+name: TestRunnerSnitch
+
+on:
+  workflow_call:
+    inputs:
+      test-names:
+        required: true
+        type: string
+
+jobs:
+  test-runner-snitch:
+    runs-on: ubuntu-22.04
+    container:
+      image: ghcr.io/pulp-platform/deeploy:main
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+      - name: Build Deeploy
+        run: pip install -e .
+      - name: Run Test
+        run: |
+          testNames="${{ inputs.test-names }}"
+          cd DeeployTest
+          echo "$testNames" | while IFS= read -r testName; do
+            if [[ -n "$testName" ]]; then
+              echo "Running test: $testName"
+              python testRunner_snitch.py -t Tests/$testName --toolchain_install_dir /app/install/riscv-llvm/
+            fi
+          done
+        shell: bash

CHANGELOG.md

@@ -25,3 +25,15 @@
 - Add a FloatAdder test to the CI for Siracusa and Generic platforms
 - Extend `testType.py` with float tests
 - LIMITATION: Current LLVM compiler does not support bfp16 and fp16, these types are commented in the library header
+
+## Snitch Cluster Support
+
+### Added
+ - cMake Flow for the Snitch Cluster
+ - Added `snitch_cluster` to Makefile
+ - New Snitch platform with testing application
+ - Testrunner for tiled and untiled execution (`testRunner_snitch.py`, `testRunner_tiled_snitch.py`)
+ - Minimal library with CycleCounter and utility function
+
+### Changed
+- Update the Banshee's commit to include a recent PR.

CMakeLists.txt

@@ -15,8 +15,8 @@ if(TOOLCHAIN STREQUAL GCC)
   set(CMAKE_INTERPROCEDURAL_OPTIMIZATION TRUE)
 endif()
 
-set(platform MemPool CACHE STRING "Platform (MemPool, QEMU, Siracusa, Siracusa_w_neureka, PULP-Open, Generic)")
-set_property(CACHE platform PROPERTY STRINGS MemPool QEMU Siracusa Siracusa_w_neureka PULP-Open Generic)
+set(platform MemPool CACHE STRING "Platform (MemPool, QEMU, Siracusa, Siracusa_w_neureka, PULP-Open, Generic, Snitch)")
+set_property(CACHE platform PROPERTY STRINGS MemPool QEMU Siracusa Siracusa_w_neureka PULP-Open Generic Snitch)
 
 if(platform STREQUAL MemPool)
   message(STATUS "Building for platform 'MemPool'")
@@ -30,6 +30,8 @@ elseif(platform STREQUAL PULPOpen)
   message(STATUS "Building for platform 'PULP-Open'")
 elseif(platform STREQUAL Generic)
   message(STATUS "Building for platform 'Generic'")
+elseif(platform STREQUAL Snitch)
+  message(STATUS "Building for platform 'Snitch'")
 else()
   message(FATAL_ERROR "Invalid platform '${platform}' specified!")
 endif()
@@ -181,4 +183,33 @@ if(platform STREQUAL Siracusa OR platform STREQUAL Siracusa_w_neureka OR platfor
 
 endif()
 
+if(platform STREQUAL Snitch)
+
+  if(TOOLCHAIN STREQUAL LLVM)
+    set(CMAKE_TOOLCHAIN_FILE ${CMAKE_CURRENT_LIST_DIR}/cmake/snitch/toolchain_llvm.cmake)
+  else()
+    set(CMAKE_TOOLCHAIN_FILE ${CMAKE_CURRENT_LIST_DIR}/cmake/snitch/toolchain_gcc.cmake)
+  endif()
+
+  include(${CMAKE_CURRENT_LIST_DIR}/cmake/snitch/snitch.cmake)
+
+  include(${CMAKE_CURRENT_LIST_DIR}/cmake/snitch/snitch_cluster/snitch_cluster.cmake)
+
+  project(deeploy LANGUAGES C ASM)
+
+  message(STATUS "============================= ${platform} Configuration ============================")
+  message(STATUS "[cMake  ]   Number of total cores  = " ${NUM_CORES})
+  message(STATUS "================================================================================")
+  message(STATUS "")
+
+  add_subdirectory(TargetLibraries/Generic)
+  add_subdirectory(TargetLibraries/Snitch)
+  target_include_directories(deeploysnitch PUBLIC TargetLibraries/Generic/inc)
+
+  add_subdirectory(DeeployTest)
+  target_link_libraries(deeploylib INTERFACE deeploybasic deeploysnitch)
+
+endif()
+
+
 print_simulation_config()

Container/Dockerfile

@@ -3,6 +3,11 @@ FROM ubuntu:22.04 AS builder
 
 ARG PYTHON_VERSION=3.8.0
 ARG DEBIAN_FRONTEND=noninteractive
+
+ARG UBUNTU_VERSION=22.04
+ARG BENDER_VERSION=0.28.1
+ARG SNITCH_LLVM_VERSION=latest
+
 ENV TZ=Etc/UTC
 
 WORKDIR /app
@@ -74,6 +79,26 @@ RUN make qemu
 RUN make mempool
 RUN make banshee
 
+# Dependencies needed for compiling Snitch
+## Bender's installaton
+RUN wget https://github.com/pulp-platform/bender/releases/download/v${BENDER_VERSION}/bender-${BENDER_VERSION}-x86_64-linux-gnu-ubuntu${UBUNTU_VERSION}.tar.gz && \
+    tar xzf bender-${BENDER_VERSION}-x86_64-linux-gnu-ubuntu${UBUNTU_VERSION}.tar.gz && cp  /app/bender /bin
+ENV PATH=/app/bender:$PATH
+
+## Precompiled llvm - Taken form https://github.com/pulp-platform/snitch_cluster (from this file: util/container/Dockerfile)
+RUN latest_tag=`curl -s -H "Accept: application/vnd.github.v3+json" https://api.github.com/repos/pulp-platform/llvm-project/releases/latest | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/'` && \
+echo "SNITCH_LLVM_VERSION=${SNITCH_LLVM_VERSION} LLVM_TAR=${LLVM_TAR} latest_tag=${latest_tag}" && \
+test "${SNITCH_LLVM_VERSION}" = "latest" && SNITCH_LLVM_VERSION=${latest_tag} || : ; \
+LLVM_TAR=riscv32-pulp-llvm-ubuntu2004-$(echo $SNITCH_LLVM_VERSION | cut -d '-' -f3-).tar.gz && \
+mkdir -p riscv-llvm && \
+echo "SNITCH_LLVM_VERSION=${SNITCH_LLVM_VERSION} LLVM_TAR=${LLVM_TAR} latest_tag=${latest_tag}" && \
+wget -qO- https://github.com/pulp-platform/llvm-project/releases/download/${SNITCH_LLVM_VERSION}/${LLVM_TAR} | \
+tar xvz --strip-components=1 -C riscv-llvm
+
+
+## compile snitch
+RUN PATH=/app/riscv-llvm/bin:${PATH} make snitch_runtime && rm -rf /app/snitch_cluster
+
 # Remove toolchain to make the container lighter
 RUN rm -rf toolchain
 
@@ -88,6 +113,7 @@ ENV TZ=Etc/UTC
 ENV CMAKE=/usr/bin/cmake
 ENV PULP_SDK_HOME=/app/install/pulp-sdk
 ENV LLVM_INSTALL_DIR=/app/install/llvm
+ENV SNITCH_HOME=/app/install/snitch_cluster
 ENV MEMPOOL_HOME=/app/install/mempool
 ENV PATH=/app/install/qemu/bin:/app/install/banshee:$PATH
 ENV PATH="/root/.cargo/bin:${PATH}"
@@ -114,6 +140,8 @@ pip install toml-to-requirements && \
 toml-to-req --toml-file pyproject.toml && \
 pip install -r requirements.txt
 
+
 # Copy pre-built toolchains and emulators
 COPY --from=builder /app/install ./install
-COPY --from=builder /root/.cargo/bin/banshee /root/.cargo/bin/banshee
+COPY --from=builder /root/.cargo/bin/banshee /root/.cargo/bin/banshee
+COPY --from=builder /app/riscv-llvm ./install/riscv-llvm

Deeploy/Targets/Snitch/Deployer.py

@@ -0,0 +1,70 @@
+# ----------------------------------------------------------------------
+#
+# File: SnitchDeployer.py
+#
+# Last edited: 23.04.2024
+#
+# Copyright (C) 2024, ETH Zurich and University of Bologna.
+#
+# Authors:
+# - Philip Wiese (wiesep@iis.ee.ethz.ch), ETH Zurich
+#
+# ----------------------------------------------------------------------
+# SPDX-License-Identifier: Apache-2.0
+#
+# Licensed under the Apache License, Version 2.0 (the License); you may
+# not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an AS IS BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from typing import Callable, Dict, Type
+
+import onnx_graphsurgeon as gs
+
+from Deeploy.AbstractDataTypes import Pointer
+from Deeploy.CommonExtensions.NetworkDeployers.SignPropDeployer import SignPropDeployer
+from Deeploy.CommonExtensions.OptimizationPasses.TopologyOptimizationPasses.LoweringOptimizationPasses import \
+    NCHWtoNHWCPass, RemoveGlobalOutputReshapePass, TransposeMatmulInputsPass
+from Deeploy.DeeployTypes import DeploymentPlatform, TopologyOptimizer
+from Deeploy.Targets.Generic.TopologyOptimizationPasses.Passes import ReshapeConstOptPass, TransposeConstOptPass, \
+    TransposeMergePass, TransposeSplitPass
+
+
+class SnitchDeployer(SignPropDeployer):
+
+    def __init__(self,
+                 graph: gs.Graph,
+                 deploymentPlatform: DeploymentPlatform,
+                 inputTypes: Dict[str, Type[Pointer]],
+                 loweringOptimizer: TopologyOptimizer,
+                 scheduler: Callable = lambda x: x,
+                 name: str = 'DeeployNetwork',
+                 default_channels_first = False,
+                 deeployStateDir: str = "DeeployStateDir",
+                 inputOffsets = {}):
+        super().__init__(graph,
+                         deploymentPlatform,
+                         inputTypes,
+                         loweringOptimizer,
+                         scheduler,
+                         name,
+                         default_channels_first = default_channels_first,
+                         deeployStateDir = deeployStateDir,
+                         inputOffsets = inputOffsets)
+
+        self.loweringOptimizer.passes += [
+            TransposeMatmulInputsPass(),
+            NCHWtoNHWCPass(self.default_channels_first),
+            TransposeSplitPass(),
+            TransposeMergePass(),
+            TransposeConstOptPass(),
+            ReshapeConstOptPass(),
+            RemoveGlobalOutputReshapePass(),
+        ]