Add Windows WHPX smoke CI workflow

.github/workflows/windows_ci.yml

@@ -0,0 +1,202 @@
+name: Windows CI
+on:
+  pull_request:
+  workflow_dispatch:
+    inputs:
+      run_whpx_smoke:
+        description: Run WHPX smoke tests on self-hosted runner
+        required: false
+        type: boolean
+        default: false
+      whpx_test_filter:
+        description: Optional cargo test filter for WHPX smoke
+        required: false
+        type: string
+        default: test_whpx_
+      rootfs_dir:
+        description: Optional rootfs dir path on self-hosted runner
+        required: false
+        type: string
+        default: ''
+      cleanup_rootfs:
+        description: Remove rootfs directory after smoke run
+        required: false
+        type: boolean
+        default: false
+      max_rootfs_age_hours:
+        description: Rebuild rootfs if marker age exceeds this value
+        required: false
+        type: string
+        default: '168'
+      dry_run_rootfs_decision:
+        description: Only evaluate rootfs reuse/rebuild decision and exit
+        required: false
+        type: boolean
+        default: false
+      fail_if_rootfs_rebuild:
+        description: Fail run if rootfs decision is rebuild
+        required: false
+        type: boolean
+        default: false
+      rootfs_marker_format:
+        description: Rootfs marker format/version used for reuse checks
+        required: false
+        type: string
+        default: libkrun-windows-smoke-rootfs-v1
+      compatible_rootfs_marker_formats:
+        description: Additional compatible marker formats (comma-separated)
+        required: false
+        type: string
+        default: ''
+      promote_compatible_marker:
+        description: Rewrite compatible marker to primary marker format
+        required: false
+        type: boolean
+        default: true
+
+jobs:
+  windows-build-and-tests:
+    name: Windows build and tests
+    runs-on: windows-latest
+    continue-on-error: true
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: x86_64-pc-windows-msvc
+
+      - name: Create a fake init
+        shell: pwsh
+        run: |
+          New-Item -ItemType File -Path "init/init" -Force | Out-Null
+
+      - name: Build check (Windows target)
+        run: cargo check -p utils -p polly -p devices -p vmm -p libkrun --target x86_64-pc-windows-msvc
+        continue-on-error: true
+
+      - name: Utils tests (Windows)
+        run: cargo test -p utils --target x86_64-pc-windows-msvc --lib
+        continue-on-error: true
+
+      - name: Polly tests
+        run: cargo test -p polly --target x86_64-pc-windows-msvc --lib
+        continue-on-error: true
+
+      - name: VMM tests (Windows)
+        run: cargo test -p vmm --target x86_64-pc-windows-msvc --lib
+        continue-on-error: true
+
+  windows-whpx-smoke:
+    name: Windows WHPX smoke (manual)
+    if: github.event_name == 'workflow_dispatch' && inputs.run_whpx_smoke
+    runs-on: [self-hosted, windows, hyperv]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Rust toolchain
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: x86_64-pc-windows-msvc
+
+      - name: Create a fake init
+        shell: pwsh
+        run: |
+          New-Item -ItemType File -Path "init/init" -Force | Out-Null
+
+      - name: WHPX smoke suite
+        shell: pwsh
+        run: |
+          $rootfsArgs = @()
+          $cleanupArgs = @()
+          $dryRunArgs = @()
+          $failIfRebuildArgs = @()
+          $promoteArgs = @()
+          if ("${{ inputs.rootfs_dir }}") {
+            $rootfsArgs = @("-RootfsDir", "${{ inputs.rootfs_dir }}")
+          }
+          if ("${{ inputs.cleanup_rootfs }}" -eq "true") {
+            $cleanupArgs = @("-CleanupRootfs")
+          }
+          if ("${{ inputs.dry_run_rootfs_decision }}" -eq "true") {
+            $dryRunArgs = @("-DryRunRootfsDecision")
+          }
+          if ("${{ inputs.fail_if_rootfs_rebuild }}" -eq "true") {
+            $failIfRebuildArgs = @("-FailIfRootfsRebuild")
+          }
+          if ("${{ inputs.promote_compatible_marker }}" -eq "true") {
+            $promoteArgs = @("-PromoteCompatibleMarker")
+          }
+          ./tests/windows/run_whpx_smoke.ps1 -Target x86_64-pc-windows-msvc -TestFilter "${{ inputs.whpx_test_filter }}" -LogDir "$env:RUNNER_TEMP/libkrun-whpx-smoke" -RootfsMarkerFormat "${{ inputs.rootfs_marker_format }}" -CompatibleRootfsMarkerFormats "${{ inputs.compatible_rootfs_marker_formats }}" -MaxRootfsAgeHours "${{ inputs.max_rootfs_age_hours }}" @rootfsArgs @cleanupArgs @dryRunArgs @failIfRebuildArgs @promoteArgs
+
+      - name: Publish WHPX smoke summary
+        if: always()
+        shell: pwsh
+        run: |
+          $summaryFile = "$env:RUNNER_TEMP/libkrun-whpx-smoke/summary.txt"
+          $summaryJsonFile = "$env:RUNNER_TEMP/libkrun-whpx-smoke/summary.json"
+          $phaseFile = "$env:RUNNER_TEMP/libkrun-whpx-smoke/phases.log"
+
+          if ((-not (Test-Path $summaryFile)) -and (-not (Test-Path $summaryJsonFile))) {
+            "## Windows WHPX smoke`n`nFAIL: summary artifact not found." >> $env:GITHUB_STEP_SUMMARY
+            exit 0
+          }
+
+          $summary = @{}
+          if (Test-Path $summaryJsonFile) {
+            $json = Get-Content $summaryJsonFile -Raw | ConvertFrom-Json
+            foreach ($prop in $json.PSObject.Properties) {
+              $summary[$prop.Name] = [string]$prop.Value
+            }
+          }
+          else {
+            Get-Content $summaryFile | ForEach-Object {
+              if ($_ -match "^([^=]+)=(.*)$") {
+                $summary[$matches[1]] = $matches[2]
+              }
+            }
+          }
+
+          $status = $summary["status"]
+          if (-not $status) { $status = "unknown" }
+          $icon = if ($status -eq "passed") { "OK" } else { "FAIL" }
+
+          "## Windows WHPX smoke" >> $env:GITHUB_STEP_SUMMARY
+          "" >> $env:GITHUB_STEP_SUMMARY
+          "$icon status: **$status**" >> $env:GITHUB_STEP_SUMMARY
+          "- git_sha: $($summary['git_sha'])" >> $env:GITHUB_STEP_SUMMARY
+          "- runner_name: $($summary['runner_name'])" >> $env:GITHUB_STEP_SUMMARY
+          "- runner_os: $($summary['runner_os'])" >> $env:GITHUB_STEP_SUMMARY
+          "- target: $($summary['target'])" >> $env:GITHUB_STEP_SUMMARY
+          "- filter: $($summary['test_filter'])" >> $env:GITHUB_STEP_SUMMARY
+          "- cleanup_rootfs: $($summary['cleanup_rootfs'])" >> $env:GITHUB_STEP_SUMMARY
+          "- dry_run_rootfs_decision: $($summary['dry_run_rootfs_decision'])" >> $env:GITHUB_STEP_SUMMARY
+          "- fail_if_rootfs_rebuild: $($summary['fail_if_rootfs_rebuild'])" >> $env:GITHUB_STEP_SUMMARY
+          "- rootfs_marker_format: $($summary['rootfs_marker_format'])" >> $env:GITHUB_STEP_SUMMARY
+          "- compatible_rootfs_marker_formats: $($summary['compatible_rootfs_marker_formats'])" >> $env:GITHUB_STEP_SUMMARY
+          "- promote_compatible_marker: $($summary['promote_compatible_marker'])" >> $env:GITHUB_STEP_SUMMARY
+          "- max_rootfs_age_hours: $($summary['max_rootfs_age_hours'])" >> $env:GITHUB_STEP_SUMMARY
+          "- rootfs_reused: $($summary['rootfs_reused'])" >> $env:GITHUB_STEP_SUMMARY
+          "- rootfs_action: $($summary['rootfs_action'])" >> $env:GITHUB_STEP_SUMMARY
+          "- rootfs_reuse_reason: $($summary['rootfs_reuse_reason'])" >> $env:GITHUB_STEP_SUMMARY
+          "- marker_promoted: $($summary['marker_promoted'])" >> $env:GITHUB_STEP_SUMMARY
+          "- log: $($summary['log_path'])" >> $env:GITHUB_STEP_SUMMARY
+          "" >> $env:GITHUB_STEP_SUMMARY
+
+          if (Test-Path $phaseFile) {
+            "<details><summary>Phase timeline</summary>" >> $env:GITHUB_STEP_SUMMARY
+            "" >> $env:GITHUB_STEP_SUMMARY
+            "```text" >> $env:GITHUB_STEP_SUMMARY
+            Get-Content $phaseFile | ForEach-Object { $_ >> $env:GITHUB_STEP_SUMMARY }
+            "```" >> $env:GITHUB_STEP_SUMMARY
+            "</details>" >> $env:GITHUB_STEP_SUMMARY
+          }
+
+      - name: Upload WHPX smoke logs
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: windows-whpx-smoke-logs
+          path: ${{ runner.temp }}/libkrun-whpx-smoke
+          if-no-files-found: ignore

