treewide: Replace pip in favor of uv

.github/workflows/ci.yml

@@ -133,7 +133,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Run pytest
-        run: pytest
+        run: uv run pytest
 
   ##############################################
   # Simulate SW on Snitch Cluster w/ Verilator #
@@ -151,10 +151,9 @@ jobs:
           submodules: 'recursive'
       - name: Hash Verilator prerequisites
         id: verilator-hash
-        uses: colluca/pymakeutils@v1.2.0
-        with:
-          target: verilator
-          flags: --recursive
+        run: |
+          hash=$(uv run list-make-prerequisites verilator --recursive --hash)
+          echo "hash=$hash" >> "$GITHUB_OUTPUT"
       - name: Set up cache for Verilator build
         id: verilator-cache
         uses: actions/cache@v4
@@ -184,8 +183,8 @@ jobs:
       - name: Run Tests
         working-directory: test
         run: |
-          ../util/experiments/run.py run.yaml --simulator verilator -j
-          ../util/experiments/run.py riscv_tests_isa.yaml --simulator verilator -j
+          uv run ../util/experiments/run.py run.yaml --simulator verilator -j
+          uv run ../util/experiments/run.py riscv_tests_isa.yaml --simulator verilator -j
       - name: Annotate traces
         # Build the traces using the --permissive flag, since the Verilator
         # testbench does not wait until all the instructions are retired

.gitlab-ci.yml

@@ -12,40 +12,24 @@ variables:
   CARGO_TARGET_X86_64_UNKNOWN_LINUX_GNU_LINKER: /usr/pack/gcc-9.2.0-af/linux-x64/bin/gcc
   LLVM_SYS_120_PREFIX: /usr/pack/llvm-12.0.1-af
   CMAKE: cmake-3.18.1
-  # Override pip cache directory
-  PIP_CACHE_DIR: "$CI_PROJECT_DIR/.cache/pip"
+  UV_CACHE_DIR: $CI_BUILDS_DIR/../cache/uv
 
 default:
   before_script:
-    source iis-setup.sh
-  cache: &global_cache
-    key:
-      files:
-        - pyproject.toml
-    paths:
-      - .cache/pip
-    policy: pull
-
+    - source iis-setup.sh
+    # Gets rid of uv warnings about already activated virtualenv
+    - unset VIRTUAL_ENV
+    # The CI is configured such that the uv cache directory (`UV_CACHE_DIR`),
+    # is located on the same file system outside of the build directory.
+    # `uv` should try to hardlink files instead of copying them to save space
+    - export UV_LINK_MODE=hardlink
 
-#########
-# Setup #
-#########
-
-setup:
-  cache:
-    # inherit all global cache settings
-    <<: *global_cache
-    # override the policy
-    policy: pull-push
-  script:
-    - echo "Setup completed."
 
 ##############
 # Build docs #
 ##############
 
 docs:
-  needs: [setup]
   script:
     - make docs
 
@@ -54,16 +38,14 @@ docs:
 #####################
 
 pytest:
-  needs: [setup]
   script:
-    - pytest
+    - uv run pytest
 
 #################################
 # Build Snitch cluster software #
 #################################
 
 snitch-cluster-sw:
-  needs: [setup]
   script:
     - make sw -j
   artifacts:
@@ -82,7 +64,6 @@ snitch-cluster-sw:
 # - snitch_dma
 # - snitch
 snitch-ip-tests:
-  needs: [setup]
   parallel:
     matrix:
       - IP:
@@ -102,28 +83,28 @@ snitch-ip-tests:
 
 # Verilator
 snitch-cluster-vlt:
-  needs: [setup, snitch-cluster-sw]
+  needs: [snitch-cluster-sw]
   script:
     - make verilator
     - cd test
-    - ../util/experiments/run.py run.yaml --simulator verilator -j --run-dir runs/vlt
+    - uv run ../util/experiments/run.py run.yaml --simulator verilator -j --run-dir runs/vlt
 
 # # VCS
 # snitch-cluster-vcs:
-#   needs: [setup, snitch-cluster-sw]
+#   needs: [snitch-cluster-sw]
 #   script:
 #     - make vcs
 #     - cd test
-#     - ../util/experiments/run.py run.yaml --simulator vcs -j --run-dir runs/vcs
+#     - uv run ../util/experiments/run.py run.yaml --simulator vcs -j --run-dir runs/vcs
 
 # Questa
 snitch-cluster-vsim:
