[Milestone] memdomain virtualisation

.github/workflows/pr.yml

@@ -17,37 +17,41 @@ jobs:
           echo "🔎 Branch: ${{ github.head_ref }} -> ${{ github.base_ref }}"
           echo "🔎 Repository: ${{ github.repository }}"
 
-      - name: Pull from the repository
+      # - uses: actions/checkout@v4
+      # - uses: DeterminateSystems/determinate-nix-action@v3
+
+      - name: Reset to clean state
         shell: zsh {0}
         run: |
-          source ~/.zshrc
-          buckyball_exec
-          setproxy
-          git fetch origin +refs/pull/${{ github.event.pull_request.number }}/head:refs/remotes/origin/pr/${{ github.event.pull_request.number }}
+          cd ~/Code/buckyball
+          git fetch origin
           git clean -fd
-          git reset --hard ${{ github.sha }}
+          git checkout ${{ github.head_ref }}
+
+      - name: Nix build
+        shell: zsh {0}
+        run: |
+          cd ~/Code/buckyball
+          nix build
 
       - name: Build Workloads
         shell: zsh {0}
         run: |
-          source ~/.zshrc
-          buckyball_exec
-          bbdev workload --build
+          cd ~/Code/buckyball
+          nix develop -c bbdev workload --build
 
       - name: Build Verilator
         shell: zsh {0}
         run: |
-          source ~/.zshrc
-          buckyball_exec
-          bbdev verilator --clean
-          bbdev verilator --verilog
-          bbdev verilator --build '--jobs 16'
+          cd ~/Code/buckyball
+          nix develop -c bbdev verilator --clean
+          nix develop -c bbdev verilator --verilog '--config sims.verilator.BuckyballToyVerilatorConfig'
+          nix develop -c bbdev verilator --build '--jobs 16'
 
       - name: Smoke Test
         shell: zsh {0}
         run: |
-          source ~/.zshrc
-          buckyball_exec
-          bbdev sardine --run '--workload ctest'
+          cd ~/Code/buckyball
+          nix develop -c bbdev sardine --run '--workload ctest'
 
       - run: echo "🍏 PR Test is ${{ job.status }}."

.gitignore

@@ -4,6 +4,9 @@
 .motia/
 .cursor/
 .bsp/
+out/
+result
+
 CLAUDE.local.md
 node_modules/
 env.sh

.gitmodules

@@ -4,24 +4,18 @@
 [submodule "arch/thirdparty/chipyard"]
 	path = arch/thirdparty/chipyard
 	url = https://github.com/ucb-bar/chipyard.git
-[submodule "workflow/vscode"]
-	path = workflow/vscode
-	url = https://github.com/DangoSys/buckyball-vscode.git
-[submodule "thirdparty/picker"]
-	path = thirdparty/picker
-	url = https://github.com/XS-MLVP/picker.git
-[submodule "bebop/host/gem5/gem5"]
-	path = bebop/host/gem5/gem5
-	url = https://github.com/gem5/gem5.git
-[submodule "bebop/host/spike/riscv-isa-sim"]
-	path = bebop/host/spike/riscv-isa-sim
-	url = https://github.com/riscv-software-src/riscv-isa-sim
-[submodule "tools/palladium"]
-	path = tools/palladium
-	url = https://github.com/SEU-ACAL/awesome-palladium.git
 [submodule "compiler"]
 	path = compiler
 	url = https://github.com/DangoSys/bb-compiler.git
 [submodule "arch/thirdparty/t1"]
 	path = arch/thirdparty/t1
 	url = https://github.com/DangoSys/t1.git
+[submodule "bebop"]
+	path = bebop
+	url = https://github.com/DangoSys/bebop.git
+[submodule "bbdev"]
+	path = bbdev
+	url = https://github.com/DangoSys/bbdev.git
+[submodule "thirdparty/palladium"]
+	path = thirdparty/palladium
+	url = https://github.com/SEU-ACAL/awesome-palladium.git

.pre-commit-config.yaml

