Skip to contentSkip to conversation

KVM: x86/mmu: fix an incorrect comment in kvm_mmu_new_pgd

PATCH Superseded Wei Liu 2 participants 3 messages Nov 27, 2022 – Nov 28, 2022

Subsystems (3)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Wei Liu

author
#0 lore raw

PATCH 1/1 KVM: x86/mmu: fix an incorrect comment in kvm_mmu_new_pgd

There is no function named kvm_mmu_ensure_valid_pgd.

Fix the comment and remove the pair of braces to conform to Linux kernel coding style.

---
 arch/x86/kvm/mmu/mmu.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)
arch/x86/kvm/mmu/mmu.c +5 -3
index b6f96d47e596..361574124fbe 100644
@@ -4452,10 +4452,12 @@ void kvm_mmu_new_pgd(struct kvm_vcpu *vcpu, gpa_t new_pgd)
 	struct kvm_mmu *mmu = vcpu->arch.mmu;
 	union kvm_mmu_page_role new_role = mmu->root_role;
 
-	if (!fast_pgd_switch(vcpu->kvm, mmu, new_pgd, new_role)) {
-		/* kvm_mmu_ensure_valid_pgd will set up a new root.  */
+	/*
+	 * Return immediately if no usable root is found. A new root will be
+	 * set up in vcpu_enter_guest prior to the next vmenter.
+	 */
+	if (!fast_pgd_switch(vcpu->kvm, mmu, new_pgd, new_role))
 		return;
-	}
 
 	/*
 	 * It's possible that the cached previous root page is obsolete because
Signature · 1 line
2.35.1
#1 lore raw
Quoted 1 line · Wei Liu

There is no function named kvm_mmu_ensure_valid_pgd.

() when referecing functions, here and in the comment.

Quoted 13 lines

Fix the comment and remove the pair of braces to conform to Linux kernel coding style.

---
 arch/x86/kvm/mmu/mmu.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)
arch/x86/kvm/mmu/mmu.c +0 -0
index b6f96d47e596..361574124fbe 100644

arch/x86/kvm/mmu/mmu.c void kvm_mmu_new_pgd(struct kvm_vcpu *vcpu, gpa_t new_pgd) · line 4456

Quoted 7 lines
arch/x86/kvm/mmu/mmu.c +2 -2
@@ -4452,10 +4452,12 @@ void kvm_mmu_new_pgd(struct kvm_vcpu *vcpu, gpa_t new_pgd)
 	struct kvm_mmu *mmu = vcpu->arch.mmu;
 	union kvm_mmu_page_role new_role = mmu->root_role;
 
-	if (!fast_pgd_switch(vcpu->kvm, mmu, new_pgd, new_role)) {
-		/* kvm_mmu_ensure_valid_pgd will set up a new root.  */
+	/*
+	 * Return immediately if no usable root is found. A new root will be

s/is/was

And technically, it may not be a "new" root, e.g. if a different vCPU creates a usable root between now and kvm_mmu_reload().

arch/x86/kvm/mmu/mmu.c void kvm_mmu_new_pgd(struct kvm_vcpu *vcpu, gpa_t new_pgd) · line 4457

Quoted 1 line
arch/x86/kvm/mmu/mmu.c +1 -0
+	 * set up in vcpu_enter_guest prior to the next vmenter.

s/vmenter/VM-Enter

Pointing a reader at vcpu_enter_guest() isn't very helpful since that's a massive function; kvm_mmu_reload() is where the real magic happens. I generally prefer to avoid referencing functions in comments unless doing so is absolutely "necessary" because such comments always seem to become stale, but in this case I think it's worthwhile.

	/*
	 * Return immediately if no usable was found, kvm_mmu_reload() will
	 * establish a valid root prior to the next VM-Enter.
	 */
Quoted 10 lines
arch/x86/kvm/mmu/mmu.c +2 -1
+	 */
+	if (!fast_pgd_switch(vcpu->kvm, mmu, new_pgd, new_role))
 		return;
-	}
 
 	/*
 	 * It's possible that the cached previous root page is obsolete because
Signature · 1 line
2.35.1
author
#2 lore raw
Quoted 41 lines · Sean Christopherson
Quoted 1 line · Wei Liu

There is no function named kvm_mmu_ensure_valid_pgd.

() when referecing functions, here and in the comment.

Quoted 13 lines

Fix the comment and remove the pair of braces to conform to Linux kernel coding style.

---
 arch/x86/kvm/mmu/mmu.c | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)
arch/x86/kvm/mmu/mmu.c +0 -0
index b6f96d47e596..361574124fbe 100644

arch/x86/kvm/mmu/mmu.c void kvm_mmu_new_pgd(struct kvm_vcpu *vcpu, gpa_t new_pgd) · line 4456

Quoted 7 lines
arch/x86/kvm/mmu/mmu.c +2 -2
@@ -4452,10 +4452,12 @@ void kvm_mmu_new_pgd(struct kvm_vcpu *vcpu, gpa_t new_pgd)
 	struct kvm_mmu *mmu = vcpu->arch.mmu;
 	union kvm_mmu_page_role new_role = mmu->root_role;
 
-	if (!fast_pgd_switch(vcpu->kvm, mmu, new_pgd, new_role)) {
-		/* kvm_mmu_ensure_valid_pgd will set up a new root.  */
+	/*
+	 * Return immediately if no usable root is found. A new root will be

s/is/was

And technically, it may not be a "new" root, e.g. if a different vCPU creates a usable root between now and kvm_mmu_reload().

arch/x86/kvm/mmu/mmu.c void kvm_mmu_new_pgd(struct kvm_vcpu *vcpu, gpa_t new_pgd) · line 4457

Quoted 1 line
arch/x86/kvm/mmu/mmu.c +1 -0
+	 * set up in vcpu_enter_guest prior to the next vmenter.

s/vmenter/VM-Enter

Pointing a reader at vcpu_enter_guest() isn't very helpful since that's a massive function; kvm_mmu_reload() is where the real magic happens. I generally prefer to avoid referencing functions in comments unless doing so is absolutely "necessary" because such comments always seem to become stale, but in this case I think it's worthwhile.

Quoted 5 lines
	/*
	 * Return immediately if no usable was found, kvm_mmu_reload() will
	 * establish a valid root prior to the next VM-Enter.
	 */

Thanks for the feedback. v2 coming shortly.

Thanks,
Wei.