Skip to contentSkip to conversation

mm/swap: Fix pte_same_as_swp() not removing uffd-wp bit when compare

PATCH Applied Peter Xu 2 participants 3 messages Jun 3, 2021 – Jun 4, 2021

Subsystems (2)
lore
Share & tools
lore

Peter Xu

author
#0 lore raw

PATCH 1/1 mm/swap: Fix pte_same_as_swp() not removing uffd-wp bit when compare

I found it by pure code review, that pte_same_as_swp() of unuse_vma() didn't take uffd-wp bit into account when comparing ptes. pte_same_as_swp() returning false negative could cause failure to swapoff swap ptes that was wr-protected by userfaultfd.

Cc Hugh Dickins <[email protected]>
Cc Andrea Arcangeli <[email protected]>
Cc Andrew Morton <[email protected]>
---
 include/linux/swapops.h | 15 +++++++++++----
 mm/swapfile.c           |  2 +-
 2 files changed, 12 insertions(+), 5 deletions(-)
include/linux/swapops.h +11 -4
index af3d2661e41e..d356ab4047f7 100644
@@ -23,6 +23,16 @@
 #define SWP_TYPE_SHIFT	(BITS_PER_XA_VALUE - MAX_SWAPFILES_SHIFT)
 #define SWP_OFFSET_MASK	((1UL << SWP_TYPE_SHIFT) - 1)
 
+/* Clear all flags but only keep swp_entry_t related information */
+static inline pte_t pte_swp_clear_flags(pte_t pte)
+{
+	if (pte_swp_soft_dirty(pte))
+		pte = pte_swp_clear_soft_dirty(pte);
+	if (pte_swp_uffd_wp(pte))
+		pte = pte_swp_clear_uffd_wp(pte);
+	return pte;
+}
+
 /*
  * Store a type+offset into a swp_entry_t in an arch-independent format
  */
@@ -66,10 +76,7 @@ static inline swp_entry_t pte_to_swp_entry(pte_t pte)
 {
 	swp_entry_t arch_entry;
 
-	if (pte_swp_soft_dirty(pte))
-		pte = pte_swp_clear_soft_dirty(pte);
-	if (pte_swp_uffd_wp(pte))
-		pte = pte_swp_clear_uffd_wp(pte);
+	pte = pte_swp_clear_flags(pte);
 	arch_entry = __pte_to_swp_entry(pte);
 	return swp_entry(__swp_type(arch_entry), __swp_offset(arch_entry));
 }
mm/swapfile.c +1 -1
index 6212bc033602..1e07d1c776f2 100644
@@ -1887,7 +1887,7 @@ unsigned int count_swap_pages(int type, int free)
 
 static inline int pte_same_as_swp(pte_t pte, pte_t swp_pte)
 {
-	return pte_same(pte_swp_clear_soft_dirty(pte), swp_pte);
+	return pte_same(pte_swp_clear_flags(pte), swp_pte);
 }
 
 /*
Signature · 1 line
2.31.1
Acked-by on v1 1/1
#1 lore raw
Quoted 1 line · Peter Xu

I found it by pure code review, that pte_same_as_swp() of unuse_vma() didn't

Yes, that is an odd corner, easily missed.

Quoted 8 lines

take uffd-wp bit into account when comparing ptes. pte_same_as_swp() returning false negative could cause failure to swapoff swap ptes that was wr-protected by userfaultfd.

Cc Hugh Dickins <[email protected]>
Cc Andrea Arcangeli <[email protected]>
Cc Andrew Morton <[email protected]>

I expect you're right: swapoff used to hang forever (but interruptibly) when this went wrong on powerpc originally. I don't know the uffd_wp (nor the soft_dirty) end of it, but treating uffd_wp and soft_dirty together looks a very good approach, so I'll venture an

But I think it should have a uffd_wp Fixes tag and be Cc stable.

Quoted 53 lines
---
 include/linux/swapops.h | 15 +++++++++++----
 mm/swapfile.c           |  2 +-
 2 files changed, 12 insertions(+), 5 deletions(-)
include/linux/swapops.h +11 -4
index af3d2661e41e..d356ab4047f7 100644
@@ -23,6 +23,16 @@
 #define SWP_TYPE_SHIFT	(BITS_PER_XA_VALUE - MAX_SWAPFILES_SHIFT)
 #define SWP_OFFSET_MASK	((1UL << SWP_TYPE_SHIFT) - 1)
 
+/* Clear all flags but only keep swp_entry_t related information */
+static inline pte_t pte_swp_clear_flags(pte_t pte)
+{
+	if (pte_swp_soft_dirty(pte))
+		pte = pte_swp_clear_soft_dirty(pte);
+	if (pte_swp_uffd_wp(pte))
+		pte = pte_swp_clear_uffd_wp(pte);
+	return pte;
+}
+
 /*
  * Store a type+offset into a swp_entry_t in an arch-independent format
  */
@@ -66,10 +76,7 @@ static inline swp_entry_t pte_to_swp_entry(pte_t pte)
 {
 	swp_entry_t arch_entry;
 
-	if (pte_swp_soft_dirty(pte))
-		pte = pte_swp_clear_soft_dirty(pte);
-	if (pte_swp_uffd_wp(pte))
-		pte = pte_swp_clear_uffd_wp(pte);
+	pte = pte_swp_clear_flags(pte);
 	arch_entry = __pte_to_swp_entry(pte);
 	return swp_entry(__swp_type(arch_entry), __swp_offset(arch_entry));
 }
mm/swapfile.c +1 -1
index 6212bc033602..1e07d1c776f2 100644
@@ -1887,7 +1887,7 @@ unsigned int count_swap_pages(int type, int free)
 
 static inline int pte_same_as_swp(pte_t pte, pte_t swp_pte)
 {
-	return pte_same(pte_swp_clear_soft_dirty(pte), swp_pte);
+	return pte_same(pte_swp_clear_flags(pte), swp_pte);
 }
 
 /*
Signature · 1 line
2.31.1
author
#2 lore raw
Quoted 15 lines · Hugh Dickins
Quoted 1 line · Peter Xu

I found it by pure code review, that pte_same_as_swp() of unuse_vma() didn't

Yes, that is an odd corner, easily missed.

Quoted 8 lines

take uffd-wp bit into account when comparing ptes. pte_same_as_swp() returning false negative could cause failure to swapoff swap ptes that was wr-protected by userfaultfd.

Cc Hugh Dickins <[email protected]>
Cc Andrea Arcangeli <[email protected]>
Cc Andrew Morton <[email protected]>
Quoted 6 lines

I expect you're right: swapoff used to hang forever (but interruptibly) when this went wrong on powerpc originally. I don't know the uffd_wp (nor the soft_dirty) end of it, but treating uffd_wp and soft_dirty together looks a very good approach, so I'll venture an

Thanks!

Quoted 2 lines

But I think it should have a uffd_wp Fixes tag and be Cc stable.

Yes, should be:

Fixes f45ec5ff16a7 ("userfaultfd: wp: support swap and page migration")
Signature · 1 line
Peter Xu