]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - include/linux/swap.h
swap_info: private to swapfile.c
[mirror_ubuntu-bionic-kernel.git] / include / linux / swap.h
CommitLineData
1da177e4
LT
1#ifndef _LINUX_SWAP_H
2#define _LINUX_SWAP_H
3
1da177e4
LT
4#include <linux/spinlock.h>
5#include <linux/linkage.h>
6#include <linux/mmzone.h>
7#include <linux/list.h>
66e1707b 8#include <linux/memcontrol.h>
1da177e4 9#include <linux/sched.h>
af936a16 10#include <linux/node.h>
542d1c88 11
1da177e4
LT
12#include <asm/atomic.h>
13#include <asm/page.h>
14
8bc719d3
MS
15struct notifier_block;
16
ab954160
AM
17struct bio;
18
1da177e4
LT
19#define SWAP_FLAG_PREFER 0x8000 /* set if swap priority specified */
20#define SWAP_FLAG_PRIO_MASK 0x7fff
21#define SWAP_FLAG_PRIO_SHIFT 0
22
23static inline int current_is_kswapd(void)
24{
25 return current->flags & PF_KSWAPD;
26}
27
28/*
29 * MAX_SWAPFILES defines the maximum number of swaptypes: things which can
30 * be swapped to. The swap type and the offset into that swap type are
31 * encoded into pte's and into pgoff_t's in the swapcache. Using five bits
32 * for the type means that the maximum number of swapcache pages is 27 bits
33 * on 32-bit-pgoff_t architectures. And that assumes that the architecture packs
34 * the type/offset into the pte as 5/27 as well.
35 */
36#define MAX_SWAPFILES_SHIFT 5
a7420aa5
AK
37
38/*
39 * Use some of the swap files numbers for other purposes. This
40 * is a convenient way to hook into the VM to trigger special
41 * actions on faults.
42 */
43
44/*
45 * NUMA node memory migration support
46 */
47#ifdef CONFIG_MIGRATION
48#define SWP_MIGRATION_NUM 2
49#define SWP_MIGRATION_READ (MAX_SWAPFILES + SWP_HWPOISON_NUM)
50#define SWP_MIGRATION_WRITE (MAX_SWAPFILES + SWP_HWPOISON_NUM + 1)
0697212a 51#else
a7420aa5 52#define SWP_MIGRATION_NUM 0
0697212a 53#endif
1da177e4 54
a7420aa5
AK
55/*
56 * Handling of hardware poisoned pages with memory corruption.
57 */
58#ifdef CONFIG_MEMORY_FAILURE
59#define SWP_HWPOISON_NUM 1
60#define SWP_HWPOISON MAX_SWAPFILES
61#else
62#define SWP_HWPOISON_NUM 0
63#endif
64
65#define MAX_SWAPFILES \
66 ((1 << MAX_SWAPFILES_SHIFT) - SWP_MIGRATION_NUM - SWP_HWPOISON_NUM)
67
1da177e4
LT
68/*
69 * Magic header for a swap area. The first part of the union is
70 * what the swap magic looks like for the old (limited to 128MB)
71 * swap area format, the second part of the union adds - in the
72 * old reserved area - some extra information. Note that the first
73 * kilobyte is reserved for boot loader or disk label stuff...
74 *
75 * Having the magic at the end of the PAGE_SIZE makes detecting swap
76 * areas somewhat tricky on machines that support multiple page sizes.
77 * For 2.5 we'll probably want to move the magic to just beyond the
78 * bootbits...
79 */
80union swap_header {
81 struct {
82 char reserved[PAGE_SIZE - 10];
83 char magic[10]; /* SWAP-SPACE or SWAPSPACE2 */
84 } magic;
85 struct {
e8f03d02
AD
86 char bootbits[1024]; /* Space for disklabel etc. */
87 __u32 version;
88 __u32 last_page;
89 __u32 nr_badpages;
90 unsigned char sws_uuid[16];
91 unsigned char sws_volume[16];
92 __u32 padding[117];
93 __u32 badpages[1];
1da177e4
LT
94 } info;
95};
96
97 /* A swap entry has to fit into a "unsigned long", as
98 * the entry is hidden in the "index" field of the
99 * swapper address space.
100 */
101typedef struct {
102 unsigned long val;
103} swp_entry_t;
104
105/*
106 * current->reclaim_state points to one of these when a task is running
107 * memory reclaim
108 */
109struct reclaim_state {
110 unsigned long reclaimed_slab;
111};
112
113#ifdef __KERNEL__
114
115struct address_space;
116struct sysinfo;
117struct writeback_control;
118struct zone;
119
120/*
121 * A swap extent maps a range of a swapfile's PAGE_SIZE pages onto a range of
122 * disk blocks. A list of swap extents maps the entire swapfile. (Where the
123 * term `swapfile' refers to either a blockdevice or an IS_REG file. Apart
124 * from setup, they're handled identically.
125 *
126 * We always assume that blocks are of size PAGE_SIZE.
127 */
128struct swap_extent {
129 struct list_head list;
130 pgoff_t start_page;
131 pgoff_t nr_pages;
132 sector_t start_block;
133};
134
135/*
136 * Max bad pages in the new format..
137 */
138#define __swapoffset(x) ((unsigned long)&((union swap_header *)0)->x)
139#define MAX_SWAP_BADPAGES \
140 ((__swapoffset(magic.magic) - __swapoffset(info.badpages)) / sizeof(int))
141
142enum {
143 SWP_USED = (1 << 0), /* is slot in swap_info[] used? */
144 SWP_WRITEOK = (1 << 1), /* ok to write to this swap? */
6a6ba831 145 SWP_DISCARDABLE = (1 << 2), /* blkdev supports discard */
7992fde7 146 SWP_DISCARDING = (1 << 3), /* now discarding a free cluster */
20137a49 147 SWP_SOLIDSTATE = (1 << 4), /* blkdev seeks are cheap */
52b7efdb
HD
148 /* add others here before... */
149 SWP_SCANNING = (1 << 8), /* refcount in scan_swap_map */
1da177e4
LT
150};
151
152#define SWAP_CLUSTER_MAX 32
153
355cfa73
KH
154#define SWAP_MAP_MAX 0x7ffe
155#define SWAP_MAP_BAD 0x7fff
156#define SWAP_HAS_CACHE 0x8000 /* There is a swap cache of entry. */
157#define SWAP_COUNT_MASK (~SWAP_HAS_CACHE)
1da177e4
LT
158/*
159 * The in-memory structure used to track swap areas.
1da177e4
LT
160 */
161struct swap_info_struct {
ebebbbe9 162 unsigned long flags;
5d337b91 163 int prio; /* swap priority */
ebebbbe9 164 int next; /* next entry on swap list */
1da177e4
LT
165 struct file *swap_file;
166 struct block_device *bdev;
167 struct list_head extent_list;
1da177e4 168 struct swap_extent *curr_swap_extent;
ebebbbe9 169 unsigned short *swap_map;
1da177e4
LT
170 unsigned int lowest_bit;
171 unsigned int highest_bit;
7992fde7
HD
172 unsigned int lowest_alloc; /* while preparing discard cluster */
173 unsigned int highest_alloc; /* while preparing discard cluster */
1da177e4
LT
174 unsigned int cluster_next;
175 unsigned int cluster_nr;
6eb396dc
HD
176 unsigned int pages;
177 unsigned int max;
178 unsigned int inuse_pages;
ebebbbe9 179 unsigned int old_block_size;
1da177e4
LT
180};
181
182struct swap_list_t {
183 int head; /* head of priority-ordered swapfile list */
184 int next; /* swapfile to be used next */
185};
186
187/* Swap 50% full? Release swapcache more aggressively.. */
188#define vm_swap_full() (nr_swap_pages*2 < total_swap_pages)
189
1da177e4
LT
190/* linux/mm/page_alloc.c */
191extern unsigned long totalram_pages;
cb45b0e9 192extern unsigned long totalreserve_pages;
1da177e4
LT
193extern unsigned int nr_free_buffer_pages(void);
194extern unsigned int nr_free_pagecache_pages(void);
195
96177299
CL
196/* Definition of global_page_state not available yet */
197#define nr_free_pages() global_page_state(NR_FREE_PAGES)
198
199
1da177e4 200/* linux/mm/swap.c */
f04e9ebb
KM
201extern void __lru_cache_add(struct page *, enum lru_list lru);
202extern void lru_cache_add_lru(struct page *, enum lru_list lru);
b3c97528
HH
203extern void activate_page(struct page *);
204extern void mark_page_accessed(struct page *);
1da177e4 205extern void lru_add_drain(void);
053837fc 206extern int lru_add_drain_all(void);
ac6aadb2 207extern void rotate_reclaimable_page(struct page *page);
1da177e4
LT
208extern void swap_setup(void);
209
894bc310
LS
210extern void add_page_to_unevictable_list(struct page *page);
211
f04e9ebb
KM
212/**
213 * lru_cache_add: add a page to the page lists
214 * @page: the page to add
215 */
4f98a2fe 216static inline void lru_cache_add_anon(struct page *page)
f04e9ebb 217{
4f98a2fe 218 __lru_cache_add(page, LRU_INACTIVE_ANON);
f04e9ebb
KM
219}
220
4f98a2fe 221static inline void lru_cache_add_active_anon(struct page *page)
f04e9ebb 222{
4f98a2fe
RR
223 __lru_cache_add(page, LRU_ACTIVE_ANON);
224}
225
226static inline void lru_cache_add_file(struct page *page)
227{
228 __lru_cache_add(page, LRU_INACTIVE_FILE);
229}
230
231static inline void lru_cache_add_active_file(struct page *page)
232{
233 __lru_cache_add(page, LRU_ACTIVE_FILE);
f04e9ebb
KM
234}
235
1da177e4 236/* linux/mm/vmscan.c */
dac1d27b 237extern unsigned long try_to_free_pages(struct zonelist *zonelist, int order,
327c0e96 238 gfp_t gfp_mask, nodemask_t *mask);
e1a1cd59 239extern unsigned long try_to_free_mem_cgroup_pages(struct mem_cgroup *mem,
a7885eb8
KM
240 gfp_t gfp_mask, bool noswap,
241 unsigned int swappiness);
4e416953
BS
242extern unsigned long mem_cgroup_shrink_node_zone(struct mem_cgroup *mem,
243 gfp_t gfp_mask, bool noswap,
244 unsigned int swappiness,
245 struct zone *zone,
246 int nid);
4f98a2fe 247extern int __isolate_lru_page(struct page *page, int mode, int file);
69e05944 248extern unsigned long shrink_all_memory(unsigned long nr_pages);
1da177e4 249extern int vm_swappiness;
b20a3503 250extern int remove_mapping(struct address_space *mapping, struct page *page);
bd1e22b8 251extern long vm_total_pages;
b20a3503 252
9eeff239
CL
253#ifdef CONFIG_NUMA
254extern int zone_reclaim_mode;
9614634f 255extern int sysctl_min_unmapped_ratio;
0ff38490 256extern int sysctl_min_slab_ratio;
9eeff239
CL
257extern int zone_reclaim(struct zone *, gfp_t, unsigned int);
258#else
259#define zone_reclaim_mode 0
260static inline int zone_reclaim(struct zone *z, gfp_t mask, unsigned int order)
261{
262 return 0;
263}
264#endif
265
894bc310 266extern int page_evictable(struct page *page, struct vm_area_struct *vma);
89e004ea 267extern void scan_mapping_unevictable_pages(struct address_space *);
af936a16
LS
268
269extern unsigned long scan_unevictable_pages;
8d65af78 270extern int scan_unevictable_handler(struct ctl_table *, int,
af936a16
LS
271 void __user *, size_t *, loff_t *);
272extern int scan_unevictable_register_node(struct node *node);
273extern void scan_unevictable_unregister_node(struct node *node);
894bc310 274
3218ae14 275extern int kswapd_run(int nid);
8fe23e05 276extern void kswapd_stop(int nid);
3218ae14 277
1da177e4
LT
278#ifdef CONFIG_MMU
279/* linux/mm/shmem.c */
280extern int shmem_unuse(swp_entry_t entry, struct page *page);
281#endif /* CONFIG_MMU */
282
283extern void swap_unplug_io_fn(struct backing_dev_info *, struct page *);
284
285#ifdef CONFIG_SWAP
286/* linux/mm/page_io.c */
aca8bf32 287extern int swap_readpage(struct page *);
1da177e4 288extern int swap_writepage(struct page *page, struct writeback_control *wbc);
6712ecf8 289extern void end_swap_bio_read(struct bio *bio, int err);
1da177e4
LT
290
291/* linux/mm/swap_state.c */
292extern struct address_space swapper_space;
293#define total_swapcache_pages swapper_space.nrpages
294extern void show_swap_cache_info(void);
ac47b003 295extern int add_to_swap(struct page *);
73b1262f 296extern int add_to_swap_cache(struct page *, swp_entry_t, gfp_t);
1da177e4
LT
297extern void __delete_from_swap_cache(struct page *);
298extern void delete_from_swap_cache(struct page *);
1da177e4
LT
299extern void free_page_and_swap_cache(struct page *);
300extern void free_pages_and_swap_cache(struct page **, int);
46017e95 301extern struct page *lookup_swap_cache(swp_entry_t);
02098fea 302extern struct page *read_swap_cache_async(swp_entry_t, gfp_t,
46017e95 303 struct vm_area_struct *vma, unsigned long addr);
02098fea 304extern struct page *swapin_readahead(swp_entry_t, gfp_t,
46017e95
HD
305 struct vm_area_struct *vma, unsigned long addr);
306
1da177e4 307/* linux/mm/swapfile.c */
b962716b 308extern long nr_swap_pages;
1da177e4 309extern long total_swap_pages;
1da177e4
LT
310extern void si_swapinfo(struct sysinfo *);
311extern swp_entry_t get_swap_page(void);
f577eb30 312extern swp_entry_t get_swap_page_of_type(int);
355cfa73 313extern void swap_duplicate(swp_entry_t);
cb4b86ba 314extern int swapcache_prepare(swp_entry_t);
1da177e4
LT
315extern int valid_swaphandles(swp_entry_t, unsigned long *);
316extern void swap_free(swp_entry_t);
cb4b86ba 317extern void swapcache_free(swp_entry_t, struct page *page);
2509ef26 318extern int free_swap_and_cache(swp_entry_t);
7bf23687 319extern int swap_type_of(dev_t, sector_t, struct block_device **);
f577eb30 320extern unsigned int count_swap_pages(int, int);
f29ad6a9 321extern sector_t map_swap_page(swp_entry_t, struct block_device **);
3aef83e0 322extern sector_t swapdev_block(int, pgoff_t);
7b1fe597 323extern int reuse_swap_page(struct page *);
a2c43eed 324extern int try_to_free_swap(struct page *);
1da177e4
LT
325struct backing_dev_info;
326
1da177e4 327/* linux/mm/thrash.c */
a5c9b696
HD
328extern struct mm_struct *swap_token_mm;
329extern void grab_swap_token(struct mm_struct *);
1da177e4
LT
330extern void __put_swap_token(struct mm_struct *);
331
332static inline int has_swap_token(struct mm_struct *mm)
333{
334 return (mm == swap_token_mm);
335}
336
337static inline void put_swap_token(struct mm_struct *mm)
338{
339 if (has_swap_token(mm))
340 __put_swap_token(mm);
341}
342
f7b7fd8f
RR
343static inline void disable_swap_token(void)
344{
345 put_swap_token(swap_token_mm);
346}
347
d13d1443 348#ifdef CONFIG_CGROUP_MEM_RES_CTLR
8a9478ca
KH
349extern void
350mem_cgroup_uncharge_swapcache(struct page *page, swp_entry_t ent, bool swapout);
d13d1443 351#else
8c7c6e34 352static inline void
8a9478ca 353mem_cgroup_uncharge_swapcache(struct page *page, swp_entry_t ent, bool swapout)
8c7c6e34
KH
354{
355}
356#endif
357#ifdef CONFIG_CGROUP_MEM_RES_CTLR_SWAP
358extern void mem_cgroup_uncharge_swap(swp_entry_t ent);
359#else
360static inline void mem_cgroup_uncharge_swap(swp_entry_t ent)
d13d1443
KH
361{
362}
363#endif
364
1da177e4
LT
365#else /* CONFIG_SWAP */
366
b962716b
HD
367#define nr_swap_pages 0L
368#define total_swap_pages 0L
1da177e4
LT
369#define total_swapcache_pages 0UL
370
371#define si_swapinfo(val) \
372 do { (val)->freeswap = (val)->totalswap = 0; } while (0)
9ae5b3c7
OH
373/* only sparc can not include linux/pagemap.h in this file
374 * so leave page_cache_release and release_pages undeclared... */
1da177e4
LT
375#define free_page_and_swap_cache(page) \
376 page_cache_release(page)
377#define free_pages_and_swap_cache(pages, nr) \
378 release_pages((pages), (nr), 0);
379
bd96b9eb
CK
380static inline void show_swap_cache_info(void)
381{
382}
383
2509ef26 384#define free_swap_and_cache(swp) is_migration_entry(swp)
cb4b86ba 385#define swapcache_prepare(swp) is_migration_entry(swp)
bd96b9eb 386
355cfa73
KH
387static inline void swap_duplicate(swp_entry_t swp)
388{
389}
390
bd96b9eb
CK
391static inline void swap_free(swp_entry_t swp)
392{
393}
394
cb4b86ba
KH
395static inline void swapcache_free(swp_entry_t swp, struct page *page)
396{
397}
398
02098fea 399static inline struct page *swapin_readahead(swp_entry_t swp, gfp_t gfp_mask,
bd96b9eb
CK
400 struct vm_area_struct *vma, unsigned long addr)
401{
402 return NULL;
403}
404
9fab5619
HD
405static inline int swap_writepage(struct page *p, struct writeback_control *wbc)
406{
407 return 0;
408}
409
bd96b9eb
CK
410static inline struct page *lookup_swap_cache(swp_entry_t swp)
411{
412 return NULL;
413}
414
60371d97
HD
415static inline int add_to_swap(struct page *page)
416{
417 return 0;
418}
419
73b1262f
HD
420static inline int add_to_swap_cache(struct page *page, swp_entry_t entry,
421 gfp_t gfp_mask)
bd96b9eb 422{
73b1262f 423 return -1;
bd96b9eb
CK
424}
425
426static inline void __delete_from_swap_cache(struct page *page)
427{
428}
429
430static inline void delete_from_swap_cache(struct page *page)
431{
432}
433
7b1fe597 434#define reuse_swap_page(page) (page_mapcount(page) == 1)
1da177e4 435
a2c43eed 436static inline int try_to_free_swap(struct page *page)
68a22394
RR
437{
438 return 0;
439}
440
1da177e4
LT
441static inline swp_entry_t get_swap_page(void)
442{
443 swp_entry_t entry;
444 entry.val = 0;
445 return entry;
446}
447
448/* linux/mm/thrash.c */
a5abeeac
JW
449static inline void put_swap_token(struct mm_struct *mm)
450{
451}
452
453static inline void grab_swap_token(struct mm_struct *mm)
454{
455}
456
457static inline int has_swap_token(struct mm_struct *mm)
458{
459 return 0;
460}
461
462static inline void disable_swap_token(void)
463{
464}
1da177e4 465
e767e056
DN
466static inline void
467mem_cgroup_uncharge_swapcache(struct page *page, swp_entry_t ent)
468{
469}
470
1da177e4
LT
471#endif /* CONFIG_SWAP */
472#endif /* __KERNEL__*/
473#endif /* _LINUX_SWAP_H */