Skip to contentSkip to conversation

swap: cleanup get/put_swap_device() usage

PATCH In review Huang Ying 3 participants 21 messages May 22, 2023 – May 23, 2023

Subsystems (2)
lore
Share & tools
lore

Huang Ying

author
#0 lore raw

cover swap: cleanup get/put_swap_device() usage

The general rule to use a swap entry is as follows.

When we get a swap entry, if there isn't some other way to prevent swapoff, such as page lock for swap cache, page table lock, etc., the swap entry may become invalid because of swapoff. Then, we need to enclose all swap related functions with get_swap_device() and put_swap_device(), unless the swap functions call get/put_swap_device() by themselves.

Based on the above rule, all get/put_swap_device() usage are checked and cleaned up if necessary.

Changelogs:

v2:

- Split patch per David's comments. Thanks!

Best Regards,
Huang, Ying

author
#1 lore raw

PATCH 1/5 swap: Remove get/put_swap_device() in __swap_count()

__swap_count() is called in do_swap_page() only, which encloses the call site with get/put_swap_device() already.

Cc David Hildenbrand <[email protected]>
Cc Hugh Dickins <[email protected]>
Cc Johannes Weiner <[email protected]>
Cc Matthew Wilcox <[email protected]>
Cc Michal Hocko <[email protected]>
Cc Minchan Kim <[email protected]>
Cc Tim Chen <[email protected]>
Cc Yang Shi <[email protected]>
Cc Yu Zhao <[email protected]>
---
 mm/swapfile.c | 10 ++--------
 1 file changed, 2 insertions(+), 8 deletions(-)