@@ -6,14 +6,15 @@ repos:
     hooks:
       - id: clang-format
         name: clang-format C++ code
+        language: system
         files: \.(cpp|hpp|cc|cxx|h|c|hxx)$
         args: [--style=llvm]
 
   - repo: https://github.com/psf/black
     rev: 24.10.0
     hooks:
       - id: black
-        language_version: python3.10
+        language: system
 
   # a comprehensive tool for checking the style and quality of Python code.
   # It combines three popular Python tools:
@@ -24,6 +25,7 @@ repos:
     rev: 6.1.0
     hooks:
       - id: flake8
+        language: system
         args:
           - --max-line-length=120  # Adjust as per your style guide
           - --ignore=F821,F403,F405,F401,W503,E203,E402,E401,W605,E712,E711,F841
@@ -40,17 +42,22 @@ repos:
     rev: v5.0.0
     hooks:
       - id: end-of-file-fixer
+        language: system
       - id: trailing-whitespace
+        language: system
       - id: check-merge-conflict
+        language: system
       - id: check-yaml
+        language: system
       - id: check-added-large-files
+        language: system
 
-  # # Scala formatting with scalafmt
-  # - repo: local
-  #   hooks:
-  #     - id: scalafmt-check
-  #       name: Check Scala formatting with scalafmt
-  #       entry: bash -c 'cd arch && scalafmt --test'
-  #       language: system
-  #       files: ^arch/.*\.scala$
-  #       pass_filenames: false
+  # Scala formatting with scalafmt
+  - repo: local
+    hooks:
+      - id: scalafmt
+        name: Format Scala code with scalafmt
+        entry: bash -c 'cd arch && scalafmt --config .scalafmt.conf src/main/scala'
+        language: system
+        files: ^arch/src/main/scala/.*\.scala$
+        pass_filenames: false

README.md

@@ -21,63 +21,35 @@ The buckyball framework provides a complete hardware design, simulation verifica
 
 ## Quick Start
 
