KVM: nVMX: Remove stale comment from nested_vmx_load_cr3()
diff mbox series

Message ID 20200204153259.16318-1-sean.j.christopherson@intel.com
State New
Headers show
Series
  • KVM: nVMX: Remove stale comment from nested_vmx_load_cr3()
Related show

Commit Message

Sean Christopherson Feb. 4, 2020, 3:32 p.m. UTC
The blurb pertaining to the return value of nested_vmx_load_cr3() no
longer matches reality, remove it entirely as the behavior it is
attempting to document is quite obvious when reading the actual code.

Signed-off-by: Sean Christopherson <sean.j.christopherson@intel.com>
---
 arch/x86/kvm/vmx/nested.c | 2 --
 1 file changed, 2 deletions(-)

Comments

Vitaly Kuznetsov Feb. 4, 2020, 4:15 p.m. UTC | #1
Sean Christopherson <sean.j.christopherson@intel.com> writes:

> The blurb pertaining to the return value of nested_vmx_load_cr3() no
> longer matches reality, remove it entirely as the behavior it is
> attempting to document is quite obvious when reading the actual code.

"And if it doesn't seem that obvious just try staring at it for a few
years, do some small (60-70 patches) refactorings and fix several dozens
of bugs. It will." :-)

>
> Signed-off-by: Sean Christopherson <sean.j.christopherson@intel.com>
> ---
>  arch/x86/kvm/vmx/nested.c | 2 --
>  1 file changed, 2 deletions(-)
>
> diff --git a/arch/x86/kvm/vmx/nested.c b/arch/x86/kvm/vmx/nested.c
> index 7608924ee8c1..0c9b847f7a25 100644
> --- a/arch/x86/kvm/vmx/nested.c
> +++ b/arch/x86/kvm/vmx/nested.c
> @@ -1076,8 +1076,6 @@ static bool nested_cr3_valid(struct kvm_vcpu *vcpu, unsigned long val)
>  /*
>   * Load guest's/host's cr3 at nested entry/exit. nested_ept is true if we are
>   * emulating VM entry into a guest with EPT enabled.
> - * Returns 0 on success, 1 on failure. Invalid state exit qualification code
> - * is assigned to entry_failure_code on failure.
>   */
>  static int nested_vmx_load_cr3(struct kvm_vcpu *vcpu, unsigned long cr3, bool nested_ept,
>  			       u32 *entry_failure_code)

Reviewed-by: Vitaly Kuznetsov <vkuznets@redhat.com>
Krish Sadhukhan Feb. 4, 2020, 7:57 p.m. UTC | #2
On 2/4/20 7:32 AM, Sean Christopherson wrote:
> The blurb pertaining to the return value of nested_vmx_load_cr3() no
> longer matches reality, remove it entirely as the behavior it is
> attempting to document is quite obvious when reading the actual code.
>
> Signed-off-by: Sean Christopherson <sean.j.christopherson@intel.com>
> ---
>   arch/x86/kvm/vmx/nested.c | 2 --
>   1 file changed, 2 deletions(-)
>
> diff --git a/arch/x86/kvm/vmx/nested.c b/arch/x86/kvm/vmx/nested.c
> index 7608924ee8c1..0c9b847f7a25 100644
> --- a/arch/x86/kvm/vmx/nested.c
> +++ b/arch/x86/kvm/vmx/nested.c
> @@ -1076,8 +1076,6 @@ static bool nested_cr3_valid(struct kvm_vcpu *vcpu, unsigned long val)
>   /*
>    * Load guest's/host's cr3 at nested entry/exit. nested_ept is true if we are
>    * emulating VM entry into a guest with EPT enabled.
> - * Returns 0 on success, 1 on failure. Invalid state exit qualification code
> - * is assigned to entry_failure_code on failure.
>    */
>   static int nested_vmx_load_cr3(struct kvm_vcpu *vcpu, unsigned long cr3, bool nested_ept,
>   			       u32 *entry_failure_code)

I think it's worth keeping the last part which is " Exit qualification 
code is assigned to entry_failure_code on failure." because "Entry 
Failure" and "Exit Qualification" might sound bit confusing until you 
actually look at the caller nested_vmx_enter_non_root_mode().
Sean Christopherson Feb. 4, 2020, 8:36 p.m. UTC | #3
On Tue, Feb 04, 2020 at 11:57:39AM -0800, Krish Sadhukhan wrote:
> 
> On 2/4/20 7:32 AM, Sean Christopherson wrote:
> >The blurb pertaining to the return value of nested_vmx_load_cr3() no
> >longer matches reality, remove it entirely as the behavior it is
> >attempting to document is quite obvious when reading the actual code.
> >
> >Signed-off-by: Sean Christopherson <sean.j.christopherson@intel.com>
> >---
> >  arch/x86/kvm/vmx/nested.c | 2 --
> >  1 file changed, 2 deletions(-)
> >
> >diff --git a/arch/x86/kvm/vmx/nested.c b/arch/x86/kvm/vmx/nested.c
> >index 7608924ee8c1..0c9b847f7a25 100644
> >--- a/arch/x86/kvm/vmx/nested.c
> >+++ b/arch/x86/kvm/vmx/nested.c
> >@@ -1076,8 +1076,6 @@ static bool nested_cr3_valid(struct kvm_vcpu *vcpu, unsigned long val)
> >  /*
> >   * Load guest's/host's cr3 at nested entry/exit. nested_ept is true if we are
> >   * emulating VM entry into a guest with EPT enabled.
> >- * Returns 0 on success, 1 on failure. Invalid state exit qualification code
> >- * is assigned to entry_failure_code on failure.
> >   */
> >  static int nested_vmx_load_cr3(struct kvm_vcpu *vcpu, unsigned long cr3, bool nested_ept,
> >  			       u32 *entry_failure_code)
> 
> I think it's worth keeping the last part which is " Exit qualification code
> is assigned to entry_failure_code on failure." because "Entry Failure" and
> "Exit Qualification" might sound bit confusing until you actually look at
> the caller nested_vmx_enter_non_root_mode().

