Re: [PATCH 2/2] KVM: fix spelling of KVM_RUN_X86_BUS_LOCK in docs

From: Sean Christopherson
Date: Mon Jun 03 2024 - 20:00:50 EST


On Mon, May 20, 2024, Julian Stecklina wrote:
> The documentation refers to KVM_RUN_BUS_LOCK, but the constant is
> actually called KVM_RUN_X86_BUS_LOCK.
>
> Signed-off-by: Julian Stecklina <julian.stecklina@xxxxxxxxxxxxxxxxxxxxx>
> ---
> Documentation/virt/kvm/api.rst | 6 +++---
> 1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
> index 2d45b21b0288..5050535140ab 100644
> --- a/Documentation/virt/kvm/api.rst
> +++ b/Documentation/virt/kvm/api.rst
> @@ -6418,7 +6418,7 @@ affect the device's behavior. Current defined flags::
> /* x86, set if the VCPU is in system management mode */
> #define KVM_RUN_X86_SMM (1 << 0)
> /* x86, set if bus lock detected in VM */
> - #define KVM_RUN_BUS_LOCK (1 << 1)
> + #define KVM_RUN_X86_BUS_LOCK (1 << 1)
> /* arm64, set for KVM_EXIT_DEBUG */
> #define KVM_DEBUG_ARCH_HSR_HIGH_VALID (1 << 0)
>
> @@ -7776,10 +7776,10 @@ its own throttling or other policy based mitigations.
> This capability is aimed to address the thread that VM can exploit bus locks to
> degree the performance of the whole system. Once the userspace enable this
> capability and select the KVM_BUS_LOCK_DETECTION_EXIT mode, KVM will set the
> -KVM_RUN_BUS_LOCK flag in vcpu-run->flags field and exit to userspace. Concerning
> +KVM_RUN_X86_BUS_LOCK flag in vcpu-run->flags field and exit to userspace. Concerning
> the bus lock vm exit can be preempted by a higher priority VM exit, the exit
> notifications to userspace can be KVM_EXIT_BUS_LOCK or other reasons.
> -KVM_RUN_BUS_LOCK flag is used to distinguish between them.
> +KVM_RUN_X86_BUS_LOCK flag is used to distinguish between them.

There's a patch[*] that does this clean-up and more, which I'm going to grab for
6.11. I am planning on grabbing patch 1 though. Thanks!

[*] https://lore.kernel.org/all/20231116133628.5976-1-clopez@xxxxxxx