blob: 4bfb5c4ac108d40d95fd0a471b7dd0f1954d4cf4 [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 {
151 struct list_head list;
152 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 */
Hugh Dickins52b7efdb2005-09-03 15:54:39 -0700178 /* add others here before... */
Omar Sandovalbc4ae272018-10-26 15:10:51 -0700179 SWP_SCANNING = (1 << 13), /* refcount in scan_swap_map */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700180};
181
Johannes Weinerd778df52013-02-22 16:32:12 -0800182#define SWAP_CLUSTER_MAX 32UL
Mel Gorman748446b2010-05-24 14:32:27 -0700183#define COMPACT_CLUSTER_MAX SWAP_CLUSTER_MAX
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184
Hugh Dickins570a335b2009-12-14 17:58:46 -0800185#define SWAP_MAP_MAX 0x3e /* Max duplication count, in first swap_map */
186#define SWAP_MAP_BAD 0x3f /* Note pageblock is bad, in first swap_map */
187#define SWAP_HAS_CACHE 0x40 /* Flag page is cached, in first swap_map */
188#define SWAP_CONT_MAX 0x7f /* Max count, in each swap_map continuation */
189#define COUNT_CONTINUED 0x80 /* See swap_map continuation for full count */
Hugh Dickinsaaa46862009-12-14 17:58:47 -0800190#define SWAP_MAP_SHMEM 0xbf /* Owned by shmem/tmpfs, in first swap_map */
Hugh Dickins253d5532009-12-14 17:58:44 -0800191
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192/*
Shaohua Li2a8f9442013-09-11 14:20:28 -0700193 * We use this to track usage of a cluster. A cluster is a block of swap disk
194 * space with SWAPFILE_CLUSTER pages long and naturally aligns in disk. All
195 * free clusters are organized into a list. We fetch an entry from the list to
196 * get a free cluster.
197 *
198 * The data field stores next cluster if the cluster is free or cluster usage
199 * counter otherwise. The flags field determines if a cluster is free. This is
200 * protected by swap_info_struct.lock.
201 */
202struct swap_cluster_info {
Huang, Ying235b6212017-02-22 15:45:22 -0800203 spinlock_t lock; /*
204 * Protect swap_cluster_info fields
205 * and swap_info_struct->swap_map
206 * elements correspond to the swap
207 * cluster
208 */
Shaohua Li2a8f9442013-09-11 14:20:28 -0700209 unsigned int data:24;
210 unsigned int flags:8;
211};
212#define CLUSTER_FLAG_FREE 1 /* This cluster is free */
213#define CLUSTER_FLAG_NEXT_NULL 2 /* This cluster has no next cluster */
Huang Yinge0709822017-09-06 16:22:16 -0700214#define CLUSTER_FLAG_HUGE 4 /* This cluster is backing a transparent huge page */
Shaohua Li2a8f9442013-09-11 14:20:28 -0700215
216/*
Shaohua Liebc2a1a62013-09-11 14:20:32 -0700217 * We assign a cluster to each CPU, so each CPU can allocate swap entry from
218 * its own cluster and swapout sequentially. The purpose is to optimize swapout
219 * throughput.
220 */
221struct percpu_cluster {
222 struct swap_cluster_info index; /* Current cluster index */
223 unsigned int next; /* Likely next allocation offset */
224};
225
Huang Ying6b534912016-10-07 16:58:42 -0700226struct swap_cluster_list {
227 struct swap_cluster_info head;
228 struct swap_cluster_info tail;
229};
230
Shaohua Liebc2a1a62013-09-11 14:20:32 -0700231/*
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 * The in-memory structure used to track swap areas.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700233 */
234struct swap_info_struct {
Hugh Dickinsefa90a92009-12-14 17:58:41 -0800235 unsigned long flags; /* SWP_USED etc: see above */
236 signed short prio; /* swap priority of this type */
Dan Streetman18ab4d42014-06-04 16:09:59 -0700237 struct plist_node list; /* entry in swap_active_head */
Hugh Dickinsefa90a92009-12-14 17:58:41 -0800238 signed char type; /* strange name for an index */
Hugh Dickins75097652009-12-14 17:58:48 -0800239 unsigned int max; /* extent of the swap_map */
240 unsigned char *swap_map; /* vmalloc'ed array of usage counts */
Shaohua Li2a8f9442013-09-11 14:20:28 -0700241 struct swap_cluster_info *cluster_info; /* cluster info. Only for SSD */
Huang Ying6b534912016-10-07 16:58:42 -0700242 struct swap_cluster_list free_clusters; /* free clusters list */
Hugh Dickins75097652009-12-14 17:58:48 -0800243 unsigned int lowest_bit; /* index of first free in swap_map */
244 unsigned int highest_bit; /* index of last free in swap_map */
245 unsigned int pages; /* total of usable pages of swap */
246 unsigned int inuse_pages; /* number of those currently in use */
247 unsigned int cluster_next; /* likely index for next allocation */
248 unsigned int cluster_nr; /* countdown to next cluster search */
Shaohua Liebc2a1a62013-09-11 14:20:32 -0700249 struct percpu_cluster __percpu *percpu_cluster; /* per cpu's swap location */
Hugh Dickins75097652009-12-14 17:58:48 -0800250 struct swap_extent *curr_swap_extent;
251 struct swap_extent first_swap_extent;
252 struct block_device *bdev; /* swap device or bdev of swap file */
253 struct file *swap_file; /* seldom referenced */
254 unsigned int old_block_size; /* seldom referenced */
Dan Magenheimer38b5faf2012-04-09 17:08:06 -0600255#ifdef CONFIG_FRONTSWAP
256 unsigned long *frontswap_map; /* frontswap in-use, one bit per page */
257 atomic_t frontswap_pages; /* frontswap pages in-use counter */
258#endif
Shaohua Liec8acf22013-02-22 16:34:38 -0800259 spinlock_t lock; /*
260 * protect map scan related fields like
261 * swap_map, lowest_bit, highest_bit,
262 * inuse_pages, cluster_next,
Shaohua Li815c2c52013-09-11 14:20:30 -0700263 * cluster_nr, lowest_alloc,
264 * highest_alloc, free/discard cluster
265 * list. other fields are only changed
266 * at swapon/swapoff, so are protected
267 * by swap_lock. changing flags need
268 * hold this lock and swap_lock. If
269 * both locks need hold, hold swap_lock
270 * first.
Shaohua Liec8acf22013-02-22 16:34:38 -0800271 */
Huang Ying2628bd62017-11-02 15:59:50 -0700272 spinlock_t cont_lock; /*
273 * protect swap count continuation page
274 * list.
275 */
Shaohua Li815c2c52013-09-11 14:20:30 -0700276 struct work_struct discard_work; /* discard worker */
Huang Ying6b534912016-10-07 16:58:42 -0700277 struct swap_cluster_list discard_clusters; /* discard clusters list */
Aaron Lu66f71da2018-12-28 00:34:39 -0800278 struct plist_node avail_lists[0]; /*
279 * entries in swap_avail_heads, one
280 * entry per node.
281 * Must be last as the number of the
282 * array is nr_node_ids, which is not
283 * a fixed value so have to allocate
284 * dynamically.
285 * And it has to be an array so that
286 * plist_for_each_* can work.
287 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288};
289
Huang Yingec560172017-09-06 16:24:36 -0700290#ifdef CONFIG_64BIT
291#define SWAP_RA_ORDER_CEILING 5
292#else
293/* Avoid stack overflow, because we need to save part of page table */
294#define SWAP_RA_ORDER_CEILING 3
295#define SWAP_RA_PTE_CACHE_SIZE (1 << SWAP_RA_ORDER_CEILING)
296#endif
297
298struct vma_swap_readahead {
299 unsigned short win;
300 unsigned short offset;
301 unsigned short nr_pte;
302#ifdef CONFIG_64BIT
303 pte_t *ptes;
304#else
305 pte_t ptes[SWAP_RA_PTE_CACHE_SIZE];
306#endif
307};
308
Johannes Weinera5289102014-04-03 14:47:51 -0700309/* linux/mm/workingset.c */
Andrey Ryabinina7ca12f2019-03-05 15:49:35 -0800310void *workingset_eviction(struct page *page);
Johannes Weiner1899ad12018-10-26 15:06:04 -0700311void workingset_refault(struct page *page, void *shadow);
Johannes Weinera5289102014-04-03 14:47:51 -0700312void workingset_activation(struct page *page);
Mel Gormanc7df8ad2017-11-15 17:37:41 -0800313
Matthew Wilcox74d60952017-11-17 10:01:45 -0500314/* Only track the nodes of mappings with shadow entries */
315void workingset_update_node(struct xa_node *node);
316#define mapping_set_update(xas, mapping) do { \
317 if (!dax_mapping(mapping) && !shmem_mapping(mapping)) \
318 xas_set_update(xas, workingset_update_node); \
319} while (0)
Johannes Weinera5289102014-04-03 14:47:51 -0700320
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321/* linux/mm/page_alloc.c */
Hideo AOKIcb45b0e2006-04-10 22:52:59 -0700322extern unsigned long totalreserve_pages;
Zhang Yanfeiebec3862013-02-22 16:35:43 -0800323extern unsigned long nr_free_buffer_pages(void);
324extern unsigned long nr_free_pagecache_pages(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325
Michal Hockoc41f0122017-09-06 16:23:36 -0700326/* Definition of global_zone_page_state not available yet */
327#define nr_free_pages() global_zone_page_state(NR_FREE_PAGES)
Christoph Lameter96177292007-02-10 01:43:03 -0800328
329
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330/* linux/mm/swap.c */
Mel Gormanc53954a2013-07-03 15:02:34 -0700331extern void lru_cache_add(struct page *);
Jianyu Zhan2329d372014-06-04 16:07:31 -0700332extern void lru_cache_add_anon(struct page *page);
333extern void lru_cache_add_file(struct page *page);
Hugh Dickinsfa9add62012-05-29 15:07:09 -0700334extern void lru_add_page_tail(struct page *page, struct page *page_tail,
Shaohua Li5bc7b8a2013-04-29 15:08:36 -0700335 struct lruvec *lruvec, struct list_head *head);
Harvey Harrisonb3c97522008-02-13 15:03:15 -0800336extern void activate_page(struct page *);
337extern void mark_page_accessed(struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338extern void lru_add_drain(void);
Konstantin Khlebnikovf0cb3c72012-03-21 16:34:06 -0700339extern void lru_add_drain_cpu(int cpu);
Chris Metcalf5fbc4612013-09-12 15:13:55 -0700340extern void lru_add_drain_all(void);
Miklos Szerediac6aadb2008-04-28 02:12:38 -0700341extern void rotate_reclaimable_page(struct page *page);
Minchan Kimcc5993b2015-04-15 16:13:26 -0700342extern void deactivate_file_page(struct page *page);
Shaohua Lif7ad2a62017-05-03 14:52:29 -0700343extern void mark_page_lazyfree(struct page *page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344extern void swap_setup(void);
345
Johannes Weiner00501b52014-08-08 14:19:20 -0700346extern void lru_cache_add_active_or_unevictable(struct page *page,
347 struct vm_area_struct *vma);
348
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349/* linux/mm/vmscan.c */
Mel Gorman5a1c84b2016-07-28 15:47:31 -0700350extern unsigned long zone_reclaimable_pages(struct zone *zone);
Mel Gormandac1d272008-04-28 02:12:12 -0700351extern unsigned long try_to_free_pages(struct zonelist *zonelist, int order,
KAMEZAWA Hiroyuki327c0e92009-03-31 15:23:31 -0700352 gfp_t gfp_mask, nodemask_t *mask);
Konstantin Khlebnikovf3fd4a62012-05-29 15:06:54 -0700353extern int __isolate_lru_page(struct page *page, isolate_mode_t mode);
Johannes Weinerb70a2a22014-10-09 15:28:56 -0700354extern unsigned long try_to_free_mem_cgroup_pages(struct mem_cgroup *memcg,
355 unsigned long nr_pages,
356 gfp_t gfp_mask,
357 bool may_swap);
Mel Gormana9dd0a82016-07-28 15:46:02 -0700358extern unsigned long mem_cgroup_shrink_node(struct mem_cgroup *mem,
Johannes Weiner185efc02011-09-14 16:21:58 -0700359 gfp_t gfp_mask, bool noswap,
Mel Gormanef8f2322016-07-28 15:46:05 -0700360 pg_data_t *pgdat,
Johannes Weiner185efc02011-09-14 16:21:58 -0700361 unsigned long *nr_scanned);
Andrew Morton69e05942006-03-22 00:08:19 -0800362extern unsigned long shrink_all_memory(unsigned long nr_pages);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363extern int vm_swappiness;
Christoph Lameterb20a3502006-03-22 00:09:12 -0800364extern int remove_mapping(struct address_space *mapping, struct page *page);
Zhang Yanfeib21e0b92013-02-22 16:35:48 -0800365extern unsigned long vm_total_pages;
Christoph Lameterb20a3502006-03-22 00:09:12 -0800366
Christoph Lameter9eeff232006-01-18 17:42:31 -0800367#ifdef CONFIG_NUMA
Mel Gormana5f5f912016-07-28 15:46:32 -0700368extern int node_reclaim_mode;
Christoph Lameter96146342006-07-03 00:24:13 -0700369extern int sysctl_min_unmapped_ratio;
Christoph Lameter0ff38492006-09-25 23:31:52 -0700370extern int sysctl_min_slab_ratio;
Christoph Lameter9eeff232006-01-18 17:42:31 -0800371#else
Mel Gormana5f5f912016-07-28 15:46:32 -0700372#define node_reclaim_mode 0
Christoph Lameter9eeff232006-01-18 17:42:31 -0800373#endif
374
Hugh Dickins39b5f292012-10-08 16:33:18 -0700375extern int page_evictable(struct page *page);
Kuo-Hsin Yang64e3d122018-11-06 13:23:24 +0000376extern void check_move_unevictable_pages(struct pagevec *pvec);
Lee Schermerhornaf936a12008-10-18 20:26:53 -0700377
Yasunori Goto3218ae12006-06-27 02:53:33 -0700378extern int kswapd_run(int nid);
David Rientjes8fe23e02009-12-14 17:58:33 -0800379extern void kswapd_stop(int nid);
Michal Hocko33398cf2015-09-08 15:01:02 -0700380
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381#ifdef CONFIG_SWAP
Christoph Hellwigbe297962016-11-01 07:40:16 -0600382
383#include <linux/blk_types.h> /* for bio_end_io_t */
384
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385/* linux/mm/page_io.c */
Shaohua Li23955622017-07-10 15:47:11 -0700386extern int swap_readpage(struct page *page, bool do_poll);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387extern int swap_writepage(struct page *page, struct writeback_control *wbc);
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200388extern void end_swap_bio_write(struct bio *bio);
Seth Jennings1eec6702013-04-29 15:08:35 -0700389extern int __swap_writepage(struct page *page, struct writeback_control *wbc,
Christoph Hellwig4246a0b2015-07-20 15:29:37 +0200390 bio_end_io_t end_write_func);
Mel Gorman62c230b2012-07-31 16:44:55 -0700391extern int swap_set_page_dirty(struct page *page);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700392
Mel Gormana509bc12012-07-31 16:44:57 -0700393int add_swap_extent(struct swap_info_struct *sis, unsigned long start_page,
394 unsigned long nr_pages, sector_t start_block);
395int generic_swapfile_activate(struct swap_info_struct *, struct file *,
396 sector_t *);
397
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398/* linux/mm/swap_state.c */
Huang, Ying4b3ef9d2017-02-22 15:45:26 -0800399/* One swap address space for each 64M swap space */
400#define SWAP_ADDRESS_SPACE_SHIFT 14
401#define SWAP_ADDRESS_SPACE_PAGES (1 << SWAP_ADDRESS_SPACE_SHIFT)
402extern struct address_space *swapper_spaces[];
403#define swap_address_space(entry) \
404 (&swapper_spaces[swp_type(entry)][swp_offset(entry) \
405 >> SWAP_ADDRESS_SPACE_SHIFT])
Shaohua Li33806f02013-02-22 16:34:37 -0800406extern unsigned long total_swapcache_pages(void);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407extern void show_swap_cache_info(void);
Minchan Kim0f074652017-07-06 15:37:24 -0700408extern int add_to_swap(struct page *page);
Hugh Dickins73b12622008-02-04 22:28:50 -0800409extern int add_to_swap_cache(struct page *, swp_entry_t, gfp_t);
Seth Jennings2f772e62013-04-29 15:08:34 -0700410extern int __add_to_swap_cache(struct page *page, swp_entry_t entry);
Matthew Wilcox4e17ec22017-11-29 08:32:39 -0500411extern void __delete_from_swap_cache(struct page *, swp_entry_t entry);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412extern void delete_from_swap_cache(struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413extern void free_page_and_swap_cache(struct page *);
414extern void free_pages_and_swap_cache(struct page **, int);
Huang Yingec560172017-09-06 16:24:36 -0700415extern struct page *lookup_swap_cache(swp_entry_t entry,
416 struct vm_area_struct *vma,
417 unsigned long addr);
Hugh Dickins02098fe2008-02-04 22:28:42 -0800418extern struct page *read_swap_cache_async(swp_entry_t, gfp_t,
Shaohua Li23955622017-07-10 15:47:11 -0700419 struct vm_area_struct *vma, unsigned long addr,
420 bool do_poll);
Dmitry Safonov5b999aa2015-09-08 15:05:00 -0700421extern struct page *__read_swap_cache_async(swp_entry_t, gfp_t,
422 struct vm_area_struct *vma, unsigned long addr,
423 bool *new_page_allocated);
Minchan Kime9e9b7e2018-04-05 16:23:42 -0700424extern struct page *swap_cluster_readahead(swp_entry_t entry, gfp_t flag,
425 struct vm_fault *vmf);
426extern struct page *swapin_readahead(swp_entry_t entry, gfp_t flag,
427 struct vm_fault *vmf);
Huang Yingec560172017-09-06 16:24:36 -0700428
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429/* linux/mm/swapfile.c */
Shaohua Liec8acf22013-02-22 16:34:38 -0800430extern atomic_long_t nr_swap_pages;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700431extern long total_swap_pages;
Huang Ying81a02982017-09-06 16:24:43 -0700432extern atomic_t nr_rotate_swap;
Tim Chen67afa382017-02-22 15:45:39 -0800433extern bool has_usable_swap(void);
Shaohua Liec8acf22013-02-22 16:34:38 -0800434
435/* Swap 50% full? Release swapcache more aggressively.. */
436static inline bool vm_swap_full(void)
437{
438 return atomic_long_read(&nr_swap_pages) * 2 < total_swap_pages;
439}
440
441static inline long get_nr_swap_pages(void)
442{
443 return atomic_long_read(&nr_swap_pages);
444}
445
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446extern void si_swapinfo(struct sysinfo *);
Huang Ying38d8b4e2017-07-06 15:37:18 -0700447extern swp_entry_t get_swap_page(struct page *page);
Minchan Kim75f6d6d2017-07-06 15:37:21 -0700448extern void put_swap_page(struct page *page, swp_entry_t entry);
Hugh Dickins910321e2010-09-09 16:38:07 -0700449extern swp_entry_t get_swap_page_of_type(int);
Huang Ying5d5e8f12018-08-21 21:52:20 -0700450extern int get_swap_pages(int n, swp_entry_t swp_entries[], int entry_size);
Hugh Dickins570a335b2009-12-14 17:58:46 -0800451extern int add_swap_count_continuation(swp_entry_t, gfp_t);
Hugh Dickinsaaa46862009-12-14 17:58:47 -0800452extern void swap_shmem_alloc(swp_entry_t);
Hugh Dickins570a335b2009-12-14 17:58:46 -0800453extern int swap_duplicate(swp_entry_t);
454extern int swapcache_prepare(swp_entry_t);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455extern void swap_free(swp_entry_t);
Tim Chen7c00baf2017-02-22 15:45:36 -0800456extern void swapcache_free_entries(swp_entry_t *entries, int n);
Hugh Dickins2509ef22009-01-06 14:40:10 -0800457extern int free_swap_and_cache(swp_entry_t);
Rafael J. Wysocki7bf23682007-01-05 16:36:28 -0800458extern int swap_type_of(dev_t, sector_t, struct block_device **);
Rafael J. Wysockif577eb32006-03-23 02:59:59 -0800459extern unsigned int count_swap_pages(int, int);
Lee Schermerhornd4906e12009-12-14 17:58:49 -0800460extern sector_t map_swap_page(struct page *, struct block_device **);
Rafael J. Wysocki3aef83e2006-12-06 20:34:10 -0800461extern sector_t swapdev_block(int, pgoff_t);
Hugh Dickinsbde05d12012-05-29 15:06:38 -0700462extern int page_swapcount(struct page *);
Minchan Kimaa8d22a2017-11-15 17:33:11 -0800463extern int __swap_count(struct swap_info_struct *si, swp_entry_t entry);
Tim Chene8c26ab2017-02-22 15:45:29 -0800464extern int __swp_swapcount(swp_entry_t entry);
Minchan Kim8334b962015-09-08 15:00:24 -0700465extern int swp_swapcount(swp_entry_t entry);
Mel Gormanf981c592012-07-31 16:44:47 -0700466extern struct swap_info_struct *page_swap_info(struct page *);
Minchan Kim0bcac062017-11-15 17:33:07 -0800467extern struct swap_info_struct *swp_swap_info(swp_entry_t entry);
Andrea Arcangeli6d0a07e2016-05-12 15:42:25 -0700468extern bool reuse_swap_page(struct page *, int *);
Hugh Dickinsa2c43ee2009-01-06 14:39:36 -0800469extern int try_to_free_swap(struct page *);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700470struct backing_dev_info;
Huang, Ying4b3ef9d2017-02-22 15:45:26 -0800471extern int init_swap_address_space(unsigned int type, unsigned long nr_pages);
472extern void exit_swap_address_space(unsigned int type);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474#else /* CONFIG_SWAP */
475
Minchan Kim0bcac062017-11-15 17:33:07 -0800476static inline int swap_readpage(struct page *page, bool do_poll)
477{
478 return 0;
479}
480
481static inline struct swap_info_struct *swp_swap_info(swp_entry_t entry)
482{
483 return NULL;
484}
485
Joonsoo Kimd2cf5ad2013-09-11 14:21:29 -0700486#define swap_address_space(entry) (NULL)
Shaohua Liec8acf22013-02-22 16:34:38 -0800487#define get_nr_swap_pages() 0L
Hugh Dickinsb9627162009-01-06 14:39:41 -0800488#define total_swap_pages 0L
Shaohua Li33806f02013-02-22 16:34:37 -0800489#define total_swapcache_pages() 0UL
Shaohua Liec8acf22013-02-22 16:34:38 -0800490#define vm_swap_full() 0
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491
492#define si_swapinfo(val) \
493 do { (val)->freeswap = (val)->totalswap = 0; } while (0)
Olaf Hering9ae5b3c2005-08-07 09:42:24 -0700494/* only sparc can not include linux/pagemap.h in this file
Kirill A. Shutemovea1754a2016-04-01 15:29:48 +0300495 * so leave put_page and release_pages undeclared... */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496#define free_page_and_swap_cache(page) \
Kirill A. Shutemov09cbfea2016-04-01 15:29:47 +0300497 put_page(page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498#define free_pages_and_swap_cache(pages, nr) \
Mel Gormanc6f92f92017-11-15 17:37:55 -0800499 release_pages((pages), (nr));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500
Con Kolivasbd96b9e2006-06-23 02:03:42 -0700501static inline void show_swap_cache_info(void)
502{
503}
504
Jérôme Glisse5042db42017-09-08 16:11:43 -0700505#define free_swap_and_cache(e) ({(is_migration_entry(e) || is_device_private_entry(e));})
506#define swapcache_prepare(e) ({(is_migration_entry(e) || is_device_private_entry(e));})
Con Kolivasbd96b9e2006-06-23 02:03:42 -0700507
Hugh Dickins570a335b2009-12-14 17:58:46 -0800508static inline int add_swap_count_continuation(swp_entry_t swp, gfp_t gfp_mask)
KAMEZAWA Hiroyuki355cfa72009-06-16 15:32:53 -0700509{
Hugh Dickins570a335b2009-12-14 17:58:46 -0800510 return 0;
511}
512
Hugh Dickinsaaa46862009-12-14 17:58:47 -0800513static inline void swap_shmem_alloc(swp_entry_t swp)
514{
515}
516
Hugh Dickins570a335b2009-12-14 17:58:46 -0800517static inline int swap_duplicate(swp_entry_t swp)
518{
519 return 0;
KAMEZAWA Hiroyuki355cfa72009-06-16 15:32:53 -0700520}
521
Con Kolivasbd96b9e2006-06-23 02:03:42 -0700522static inline void swap_free(swp_entry_t swp)
523{
524}
525
Minchan Kim75f6d6d2017-07-06 15:37:21 -0700526static inline void put_swap_page(struct page *page, swp_entry_t swp)
KAMEZAWA Hiroyukicb4b86b2009-06-16 15:32:52 -0700527{
528}
529
Minchan Kime9e9b7e2018-04-05 16:23:42 -0700530static inline struct page *swap_cluster_readahead(swp_entry_t entry,
531 gfp_t gfp_mask, struct vm_fault *vmf)
Con Kolivasbd96b9e2006-06-23 02:03:42 -0700532{
533 return NULL;
534}
535
Minchan Kime9e9b7e2018-04-05 16:23:42 -0700536static inline struct page *swapin_readahead(swp_entry_t swp, gfp_t gfp_mask,
537 struct vm_fault *vmf)
Huang Yingec560172017-09-06 16:24:36 -0700538{
539 return NULL;
540}
541
Hugh Dickins9fab5612009-03-31 15:23:33 -0700542static inline int swap_writepage(struct page *p, struct writeback_control *wbc)
543{
544 return 0;
545}
546
Huang Yingec560172017-09-06 16:24:36 -0700547static inline struct page *lookup_swap_cache(swp_entry_t swp,
548 struct vm_area_struct *vma,
549 unsigned long addr)
Con Kolivasbd96b9e2006-06-23 02:03:42 -0700550{
551 return NULL;
552}
553
Minchan Kim0f074652017-07-06 15:37:24 -0700554static inline int add_to_swap(struct page *page)
Hugh Dickins60371d92009-01-06 14:39:40 -0800555{
556 return 0;
557}
558
Hugh Dickins73b12622008-02-04 22:28:50 -0800559static inline int add_to_swap_cache(struct page *page, swp_entry_t entry,
560 gfp_t gfp_mask)
Con Kolivasbd96b9e2006-06-23 02:03:42 -0700561{
Hugh Dickins73b12622008-02-04 22:28:50 -0800562 return -1;
Con Kolivasbd96b9e2006-06-23 02:03:42 -0700563}
564
Matthew Wilcox4e17ec22017-11-29 08:32:39 -0500565static inline void __delete_from_swap_cache(struct page *page,
566 swp_entry_t entry)
Con Kolivasbd96b9e2006-06-23 02:03:42 -0700567{
568}
569
570static inline void delete_from_swap_cache(struct page *page)
571{
572}
573
Hugh Dickinsbde05d12012-05-29 15:06:38 -0700574static inline int page_swapcount(struct page *page)
575{
576 return 0;
577}
578
Minchan Kimaa8d22a2017-11-15 17:33:11 -0800579static inline int __swap_count(struct swap_info_struct *si, swp_entry_t entry)
580{
581 return 0;
582}
583
Tim Chene8c26ab2017-02-22 15:45:29 -0800584static inline int __swp_swapcount(swp_entry_t entry)
585{
586 return 0;
587}
588
Minchan Kim8334b962015-09-08 15:00:24 -0700589static inline int swp_swapcount(swp_entry_t entry)
590{
591 return 0;
592}
593
Huang Yingba3c4ce2017-09-06 16:22:19 -0700594#define reuse_swap_page(page, total_map_swapcount) \
595 (page_trans_huge_mapcount(page, total_map_swapcount) == 1)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596
Hugh Dickinsa2c43ee2009-01-06 14:39:36 -0800597static inline int try_to_free_swap(struct page *page)
Rik van Riel68a223942008-10-18 20:26:23 -0700598{
599 return 0;
600}
601
Huang Ying38d8b4e2017-07-06 15:37:18 -0700602static inline swp_entry_t get_swap_page(struct page *page)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603{
604 swp_entry_t entry;
605 entry.val = 0;
606 return entry;
607}
608
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609#endif /* CONFIG_SWAP */
Vladimir Davydov6f2cb2f2016-01-20 15:03:05 -0800610
Huang Ying59807682017-09-06 16:22:34 -0700611#ifdef CONFIG_THP_SWAP
612extern int split_swap_cluster(swp_entry_t entry);
613#else
614static inline int split_swap_cluster(swp_entry_t entry)
615{
616 return 0;
617}
618#endif
619
Vladimir Davydov6f2cb2f2016-01-20 15:03:05 -0800620#ifdef CONFIG_MEMCG
621static inline int mem_cgroup_swappiness(struct mem_cgroup *memcg)
622{
Johannes Weiner4550c4e2016-05-05 16:22:03 -0700623 /* Cgroup2 doesn't have per-cgroup swappiness */
624 if (cgroup_subsys_on_dfl(memory_cgrp_subsys))
625 return vm_swappiness;
626
Vladimir Davydov6f2cb2f2016-01-20 15:03:05 -0800627 /* root ? */
Yang Shi59118c42019-03-05 15:48:02 -0800628 if (mem_cgroup_disabled() || mem_cgroup_is_root(memcg))
Vladimir Davydov6f2cb2f2016-01-20 15:03:05 -0800629 return vm_swappiness;
630
631 return memcg->swappiness;
632}
Vladimir Davydov6f2cb2f2016-01-20 15:03:05 -0800633#else
634static inline int mem_cgroup_swappiness(struct mem_cgroup *mem)
635{
636 return vm_swappiness;
637}
638#endif
639
Tejun Heo2cf85582018-07-03 11:14:56 -0400640#if defined(CONFIG_SWAP) && defined(CONFIG_MEMCG) && defined(CONFIG_BLK_CGROUP)
641extern void mem_cgroup_throttle_swaprate(struct mem_cgroup *memcg, int node,
642 gfp_t gfp_mask);
643#else
644static inline void mem_cgroup_throttle_swaprate(struct mem_cgroup *memcg,
645 int node, gfp_t gfp_mask)
646{
647}
648#endif
649
Vladimir Davydov6f2cb2f2016-01-20 15:03:05 -0800650#ifdef CONFIG_MEMCG_SWAP
651extern void mem_cgroup_swapout(struct page *page, swp_entry_t entry);
652extern int mem_cgroup_try_charge_swap(struct page *page, swp_entry_t entry);
Huang Ying38d8b4e2017-07-06 15:37:18 -0700653extern void mem_cgroup_uncharge_swap(swp_entry_t entry, unsigned int nr_pages);
Vladimir Davydovd8b38432016-01-20 15:03:07 -0800654extern long mem_cgroup_get_nr_swap_pages(struct mem_cgroup *memcg);
Vladimir Davydov5ccc5ab2016-01-20 15:03:10 -0800655extern bool mem_cgroup_swap_full(struct page *page);
Vladimir Davydov6f2cb2f2016-01-20 15:03:05 -0800656#else
657static inline void mem_cgroup_swapout(struct page *page, swp_entry_t entry)
658{
659}
660
661static inline int mem_cgroup_try_charge_swap(struct page *page,
662 swp_entry_t entry)
663{
664 return 0;
665}
666
Huang Ying38d8b4e2017-07-06 15:37:18 -0700667static inline void mem_cgroup_uncharge_swap(swp_entry_t entry,
668 unsigned int nr_pages)
Vladimir Davydov6f2cb2f2016-01-20 15:03:05 -0800669{
670}
Vladimir Davydovd8b38432016-01-20 15:03:07 -0800671
672static inline long mem_cgroup_get_nr_swap_pages(struct mem_cgroup *memcg)
673{
674 return get_nr_swap_pages();
675}
Vladimir Davydov5ccc5ab2016-01-20 15:03:10 -0800676
677static inline bool mem_cgroup_swap_full(struct page *page)
678{
679 return vm_swap_full();
680}
Vladimir Davydov6f2cb2f2016-01-20 15:03:05 -0800681#endif
682
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683#endif /* __KERNEL__*/
684#endif /* _LINUX_SWAP_H */