KVM: x86: Clean up rmap zap helpers
Sean Christopherson
maintainerv2 cover KVM: x86: Clean up rmap zap helpers
Clean up the rmap helpers (mostly renames) to yield a more coherent set of APIs, and to purge the irritating and inconsistent "rmapp" (p is for pointer) nomenclature.
Patch 1 is a tangentially related fix for a benign bug.
v2:
- Split up patches into smaller, more related chunks. [Paolo]
- Reorder patches to put all renames at the end. [Paolo]
- Avoid quadruple underscores and use more consistent names. [Paolo]
v1: https://lore.kernel.org/all/[email protected]
Sean Christopherson (7):
KVM: x86/mmu: Return a u64 (the old SPTE) from
mmu_spte_clear_track_bits()
KVM: x86/mmu: Directly "destroy" PTE list when recycling rmaps
KVM: x86/mmu: Drop the "p is for pointer" from rmap helpers
KVM: x86/mmu: Rename __kvm_zap_rmaps() to align with other
nomenclature
KVM: x86/mmu: Rename rmap zap helpers to eliminate "unmap" wrapper
KVM: x86/mmu: Rename pte_list_{destroy,remove}() to show they zap
SPTEs
KVM: x86/mmu: Remove underscores from __pte_list_remove()
arch/x86/kvm/mmu/mmu.c | 74 +++++++++++++++++++++--------------------- 1 file changed, 37 insertions(+), 37 deletions(-)
base-commit: 8031d87aa9953ddeb047a5356ebd0b240c30f233
Signature · 1 line
2.37.0.170.g444d1eabd0-goog
Sean Christopherson
maintainerPATCH v2 1/7 KVM: x86/mmu: Return a u64 (the old SPTE) from mmu_spte_clear_track_bits()
Return a u64, not an int, from mmu_spte_clear_track_bits(). The return value is the old SPTE value, which is very much a 64-bit value. The sole caller that consumes the return value, drop_spte(), already uses a u64. The only reason that truncating the SPTE value is not problematic is because drop_spte() only queries the shadow-present bit, which is in the lower 32 bits.
--- arch/x86/kvm/mmu/mmu.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
arch/x86/kvm/mmu/mmu.c +1 -1
@@ -529,7 +529,7 @@ static bool mmu_spte_update(u64 *sptep, u64 new_spte)* state bits, it is used to clear the last level sptep. * Returns the old PTE. */ -static int mmu_spte_clear_track_bits (struct kvm *kvm,u64 *sptep) +static u64 mmu_spte_clear_track_bits (struct kvm *kvm,u64 *sptep) {kvm_pfn_t pfn;u64 old_spte = *sptep;
Signature · 1 line
2.37.0.170.g444d1eabd0-goog
Sean Christopherson
maintainerPATCH v2 2/7 KVM: x86/mmu: Directly "destroy" PTE list when recycling rmaps
In reply to Sean ChristophersonUse pte_list_destroy() directly when recycling rmaps instead of bouncing through kvm_unmap_rmapp() and kvm_zap_rmapp(). Calling kvm_unmap_rmapp() is unnecessary and odd as it requires passing dummy parameters; passing NULL for @slot when __rmap_add() already has a valid slot is especially weird and confusing.
No functional change intended.
--- arch/x86/kvm/mmu/mmu.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
arch/x86/kvm/mmu/mmu.c +1 -1
@@ -1596,7 +1596,7 @@ static void __rmap_add(struct kvm *kvm, rmap_count =pte_list_add (cache, spte, rmap_head);if (rmap_count >RMAP_RECYCLE_THRESHOLD ) { -kvm_unmap_rmapp (kvm, rmap_head,NULL , gfn, sp->role.level,__pte (0 )); +pte_list_destroy (kvm, rmap_head);kvm_flush_remote_tlbs_with_address ( kvm, sp->gfn,KVM_PAGES_PER_HPAGE (sp->role.level)); }
Signature · 1 line
2.37.0.170.g444d1eabd0-goog
Sean Christopherson
maintainerPATCH v2 3/7 KVM: x86/mmu: Drop the "p is for pointer" from rmap helpers
In reply to Sean ChristophersonDrop the trailing "p" from rmap helpers, i.e. rename functions to simply be kvm_<action>_rmap(). Declaring that a function takes a pointer is completely unnecessary and goes against kernel style.
No functional change intended.
--- arch/x86/kvm/mmu/mmu.c | 43 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 22 deletions(-)
arch/x86/kvm/mmu/mmu.c +21 -22
@@ -403,7 +403,7 @@ static u64 __update_clear_spte_slow(u64 *sptep, u64 spte)* The idea using the light way get the spte on x86_32 guest is from * gup_get_pte (mm/gup.c). * -* An spte tlb flush may be pending, because kvm_set_pte_rmapp +* An spte tlb flush may be pending, because kvm_set_pte_rmap * coalesces them and we are running out of the MMU lock. Therefore * we need to protect against in-progress updates of the spte. *
@@ -1383,22 +1383,22 @@ static bool kvm_vcpu_write_protect_gfn(struct kvm_vcpu *vcpu, u64 gfn)return kvm_mmu_slot_gfn_write_protect (vcpu->kvm, slot, gfn,PG_LEVEL_4K ); } -static bool kvm_zap_rmapp (struct kvm *kvm,struct kvm_rmap_head *rmap_head, -const struct kvm_memory_slot *slot) +static bool kvm_zap_rmap (struct kvm *kvm,struct kvm_rmap_head *rmap_head, +const struct kvm_memory_slot *slot) {return pte_list_destroy (kvm, rmap_head); } -static bool kvm_unmap_rmapp (struct kvm *kvm,struct kvm_rmap_head *rmap_head, -struct kvm_memory_slot *slot,gfn_t gfn,int level, -pte_t unused) +static bool kvm_unmap_rmap (struct kvm *kvm,struct kvm_rmap_head *rmap_head, +struct kvm_memory_slot *slot,gfn_t gfn,int level, +pte_t unused) { -return kvm_zap_rmapp (kvm, rmap_head, slot); +return kvm_zap_rmap (kvm, rmap_head, slot); } -static bool kvm_set_pte_rmapp (struct kvm *kvm,struct kvm_rmap_head *rmap_head, -struct kvm_memory_slot *slot,gfn_t gfn,int level, -pte_t pte) +static bool kvm_set_pte_rmap (struct kvm *kvm,struct kvm_rmap_head *rmap_head, +struct kvm_memory_slot *slot,gfn_t gfn,int level, +pte_t pte) {u64 *sptep;struct rmap_iterator iter;
@@ -1529,7 +1529,7 @@ bool kvm_unmap_gfn_range(struct kvm *kvm, struct kvm_gfn_range *range)bool flush = false;if (kvm_memslots_have_rmaps (kvm)) - flush =kvm_handle_gfn_range (kvm, range, kvm_unmap_rmapp); + flush =kvm_handle_gfn_range (kvm, range, kvm_unmap_rmap);if (is_tdp_mmu_enabled (kvm)) flush =kvm_tdp_mmu_unmap_gfn_range (kvm, range, flush);
@@ -1542,7 +1542,7 @@ bool kvm_set_spte_gfn(struct kvm *kvm, struct kvm_gfn_range *range)bool flush = false;if (kvm_memslots_have_rmaps (kvm)) - flush =kvm_handle_gfn_range (kvm, range, kvm_set_pte_rmapp); + flush =kvm_handle_gfn_range (kvm, range, kvm_set_pte_rmap);if (is_tdp_mmu_enabled (kvm)) flush |=kvm_tdp_mmu_set_spte_gfn (kvm, range);
@@ -1550,9 +1550,9 @@ bool kvm_set_spte_gfn(struct kvm *kvm, struct kvm_gfn_range *range)return flush; } -static bool kvm_age_rmapp (struct kvm *kvm,struct kvm_rmap_head *rmap_head, -struct kvm_memory_slot *slot,gfn_t gfn,int level, -pte_t unused) +static bool kvm_age_rmap (struct kvm *kvm,struct kvm_rmap_head *rmap_head, +struct kvm_memory_slot *slot,gfn_t gfn,int level, +pte_t unused) {u64 *sptep;struct rmap_iterator iter;
@@ -1564,9 +1564,9 @@ static bool kvm_age_rmapp(struct kvm *kvm, struct kvm_rmap_head *rmap_head,return young; } -static bool kvm_test_age_rmapp (struct kvm *kvm,struct kvm_rmap_head *rmap_head, -struct kvm_memory_slot *slot,gfn_t gfn, -int level,pte_t unused) +static bool kvm_test_age_rmap (struct kvm *kvm,struct kvm_rmap_head *rmap_head, +struct kvm_memory_slot *slot,gfn_t gfn, +int level,pte_t unused) {u64 *sptep;struct rmap_iterator iter;
@@ -1615,7 +1615,7 @@ bool kvm_age_gfn(struct kvm *kvm, struct kvm_gfn_range *range)bool young = false;if (kvm_memslots_have_rmaps (kvm)) - young =kvm_handle_gfn_range (kvm, range, kvm_age_rmapp); + young =kvm_handle_gfn_range (kvm, range, kvm_age_rmap);if (is_tdp_mmu_enabled (kvm)) young |=kvm_tdp_mmu_age_gfn_range (kvm, range);
@@ -1628,7 +1628,7 @@ bool kvm_test_age_gfn(struct kvm *kvm, struct kvm_gfn_range *range)bool young = false;if (kvm_memslots_have_rmaps (kvm)) - young =kvm_handle_gfn_range (kvm, range, kvm_test_age_rmapp); + young =kvm_handle_gfn_range (kvm, range, kvm_test_age_rmap);if (is_tdp_mmu_enabled (kvm)) young |=kvm_tdp_mmu_test_age_gfn (kvm, range);
@@ -6004,8 +6004,7 @@ static bool __kvm_zap_rmaps(struct kvm *kvm, gfn_t gfn_start, gfn_t gfn_end)if (WARN_ON_ONCE (start >= end))continue ; - flush =slot_handle_level_range (kvm, memslot, kvm_zap_rmapp, - + flush =slot_handle_level_range (kvm, memslot, kvm_zap_rmap,PG_LEVEL_4K ,KVM_MAX_HUGEPAGE_LEVEL , start, end -1 , true, flush); }
Signature · 1 line
2.37.0.170.g444d1eabd0-goog
Sean Christopherson
maintainerPATCH v2 4/7 KVM: x86/mmu: Rename __kvm_zap_rmaps() to align with other nomenclature
In reply to Sean ChristophersonRename __kvm_zap_rmaps() to kvm_rmap_zap_gfn_range() to avoid future confusion with a soon-to-be-introduced __kvm_zap_rmap(). Using a plural "rmaps" is somewhat ambiguous without additional context, as it's not obvious whether it's referring to multiple rmap lists, versus multiple rmap entries within a single list.
Use kvm_rmap_zap_gfn_range() to align with the pattern established by kvm_rmap_zap_collapsible_sptes(), without losing the information that it zaps only rmap-based MMUs, i.e. don't rename it to __kvm_zap_gfn_range().
No functional change intended.
--- arch/x86/kvm/mmu/mmu.c | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-)
arch/x86/kvm/mmu/mmu.c +2 -2
@@ -5982,7 +5982,7 @@ void kvm_mmu_uninit_vm(struct kvm *kvm)mmu_free_vm_memory_caches (kvm); } -static bool __kvm_zap_rmaps (struct kvm *kvm,gfn_t gfn_start,gfn_t gfn_end) +static bool kvm_rmap_zap_gfn_range (struct kvm *kvm,gfn_t gfn_start,gfn_t gfn_end) {const struct kvm_memory_slot *memslot;struct kvm_memslots *slots;
@@ -6029,7 +6029,7 @@ void kvm_zap_gfn_range(struct kvm *kvm, gfn_t gfn_start, gfn_t gfn_end)kvm_inc_notifier_count (kvm, gfn_start, gfn_end); - flush =__kvm_zap_rmaps (kvm, gfn_start, gfn_end); + flush =kvm_rmap_zap_gfn_range (kvm, gfn_start, gfn_end);if (is_tdp_mmu_enabled (kvm)) {for (i =0 ; i <KVM_ADDRESS_SPACE_NUM ; i++)
Signature · 1 line
2.37.0.170.g444d1eabd0-goog
Sean Christopherson
maintainerPATCH v2 5/7 KVM: x86/mmu: Rename rmap zap helpers to eliminate "unmap" wrapper
In reply to Sean ChristophersonRename kvm_unmap_rmap() and kvm_zap_rmap() to kvm_zap_rmap() and __kvm_zap_rmap() respectively to show that what was the "unmap" helper is just a wrapper for the "zap" helper, i.e. that they do the exact same thing, one just exists to deal with its caller passing in more params.
No functional change intended.
--- arch/x86/kvm/mmu/mmu.c | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-)
arch/x86/kvm/mmu/mmu.c +8 -8
@@ -1383,17 +1383,17 @@ static bool kvm_vcpu_write_protect_gfn(struct kvm_vcpu *vcpu, u64 gfn)return kvm_mmu_slot_gfn_write_protect (vcpu->kvm, slot, gfn,PG_LEVEL_4K ); } -static bool kvm_zap_rmap (struct kvm *kvm,struct kvm_rmap_head *rmap_head, -const struct kvm_memory_slot *slot) +static bool __kvm_zap_rmap (struct kvm *kvm,struct kvm_rmap_head *rmap_head, +const struct kvm_memory_slot *slot) {return pte_list_destroy (kvm, rmap_head); } -static bool kvm_unmap_rmap (struct kvm *kvm,struct kvm_rmap_head *rmap_head, -struct kvm_memory_slot *slot,gfn_t gfn,int level, -pte_t unused) +static bool kvm_zap_rmap (struct kvm *kvm,struct kvm_rmap_head *rmap_head, +struct kvm_memory_slot *slot,gfn_t gfn,int level, +pte_t unused) { -return kvm_zap_rmap (kvm, rmap_head, slot); +return __kvm_zap_rmap (kvm, rmap_head, slot); } static bool kvm_set_pte_rmap(struct kvm *kvm, struct kvm_rmap_head *rmap_head,
@@ -1529,7 +1529,7 @@ bool kvm_unmap_gfn_range(struct kvm *kvm, struct kvm_gfn_range *range)bool flush = false;if (kvm_memslots_have_rmaps (kvm)) - flush =kvm_handle_gfn_range (kvm, range, kvm_unmap_rmap); + flush =kvm_handle_gfn_range (kvm, range, kvm_zap_rmap);if (is_tdp_mmu_enabled (kvm)) flush =kvm_tdp_mmu_unmap_gfn_range (kvm, range, flush);
@@ -6004,7 +6004,7 @@ static bool kvm_rmap_zap_gfn_range(struct kvm *kvm, gfn_t gfn_start, gfn_t gfn_eif (WARN_ON_ONCE (start >= end))continue ; - flush =slot_handle_level_range (kvm, memslot, kvm_zap_rmap, + flush =slot_handle_level_range (kvm, memslot, __kvm_zap_rmap,PG_LEVEL_4K ,KVM_MAX_HUGEPAGE_LEVEL , start, end -1 , true, flush); }
Signature · 1 line
2.37.0.170.g444d1eabd0-goog
Sean Christopherson
maintainerPATCH v2 6/7 KVM: x86/mmu: Rename pte_list_{destroy,remove}() to show they zap SPTEs
In reply to Sean ChristophersonRename pte_list_remove() and pte_list_destroy() to kvm_zap_one_rmap_spte() and kvm_zap_all_rmap_sptes() respectively to document that (a) they zap SPTEs and (b) to better document how they differ (remove vs. destroy does not exactly scream "one vs. all").
No functional change intended.
--- arch/x86/kvm/mmu/mmu.c | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-)
arch/x86/kvm/mmu/mmu.c +9 -8
@@ -957,15 +957,16 @@ static void __pte_list_remove(u64 *spte, struct kvm_rmap_head *rmap_head) } } -static void pte_list_remove (struct kvm *kvm,struct kvm_rmap_head *rmap_head, -u64 *sptep) +static void kvm_zap_one_rmap_spte (struct kvm *kvm, +struct kvm_rmap_head *rmap_head,u64 *sptep) {mmu_spte_clear_track_bits (kvm, sptep);__pte_list_remove (sptep, rmap_head); } -/* Return true if rmap existed, false otherwise */ -static bool pte_list_destroy (struct kvm *kvm,struct kvm_rmap_head *rmap_head) +/* Return true if at least one SPTE was zapped, false otherwise */ +static bool kvm_zap_all_rmap_sptes (struct kvm *kvm, +struct kvm_rmap_head *rmap_head) {struct pte_list_desc *desc, *next;int i;
@@ -1386,7 +1387,7 @@ static bool kvm_vcpu_write_protect_gfn(struct kvm_vcpu *vcpu, u64 gfn)static bool __kvm_zap_rmap (struct kvm *kvm,struct kvm_rmap_head *rmap_head,const struct kvm_memory_slot *slot) { -return pte_list_destroy (kvm, rmap_head); +return kvm_zap_all_rmap_sptes (kvm, rmap_head); } static bool kvm_zap_rmap(struct kvm *kvm, struct kvm_rmap_head *rmap_head,
@@ -1417,7 +1418,7 @@ static bool kvm_set_pte_rmap(struct kvm *kvm, struct kvm_rmap_head *rmap_head, need_flush = true;if (pte_write (pte)) { -pte_list_remove (kvm, rmap_head, sptep); +kvm_zap_one_rmap_spte (kvm, rmap_head, sptep); goto restart; }else { new_spte = kvm_mmu_changed_pte_notifier_make_spte(
@@ -1596,7 +1597,7 @@ static void __rmap_add(struct kvm *kvm, rmap_count =pte_list_add (cache, spte, rmap_head);if (rmap_count >RMAP_RECYCLE_THRESHOLD ) { -pte_list_destroy (kvm, rmap_head); +kvm_zap_all_rmap_sptes (kvm, rmap_head);kvm_flush_remote_tlbs_with_address ( kvm, sp->gfn,KVM_PAGES_PER_HPAGE (sp->role.level)); }
@@ -6406,7 +6407,7 @@ static bool kvm_mmu_zap_collapsible_spte(struct kvm *kvm,if (sp->role.direct && sp->role.level <kvm_mmu_max_mapping_level (kvm, slot, sp->gfn, pfn,PG_LEVEL_NUM )) { -pte_list_remove (kvm, rmap_head, sptep); +kvm_zap_one_rmap_spte (kvm, rmap_head, sptep);if (kvm_available_flush_tlb_with_range ()) kvm_flush_remote_tlbs_with_address(kvm, sp->gfn,
Signature · 1 line
2.37.0.170.g444d1eabd0-goog
Sean Christopherson
maintainerPATCH v2 7/7 KVM: x86/mmu: Remove underscores from __pte_list_remove()
In reply to Sean ChristophersonRemove the underscores from __pte_list_remove(), the function formerly known as pte_list_remove() is now named kvm_zap_one_rmap_spte() to show that it zaps rmaps/PTEs, i.e. doesn't just remove an entry from a list.
No functional change intended.
--- arch/x86/kvm/mmu/mmu.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
arch/x86/kvm/mmu/mmu.c +4 -4
@@ -921,7 +921,7 @@ pte_list_desc_remove_entry(struct kvm_rmap_head *rmap_head,mmu_free_pte_list_desc (desc); } -static void __pte_list_remove (u64 *spte,struct kvm_rmap_head *rmap_head) +static void pte_list_remove (u64 *spte,struct kvm_rmap_head *rmap_head) {struct pte_list_desc *desc;struct pte_list_desc *prev_desc;
@@ -961,7 +961,7 @@ static void kvm_zap_one_rmap_spte(struct kvm *kvm, struct kvm_rmap_head *rmap_head, u64 *sptep) {mmu_spte_clear_track_bits (kvm ,sptep ); -__pte_list_remove (sptep, rmap_head); +pte_list_remove (sptep, rmap_head); }/* Return true if at least one SPTE was zapped, false otherwise */
@@ -1051,7 +1051,7 @@ static void rmap_remove(struct kvm *kvm, u64 *spte) slot =__gfn_to_memslot (slots, gfn); rmap_head =gfn_to_rmap (gfn, sp->role.level, slot); -__pte_list_remove (spte, rmap_head); +pte_list_remove (spte, rmap_head); }/*
@@ -1693,7 +1693,7 @@ static void mmu_page_add_parent_pte(struct kvm_mmu_memory_cache *cache,static void mmu_page_remove_parent_pte (struct kvm_mmu_page *sp,u64 *parent_pte) { -__pte_list_remove (parent_pte, &sp->parent_ptes); +pte_list_remove (parent_pte, &sp->parent_ptes); } static void drop_parent_pte(struct kvm_mmu_page *sp,
Signature · 1 line
2.37.0.170.g444d1eabd0-goog
Queued, thanks.
Paolo