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