Hmm, something like this?

/*
 * Load guest's/host's cr3 at nested entry/exit.  @nested_ept is true if we are
 * emulating VM-Entry into a guest with EPT enabled.  On failure, the expected
 * Exit Qualification (for a VM-Entry consistency check VM-Exit) is assigned to
 * @entry_failure_code.
 */
Krish Sadhukhan Feb. 4, 2020, 10:01 p.m. UTC | #4
On 02/04/2020 12:36 PM, Sean Christopherson wrote:
> On Tue, Feb 04, 2020 at 11:57:39AM -0800, Krish Sadhukhan wrote:
>> On 2/4/20 7:32 AM, Sean Christopherson wrote:
>>> The blurb pertaining to the return value of nested_vmx_load_cr3() no
>>> longer matches reality, remove it entirely as the behavior it is
>>> attempting to document is quite obvious when reading the actual code.
>>>
>>> Signed-off-by: Sean Christopherson <sean.j.christopherson@intel.com>
>>> ---
>>>   arch/x86/kvm/vmx/nested.c | 2 --
>>>   1 file changed, 2 deletions(-)
>>>
>>> diff --git a/arch/x86/kvm/vmx/nested.c b/arch/x86/kvm/vmx/nested.c
>>> index 7608924ee8c1..0c9b847f7a25 100644
>>> --- a/arch/x86/kvm/vmx/nested.c
>>> +++ b/arch/x86/kvm/vmx/nested.c
>>> @@ -1076,8 +1076,6 @@ static bool nested_cr3_valid(struct kvm_vcpu *vcpu, unsigned long val)
>>>   /*
>>>    * Load guest's/host's cr3 at nested entry/exit. nested_ept is true if we are
>>>    * emulating VM entry into a guest with EPT enabled.
>>> - * Returns 0 on success, 1 on failure. Invalid state exit qualification code
>>> - * is assigned to entry_failure_code on failure.
>>>    */
>>>   static int nested_vmx_load_cr3(struct kvm_vcpu *vcpu, unsigned long cr3, bool nested_ept,
>>>   			       u32 *entry_failure_code)
>> I think it's worth keeping the last part which is " Exit qualification code
>> is assigned to entry_failure_code on failure." because "Entry Failure" and
>> "Exit Qualification" might sound bit confusing until you actually look at
>> the caller nested_vmx_enter_non_root_mode().
> Hmm, something like this?
>
> /*
>   * Load guest's/host's cr3 at nested entry/exit.  @nested_ept is true if we are
>   * emulating VM-Entry into a guest with EPT enabled.  On failure, the expected
>   * Exit Qualification (for a VM-Entry consistency check VM-Exit) is assigned to
>   * @entry_failure_code.
>   */
It  works.

With that,

Reviewed-by: Krish Sadhukhan <krish.sadhukhan@oracle.com>
Paolo Bonzini Feb. 5, 2020, 2:31 p.m. UTC | #5
On 04/02/20 23:01, Krish Sadhukhan wrote:
>>
>> /*
>>   * Load guest's/host's cr3 at nested entry/exit.  @nested_ept is true
>> if we are
>>   * emulating VM-Entry into a guest with EPT enabled.  On failure, the
>> expected
>>   * Exit Qualification (for a VM-Entry consistency check VM-Exit) is
>> assigned to
>>   * @entry_failure_code.
>>   */
> It  works.
> 
> With that,
> 
> Reviewed-by: Krish Sadhukhan <krish.sadhukhan@oracle.com>

Thanks, I folded in the change.

Paolo

Patch
diff mbox series

diff --git a/arch/x86/kvm/vmx/nested.c b/arch/x86/kvm/vmx/nested.c
index 7608924ee8c1..0c9b847f7a25 100644
--- a/arch/x86/kvm/vmx/nested.c
+++ b/arch/x86/kvm/vmx/nested.c
@@ -1076,8 +1076,6 @@  static bool nested_cr3_valid(struct kvm_vcpu *vcpu, unsigned long val)
 /*
  * Load guest's/host's cr3 at nested entry/exit. nested_ept is true if we are
  * emulating VM entry into a guest with EPT enabled.
- * Returns 0 on success, 1 on failure. Invalid state exit qualification code
- * is assigned to entry_failure_code on failure.
  */
 static int nested_vmx_load_cr3(struct kvm_vcpu *vcpu, unsigned long cr3, bool nested_ept,
 			       u32 *entry_failure_code)