Commit 35c59990 authored by Joshua Abraham's avatar Joshua Abraham Committed by Jonathan Corbet

docs: kvm: Fix KVM_KVMCLOCK_CTRL API doc

The KVM_KVMCLOCK_CTRL ioctl signals to supported KVM guests
that the hypervisor has paused it. Update the documentation to
reflect that the guest is notified by this API.
Signed-off-by: default avatarJoshua Abraham <sinisterpatrician@gmail.com>
Link: https://lore.kernel.org/r/20200501223624.GA25826@josh-ZenBookSigned-off-by: default avatarJonathan Corbet <corbet@lwn.net>
parent 094d6dc5
...@@ -2572,13 +2572,15 @@ list in 4.68. ...@@ -2572,13 +2572,15 @@ list in 4.68.
:Parameters: None :Parameters: None
:Returns: 0 on success, -1 on error :Returns: 0 on success, -1 on error
This signals to the host kernel that the specified guest is being paused by This ioctl sets a flag accessible to the guest indicating that the specified
userspace. The host will set a flag in the pvclock structure that is checked vCPU has been paused by the host userspace.
from the soft lockup watchdog. The flag is part of the pvclock structure that
is shared between guest and host, specifically the second bit of the flags The host will set a flag in the pvclock structure that is checked from the
soft lockup watchdog. The flag is part of the pvclock structure that is
shared between guest and host, specifically the second bit of the flags
field of the pvclock_vcpu_time_info structure. It will be set exclusively by field of the pvclock_vcpu_time_info structure. It will be set exclusively by
the host and read/cleared exclusively by the guest. The guest operation of the host and read/cleared exclusively by the guest. The guest operation of
checking and clearing the flag must an atomic operation so checking and clearing the flag must be an atomic operation so
load-link/store-conditional, or equivalent must be used. There are two cases load-link/store-conditional, or equivalent must be used. There are two cases
where the guest will clear the flag: when the soft lockup watchdog timer resets where the guest will clear the flag: when the soft lockup watchdog timer resets
itself or when a soft lockup is detected. This ioctl can be called any time itself or when a soft lockup is detected. This ioctl can be called any time
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment