8a3c4a1caa14f501bac7d812f69ca4cc359ed0f7
[platform/adaptation/renesas_rcar/renesas_kernel.git] / include / linux / swap.h
1 #ifndef _LINUX_SWAP_H
2 #define _LINUX_SWAP_H
3
4 #include <linux/spinlock.h>
5 #include <linux/linkage.h>
6 #include <linux/mmzone.h>
7 #include <linux/list.h>
8 #include <linux/memcontrol.h>
9 #include <linux/sched.h>
10 #include <linux/node.h>
11 #include <linux/fs.h>
12 #include <linux/atomic.h>
13 #include <linux/page-flags.h>
14 #include <asm/page.h>
15
16 struct notifier_block;
17
18 struct bio;
19
20 #define SWAP_FLAG_PREFER        0x8000  /* set if swap priority specified */
21 #define SWAP_FLAG_PRIO_MASK     0x7fff
22 #define SWAP_FLAG_PRIO_SHIFT    0
23 #define SWAP_FLAG_DISCARD       0x10000 /* enable discard for swap */
24 #define SWAP_FLAG_DISCARD_ONCE  0x20000 /* discard swap area at swapon-time */
25 #define SWAP_FLAG_DISCARD_PAGES 0x40000 /* discard page-clusters after use */
26
27 #define SWAP_FLAGS_VALID        (SWAP_FLAG_PRIO_MASK | SWAP_FLAG_PREFER | \
28                                  SWAP_FLAG_DISCARD | SWAP_FLAG_DISCARD_ONCE | \
29                                  SWAP_FLAG_DISCARD_PAGES)
30
31 static inline int current_is_kswapd(void)
32 {
33         return current->flags & PF_KSWAPD;
34 }
35
36 /*
37  * MAX_SWAPFILES defines the maximum number of swaptypes: things which can
38  * be swapped to.  The swap type and the offset into that swap type are
39  * encoded into pte's and into pgoff_t's in the swapcache.  Using five bits
40  * for the type means that the maximum number of swapcache pages is 27 bits
41  * on 32-bit-pgoff_t architectures.  And that assumes that the architecture packs
42  * the type/offset into the pte as 5/27 as well.
43  */
44 #define MAX_SWAPFILES_SHIFT     5
45
46 /*
47  * Use some of the swap files numbers for other purposes. This
48  * is a convenient way to hook into the VM to trigger special
49  * actions on faults.
50  */
51
52 /*
53  * NUMA node memory migration support
54  */
55 #ifdef CONFIG_MIGRATION
56 #define SWP_MIGRATION_NUM 2
57 #define SWP_MIGRATION_READ      (MAX_SWAPFILES + SWP_HWPOISON_NUM)
58 #define SWP_MIGRATION_WRITE     (MAX_SWAPFILES + SWP_HWPOISON_NUM + 1)
59 #else
60 #define SWP_MIGRATION_NUM 0
61 #endif
62
63 /*
64  * Handling of hardware poisoned pages with memory corruption.
65  */
66 #ifdef CONFIG_MEMORY_FAILURE
67 #define SWP_HWPOISON_NUM 1
68 #define SWP_HWPOISON            MAX_SWAPFILES
69 #else
70 #define SWP_HWPOISON_NUM 0
71 #endif
72
73 #define MAX_SWAPFILES \
74         ((1 << MAX_SWAPFILES_SHIFT) - SWP_MIGRATION_NUM - SWP_HWPOISON_NUM)
75
76 /*
77  * Magic header for a swap area. The first part of the union is
78  * what the swap magic looks like for the old (limited to 128MB)
79  * swap area format, the second part of the union adds - in the
80  * old reserved area - some extra information. Note that the first
81  * kilobyte is reserved for boot loader or disk label stuff...
82  *
83  * Having the magic at the end of the PAGE_SIZE makes detecting swap
84  * areas somewhat tricky on machines that support multiple page sizes.
85  * For 2.5 we'll probably want to move the magic to just beyond the
86  * bootbits...
87  */
88 union swap_header {
89         struct {
90                 char reserved[PAGE_SIZE - 10];
91                 char magic[10];                 /* SWAP-SPACE or SWAPSPACE2 */
92         } magic;
93         struct {
94                 char            bootbits[1024]; /* Space for disklabel etc. */
95                 __u32           version;
96                 __u32           last_page;
97                 __u32           nr_badpages;
98                 unsigned char   sws_uuid[16];
99                 unsigned char   sws_volume[16];
100                 __u32           padding[117];
101                 __u32           badpages[1];
102         } info;
103 };
104
105  /* A swap entry has to fit into a "unsigned long", as
106   * the entry is hidden in the "index" field of the
107   * swapper address space.
108   */
109 typedef struct {
110         unsigned long val;
111 } swp_entry_t;
112
113 /*
114  * current->reclaim_state points to one of these when a task is running
115  * memory reclaim
116  */
117 struct reclaim_state {
118         unsigned long reclaimed_slab;
119 };
120
121 #ifdef __KERNEL__
122
123 struct address_space;
124 struct sysinfo;
125 struct writeback_control;
126 struct zone;
127
128 /*
129  * A swap extent maps a range of a swapfile's PAGE_SIZE pages onto a range of
130  * disk blocks.  A list of swap extents maps the entire swapfile.  (Where the
131  * term `swapfile' refers to either a blockdevice or an IS_REG file.  Apart
132  * from setup, they're handled identically.
133  *
134  * We always assume that blocks are of size PAGE_SIZE.
135  */
136 struct swap_extent {
137         struct list_head list;
138         pgoff_t start_page;
139         pgoff_t nr_pages;
140         sector_t start_block;
141 };
142
143 /*
144  * Max bad pages in the new format..
145  */
146 #define __swapoffset(x) ((unsigned long)&((union swap_header *)0)->x)
147 #define MAX_SWAP_BADPAGES \
148         ((__swapoffset(magic.magic) - __swapoffset(info.badpages)) / sizeof(int))
149
150 enum {
151         SWP_USED        = (1 << 0),     /* is slot in swap_info[] used? */
152         SWP_WRITEOK     = (1 << 1),     /* ok to write to this swap?    */
153         SWP_DISCARDABLE = (1 << 2),     /* blkdev support discard */
154         SWP_DISCARDING  = (1 << 3),     /* now discarding a free cluster */
155         SWP_SOLIDSTATE  = (1 << 4),     /* blkdev seeks are cheap */
156         SWP_CONTINUED   = (1 << 5),     /* swap_map has count continuation */
157         SWP_BLKDEV      = (1 << 6),     /* its a block device */
158         SWP_FILE        = (1 << 7),     /* set after swap_activate success */
159         SWP_AREA_DISCARD = (1 << 8),    /* single-time swap area discards */
160         SWP_PAGE_DISCARD = (1 << 9),    /* freed swap page-cluster discards */
161                                         /* add others here before... */
162         SWP_SCANNING    = (1 << 10),    /* refcount in scan_swap_map */
163 };
164
165 #define SWAP_CLUSTER_MAX 32UL
166 #define COMPACT_CLUSTER_MAX SWAP_CLUSTER_MAX
167
168 /*
169  * Ratio between the present memory in the zone and the "gap" that
170  * we're allowing kswapd to shrink in addition to the per-zone high
171  * wmark, even for zones that already have the high wmark satisfied,
172  * in order to provide better per-zone lru behavior. We are ok to
173  * spend not more than 1% of the memory for this zone balancing "gap".
174  */
175 #define KSWAPD_ZONE_BALANCE_GAP_RATIO 100
176
177 #define SWAP_MAP_MAX    0x3e    /* Max duplication count, in first swap_map */
178 #define SWAP_MAP_BAD    0x3f    /* Note pageblock is bad, in first swap_map */
179 #define SWAP_HAS_CACHE  0x40    /* Flag page is cached, in first swap_map */
180 #define SWAP_CONT_MAX   0x7f    /* Max count, in each swap_map continuation */
181 #define COUNT_CONTINUED 0x80    /* See swap_map continuation for full count */
182 #define SWAP_MAP_SHMEM  0xbf    /* Owned by shmem/tmpfs, in first swap_map */
183
184 /*
185  * We use this to track usage of a cluster. A cluster is a block of swap disk
186  * space with SWAPFILE_CLUSTER pages long and naturally aligns in disk. All
187  * free clusters are organized into a list. We fetch an entry from the list to
188  * get a free cluster.
189  *
190  * The data field stores next cluster if the cluster is free or cluster usage
191  * counter otherwise. The flags field determines if a cluster is free. This is
192  * protected by swap_info_struct.lock.
193  */
194 struct swap_cluster_info {
195         unsigned int data:24;
196         unsigned int flags:8;
197 };
198 #define CLUSTER_FLAG_FREE 1 /* This cluster is free */
199 #define CLUSTER_FLAG_NEXT_NULL 2 /* This cluster has no next cluster */
200
201 /*
202  * The in-memory structure used to track swap areas.
203  */
204 struct swap_info_struct {
205         unsigned long   flags;          /* SWP_USED etc: see above */
206         signed short    prio;           /* swap priority of this type */
207         signed char     type;           /* strange name for an index */
208         signed char     next;           /* next type on the swap list */
209         unsigned int    max;            /* extent of the swap_map */
210         unsigned char *swap_map;        /* vmalloc'ed array of usage counts */
211         struct swap_cluster_info *cluster_info; /* cluster info. Only for SSD */
212         struct swap_cluster_info free_cluster_head; /* free cluster list head */
213         struct swap_cluster_info free_cluster_tail; /* free cluster list tail */
214         unsigned int lowest_bit;        /* index of first free in swap_map */
215         unsigned int highest_bit;       /* index of last free in swap_map */
216         unsigned int pages;             /* total of usable pages of swap */
217         unsigned int inuse_pages;       /* number of those currently in use */
218         unsigned int cluster_next;      /* likely index for next allocation */
219         unsigned int cluster_nr;        /* countdown to next cluster search */
220         struct swap_extent *curr_swap_extent;
221         struct swap_extent first_swap_extent;
222         struct block_device *bdev;      /* swap device or bdev of swap file */
223         struct file *swap_file;         /* seldom referenced */
224         unsigned int old_block_size;    /* seldom referenced */
225 #ifdef CONFIG_FRONTSWAP
226         unsigned long *frontswap_map;   /* frontswap in-use, one bit per page */
227         atomic_t frontswap_pages;       /* frontswap pages in-use counter */
228 #endif
229         spinlock_t lock;                /*
230                                          * protect map scan related fields like
231                                          * swap_map, lowest_bit, highest_bit,
232                                          * inuse_pages, cluster_next,
233                                          * cluster_nr, lowest_alloc,
234                                          * highest_alloc, free/discard cluster
235                                          * list. other fields are only changed
236                                          * at swapon/swapoff, so are protected
237                                          * by swap_lock. changing flags need
238                                          * hold this lock and swap_lock. If
239                                          * both locks need hold, hold swap_lock
240                                          * first.
241                                          */
242         struct work_struct discard_work; /* discard worker */
243         struct swap_cluster_info discard_cluster_head; /* list head of discard clusters */
244         struct swap_cluster_info discard_cluster_tail; /* list tail of discard clusters */
245 };
246
247 struct swap_list_t {
248         int head;       /* head of priority-ordered swapfile list */
249         int next;       /* swapfile to be used next */
250 };
251
252 /* linux/mm/page_alloc.c */
253 extern unsigned long totalram_pages;
254 extern unsigned long totalreserve_pages;
255 extern unsigned long dirty_balance_reserve;
256 extern unsigned long nr_free_buffer_pages(void);
257 extern unsigned long nr_free_pagecache_pages(void);
258
259 /* Definition of global_page_state not available yet */
260 #define nr_free_pages() global_page_state(NR_FREE_PAGES)
261
262
263 /* linux/mm/swap.c */
264 extern void __lru_cache_add(struct page *);
265 extern void lru_cache_add(struct page *);
266 extern void lru_add_page_tail(struct page *page, struct page *page_tail,
267                          struct lruvec *lruvec, struct list_head *head);
268 extern void activate_page(struct page *);
269 extern void mark_page_accessed(struct page *);
270 extern void lru_add_drain(void);
271 extern void lru_add_drain_cpu(int cpu);
272 extern int lru_add_drain_all(void);
273 extern void rotate_reclaimable_page(struct page *page);
274 extern void deactivate_page(struct page *page);
275 extern void swap_setup(void);
276
277 extern void add_page_to_unevictable_list(struct page *page);
278
279 /**
280  * lru_cache_add: add a page to the page lists
281  * @page: the page to add
282  */
283 static inline void lru_cache_add_anon(struct page *page)
284 {
285         ClearPageActive(page);
286         __lru_cache_add(page);
287 }
288
289 static inline void lru_cache_add_file(struct page *page)
290 {
291         ClearPageActive(page);
292         __lru_cache_add(page);
293 }
294
295 /* linux/mm/vmscan.c */
296 extern unsigned long try_to_free_pages(struct zonelist *zonelist, int order,
297                                         gfp_t gfp_mask, nodemask_t *mask);
298 extern int __isolate_lru_page(struct page *page, isolate_mode_t mode);
299 extern unsigned long try_to_free_mem_cgroup_pages(struct mem_cgroup *mem,
300                                                   gfp_t gfp_mask, bool noswap);
301 extern unsigned long mem_cgroup_shrink_node_zone(struct mem_cgroup *mem,
302                                                 gfp_t gfp_mask, bool noswap,
303                                                 struct zone *zone,
304                                                 unsigned long *nr_scanned);
305 extern unsigned long shrink_all_memory(unsigned long nr_pages);
306 extern int vm_swappiness;
307 extern int remove_mapping(struct address_space *mapping, struct page *page);
308 extern unsigned long vm_total_pages;
309
310 #ifdef CONFIG_NUMA
311 extern int zone_reclaim_mode;
312 extern int sysctl_min_unmapped_ratio;
313 extern int sysctl_min_slab_ratio;
314 extern int zone_reclaim(struct zone *, gfp_t, unsigned int);
315 #else
316 #define zone_reclaim_mode 0
317 static inline int zone_reclaim(struct zone *z, gfp_t mask, unsigned int order)
318 {
319         return 0;
320 }
321 #endif
322
323 extern int page_evictable(struct page *page);
324 extern void check_move_unevictable_pages(struct page **, int nr_pages);
325
326 extern unsigned long scan_unevictable_pages;
327 extern int scan_unevictable_handler(struct ctl_table *, int,
328                                         void __user *, size_t *, loff_t *);
329 #ifdef CONFIG_NUMA
330 extern int scan_unevictable_register_node(struct node *node);
331 extern void scan_unevictable_unregister_node(struct node *node);
332 #else
333 static inline int scan_unevictable_register_node(struct node *node)
334 {
335         return 0;
336 }
337 static inline void scan_unevictable_unregister_node(struct node *node)
338 {
339 }
340 #endif
341
342 extern int kswapd_run(int nid);
343 extern void kswapd_stop(int nid);
344 #ifdef CONFIG_MEMCG
345 extern int mem_cgroup_swappiness(struct mem_cgroup *mem);
346 #else
347 static inline int mem_cgroup_swappiness(struct mem_cgroup *mem)
348 {
349         return vm_swappiness;
350 }
351 #endif
352 #ifdef CONFIG_MEMCG_SWAP
353 extern void mem_cgroup_uncharge_swap(swp_entry_t ent);
354 #else
355 static inline void mem_cgroup_uncharge_swap(swp_entry_t ent)
356 {
357 }
358 #endif
359 #ifdef CONFIG_SWAP
360 /* linux/mm/page_io.c */
361 extern int swap_readpage(struct page *);
362 extern int swap_writepage(struct page *page, struct writeback_control *wbc);
363 extern void end_swap_bio_write(struct bio *bio, int err);
364 extern int __swap_writepage(struct page *page, struct writeback_control *wbc,
365         void (*end_write_func)(struct bio *, int));
366 extern int swap_set_page_dirty(struct page *page);
367 extern void end_swap_bio_read(struct bio *bio, int err);
368
369 int add_swap_extent(struct swap_info_struct *sis, unsigned long start_page,
370                 unsigned long nr_pages, sector_t start_block);
371 int generic_swapfile_activate(struct swap_info_struct *, struct file *,
372                 sector_t *);
373
374 /* linux/mm/swap_state.c */
375 extern struct address_space swapper_spaces[];
376 #define swap_address_space(entry) (&swapper_spaces[swp_type(entry)])
377 extern unsigned long total_swapcache_pages(void);
378 extern void show_swap_cache_info(void);
379 extern int add_to_swap(struct page *, struct list_head *list);
380 extern int add_to_swap_cache(struct page *, swp_entry_t, gfp_t);
381 extern int __add_to_swap_cache(struct page *page, swp_entry_t entry);
382 extern void __delete_from_swap_cache(struct page *);
383 extern void delete_from_swap_cache(struct page *);
384 extern void free_page_and_swap_cache(struct page *);
385 extern void free_pages_and_swap_cache(struct page **, int);
386 extern struct page *lookup_swap_cache(swp_entry_t);
387 extern struct page *read_swap_cache_async(swp_entry_t, gfp_t,
388                         struct vm_area_struct *vma, unsigned long addr);
389 extern struct page *swapin_readahead(swp_entry_t, gfp_t,
390                         struct vm_area_struct *vma, unsigned long addr);
391
392 /* linux/mm/swapfile.c */
393 extern atomic_long_t nr_swap_pages;
394 extern long total_swap_pages;
395
396 /* Swap 50% full? Release swapcache more aggressively.. */
397 static inline bool vm_swap_full(void)
398 {
399         return atomic_long_read(&nr_swap_pages) * 2 < total_swap_pages;
400 }
401
402 static inline long get_nr_swap_pages(void)
403 {
404         return atomic_long_read(&nr_swap_pages);
405 }
406
407 extern void si_swapinfo(struct sysinfo *);
408 extern swp_entry_t get_swap_page(void);
409 extern swp_entry_t get_swap_page_of_type(int);
410 extern int add_swap_count_continuation(swp_entry_t, gfp_t);
411 extern void swap_shmem_alloc(swp_entry_t);
412 extern int swap_duplicate(swp_entry_t);
413 extern int swapcache_prepare(swp_entry_t);
414 extern void swap_free(swp_entry_t);
415 extern void swapcache_free(swp_entry_t, struct page *page);
416 extern int free_swap_and_cache(swp_entry_t);
417 extern int swap_type_of(dev_t, sector_t, struct block_device **);
418 extern unsigned int count_swap_pages(int, int);
419 extern sector_t map_swap_page(struct page *, struct block_device **);
420 extern sector_t swapdev_block(int, pgoff_t);
421 extern int page_swapcount(struct page *);
422 extern struct swap_info_struct *page_swap_info(struct page *);
423 extern int reuse_swap_page(struct page *);
424 extern int try_to_free_swap(struct page *);
425 struct backing_dev_info;
426
427 #ifdef CONFIG_MEMCG
428 extern void
429 mem_cgroup_uncharge_swapcache(struct page *page, swp_entry_t ent, bool swapout);
430 #else
431 static inline void
432 mem_cgroup_uncharge_swapcache(struct page *page, swp_entry_t ent, bool swapout)
433 {
434 }
435 #endif
436
437 #else /* CONFIG_SWAP */
438
439 #define get_nr_swap_pages()                     0L
440 #define total_swap_pages                        0L
441 #define total_swapcache_pages()                 0UL
442 #define vm_swap_full()                          0
443
444 #define si_swapinfo(val) \
445         do { (val)->freeswap = (val)->totalswap = 0; } while (0)
446 /* only sparc can not include linux/pagemap.h in this file
447  * so leave page_cache_release and release_pages undeclared... */
448 #define free_page_and_swap_cache(page) \
449         page_cache_release(page)
450 #define free_pages_and_swap_cache(pages, nr) \
451         release_pages((pages), (nr), 0);
452
453 static inline void show_swap_cache_info(void)
454 {
455 }
456
457 #define free_swap_and_cache(swp)        is_migration_entry(swp)
458 #define swapcache_prepare(swp)          is_migration_entry(swp)
459
460 static inline int add_swap_count_continuation(swp_entry_t swp, gfp_t gfp_mask)
461 {
462         return 0;
463 }
464
465 static inline void swap_shmem_alloc(swp_entry_t swp)
466 {
467 }
468
469 static inline int swap_duplicate(swp_entry_t swp)
470 {
471         return 0;
472 }
473
474 static inline void swap_free(swp_entry_t swp)
475 {
476 }
477
478 static inline void swapcache_free(swp_entry_t swp, struct page *page)
479 {
480 }
481
482 static inline struct page *swapin_readahead(swp_entry_t swp, gfp_t gfp_mask,
483                         struct vm_area_struct *vma, unsigned long addr)
484 {
485         return NULL;
486 }
487
488 static inline int swap_writepage(struct page *p, struct writeback_control *wbc)
489 {
490         return 0;
491 }
492
493 static inline struct page *lookup_swap_cache(swp_entry_t swp)
494 {
495         return NULL;
496 }
497
498 static inline int add_to_swap(struct page *page, struct list_head *list)
499 {
500         return 0;
501 }
502
503 static inline int add_to_swap_cache(struct page *page, swp_entry_t entry,
504                                                         gfp_t gfp_mask)
505 {
506         return -1;
507 }
508
509 static inline void __delete_from_swap_cache(struct page *page)
510 {
511 }
512
513 static inline void delete_from_swap_cache(struct page *page)
514 {
515 }
516
517 static inline int page_swapcount(struct page *page)
518 {
519         return 0;
520 }
521
522 #define reuse_swap_page(page)   (page_mapcount(page) == 1)
523
524 static inline int try_to_free_swap(struct page *page)
525 {
526         return 0;
527 }
528
529 static inline swp_entry_t get_swap_page(void)
530 {
531         swp_entry_t entry;
532         entry.val = 0;
533         return entry;
534 }
535
536 static inline void
537 mem_cgroup_uncharge_swapcache(struct page *page, swp_entry_t ent)
538 {
539 }
540
541 #endif /* CONFIG_SWAP */
542 #endif /* __KERNEL__*/
543 #endif /* _LINUX_SWAP_H */