Re: [PATCH] kvm: correct comment description issue

[Sean Christopherson <seanjc@google.com>]

"KVM: VMX:" for the scope.  A more specific shortlog would also be helfpul, stating
that a comment is being modified doesn't provide any info about what comment.

On Fri, Feb 18, 2022, Peng Hao wrote:
> loaded_vmcs does not have this field 'vcpu', modify this comment.

It would be helpful to state that loaded_vmcs has 'cpu', not 'vcpu'.  It's hard to
identify what's being changed.


Something like this?

  KVM: VMX: Fix typos above smp_wmb() comment in __loaded_vmcs_clear()

  Fix a comment documenting the memory barrier related to clearing a
  loaded_vmcs; loaded_vmcs tracks the host CPU the VMCS is loaded on via
  the field 'cpu', it doesn't have a 'vcpu' field.

With a tweaked shortlog/changelog (doesn't have to be exactly the above),

Reviewed-by: Sean Christopherson <seanjc@google.com>

> Signed-off-by: Peng Hao <flyingpeng@tencent.com>
> ---
>  arch/x86/kvm/vmx/vmx.c | 8 ++++----
>  1 file changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/arch/x86/kvm/vmx/vmx.c b/arch/x86/kvm/vmx/vmx.c
> index 7dce746c175f..0ffcfe54eea5 100644
> --- a/arch/x86/kvm/vmx/vmx.c
> +++ b/arch/x86/kvm/vmx/vmx.c
> @@ -644,10 +644,10 @@ static void __loaded_vmcs_clear(void *arg)
>  
>  	/*
>  	 * Ensure all writes to loaded_vmcs, including deleting it from its
> -	 * current percpu list, complete before setting loaded_vmcs->vcpu to
> -	 * -1, otherwise a different cpu can see vcpu == -1 first and add
> -	 * loaded_vmcs to its percpu list before it's deleted from this cpu's
> -	 * list. Pairs with the smp_rmb() in vmx_vcpu_load_vmcs().
> +	 * current percpu list, complete before setting loaded_vmcs->cpu to
> +	 * -1, otherwise a different cpu can see loaded_vmcs->cpu == -1 first
> +	 * and add loaded_vmcs to its percpu list before it's deleted from this
> +	 * cpu's list. Pairs with the smp_rmb() in vmx_vcpu_load_vmcs().
>  	 */
>  	smp_wmb();
>  
> -- 
> 2.27.0
>