[PATCH 1/2] KVM: fix documentation rendering for KVM_CAP_VM_MOVE_ENC_CONTEXT_FROM

[PATCH 1/2] KVM: fix documentation rendering for KVM_CAP_VM_MOVE_ENC_CONTEXT_FROM

[Julian Stecklina]

The documentation for KVM_CAP_VM_MOVE_ENC_CONTEXT_FROM doesn't use the
correct keyword formatting, which breaks rendering on
https://www.kernel.org/doc/html/latest/virt/kvm/api.html.

Signed-off-by: Julian Stecklina <julian.stecklina@cyberus-technology.de>
---
 Documentation/virt/kvm/api.rst | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/Documentation/virt/kvm/api.rst b/Documentation/virt/kvm/api.rst
index 0b5a33ee71ee..2d45b21b0288 100644
--- a/Documentation/virt/kvm/api.rst
+++ b/Documentation/virt/kvm/api.rst
@@ -7895,10 +7895,10 @@ perform a bulk copy of tags to/from the guest.
 7.29 KVM_CAP_VM_MOVE_ENC_CONTEXT_FROM
 -------------------------------------
 
-Architectures: x86 SEV enabled
-Type: vm
-Parameters: args[0] is the fd of the source vm
-Returns: 0 on success
+:Architectures: x86 SEV enabled
+:Type: vm
+:Parameters: args[0] is the fd of the source vm
+:Returns: 0 on success
 
 This capability enables userspace to migrate the encryption context from the VM
 indicated by the fd to the VM this is called on.
-- 
2.44.0

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

[Julian Stecklina]

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@cyberus-technology.de>
---
 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.
 
 7.23 KVM_CAP_PPC_DAWR1
 ----------------------
-- 
2.44.0

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

[Sean Christopherson]

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@cyberus-technology.de>
> ---
>  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@suse.de

Re: [PATCH 1/2] KVM: fix documentation rendering for KVM_CAP_VM_MOVE_ENC_CONTEXT_FROM

[Sean Christopherson]

On Mon, 20 May 2024 16:32:18 +0200, Julian Stecklina wrote:
> The documentation for KVM_CAP_VM_MOVE_ENC_CONTEXT_FROM doesn't use the
> correct keyword formatting, which breaks rendering on
> https://www.kernel.org/doc/html/latest/virt/kvm/api.html.
> 
> 

Applied patch 1 to kvm-x86 generic, thanks!

[1/2] KVM: fix documentation rendering for KVM_CAP_VM_MOVE_ENC_CONTEXT_FROM
      https://github.com/kvm-x86/linux/commit/f2362c04752c
[2/2] KVM: fix spelling of KVM_RUN_X86_BUS_LOCK in docs
      (not applied)
--
https://github.com/kvm-x86/linux/tree/next