Skip to content

Conversation

@bchalios
Copy link
Contributor

@bchalios bchalios commented Dec 5, 2025

Changes

Implement snapshot safety features for VMClock device as described in this Linux patchset: https://lore.kernel.org/lkml/[email protected]/.

Expose the vm_generation_counter field in the vmclock_abi. Also, implement the notification feature. This simply means that during snapshot resume we bump vm_gneration_counter and inject an interrupt to the guest before resuming vCPUs.

Reason

Provide a means for the guest userspace to know that the microVM has been loaded from a snpahost

License Acceptance

By submitting this pull request, I confirm that my contribution is made under
the terms of the Apache 2.0 license. For more information on following Developer
Certificate of Origin and signing off your commits, please check
CONTRIBUTING.md.

PR Checklist

  • I have read and understand CONTRIBUTING.md.
  • I have run tools/devtool checkbuild --all to verify that the PR passes
    build checks on all supported architectures.
  • I have run tools/devtool checkstyle to verify that the PR passes the
    automated style checks.
  • I have described what is done in these changes, why they are needed, and
    how they are solving the problem in a clear and encompassing way.
  • I have updated any relevant documentation (both in code and in the docs)
    in the PR.
  • I have mentioned all user-facing changes in CHANGELOG.md.
  • If a specific issue led to this PR, this PR closes the issue.
  • When making API changes, I have followed the
    Runbook for Firecracker API changes.
  • I have tested all new and changed functionalities in unit tests and/or
    integration tests.
  • I have linked an issue to every new TODO.

  • This functionality cannot be added in rust-vmm.

@bchalios bchalios marked this pull request as draft December 5, 2025 11:15
@codecov
Copy link

codecov bot commented Dec 5, 2025

Codecov Report

❌ Patch coverage is 91.04478% with 6 lines in your changes missing coverage. Please review.
✅ Project coverage is 83.24%. Comparing base (5baa588) to head (99d68b0).

Files with missing lines Patch % Lines
src/vmm/src/devices/acpi/vmclock.rs 87.09% 4 Missing ⚠️
src/vmm/src/arch/aarch64/fdt.rs 91.66% 1 Missing ⚠️
src/vmm/src/device_manager/persist.rs 80.00% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##             main    #5564   +/-   ##
=======================================
  Coverage   83.23%   83.24%           
=======================================
  Files         277      277           
  Lines       29265    29310   +45     
=======================================
+ Hits        24359    24399   +40     
- Misses       4906     4911    +5     
Flag Coverage Δ
5.10-m5n.metal 83.57% <90.90%> (+<0.01%) ⬆️
5.10-m6a.metal 82.91% <90.90%> (+<0.01%) ⬆️
5.10-m6g.metal 80.28% <88.46%> (+0.09%) ⬆️
5.10-m6i.metal 83.57% <90.90%> (+<0.01%) ⬆️
5.10-m7a.metal-48xl 82.90% <90.90%> (+<0.01%) ⬆️
5.10-m7g.metal 80.28% <88.46%> (+0.09%) ⬆️
5.10-m7i.metal-24xl 83.54% <90.90%> (+<0.01%) ⬆️
5.10-m7i.metal-48xl 83.54% <90.90%> (+<0.01%) ⬆️
5.10-m8g.metal-24xl 80.28% <88.46%> (+0.09%) ⬆️
5.10-m8g.metal-48xl 80.28% <88.46%> (+0.09%) ⬆️
6.1-m5n.metal 83.60% <90.90%> (+<0.01%) ⬆️
6.1-m6a.metal 82.93% <90.90%> (-0.01%) ⬇️
6.1-m6g.metal 80.27% <88.46%> (+0.09%) ⬆️
6.1-m6i.metal 83.60% <90.90%> (+<0.01%) ⬆️
6.1-m7a.metal-48xl 82.93% <90.90%> (+<0.01%) ⬆️
6.1-m7g.metal 80.28% <88.46%> (+0.09%) ⬆️
6.1-m7i.metal-24xl 83.61% <90.90%> (+<0.01%) ⬆️
6.1-m7i.metal-48xl 83.61% <90.90%> (-0.01%) ⬇️
6.1-m8g.metal-24xl 80.27% <88.46%> (+0.09%) ⬆️
6.1-m8g.metal-48xl 80.28% <88.46%> (+0.09%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@bchalios bchalios force-pushed the vmclock-snapsafe branch 8 times, most recently from 5487e22 to 115a1d6 Compare December 10, 2025 15:26
Add support for vm_generation_counter and notifications.

Keep this separately for now, since currently upstream bindings don't
include it.

We will recreate this for Linux headers once they are released.

Signed-off-by: Babis Chalios <[email protected]>
Add support for `vm_generation_counter` field in VMClock ABI. This field
is similar to `disruption_marker` but it's only updated on snapshot
loading events (not in live migration). It is meant to provide the guest
with snapshot safety notifications.

Moreover, add support for the notification capability. This capability
require us to send an ACPI notification every time we change the
seq_count field to a new even value. This essentially means that we need
to send a notification upon resuming from a snapshot just before
resuming vCPUs.

Signed-off-by: Babis Chalios <[email protected]>
Extend VMClock integration tests to also account for the
vm_generation_counter field and notification support flag.

Signed-off-by: Babis Chalios <[email protected]>
Expose VMClock device to guest via DT and enable compiling the vmclock
for ARM architectures.

Keep VMClock tests only on x86 until we get support from the guest
kernel.

Signed-off-by: Babis Chalios <[email protected]>
Add support to apply patches while build kernels for our CI. For the
time being we use this to apply patches for snapshot safety VMClock
extensions [1] (backported to 5.10 and 6.1 AL kernels).

[1] https://lkml.org/lkml/2025/12/3/653

Signed-off-by: Babis Chalios <[email protected]>
Enable CONFIG_PTP_1588_CLOCK_VMCLOCK for both 5.10 and 6.1 kernels

Signed-off-by: Babis Chalios <[email protected]>
We now apply backported patches that add support for VMClock on Aarch64
systems via DT bindings, so enable tests for Aarch64 as well.

Moreover, backported patches add support for the poll() system calls
family, so enable the relevant test.

Signed-off-by: Babis Chalios <[email protected]>
pub const VMCLOCK_FLAG_TIME_ESTERROR_VALID: u64 = 32;
pub const VMCLOCK_FLAG_TIME_MAXERROR_VALID: u64 = 64;
pub const VMCLOCK_FLAG_TIME_MONOTONIC: u64 = 128;
pub const VMCLOCK_FLAG_VM_GEN_COUNTER_PRESENT: u64 = 256;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we add this to our bindgen patches?

Comment on lines +203 to +207
# Undo any patches previsouly applied, so that we can build the same kernel with different
# configs, e.g. no-acpi
git reset --hard $(get_tag $KERNEL_VERSION)
git clean -f -d

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we just create a temporary branch for the build? iow replace

- git checkout $(get_tag $KERNEL_VERSION)
+ git checkout -B tmp $(get_tag $KERNEL_VERSION)

# Enable PHYLIB and NETWORK_PHY_TIMESTAMPING to see the additional clocks.
#
CONFIG_PTP_1588_CLOCK_KVM=y
CONFIG_PTP_1588_CLOCK_VMCLOCK=y
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should have this in our patches on top of this base config, otherwise we risk removing these when we rebase the config.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants