Skip to contentSkip to conversation

KVM: x86/mmu: Use boolean returns for (S)PTE accessors

PATCH Applied Sean Christopherson 2 participants 2 messages Jan 23, 2021 – Jan 25, 2021

Subsystems (3)
lore
Share & tools
lore

Sean Christopherson

author maintainer
#0 lore raw

PATCH 1/1 KVM: x86/mmu: Use boolean returns for (S)PTE accessors

Return a 'bool' instead of an 'int' for various PTE accessors that are boolean in nature, e.g. is_shadow_present_pte(). Returning an int is goofy and potentially dangerous, e.g. if a flag being checked is moved into the upper 32 bits of a SPTE, then the compiler may silently squash the entire check since casting to an int is guaranteed to yield a return value of '0'.

Opportunistically refactor is_last_spte() so that it naturally returns a bool value instead of letting it implicitly cast 0/1 to false/true.

No functional change intended.

---
 arch/x86/kvm/mmu.h      |  2 +-
 arch/x86/kvm/mmu/spte.h | 12 ++++--------
 2 files changed, 5 insertions(+), 9 deletions(-)
arch/x86/kvm/mmu.h +1 -1
index 581925e476d6..f61e18dad2f3 100644
@@ -145,7 +145,7 @@ static inline int kvm_mmu_do_page_fault(struct kvm_vcpu *vcpu, gpa_t cr2_or_gpa,
  *
  * TODO: introduce APIs to split these two cases.
  */
-static inline int is_writable_pte(unsigned long pte)
+static inline bool is_writable_pte(unsigned long pte)
 {
 	return pte & PT_WRITABLE_MASK;
 }
arch/x86/kvm/mmu/spte.h +4 -8
index 2b3a30bd38b0..398fd1bb13a7 100644
@@ -185,23 +185,19 @@ static inline bool is_access_track_spte(u64 spte)
 	return !spte_ad_enabled(spte) && (spte & shadow_acc_track_mask) == 0;
 }
 
-static inline int is_shadow_present_pte(u64 pte)
+static inline bool is_shadow_present_pte(u64 pte)
 {
 	return (pte != 0) && !is_mmio_spte(pte);
 }
 
-static inline int is_large_pte(u64 pte)
+static inline bool is_large_pte(u64 pte)
 {
 	return pte & PT_PAGE_SIZE_MASK;
 }
 
-static inline int is_last_spte(u64 pte, int level)
+static inline bool is_last_spte(u64 pte, int level)
 {
-	if (level == PG_LEVEL_4K)
-		return 1;
-	if (is_large_pte(pte))
-		return 1;
-	return 0;
+	return (level == PG_LEVEL_4K) || is_large_pte(pte);
 }
 
 static inline bool is_executable_pte(u64 spte)
Signature · 1 line
2.30.0.280.ga3ce27912f-goog
maintainer Applied
#1 lore raw
Quoted 54 lines · Sean Christopherson

Return a 'bool' instead of an 'int' for various PTE accessors that are boolean in nature, e.g. is_shadow_present_pte(). Returning an int is goofy and potentially dangerous, e.g. if a flag being checked is moved into the upper 32 bits of a SPTE, then the compiler may silently squash the entire check since casting to an int is guaranteed to yield a return value of '0'.

Opportunistically refactor is_last_spte() so that it naturally returns a bool value instead of letting it implicitly cast 0/1 to false/true.

No functional change intended.

---
  arch/x86/kvm/mmu.h      |  2 +-
  arch/x86/kvm/mmu/spte.h | 12 ++++--------
  2 files changed, 5 insertions(+), 9 deletions(-)
arch/x86/kvm/mmu.h +1 -1
index 581925e476d6..f61e18dad2f3 100644
@@ -145,7 +145,7 @@ static inline int kvm_mmu_do_page_fault(struct kvm_vcpu *vcpu, gpa_t cr2_or_gpa,
   *
   * TODO: introduce APIs to split these two cases.
   */
-static inline int is_writable_pte(unsigned long pte)
+static inline bool is_writable_pte(unsigned long pte)
  {
  	return pte & PT_WRITABLE_MASK;
  }
arch/x86/kvm/mmu/spte.h +3 -3
index 2b3a30bd38b0..398fd1bb13a7 100644
@@ -185,23 +185,19 @@ static inline bool is_access_track_spte(u64 spte)
  	return !spte_ad_enabled(spte) && (spte & shadow_acc_track_mask) == 0;
  }
 
-static inline int is_shadow_present_pte(u64 pte)
+static inline bool is_shadow_present_pte(u64 pte)
  {
  	return (pte != 0) && !is_mmio_spte(pte);
  }
 
-static inline int is_large_pte(u64 pte)
+static inline bool is_large_pte(u64 pte)
  {
  	return pte & PT_PAGE_SIZE_MASK;
  }
 
-static inline int is_last_spte(u64 pte, int level)
+static inline bool is_last_spte(u64 pte, int level)

arch/x86/kvm/mmu/spte.h static inline bool is_access_track_spte(u64 spte) · line 203

Quoted 10 lines
arch/x86/kvm/mmu/spte.h +1 -5
  {
-	if (level == PG_LEVEL_4K)
-		return 1;
-	if (is_large_pte(pte))
-		return 1;
-	return 0;
+	return (level == PG_LEVEL_4K) || is_large_pte(pte);
  }
 
  static inline bool is_executable_pte(u64 spte)

Queued, thanks.

Paolo