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