Skip to content

Commit 35c5999

Browse files
jabedudeJonathan Corbet
authored andcommitted
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: Joshua Abraham <[email protected]> Link: https://lore.kernel.org/r/20200501223624.GA25826@josh-ZenBook Signed-off-by: Jonathan Corbet <[email protected]>
1 parent 094d6dc commit 35c5999

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

Documentation/virt/kvm/api.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2572,13 +2572,15 @@ list in 4.68.
25722572
:Parameters: None
25732573
:Returns: 0 on success, -1 on error
25742574

2575-
This signals to the host kernel that the specified guest is being paused by
2576-
userspace. The host will set a flag in the pvclock structure that is checked
2577-
from the soft lockup watchdog. The flag is part of the pvclock structure that
2578-
is shared between guest and host, specifically the second bit of the flags
2575+
This ioctl sets a flag accessible to the guest indicating that the specified
2576+
vCPU has been paused by the host userspace.
2577+
2578+
The host will set a flag in the pvclock structure that is checked from the
2579+
soft lockup watchdog. The flag is part of the pvclock structure that is
2580+
shared between guest and host, specifically the second bit of the flags
25792581
field of the pvclock_vcpu_time_info structure. It will be set exclusively by
25802582
the host and read/cleared exclusively by the guest. The guest operation of
2581-
checking and clearing the flag must an atomic operation so
2583+
checking and clearing the flag must be an atomic operation so
25822584
load-link/store-conditional, or equivalent must be used. There are two cases
25832585
where the guest will clear the flag: when the soft lockup watchdog timer resets
25842586
itself or when a soft lockup is detected. This ioctl can be called any time

0 commit comments

Comments
 (0)