-  needs: [setup, snitch-cluster-sw]
+  needs: [snitch-cluster-sw]
   script:
     - make vsim -j
     - cd test
-    - ../util/experiments/run.py run.yaml --simulator vsim -j --run-dir runs/vsim
-    - ../util/experiments/run.py riscv_tests_isa.yaml --simulator vsim -j --run-dir runs/vsim
+    - uv run ../util/experiments/run.py run.yaml --simulator vsim -j --run-dir runs/vsim
+    - uv run ../util/experiments/run.py riscv_tests_isa.yaml --simulator vsim -j --run-dir runs/vsim
     # Test trace annotation
     - make -C .. SIM_DIR=$(PWD)/runs/vsim/simple annotate -j
     # Run additional, more extensive tests
@@ -133,54 +114,49 @@ snitch-cluster-vsim:
 
 # Test OmegaNet TCDM interconnect
 snitch-cluster-omega-vsim:
-  needs: [setup]
   script:
     - make CFG_OVERRIDE=cfg/omega.json sw -j
     - make vsim -j
     - cd test
-    - ../util/experiments/run.py run.yaml --simulator vsim -j --run-dir runs/vsim
+    - uv run ../util/experiments/run.py run.yaml --simulator vsim -j --run-dir runs/vsim
 
 # Test Multi-channel DMA
 snitch-cluster-mchan-vsim:
-  needs: [setup]
   script:
     - make CFG_OVERRIDE=cfg/dma_mchan.json sw -j
     - make vsim -j
     - cd test
-    - ../util/experiments/run.py dma_mchan.yaml --simulator vsim -j --run-dir runs/vsim
+    - uv run ../util/experiments/run.py dma_mchan.yaml --simulator vsim -j --run-dir runs/vsim
 
 # Additional tests for different FREP configurations
 snitch-cluster-frep-vsim:
-  needs: [setup]
   script:
     # Large FREP configuration
     - make CFG_OVERRIDE=cfg/frep_xl.json sw -j
     - make vsim -j
     - cd test
-    - ../util/experiments/run.py frep_xl.yaml --simulator vsim -j --run-dir runs/vsim
+    - uv run ../util/experiments/run.py frep_xl.yaml --simulator vsim -j --run-dir runs/vsim
     - cd -
     # Small FREP configuration
     - make CFG_OVERRIDE=cfg/frep_xs.json sw -j
     - make vsim -j
     - cd test
-    - ../util/experiments/run.py frep_xs.yaml --simulator vsim -j --run-dir runs/vsim
+    - uv run ../util/experiments/run.py frep_xs.yaml --simulator vsim -j --run-dir runs/vsim
 
 # COPIFT and scalar chaining experiments
 snitch-cluster-copift-sc-vsim:
-  needs: [setup]
   script:
     - make CFG_OVERRIDE=experiments/copift/cfg.json vsim -j
     - cd experiments/copift
-    - ./experiments.py experiments.yaml --actions sw run perf -j
+    - uv run ./experiments.py experiments.yaml --actions sw run perf -j
     - cd ../chaining
-    - ./experiments.py experiments.yaml --actions sw run perf -j
+    - uv run ./experiments.py experiments.yaml --actions sw run perf -j
 
 ############
 # Non-free #
 ############
 
 nonfree:
-  needs: [setup]
   script:
     - make nonfree
     - make elab

.python-version

@@ -0,0 +1 @@
+3.11

Makefile

@@ -107,7 +107,7 @@ doc-srcs: $(GENERATED_DOC_SRCS)
 doxygen-docs: $(DOXYGEN_DOCS_DIR)
 
 docs: doc-srcs doxygen-docs
-	mkdocs build
+	$(SN_UV) mkdocs build
 
 clean-docs:
 	rm -rf $(GENERATED_DOCS_DIR)
@@ -121,7 +121,7 @@ $(GENERATED_DOCS_DIR)/peripherals.md: hw/snitch_cluster/src/snitch_cluster_perip
 	$(SN_PEAKRDL) markdown $< -o $@
 
 $(DOXYGEN_DOCS_DIR): $(DOXYFILE) $(DOXYGEN_INPUTS)
-	doxygen $<
+	$(SN_UV) doxygen $<
 
 #######
 # RTL #
@@ -138,7 +138,7 @@ clean-rtl: sn-clean-rtl
 ############
 
 NONFREE_REMOTE ?= git@iis-git.ee.ethz.ch:pulp-restricted/snitch-cluster-nonfree.git
-NONFREE_COMMIT ?= refactor
+NONFREE_COMMIT ?= 41979e8257904625e45118675f72553d37f86bf4
 NONFREE_DIR = $(SN_ROOT)/nonfree
 
 .PHONY: nonfree clean-nonfree

iis-setup.sh

@@ -12,16 +12,13 @@ export SN_VERILATOR_SEPP=oseda
 export SN_QUESTA_SEPP=questa-2023.4
 export SN_LLVM_BINROOT=/usr/scratch2/vulcano/colluca/tools/riscv32-snitch-llvm-almalinux8-15.0.0-snitch-0.2.0/bin
 
-# Create Python virtual environment with required packages
-/usr/local/anaconda3-2023.07/bin/python -m venv .venv
-source .venv/bin/activate
-# Install local packages in editable mode and unpack packages in a
-# local temporary directory which can be safely cleaned after installation.
-# Also protects against "No space left on device" errors
-# occurring when the /tmp folder is filled by other processes.
-mkdir tmp
-TMPDIR=tmp pip install -e .[all]
-rm -rf tmp
-
 # Add simulator binaries to PATH
 export PATH=$PWD/target/sim/build/bin:$PATH
+
+# We use `uv` for managing python dependencies and environments
+export SN_UV="/usr/local/uv/uv run --all-extras"
+# Setting the path is only necessary for manual `uv run` commands
+export PATH=$PATH:/usr/local/uv
+# Copy instead link packages from global cache, since the cache is typically
+# located on a different file system (e.g. your home directory).
+export UV_LINK_MODE=copy

make/common.mk

@@ -20,8 +20,9 @@ SN_BIN_DIR    = $(SN_TARGET_DIR)/sim/build/bin
 SN_WORK_DIR   = $(SN_TARGET_DIR)/sim/build/work
 
 # External executables
-SN_BENDER	      ?= bender
-SN_PEAKRDL        ?= peakrdl
+SN_BENDER         ?= bender
+SN_UV             ?=
+SN_PEAKRDL        ?= $(SN_UV) peakrdl
 SN_VERIBLE_FMT    ?= verible-verilog-format
 SN_CLANG_FORMAT   ?= clang-format
 SN_RISCV_MC       ?= $(SN_LLVM_BINROOT)/llvm-mc
@@ -96,7 +97,7 @@ endef
 define sn_cluster_gen_rule
 $(1): $(SN_CFG) $(SN_CLUSTER_GEN) $(SN_CLUSTER_GEN_SRC) $(2) | $(call sn_normalize_dir,$(dir $(1)))
 	@echo "[CLUSTERGEN] Generate $$@"
-	$(SN_CLUSTER_GEN) -c $$< -o $$@ --template $(2)
+	$(SN_UV) $(SN_CLUSTER_GEN) -c $$< -o $$@ --template $(2)
 endef
 
 # Common rule to generate a Makefile with RTL source and header
@@ -125,5 +126,5 @@ endef
 # Usage:
 #   $(call sn_include_deps)
 define sn_include_deps
-$(eval $(if $(strip $(MAKECMDGOALS)),$(shell list-dependent-make-targets -M -r $(SN_DEPS))))
+$(eval $(if $(strip $(MAKECMDGOALS)),$(shell $(SN_UV) list-dependent-make-targets -M -r $(SN_DEPS))))
 endef

make/rtl.mk

