blob: 4c5974bb9ba94191f295bd0c2f7fc3daa87003b3 [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#ifndef _LINUX_SWAP_H
3#define _LINUX_SWAP_H
4
Linus Torvalds1da177e2005-04-16 15:20:36 -07005#include <linux/spinlock.h>
6#include <linux/linkage.h>
7#include <linux/mmzone.h>
8#include <linux/list.h>
Balbir Singh66e17072008-02-07 00:13:56 -08009#include <linux/memcontrol.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010#include <linux/sched.h>
Lee Schermerhornaf936a12008-10-18 20:26:53 -070011#include <linux/node.h>
Shaohua Li33806f02013-02-22 16:34:37 -080012#include <linux/fs.h>
Arun Sharma600634972011-07-26 16:09:06 -070013#include <linux/atomic.h>
Mel Gormanc53954a2013-07-03 15:02:34 -070014#include <linux/page-flags.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015#include <asm/page.h>
16
Martin Schwidefsky8bc719d2006-09-25 23:31:20 -070017struct notifier_block;
18
Andrew Mortonab954162006-09-25 23:32:42 -070019struct bio;
20
Kuo-Hsin Yang64e3d122018-11-06 13:23:24 +000021struct pagevec;
22
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#define SWAP_FLAG_PREFER 0x8000 /* set if swap priority specified */
24#define SWAP_FLAG_PRIO_MASK 0x7fff
25#define SWAP_FLAG_PRIO_SHIFT 0
Rafael Aquinidcf6b7d2013-07-03 15:02:46 -070026#define SWAP_FLAG_DISCARD 0x10000 /* enable discard for swap */
27#define SWAP_FLAG_DISCARD_ONCE 0x20000 /* discard swap area at swapon-time */
28#define SWAP_FLAG_DISCARD_PAGES 0x40000 /* discard page-clusters after use */
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
Hugh Dickinsd15cab92012-03-28 14:42:42 -070030#define SWAP_FLAGS_VALID (SWAP_FLAG_PRIO_MASK | SWAP_FLAG_PREFER | \
Rafael Aquinidcf6b7d2013-07-03 15:02:46 -070031 SWAP_FLAG_DISCARD | SWAP_FLAG_DISCARD_ONCE | \
32 SWAP_FLAG_DISCARD_PAGES)
Tim Chen36005ba2017-02-22 15:45:33 -080033#define SWAP_BATCH 64
Hugh Dickinsd15cab92012-03-28 14:42:42 -070034
Linus Torvalds1da177e2005-04-16 15:20:36 -070035static inline int current_is_kswapd(void)
36{
37 return current->flags & PF_KSWAPD;
38}
39
40/*
41 * MAX_SWAPFILES defines the maximum number of swaptypes: things which can
42 * be swapped to. The swap type and the offset into that swap type are
43 * encoded into pte's and into pgoff_t's in the swapcache. Using five bits
44 * for the type means that the maximum number of swapcache pages is 27 bits
45 * on 32-bit-pgoff_t architectures. And that assumes that the architecture packs
46 * the type/offset into the pte as 5/27 as well.
47 */
48#define MAX_SWAPFILES_SHIFT 5
Andi Kleena7420aa2009-09-16 11:50:05 +020049
50/*
51 * Use some of the swap files numbers for other purposes. This
52 * is a convenient way to hook into the VM to trigger special
53 * actions on faults.
54 */
55
56/*
Jérôme Glisse5042db42017-09-08 16:11:43 -070057 * Unaddressable device memory support. See include/linux/hmm.h and
Mike Rapoportad56b732018-03-21 21:22:47 +020058 * Documentation/vm/hmm.rst. Short description is we need struct pages for
Jérôme Glisse5042db42017-09-08 16:11:43 -070059 * device memory that is unaddressable (inaccessible) by CPU, so that we can
60 * migrate part of a process memory to device memory.
61 *
62 * When a page is migrated from CPU to device, we set the CPU page table entry
63 * to a special SWP_DEVICE_* entry.
64 */
65#ifdef CONFIG_DEVICE_PRIVATE
66#define SWP_DEVICE_NUM 2
67#define SWP_DEVICE_WRITE (MAX_SWAPFILES+SWP_HWPOISON_NUM+SWP_MIGRATION_NUM)
68#define SWP_DEVICE_READ (MAX_SWAPFILES+SWP_HWPOISON_NUM+SWP_MIGRATION_NUM+1)
69#else
70#define SWP_DEVICE_NUM 0
71#endif
72
73/*
Andi Kleena7420aa2009-09-16 11:50:05 +020074 * NUMA node memory migration support
75 */
76#ifdef CONFIG_MIGRATION
77#define SWP_MIGRATION_NUM 2
78#define SWP_MIGRATION_READ (MAX_SWAPFILES + SWP_HWPOISON_NUM)
79#define SWP_MIGRATION_WRITE (MAX_SWAPFILES + SWP_HWPOISON_NUM + 1)
Christoph Lameter06972122006-06-23 02:03:35 -070080#else
Andi Kleena7420aa2009-09-16 11:50:05 +020081#define SWP_MIGRATION_NUM 0
Christoph Lameter06972122006-06-23 02:03:35 -070082#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070083
84/*
Andi Kleena7420aa2009-09-16 11:50:05 +020085 * Handling of hardware poisoned pages with memory corruption.
86 */
87#ifdef CONFIG_MEMORY_FAILURE
88#define SWP_HWPOISON_NUM 1
89#define SWP_HWPOISON MAX_SWAPFILES
90#else
91#define SWP_HWPOISON_NUM 0
92#endif
93
94#define MAX_SWAPFILES \
Jérôme Glisse5042db42017-09-08 16:11:43 -070095 ((1 << MAX_SWAPFILES_SHIFT) - SWP_DEVICE_NUM - \
96 SWP_MIGRATION_NUM - SWP_HWPOISON_NUM)
Andi Kleena7420aa2009-09-16 11:50:05 +020097
98/*
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 * Magic header for a swap area. The first part of the union is
100 * what the swap magic looks like for the old (limited to 128MB)
101 * swap area format, the second part of the union adds - in the
102 * old reserved area - some extra information. Note that the first
103 * kilobyte is reserved for boot loader or disk label stuff...
104 *
105 * Having the magic at the end of the PAGE_SIZE makes detecting swap
106 * areas somewhat tricky on machines that support multiple page sizes.
107 * For 2.5 we'll probably want to move the magic to just beyond the
108 * bootbits...
109 */
110union swap_header {
111 struct {
112 char reserved[PAGE_SIZE - 10];
113 char magic[10]; /* SWAP-SPACE or SWAPSPACE2 */
114 } magic;
115 struct {
Andreas Dilgere8f03d02006-06-23 02:03:14 -0700116 char bootbits[1024]; /* Space for disklabel etc. */
117 __u32 version;
118 __u32 last_page;
119 __u32 nr_badpages;
120 unsigned char sws_uuid[16];
121 unsigned char sws_volume[16];
122 __u32 padding[117];
123 __u32 badpages[1];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 } info;
125};
126
Linus Torvalds1da177e2005-04-16 15:20:36 -0700127/*
128 * current->reclaim_state points to one of these when a task is running
129 * memory reclaim
130 */
131struct reclaim_state {
132 unsigned long reclaimed_slab;
133};
134
135#ifdef __KERNEL__
136
137struct address_space;
138struct sysinfo;
139struct writeback_control;
140struct zone;
141
142/*
143 * A swap extent maps a range of a swapfile's PAGE_SIZE pages onto a range of
144 * disk blocks. A list of swap extents maps the entire swapfile. (Where the
145 * term `swapfile' refers to either a blockdevice or an IS_REG file. Apart
146 * from setup, they're handled identically.
147 *
148 * We always assume that blocks are of size PAGE_SIZE.
149 */
150struct swap_extent {
Aaron Lu4efaceb2019-07-11 20:55:41 -0700151 struct rb_node rb_node;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 pgoff_t start_page;
153 pgoff_t nr_pages;
154 sector_t start_block;
155};
156
157/*
158 * Max bad pages in the new format..
159 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160#define MAX_SWAP_BADPAGES \
Pi-Hsun Shiha4046c02019-03-13 11:44:33 -0700161 ((offsetof(union swap_header, magic.magic) - \
162 offsetof(union swap_header, info.badpages)) / sizeof(int))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
164enum {
165 SWP_USED = (1 << 0), /* is slot in swap_info[] used? */
166 SWP_WRITEOK = (1 << 1), /* ok to write to this swap? */
Rafael Aquinidcf6b7d2013-07-03 15:02:46 -0700167 SWP_DISCARDABLE = (1 << 2), /* blkdev support discard */
Hugh Dickins7992fde2009-01-06 14:39:53 -0800168 SWP_DISCARDING = (1 << 3), /* now discarding a free cluster */
Hugh Dickins20137a42009-01-06 14:39:54 -0800169 SWP_SOLIDSTATE = (1 << 4), /* blkdev seeks are cheap */
Hugh Dickins570a335b2009-12-14 17:58:46 -0800170 SWP_CONTINUED = (1 << 5), /* swap_map has count continuation */
Nitin Guptab2725642010-05-17 11:02:42 +0530171 SWP_BLKDEV = (1 << 6), /* its a block device */
Omar Sandovalbc4ae272018-10-26 15:10:51 -0700172 SWP_ACTIVATED = (1 << 7), /* set after swap_activate success */
173 SWP_FS = (1 << 8), /* swap file goes through fs */
174 SWP_AREA_DISCARD = (1 << 9), /* single-time swap area discards */
175 SWP_PAGE_DISCARD = (1 << 10), /* freed swap page-cluster discards */
176 SWP_STABLE_WRITES = (1 << 11), /* no overwrite PG_writeback pages */
177 SWP_SYNCHRONOUS_IO = (1 << 12), /* synchronous IO is efficient */
Huang Yingeb085572019-07-11 20:55:33 -0700178 SWP_VALID = (1 << 13), /* swap is valid to be operated on? */
Hugh Dickins52b7efdb2005-09-03 15:54:39 -0700179 /* add others here before... */
Huang Yingeb085572019-07-11 20:55:33 -0700180 SWP_SCANNING = (1 << 14), /* refcount in scan_swap_map */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181};
182
Johannes Weinerd778df52013-02-22 16:32:12 -0800183#define SWAP_CLUSTER_MAX 32UL
Mel Gorman748446b2010-05-24 14:32:27 -0700184#define COMPACT_CLUSTER_MAX SWAP_CLUSTER_MAX
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
Wei Yang4b4bb6b2020-06-01 21:49:13 -0700186/* Bit flag in swap_map */
Hugh Dickins570a335b2009-12-14 17:58:46 -0800187#define SWAP_HAS_CACHE 0x40 /* Flag page is cached, in first swap_map */
Wei Yang4b4bb6b2020-06-01 21:49:13 -0700188#define COUNT_CONTINUED 0x80 /* Flag swap_map continuation for full count */
189
190/* Special value in first swap_map */
191#define SWAP_MAP_MAX 0x3e /* Max count */
192#define SWAP_MAP_BAD 0x3f /* Note page is bad */
193#define SWAP_MAP_SHMEM 0xbf /* Owned by shmem/tmpfs */
194
195/* Special value in each swap_map continuation */
196#define SWAP_CONT_MAX 0x7f /* Max count */
Hugh Dickins253d5532009-12-14 17:58:44 -0800197
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198/*
Shaohua Li2a8f9442013-09-11 14:20:28 -0700199 * We use this to track usage of a cluster. A cluster is a block of swap disk
200 * space with SWAPFILE_CLUSTER pages long and naturally aligns in disk. All
201 * free clusters are organized into a list. We fetch an entry from the list to
202 * get a free cluster.
203 *
204 * The data field stores next cluster if the cluster is free or cluster usage
205 * counter otherwise. The flags field determines if a cluster is free. This is
206 * protected by swap_info_struct.lock.
207 */
208struct swap_cluster_info {
Huang, Ying235b6212017-02-22 15:45:22 -0800209 spinlock_t lock; /*
210 * Protect swap_cluster_info fields
211 * and swap_info_struct->swap_map
212 * elements correspond to the swap
213 * cluster
214 */
Shaohua Li2a8f9442013-09-11 14:20:28 -0700215 unsigned int data:24;
216 unsigned int flags:8;
217};
218#define CLUSTER_FLAG_FREE 1 /* This cluster is free */
219#define CLUSTER_FLAG_NEXT_NULL 2 /* This cluster has no next cluster */
Huang Yinge0709822017-09-06 16:22:16 -0700220#define CLUSTER_FLAG_HUGE 4 /* This cluster is backing a transparent huge page */
Shaohua Li2a8f9442013-09-11 14:20:28 -0700221
222/*
Shaohua Liebc2a1a2013-09-11 14:20:32 -0700223 * We assign a cluster to each CPU, so each CPU can allocate swap entry from
224 * its own cluster and swapout sequentially. The purpose is to optimize swapout
225 * throughput.
226 */
227struct percpu_cluster {
228 struct swap_cluster_info index; /* Current cluster index */
229 unsigned int next; /* Likely next allocation offset */
230};
231
Huang Ying6b534912016-10-07 16:58:42 -0700232struct swap_cluster_list {
233 struct swap_cluster_info head;
234 struct swap_cluster_info tail;
235};
236
Shaohua Liebc2a1a2013-09-11 14:20:32 -0700237/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 * The in-memory structure used to track swap areas.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239 */
240struct swap_info_struct {
Hugh Dickinsefa90a92009-12-14 17:58:41 -0800241 unsigned long flags; /* SWP_USED etc: see above */
242 signed short prio; /* swap priority of this type */
Dan Streetman18ab4d42014-06-04 16:09:59 -0700243 struct plist_node list; /* entry in swap_active_head */
Hugh Dickinsefa90a92009-12-14 17:58:41 -0800244 signed char type; /* strange name for an index */
Hugh Dickins75097652009-12-14 17:58:48 -0800245 unsigned int max; /* extent of the swap_map */
246 unsigned char *swap_map; /* vmalloc'ed array of usage counts */
Shaohua Li2a8f9442013-09-11 14:20:28 -0700247 struct swap_cluster_info *cluster_info; /* cluster info. Only for SSD */
Huang Ying6b534912016-10-07 16:58:42 -0700248 struct swap_cluster_list free_clusters; /* free clusters list */
Hugh Dickins75097652009-12-14 17:58:48 -0800249 unsigned int lowest_bit; /* index of first free in swap_map */
250 unsigned int highest_bit; /* index of last free in swap_map */
251 unsigned int pages; /* total of usable pages of swap */
252 unsigned int inuse_pages; /* number of those currently in use */
253 unsigned int cluster_next; /* likely index for next allocation */
254 unsigned int cluster_nr; /* countdown to next cluster search */
Huang Ying49070582020-06-01 21:49:22 -0700255 unsigned int __percpu *cluster_next_cpu; /*percpu index for next allocation */
Shaohua Liebc2a1a2013-09-11 14:20:32 -0700256 struct percpu_cluster __percpu *percpu_cluster; /* per cpu's swap location */
Aaron Lu4efaceb2019-07-11 20:55:41 -0700257 struct rb_root swap_extent_root;/* root of the swap extent rbtree */
Hugh Dickins75097652009-12-14 17:58:48 -0800258 struct block_device *bdev; /* swap device or bdev of swap file */
259 struct file *swap_file; /* seldom referenced */
260 unsigned int old_block_size; /* seldom referenced */
Dan Magenheimer38b5faf2012-04-09 17:08:06 -0600261#ifdef CONFIG_FRONTSWAP
262 unsigned long *frontswap_map; /* frontswap in-use, one bit per page */
263 atomic_t frontswap_pages; /* frontswap pages in-use counter */
264#endif
Shaohua Liec8acf22013-02-22 16:34:38 -0800265 spinlock_t lock; /*
266 * protect map scan related fields like
267 * swap_map, lowest_bit, highest_bit,
268 * inuse_pages, cluster_next,
Shaohua Li815c2c52013-09-11 14:20:30 -0700269 * cluster_nr, lowest_alloc,
270 * highest_alloc, free/discard cluster
271 * list. other fields are only changed
272 * at swapon/swapoff, so are protected
273 * by swap_lock. changing flags need
274 * hold this lock and swap_lock. If
275 * both locks need hold, hold swap_lock
276 * first.
Shaohua Liec8acf22013-02-22 16:34:38 -0800277 */
Huang Ying2628bd62017-11-02 15:59:50 -0700278 spinlock_t cont_lock; /*
279 * protect swap count continuation page
280 * list.
281 */
Shaohua Li815c2c52013-09-11 14:20:30 -0700282 struct work_struct discard_work; /* discard worker */
Huang Ying6b534912016-10-07 16:58:42 -0700283 struct swap_cluster_list discard_clusters; /* discard clusters list */
Gustavo A. R. Silva16c33802020-03-23 19:23:10 -0500284 struct plist_node avail_lists[]; /*
Aaron Lu66f71da2018-12-28 00:34:39 -0800285 * entries in swap_avail_heads, one
286 * entry per node.
287 * Must be last as the number of the
288 * array is nr_node_ids, which is not
289 * a fixed value so have to allocate
290 * dynamically.
291 * And it has to be an array so that
292 * plist_for_each_* can work.
293 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294};
295
Huang Yingec560172017-09-06 16:24:36 -0700296#ifdef CONFIG_64BIT
297#define SWAP_RA_ORDER_CEILING 5
298#else
299/* Avoid stack overflow, because we need to save part of page table */
300#define SWAP_RA_ORDER_CEILING 3
301#define SWAP_RA_PTE_CACHE_SIZE (1 << SWAP_RA_ORDER_CEILING)
302#endif
303
304struct vma_swap_readahead {
305 unsigned short win;
306 unsigned short offset;
307 unsigned short nr_pte;
308#ifdef CONFIG_64BIT
309 pte_t *ptes;
310#else
311 pte_t ptes[SWAP_RA_PTE_CACHE_SIZE];
312#endif
313};
314
Johannes Weinera5289102014-04-03 14:47:51 -0700315/* linux/mm/workingset.c */
Johannes Weinerb9107182019-11-30 17:55:59 -0800316void *workingset_eviction(struct page *page, struct mem_cgroup *target_memcg);
Johannes Weiner1899ad12018-10-26 15:06:04 -0700317void workingset_refault(struct page *page, void *shadow);
Johannes Weinera5289102014-04-03 14:47:51 -0700318void workingset_activation(struct page *page);
Mel Gormanc7df8ad2017-11-15 17:37:41 -0800319
Matthew Wilcox74d60952017-11-17 10:01:45 -0500320/* Only track the nodes of mappings with shadow entries */
321void workingset_update_node(struct xa_node *node);
322#define mapping_set_update(xas, mapping) do { \
323 if (!dax_mapping(mapping) && !shmem_mapping(mapping)) \
324 xas_set_update(xas, workingset_update_node); \
325} while (0)
Johannes Weinera5289102014-04-03 14:47:51 -0700326
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327/* linux/mm/page_alloc.c */
Hideo AOKIcb45b0e2006-04-10 22:52:59 -0700328extern unsigned long totalreserve_pages;
Zhang Yanfeiebec3862013-02-22 16:35:43 -0800329extern unsigned long nr_free_buffer_pages(void);
330extern unsigned long nr_free_pagecache_pages(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331
Michal Hockoc41f0122017-09-06 16:23:36 -0700332/* Definition of global_zone_page_state not available yet */
333#define nr_free_pages() global_zone_page_state(NR_FREE_PAGES)
Christoph Lameter96177292007-02-10 01:43:03 -0800334
335
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336/* linux/mm/swap.c */
Johannes Weiner96f8bf42020-06-03 16:03:09 -0700337extern void lru_note_cost(struct lruvec *lruvec, bool file,
338 unsigned int nr_pages);
339extern void lru_note_cost_page(struct page *);
Mel Gormanc53954a2013-07-03 15:02:34 -0700340extern void lru_cache_add(struct page *);
Hugh Dickinsfa9add62012-05-29 15:07:09 -0700341extern void lru_add_page_tail(struct page *page, struct page *page_tail,
Shaohua Li5bc7b8a2013-04-29 15:08:36 -0700342 struct lruvec *lruvec, struct list_head *head);
Harvey Harrisonb3c97522008-02-13 15:03:15 -0800343extern void activate_page(struct page *);
344extern void mark_page_accessed(struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345extern void lru_add_drain(void);
Konstantin Khlebnikovf0cb3c72012-03-21 16:34:06 -0700346extern void lru_add_drain_cpu(int cpu);
Ingo Molnarb01b2142020-05-27 22:11:15 +0200347extern void lru_add_drain_cpu_zone(struct zone *zone);
Chris Metcalf5fbc4612013-09-12 15:13:55 -0700348extern void lru_add_drain_all(void);
Miklos Szerediac6aadb2008-04-28 02:12:38 -0700349extern void rotate_reclaimable_page(struct page *page);
Minchan Kimcc5993b2015-04-15 16:13:26 -0700350extern void deactivate_file_page(struct page *page);
Minchan Kim9c276cc2019-09-25 16:49:08 -0700351extern void deactivate_page(struct page *page);
Shaohua Lif7ad2a62017-05-03 14:52:29 -0700352extern void mark_page_lazyfree(struct page *page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353extern void swap_setup(void);
354
Johannes Weiner00501b52014-08-08 14:19:20 -0700355extern void lru_cache_add_active_or_unevictable(struct page *page,
356 struct vm_area_struct *vma);
357
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358/* linux/mm/vmscan.c */
Mel Gorman5a1c84b2016-07-28 15:47:31 -0700359extern unsigned long zone_reclaimable_pages(struct zone *zone);
Mel Gormandac1d272008-04-28 02:12:12 -0700360extern unsigned long try_to_free_pages(struct zonelist *zonelist, int order,
KAMEZAWA Hiroyuki327c0e92009-03-31 15:23:31 -0700361 gfp_t gfp_mask, nodemask_t *mask);
Konstantin Khlebnikovf3fd4a62012-05-29 15:06:54 -0700362extern int __isolate_lru_page(struct page *page, isolate_mode_t mode);
Johannes Weinerb70a2a22014-10-09 15:28:56 -0700363extern unsigned long try_to_free_mem_cgroup_pages(struct mem_cgroup *memcg,
364 unsigned long nr_pages,
365 gfp_t gfp_mask,
366 bool may_swap);
Mel Gormana9dd0a82016-07-28 15:46:02 -0700367extern unsigned long mem_cgroup_shrink_node(struct mem_cgroup *mem,
Johannes Weiner185efc02011-09-14 16:21:58 -0700368 gfp_t gfp_mask, bool noswap,
Mel Gormanef8f2322016-07-28 15:46:05 -0700369 pg_data_t *pgdat,
Johannes Weiner185efc02011-09-14 16:21:58 -0700370 unsigned long *nr_scanned);
Andrew Morton69e05942006-03-22 00:08:19 -0800371extern unsigned long shrink_all_memory(unsigned long nr_pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700372extern int vm_swappiness;
Christoph Lameterb20a3502006-03-22 00:09:12 -0800373extern int remove_mapping(struct address_space *mapping, struct page *page);
Zhang Yanfeib21e0b92013-02-22 16:35:48 -0800374extern unsigned long vm_total_pages;
Christoph Lameterb20a3502006-03-22 00:09:12 -0800375
Minchan Kim1a4e58c2019-09-25 16:49:15 -0700376extern unsigned long reclaim_pages(struct list_head *page_list);
Christoph Lameter9eeff232006-01-18 17:42:31 -0800377#ifdef CONFIG_NUMA
Mel Gormana5f5f912016-07-28 15:46:32 -0700378extern int node_reclaim_mode;
Christoph Lameter96146342006-07-03 00:24:13 -0700379extern int sysctl_min_unmapped_ratio;
Christoph Lameter0ff38492006-09-25 23:31:52 -0700380extern int sysctl_min_slab_ratio;
Christoph Lameter9eeff232006-01-18 17:42:31 -0800381#else
Mel Gormana5f5f912016-07-28 15:46:32 -0700382#define node_reclaim_mode 0
Christoph Lameter9eeff232006-01-18 17:42:31 -0800383#endif
384
Kuo-Hsin Yang64e3d122018-11-06 13:23:24 +0000385extern void check_move_unevictable_pages(struct pagevec *pvec);
Lee Schermerhornaf936a12008-10-18 20:26:53 -0700386
Yasunori Goto3218ae12006-06-27 02:53:33 -0700387extern int kswapd_run(int nid);
David Rientjes8fe23e02009-12-14 17:58:33 -0800388extern void kswapd_stop(int nid);
Michal Hocko33398cf2015-09-08 15:01:02 -0700389
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390#ifdef CONFIG_SWAP
Christoph Hellwigbe297962016-11-01 07:40:16 -0600391
392#include <linux/blk_types.h> /* for bio_end_io_t */
393
Linus Torvalds1da177e2005-04-16 15:20:36 -0700394/* linux/mm/page_io.c */
Shaohua Li23955622017-07-10 15:47:11 -0700395extern int swap_readpage(struct page *page, bool do_poll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700396extern int swap_writepage(struct page *page, struct writeback_control *wbc);
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200397extern void end_swap_bio_write(struct bio *bio);
Seth Jennings1eec6702013-04-29 15:08:35 -0700398extern int __swap_writepage(struct page *page, struct writeback_control *wbc,
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200399 bio_end_io_t end_write_func);
Mel Gorman62c230b2012-07-31 16:44:55 -0700400extern int swap_set_page_dirty(struct page *page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401
Mel Gormana509bc12012-07-31 16:44:57 -0700402int add_swap_extent(struct swap_info_struct *sis, unsigned long start_page,
403 unsigned long nr_pages, sector_t start_block);
404int generic_swapfile_activate(struct swap_info_struct *, struct file *,
405 sector_t *);
406
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407/* linux/mm/swap_state.c */
Huang, Ying4b3ef9d2017-02-22 15:45:26 -0800408/* One swap address space for each 64M swap space */
409#define SWAP_ADDRESS_SPACE_SHIFT 14
410#define SWAP_ADDRESS_SPACE_PAGES (1 << SWAP_ADDRESS_SPACE_SHIFT)
411extern struct address_space *swapper_spaces[];
412#define swap_address_space(entry) \
413 (&swapper_spaces[swp_type(entry)][swp_offset(entry) \
414 >> SWAP_ADDRESS_SPACE_SHIFT])
Shaohua Li33806f02013-02-22 16:34:37 -0800415extern unsigned long total_swapcache_pages(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416extern void show_swap_cache_info(void);
Minchan Kim0f074652017-07-06 15:37:24 -0700417extern int add_to_swap(struct page *page);
Hugh Dickins73b12622008-02-04 22:28:50 -0800418extern int add_to_swap_cache(struct page *, swp_entry_t, gfp_t);
Matthew Wilcox4e17ec22017-11-29 08:32:39 -0500419extern void __delete_from_swap_cache(struct page *, swp_entry_t entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700420extern void delete_from_swap_cache(struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700421extern void free_page_and_swap_cache(struct page *);
422extern void free_pages_and_swap_cache(struct page **, int);
Huang Yingec560172017-09-06 16:24:36 -0700423extern struct page *lookup_swap_cache(swp_entry_t entry,
424 struct vm_area_struct *vma,
425 unsigned long addr);
Hugh Dickins02098fe2008-02-04 22:28:42 -0800426extern struct page *read_swap_cache_async(swp_entry_t, gfp_t,
Shaohua Li23955622017-07-10 15:47:11 -0700427 struct vm_area_struct *vma, unsigned long addr,
428 bool do_poll);
Dmitry Safonov5b999aa2015-09-08 15:05:00 -0700429extern struct page *__read_swap_cache_async(swp_entry_t, gfp_t,
430 struct vm_area_struct *vma, unsigned long addr,
431 bool *new_page_allocated);
Minchan Kime9e9b7e2018-04-05 16:23:42 -0700432extern struct page *swap_cluster_readahead(swp_entry_t entry, gfp_t flag,
433 struct vm_fault *vmf);
434extern struct page *swapin_readahead(swp_entry_t entry, gfp_t flag,
435 struct vm_fault *vmf);
Huang Yingec560172017-09-06 16:24:36 -0700436
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437/* linux/mm/swapfile.c */
Shaohua Liec8acf22013-02-22 16:34:38 -0800438extern atomic_long_t nr_swap_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700439extern long total_swap_pages;
Huang Ying81a02982017-09-06 16:24:43 -0700440extern atomic_t nr_rotate_swap;
Tim Chen67afa382017-02-22 15:45:39 -0800441extern bool has_usable_swap(void);
Shaohua Liec8acf22013-02-22 16:34:38 -0800442
443/* Swap 50% full? Release swapcache more aggressively.. */
444static inline bool vm_swap_full(void)
445{
446 return atomic_long_read(&nr_swap_pages) * 2 < total_swap_pages;
447}
448
449static inline long get_nr_swap_pages(void)
450{
451 return atomic_long_read(&nr_swap_pages);
452}
453
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454extern void si_swapinfo(struct sysinfo *);
Huang Ying38d8b4e2017-07-06 15:37:18 -0700455extern swp_entry_t get_swap_page(struct page *page);
Minchan Kim75f6d6d2017-07-06 15:37:21 -0700456extern void put_swap_page(struct page *page, swp_entry_t entry);
Hugh Dickins910321e2010-09-09 16:38:07 -0700457extern swp_entry_t get_swap_page_of_type(int);
Huang Ying5d5e8f12018-08-21 21:52:20 -0700458extern int get_swap_pages(int n, swp_entry_t swp_entries[], int entry_size);
Hugh Dickins570a335b2009-12-14 17:58:46 -0800459extern int add_swap_count_continuation(swp_entry_t, gfp_t);
Hugh Dickinsaaa46862009-12-14 17:58:47 -0800460extern void swap_shmem_alloc(swp_entry_t);
Hugh Dickins570a335b2009-12-14 17:58:46 -0800461extern int swap_duplicate(swp_entry_t);
462extern int swapcache_prepare(swp_entry_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463extern void swap_free(swp_entry_t);
Tim Chen7c00baf2017-02-22 15:45:36 -0800464extern void swapcache_free_entries(swp_entry_t *entries, int n);
Hugh Dickins2509ef22009-01-06 14:40:10 -0800465extern int free_swap_and_cache(swp_entry_t);
Rafael J. Wysocki7bf23682007-01-05 16:36:28 -0800466extern int swap_type_of(dev_t, sector_t, struct block_device **);
Rafael J. Wysockif577eb32006-03-23 02:59:59 -0800467extern unsigned int count_swap_pages(int, int);
Lee Schermerhornd4906e12009-12-14 17:58:49 -0800468extern sector_t map_swap_page(struct page *, struct block_device **);
Rafael J. Wysocki3aef83e2006-12-06 20:34:10 -0800469extern sector_t swapdev_block(int, pgoff_t);
Hugh Dickinsbde05d12012-05-29 15:06:38 -0700470extern int page_swapcount(struct page *);
Huang Yingeb085572019-07-11 20:55:33 -0700471extern int __swap_count(swp_entry_t entry);
Tim Chene8c26ab2017-02-22 15:45:29 -0800472extern int __swp_swapcount(swp_entry_t entry);
Minchan Kim8334b962015-09-08 15:00:24 -0700473extern int swp_swapcount(swp_entry_t entry);
Mel Gormanf981c592012-07-31 16:44:47 -0700474extern struct swap_info_struct *page_swap_info(struct page *);
Minchan Kim0bcac062017-11-15 17:33:07 -0800475extern struct swap_info_struct *swp_swap_info(swp_entry_t entry);
Andrea Arcangeli6d0a07e2016-05-12 15:42:25 -0700476extern bool reuse_swap_page(struct page *, int *);
Hugh Dickinsa2c43ee2009-01-06 14:39:36 -0800477extern int try_to_free_swap(struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700478struct backing_dev_info;
Huang, Ying4b3ef9d2017-02-22 15:45:26 -0800479extern int init_swap_address_space(unsigned int type, unsigned long nr_pages);
480extern void exit_swap_address_space(unsigned int type);
Huang Yingeb085572019-07-11 20:55:33 -0700481extern struct swap_info_struct *get_swap_device(swp_entry_t entry);
482
483static inline void put_swap_device(struct swap_info_struct *si)
484{
485 rcu_read_unlock();
486}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488#else /* CONFIG_SWAP */
489
Minchan Kim0bcac062017-11-15 17:33:07 -0800490static inline int swap_readpage(struct page *page, bool do_poll)
491{
492 return 0;
493}
494
495static inline struct swap_info_struct *swp_swap_info(swp_entry_t entry)
496{
497 return NULL;
498}
499
Joonsoo Kimd2cf5ad2013-09-11 14:21:29 -0700500#define swap_address_space(entry) (NULL)
Shaohua Liec8acf22013-02-22 16:34:38 -0800501#define get_nr_swap_pages() 0L
Hugh Dickinsb9627162009-01-06 14:39:41 -0800502#define total_swap_pages 0L
Shaohua Li33806f02013-02-22 16:34:37 -0800503#define total_swapcache_pages() 0UL
Shaohua Liec8acf22013-02-22 16:34:38 -0800504#define vm_swap_full() 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505
506#define si_swapinfo(val) \
507 do { (val)->freeswap = (val)->totalswap = 0; } while (0)
Olaf Hering9ae5b3c2005-08-07 09:42:24 -0700508/* only sparc can not include linux/pagemap.h in this file
Kirill A. Shutemovea1754a2016-04-01 15:29:48 +0300509 * so leave put_page and release_pages undeclared... */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510#define free_page_and_swap_cache(page) \
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300511 put_page(page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512#define free_pages_and_swap_cache(pages, nr) \
Mel Gormanc6f92f92017-11-15 17:37:55 -0800513 release_pages((pages), (nr));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
Con Kolivasbd96b9e2006-06-23 02:03:42 -0700515static inline void show_swap_cache_info(void)
516{
517}
518
Jérôme Glisse5042db42017-09-08 16:11:43 -0700519#define free_swap_and_cache(e) ({(is_migration_entry(e) || is_device_private_entry(e));})
520#define swapcache_prepare(e) ({(is_migration_entry(e) || is_device_private_entry(e));})
Con Kolivasbd96b9e2006-06-23 02:03:42 -0700521
Hugh Dickins570a335b2009-12-14 17:58:46 -0800522static inline int add_swap_count_continuation(swp_entry_t swp, gfp_t gfp_mask)
KAMEZAWA Hiroyuki355cfa72009-06-16 15:32:53 -0700523{
Hugh Dickins570a335b2009-12-14 17:58:46 -0800524 return 0;
525}
526
Hugh Dickinsaaa46862009-12-14 17:58:47 -0800527static inline void swap_shmem_alloc(swp_entry_t swp)
528{
529}
530
Hugh Dickins570a335b2009-12-14 17:58:46 -0800531static inline int swap_duplicate(swp_entry_t swp)
532{
533 return 0;
KAMEZAWA Hiroyuki355cfa72009-06-16 15:32:53 -0700534}
535
Con Kolivasbd96b9e2006-06-23 02:03:42 -0700536static inline void swap_free(swp_entry_t swp)
537{
538}
539
Minchan Kim75f6d6d2017-07-06 15:37:21 -0700540static inline void put_swap_page(struct page *page, swp_entry_t swp)
KAMEZAWA Hiroyukicb4b86b2009-06-16 15:32:52 -0700541{
542}
543
Minchan Kime9e9b7e2018-04-05 16:23:42 -0700544static inline struct page *swap_cluster_readahead(swp_entry_t entry,
545 gfp_t gfp_mask, struct vm_fault *vmf)
Con Kolivasbd96b9e2006-06-23 02:03:42 -0700546{
547 return NULL;
548}
549
Minchan Kime9e9b7e2018-04-05 16:23:42 -0700550static inline struct page *swapin_readahead(swp_entry_t swp, gfp_t gfp_mask,
551 struct vm_fault *vmf)
Huang Yingec560172017-09-06 16:24:36 -0700552{
553 return NULL;
554}
555
Hugh Dickins9fab5612009-03-31 15:23:33 -0700556static inline int swap_writepage(struct page *p, struct writeback_control *wbc)
557{
558 return 0;
559}
560
Huang Yingec560172017-09-06 16:24:36 -0700561static inline struct page *lookup_swap_cache(swp_entry_t swp,
562 struct vm_area_struct *vma,
563 unsigned long addr)
Con Kolivasbd96b9e2006-06-23 02:03:42 -0700564{
565 return NULL;
566}
567
Minchan Kim0f074652017-07-06 15:37:24 -0700568static inline int add_to_swap(struct page *page)
Hugh Dickins60371d92009-01-06 14:39:40 -0800569{
570 return 0;
571}
572
Hugh Dickins73b12622008-02-04 22:28:50 -0800573static inline int add_to_swap_cache(struct page *page, swp_entry_t entry,
574 gfp_t gfp_mask)
Con Kolivasbd96b9e2006-06-23 02:03:42 -0700575{
Hugh Dickins73b12622008-02-04 22:28:50 -0800576 return -1;
Con Kolivasbd96b9e2006-06-23 02:03:42 -0700577}
578
Matthew Wilcox4e17ec22017-11-29 08:32:39 -0500579static inline void __delete_from_swap_cache(struct page *page,
580 swp_entry_t entry)
Con Kolivasbd96b9e2006-06-23 02:03:42 -0700581{
582}
583
584static inline void delete_from_swap_cache(struct page *page)
585{
586}
587
Hugh Dickinsbde05d12012-05-29 15:06:38 -0700588static inline int page_swapcount(struct page *page)
589{
590 return 0;
591}
592
Huang Yingeb085572019-07-11 20:55:33 -0700593static inline int __swap_count(swp_entry_t entry)
Minchan Kimaa8d22a2017-11-15 17:33:11 -0800594{
595 return 0;
596}
597
Tim Chene8c26ab2017-02-22 15:45:29 -0800598static inline int __swp_swapcount(swp_entry_t entry)
599{
600 return 0;
601}
602
Minchan Kim8334b962015-09-08 15:00:24 -0700603static inline int swp_swapcount(swp_entry_t entry)
604{
605 return 0;
606}
607
Huang Yingba3c4ce2017-09-06 16:22:19 -0700608#define reuse_swap_page(page, total_map_swapcount) \
609 (page_trans_huge_mapcount(page, total_map_swapcount) == 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610
Hugh Dickinsa2c43ee2009-01-06 14:39:36 -0800611static inline int try_to_free_swap(struct page *page)
Rik van Riel68a223942008-10-18 20:26:23 -0700612{
613 return 0;
614}
615
Huang Ying38d8b4e2017-07-06 15:37:18 -0700616static inline swp_entry_t get_swap_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617{
618 swp_entry_t entry;
619 entry.val = 0;
620 return entry;
621}
622
Linus Torvalds1da177e2005-04-16 15:20:36 -0700623#endif /* CONFIG_SWAP */
Vladimir Davydov6f2cb2f2016-01-20 15:03:05 -0800624
Huang Ying59807682017-09-06 16:22:34 -0700625#ifdef CONFIG_THP_SWAP
626extern int split_swap_cluster(swp_entry_t entry);
627#else
628static inline int split_swap_cluster(swp_entry_t entry)
629{
630 return 0;
631}
632#endif
633
Vladimir Davydov6f2cb2f2016-01-20 15:03:05 -0800634#ifdef CONFIG_MEMCG
635static inline int mem_cgroup_swappiness(struct mem_cgroup *memcg)
636{
Johannes Weiner4550c4e2016-05-05 16:22:03 -0700637 /* Cgroup2 doesn't have per-cgroup swappiness */
638 if (cgroup_subsys_on_dfl(memory_cgrp_subsys))
639 return vm_swappiness;
640
Vladimir Davydov6f2cb2f2016-01-20 15:03:05 -0800641 /* root ? */
Yang Shi59118c42019-03-05 15:48:02 -0800642 if (mem_cgroup_disabled() || mem_cgroup_is_root(memcg))
Vladimir Davydov6f2cb2f2016-01-20 15:03:05 -0800643 return vm_swappiness;
644
645 return memcg->swappiness;
646}
Vladimir Davydov6f2cb2f2016-01-20 15:03:05 -0800647#else
648static inline int mem_cgroup_swappiness(struct mem_cgroup *mem)
649{
650 return vm_swappiness;
651}
652#endif
653
Tejun Heo2cf85582018-07-03 11:14:56 -0400654#if defined(CONFIG_SWAP) && defined(CONFIG_MEMCG) && defined(CONFIG_BLK_CGROUP)
Johannes Weiner6caa6a02020-06-03 16:01:38 -0700655extern void cgroup_throttle_swaprate(struct page *page, gfp_t gfp_mask);
Tejun Heo2cf85582018-07-03 11:14:56 -0400656#else
Johannes Weiner6caa6a02020-06-03 16:01:38 -0700657static inline void cgroup_throttle_swaprate(struct page *page, gfp_t gfp_mask)
Tejun Heo2cf85582018-07-03 11:14:56 -0400658{
659}
660#endif
661
Vladimir Davydov6f2cb2f2016-01-20 15:03:05 -0800662#ifdef CONFIG_MEMCG_SWAP
663extern void mem_cgroup_swapout(struct page *page, swp_entry_t entry);
664extern int mem_cgroup_try_charge_swap(struct page *page, swp_entry_t entry);
Huang Ying38d8b4e2017-07-06 15:37:18 -0700665extern void mem_cgroup_uncharge_swap(swp_entry_t entry, unsigned int nr_pages);
Vladimir Davydovd8b38432016-01-20 15:03:07 -0800666extern long mem_cgroup_get_nr_swap_pages(struct mem_cgroup *memcg);
Vladimir Davydov5ccc5ab2016-01-20 15:03:10 -0800667extern bool mem_cgroup_swap_full(struct page *page);
Vladimir Davydov6f2cb2f2016-01-20 15:03:05 -0800668#else
669static inline void mem_cgroup_swapout(struct page *page, swp_entry_t entry)
670{
671}
672
673static inline int mem_cgroup_try_charge_swap(struct page *page,
674 swp_entry_t entry)
675{
676 return 0;
677}
678
Huang Ying38d8b4e2017-07-06 15:37:18 -0700679static inline void mem_cgroup_uncharge_swap(swp_entry_t entry,
680 unsigned int nr_pages)
Vladimir Davydov6f2cb2f2016-01-20 15:03:05 -0800681{
682}
Vladimir Davydovd8b38432016-01-20 15:03:07 -0800683
684static inline long mem_cgroup_get_nr_swap_pages(struct mem_cgroup *memcg)
685{
686 return get_nr_swap_pages();
687}
Vladimir Davydov5ccc5ab2016-01-20 15:03:10 -0800688
689static inline bool mem_cgroup_swap_full(struct page *page)
690{
691 return vm_swap_full();
692}
Vladimir Davydov6f2cb2f2016-01-20 15:03:05 -0800693#endif
694
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695#endif /* __KERNEL__*/
696#endif /* _LINUX_SWAP_H */