Preview PR: Hugo docs: Add NUMA design docs

.git-blame-ignore-revs

@@ -32,6 +32,7 @@ d6ab15362548b8fe270bd14d5153b8d94e1b15c0
 b12cf444edea15da6274975e1b2ca6a7fce2a090
 364c27f5d18ab9dd31825e67a93efabecad06823
 d8b4de9076531dd13bdffa20cc10c72290a52356
+bdf06bca7534fbc0c4fc3cee3408a51a22615226
 
 # ocp-indent
 d018d26d6acd4707a23288b327b49e44f732725e

.github/workflows/1.249-lcm.yml

@@ -10,7 +10,7 @@ on:
 jobs:
   python-test:
     name: Python tests
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
     permissions:
       contents: read
     strategy:
@@ -28,7 +28,7 @@ jobs:
 
   ocaml-test:
     name: Ocaml tests
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-22.04
 
     steps:
       - name: Checkout code

.github/workflows/codechecker.yml

@@ -38,7 +38,7 @@ jobs:
           opam pin add -y dune-compiledb https://github.com/edwintorok/dune-compiledb/releases/download/0.6.0/dune-compiledb-0.6.0.tbz
 
       - name: Trim dune cache
-        run: opam exec -- dune cache trim --size=2GiB         
+        run: opam exec -- dune cache trim --size=2GiB
 
       - name: Generate compile_commands.json
         run: opam exec -- make compile_commands.json
@@ -73,7 +73,10 @@ jobs:
           name: codechecker_sarif
           path: codechecker.sarif
 
-      - name: Upload SARIF report
-        uses: github/codeql-action/upload-sarif@v3
-        with:
-         sarif_file: codechecker.sarif
+      # TODO: reenable after fixing
+      # https://github.blog/changelog/2025-07-21-code-scanning-will-stop-combining-multiple-sarif-runs-uploaded-in-the-same-sarif-file/
+      #
+      #- name: Upload SARIF report
+      #  uses: github/codeql-action/upload-sarif@v3
+      #  with:
+      #   sarif_file: codechecker.sarif

.github/workflows/docs.yml

@@ -31,15 +31,23 @@ jobs:
       - name: Update Ubuntu repositories
         run: sudo apt-get update
 
+      # We set DUNE_CACHE_STORAGE_MODE, it is required for dune cache to work inside opam for now,
+      # otherwise it gets EXDEV and considers it a cache miss
       - name: Use ocaml
-        uses: ocaml/setup-ocaml@v2
+        uses: ocaml/setup-ocaml@v3
         with:
           ocaml-compiler: ${{ steps.dotenv.outputs.ocaml_version_full }}
           opam-repositories: |
             xs-opam: ${{ steps.dotenv.outputs.repository }}
+          dune-cache: true
+          opam-pin: false
+          cache-prefix: v3-${{ steps.system-info.outputs.name }}-${{ steps.system-info.outputs.release }}
+        env:
+          DUNE_CACHE_STORAGE_MODE: copy
 
       - name: Install dependencies
-        run: opam pin list --short | xargs opam install --deps-only -v
+        shell: bash
+        run: opam install . --deps-only -v
 
       - name: Generate xapi-storage docs
         run: |

.github/workflows/generate-and-build-sdks.yml

@@ -29,17 +29,6 @@ jobs:
         shell: bash
         run: opam exec -- make sdk
 
-      # sdk-ci runs some Go unit tests.
-      # This setting ensures that SDK date time
-      # tests are run on a machine that
-      # isn't using UTC
-      - name: Set Timezone to Tokyo for datetime tests
-        run: |
-          sudo timedatectl set-timezone Asia/Tokyo
-
-      - name: Run CI for SDKs
-        uses: ./.github/workflows/sdk-ci
-
       - name: Store C SDK source
         uses: actions/upload-artifact@v4
         with:
@@ -60,7 +49,13 @@ jobs:
           name: SDK_Source_PowerShell
           path: _build/install/default/share/powershell/*
 
-      - name: Store Go SDK Artifacts
+      - name: Store Java SDK source
+        uses: actions/upload-artifact@v4
+        with:
+          name: SDK_Source_Java
+          path: _build/install/default/share/java/*
+
+      - name: Store Go SDK source
         uses: actions/upload-artifact@v4
         with:
           name: SDK_Artifacts_Go
@@ -69,11 +64,16 @@ jobs:
             !_build/install/default/share/go/dune
             !_build/install/default/share/go/**/*_test.go
 