@@ -47,7 +47,7 @@ $(SN_BOOTROM_ELF) $(SN_BOOTROM_DUMP) $(SN_BOOTROM_BIN) $(SN_BOOTROM): $(SN_BOOTR
 	$(SN_RISCV_CC) -mabi=ilp32d -march=rv32imafd -static -nostartfiles -fuse-ld=$(SN_RISCV_LD) -L$(SN_ROOT)/sw/runtime -T$(SN_BOOTROM_DIR)/bootrom.ld $< -o $(SN_BOOTROM_ELF)
 	$(SN_RISCV_OBJDUMP) -d $(SN_BOOTROM_ELF) > $(SN_BOOTROM_DUMP)
 	$(SN_RISCV_OBJCOPY) -j .text -O binary $(SN_BOOTROM_ELF) $(SN_BOOTROM_BIN)
-	$(SN_BOOTROM_GEN) --sv-module snitch_bootrom $(SN_BOOTROM_BIN) > $(SN_BOOTROM)
+	$(SN_UV) $(SN_BOOTROM_GEN) --sv-module snitch_bootrom $(SN_BOOTROM_BIN) > $(SN_BOOTROM)
 
 # General RTL targets
 .PHONY: sn-rtl sn-clean-rtl

make/traces.mk

@@ -46,19 +46,19 @@ sn-clean-visual-trace:
 	rm -f $(SN_VISUAL_TRACE)
 
 $(addprefix $(SN_LOGS_DIR)/,trace_hart_%.txt hart_%_perf.json dma_%_perf.json): $(SN_LOGS_DIR)/trace_hart_%.dasm $(SN_GENTRACE_PY) $(SN_GENTRACE_SRC)
-	$(SN_GENTRACE_PY) $< $(SN_GENTRACE_PY_FLAGS) --dma-trace $(SN_SIM_DIR)/dma_trace_$*_00000.log --dump-hart-perf $(SN_LOGS_DIR)/hart_$*_perf.json --dump-dma-perf $(SN_LOGS_DIR)/dma_$*_perf.json -o $(SN_LOGS_DIR)/trace_hart_$*.txt
+	$(SN_UV) $(SN_GENTRACE_PY) $< $(SN_GENTRACE_PY_FLAGS) --dma-trace $(SN_SIM_DIR)/dma_trace_$*_00000.log --dump-hart-perf $(SN_LOGS_DIR)/hart_$*_perf.json --dump-dma-perf $(SN_LOGS_DIR)/dma_$*_perf.json -o $(SN_LOGS_DIR)/trace_hart_$*.txt
 
 # Generate source-code interleaved traces for all harts
 $(SN_LOGS_DIR)/trace_hart_%.s: $(SN_LOGS_DIR)/trace_hart_%.txt $(SN_ANNOTATE_PY) $(SN_ANNOTATE_SRC)
-	$(SN_ANNOTATE_PY) $(SN_ANNOTATE_FLAGS) -o $@ $(SN_BINARY) $<
+	$(SN_UV) $(SN_ANNOTATE_PY) $(SN_ANNOTATE_FLAGS) -o $@ $(SN_BINARY) $<
 $(SN_LOGS_DIR)/trace_hart_%.diff: $(SN_LOGS_DIR)/trace_hart_%.txt $(SN_ANNOTATE_PY) $(SN_ANNOTATE_SRC)
-	$(SN_ANNOTATE_PY) $(SN_ANNOTATE_FLAGS) -o $@ $(SN_BINARY) $< -d
+	$(SN_UV) $(SN_ANNOTATE_PY) $(SN_ANNOTATE_FLAGS) -o $@ $(SN_BINARY) $< -d
 
 $(SN_JOINT_PERF_DUMP): $(SN_PERF_DUMPS) $(SN_JOIN_PY)
-	$(SN_JOIN_PY) -i $(shell ls $(SN_LOGS_DIR)/*_perf.json) -o $@
+	$(SN_UV) $(SN_JOIN_PY) -i $(shell ls $(SN_LOGS_DIR)/*_perf.json) -o $@
 
 $(SN_ROI_DUMP): $(SN_JOINT_PERF_DUMP) $(SN_ROI_SPEC) $(SN_ROI_PY)
-	$(SN_ROI_PY) $(SN_JOINT_PERF_DUMP) $(SN_ROI_SPEC) --cfg $(SN_CFG) -o $@
+	$(SN_UV) $(SN_ROI_PY) $(SN_JOINT_PERF_DUMP) $(SN_ROI_SPEC) --cfg $(SN_CFG) -o $@
 
 $(SN_VISUAL_TRACE): $(SN_ROI_DUMP) $(SN_VISUALIZE_PY)
-	$(SN_VISUALIZE_PY) $(SN_ROI_DUMP) $(SN_VISUALIZE_PY_FLAGS) -o $@
+	$(SN_UV) $(SN_VISUALIZE_PY) $(SN_ROI_DUMP) $(SN_VISUALIZE_PY_FLAGS) -o $@

pyproject.toml

@@ -11,6 +11,7 @@ name = "snitch"
 authors = [
     {name = "Luca Colagrande", email = "colluca@iis.ee.ethz.ch"}
 ]
+requires-python = ">=3.11"
 dynamic = ["version"]
 dependencies = [
     # Alphabetically sorted.
@@ -61,6 +62,16 @@ all = [
     "snitch[kernels,docs]"
 ]
 
+[tool.uv.sources]
+torch = [
+    { index = "pytorch-cpu" },
+]
+
+[[tool.uv.index]]
+name = "pytorch-cpu"
+url = "https://download.pytorch.org/whl/cpu"
+explicit = true
+
 [tool.setuptools.package-dir]
 "snitch.dnn" = "sw/kernels/dnn"
 "snitch.blas" = "sw/kernels/blas"

sw/kernels/datagen.mk

@@ -22,4 +22,4 @@ $(dir $(DATA_H)):
 
 $(DATA_H): DATAGEN_ARGS := $($(APP)_DATAGEN_ARGS)
 $(DATA_H): $(DATAGEN_PY) $($(APP)_DATA_CFG) | $(dir $(DATA_H))
-	$< $(DATAGEN_ARGS) $@
+	$(SN_UV) $< $(DATAGEN_ARGS) $@

test/blas/gemm/test.sh

@@ -11,7 +11,7 @@ BUILD_PY=$ROOT/util/experiments/build.py
 RUN_PY=$ROOT/util/experiments/run.py
 TEST_LIST=$(pwd)/run.yaml
 CFG_FILES=$(pwd)/cfg/"*"
-CMD="$ROOT/sw/kernels/blas/gemm/scripts/verify.py \${sim_bin} \${elf} --dump-results"
+CMD="$SN_UV $ROOT/sw/kernels/blas/gemm/scripts/verify.py \${sim_bin} \${elf} --dump-results"
 
-$BUILD_PY gemm --cfg $CFG_FILES --testlist $TEST_LIST --testlist-cmd "$CMD"
-$RUN_PY $TEST_LIST --simulator vsim -j
+$SN_UV $BUILD_PY gemm --cfg $CFG_FILES --testlist $TEST_LIST --testlist-cmd "$CMD"
+$SN_UV $RUN_PY $TEST_LIST --simulator vsim -j

test/dnn/flashattention_2/test.sh

@@ -10,7 +10,7 @@ BUILD_PY=$ROOT/util/experiments/build.py
 RUN_PY=$ROOT/util/experiments/run.py
 TEST_LIST=$(pwd)/run.yaml
 CFG_FILES=$(pwd)/cfg/"*"
-CMD="$ROOT/sw/kernels/dnn/flashattention_2/scripts/verify.py \${sim_bin} \${elf} --dump-results"
+CMD="$SN_UV $ROOT/sw/kernels/dnn/flashattention_2/scripts/verify.py \${sim_bin} \${elf} --dump-results"
 
-$BUILD_PY flashattention_2 --cfg $CFG_FILES --testlist $TEST_LIST --testlist-cmd "$CMD"
-$RUN_PY $TEST_LIST --simulator vsim -j
+$SN_UV $BUILD_PY flashattention_2 --cfg $CFG_FILES --testlist $TEST_LIST --testlist-cmd "$CMD"
+$SN_UV $RUN_PY $TEST_LIST --simulator vsim -j

test/dnn/transpose/test.sh

@@ -10,7 +10,7 @@ BUILD_PY=$ROOT/util/experiments/build.py
 RUN_PY=$ROOT/util/experiments/run.py
 TEST_LIST=$(pwd)/run.yaml
 CFG_FILES=$(pwd)/cfg/"*"
-CMD="$ROOT/sw/kernels/dnn/transpose/scripts/verify.py \${sim_bin} \${elf} --dump-results"
+CMD="$SN_UV $ROOT/sw/kernels/dnn/transpose/scripts/verify.py \${sim_bin} \${elf} --dump-results"
 
-$BUILD_PY transpose --cfg $CFG_FILES --testlist $TEST_LIST --testlist-cmd "$CMD"
-$RUN_PY $TEST_LIST --simulator vsim -j
+$SN_UV $BUILD_PY transpose --cfg $CFG_FILES --testlist $TEST_LIST --testlist-cmd "$CMD"
+$SN_UV $RUN_PY $TEST_LIST --simulator vsim -j