Merge branch 'drm-intel-fixes' of git://git.kernel.org/pub/scm/linux/kernel/git/keith...
[linux-block.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);
e1a1cd59 254extern unsigned long try_to_free_mem_cgroup_pages(struct mem_cgroup *mem,
a7885eb8
KM
255 gfp_t gfp_mask, bool noswap,
256 unsigned int swappiness);
4e416953
BS
257extern unsigned long mem_cgroup_shrink_node_zone(struct mem_cgroup *mem,
258 gfp_t gfp_mask, bool noswap,
259 unsigned int swappiness,
14fec796 260 struct zone *zone);
4f98a2fe 261extern int __isolate_lru_page(struct page *page, int mode, int file);
69e05944 262extern unsigned long shrink_all_memory(unsigned long nr_pages);
1da177e4 263extern int vm_swappiness;
b20a3503 264extern int remove_mapping(struct address_space *mapping, struct page *page);
bd1e22b8 265extern long vm_total_pages;
b20a3503 266
9eeff239
CL
267#ifdef CONFIG_NUMA
268extern int zone_reclaim_mode;
9614634f 269extern int sysctl_min_unmapped_ratio;
0ff38490 270extern int sysctl_min_slab_ratio;
9eeff239
CL
271extern int zone_reclaim(struct zone *, gfp_t, unsigned int);
272#else
273#define zone_reclaim_mode 0
274static inline int zone_reclaim(struct zone *z, gfp_t mask, unsigned int order)
275{
276 return 0;
277}
278#endif
279
894bc310 280extern int page_evictable(struct page *page, struct vm_area_struct *vma);
89e004ea 281extern void scan_mapping_unevictable_pages(struct address_space *);
af936a16
LS
282
283extern unsigned long scan_unevictable_pages;
8d65af78 284extern int scan_unevictable_handler(struct ctl_table *, int,
af936a16 285 void __user *, size_t *, loff_t *);
e4455abb 286#ifdef CONFIG_NUMA
af936a16
LS
287extern int scan_unevictable_register_node(struct node *node);
288extern void scan_unevictable_unregister_node(struct node *node);
e4455abb
TLSC
289#else
290static inline int scan_unevictable_register_node(struct node *node)
291{
292 return 0;
293}
294static inline void scan_unevictable_unregister_node(struct node *node)
295{
296}
297#endif
894bc310 298
3218ae14 299extern int kswapd_run(int nid);
8fe23e05 300extern void kswapd_stop(int nid);
3218ae14 301
1da177e4
LT
302#ifdef CONFIG_MMU
303/* linux/mm/shmem.c */
304extern int shmem_unuse(swp_entry_t entry, struct page *page);
305#endif /* CONFIG_MMU */
306
87946a72
DN
307#ifdef CONFIG_CGROUP_MEM_RES_CTLR
308extern void mem_cgroup_get_shmem_target(struct inode *inode, pgoff_t pgoff,
309 struct page **pagep, swp_entry_t *ent);
310#endif
311
1da177e4
LT
312#ifdef CONFIG_SWAP
313/* linux/mm/page_io.c */
aca8bf32 314extern int swap_readpage(struct page *);
1da177e4 315extern int swap_writepage(struct page *page, struct writeback_control *wbc);
6712ecf8 316extern void end_swap_bio_read(struct bio *bio, int err);
1da177e4
LT
317
318/* linux/mm/swap_state.c */
319extern struct address_space swapper_space;
320#define total_swapcache_pages swapper_space.nrpages
321extern void show_swap_cache_info(void);
ac47b003 322extern int add_to_swap(struct page *);
73b1262f 323extern int add_to_swap_cache(struct page *, swp_entry_t, gfp_t);
1da177e4
LT
324extern void __delete_from_swap_cache(struct page *);
325extern void delete_from_swap_cache(struct page *);
1da177e4
LT
326extern void free_page_and_swap_cache(struct page *);
327extern void free_pages_and_swap_cache(struct page **, int);
46017e95 328extern struct page *lookup_swap_cache(swp_entry_t);
02098fea 329extern struct page *read_swap_cache_async(swp_entry_t, gfp_t,
46017e95 330 struct vm_area_struct *vma, unsigned long addr);
02098fea 331extern struct page *swapin_readahead(swp_entry_t, gfp_t,
46017e95
HD
332 struct vm_area_struct *vma, unsigned long addr);
333
1da177e4 334/* linux/mm/swapfile.c */
b962716b 335extern long nr_swap_pages;
1da177e4 336extern long total_swap_pages;
1da177e4
LT
337extern void si_swapinfo(struct sysinfo *);
338extern swp_entry_t get_swap_page(void);
910321ea 339extern swp_entry_t get_swap_page_of_type(int);
1da177e4 340extern int valid_swaphandles(swp_entry_t, unsigned long *);
570a335b 341extern int add_swap_count_continuation(swp_entry_t, gfp_t);
aaa46865 342extern void swap_shmem_alloc(swp_entry_t);
570a335b
HD
343extern int swap_duplicate(swp_entry_t);
344extern int swapcache_prepare(swp_entry_t);
1da177e4 345extern void swap_free(swp_entry_t);
cb4b86ba 346extern void swapcache_free(swp_entry_t, struct page *page);
2509ef26 347extern int free_swap_and_cache(swp_entry_t);
7bf23687 348extern int swap_type_of(dev_t, sector_t, struct block_device **);
f577eb30 349extern unsigned int count_swap_pages(int, int);
d4906e1a 350extern sector_t map_swap_page(struct page *, struct block_device **);
3aef83e0 351extern sector_t swapdev_block(int, pgoff_t);
7b1fe597 352extern int reuse_swap_page(struct page *);
a2c43eed 353extern int try_to_free_swap(struct page *);
1da177e4
LT
354struct backing_dev_info;
355
1da177e4 356/* linux/mm/thrash.c */
a5c9b696
HD
357extern struct mm_struct *swap_token_mm;
358extern void grab_swap_token(struct mm_struct *);
1da177e4
LT
359extern void __put_swap_token(struct mm_struct *);
360
361static inline int has_swap_token(struct mm_struct *mm)
362{
363 return (mm == swap_token_mm);
364}
365
366static inline void put_swap_token(struct mm_struct *mm)
367{
368 if (has_swap_token(mm))
369 __put_swap_token(mm);
370}
371
f7b7fd8f
RR
372static inline void disable_swap_token(void)
373{
374 put_swap_token(swap_token_mm);
375}
376
d13d1443 377#ifdef CONFIG_CGROUP_MEM_RES_CTLR
8a9478ca
KH
378extern void
379mem_cgroup_uncharge_swapcache(struct page *page, swp_entry_t ent, bool swapout);
02491447 380extern int mem_cgroup_count_swap_user(swp_entry_t ent, struct page **pagep);
d13d1443 381#else
8c7c6e34 382static inline void
8a9478ca 383mem_cgroup_uncharge_swapcache(struct page *page, swp_entry_t ent, bool swapout)
8c7c6e34
KH
384{
385}
386#endif
387#ifdef CONFIG_CGROUP_MEM_RES_CTLR_SWAP
388extern void mem_cgroup_uncharge_swap(swp_entry_t ent);
389#else
390static inline void mem_cgroup_uncharge_swap(swp_entry_t ent)
d13d1443
KH
391{
392}
393#endif
394
1da177e4
LT
395#else /* CONFIG_SWAP */
396
b962716b
HD
397#define nr_swap_pages 0L
398#define total_swap_pages 0L
1da177e4
LT
399#define total_swapcache_pages 0UL
400
401#define si_swapinfo(val) \
402 do { (val)->freeswap = (val)->totalswap = 0; } while (0)
9ae5b3c7
OH
403/* only sparc can not include linux/pagemap.h in this file
404 * so leave page_cache_release and release_pages undeclared... */
1da177e4
LT
405#define free_page_and_swap_cache(page) \
406 page_cache_release(page)
407#define free_pages_and_swap_cache(pages, nr) \
408 release_pages((pages), (nr), 0);
409
bd96b9eb
CK
410static inline void show_swap_cache_info(void)
411{
412}
413
2509ef26 414#define free_swap_and_cache(swp) is_migration_entry(swp)
cb4b86ba 415#define swapcache_prepare(swp) is_migration_entry(swp)
bd96b9eb 416
570a335b 417static inline int add_swap_count_continuation(swp_entry_t swp, gfp_t gfp_mask)
355cfa73 418{
570a335b
HD
419 return 0;
420}
421
aaa46865
HD
422static inline void swap_shmem_alloc(swp_entry_t swp)
423{
424}
425
570a335b
HD
426static inline int swap_duplicate(swp_entry_t swp)
427{
428 return 0;
355cfa73
KH
429}
430
bd96b9eb
CK
431static inline void swap_free(swp_entry_t swp)
432{
433}
434
cb4b86ba
KH
435static inline void swapcache_free(swp_entry_t swp, struct page *page)
436{
437}
438
02098fea 439static inline struct page *swapin_readahead(swp_entry_t swp, gfp_t gfp_mask,
bd96b9eb
CK
440 struct vm_area_struct *vma, unsigned long addr)
441{
442 return NULL;
443}
444
9fab5619
HD
445static inline int swap_writepage(struct page *p, struct writeback_control *wbc)
446{
447 return 0;
448}
449
bd96b9eb
CK
450static inline struct page *lookup_swap_cache(swp_entry_t swp)
451{
452 return NULL;
453}
454
60371d97
HD
455static inline int add_to_swap(struct page *page)
456{
457 return 0;
458}
459
73b1262f
HD
460static inline int add_to_swap_cache(struct page *page, swp_entry_t entry,
461 gfp_t gfp_mask)
bd96b9eb 462{
73b1262f 463 return -1;
bd96b9eb
CK
464}
465
466static inline void __delete_from_swap_cache(struct page *page)
467{
468}
469
470static inline void delete_from_swap_cache(struct page *page)
471{
472}
473
7b1fe597 474#define reuse_swap_page(page) (page_mapcount(page) == 1)
1da177e4 475
a2c43eed 476static inline int try_to_free_swap(struct page *page)
68a22394
RR
477{
478 return 0;
479}
480
1da177e4
LT
481static inline swp_entry_t get_swap_page(void)
482{
483 swp_entry_t entry;
484 entry.val = 0;
485 return entry;
486}
487
488/* linux/mm/thrash.c */
a5abeeac
JW
489static inline void put_swap_token(struct mm_struct *mm)
490{
491}
492
493static inline void grab_swap_token(struct mm_struct *mm)
494{
495}
496
497static inline int has_swap_token(struct mm_struct *mm)
498{
499 return 0;
500}
501
502static inline void disable_swap_token(void)
503{
504}
1da177e4 505
e767e056
DN
506static inline void
507mem_cgroup_uncharge_swapcache(struct page *page, swp_entry_t ent)
508{
509}
510
02491447
DN
511#ifdef CONFIG_CGROUP_MEM_RES_CTLR
512static inline int
513mem_cgroup_count_swap_user(swp_entry_t ent, struct page **pagep)
514{
515 return 0;
516}
517#endif
518
1da177e4
LT
519#endif /* CONFIG_SWAP */
520#endif /* __KERNEL__*/
521#endif /* _LINUX_SWAP_H */