.gitignore

@@ -18,3 +18,5 @@ examples/consoles
 examples/rootfs_fedora
 test-prefix
 /linux-sysroot
+
+.claude/settings.local.json

AUTHORS

@@ -28,3 +28,4 @@ Teoh Han Hui <teohhanhui@gmail.com>
 Tyler Fanelli <tfanelli@redhat.com>
 Wainer dos Santos Moschetta <wainersm@redhat.com>
 Zalan Blenessy <zalan.blenessy@gmail.com>
+Roy Lin <linzhixiao1996@gmail.com>

Cargo.toml

@@ -9,3 +9,6 @@ resolver = "2"
 [profile.release]
 #panic = "abort"
 lto = true
+
+[patch.crates-io]
+vm-memory = { path = "third_party/vm-memory" }

README.md

@@ -6,7 +6,7 @@
 
 # libkrun
 
-```libkrun``` is a dynamic library that allows programs to easily acquire the ability to run processes in a partially isolated environment using [KVM](https://www.kernel.org/doc/Documentation/virtual/kvm/api.txt) Virtualization on Linux and [HVF](https://developer.apple.com/documentation/hypervisor) on macOS/ARM64.
+```libkrun``` is a dynamic library that allows programs to easily acquire the ability to run processes in a partially isolated environment using [KVM](https://www.kernel.org/doc/Documentation/virtual/kvm/api.txt) Virtualization on Linux, [HVF](https://developer.apple.com/documentation/hypervisor) on macOS/ARM64, and [WHPX](https://learn.microsoft.com/en-us/virtualization/api/) on Windows x86_64.
 
 It integrates a VMM (Virtual Machine Monitor, the userspace side of an Hypervisor) with the minimum amount of emulated devices required to its purpose, abstracting most of the complexity that comes from Virtual Machine management, offering users a simple C API.
 
@@ -44,7 +44,7 @@ Each variant generates a dynamic library with a different name (and ```soname```
 
 ## Virtio device support
 
-### All variants
+### Linux and macOS
 
 * virtio-console
 * virtio-block
@@ -56,6 +56,15 @@ Each variant generates a dynamic library with a different name (and ```soname```
 * virtio-rng
 * virtio-snd
 
+### Windows (x86_64)
+
+* virtio-console
+* virtio-block
+* virtio-net (via TcpStream backend)
+* virtio-vsock (via Named Pipe backend; no TSI; DGRAM support)
+* virtio-balloon (free-page reporting)
+* virtio-rng
+
 ## Networking
 
 In ```libkrun```, networking is provided by two different, mutually exclusive techniques: **virtio-vsock + TSI** and **virtio-net + passt/gvproxy**.
@@ -225,25 +234,46 @@ A suitable sysroot is automatically generated by the Makefile from Debian reposi
 sudo make [FEATURE_OPTIONS] install
 ```
 
-### Windows (Experimental)
-- Windows 10 2004+ or Windows 11
-- Hyper-V enabled
-- WinHvPlatform API support
-- Architectures: x86_64, aarch64
+### Windows (x86_64, Experimental)
 
-### Building for Windows
+> **Status**: Early development. Linux kernels boot through early console output. Full
+> userspace boot is not yet supported (interrupt injection is not yet implemented).
 
-Cross-compile from Linux/macOS:
-```bash
-cargo build --target x86_64-pc-windows-msvc --release
-cargo build --target aarch64-pc-windows-msvc --release
+#### Requirements
+
+* Windows 10 version 2004 or later, or Windows 11
+* **Windows Hypervisor Platform** enabled (Settings → Optional Features, or `DISM /Online /Enable-Feature /FeatureName:HypervisorPlatform`)
+* A working [Rust](https://www.rust-lang.org/) toolchain with the `x86_64-pc-windows-msvc` target (`rustup target add x86_64-pc-windows-msvc`)
+* MSVC build tools (Visual Studio Build Tools 2019 or later)
+
+#### Compiling
+
+```powershell
+cargo build -p libkrun --target x86_64-pc-windows-msvc --release
 ```
 
-Native build on Windows:
+#### Running smoke tests
+
 ```powershell
-cargo build --release
+# Requires Windows Hypervisor Platform; must use --test-threads=1
+cargo test -p vmm --target x86_64-pc-windows-msvc --lib -- test_whpx_ --ignored --test-threads=1
 ```
 
+#### API differences from Linux/macOS
+
+| API | Windows equivalent |
+|-----|--------------------|
+| `krun_add_net_unixstream` | `krun_add_net` (TcpStream address) |
+| `krun_add_vsock_port` | `krun_add_vsock_port_windows` (Named Pipe name) |
+| `krun_add_disk` | same |
+
+#### Known limitations
+
+* x86_64 only (no ARM64/WHPX support on Windows)
+* virtio-fs, virtio-gpu, and virtio-snd are not supported
+* TSI (Transparent Socket Impersonation) is not supported; vsock uses Windows Named Pipes
+* No interrupt injection yet — guest kernel stalls after early boot output
+
 ## Using the library
 
 Despite being written in Rust, this library provides a simple C API defined in [include/libkrun.h](include/libkrun.h)