-      - name: Store Java SDK source
-        uses: actions/upload-artifact@v4
-        with:
-          name: SDK_Source_Java
-          path: _build/install/default/share/java/*
+      # sdk-ci runs some Go unit tests.
+      # This setting ensures that SDK date time
+      # tests are run on a machine that
+      # isn't using UTC
+      - name: Set Timezone to Tokyo for datetime tests
+        run: |
+          sudo timedatectl set-timezone Asia/Tokyo
+
+      - name: Run CI for SDKs
+        uses: ./.github/workflows/sdk-ci
 
       - name: Trim dune cache
         run: opam exec -- dune cache trim --size=2GiB
@@ -188,7 +188,7 @@ jobs:
       - name: Build C# SDK
         shell: pwsh
         run: |
-          dotnet build source/src `
+          dotnet build source/src/XenServer.csproj `
           --disable-build-servers `
           --configuration Release `
           -p:Version=${{ env.XAPI_VERSION_NUMBER }}-prerelease-unsigned `
@@ -200,86 +200,12 @@ jobs:
           name: SDK_Binaries_CSharp
           path: source/src/bin/Release/XenServer.NET.${{ env.XAPI_VERSION_NUMBER }}-prerelease-unsigned.nupkg
 
-  build-powershell-5x-sdk:
-    name: Build PowerShell 5.x SDK (.NET Framework 4.5)
-    needs: build-csharp-sdk
-    # PowerShell SDK for PowerShell 5.x needs to run on windows-2019 because
-    # windows-2022 doesn't contain .NET Framework 4.x dev tools
-    runs-on: windows-2019
-    permissions:
-      contents: read
-
-    steps:
-      - name: Strip 'v' prefix from xapi version
-        shell: pwsh
-        run: echo "XAPI_VERSION_NUMBER=$("${{ inputs.xapi_version }}".TrimStart('v'))" | Out-File -FilePath $env:GITHUB_ENV -Encoding utf8 -Append
-
-      - name: Retrieve PowerShell SDK source
-        uses: actions/download-artifact@v4
-        with:
-          name: SDK_Source_PowerShell
-          path: source/
-
-      - name: Retrieve C# SDK binaries
-        uses: actions/download-artifact@v4
-        with:
-          name: SDK_Binaries_CSharp
-          path: csharp/
-
-      # Following needed for restoring packages
-      # when calling dotnet add package
-      - name: Set up dotnet CLI (.NET 6.0 and 8.0)
-        uses: actions/setup-dotnet@v4
-        with:
-          dotnet-version: |
-            6
-            8
-
-      - name: Setup project and dotnet CLI
-        shell: pwsh
-        run: |
-          dotnet nuget add source --name local ${{ github.workspace }}\csharp
-          dotnet add source/src package XenServer.NET --version ${{ env.XAPI_VERSION_NUMBER }}-prerelease-unsigned
-
-      - name: Build PowerShell SDK (.NET Framework 4.5)
-        shell: pwsh
-        run: |
-          dotnet build source/src/XenServerPowerShell.csproj `
-             --disable-build-servers `
-             --configuration Release `
-             -p:Version=${{ env.XAPI_VERSION_NUMBER }}-prerelease-unsigned `
-             -p:TargetFramework=net45 `
-             --verbosity=normal`
-
-      - name: Update SDK and PS versions in "XenServerPSModule.psd1"
-        shell: pwsh
-        run: |
-          (Get-Content "source\XenServerPSModule.psd1") -replace "@SDK_VERSION@","${{ env.XAPI_VERSION_NUMBER }}" | Set-Content -Path "source\XenServerPSModule.psd1"
-          (Get-Content "source\XenServerPSModule.psd1") -replace "@PS_VERSION@","5.0" | Set-Content -Path "source\XenServerPSModule.psd1"
-
-      - name: Move binaries to destination folder
-        shell: pwsh
-        run: |
-          New-Item -Path "." -Name "output" -ItemType "directory"
-          Copy-Item -Verbose "source\README_51.md" -Destination "output"  -Force
-          Copy-Item -Verbose "source\LICENSE" -Destination "output" -Force
-          Copy-Item -Path "source\src\bin\Release\net45\*" -Include "*.dll" "output\"
-          Get-ChildItem -Path "source" |`
-          Where-Object { $_.Extension -eq ".ps1" -or $_.Extension -eq ".ps1xml" -or $_.Extension -eq ".psd1" -or $_.Extension -eq ".txt"  } |`
-          ForEach-Object -Process { Copy-Item -Verbose $_.FullName -Destination "output" }
-
-      - name: Store PowerShell SDK (.NET Framework 4.5)
-        uses: actions/upload-artifact@v4
-        with:
-          name: SDK_Binaries_XenServerPowerShell_NET45
-          path: output/**/*
-
   build-powershell-7x-sdk:
     name: Build PowerShell 7.x SDK
     strategy:
       fail-fast: false
       matrix:
-        dotnet: ["6", "8"]
+        dotnet: ["8"]
     needs: build-csharp-sdk
     runs-on: windows-2022
     permissions:

.github/workflows/main.yml

@@ -21,14 +21,25 @@ concurrency: # On new push, cancel old workflows from the same PR, branch or tag
 jobs:
   ocaml-tests:
     name: Run OCaml tests
