blob: fd2f21e1c60ae051fb85a0adff3ef6e891e6a8bb [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001// SPDX-License-Identifier: GPL-2.0
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/*
3 * linux/mm/swap_state.c
4 *
5 * Copyright (C) 1991, 1992, 1993, 1994 Linus Torvalds
6 * Swap reorganised 29.12.95, Stephen Tweedie
7 *
8 * Rewritten to use page cache, (C) 1998 Stephen Tweedie
9 */
Linus Torvalds1da177e2005-04-16 15:20:36 -070010#include <linux/mm.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090011#include <linux/gfp.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#include <linux/kernel_stat.h>
13#include <linux/swap.h>
Hugh Dickins46017e92008-02-04 22:28:41 -080014#include <linux/swapops.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <linux/init.h>
16#include <linux/pagemap.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070017#include <linux/backing-dev.h>
Christian Ehrhardt3fb5c292012-07-31 16:41:44 -070018#include <linux/blkdev.h>
Hugh Dickinsc484d412006-01-06 00:10:55 -080019#include <linux/pagevec.h>
Christoph Lameterb20a3502006-03-22 00:09:12 -080020#include <linux/migrate.h>
Huang, Ying4b3ef9d2017-02-22 15:45:26 -080021#include <linux/vmalloc.h>
Tim Chen67afa382017-02-22 15:45:39 -080022#include <linux/swap_slots.h>
Huang Ying38d8b4e2017-07-06 15:37:18 -070023#include <linux/huge_mm.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070024
25#include <asm/pgtable.h>
26
27/*
28 * swapper_space is a fiction, retained to simplify the path through
Jens Axboe7eaceac2011-03-10 08:52:07 +010029 * vmscan's shrink_page_list.
Linus Torvalds1da177e2005-04-16 15:20:36 -070030 */
Christoph Hellwigf5e54d62006-06-28 04:26:44 -070031static const struct address_space_operations swap_aops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -070032 .writepage = swap_writepage,
Mel Gorman62c230b2012-07-31 16:44:55 -070033 .set_page_dirty = swap_set_page_dirty,
Andrew Morton1c939232014-10-09 15:27:59 -070034#ifdef CONFIG_MIGRATION
Christoph Lametere965f962006-02-01 03:05:41 -080035 .migratepage = migrate_page,
Andrew Morton1c939232014-10-09 15:27:59 -070036#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070037};
38
Changbin Du783cb682017-11-15 17:36:06 -080039struct address_space *swapper_spaces[MAX_SWAPFILES] __read_mostly;
40static unsigned int nr_swapper_spaces[MAX_SWAPFILES] __read_mostly;
Colin Ian Kingf5c754d2018-04-05 16:25:05 -070041static bool enable_vma_readahead __read_mostly = true;
Huang Yingec560172017-09-06 16:24:36 -070042
Huang Yingec560172017-09-06 16:24:36 -070043#define SWAP_RA_WIN_SHIFT (PAGE_SHIFT / 2)
44#define SWAP_RA_HITS_MASK ((1UL << SWAP_RA_WIN_SHIFT) - 1)
45#define SWAP_RA_HITS_MAX SWAP_RA_HITS_MASK
46#define SWAP_RA_WIN_MASK (~PAGE_MASK & ~SWAP_RA_HITS_MASK)
47
48#define SWAP_RA_HITS(v) ((v) & SWAP_RA_HITS_MASK)
49#define SWAP_RA_WIN(v) (((v) & SWAP_RA_WIN_MASK) >> SWAP_RA_WIN_SHIFT)
50#define SWAP_RA_ADDR(v) ((v) & PAGE_MASK)
51
52#define SWAP_RA_VAL(addr, win, hits) \
53 (((addr) & PAGE_MASK) | \
54 (((win) << SWAP_RA_WIN_SHIFT) & SWAP_RA_WIN_MASK) | \
55 ((hits) & SWAP_RA_HITS_MASK))
56
57/* Initial readahead hits is 4 to start up with a small window */
58#define GET_SWAP_RA_VAL(vma) \
59 (atomic_long_read(&(vma)->swap_readahead_info) ? : 4)
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
61#define INC_CACHE_INFO(x) do { swap_cache_info.x++; } while (0)
Huang Ying38d8b4e2017-07-06 15:37:18 -070062#define ADD_CACHE_INFO(x, nr) do { swap_cache_info.x += (nr); } while (0)
Linus Torvalds1da177e2005-04-16 15:20:36 -070063
64static struct {
65 unsigned long add_total;
66 unsigned long del_total;
67 unsigned long find_success;
68 unsigned long find_total;
Linus Torvalds1da177e2005-04-16 15:20:36 -070069} swap_cache_info;
70
Shaohua Li33806f02013-02-22 16:34:37 -080071unsigned long total_swapcache_pages(void)
72{
Huang, Ying4b3ef9d2017-02-22 15:45:26 -080073 unsigned int i, j, nr;
Shaohua Li33806f02013-02-22 16:34:37 -080074 unsigned long ret = 0;
Huang, Ying4b3ef9d2017-02-22 15:45:26 -080075 struct address_space *spaces;
Shaohua Li33806f02013-02-22 16:34:37 -080076
Huang, Ying4b3ef9d2017-02-22 15:45:26 -080077 rcu_read_lock();
78 for (i = 0; i < MAX_SWAPFILES; i++) {
79 /*
80 * The corresponding entries in nr_swapper_spaces and
81 * swapper_spaces will be reused only after at least
82 * one grace period. So it is impossible for them
83 * belongs to different usage.
84 */
85 nr = nr_swapper_spaces[i];
86 spaces = rcu_dereference(swapper_spaces[i]);
87 if (!nr || !spaces)
88 continue;
89 for (j = 0; j < nr; j++)
90 ret += spaces[j].nrpages;
91 }
92 rcu_read_unlock();
Shaohua Li33806f02013-02-22 16:34:37 -080093 return ret;
94}
95
Shaohua Li579f8292014-02-06 12:04:21 -080096static atomic_t swapin_readahead_hits = ATOMIC_INIT(4);
97
Linus Torvalds1da177e2005-04-16 15:20:36 -070098void show_swap_cache_info(void)
99{
Shaohua Li33806f02013-02-22 16:34:37 -0800100 printk("%lu pages in swap cache\n", total_swapcache_pages());
Johannes Weiner2c97b7f2008-07-25 19:46:01 -0700101 printk("Swap cache stats: add %lu, delete %lu, find %lu/%lu\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700102 swap_cache_info.add_total, swap_cache_info.del_total,
Hugh Dickinsbb63be02008-02-04 22:28:49 -0800103 swap_cache_info.find_success, swap_cache_info.find_total);
Shaohua Liec8acf22013-02-22 16:34:38 -0800104 printk("Free swap = %ldkB\n",
105 get_nr_swap_pages() << (PAGE_SHIFT - 10));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106 printk("Total swap = %lukB\n", total_swap_pages << (PAGE_SHIFT - 10));
107}
108
109/*
Matthew Wilcox8d93b412017-11-27 15:46:54 -0500110 * add_to_swap_cache resembles add_to_page_cache_locked on swapper_space,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111 * but sets SwapCache flag and private instead of mapping and index.
112 */
Matthew Wilcox8d93b412017-11-27 15:46:54 -0500113int add_to_swap_cache(struct page *page, swp_entry_t entry, gfp_t gfp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114{
Matthew Wilcox8d93b412017-11-27 15:46:54 -0500115 struct address_space *address_space = swap_address_space(entry);
Huang Ying38d8b4e2017-07-06 15:37:18 -0700116 pgoff_t idx = swp_offset(entry);
Matthew Wilcox8d93b412017-11-27 15:46:54 -0500117 XA_STATE_ORDER(xas, &address_space->i_pages, idx, compound_order(page));
118 unsigned long i, nr = 1UL << compound_order(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
Sasha Levin309381fea2014-01-23 15:52:54 -0800120 VM_BUG_ON_PAGE(!PageLocked(page), page);
121 VM_BUG_ON_PAGE(PageSwapCache(page), page);
122 VM_BUG_ON_PAGE(!PageSwapBacked(page), page);
Hugh Dickins51726b12009-01-06 14:39:25 -0800123
Huang Ying38d8b4e2017-07-06 15:37:18 -0700124 page_ref_add(page, nr);
Daisuke Nishimura31a56392009-09-21 17:02:50 -0700125 SetPageSwapCache(page);
Daisuke Nishimura31a56392009-09-21 17:02:50 -0700126
Matthew Wilcox8d93b412017-11-27 15:46:54 -0500127 do {
128 xas_lock_irq(&xas);
129 xas_create_range(&xas);
130 if (xas_error(&xas))
131 goto unlock;
132 for (i = 0; i < nr; i++) {
133 VM_BUG_ON_PAGE(xas.xa_index != idx + i, page);
134 set_page_private(page + i, entry.val + i);
135 xas_store(&xas, page + i);
136 xas_next(&xas);
137 }
Huang Ying38d8b4e2017-07-06 15:37:18 -0700138 address_space->nrpages += nr;
139 __mod_node_page_state(page_pgdat(page), NR_FILE_PAGES, nr);
140 ADD_CACHE_INFO(add_total, nr);
Matthew Wilcox8d93b412017-11-27 15:46:54 -0500141unlock:
142 xas_unlock_irq(&xas);
143 } while (xas_nomem(&xas, gfp));
Daisuke Nishimura31a56392009-09-21 17:02:50 -0700144
Matthew Wilcox8d93b412017-11-27 15:46:54 -0500145 if (!xas_error(&xas))
146 return 0;
Daisuke Nishimura31a56392009-09-21 17:02:50 -0700147
Matthew Wilcox8d93b412017-11-27 15:46:54 -0500148 ClearPageSwapCache(page);
149 page_ref_sub(page, nr);
150 return xas_error(&xas);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151}
152
Linus Torvalds1da177e2005-04-16 15:20:36 -0700153/*
154 * This must be called only on pages that have
155 * been verified to be in the swap cache.
156 */
Matthew Wilcox4e17ec22017-11-29 08:32:39 -0500157void __delete_from_swap_cache(struct page *page, swp_entry_t entry)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700158{
Matthew Wilcox4e17ec22017-11-29 08:32:39 -0500159 struct address_space *address_space = swap_address_space(entry);
Huang Ying38d8b4e2017-07-06 15:37:18 -0700160 int i, nr = hpage_nr_pages(page);
Matthew Wilcox4e17ec22017-11-29 08:32:39 -0500161 pgoff_t idx = swp_offset(entry);
162 XA_STATE(xas, &address_space->i_pages, idx);
Shaohua Li33806f02013-02-22 16:34:37 -0800163
Sasha Levin309381fea2014-01-23 15:52:54 -0800164 VM_BUG_ON_PAGE(!PageLocked(page), page);
165 VM_BUG_ON_PAGE(!PageSwapCache(page), page);
166 VM_BUG_ON_PAGE(PageWriteback(page), page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700167
Huang Ying38d8b4e2017-07-06 15:37:18 -0700168 for (i = 0; i < nr; i++) {
Matthew Wilcox4e17ec22017-11-29 08:32:39 -0500169 void *entry = xas_store(&xas, NULL);
170 VM_BUG_ON_PAGE(entry != page + i, entry);
Huang Ying38d8b4e2017-07-06 15:37:18 -0700171 set_page_private(page + i, 0);
Matthew Wilcox4e17ec22017-11-29 08:32:39 -0500172 xas_next(&xas);
Huang Ying38d8b4e2017-07-06 15:37:18 -0700173 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 ClearPageSwapCache(page);
Huang Ying38d8b4e2017-07-06 15:37:18 -0700175 address_space->nrpages -= nr;
176 __mod_node_page_state(page_pgdat(page), NR_FILE_PAGES, -nr);
177 ADD_CACHE_INFO(del_total, nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178}
179
180/**
181 * add_to_swap - allocate swap space for a page
182 * @page: page we want to move to swap
183 *
184 * Allocate swap space for the page and add the page to the
185 * swap cache. Caller needs to hold the page lock.
186 */
Minchan Kim0f074652017-07-06 15:37:24 -0700187int add_to_swap(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188{
189 swp_entry_t entry;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 int err;
191
Sasha Levin309381fea2014-01-23 15:52:54 -0800192 VM_BUG_ON_PAGE(!PageLocked(page), page);
193 VM_BUG_ON_PAGE(!PageUptodate(page), page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194
Huang Ying38d8b4e2017-07-06 15:37:18 -0700195 entry = get_swap_page(page);
Daisuke Nishimura2ca45322009-09-21 17:02:52 -0700196 if (!entry.val)
Minchan Kim0f074652017-07-06 15:37:24 -0700197 return 0;
198
Daisuke Nishimura2ca45322009-09-21 17:02:52 -0700199 /*
Matthew Wilcox8d93b412017-11-27 15:46:54 -0500200 * XArray node allocations from PF_MEMALLOC contexts could
Daisuke Nishimura2ca45322009-09-21 17:02:52 -0700201 * completely exhaust the page allocator. __GFP_NOMEMALLOC
202 * stops emergency reserves from being allocated.
203 *
204 * TODO: this could cause a theoretical memory reclaim
205 * deadlock in the swap out path.
206 */
207 /*
Minchan Kim854e9ed2016-01-15 16:54:53 -0800208 * Add it to the swap cache.
Daisuke Nishimura2ca45322009-09-21 17:02:52 -0700209 */
210 err = add_to_swap_cache(page, entry,
211 __GFP_HIGH|__GFP_NOMEMALLOC|__GFP_NOWARN);
Huang Ying38d8b4e2017-07-06 15:37:18 -0700212 if (err)
Daisuke Nishimura2ca45322009-09-21 17:02:52 -0700213 /*
214 * add_to_swap_cache() doesn't return -EEXIST, so we can safely
215 * clear SWAP_HAS_CACHE flag.
216 */
Minchan Kim0f074652017-07-06 15:37:24 -0700217 goto fail;
Shaohua Li96254562017-10-03 16:15:32 -0700218 /*
219 * Normally the page will be dirtied in unmap because its pte should be
220 * dirty. A special case is MADV_FREE page. The page'e pte could have
221 * dirty bit cleared but the page's SwapBacked bit is still set because
222 * clearing the dirty bit and SwapBacked bit has no lock protected. For
223 * such page, unmap will not set dirty bit for it, so page reclaim will
224 * not write the page out. This can cause data corruption when the page
225 * is swap in later. Always setting the dirty bit for the page solves
226 * the problem.
227 */
228 set_page_dirty(page);
Huang Ying38d8b4e2017-07-06 15:37:18 -0700229
230 return 1;
231
Huang Ying38d8b4e2017-07-06 15:37:18 -0700232fail:
Minchan Kim0f074652017-07-06 15:37:24 -0700233 put_swap_page(page, entry);
Huang Ying38d8b4e2017-07-06 15:37:18 -0700234 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235}
236
237/*
238 * This must be called only on pages that have
239 * been verified to be in the swap cache and locked.
240 * It will never put the page into the free list,
241 * the caller has a reference on the page.
242 */
243void delete_from_swap_cache(struct page *page)
244{
Matthew Wilcox4e17ec22017-11-29 08:32:39 -0500245 swp_entry_t entry = { .val = page_private(page) };
246 struct address_space *address_space = swap_address_space(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700248 xa_lock_irq(&address_space->i_pages);
Matthew Wilcox4e17ec22017-11-29 08:32:39 -0500249 __delete_from_swap_cache(page, entry);
Matthew Wilcoxb93b0162018-04-10 16:36:56 -0700250 xa_unlock_irq(&address_space->i_pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251
Minchan Kim75f6d6d2017-07-06 15:37:21 -0700252 put_swap_page(page, entry);
Huang Ying38d8b4e2017-07-06 15:37:18 -0700253 page_ref_sub(page, hpage_nr_pages(page));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254}
255
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256/*
257 * If we are the only user, then try to free up the swap cache.
258 *
259 * Its ok to check for PageSwapCache without the page lock
Hugh Dickinsa2c43ee2009-01-06 14:39:36 -0800260 * here because we are going to recheck again inside
261 * try_to_free_swap() _with_ the lock.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 * - Marcelo
263 */
264static inline void free_swap_cache(struct page *page)
265{
Hugh Dickinsa2c43ee2009-01-06 14:39:36 -0800266 if (PageSwapCache(page) && !page_mapped(page) && trylock_page(page)) {
267 try_to_free_swap(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 unlock_page(page);
269 }
270}
271
272/*
273 * Perform a free_page(), also freeing any swap cache associated with
Hugh Dickinsb8072f02005-10-29 18:16:41 -0700274 * this page if it is the last user of the page.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 */
276void free_page_and_swap_cache(struct page *page)
277{
278 free_swap_cache(page);
Aaron Lu6fcb52a2016-10-07 17:00:08 -0700279 if (!is_huge_zero_page(page))
Gerald Schaefer770a5372016-06-08 15:33:50 -0700280 put_page(page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281}
282
283/*
284 * Passed an array of pages, drop them all from swapcache and then release
285 * them. They are removed from the LRU and freed if this is their last use.
286 */
287void free_pages_and_swap_cache(struct page **pages, int nr)
288{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 struct page **pagep = pages;
Michal Hockoaabfb572014-10-09 15:28:52 -0700290 int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
292 lru_add_drain();
Michal Hockoaabfb572014-10-09 15:28:52 -0700293 for (i = 0; i < nr; i++)
294 free_swap_cache(pagep[i]);
Mel Gormanc6f92f92017-11-15 17:37:55 -0800295 release_pages(pagep, nr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296}
297
Minchan Kime9e9b7e2018-04-05 16:23:42 -0700298static inline bool swap_use_vma_readahead(void)
299{
300 return READ_ONCE(enable_vma_readahead) && !atomic_read(&nr_rotate_swap);
301}
302
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303/*
304 * Lookup a swap entry in the swap cache. A found page will be returned
305 * unlocked and with its refcount incremented - we rely on the kernel
306 * lock getting page table operations atomic even if we drop the page
307 * lock before returning.
308 */
Huang Yingec560172017-09-06 16:24:36 -0700309struct page *lookup_swap_cache(swp_entry_t entry, struct vm_area_struct *vma,
310 unsigned long addr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311{
312 struct page *page;
313
Huang Yingf6ab1f72016-10-07 17:00:21 -0700314 page = find_get_page(swap_address_space(entry), swp_offset(entry));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315
Huang Yingec560172017-09-06 16:24:36 -0700316 INC_CACHE_INFO(find_total);
317 if (page) {
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700318 bool vma_ra = swap_use_vma_readahead();
319 bool readahead;
320
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 INC_CACHE_INFO(find_success);
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700322 /*
323 * At the moment, we don't support PG_readahead for anon THP
324 * so let's bail out rather than confusing the readahead stat.
325 */
Huang Yingec560172017-09-06 16:24:36 -0700326 if (unlikely(PageTransCompound(page)))
327 return page;
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700328
Huang Yingec560172017-09-06 16:24:36 -0700329 readahead = TestClearPageReadahead(page);
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700330 if (vma && vma_ra) {
331 unsigned long ra_val;
332 int win, hits;
333
334 ra_val = GET_SWAP_RA_VAL(vma);
335 win = SWAP_RA_WIN(ra_val);
336 hits = SWAP_RA_HITS(ra_val);
Huang Yingec560172017-09-06 16:24:36 -0700337 if (readahead)
338 hits = min_t(int, hits + 1, SWAP_RA_HITS_MAX);
339 atomic_long_set(&vma->swap_readahead_info,
340 SWAP_RA_VAL(addr, win, hits));
341 }
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700342
Huang Yingec560172017-09-06 16:24:36 -0700343 if (readahead) {
Huang Yingcbc65df2017-09-06 16:24:29 -0700344 count_vm_event(SWAP_RA_HIT);
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700345 if (!vma || !vma_ra)
Huang Yingec560172017-09-06 16:24:36 -0700346 atomic_inc(&swapin_readahead_hits);
Huang Yingcbc65df2017-09-06 16:24:29 -0700347 }
Shaohua Li579f8292014-02-06 12:04:21 -0800348 }
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700349
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350 return page;
351}
352
Dmitry Safonov5b999aa2015-09-08 15:05:00 -0700353struct page *__read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
354 struct vm_area_struct *vma, unsigned long addr,
355 bool *new_page_allocated)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356{
357 struct page *found_page, *new_page = NULL;
Dmitry Safonov5b999aa2015-09-08 15:05:00 -0700358 struct address_space *swapper_space = swap_address_space(entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359 int err;
Dmitry Safonov5b999aa2015-09-08 15:05:00 -0700360 *new_page_allocated = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700361
362 do {
363 /*
364 * First check the swap cache. Since this is normally
365 * called after lookup_swap_cache() failed, re-calling
366 * that would confuse statistics.
367 */
Huang Yingf6ab1f72016-10-07 17:00:21 -0700368 found_page = find_get_page(swapper_space, swp_offset(entry));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700369 if (found_page)
370 break;
371
Huang Yingba81f832017-02-22 15:45:46 -0800372 /*
373 * Just skip read ahead for unused swap slot.
374 * During swap_off when swap_slot_cache is disabled,
375 * we have to handle the race between putting
376 * swap entry in swap cache and marking swap slot
377 * as SWAP_HAS_CACHE. That's done in later part of code or
378 * else swap_off will be aborted if we return NULL.
379 */
380 if (!__swp_swapcount(entry) && swap_slot_cache_enabled)
381 break;
Tim Chene8c26ab2017-02-22 15:45:29 -0800382
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 /*
384 * Get a new page to read into from swap.
385 */
386 if (!new_page) {
Hugh Dickins02098fe2008-02-04 22:28:42 -0800387 new_page = alloc_page_vma(gfp_mask, vma, addr);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700388 if (!new_page)
389 break; /* Out of memory */
390 }
391
392 /*
Hugh Dickinsf0009442008-02-04 22:28:49 -0800393 * Swap entry may have been freed since our caller observed it.
394 */
KAMEZAWA Hiroyuki355cfa72009-06-16 15:32:53 -0700395 err = swapcache_prepare(entry);
Rafael Aquinicbab0e42013-06-12 14:04:49 -0700396 if (err == -EEXIST) {
Rafael Aquinicbab0e42013-06-12 14:04:49 -0700397 /*
398 * We might race against get_swap_page() and stumble
399 * across a SWAP_HAS_CACHE swap_map entry whose page
Huang Ying9c1cc2e2017-05-03 14:54:33 -0700400 * has not been brought into the swapcache yet.
Rafael Aquinicbab0e42013-06-12 14:04:49 -0700401 */
402 cond_resched();
KAMEZAWA Hiroyuki355cfa72009-06-16 15:32:53 -0700403 continue;
Matthew Wilcox8d93b412017-11-27 15:46:54 -0500404 } else if (err) /* swp entry is obsolete ? */
Hugh Dickinsf0009442008-02-04 22:28:49 -0800405 break;
406
Matthew Wilcox8d93b412017-11-27 15:46:54 -0500407 /* May fail (-ENOMEM) if XArray node allocation failed. */
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800408 __SetPageLocked(new_page);
Hugh Dickinsfa9949d2016-05-19 17:12:41 -0700409 __SetPageSwapBacked(new_page);
Matthew Wilcox8d93b412017-11-27 15:46:54 -0500410 err = add_to_swap_cache(new_page, entry, gfp_mask & GFP_KERNEL);
Nick Piggin529ae9a2008-08-02 12:01:03 +0200411 if (likely(!err)) {
Matthew Wilcox8d93b412017-11-27 15:46:54 -0500412 /* Initiate read into locked page */
Johannes Weiner1899ad12018-10-26 15:06:04 -0700413 SetPageWorkingset(new_page);
Rik van Rielc5fdae42008-10-18 20:26:36 -0700414 lru_cache_add_anon(new_page);
Dmitry Safonov5b999aa2015-09-08 15:05:00 -0700415 *new_page_allocated = true;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416 return new_page;
417 }
Kirill A. Shutemov48c935a2016-01-15 16:51:24 -0800418 __ClearPageLocked(new_page);
Daisuke Nishimura2ca45322009-09-21 17:02:52 -0700419 /*
420 * add_to_swap_cache() doesn't return -EEXIST, so we can safely
421 * clear SWAP_HAS_CACHE flag.
422 */
Minchan Kim75f6d6d2017-07-06 15:37:21 -0700423 put_swap_page(new_page, entry);
Hugh Dickinsf0009442008-02-04 22:28:49 -0800424 } while (err != -ENOMEM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425
426 if (new_page)
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300427 put_page(new_page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700428 return found_page;
429}
Hugh Dickins46017e92008-02-04 22:28:41 -0800430
Dmitry Safonov5b999aa2015-09-08 15:05:00 -0700431/*
432 * Locate a page of swap in physical memory, reserving swap cache space
433 * and reading the disk if it is not already cached.
434 * A failure return means that either the page allocation failed or that
435 * the swap entry is no longer in use.
436 */
437struct page *read_swap_cache_async(swp_entry_t entry, gfp_t gfp_mask,
Shaohua Li23955622017-07-10 15:47:11 -0700438 struct vm_area_struct *vma, unsigned long addr, bool do_poll)
Dmitry Safonov5b999aa2015-09-08 15:05:00 -0700439{
440 bool page_was_allocated;
441 struct page *retpage = __read_swap_cache_async(entry, gfp_mask,
442 vma, addr, &page_was_allocated);
443
444 if (page_was_allocated)
Shaohua Li23955622017-07-10 15:47:11 -0700445 swap_readpage(retpage, do_poll);
Dmitry Safonov5b999aa2015-09-08 15:05:00 -0700446
447 return retpage;
448}
449
Huang Yingec560172017-09-06 16:24:36 -0700450static unsigned int __swapin_nr_pages(unsigned long prev_offset,
451 unsigned long offset,
452 int hits,
453 int max_pages,
454 int prev_win)
Shaohua Li579f8292014-02-06 12:04:21 -0800455{
Huang Yingec560172017-09-06 16:24:36 -0700456 unsigned int pages, last_ra;
Shaohua Li579f8292014-02-06 12:04:21 -0800457
458 /*
459 * This heuristic has been found to work well on both sequential and
460 * random loads, swapping to hard disk or to SSD: please don't ask
461 * what the "+ 2" means, it just happens to work well, that's all.
462 */
Huang Yingec560172017-09-06 16:24:36 -0700463 pages = hits + 2;
Shaohua Li579f8292014-02-06 12:04:21 -0800464 if (pages == 2) {
465 /*
466 * We can have no readahead hits to judge by: but must not get
467 * stuck here forever, so check for an adjacent offset instead
468 * (and don't even bother to check whether swap type is same).
469 */
470 if (offset != prev_offset + 1 && offset != prev_offset - 1)
471 pages = 1;
Shaohua Li579f8292014-02-06 12:04:21 -0800472 } else {
473 unsigned int roundup = 4;
474 while (roundup < pages)
475 roundup <<= 1;
476 pages = roundup;
477 }
478
479 if (pages > max_pages)
480 pages = max_pages;
481
482 /* Don't shrink readahead too fast */
Huang Yingec560172017-09-06 16:24:36 -0700483 last_ra = prev_win / 2;
Shaohua Li579f8292014-02-06 12:04:21 -0800484 if (pages < last_ra)
485 pages = last_ra;
Huang Yingec560172017-09-06 16:24:36 -0700486
487 return pages;
488}
489
490static unsigned long swapin_nr_pages(unsigned long offset)
491{
492 static unsigned long prev_offset;
493 unsigned int hits, pages, max_pages;
494 static atomic_t last_readahead_pages;
495
496 max_pages = 1 << READ_ONCE(page_cluster);
497 if (max_pages <= 1)
498 return 1;
499
500 hits = atomic_xchg(&swapin_readahead_hits, 0);
501 pages = __swapin_nr_pages(prev_offset, offset, hits, max_pages,
502 atomic_read(&last_readahead_pages));
503 if (!hits)
504 prev_offset = offset;
Shaohua Li579f8292014-02-06 12:04:21 -0800505 atomic_set(&last_readahead_pages, pages);
506
507 return pages;
508}
509
Hugh Dickins46017e92008-02-04 22:28:41 -0800510/**
Minchan Kime9e9b7e2018-04-05 16:23:42 -0700511 * swap_cluster_readahead - swap in pages in hope we need them soon
Hugh Dickins46017e92008-02-04 22:28:41 -0800512 * @entry: swap entry of this memory
Randy Dunlap76824862008-03-19 17:00:40 -0700513 * @gfp_mask: memory allocation flags
Minchan Kime9e9b7e2018-04-05 16:23:42 -0700514 * @vmf: fault information
Hugh Dickins46017e92008-02-04 22:28:41 -0800515 *
516 * Returns the struct page for entry and addr, after queueing swapin.
517 *
518 * Primitive swap readahead code. We simply read an aligned block of
519 * (1 << page_cluster) entries in the swap area. This method is chosen
520 * because it doesn't cost us any seek time. We also make sure to queue
521 * the 'original' request together with the readahead ones...
522 *
523 * This has been extended to use the NUMA policies from the mm triggering
524 * the readahead.
525 *
Minchan Kime9e9b7e2018-04-05 16:23:42 -0700526 * Caller must hold down_read on the vma->vm_mm if vmf->vma is not NULL.
Hugh Dickins46017e92008-02-04 22:28:41 -0800527 */
Minchan Kime9e9b7e2018-04-05 16:23:42 -0700528struct page *swap_cluster_readahead(swp_entry_t entry, gfp_t gfp_mask,
529 struct vm_fault *vmf)
Hugh Dickins46017e92008-02-04 22:28:41 -0800530{
Hugh Dickins46017e92008-02-04 22:28:41 -0800531 struct page *page;
Shaohua Li579f8292014-02-06 12:04:21 -0800532 unsigned long entry_offset = swp_offset(entry);
533 unsigned long offset = entry_offset;
Rik van Riel67f96aa2012-03-21 16:33:50 -0700534 unsigned long start_offset, end_offset;
Shaohua Li579f8292014-02-06 12:04:21 -0800535 unsigned long mask;
Huang Yinge9a6eff2017-11-15 17:33:15 -0800536 struct swap_info_struct *si = swp_swap_info(entry);
Christian Ehrhardt3fb5c292012-07-31 16:41:44 -0700537 struct blk_plug plug;
Huang Yingc4fa6302017-09-06 16:24:33 -0700538 bool do_poll = true, page_allocated;
Minchan Kime9e9b7e2018-04-05 16:23:42 -0700539 struct vm_area_struct *vma = vmf->vma;
540 unsigned long addr = vmf->address;
Hugh Dickins46017e92008-02-04 22:28:41 -0800541
Shaohua Li579f8292014-02-06 12:04:21 -0800542 mask = swapin_nr_pages(offset) - 1;
543 if (!mask)
544 goto skip;
545
Shaohua Li23955622017-07-10 15:47:11 -0700546 do_poll = false;
Rik van Riel67f96aa2012-03-21 16:33:50 -0700547 /* Read a page_cluster sized and aligned cluster around offset. */
548 start_offset = offset & ~mask;
549 end_offset = offset | mask;
550 if (!start_offset) /* First page is swap header. */
551 start_offset++;
Huang Yinge9a6eff2017-11-15 17:33:15 -0800552 if (end_offset >= si->max)
553 end_offset = si->max - 1;
Rik van Riel67f96aa2012-03-21 16:33:50 -0700554
Christian Ehrhardt3fb5c292012-07-31 16:41:44 -0700555 blk_start_plug(&plug);
Rik van Riel67f96aa2012-03-21 16:33:50 -0700556 for (offset = start_offset; offset <= end_offset ; offset++) {
Hugh Dickins46017e92008-02-04 22:28:41 -0800557 /* Ok, do the async read-ahead now */
Huang Yingc4fa6302017-09-06 16:24:33 -0700558 page = __read_swap_cache_async(
559 swp_entry(swp_type(entry), offset),
560 gfp_mask, vma, addr, &page_allocated);
Hugh Dickins46017e92008-02-04 22:28:41 -0800561 if (!page)
Rik van Riel67f96aa2012-03-21 16:33:50 -0700562 continue;
Huang Yingc4fa6302017-09-06 16:24:33 -0700563 if (page_allocated) {
564 swap_readpage(page, false);
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700565 if (offset != entry_offset) {
Huang Yingc4fa6302017-09-06 16:24:33 -0700566 SetPageReadahead(page);
567 count_vm_event(SWAP_RA);
568 }
Huang Yingcbc65df2017-09-06 16:24:29 -0700569 }
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300570 put_page(page);
Hugh Dickins46017e92008-02-04 22:28:41 -0800571 }
Christian Ehrhardt3fb5c292012-07-31 16:41:44 -0700572 blk_finish_plug(&plug);
573
Hugh Dickins46017e92008-02-04 22:28:41 -0800574 lru_add_drain(); /* Push any new pages onto the LRU now */
Shaohua Li579f8292014-02-06 12:04:21 -0800575skip:
Shaohua Li23955622017-07-10 15:47:11 -0700576 return read_swap_cache_async(entry, gfp_mask, vma, addr, do_poll);
Hugh Dickins46017e92008-02-04 22:28:41 -0800577}
Huang, Ying4b3ef9d2017-02-22 15:45:26 -0800578
579int init_swap_address_space(unsigned int type, unsigned long nr_pages)
580{
581 struct address_space *spaces, *space;
582 unsigned int i, nr;
583
584 nr = DIV_ROUND_UP(nr_pages, SWAP_ADDRESS_SPACE_PAGES);
Kees Cook778e1cd2018-06-12 14:04:48 -0700585 spaces = kvcalloc(nr, sizeof(struct address_space), GFP_KERNEL);
Huang, Ying4b3ef9d2017-02-22 15:45:26 -0800586 if (!spaces)
587 return -ENOMEM;
588 for (i = 0; i < nr; i++) {
589 space = spaces + i;
Matthew Wilcoxa2833482017-12-05 19:04:20 -0500590 xa_init_flags(&space->i_pages, XA_FLAGS_LOCK_IRQ);
Huang, Ying4b3ef9d2017-02-22 15:45:26 -0800591 atomic_set(&space->i_mmap_writable, 0);
592 space->a_ops = &swap_aops;
593 /* swap cache doesn't use writeback related tags */
594 mapping_set_no_writeback_tags(space);
Huang, Ying4b3ef9d2017-02-22 15:45:26 -0800595 }
596 nr_swapper_spaces[type] = nr;
597 rcu_assign_pointer(swapper_spaces[type], spaces);
598
599 return 0;
600}
601
602void exit_swap_address_space(unsigned int type)
603{
604 struct address_space *spaces;
605
606 spaces = swapper_spaces[type];
607 nr_swapper_spaces[type] = 0;
608 rcu_assign_pointer(swapper_spaces[type], NULL);
609 synchronize_rcu();
610 kvfree(spaces);
611}
Huang Yingec560172017-09-06 16:24:36 -0700612
613static inline void swap_ra_clamp_pfn(struct vm_area_struct *vma,
614 unsigned long faddr,
615 unsigned long lpfn,
616 unsigned long rpfn,
617 unsigned long *start,
618 unsigned long *end)
619{
620 *start = max3(lpfn, PFN_DOWN(vma->vm_start),
621 PFN_DOWN(faddr & PMD_MASK));
622 *end = min3(rpfn, PFN_DOWN(vma->vm_end),
623 PFN_DOWN((faddr & PMD_MASK) + PMD_SIZE));
624}
625
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700626static void swap_ra_info(struct vm_fault *vmf,
627 struct vma_swap_readahead *ra_info)
Huang Yingec560172017-09-06 16:24:36 -0700628{
629 struct vm_area_struct *vma = vmf->vma;
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700630 unsigned long ra_val;
Huang Yingec560172017-09-06 16:24:36 -0700631 swp_entry_t entry;
632 unsigned long faddr, pfn, fpfn;
633 unsigned long start, end;
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700634 pte_t *pte, *orig_pte;
Huang Yingec560172017-09-06 16:24:36 -0700635 unsigned int max_win, hits, prev_win, win, left;
636#ifndef CONFIG_64BIT
637 pte_t *tpte;
638#endif
639
Huang Ying61b63972017-10-13 15:58:29 -0700640 max_win = 1 << min_t(unsigned int, READ_ONCE(page_cluster),
641 SWAP_RA_ORDER_CEILING);
642 if (max_win == 1) {
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700643 ra_info->win = 1;
644 return;
Huang Ying61b63972017-10-13 15:58:29 -0700645 }
646
Huang Yingec560172017-09-06 16:24:36 -0700647 faddr = vmf->address;
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700648 orig_pte = pte = pte_offset_map(vmf->pmd, faddr);
649 entry = pte_to_swp_entry(*pte);
650 if ((unlikely(non_swap_entry(entry)))) {
651 pte_unmap(orig_pte);
652 return;
653 }
Huang Yingec560172017-09-06 16:24:36 -0700654
Huang Yingec560172017-09-06 16:24:36 -0700655 fpfn = PFN_DOWN(faddr);
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700656 ra_val = GET_SWAP_RA_VAL(vma);
657 pfn = PFN_DOWN(SWAP_RA_ADDR(ra_val));
658 prev_win = SWAP_RA_WIN(ra_val);
659 hits = SWAP_RA_HITS(ra_val);
660 ra_info->win = win = __swapin_nr_pages(pfn, fpfn, hits,
Huang Yingec560172017-09-06 16:24:36 -0700661 max_win, prev_win);
662 atomic_long_set(&vma->swap_readahead_info,
663 SWAP_RA_VAL(faddr, win, 0));
664
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700665 if (win == 1) {
666 pte_unmap(orig_pte);
667 return;
668 }
Huang Yingec560172017-09-06 16:24:36 -0700669
670 /* Copy the PTEs because the page table may be unmapped */
671 if (fpfn == pfn + 1)
672 swap_ra_clamp_pfn(vma, faddr, fpfn, fpfn + win, &start, &end);
673 else if (pfn == fpfn + 1)
674 swap_ra_clamp_pfn(vma, faddr, fpfn - win + 1, fpfn + 1,
675 &start, &end);
676 else {
677 left = (win - 1) / 2;
678 swap_ra_clamp_pfn(vma, faddr, fpfn - left, fpfn + win - left,
679 &start, &end);
680 }
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700681 ra_info->nr_pte = end - start;
682 ra_info->offset = fpfn - start;
683 pte -= ra_info->offset;
Huang Yingec560172017-09-06 16:24:36 -0700684#ifdef CONFIG_64BIT
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700685 ra_info->ptes = pte;
Huang Yingec560172017-09-06 16:24:36 -0700686#else
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700687 tpte = ra_info->ptes;
Huang Yingec560172017-09-06 16:24:36 -0700688 for (pfn = start; pfn != end; pfn++)
689 *tpte++ = *pte++;
690#endif
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700691 pte_unmap(orig_pte);
Huang Yingec560172017-09-06 16:24:36 -0700692}
693
Colin Ian Kingf5c754d2018-04-05 16:25:05 -0700694static struct page *swap_vma_readahead(swp_entry_t fentry, gfp_t gfp_mask,
695 struct vm_fault *vmf)
Huang Yingec560172017-09-06 16:24:36 -0700696{
697 struct blk_plug plug;
698 struct vm_area_struct *vma = vmf->vma;
699 struct page *page;
700 pte_t *pte, pentry;
701 swp_entry_t entry;
702 unsigned int i;
703 bool page_allocated;
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700704 struct vma_swap_readahead ra_info = {0,};
Huang Yingec560172017-09-06 16:24:36 -0700705
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700706 swap_ra_info(vmf, &ra_info);
707 if (ra_info.win == 1)
Huang Yingec560172017-09-06 16:24:36 -0700708 goto skip;
709
710 blk_start_plug(&plug);
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700711 for (i = 0, pte = ra_info.ptes; i < ra_info.nr_pte;
Huang Yingec560172017-09-06 16:24:36 -0700712 i++, pte++) {
713 pentry = *pte;
714 if (pte_none(pentry))
715 continue;
716 if (pte_present(pentry))
717 continue;
718 entry = pte_to_swp_entry(pentry);
719 if (unlikely(non_swap_entry(entry)))
720 continue;
721 page = __read_swap_cache_async(entry, gfp_mask, vma,
722 vmf->address, &page_allocated);
723 if (!page)
724 continue;
725 if (page_allocated) {
726 swap_readpage(page, false);
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700727 if (i != ra_info.offset) {
Huang Yingec560172017-09-06 16:24:36 -0700728 SetPageReadahead(page);
729 count_vm_event(SWAP_RA);
730 }
731 }
732 put_page(page);
733 }
734 blk_finish_plug(&plug);
735 lru_add_drain();
736skip:
737 return read_swap_cache_async(fentry, gfp_mask, vma, vmf->address,
Minchan Kimeaf649eb2018-04-05 16:23:39 -0700738 ra_info.win == 1);
Huang Yingec560172017-09-06 16:24:36 -0700739}
Huang Yingd9bfcfd2017-09-06 16:24:40 -0700740
Minchan Kime9e9b7e2018-04-05 16:23:42 -0700741/**
742 * swapin_readahead - swap in pages in hope we need them soon
743 * @entry: swap entry of this memory
744 * @gfp_mask: memory allocation flags
745 * @vmf: fault information
746 *
747 * Returns the struct page for entry and addr, after queueing swapin.
748 *
749 * It's a main entry function for swap readahead. By the configuration,
750 * it will read ahead blocks by cluster-based(ie, physical disk based)
751 * or vma-based(ie, virtual address based on faulty address) readahead.
752 */
753struct page *swapin_readahead(swp_entry_t entry, gfp_t gfp_mask,
754 struct vm_fault *vmf)
755{
756 return swap_use_vma_readahead() ?
757 swap_vma_readahead(entry, gfp_mask, vmf) :
758 swap_cluster_readahead(entry, gfp_mask, vmf);
759}
760
Huang Yingd9bfcfd2017-09-06 16:24:40 -0700761#ifdef CONFIG_SYSFS
762static ssize_t vma_ra_enabled_show(struct kobject *kobj,
763 struct kobj_attribute *attr, char *buf)
764{
Minchan Kime9e9b7e2018-04-05 16:23:42 -0700765 return sprintf(buf, "%s\n", enable_vma_readahead ? "true" : "false");
Huang Yingd9bfcfd2017-09-06 16:24:40 -0700766}
767static ssize_t vma_ra_enabled_store(struct kobject *kobj,
768 struct kobj_attribute *attr,
769 const char *buf, size_t count)
770{
771 if (!strncmp(buf, "true", 4) || !strncmp(buf, "1", 1))
Minchan Kime9e9b7e2018-04-05 16:23:42 -0700772 enable_vma_readahead = true;
Huang Yingd9bfcfd2017-09-06 16:24:40 -0700773 else if (!strncmp(buf, "false", 5) || !strncmp(buf, "0", 1))
Minchan Kime9e9b7e2018-04-05 16:23:42 -0700774 enable_vma_readahead = false;
Huang Yingd9bfcfd2017-09-06 16:24:40 -0700775 else
776 return -EINVAL;
777
778 return count;
779}
780static struct kobj_attribute vma_ra_enabled_attr =
781 __ATTR(vma_ra_enabled, 0644, vma_ra_enabled_show,
782 vma_ra_enabled_store);
783
Huang Yingd9bfcfd2017-09-06 16:24:40 -0700784static struct attribute *swap_attrs[] = {
785 &vma_ra_enabled_attr.attr,
Huang Yingd9bfcfd2017-09-06 16:24:40 -0700786 NULL,
787};
788
789static struct attribute_group swap_attr_group = {
790 .attrs = swap_attrs,
791};
792
793static int __init swap_init_sysfs(void)
794{
795 int err;
796 struct kobject *swap_kobj;
797
798 swap_kobj = kobject_create_and_add("swap", mm_kobj);
799 if (!swap_kobj) {
800 pr_err("failed to create swap kobject\n");
801 return -ENOMEM;
802 }
803 err = sysfs_create_group(swap_kobj, &swap_attr_group);
804 if (err) {
805 pr_err("failed to register swap group\n");
806 goto delete_obj;
807 }
808 return 0;
809
810delete_obj:
811 kobject_put(swap_kobj);
812 return err;
813}
814subsys_initcall(swap_init_sysfs);
815#endif