mm/swapfile.c +2 -8
index 274bbf797480..8419cba9c192 100644
@@ -1432,16 +1432,10 @@ void swapcache_free_entries(swp_entry_t *entries, int n)
 
 int __swap_count(swp_entry_t entry)
 {
-	struct swap_info_struct *si;
+	struct swap_info_struct *si = swp_swap_info(entry);
 	pgoff_t offset = swp_offset(entry);
-	int count = 0;
 
-	si = get_swap_device(entry);
-	if (si) {
-		count = swap_count(si->swap_map[offset]);
-		put_swap_device(si);
-	}
-	return count;
+	return swap_count(si->swap_map[offset]);
 }
 
 /*
Signature · 1 line
2.39.2
Reviewed-by on v1 1/5
#2 lore raw

Re: [PATCH -V2 1/5] swap: Remove get/put_swap_device() in __swap_count()

Quoted 30 lines · Huang Ying

__swap_count() is called in do_swap_page() only, which encloses the call site with get/put_swap_device() already.

Cc David Hildenbrand <[email protected]>
Cc Hugh Dickins <[email protected]>
Cc Johannes Weiner <[email protected]>
Cc Matthew Wilcox <[email protected]>
Cc Michal Hocko <[email protected]>
Cc Minchan Kim <[email protected]>
Cc Tim Chen <[email protected]>
Cc Yang Shi <[email protected]>
Cc Yu Zhao <[email protected]>
---
  mm/swapfile.c | 10 ++--------
  1 file changed, 2 insertions(+), 8 deletions(-)
mm/swapfile.c +1 -2
index 274bbf797480..8419cba9c192 100644
@@ -1432,16 +1432,10 @@ void swapcache_free_entries(swp_entry_t *entries, int n)
 
  int __swap_count(swp_entry_t entry)
  {
-	struct swap_info_struct *si;
+	struct swap_info_struct *si = swp_swap_info(entry);
  	pgoff_t offset = swp_offset(entry);
-	int count = 0;
 

mm/swapfile.c void swapcache_free_entries(swp_entry_t *entries, int n) · line 1441

Quoted 10 lines
mm/swapfile.c +1 -6
-	si = get_swap_device(entry);
-	if (si) {
-		count = swap_count(si->swap_map[offset]);
-		put_swap_device(si);
-	}
-	return count;
+	return swap_count(si->swap_map[offset]);
  }
 
  /*

That locking was added in eb085574a752 ("mm, swap: fix race between swapoff and some swap operations"). Before 2799e77529c ("swap: fix do_swap_page() race with swapoff") added the get_swap_device() to do_swap_page().

Signature · 3 lines
Thanks,

David / dhildenb
Reviewed-by on v1 1/5
#3 lore raw

Re: [PATCH -V2 1/5] swap: Remove get/put_swap_device() in __swap_count()

In reply to Huang Ying
Quoted 23 lines · Huang Ying

__swap_count() is called in do_swap_page() only, which encloses the call site with get/put_swap_device() already.

Cc David Hildenbrand <[email protected]>
Cc Hugh Dickins <[email protected]>
Cc Johannes Weiner <[email protected]>
Cc Matthew Wilcox <[email protected]>
Cc Michal Hocko <[email protected]>
Cc Minchan Kim <[email protected]>
Cc Tim Chen <[email protected]>
Cc Yang Shi <[email protected]>
Cc Yu Zhao <[email protected]>
---
 mm/swapfile.c | 10 ++--------
 1 file changed, 2 insertions(+), 8 deletions(-)
mm/swapfile.c +0 -0
index 274bbf797480..8419cba9c192 100644

mm/swapfile.c void swapcache_free_entries(swp_entry_t *entries, int n) · line 1432

Quoted 1 line
mm/swapfile.c +0 -0
@@ -1432,16 +1432,10 @@ void swapcache_free_entries(swp_entry_t *entries, int n)
 

nit: I would add a comment here that the caller needs get/put_swap_device().

Quoted 21 lines
mm/swapfile.c +2 -9
 int __swap_count(swp_entry_t entry)
 {
-       struct swap_info_struct *si;
+       struct swap_info_struct *si = swp_swap_info(entry);
        pgoff_t offset = swp_offset(entry);
-       int count = 0;
 
-       si = get_swap_device(entry);
-       if (si) {
-               count = swap_count(si->swap_map[offset]);
-               put_swap_device(si);
-       }
-       return count;
+       return swap_count(si->swap_map[offset]);
 }
 
 /*
--

2.39.2

#4 lore raw

Re: [PATCH -V2 1/5] swap: Remove get/put_swap_device() in __swap_count()

Quoted 19 lines · Yosry Ahmed
Quoted 18 lines · Huang Ying

__swap_count() is called in do_swap_page() only, which encloses the call site with get/put_swap_device() already.

Cc David Hildenbrand <[email protected]>
Cc Hugh Dickins <[email protected]>
Cc Johannes Weiner <[email protected]>
Cc Matthew Wilcox <[email protected]>
Cc Michal Hocko <[email protected]>
Cc Minchan Kim <[email protected]>
Cc Tim Chen <[email protected]>
Cc Yang Shi <[email protected]>
Cc Yu Zhao <[email protected]>
---
 mm/swapfile.c | 10 ++--------
 1 file changed, 2 insertions(+), 8 deletions(-)
Quoted 8 lines

mm/swapfile.c void swapcache_free_entries(swp_entry_t *entries, int n) · line 1432

Quoted 6 lines
mm/swapfile.c +0 -0
index 274bbf797480..8419cba9c192 100644
@@ -1432,16 +1432,10 @@ void swapcache_free_entries(swp_entry_t *entries, int n)
 

nit: I would add a comment here that the caller needs get/put_swap_device().

It's default behavior to call get/put_swap_device() in the caller for all almost all swap functions. I would rather comment the swap functions needn't to do that, as the comments for read_swap_cache_async() in [2/5].

Quoted 1 line

Thanks!

Quoted 16 lines
Quoted 16 lines
mm/swapfile.c +2 -8
 int __swap_count(swp_entry_t entry)
 {
-       struct swap_info_struct *si;
+       struct swap_info_struct *si = swp_swap_info(entry);
        pgoff_t offset = swp_offset(entry);
-       int count = 0;
 
-       si = get_swap_device(entry);
-       if (si) {
-               count = swap_count(si->swap_map[offset]);
-               put_swap_device(si);
-       }
-       return count;
+       return swap_count(si->swap_map[offset]);
 }
 
Quoted 1 line

mm/swapfile.c void swapcache_free_entries(swp_entry_t *entries, int n) · line 1441

Quoted 1 line
mm/swapfile.c +0 -0
 /*

Best Regards,
Huang, Ying

#5 lore raw

Re: [PATCH -V2 1/5] swap: Remove get/put_swap_device() in __swap_count()

Quoted 31 lines · Ying
Quoted 19 lines · Yosry Ahmed
Quoted 18 lines · Huang Ying

__swap_count() is called in do_swap_page() only, which encloses the call site with get/put_swap_device() already.

Cc David Hildenbrand <[email protected]>
Cc Hugh Dickins <[email protected]>
Cc Johannes Weiner <[email protected]>
Cc Matthew Wilcox <[email protected]>
Cc Michal Hocko <[email protected]>
Cc Minchan Kim <[email protected]>
Cc Tim Chen <[email protected]>
Cc Yang Shi <[email protected]>
Cc Yu Zhao <[email protected]>
---
 mm/swapfile.c | 10 ++--------
 1 file changed, 2 insertions(+), 8 deletions(-)
Quoted 8 lines

mm/swapfile.c void swapcache_free_entries(swp_entry_t *entries, int n) · line 1432

Quoted 6 lines
mm/swapfile.c +0 -0
index 274bbf797480..8419cba9c192 100644
@@ -1432,16 +1432,10 @@ void swapcache_free_entries(swp_entry_t *entries, int n)
 

nit: I would add a comment here that the caller needs get/put_swap_device().

Quoted 4 lines

It's default behavior to call get/put_swap_device() in the caller for all almost all swap functions. I would rather comment the swap functions needn't to do that, as the comments for read_swap_cache_async() in [2/5].

Fair enough. The comment that you added above get_swap_device() states that all swap-related functions should have some sort of protection against swapoff, so I guess that's sufficient.

My concern is that sometimes people don't know where to look, and having a comment above the function might be helpful. I do agree though that having a comment above ~all swap-related functions pointing to the comment above get_swap_device() is too much.

Quoted 25 lines
Quoted 2 lines

Thanks!

Quoted 16 lines
Quoted 16 lines
mm/swapfile.c +2 -8
 int __swap_count(swp_entry_t entry)
 {
-       struct swap_info_struct *si;
+       struct swap_info_struct *si = swp_swap_info(entry);
        pgoff_t offset = swp_offset(entry);
-       int count = 0;
 
-       si = get_swap_device(entry);
-       if (si) {
-               count = swap_count(si->swap_map[offset]);
-               put_swap_device(si);
-       }
-       return count;
+       return swap_count(si->swap_map[offset]);
 }
 
Quoted 1 line

mm/swapfile.c void swapcache_free_entries(swp_entry_t *entries, int n) · line 1441

Quoted 1 line
mm/swapfile.c +0 -0
 /*

Best Regards,
Huang, Ying

author
#6 lore raw

PATCH 2/5 swap, __read_swap_cache_async(): enlarge get/put_swap_device protection range

In reply to Huang Ying

This makes the function a little easier to be understood because we don't need to consider swapoff. And this makes it possible to remove get/put_swap_device() calling in some functions called by __read_swap_cache_async().

Cc David Hildenbrand <[email protected]>
Cc Hugh Dickins <[email protected]>
Cc Johannes Weiner <[email protected]>
Cc Matthew Wilcox <[email protected]>
Cc Michal Hocko <[email protected]>
Cc Minchan Kim <[email protected]>
Cc Tim Chen <[email protected]>
Cc Yang Shi <[email protected]>
Cc Yu Zhao <[email protected]>
---
 mm/swap_state.c | 33 ++++++++++++++++++++++-----------
 1 file changed, 22 insertions(+), 11 deletions(-)
mm/swap_state.c +22 -11
index b76a65ac28b3..a1028fe7214e 100644
@@ -417,9 +417,13 @@ struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
 {
 	struct swap_info_struct *si;
 	struct folio *folio;
+	struct page *page;
 	void *shadow = NULL;
 
 	*new_page_allocated = false;
+	si = get_swap_device(entry);
+	if (!si)
+		return NULL;
 
 	for (;;) {
 		int err;
@@ -428,14 +432,12 @@ struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
 		 * called after swap_cache_get_folio() failed, re-calling
 		 * that would confuse statistics.
 		 */
-		si = get_swap_device(entry);
-		if (!si)
-			return NULL;
 		folio = filemap_get_folio(swap_address_space(entry),
 						swp_offset(entry));
-		put_swap_device(si);
-		if (!IS_ERR(folio))
-			return folio_file_page(folio, swp_offset(entry));
+		if (!IS_ERR(folio)) {
+			page = folio_file_page(folio, swp_offset(entry));
+			goto got_page;
+		}
 
 		/*
 		 * Just skip read ahead for unused swap slot.
@@ -445,8 +447,8 @@ struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
 		 * as SWAP_HAS_CACHE.  That's done in later part of code or
 		 * else swap_off will be aborted if we return NULL.
 		 */
-		if (!__swp_swapcount(entry) && swap_slot_cache_enabled)
-			return NULL;
+		if (!swap_swapcount(si, entry) && swap_slot_cache_enabled)
+			goto fail;
 
 		/*
 		 * Get a new page to read into from swap.  Allocate it now,
@@ -455,7 +457,7 @@ struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
 		 */
 		folio = vma_alloc_folio(gfp_mask, 0, vma, addr, false);
 		if (!folio)
-			return NULL;
+                        goto fail;
 
 		/*
 		 * Swap entry may have been freed since our caller observed it.
@@ -466,7 +468,7 @@ struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
 
 		folio_put(folio);
 		if (err != -EEXIST)
-			return NULL;
+			goto fail;
 
 		/*
 		 * We might race against __delete_from_swap_cache(), and
@@ -500,12 +502,17 @@ struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
 	/* Caller will initiate read into locked folio */
 	folio_add_lru(folio);
 	*new_page_allocated = true;
-	return &folio->page;
+	page = &folio->page;
+got_page:
+	put_swap_device(si);
+	return page;
 
 fail_unlock:
 	put_swap_folio(folio, entry);
 	folio_unlock(folio);
 	folio_put(folio);
+fail:
+	put_swap_device(si);
 	return NULL;
 }
 
@@ -514,6 +521,10 @@ struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
  * and reading the disk if it is not already cached.
  * A failure return means that either the page allocation failed or that
  * the swap entry is no longer in use.
+ *
+ * get/put_swap_device() aren't needed to call this function, because
+ * __read_swap_cache_async() call them and swap_readpage() holds the
+ * swap cache folio lock.
  */
 struct page *read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
 				   struct vm_area_struct *vma,
Signature · 1 line
2.39.2
#7 lore raw

Re: [PATCH -V2 2/5] swap, __read_swap_cache_async(): enlarge get/put_swap_device protection range

Quoted 90 lines · Huang Ying

This makes the function a little easier to be understood because we don't need to consider swapoff. And this makes it possible to remove get/put_swap_device() calling in some functions called by __read_swap_cache_async().

Cc David Hildenbrand <[email protected]>
Cc Hugh Dickins <[email protected]>
Cc Johannes Weiner <[email protected]>
Cc Matthew Wilcox <[email protected]>
Cc Michal Hocko <[email protected]>
Cc Minchan Kim <[email protected]>
Cc Tim Chen <[email protected]>
Cc Yang Shi <[email protected]>
Cc Yu Zhao <[email protected]>
---
  mm/swap_state.c | 33 ++++++++++++++++++++++-----------
  1 file changed, 22 insertions(+), 11 deletions(-)
mm/swap_state.c +12 -11
index b76a65ac28b3..a1028fe7214e 100644
@@ -417,9 +417,13 @@ struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
  {
  	struct swap_info_struct *si;
  	struct folio *folio;
+	struct page *page;
  	void *shadow = NULL;
 
  	*new_page_allocated = false;
+	si = get_swap_device(entry);
+	if (!si)
+		return NULL;
 
  	for (;;) {
  		int err;
@@ -428,14 +432,12 @@ struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
  		 * called after swap_cache_get_folio() failed, re-calling
  		 * that would confuse statistics.
  		 */
-		si = get_swap_device(entry);
-		if (!si)
-			return NULL;
  		folio = filemap_get_folio(swap_address_space(entry),
  						swp_offset(entry));
-		put_swap_device(si);
-		if (!IS_ERR(folio))
-			return folio_file_page(folio, swp_offset(entry));
+		if (!IS_ERR(folio)) {
+			page = folio_file_page(folio, swp_offset(entry));
+			goto got_page;
+		}
 
  		/*
  		 * Just skip read ahead for unused swap slot.
@@ -445,8 +447,8 @@ struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
  		 * as SWAP_HAS_CACHE.  That's done in later part of code or
  		 * else swap_off will be aborted if we return NULL.
  		 */
-		if (!__swp_swapcount(entry) && swap_slot_cache_enabled)
-			return NULL;
+		if (!swap_swapcount(si, entry) && swap_slot_cache_enabled)
+			goto fail;
 
  		/*
  		 * Get a new page to read into from swap.  Allocate it now,
@@ -455,7 +457,7 @@ struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
  		 */
  		folio = vma_alloc_folio(gfp_mask, 0, vma, addr, false);
  		if (!folio)
-			return NULL;
+                        goto fail;
 
  		/*
  		 * Swap entry may have been freed since our caller observed it.
@@ -466,7 +468,7 @@ struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
 
  		folio_put(folio);
  		if (err != -EEXIST)
-			return NULL;
+			goto fail;
 
  		/*
  		 * We might race against __delete_from_swap_cache(), and
@@ -500,12 +502,17 @@ struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
  	/* Caller will initiate read into locked folio */
  	folio_add_lru(folio);
  	*new_page_allocated = true;
-	return &folio->page;

mm/swap_state.c struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask, · line 514

Quoted 10 lines
mm/swap_state.c +5 -0
+	page = &folio->page;
+got_page:
+	put_swap_device(si);
+	return page;
 
  fail_unlock:
  	put_swap_folio(folio, entry);
  	folio_unlock(folio);
  	folio_put(folio);
+fail:

Maybe better "fail_put_swap".

We now hold the swap device ref longer than we used to, prevent swapoff over the whole operation. I guess there is no way we can deadlock this way?

In general, looks good to me.

Signature · 3 lines
Thanks,

David / dhildenb
#8 lore raw

Re: [PATCH -V2 2/5] swap, __read_swap_cache_async(): enlarge get/put_swap_device protection range

Quoted 94 lines · David Hildenbrand
Quoted 80 lines · Huang Ying

This makes the function a little easier to be understood because we don't need to consider swapoff. And this makes it possible to remove get/put_swap_device() calling in some functions called by __read_swap_cache_async().

Cc David Hildenbrand <[email protected]>
Cc Hugh Dickins <[email protected]>
Cc Johannes Weiner <[email protected]>
Cc Matthew Wilcox <[email protected]>
Cc Michal Hocko <[email protected]>
Cc Minchan Kim <[email protected]>
Cc Tim Chen <[email protected]>
Cc Yang Shi <[email protected]>
Cc Yu Zhao <[email protected]>
---
  mm/swap_state.c | 33 ++++++++++++++++++++++-----------
  1 file changed, 22 insertions(+), 11 deletions(-)
mm/swap_state.c +12 -10
index b76a65ac28b3..a1028fe7214e 100644
@@ -417,9 +417,13 @@ struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
  {
  	struct swap_info_struct *si;
  	struct folio *folio;
+	struct page *page;
  	void *shadow = NULL;
    	*new_page_allocated = false;
+	si = get_swap_device(entry);
+	if (!si)
+		return NULL;
    	for (;;) {
  		int err;
@@ -428,14 +432,12 @@ struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
  		 * called after swap_cache_get_folio() failed, re-calling
  		 * that would confuse statistics.
  		 */
-		si = get_swap_device(entry);
-		if (!si)
-			return NULL;
  		folio = filemap_get_folio(swap_address_space(entry),
  						swp_offset(entry));
-		put_swap_device(si);
-		if (!IS_ERR(folio))
-			return folio_file_page(folio, swp_offset(entry));
+		if (!IS_ERR(folio)) {
+			page = folio_file_page(folio, swp_offset(entry));
+			goto got_page;
+		}
    		/*
  		 * Just skip read ahead for unused swap slot.
@@ -445,8 +447,8 @@ struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
  		 * as SWAP_HAS_CACHE.  That's done in later part of code or
  		 * else swap_off will be aborted if we return NULL.
  		 */
-		if (!__swp_swapcount(entry) && swap_slot_cache_enabled)
-			return NULL;
+		if (!swap_swapcount(si, entry) && swap_slot_cache_enabled)
+			goto fail;
    		/*
  		 * Get a new page to read into from swap.  Allocate it now,
@@ -455,7 +457,7 @@ struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
  		 */
  		folio = vma_alloc_folio(gfp_mask, 0, vma, addr, false);
  		if (!folio)
-			return NULL;
+                        goto fail;
    		/*
  		 * Swap entry may have been freed since our caller observed it.
@@ -466,7 +468,7 @@ struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
    		folio_put(folio);
  		if (err != -EEXIST)
-			return NULL;
+			goto fail;
    		/*
  		 * We might race against __delete_from_swap_cache(), and
@@ -500,12 +502,17 @@ struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
  	/* Caller will initiate read into locked folio */
  	folio_add_lru(folio);
  	*new_page_allocated = true;

mm/swap_state.c struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask, · line 513

Quoted 10 lines
mm/swap_state.c +5 -1
-	return &folio->page;
+	page = &folio->page;
+got_page:
+	put_swap_device(si);
+	return page;
    fail_unlock:
  	put_swap_folio(folio, entry);
  	folio_unlock(folio);
  	folio_put(folio);
+fail:

Maybe better "fail_put_swap".

Quoted 3 lines

We now hold the swap device ref longer than we used to, prevent swapoff over the whole operation. I guess there is no way we can deadlock this way?

I think that we are safe. In swapoff() syscall, we call percpu_ref_kill() after all pages are swapped in (via try_to_unuse()).

Quoted 1 line

In general, looks good to me.

Thanks!

Best Regards,
Huang, Ying

author
#9 lore raw

PATCH 3/5 swap: remove __swp_swapcount()

In reply to Huang Ying

__swp_swapcount() just encloses the calling to swap_swapcount() with get/put_swap_device(). It is called in __read_swap_cache_async() only, which encloses the calling with get/put_swap_device() already. So, __read_swap_cache_async() can call swap_swapcount() directly.

Cc David Hildenbrand <[email protected]>
Cc Hugh Dickins <[email protected]>
Cc Johannes Weiner <[email protected]>
Cc Matthew Wilcox <[email protected]>
Cc Michal Hocko <[email protected]>
Cc Minchan Kim <[email protected]>
Cc Tim Chen <[email protected]>
Cc Yang Shi <[email protected]>
Cc Yu Zhao <[email protected]>
---
 include/linux/swap.h |  4 ++--
 mm/swapfile.c        | 20 +-------------------
 2 files changed, 3 insertions(+), 21 deletions(-)
include/linux/swap.h +2 -2
index 3c69cb653cb9..f6bd51aa05ea 100644
@@ -512,7 +512,7 @@ int find_first_swap(dev_t *device);
 extern unsigned int count_swap_pages(int, int);
 extern sector_t swapdev_block(int, pgoff_t);
 extern int __swap_count(swp_entry_t entry);
-extern int __swp_swapcount(swp_entry_t entry);
+extern int swap_swapcount(struct swap_info_struct *si, swp_entry_t entry);
 extern int swp_swapcount(swp_entry_t entry);
 extern struct swap_info_struct *page_swap_info(struct page *);
 extern struct swap_info_struct *swp_swap_info(swp_entry_t entry);
@@ -590,7 +590,7 @@ static inline int __swap_count(swp_entry_t entry)
 	return 0;
 }
 
-static inline int __swp_swapcount(swp_entry_t entry)
+static inline int swap_swapcount(struct swap_info_struct *si, swp_entry_t entry)
 {
 	return 0;
 }
mm/swapfile.c +1 -19
index 8419cba9c192..e9cce775fb25 100644
@@ -1443,7 +1443,7 @@ int __swap_count(swp_entry_t entry)
  * This does not give an exact answer when swap count is continued,
  * but does include the high COUNT_CONTINUED flag to allow for that.
  */
-static int swap_swapcount(struct swap_info_struct *si, swp_entry_t entry)
+int swap_swapcount(struct swap_info_struct *si, swp_entry_t entry)
 {
 	pgoff_t offset = swp_offset(entry);
 	struct swap_cluster_info *ci;
@@ -1455,24 +1455,6 @@ static int swap_swapcount(struct swap_info_struct *si, swp_entry_t entry)
 	return count;
 }
 
-/*
- * How many references to @entry are currently swapped out?
- * This does not give an exact answer when swap count is continued,
- * but does include the high COUNT_CONTINUED flag to allow for that.
- */
-int __swp_swapcount(swp_entry_t entry)
-{
-	int count = 0;
-	struct swap_info_struct *si;
-
-	si = get_swap_device(entry);
-	if (si) {
-		count = swap_swapcount(si, entry);
-		put_swap_device(si);
-	}
-	return count;
-}
-
 /*
  * How many references to @entry are currently swapped out?
  * This considers COUNT_CONTINUED so it returns exact answer.
Signature · 1 line
2.39.2
#10 lore raw

Re: [PATCH -V2 3/5] swap: remove __swp_swapcount()

Quoted 4 lines · Huang Ying

__swp_swapcount() just encloses the calling to swap_swapcount() with get/put_swap_device(). It is called in __read_swap_cache_async() only, which encloses the calling with get/put_swap_device() already. So, __read_swap_cache_async() can call swap_swapcount() directly.

The previous patch contained the hunk

- if (!__swp_swapcount(entry) && swap_slot_cache_enabled)
- return NULL;
+ if (!swap_swapcount(si, entry) && swap_slot_cache_enabled)
+ goto fail;

So something is a bit off here. Either that hunk should go here, or this patch description has to be adjusted.

But I guess patch #2 doesn't compile on its own because this patch here adds swap_swapcount() to include/linux/swap.h ?

Quoted 76 lines
Cc David Hildenbrand <[email protected]>
Cc Hugh Dickins <[email protected]>
Cc Johannes Weiner <[email protected]>
Cc Matthew Wilcox <[email protected]>
Cc Michal Hocko <[email protected]>
Cc Minchan Kim <[email protected]>
Cc Tim Chen <[email protected]>
Cc Yang Shi <[email protected]>
Cc Yu Zhao <[email protected]>
---
  include/linux/swap.h |  4 ++--
  mm/swapfile.c        | 20 +-------------------
  2 files changed, 3 insertions(+), 21 deletions(-)
include/linux/swap.h +2 -2
index 3c69cb653cb9..f6bd51aa05ea 100644
@@ -512,7 +512,7 @@ int find_first_swap(dev_t *device);
  extern unsigned int count_swap_pages(int, int);
  extern sector_t swapdev_block(int, pgoff_t);
  extern int __swap_count(swp_entry_t entry);
-extern int __swp_swapcount(swp_entry_t entry);
+extern int swap_swapcount(struct swap_info_struct *si, swp_entry_t entry);
  extern int swp_swapcount(swp_entry_t entry);
  extern struct swap_info_struct *page_swap_info(struct page *);
  extern struct swap_info_struct *swp_swap_info(swp_entry_t entry);
@@ -590,7 +590,7 @@ static inline int __swap_count(swp_entry_t entry)
  	return 0;
  }
 
-static inline int __swp_swapcount(swp_entry_t entry)
+static inline int swap_swapcount(struct swap_info_struct *si, swp_entry_t entry)
  {
  	return 0;
  }
mm/swapfile.c +1 -19
index 8419cba9c192..e9cce775fb25 100644
@@ -1443,7 +1443,7 @@ int __swap_count(swp_entry_t entry)
   * This does not give an exact answer when swap count is continued,
   * but does include the high COUNT_CONTINUED flag to allow for that.
   */
-static int swap_swapcount(struct swap_info_struct *si, swp_entry_t entry)
+int swap_swapcount(struct swap_info_struct *si, swp_entry_t entry)
  {
  	pgoff_t offset = swp_offset(entry);
  	struct swap_cluster_info *ci;
@@ -1455,24 +1455,6 @@ static int swap_swapcount(struct swap_info_struct *si, swp_entry_t entry)
  	return count;
  }
 
-/*
- * How many references to @entry are currently swapped out?
- * This does not give an exact answer when swap count is continued,
- * but does include the high COUNT_CONTINUED flag to allow for that.
- */
-int __swp_swapcount(swp_entry_t entry)
-{
-	int count = 0;
-	struct swap_info_struct *si;
-
-	si = get_swap_device(entry);
-	if (si) {
-		count = swap_swapcount(si, entry);
-		put_swap_device(si);
-	}
-	return count;
-}
-
  /*
   * How many references to @entry are currently swapped out?
   * This considers COUNT_CONTINUED so it returns exact answer.
Signature · 3 lines
Thanks,

David / dhildenb
#11 lore raw

Re: [PATCH -V2 3/5] swap: remove __swp_swapcount()

Quoted 13 lines · David Hildenbrand
Quoted 4 lines · Huang Ying

__swp_swapcount() just encloses the calling to swap_swapcount() with get/put_swap_device(). It is called in __read_swap_cache_async() only, which encloses the calling with get/put_swap_device() already. So, __read_swap_cache_async() can call swap_swapcount() directly.

The previous patch contained the hunk

(quoted diff) +2 -2
-		if (!__swp_swapcount(entry) && swap_slot_cache_enabled)
-			return NULL;
+		if (!swap_swapcount(si, entry) && swap_slot_cache_enabled)
+			goto fail;
Quoted 6 lines

So something is a bit off here. Either that hunk should go here, or this patch description has to be adjusted.

But I guess patch #2 doesn't compile on its own because this patch here adds swap_swapcount() to include/linux/swap.h ?

Good catch! Will change this in the next version.

Best Regards,
Huang, Ying

Quoted 72 lines
Quoted 72 lines
Cc David Hildenbrand <[email protected]>
Cc Hugh Dickins <[email protected]>
Cc Johannes Weiner <[email protected]>
Cc Matthew Wilcox <[email protected]>
Cc Michal Hocko <[email protected]>
Cc Minchan Kim <[email protected]>
Cc Tim Chen <[email protected]>
Cc Yang Shi <[email protected]>
Cc Yu Zhao <[email protected]>
---
  include/linux/swap.h |  4 ++--
  mm/swapfile.c        | 20 +-------------------
  2 files changed, 3 insertions(+), 21 deletions(-)
include/linux/swap.h +2 -1
index 3c69cb653cb9..f6bd51aa05ea 100644
@@ -512,7 +512,7 @@ int find_first_swap(dev_t *device);
  extern unsigned int count_swap_pages(int, int);
  extern sector_t swapdev_block(int, pgoff_t);
  extern int __swap_count(swp_entry_t entry);
-extern int __swp_swapcount(swp_entry_t entry);
+extern int swap_swapcount(struct swap_info_struct *si, swp_entry_t entry);
  extern int swp_swapcount(swp_entry_t entry);
  extern struct swap_info_struct *page_swap_info(struct page *);
  extern struct swap_info_struct *swp_swap_info(swp_entry_t entry);
@@ -590,7 +590,7 @@ static inline int __swap_count(swp_entry_t entry)
  	return 0;
  }
  -static inline int __swp_swapcount(swp_entry_t entry)
+static inline int swap_swapcount(struct swap_info_struct *si, swp_entry_t entry)
  {
  	return 0;
  }
mm/swapfile.c +1 -18
index 8419cba9c192..e9cce775fb25 100644
@@ -1443,7 +1443,7 @@ int __swap_count(swp_entry_t entry)
   * This does not give an exact answer when swap count is continued,
   * but does include the high COUNT_CONTINUED flag to allow for that.
   */
-static int swap_swapcount(struct swap_info_struct *si, swp_entry_t entry)
+int swap_swapcount(struct swap_info_struct *si, swp_entry_t entry)
  {
  	pgoff_t offset = swp_offset(entry);
  	struct swap_cluster_info *ci;
@@ -1455,24 +1455,6 @@ static int swap_swapcount(struct swap_info_struct *si, swp_entry_t entry)
  	return count;
  }
  -/*
- * How many references to @entry are currently swapped out?
- * This does not give an exact answer when swap count is continued,
- * but does include the high COUNT_CONTINUED flag to allow for that.
- */
-int __swp_swapcount(swp_entry_t entry)
-{
-	int count = 0;
-	struct swap_info_struct *si;
-
-	si = get_swap_device(entry);
-	if (si) {
-		count = swap_swapcount(si, entry);
-		put_swap_device(si);
-	}
-	return count;
-}
-
  /*
   * How many references to @entry are currently swapped out?
   * This considers COUNT_CONTINUED so it returns exact answer.
author
#12 lore raw

PATCH 4/5 swap: remove get/put_swap_device() in __swap_duplicate()

In reply to Huang Ying

__swap_duplicate() is called by

- swap_shmem_alloc(): the page lock of the swap cache is held.

- copy_nonpresent_pte() -> swap_duplicate() and try_to_unmap_one() -> swap_duplicate(): the page table lock is held.

- __read_swap_cache_async() -> swapcache_prepare(): enclosed with get/put_swap_device() in __read_swap_cache_async() already.

So, it's safe to remove get/put_swap_device() in __swap_duplicate().

Cc David Hildenbrand <[email protected]>
Cc Hugh Dickins <[email protected]>
Cc Johannes Weiner <[email protected]>
Cc Matthew Wilcox <[email protected]>
Cc Michal Hocko <[email protected]>
Cc Minchan Kim <[email protected]>
Cc Tim Chen <[email protected]>
Cc Yang Shi <[email protected]>
Cc Yu Zhao <[email protected]>
---
 mm/swapfile.c | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)
mm/swapfile.c +1 -4
index e9cce775fb25..4dbaea64635d 100644
@@ -3264,9 +3264,7 @@ static int __swap_duplicate(swp_entry_t entry, unsigned char usage)
 	unsigned char has_cache;
 	int err;
 
-	p = get_swap_device(entry);
-	if (!p)
-		return -EINVAL;
+	p = swp_swap_info(entry);
 
 	offset = swp_offset(entry);
 	ci = lock_cluster_or_swap_info(p, offset);
@@ -3313,7 +3311,6 @@ static int __swap_duplicate(swp_entry_t entry, unsigned char usage)
 
 unlock_out:
 	unlock_cluster_or_swap_info(p, ci);
-	put_swap_device(p);
 	return err;
 }
 
Signature · 1 line
2.39.2
#13 lore raw

Re: [PATCH -V2 4/5] swap: remove get/put_swap_device() in __swap_duplicate()

Quoted 3 lines · Huang Ying

__swap_duplicate() is called by

- swap_shmem_alloc(): the page lock of the swap cache is held.

page lock of the swap cache? Did you really mean to say that or am I confused?

"Page lock of the page that is in the swap cache?"

Quoted 8 lines

- copy_nonpresent_pte() -> swap_duplicate() and try_to_unmap_one() -> swap_duplicate(): the page table lock is held.

- __read_swap_cache_async() -> swapcache_prepare(): enclosed with get/put_swap_device() in __read_swap_cache_async() already.

So, it's safe to remove get/put_swap_device() in __swap_duplicate().

Signature · 3 lines
Thanks,

David / dhildenb
#14 lore raw

Re: [PATCH -V2 4/5] swap: remove get/put_swap_device() in __swap_duplicate()

Quoted 8 lines · David Hildenbrand
Quoted 2 lines · Huang Ying

__swap_duplicate() is called by
- swap_shmem_alloc(): the page lock of the swap cache is held.

page lock of the swap cache? Did you really mean to say that or am I confused?

"Page lock of the page that is in the swap cache?"

Sorry for my poor English. Or make it shorter?

"the folio in the swap cache is locked"

Best Regards,
Huang, Ying

Quoted 6 lines
Quoted 6 lines

- copy_nonpresent_pte() -> swap_duplicate() and try_to_unmap_one() ->
swap_duplicate(): the page table lock is held.
- __read_swap_cache_async() -> swapcache_prepare(): enclosed with get/put_swap_device() in __read_swap_cache_async() already.
So, it's safe to remove get/put_swap_device() in __swap_duplicate().

#15 lore raw

Re: [PATCH -V2 4/5] swap: remove get/put_swap_device() in __swap_duplicate()

Quoted 6 lines · Ying
Quoted 4 lines · David Hildenbrand
Quoted 2 lines · Huang Ying

__swap_duplicate() is called by
- swap_shmem_alloc(): the page lock of the swap cache is held.

Quoted 8 lines
Quoted 4 lines

page lock of the swap cache? Did you really mean to say that or am I confused?

"Page lock of the page that is in the swap cache?"

Sorry for my poor English. Or make it shorter?

"the folio in the swap cache is locked"

Much clearer, thanks.

Signature · 3 lines
Thanks,

David / dhildenb
Reviewed-by on v1 4/5
#16 lore raw

Re: [PATCH -V2 4/5] swap: remove get/put_swap_device() in __swap_duplicate()

In reply to Huang Ying

mm/swapfile.c static int __swap_duplicate(swp_entry_t entry, unsigned char usage)

Quoted 32 lines · Huang Ying

__swap_duplicate() is called by

- swap_shmem_alloc(): the page lock of the swap cache is held.

- copy_nonpresent_pte() -> swap_duplicate() and try_to_unmap_one() -> swap_duplicate(): the page table lock is held.

- __read_swap_cache_async() -> swapcache_prepare(): enclosed with get/put_swap_device() in __read_swap_cache_async() already.

So, it's safe to remove get/put_swap_device() in __swap_duplicate().

Cc David Hildenbrand <[email protected]>
Cc Hugh Dickins <[email protected]>
Cc Johannes Weiner <[email protected]>
Cc Matthew Wilcox <[email protected]>
Cc Michal Hocko <[email protected]>
Cc Minchan Kim <[email protected]>
Cc Tim Chen <[email protected]>
Cc Yang Shi <[email protected]>
Cc Yu Zhao <[email protected]>
---
 mm/swapfile.c | 5 +----
 1 file changed, 1 insertion(+), 4 deletions(-)
mm/swapfile.c +0 -0
index e9cce775fb25..4dbaea64635d 100644
@@ -3264,9 +3264,7 @@ static int __swap_duplicate(swp_entry_t entry, unsigned char usage)

I would add a comment above this function stating that the caller needs to provide protection against swapoff, and refer to the comment above get_swap_device().

Otherwise, LGTM with David's comment.

Quoted 22 lines
mm/swapfile.c +1 -5
        unsigned char has_cache;
        int err;
 
-       p = get_swap_device(entry);
-       if (!p)
-               return -EINVAL;
+       p = swp_swap_info(entry);
 
        offset = swp_offset(entry);
        ci = lock_cluster_or_swap_info(p, offset);
@@ -3313,7 +3311,6 @@ static int __swap_duplicate(swp_entry_t entry, unsigned char usage)
 
 unlock_out:
        unlock_cluster_or_swap_info(p, ci);
-       put_swap_device(p);
        return err;
 }
 
--

2.39.2

author
#17 lore raw

PATCH 5/5 swap: comments get_swap_device() with usage rule

In reply to Huang Ying

The general rule to use a swap entry is as follows.

When we get a swap entry, if there isn't some other way to prevent swapoff, such as page lock for swap cache, page table lock, etc., the swap entry may become invalid because of swapoff. Then, we need to enclose all swap related functions with get_swap_device() and put_swap_device(), unless the swap functions call get/put_swap_device() by themselves.

Add the rule as comments of get_swap_device().

Cc David Hildenbrand <[email protected]>
Cc Hugh Dickins <[email protected]>
Cc Johannes Weiner <[email protected]>
Cc Matthew Wilcox <[email protected]>
Cc Michal Hocko <[email protected]>
Cc Minchan Kim <[email protected]>
Cc Tim Chen <[email protected]>
Cc Yang Shi <[email protected]>
Cc Yu Zhao <[email protected]>
---
 mm/swapfile.c | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)
mm/swapfile.c +9 -3
index 4dbaea64635d..0c1cb935b2eb 100644
@@ -1219,6 +1219,13 @@ static unsigned char __swap_entry_free_locked(struct swap_info_struct *p,
 }
 
 /*
+ * When we get a swap entry, if there isn't some other way to prevent
+ * swapoff, such as page lock for swap cache, page table lock, etc.,
+ * the swap entry may become invalid because of swapoff.  Then, we
+ * need to enclose all swap related functions with get_swap_device()
+ * and put_swap_device(), unless the swap functions call
+ * get/put_swap_device() by themselves.
+ *
  * Check whether swap entry is valid in the swap device.  If so,
  * return pointer to swap_info_struct, and keep the swap entry valid
  * via preventing the swap device from being swapoff, until
@@ -1227,9 +1234,8 @@ static unsigned char __swap_entry_free_locked(struct swap_info_struct *p,
  * Notice that swapoff or swapoff+swapon can still happen before the
  * percpu_ref_tryget_live() in get_swap_device() or after the
  * percpu_ref_put() in put_swap_device() if there isn't any other way
- * to prevent swapoff, such as page lock, page table lock, etc.  The
- * caller must be prepared for that.  For example, the following
- * situation is possible.
+ * to prevent swapoff.  The caller must be prepared for that.  For
+ * example, the following situation is possible.
  *
  *   CPU1				CPU2
  *   do_swap_page()
Signature · 1 line
2.39.2
Reviewed-by on v1 5/5
#18 lore raw

Re: [PATCH -V2 5/5] swap: comments get_swap_device() with usage rule

Quoted 30 lines · Huang Ying

The general rule to use a swap entry is as follows.

When we get a swap entry, if there isn't some other way to prevent swapoff, such as page lock for swap cache, page table lock, etc., the swap entry may become invalid because of swapoff. Then, we need to enclose all swap related functions with get_swap_device() and put_swap_device(), unless the swap functions call get/put_swap_device() by themselves.

Add the rule as comments of get_swap_device().

Cc David Hildenbrand <[email protected]>
Cc Hugh Dickins <[email protected]>
Cc Johannes Weiner <[email protected]>
Cc Matthew Wilcox <[email protected]>
Cc Michal Hocko <[email protected]>
Cc Minchan Kim <[email protected]>
Cc Tim Chen <[email protected]>
Cc Yang Shi <[email protected]>
Cc Yu Zhao <[email protected]>
---
  mm/swapfile.c | 12 +++++++++---
  1 file changed, 9 insertions(+), 3 deletions(-)
mm/swapfile.c +0 -0
index 4dbaea64635d..0c1cb935b2eb 100644

mm/swapfile.c static unsigned char __swap_entry_free_locked(struct swap_info_struct *p, · line 1223

Quoted 5 lines
mm/swapfile.c +2 -0
@@ -1219,6 +1219,13 @@ static unsigned char __swap_entry_free_locked(struct swap_info_struct *p,
  }
 
  /*
+ * When we get a swap entry, if there isn't some other way to prevent
+ * swapoff, such as page lock for swap cache, page table lock, etc.,

Again "page lock for swap cache" might be imprecise.

Quoted 10 lines
mm/swapfile.c +5 -0
+ * the swap entry may become invalid because of swapoff.  Then, we
+ * need to enclose all swap related functions with get_swap_device()
+ * and put_swap_device(), unless the swap functions call
+ * get/put_swap_device() by themselves.
+ *
   * Check whether swap entry is valid in the swap device.  If so,
   * return pointer to swap_info_struct, and keep the swap entry valid
   * via preventing the swap device from being swapoff, until
@@ -1227,9 +1234,8 @@ static unsigned char __swap_entry_free_locked(struct swap_info_struct *p,
   * Notice that swapoff or swapoff+swapon can still happen before the

mm/swapfile.c static unsigned char __swap_entry_free_locked(struct swap_info_struct *p, · line 1241

Quoted 10 lines
mm/swapfile.c +2 -3
   * percpu_ref_tryget_live() in get_swap_device() or after the
   * percpu_ref_put() in put_swap_device() if there isn't any other way
- * to prevent swapoff, such as page lock, page table lock, etc.  The
- * caller must be prepared for that.  For example, the following
- * situation is possible.
+ * to prevent swapoff.  The caller must be prepared for that.  For
+ * example, the following situation is possible.
   *
   *   CPU1				CPU2
   *   do_swap_page()
Signature · 3 lines
Thanks,

David / dhildenb
#19 lore raw

Re: [PATCH -V2 5/5] swap: comments get_swap_device() with usage rule

Quoted 25 lines · David Hildenbrand
Quoted 24 lines · Huang Ying

The general rule to use a swap entry is as follows.
When we get a swap entry, if there isn't some other way to prevent swapoff, such as page lock for swap cache, page table lock, etc., the swap entry may become invalid because of swapoff. Then, we need to enclose all swap related functions with get_swap_device() and put_swap_device(), unless the swap functions call get/put_swap_device() by themselves.
Add the rule as comments of get_swap_device().

Cc David Hildenbrand <[email protected]>
Cc Hugh Dickins <[email protected]>
Cc Johannes Weiner <[email protected]>
Cc Matthew Wilcox <[email protected]>
Cc Michal Hocko <[email protected]>
Cc Minchan Kim <[email protected]>
Cc Tim Chen <[email protected]>
Cc Yang Shi <[email protected]>
Cc Yu Zhao <[email protected]>
---
  mm/swapfile.c | 12 +++++++++---
  1 file changed, 9 insertions(+), 3 deletions(-)
mm/swapfile.c +0 -1
index 4dbaea64635d..0c1cb935b2eb 100644
--- a/mm/swapfile.c
Quoted 8 lines

mm/swapfile.c static unsigned char __swap_entry_free_locked(struct swap_info_struct *p, · line 1222

Quoted 6 lines

+++ b/mm/swapfile.c

mm/swapfile.c +2 -0
@@ -1219,6 +1219,13 @@ static unsigned char __swap_entry_free_locked(struct swap_info_struct *p,
  }
    /*
+ * When we get a swap entry, if there isn't some other way to prevent
+ * swapoff, such as page lock for swap cache, page table lock, etc.,

Again "page lock for swap cache" might be imprecise.

Sure. Will revise this.

Quoted 14 lines
Quoted 14 lines
mm/swapfile.c +5 -2
+ * the swap entry may become invalid because of swapoff.  Then, we
+ * need to enclose all swap related functions with get_swap_device()
+ * and put_swap_device(), unless the swap functions call
+ * get/put_swap_device() by themselves.
+ *
   * Check whether swap entry is valid in the swap device.  If so,
   * return pointer to swap_info_struct, and keep the swap entry valid
   * via preventing the swap device from being swapoff, until
@@ -1227,9 +1234,8 @@ static unsigned char __swap_entry_free_locked(struct swap_info_struct *p,
   * Notice that swapoff or swapoff+swapon can still happen before the
   * percpu_ref_tryget_live() in get_swap_device() or after the
   * percpu_ref_put() in put_swap_device() if there isn't any other way
- * to prevent swapoff, such as page lock, page table lock, etc.  The
- * caller must be prepared for that.  For example, the following
Quoted 8 lines

mm/swapfile.c static unsigned char __swap_entry_free_locked(struct swap_info_struct *p, · line 1241

Quoted 6 lines
mm/swapfile.c +2 -1
- * situation is possible.
+ * to prevent swapoff.  The caller must be prepared for that.  For
+ * example, the following situation is possible.
   *
   *   CPU1				CPU2
   *   do_swap_page()

Thanks!

Best Regards,
Huang, Ying

Reviewed-by on v1 5/5
#20 lore raw

Re: [PATCH -V2 5/5] swap: comments get_swap_device() with usage rule

In reply to Huang Ying
Quoted 57 lines · Huang Ying

The general rule to use a swap entry is as follows.

When we get a swap entry, if there isn't some other way to prevent swapoff, such as page lock for swap cache, page table lock, etc., the swap entry may become invalid because of swapoff. Then, we need to enclose all swap related functions with get_swap_device() and put_swap_device(), unless the swap functions call get/put_swap_device() by themselves.

Add the rule as comments of get_swap_device().

Cc David Hildenbrand <[email protected]>
Cc Hugh Dickins <[email protected]>
Cc Johannes Weiner <[email protected]>
Cc Matthew Wilcox <[email protected]>
Cc Michal Hocko <[email protected]>
Cc Minchan Kim <[email protected]>
Cc Tim Chen <[email protected]>
Cc Yang Shi <[email protected]>
Cc Yu Zhao <[email protected]>
---
 mm/swapfile.c | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)
mm/swapfile.c +9 -4
index 4dbaea64635d..0c1cb935b2eb 100644
@@ -1219,6 +1219,13 @@ static unsigned char __swap_entry_free_locked(struct swap_info_struct *p,
 }
 
 /*
+ * When we get a swap entry, if there isn't some other way to prevent
+ * swapoff, such as page lock for swap cache, page table lock, etc.,
+ * the swap entry may become invalid because of swapoff.  Then, we
+ * need to enclose all swap related functions with get_swap_device()
+ * and put_swap_device(), unless the swap functions call
+ * get/put_swap_device() by themselves.
+ *
  * Check whether swap entry is valid in the swap device.  If so,
  * return pointer to swap_info_struct, and keep the swap entry valid
  * via preventing the swap device from being swapoff, until
@@ -1227,9 +1234,8 @@ static unsigned char __swap_entry_free_locked(struct swap_info_struct *p,
  * Notice that swapoff or swapoff+swapon can still happen before the
  * percpu_ref_tryget_live() in get_swap_device() or after the
  * percpu_ref_put() in put_swap_device() if there isn't any other way
- * to prevent swapoff, such as page lock, page table lock, etc.  The
- * caller must be prepared for that.  For example, the following
- * situation is possible.
+ * to prevent swapoff.  The caller must be prepared for that.  For
+ * example, the following situation is possible.
  *
  *   CPU1                              CPU2
  *   do_swap_page()
--
Quoted 3 lines

2.39.2

Thanks for clarifying the code!

With David's comments: