Merge branch 'master' into max_dev

.github/workflows/build_docs.yaml

@@ -0,0 +1,38 @@
+# A work-flow for generating documentation given a PR
+# Builds Sphinx documentation, uploads the generated HTML files as artefacts and deploys them to GitHub Pages
+name: Build docs
+
+# It runs on every pull request, but it only generates the documentation from master (which makes sense)
+on:
+  pull_request:
+    branches:
+    - master
+
+jobs:
+  sphinx-build:
+    # Target platform; mostly doesn't matter for HTML websites generated from Sphinx
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v4
+
+    # 1) Build HTML from Sphinx
+    - name: Build HTML
+      uses: ammaraskar/[email protected]
+      with:
+        pre-build-command: "apt install -y pandoc"
+
+    # 2) Upload the generated HTML
+    - name: Upload artifacts
+      uses: actions/upload-artifact@v3
+      with:
+        name: html-docs
+        path: docs/build/html/
+
+    # 3) Deploy using GitHub pages, but only if the branch == master
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      if: github.ref == 'refs/heads/master'
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: docs/build/html

.github/workflows/build_static.yml → .github/workflows/build_static.yaml

@@ -5,31 +5,34 @@ on:
     branches:
     - master
 
-  workflow_dispatch:
+defaults:
+  run:
+    shell: bash -ileo pipefail {0} 
 
 jobs:
-
   build_perf_local:
-    runs-on: self-hosted
+    environment: fpga-synth
+    runs-on: [self-hosted, linux, x64]
 
     steps:
     - uses: actions/checkout@v3
 
-    - name: Compile HW Perf Local Example
+    - name: Compile hardware for Perf Local Example
       run: |
+        source ~/.bashrc && vivado -version
         mkdir examples_hw/build_perf_local && cd examples_hw/build_perf_local
-        /usr/bin/cmake ../ -DFDEV_NAME=u55c -DEXAMPLE=static -DEN_XTERM=0
+        cmake ../ -DFDEV_NAME=u55c -DEXAMPLE=static -DEN_XTERM=0
         make project && make bitgen
     
-    - name: Compile SW Perf Host Example
+    - name: Compile software for Perf Local Example
       run: |
         mkdir examples_sw/build_perf_local && cd examples_sw/build_perf_local
-        /usr/bin/cmake ../ -DEXAMPLE=perf_local
+        cmake ../ -DEXAMPLE=perf_local
         make
     
     - name: Artifact upload
       uses: actions/upload-artifact@v3
       with:
         name: bitstream-perf-local
         path: examples_hw/build_perf_local/bitstreams
-        retention-days: 5
+        retention-days: 3

.github/workflows/compile_driver.yaml

@@ -0,0 +1,21 @@
+# A work-flow for compiling the Coyote driver; for now, we are testing on Ubuntu 20.04
+# This checks no extreme breaking changes were done in the driver, i.e. at least it compiles
+name: Compile driver
+
+# Run on every pull request change, makes dev and PR reviews easier
+on:
+  pull_request:
+    branches:
+    - master
+
+jobs:
+  compile-driver:
+    runs-on: ubuntu-20.04
+
+    steps:
+    - uses: actions/checkout@v4
+
+    # We do some additional logging, just so that we can back-trace the Linux / Ubuntu version
+    - name: Compile driver
+      run:
+        cd driver && uname -r && lsb_release -a && make

.github/workflows/compile_software.yaml

@@ -0,0 +1,150 @@
+# A work-flow for compiling the Coyote software examples; for now, we are testing on Ubuntu 20.04
+# This checks no extreme breaking changes were done in the examples & software, i.e. at least it compiles
+name: Compile software
+
+# Run on every pull request update, makes dev and PR reviews easier
+on:
+  pull_request:
+    branches:
+    - master
+
+jobs:
+  compile-kmeans:
+    runs-on: ubuntu-20.04
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Environment set-up
+      run:
+        mkdir examples_sw/build && sudo apt-get install libboost-all-dev
+
+    - name: Compile kmeans
+      run:
+        cd examples_sw/build && cmake ../ -DEXAMPLE=kmeans -DVERBOSITY=ON && make
+
+  compile-multi-threading:
+    runs-on: ubuntu-20.04
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Environment set-up
+      run:
+        mkdir examples_sw/build && sudo apt-get install libboost-all-dev
+
+    - name: Compile multi-threading
+      run:
+        cd examples_sw/build && cmake ../ -DEXAMPLE=multithreading -DVERBOSITY=ON && make
+
+  compile-perf-fpga:
+    runs-on: ubuntu-20.04
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Environment set-up
+      run:
+        mkdir examples_sw/build && sudo apt-get install libboost-all-dev
+
+    - name: Compile perf FPGA
+      run:
+        cd examples_sw/build && cmake ../ -DEXAMPLE=perf_fpga -DVERBOSITY=ON && make
+
+  compile-perf-local:
+    runs-on: ubuntu-20.04
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Environment set-up
+      run:
+        mkdir examples_sw/build && sudo apt-get install libboost-all-dev
+
+    - name: Compile perf local
+      run:
+        cd examples_sw/build && cmake ../ -DEXAMPLE=perf_local -DVERBOSITY=ON && make
+
+  compile-reconfigure-shell:
+    runs-on: ubuntu-20.04
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Environment set-up
+      run:
+        mkdir examples_sw/build && sudo apt-get install libboost-all-dev
+
+    - name: Compile reconfigure shell
+      run:
+        cd examples_sw/build && cmake ../ -DEXAMPLE=reconfigure_shell -DVERBOSITY=ON && make
+
+  compile-streaming-client:
+    runs-on: ubuntu-20.04
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Environment set-up
+      run:
+        mkdir examples_sw/build && sudo apt-get install libboost-all-dev
+
+    - name: Compile streaming client
+      run:
+        cd examples_sw/build && cmake ../ -DEXAMPLE=streaming_client -DVERBOSITY=ON && make
+
+  compile-streaming-server:
+    runs-on: ubuntu-20.04
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Environment set-up
+      run:
+        mkdir examples_sw/build && sudo apt-get install libboost-all-dev
+
+    - name: Compile streaming server
+      run:
+        cd examples_sw/build && cmake ../ -DEXAMPLE=streaming_server -DVERBOSITY=ON && make
+
+  compile-tcp-benchmark:
+    runs-on: ubuntu-20.04
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Environment set-up
+      run:
+        mkdir examples_sw/build && sudo apt-get install libboost-all-dev
+
+    - name: Compile TCP benchmark
+      run:
+        cd examples_sw/build && cmake ../ -DEXAMPLE=tcp_iperf -DVERBOSITY=ON && make
+
+  compile-rdma-client:
+    runs-on: ubuntu-20.04
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Environment set-up
+      run:
+        mkdir examples_sw/build && sudo apt-get install libboost-all-dev
+
+    - name: Compile RDMA client
+      run:
+        cd examples_sw/build && cmake ../ -DEXAMPLE=rdma_client -DVERBOSITY=ON && make
+
+  compile-rdma-server:  
+    runs-on: ubuntu-20.04
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Environment set-up
+      run:
+        mkdir examples_sw/build && sudo apt-get install libboost-all-dev
+
+    - name: Compile RDMA server
+      run:
+        cd examples_sw/build && cmake ../ -DEXAMPLE=rdma_server -DVERBOSITY=ON && make

.gitignore

@@ -46,3 +46,5 @@ misc/
 *_funcsim.vhdl
 *.upgrade_log
 *.d
+*.DS_Store
+*.venv