-    runs-on: ubuntu-22.04
+    strategy:
+      fail-fast: false
+      matrix:
+        runs-on: ["ubuntu-22.04"]
+        experimental: [false]
+        include:
+        - runs-on: "ubuntu-22.04-arm"
+          experimental: true
+
+    continue-on-error: ${{ matrix.experimental }}
+    runs-on: ${{ matrix.runs-on }}
     permissions:
       contents: read
     env:
       # Ensure you also update test-sdk-builds
       # when changing this value, to keep builds
       # consistent
       XAPI_VERSION: "v0.0.0"
+
     steps:
       - name: Checkout code
         uses: actions/checkout@v4

.github/workflows/other.yml

@@ -51,7 +51,7 @@ jobs:
       - uses: pre-commit/action@v3.0.1
         name: Run pre-commit checks (no spaces at end of lines, etc)
         with:
-          extra_args: --all-files --verbose --hook-stage commit
+          extra_args: --all-files --verbose --hook-stage pre-commit
         env:
           SKIP: no-commit-to-branch
 

.github/workflows/release.yml

@@ -83,16 +83,10 @@ jobs:
           name: SDK_Binaries_CSharp
           path: dist/
 
-      - name: Retrieve PowerShell 5.x SDK distribution artifacts
-        uses: actions/download-artifact@v4
-        with:
-          name: SDK_Binaries_XenServerPowerShell_NET45
-          path: sdk_powershell_5x/
-
       - name: Retrieve PowerShell 7.x SDK distribution artifacts
         uses: actions/download-artifact@v4
         with:
-          name: SDK_Binaries_XenServerPowerShell_NET6
+          name: SDK_Binaries_XenServerPowerShell_NET8
           path: sdk_powershell_7x/
 
       - name: Package C SDK artifacts for deployment
@@ -104,10 +98,6 @@ jobs:
           rm -rf libxenserver/usr/local/lib/
           tar -zcvf libxenserver-prerelease.src.tar.gz -C ./libxenserver/usr/local .
 
-      - name: Zip PowerShell 5.x SDK artifacts for deployment
-        shell: bash
-        run: zip PowerShell-SDK-5.x-prerelease-unsigned.zip ./sdk_powershell_5x -r
-
       - name: Zip PowerShell 7.x SDK artifacts for deployment
         shell: bash
         run: zip PowerShell-SDK-7.x-prerelease-unsigned.zip ./sdk_powershell_7x -r
@@ -120,7 +110,6 @@ jobs:
         shell: bash
         run: |
           gh release create ${{ github.ref_name }} --repo ${{ github.repository }} --generate-notes dist/* \
-          PowerShell-SDK-5.x-prerelease-unsigned.zip \
           PowerShell-SDK-7.x-prerelease-unsigned.zip \
           Go-SDK-prerelease-unsigned.zip \
           libxenserver-prerelease.tar.gz libxenserver-prerelease.src.tar.gz

.github/workflows/setup-xapi-environment/action.yml

@@ -18,7 +18,7 @@ runs:
       shell: bash
       run: |
         mkdir -p /opt/xensource/sm
-        wget -O /opt/xensource/sm/XE_SR_ERRORCODES.xml https://raw.githubusercontent.com/xapi-project/sm/master/drivers/XE_SR_ERRORCODES.xml
+        wget -O /opt/xensource/sm/XE_SR_ERRORCODES.xml https://raw.githubusercontent.com/xapi-project/sm/master/libs/sm/core/XE_SR_ERRORCODES.xml
 
     - name: Load environment file
       id: dotenv

.gitignore

@@ -6,6 +6,7 @@ _coverage/
 *.install
 *.swp
 compile_flags.txt
+_opam
 
 # tests
 xapi-db.xml

.pre-commit-config.yaml

@@ -13,7 +13,7 @@
 ## For manually executing the pre-push hook:
 # pre-commit run -av --hook-stage pre-push
 #
-default_stages: [commit, push]
+default_stages: [pre-commit, pre-push]
 default_language_version:
     python: python3.11
 repos:
@@ -68,7 +68,7 @@ repos:
         entry: env PYTHONDEVMODE=yes sh -c 'coverage run && coverage xml &&
             coverage html && coverage report &&
             diff-cover --ignore-whitespace --compare-branch=origin/master
-            --show-uncovered --html-report .git/coverage-diff.html
+            --show-uncovered --format html:.git/coverage-diff.html
             --fail-under 50 .git/coverage3.11.xml'
         require_serial: true
         pass_filenames: false
@@ -108,7 +108,7 @@ repos:
     hooks:
     -   id: pylint
         files: python3/
-        stages: [push]
+        stages: [pre-push]
         name: check that changes to python3 tree pass pylint
         entry: diff-quality --violations=pylint
             --ignore-whitespace --compare-branch=origin/master
@@ -134,7 +134,7 @@ repos:
         entry: python3 pytype_reporter.py
         pass_filenames: false
         types: [python]
-        stages: [push]
+        stages: [pre-push]
         verbose: true
         # This hook runs locally only when Python files change:
         language: python