v1.0.0

.github/workflows/ci-build-sw.yml → .github/workflows/linker-unit-test.yml

@@ -18,30 +18,35 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 # ##################################################################################################
 
-name: CI Build SW
+name: Linker unit testing
 
 on:
+  push:
+    branches:
+    - main
+    - dev
   pull_request:
 
 jobs:
-  build:
-    runs-on: ubuntu-22.04
+  linker_unit_tests:
+    runs-on: ubuntu-24.04
     permissions: { contents: read }
 
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v6
 
-      - name: Install build tools
-        run: |
-          sudo apt-get update -qq
-          sudo apt-get install -y build-essential linux-headers-$(uname -r) libxml2-dev libzmq3-dev libjsoncpp-dev
+      - name: Setup python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.10"
+          cache: "pip"
 
-      - name: Build hotplug driver
-        if: ${{ false }}
-        run: |
-          cd ${{ github.workspace }}/submodules/pcie-hotplug-drv/ && make
+      - name: Install required packages
+        run: pip install -r requirements.txt
 
-      - name: Build linker
-        run: |
-          cd ${{ github.workspace }}/submodules/v80-vitis-flow && cmake . && make
+      - name: Run unit tests
+        run: cd linker && pytest
+
+      - name: Check formatting
+        run: cd linker && autopep8 -r --diff --exit-code --exclude 'slashkit/resources/*' slashkit/ test/

.github/workflows/vrt-unit-test.yml

@@ -0,0 +1,72 @@
+# ##################################################################################################
+#  The MIT License (MIT)
+#  Copyright (c) 2025 Advanced Micro Devices, Inc. All rights reserved.
+# 
+#  Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+#  and associated documentation files (the "Software"), to deal in the Software without restriction,
+#  including without limitation the rights to use, copy, modify, merge, publish, distribute,
+#  sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+# 
+#  The above copyright notice and this permission notice shall be included in all copies or
+#  substantial portions of the Software.
+# 
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+# NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+# ##################################################################################################
+
+name: VRT unit testing
+
+on:
+  push:
+    branches:
+    - main
+    - dev
+  pull_request:
+
+jobs:
+  vrt_unit_tests:
+    runs-on: ubuntu-24.04
+    permissions: { contents: read }
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+        with: 
+          submodules: "true"
+
+      - name: Install dependencies
+        run: |
+          sudo apt install -y cmake pkg-config ninja-build \
+          libxml2-dev libzmq3-dev libjsoncpp-dev zlib1g-dev \
+          libsystemd-dev libinih-dev libcli11-dev lcov python3-zmq
+
+      - name: Build and run VRT unit tests
+        run: |
+          mkdir vrt/build
+          cd vrt/build
+          cmake -DVRT_INCLUDE_VRTD=1 -DVRTD_INCLUDE_LIBSLASH=1 -DVRT_BUILD_TESTS=1 -DENABLE_COVERAGE=1 ..
+          make unit_tests -j$(nproc)
+          cd tests && ctest --output-on-failure
+
+      - name: Generate coverage report
+        run: |
+          cd vrt/build
+          lcov --capture --directory . --output-file coverage.info \
+            --ignore-errors mismatch --ignore-errors negative
+          lcov --remove coverage.info \
+            '/usr/*' '*/build/_deps/*' '*/vrtd/*' '*/tests/*' \
+            --output-file coverage.filtered.info \
+            --ignore-errors unused
+          genhtml coverage.filtered.info --output-directory coverage-report
+          lcov --list coverage.filtered.info
+
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v4
+        with:
+          name: vrt-coverage-report
+          path: vrt/build/coverage-report/
+

.github/workflows/vrtd-unit-test.yml

@@ -0,0 +1,72 @@
+# ##################################################################################################
+#  The MIT License (MIT)
+#  Copyright (c) 2025-2026 Advanced Micro Devices, Inc. All rights reserved.
+#
+#  Permission is hereby granted, free of charge, to any person obtaining a copy of this software
+#  and associated documentation files (the "Software"), to deal in the Software without restriction,
+#  including without limitation the rights to use, copy, modify, merge, publish, distribute,
+#  sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
+#  furnished to do so, subject to the following conditions:
+#
+#  The above copyright notice and this permission notice shall be included in all copies or
+#  substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
+# NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+# DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+# ##################################################################################################
+
+name: VRTD unit testing
+
+on:
+  push:
+    branches:
+    - main
+    - dev
+  pull_request:
+
+jobs:
+  vrtd_unit_tests:
+    runs-on: ubuntu-24.04
+    permissions: { contents: read }
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+        with:
+          submodules: "true"
+
+      - name: Install dependencies
+        run: |
+          sudo apt update
+          sudo apt install -y cmake pkg-config ninja-build \
+          libsystemd-dev libinih-dev lcov
+
+      - name: Build and run VRTD unit tests
+        run: |
+          mkdir vrt/vrtd/build
+          cd vrt/vrtd/build
+          cmake -DVRTD_BUILD_TESTS=1 -DVRTD_INCLUDE_LIBSLASH=1 -DENABLE_COVERAGE=1 ..
+          make unit_tests -j$(nproc)
+          export LD_LIBRARY_PATH=$(pwd)/libslash/src/:$LD_LIBRARY_PATH
+          cd tests && ctest --output-on-failure
+
+      - name: Generate coverage report
+        run: |
+          cd vrt/vrtd/build
+          lcov --capture --directory . --output-file coverage.info \
+            --ignore-errors mismatch --ignore-errors negative
+          lcov --remove coverage.info \
+            '/usr/*' '*/build/_deps/*' '*/tests/*' \
+            --output-file coverage.filtered.info \
+            --ignore-errors unused
+          genhtml coverage.filtered.info --output-directory coverage-report
+          lcov --list coverage.filtered.info
+
+      - name: Upload coverage report
+        uses: actions/upload-artifact@v4
+        with:
+          name: vrtd-coverage-report
+          path: vrt/vrtd/build/coverage-report/

.gitignore

@@ -53,5 +53,34 @@ Thumbs.db
 *~
 *.Xil
 !build_all.sh
+!build_bsp.sh
 
 .clang-format
+.cache
+**/linker_results/
+**/linker_results_*/
+
+__pycache__/
+*.pyc
+.venv/
+
+# Kernel module kcompat probe scratch (driver/kcompat/probe.sh)
+driver/kcompat/.scratch/
+
+# Build files for package
+/pbuild/
+/rpmbuild/
+/debian/
+
+# Output files for package
+/deb/
+/rpm/
+
+# VBIN build directories
+*.prj
+
+# Python virtual environment
+.venv
+
+# Python test coverage
+.coverage

.gitmodules

@@ -1,6 +1,6 @@
 [submodule "submodules/qdma_drv"]
 	path = submodules/qdma_drv
 	url = https://github.com/Xilinx/dma_ip_drivers.git
-[submodule "submodules/v80-vitis-flow/submodules/aved"]
-	path = submodules/v80-vitis-flow/submodules/aved
+[submodule "AVED"]
+	path = submodules/AVED
 	url = https://github.com/Xilinx/AVED.git

.readthedocs.yaml

@@ -24,9 +24,9 @@
 version: 2
 
 build:
-   os: ubuntu-20.04
+   os: ubuntu-24.04
    tools:
-      python: "3.8"
+      python: "3.12"
    apt_packages:
       - graphviz
 
@@ -39,4 +39,4 @@ sphinx:
 
 python:
    install:
-    - requirements: docs/requirements.txt
+    - requirements: docs/requirements.txt