]> rtime.felk.cvut.cz Git - zynq/linux.git/blob - include/linux/swap.h
Apply preempt_rt patch-4.9-rt1.patch.xz
[zynq/linux.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 <linux/locallock.h>
15 #include <asm/page.h>
16
17 struct notifier_block;
18
19 struct bio;
20
21 #define SWAP_FLAG_PREFER        0x8000  /* set if swap priority specified */
22 #define SWAP_FLAG_PRIO_MASK     0x7fff
23 #define SWAP_FLAG_PRIO_SHIFT    0
24 #define SWAP_FLAG_DISCARD       0x10000 /* enable discard for swap */
25 #define SWAP_FLAG_DISCARD_ONCE  0x20000 /* discard swap area at swapon-time */
26 #define SWAP_FLAG_DISCARD_PAGES 0x40000 /* discard page-clusters after use */
27
28 #define SWAP_FLAGS_VALID        (SWAP_FLAG_PRIO_MASK | SWAP_FLAG_PREFER | \
29                                  SWAP_FLAG_DISCARD | SWAP_FLAG_DISCARD_ONCE | \
30                                  SWAP_FLAG_DISCARD_PAGES)
31
32 static inline int current_is_kswapd(void)
33 {
34         return current->flags & PF_KSWAPD;
35 }
36
37 /*
38  * MAX_SWAPFILES defines the maximum number of swaptypes: things which can
39  * be swapped to.  The swap type and the offset into that swap type are
40  * encoded into pte's and into pgoff_t's in the swapcache.  Using five bits
41  * for the type means that the maximum number of swapcache pages is 27 bits
42  * on 32-bit-pgoff_t architectures.  And that assumes that the architecture packs
43  * the type/offset into the pte as 5/27 as well.
44  */
45 #define MAX_SWAPFILES_SHIFT     5
46
47 /*
48  * Use some of the swap files numbers for other purposes. This
49  * is a convenient way to hook into the VM to trigger special
50  * actions on faults.
51  */
52
53 /*
54  * NUMA node memory migration support
55  */
56 #ifdef CONFIG_MIGRATION
57 #define SWP_MIGRATION_NUM 2
58 #define SWP_MIGRATION_READ      (MAX_SWAPFILES + SWP_HWPOISON_NUM)
59 #define SWP_MIGRATION_WRITE     (MAX_SWAPFILES + SWP_HWPOISON_NUM + 1)
60 #else
61 #define SWP_MIGRATION_NUM 0
62 #endif
63
64 /*
65  * Handling of hardware poisoned pages with memory corruption.
66  */
67 #ifdef CONFIG_MEMORY_FAILURE
68 #define SWP_HWPOISON_NUM 1
69 #define SWP_HWPOISON            MAX_SWAPFILES
70 #else
71 #define SWP_HWPOISON_NUM 0
72 #endif
73
74 #define MAX_SWAPFILES \
75         ((1 << MAX_SWAPFILES_SHIFT) - SWP_MIGRATION_NUM - SWP_HWPOISON_NUM)
76
77 /*
78  * Magic header for a swap area. The first part of the union is
79  * what the swap magic looks like for the old (limited to 128MB)
80  * swap area format, the second part of the union adds - in the
81  * old reserved area - some extra information. Note that the first
82  * kilobyte is reserved for boot loader or disk label stuff...
83  *
84  * Having the magic at the end of the PAGE_SIZE makes detecting swap
85  * areas somewhat tricky on machines that support multiple page sizes.
86  * For 2.5 we'll probably want to move the magic to just beyond the
87  * bootbits...
88  */
89 union swap_header {
90         struct {
91                 char reserved[PAGE_SIZE - 10];
92                 char magic[10];                 /* SWAP-SPACE or SWAPSPACE2 */
93         } magic;
94         struct {
95                 char            bootbits[1024]; /* Space for disklabel etc. */
96                 __u32           version;
97                 __u32           last_page;
98                 __u32           nr_badpages;
99                 unsigned char   sws_uuid[16];
100                 unsigned char   sws_volume[16];
101                 __u32           padding[117];
102                 __u32           badpages[1];
103         } info;
104 };
105
106 /*
107  * current->reclaim_state points to one of these when a task is running
108  * memory reclaim
109  */
110 struct reclaim_state {
111         unsigned long reclaimed_slab;
112 };
113
114 #ifdef __KERNEL__
115
116 struct address_space;
117 struct sysinfo;
118 struct writeback_control;
119 struct 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  */
129 struct 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
143 enum {
144         SWP_USED        = (1 << 0),     /* is slot in swap_info[] used? */
145         SWP_WRITEOK     = (1 << 1),     /* ok to write to this swap?    */
146         SWP_DISCARDABLE = (1 << 2),     /* blkdev support discard */
147         SWP_DISCARDING  = (1 << 3),     /* now discarding a free cluster */
148         SWP_SOLIDSTATE  = (1 << 4),     /* blkdev seeks are cheap */
149         SWP_CONTINUED   = (1 << 5),     /* swap_map has count continuation */
150         SWP_BLKDEV      = (1 << 6),     /* its a block device */
151         SWP_FILE        = (1 << 7),     /* set after swap_activate success */
152         SWP_AREA_DISCARD = (1 << 8),    /* single-time swap area discards */
153         SWP_PAGE_DISCARD = (1 << 9),    /* freed swap page-cluster discards */
154                                         /* add others here before... */
155         SWP_SCANNING    = (1 << 10),    /* refcount in scan_swap_map */
156 };
157
158 #define SWAP_CLUSTER_MAX 32UL
159 #define COMPACT_CLUSTER_MAX SWAP_CLUSTER_MAX
160
161 #define SWAP_MAP_MAX    0x3e    /* Max duplication count, in first swap_map */
162 #define SWAP_MAP_BAD    0x3f    /* Note pageblock is bad, in first swap_map */
163 #define SWAP_HAS_CACHE  0x40    /* Flag page is cached, in first swap_map */
164 #define SWAP_CONT_MAX   0x7f    /* Max count, in each swap_map continuation */
165 #define COUNT_CONTINUED 0x80    /* See swap_map continuation for full count */
166 #define SWAP_MAP_SHMEM  0xbf    /* Owned by shmem/tmpfs, in first swap_map */
167
168 /*
169  * We use this to track usage of a cluster. A cluster is a block of swap disk
170  * space with SWAPFILE_CLUSTER pages long and naturally aligns in disk. All
171  * free clusters are organized into a list. We fetch an entry from the list to
172  * get a free cluster.
173  *
174  * The data field stores next cluster if the cluster is free or cluster usage
175  * counter otherwise. The flags field determines if a cluster is free. This is
176  * protected by swap_info_struct.lock.
177  */
178 struct swap_cluster_info {
179         unsigned int data:24;
180         unsigned int flags:8;
181 };
182 #define CLUSTER_FLAG_FREE 1 /* This cluster is free */
183 #define CLUSTER_FLAG_NEXT_NULL 2 /* This cluster has no next cluster */
184
185 /*
186  * We assign a cluster to each CPU, so each CPU can allocate swap entry from
187  * its own cluster and swapout sequentially. The purpose is to optimize swapout
188  * throughput.
189  */
190 struct percpu_cluster {
191         struct swap_cluster_info index; /* Current cluster index */
192         unsigned int next; /* Likely next allocation offset */
193 };
194
195 struct swap_cluster_list {
196         struct swap_cluster_info head;
197         struct swap_cluster_info tail;
198 };
199
200 /*
201  * The in-memory structure used to track swap areas.
202  */
203 struct swap_info_struct {
204         unsigned long   flags;          /* SWP_USED etc: see above */
205         signed short    prio;           /* swap priority of this type */
206         struct plist_node list;         /* entry in swap_active_head */
207         struct plist_node avail_list;   /* entry in swap_avail_head */
208         signed char     type;           /* strange name for an index */
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_list free_clusters; /* free clusters list */
213         unsigned int lowest_bit;        /* index of first free in swap_map */
214         unsigned int highest_bit;       /* index of last free in swap_map */
215         unsigned int pages;             /* total of usable pages of swap */
216         unsigned int inuse_pages;       /* number of those currently in use */
217         unsigned int cluster_next;      /* likely index for next allocation */
218         unsigned int cluster_nr;        /* countdown to next cluster search */
219         struct percpu_cluster __percpu *percpu_cluster; /* per cpu's swap location */
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_list discard_clusters; /* discard clusters list */
244 };
245
246 /* linux/mm/workingset.c */
247 void *workingset_eviction(struct address_space *mapping, struct page *page);
248 bool workingset_refault(void *shadow);
249 void workingset_activation(struct page *page);
250 extern struct list_lru __workingset_shadow_nodes;
251 DECLARE_LOCAL_IRQ_LOCK(workingset_shadow_lock);
252
253 static inline unsigned int workingset_node_pages(struct radix_tree_node *node)
254 {
255         return node->count & RADIX_TREE_COUNT_MASK;
256 }
257
258 static inline void workingset_node_pages_inc(struct radix_tree_node *node)
259 {
260         node->count++;
261 }
262
263 static inline void workingset_node_pages_dec(struct radix_tree_node *node)
264 {
265         VM_WARN_ON_ONCE(!workingset_node_pages(node));
266         node->count--;
267 }
268
269 static inline unsigned int workingset_node_shadows(struct radix_tree_node *node)
270 {
271         return node->count >> RADIX_TREE_COUNT_SHIFT;
272 }
273
274 static inline void workingset_node_shadows_inc(struct radix_tree_node *node)
275 {
276         node->count += 1U << RADIX_TREE_COUNT_SHIFT;
277 }
278
279 static inline void workingset_node_shadows_dec(struct radix_tree_node *node)
280 {
281         VM_WARN_ON_ONCE(!workingset_node_shadows(node));
282         node->count -= 1U << RADIX_TREE_COUNT_SHIFT;
283 }
284
285 /* linux/mm/page_alloc.c */
286 extern unsigned long totalram_pages;
287 extern unsigned long totalreserve_pages;
288 extern unsigned long nr_free_buffer_pages(void);
289 extern unsigned long nr_free_pagecache_pages(void);
290
291 /* Definition of global_page_state not available yet */
292 #define nr_free_pages() global_page_state(NR_FREE_PAGES)
293
294
295 /* linux/mm/swap.c */
296 DECLARE_LOCAL_IRQ_LOCK(swapvec_lock);
297 extern void lru_cache_add(struct page *);
298 extern void lru_cache_add_anon(struct page *page);
299 extern void lru_cache_add_file(struct page *page);
300 extern void lru_add_page_tail(struct page *page, struct page *page_tail,
301                          struct lruvec *lruvec, struct list_head *head);
302 extern void activate_page(struct page *);
303 extern void mark_page_accessed(struct page *);
304 extern void lru_add_drain(void);
305 extern void lru_add_drain_cpu(int cpu);
306 extern void lru_add_drain_all(void);
307 extern void rotate_reclaimable_page(struct page *page);
308 extern void deactivate_file_page(struct page *page);
309 extern void deactivate_page(struct page *page);
310 extern void swap_setup(void);
311
312 extern void add_page_to_unevictable_list(struct page *page);
313
314 extern void lru_cache_add_active_or_unevictable(struct page *page,
315                                                 struct vm_area_struct *vma);
316
317 /* linux/mm/vmscan.c */
318 extern unsigned long zone_reclaimable_pages(struct zone *zone);
319 extern unsigned long pgdat_reclaimable_pages(struct pglist_data *pgdat);
320 extern unsigned long try_to_free_pages(struct zonelist *zonelist, int order,
321                                         gfp_t gfp_mask, nodemask_t *mask);
322 extern int __isolate_lru_page(struct page *page, isolate_mode_t mode);
323 extern unsigned long try_to_free_mem_cgroup_pages(struct mem_cgroup *memcg,
324                                                   unsigned long nr_pages,
325                                                   gfp_t gfp_mask,
326                                                   bool may_swap);
327 extern unsigned long mem_cgroup_shrink_node(struct mem_cgroup *mem,
328                                                 gfp_t gfp_mask, bool noswap,
329                                                 pg_data_t *pgdat,
330                                                 unsigned long *nr_scanned);
331 extern unsigned long shrink_all_memory(unsigned long nr_pages);
332 extern int vm_swappiness;
333 extern int remove_mapping(struct address_space *mapping, struct page *page);
334 extern unsigned long vm_total_pages;
335
336 #ifdef CONFIG_NUMA
337 extern int node_reclaim_mode;
338 extern int sysctl_min_unmapped_ratio;
339 extern int sysctl_min_slab_ratio;
340 extern int node_reclaim(struct pglist_data *, gfp_t, unsigned int);
341 #else
342 #define node_reclaim_mode 0
343 static inline int node_reclaim(struct pglist_data *pgdat, gfp_t mask,
344                                 unsigned int order)
345 {
346         return 0;
347 }
348 #endif
349
350 extern int page_evictable(struct page *page);
351 extern void check_move_unevictable_pages(struct page **, int nr_pages);
352
353 extern int kswapd_run(int nid);
354 extern void kswapd_stop(int nid);
355
356 #ifdef CONFIG_SWAP
357 /* linux/mm/page_io.c */
358 extern int swap_readpage(struct page *);
359 extern int swap_writepage(struct page *page, struct writeback_control *wbc);
360 extern void end_swap_bio_write(struct bio *bio);
361 extern int __swap_writepage(struct page *page, struct writeback_control *wbc,
362         bio_end_io_t end_write_func);
363 extern int swap_set_page_dirty(struct page *page);
364
365 int add_swap_extent(struct swap_info_struct *sis, unsigned long start_page,
366                 unsigned long nr_pages, sector_t start_block);
367 int generic_swapfile_activate(struct swap_info_struct *, struct file *,
368                 sector_t *);
369
370 /* linux/mm/swap_state.c */
371 extern struct address_space swapper_spaces[];
372 #define swap_address_space(entry) (&swapper_spaces[swp_type(entry)])
373 extern unsigned long total_swapcache_pages(void);
374 extern void show_swap_cache_info(void);
375 extern int add_to_swap(struct page *, struct list_head *list);
376 extern int add_to_swap_cache(struct page *, swp_entry_t, gfp_t);
377 extern int __add_to_swap_cache(struct page *page, swp_entry_t entry);
378 extern void __delete_from_swap_cache(struct page *);
379 extern void delete_from_swap_cache(struct page *);
380 extern void free_page_and_swap_cache(struct page *);
381 extern void free_pages_and_swap_cache(struct page **, int);
382 extern struct page *lookup_swap_cache(swp_entry_t);
383 extern struct page *read_swap_cache_async(swp_entry_t, gfp_t,
384                         struct vm_area_struct *vma, unsigned long addr);
385 extern struct page *__read_swap_cache_async(swp_entry_t, gfp_t,
386                         struct vm_area_struct *vma, unsigned long addr,
387                         bool *new_page_allocated);
388 extern struct page *swapin_readahead(swp_entry_t, gfp_t,
389                         struct vm_area_struct *vma, unsigned long addr);
390
391 /* linux/mm/swapfile.c */
392 extern atomic_long_t nr_swap_pages;
393 extern long total_swap_pages;
394
395 /* Swap 50% full? Release swapcache more aggressively.. */
396 static inline bool vm_swap_full(void)
397 {
398         return atomic_long_read(&nr_swap_pages) * 2 < total_swap_pages;
399 }
400
401 static inline long get_nr_swap_pages(void)
402 {
403         return atomic_long_read(&nr_swap_pages);
404 }
405
406 extern void si_swapinfo(struct sysinfo *);
407 extern swp_entry_t get_swap_page(void);
408 extern swp_entry_t get_swap_page_of_type(int);
409 extern int add_swap_count_continuation(swp_entry_t, gfp_t);
410 extern void swap_shmem_alloc(swp_entry_t);
411 extern int swap_duplicate(swp_entry_t);
412 extern int swapcache_prepare(swp_entry_t);
413 extern void swap_free(swp_entry_t);
414 extern void swapcache_free(swp_entry_t);
415 extern int free_swap_and_cache(swp_entry_t);
416 extern int swap_type_of(dev_t, sector_t, struct block_device **);
417 extern unsigned int count_swap_pages(int, int);
418 extern sector_t map_swap_page(struct page *, struct block_device **);
419 extern sector_t swapdev_block(int, pgoff_t);
420 extern int page_swapcount(struct page *);
421 extern int swp_swapcount(swp_entry_t entry);
422 extern struct swap_info_struct *page_swap_info(struct page *);
423 extern bool reuse_swap_page(struct page *, int *);
424 extern int try_to_free_swap(struct page *);
425 struct backing_dev_info;
426
427 #else /* CONFIG_SWAP */
428
429 #define swap_address_space(entry)               (NULL)
430 #define get_nr_swap_pages()                     0L
431 #define total_swap_pages                        0L
432 #define total_swapcache_pages()                 0UL
433 #define vm_swap_full()                          0
434
435 #define si_swapinfo(val) \
436         do { (val)->freeswap = (val)->totalswap = 0; } while (0)
437 /* only sparc can not include linux/pagemap.h in this file
438  * so leave put_page and release_pages undeclared... */
439 #define free_page_and_swap_cache(page) \
440         put_page(page)
441 #define free_pages_and_swap_cache(pages, nr) \
442         release_pages((pages), (nr), false);
443
444 static inline void show_swap_cache_info(void)
445 {
446 }
447
448 #define free_swap_and_cache(swp)        is_migration_entry(swp)
449 #define swapcache_prepare(swp)          is_migration_entry(swp)
450
451 static inline int add_swap_count_continuation(swp_entry_t swp, gfp_t gfp_mask)
452 {
453         return 0;
454 }
455
456 static inline void swap_shmem_alloc(swp_entry_t swp)
457 {
458 }
459
460 static inline int swap_duplicate(swp_entry_t swp)
461 {
462         return 0;
463 }
464
465 static inline void swap_free(swp_entry_t swp)
466 {
467 }
468
469 static inline void swapcache_free(swp_entry_t swp)
470 {
471 }
472
473 static inline struct page *swapin_readahead(swp_entry_t swp, gfp_t gfp_mask,
474                         struct vm_area_struct *vma, unsigned long addr)
475 {
476         return NULL;
477 }
478
479 static inline int swap_writepage(struct page *p, struct writeback_control *wbc)
480 {
481         return 0;
482 }
483
484 static inline struct page *lookup_swap_cache(swp_entry_t swp)
485 {
486         return NULL;
487 }
488
489 static inline int add_to_swap(struct page *page, struct list_head *list)
490 {
491         return 0;
492 }
493
494 static inline int add_to_swap_cache(struct page *page, swp_entry_t entry,
495                                                         gfp_t gfp_mask)
496 {
497         return -1;
498 }
499
500 static inline void __delete_from_swap_cache(struct page *page)
501 {
502 }
503
504 static inline void delete_from_swap_cache(struct page *page)
505 {
506 }
507
508 static inline int page_swapcount(struct page *page)
509 {
510         return 0;
511 }
512
513 static inline int swp_swapcount(swp_entry_t entry)
514 {
515         return 0;
516 }
517
518 #define reuse_swap_page(page, total_mapcount) \
519         (page_trans_huge_mapcount(page, total_mapcount) == 1)
520
521 static inline int try_to_free_swap(struct page *page)
522 {
523         return 0;
524 }
525
526 static inline swp_entry_t get_swap_page(void)
527 {
528         swp_entry_t entry;
529         entry.val = 0;
530         return entry;
531 }
532
533 #endif /* CONFIG_SWAP */
534
535 #ifdef CONFIG_MEMCG
536 static inline int mem_cgroup_swappiness(struct mem_cgroup *memcg)
537 {
538         /* Cgroup2 doesn't have per-cgroup swappiness */
539         if (cgroup_subsys_on_dfl(memory_cgrp_subsys))
540                 return vm_swappiness;
541
542         /* root ? */
543         if (mem_cgroup_disabled() || !memcg->css.parent)
544                 return vm_swappiness;
545
546         return memcg->swappiness;
547 }
548
549 #else
550 static inline int mem_cgroup_swappiness(struct mem_cgroup *mem)
551 {
552         return vm_swappiness;
553 }
554 #endif
555
556 #ifdef CONFIG_MEMCG_SWAP
557 extern void mem_cgroup_swapout(struct page *page, swp_entry_t entry);
558 extern int mem_cgroup_try_charge_swap(struct page *page, swp_entry_t entry);
559 extern void mem_cgroup_uncharge_swap(swp_entry_t entry);
560 extern long mem_cgroup_get_nr_swap_pages(struct mem_cgroup *memcg);
561 extern bool mem_cgroup_swap_full(struct page *page);
562 #else
563 static inline void mem_cgroup_swapout(struct page *page, swp_entry_t entry)
564 {
565 }
566
567 static inline int mem_cgroup_try_charge_swap(struct page *page,
568                                              swp_entry_t entry)
569 {
570         return 0;
571 }
572
573 static inline void mem_cgroup_uncharge_swap(swp_entry_t entry)
574 {
575 }
576
577 static inline long mem_cgroup_get_nr_swap_pages(struct mem_cgroup *memcg)
578 {
579         return get_nr_swap_pages();
580 }
581
582 static inline bool mem_cgroup_swap_full(struct page *page)
583 {
584         return vm_swap_full();
585 }
586 #endif
587
588 #endif /* __KERNEL__*/
589 #endif /* _LINUX_SWAP_H */