-### Environment Dependencies
+### Installation in Nix
+We use Nix Flake as our main build system. If you have not installed nix, install it following the [guide](https://nix.dev/manual/nix/2.28/installation/installing-binary.html), and enable flake following the [wiki](https://nixos.wiki/wiki/Flakes#Enable_flakes). Or you can try the [installer](https://github.com/DeterminateSystems/nix-installer) provided by Determinate Systems, which enables flake by default.
 
-Before getting started, please ensure your system meets the following dependency requirements:
-
-**Required Software**:
-- Anaconda/Miniconda (Python environment management)
-- Ninja Build System
-- GTKWave (waveform viewer)
-- Bash Shell environment (doesn't need to be the primary shell)
-
-**Installing Dependencies**:
-```bash
-# Install Anaconda
-# Download from: https://www.anaconda.com/download/
-
-# Install system tools
-sudo apt install ninja-build gtkwave
-
-# Optional: FireSim passwordless configuration
-# Add to /etc/sudoers: user_name ALL=(ALL) NOPASSWD:ALL
-```
-
-### Source Build
 
 **1. Clone Repository**
+
 ```bash
 git clone https://github.com/DangoSys/buckyball.git
-cd buckyball
 ```
 
 **2. Initialize Environment**
 ```bash
-./scripts/init.sh
+cd buckyball
+./scripts/nix/build-all.sh
 ```
-*Note: Initialization takes approximately 3 hours, including dependency downloads and compilation*
 
-**3. Environment Activation**
+After the first time installation, you can enter the environment anytime by running:
+
 ```bash
-source buckyball/env.sh
+nix develop
 ```
 
-**4. Verify Installation**
+**3. Verify Installation**
 
 Run Verilator simulation test to verify installation:
 ```bash
 bbdev verilator --run '--jobs 16 --binary ctest_vecunit_matmul_ones_singlecore-baremetal --config sims.verilator.BuckyballToyVerilatorConfig --batch'
 ```
 
-### Docker Quick Experience
-
-  We support providing a Docker environment for rapid deployment of buckyball.
-
-**Notice**:
-- Docker images are provided only for specific release versions.
-- Docker image may not be the latest version, source build is recommended.
-
-> We do not provide support for this version as it is not a stable release.
 
 ### Buckyball as a library
   We support providing a streamlined version of buckyball installation, integrated as a generator within Chipyard.
@@ -88,7 +60,7 @@ bbdev verilator --run '--jobs 16 --binary ctest_vecunit_matmul_ones_singlecore-b
 > We do not provide support for this version as it is not a stable release.
 
 
-## Quick Tutorial
+## Tutorial
 You can start to learn ball and blink from [here](https://github.com/DangoSys/buckyball/blob/main/docs/bb-note/src/tutorial/tutorial.md)
 
 ## Additional Resources

arch/.mill-version

@@ -1 +1 @@
-0.11.4
+0.11.12

arch/.scalafmt.conf

@@ -1,8 +1,8 @@
 version = 2.6.4
 
-# Exclude thirdparty directory from formatting
-project.excludeFilters = [
-  "thirdparty"
+# Only format src/main/scala directory
+project.includeFilters = [
+  "src/main/scala/.*\\.scala$"
 ]
 
 # Basic formatting

arch/build.sbt

@@ -1,7 +1,7 @@
 // See README.md for license details.
 
-val chisel6Version = "6.5.0"
-val chiselTestVersion = "6.0.0"
+val chisel6Version         = "6.5.0"
+val chiselTestVersion      = "6.0.0"
 val scalaVersionFromChisel = "2.13.12"
 
 // Fix for scalafix undefined setting
@@ -19,11 +19,11 @@ lazy val chisel6Settings = Seq(
 lazy val chiselSettings = chisel6Settings ++ Seq(
   libraryDependencies ++= Seq(
     "org.apache.commons" % "commons-lang3" % "3.12.0",
-    "org.apache.commons" % "commons-text" % "1.9"
+    "org.apache.commons" % "commons-text"  % "1.9"
   )
 )
 
-lazy val scalaTestSettings =  Seq(
+lazy val scalaTestSettings = Seq(
   libraryDependencies ++= Seq(
     "org.scalatest" %% "scalatest" % "3.2.+" % "test"
   )
@@ -34,19 +34,18 @@ lazy val scalaTestSettings =  Seq(
 // ------------------------------------------------------------------------------
 lazy val chipyard = ProjectRef(file("thirdparty/chipyard"), "chipyard")
 lazy val firechip = ProjectRef(file("thirdparty/chipyard"), "firechip")
-
-// Palladium FPGA subproject (external reference)
-lazy val palladium = ProjectRef(file("../tools/palladium"), "palladium")
+// Palladium FPGA subproject
+lazy val palladium = ProjectRef(file("../thirdparty/palladium"), "palladium")
 
 // ------------------------------------------------------------------------------
 // Project Settings
 // ------------------------------------------------------------------------------
 lazy val buckyball = (project in file("."))
   .dependsOn(chipyard, firechip, palladium)
   .settings(
-    name := "buckyball",
+    name         := "buckyball",
     organization := "com.buckyball",
-    version := "1.0.0",
+    version      := "1.0.0",
     scalaVersion := scalaVersionFromChisel,
     scalacOptions ++= Seq(
       "-deprecation",
@@ -58,10 +57,12 @@ lazy val buckyball = (project in file("."))
       Resolver.sonatypeRepo("releases")
     ),
     chisel6Settings ++
-    scalaTestSettings ++
-    Seq(
-      libraryDependencies ++= Seq(
-        "edu.berkeley.cs" %% "rocketchip" % "1.6"
+      scalaTestSettings ++
+      Seq(
+        libraryDependencies ++= Seq(
+          "edu.berkeley.cs" %% "rocketchip" % "1.6",
+          "com.lihaoyi" %% "os-lib" % "0.10.0",
+          "com.lihaoyi" %% "upickle" % "3.3.1"
+        )
       )
-    )
   )