kernel/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 /*
 162  * Ratio between zone->managed_pages and the "gap" that above the per-zone
 163  * "high_wmark". While balancing nodes, We allow kswapd to shrink zones that
 164  * do not meet the (high_wmark + gap) watermark, even which already met the
 165  * high_wmark, in order to provide better per-zone lru behavior. We are ok to
 166  * spend not more than 1% of the memory for this zone balancing "gap".
 167  */
 168 #define KSWAPD_ZONE_BALANCE_GAP_RATIO 100
 169
 170 #define SWAP_MAP_MAX    0x3e    /* Max duplication count, in first swap_map */
 171 #define SWAP_MAP_BAD    0x3f    /* Note pageblock is bad, in first swap_map */
 172 #define SWAP_HAS_CACHE  0x40    /* Flag page is cached, in first swap_map */
 173 #define SWAP_CONT_MAX   0x7f    /* Max count, in each swap_map continuation */
 174 #define COUNT_CONTINUED 0x80    /* See swap_map continuation for full count */
 175 #define SWAP_MAP_SHMEM  0xbf    /* Owned by shmem/tmpfs, in first swap_map */
 176
 177 /*
 178  * We use this to track usage of a cluster. A cluster is a block of swap disk
 179  * space with SWAPFILE_CLUSTER pages long and naturally aligns in disk. All
 180  * free clusters are organized into a list. We fetch an entry from the list to
 181  * get a free cluster.
 182  *
 183  * The data field stores next cluster if the cluster is free or cluster usage
 184  * counter otherwise. The flags field determines if a cluster is free. This is
 185  * protected by swap_info_struct.lock.
 186  */
 187 struct swap_cluster_info {
 188         unsigned int data:24;
 189         unsigned int flags:8;
 190 };
 191 #define CLUSTER_FLAG_FREE 1 /* This cluster is free */
 192 #define CLUSTER_FLAG_NEXT_NULL 2 /* This cluster has no next cluster */
 193
 194 /*
 195  * We assign a cluster to each CPU, so each CPU can allocate swap entry from
 196  * its own cluster and swapout sequentially. The purpose is to optimize swapout
 197  * throughput.
 198  */
 199 struct percpu_cluster {
 200         struct swap_cluster_info index; /* Current cluster index */
 201         unsigned int next; /* Likely next allocation offset */
 202 };
 203
 204 /*
 205  * The in-memory structure used to track swap areas.
 206  */
 207 struct swap_info_struct {
 208         unsigned long   flags;          /* SWP_USED etc: see above */
 209         signed short    prio;           /* swap priority of this type */
 210         struct plist_node list;         /* entry in swap_active_head */
 211         struct plist_node avail_list;   /* entry in swap_avail_head */
 212         signed char     type;           /* strange name for an index */
 213         unsigned int    max;            /* extent of the swap_map */
 214         unsigned char *swap_map;        /* vmalloc'ed array of usage counts */
 215         struct swap_cluster_info *cluster_info; /* cluster info. Only for SSD */
 216         struct swap_cluster_info free_cluster_head; /* free cluster list head */
 217         struct swap_cluster_info free_cluster_tail; /* free cluster list tail */
 218         unsigned int lowest_bit;        /* index of first free in swap_map */
 219         unsigned int highest_bit;       /* index of last free in swap_map */
 220         unsigned int pages;             /* total of usable pages of swap */
 221         unsigned int inuse_pages;       /* number of those currently in use */
 222         unsigned int cluster_next;      /* likely index for next allocation */
 223         unsigned int cluster_nr;        /* countdown to next cluster search */
 224         struct percpu_cluster __percpu *percpu_cluster; /* per cpu's swap location */
 225         struct swap_extent *curr_swap_extent;
 226         struct swap_extent first_swap_extent;
 227         struct block_device *bdev;      /* swap device or bdev of swap file */
 228         struct file *swap_file;         /* seldom referenced */
 229         unsigned int old_block_size;    /* seldom referenced */
 230 #ifdef CONFIG_FRONTSWAP
 231         unsigned long *frontswap_map;   /* frontswap in-use, one bit per page */
 232         atomic_t frontswap_pages;       /* frontswap pages in-use counter */
 233 #endif
 234         spinlock_t lock;                /*
 235                                          * protect map scan related fields like
 236                                          * swap_map, lowest_bit, highest_bit,
 237                                          * inuse_pages, cluster_next,
 238                                          * cluster_nr, lowest_alloc,
 239                                          * highest_alloc, free/discard cluster
 240                                          * list. other fields are only changed
 241                                          * at swapon/swapoff, so are protected
 242                                          * by swap_lock. changing flags need
 243                                          * hold this lock and swap_lock. If
 244                                          * both locks need hold, hold swap_lock
 245                                          * first.
 246                                          */
 247         struct work_struct discard_work; /* discard worker */
 248         struct swap_cluster_info discard_cluster_head; /* list head of discard clusters */
 249         struct swap_cluster_info discard_cluster_tail; /* list tail of discard clusters */
 250 };
 251
 252 /* linux/mm/workingset.c */
 253 void *workingset_eviction(struct address_space *mapping, struct page *page);
 254 bool workingset_refault(void *shadow);
 255 void workingset_activation(struct page *page);
 256 extern struct list_lru __workingset_shadow_nodes;
 257 DECLARE_LOCAL_IRQ_LOCK(workingset_shadow_lock);
 258
 259 static inline unsigned int workingset_node_pages(struct radix_tree_node *node)
 260 {
 261         return node->count & RADIX_TREE_COUNT_MASK;
 262 }
 263
 264 static inline void workingset_node_pages_inc(struct radix_tree_node *node)
 265 {
 266         node->count++;
 267 }
 268
 269 static inline void workingset_node_pages_dec(struct radix_tree_node *node)
 270 {
 271         node->count--;
 272 }
 273
 274 static inline unsigned int workingset_node_shadows(struct radix_tree_node *node)
 275 {
 276         return node->count >> RADIX_TREE_COUNT_SHIFT;
 277 }
 278
 279 static inline void workingset_node_shadows_inc(struct radix_tree_node *node)
 280 {
 281         node->count += 1U << RADIX_TREE_COUNT_SHIFT;
 282 }
 283
 284 static inline void workingset_node_shadows_dec(struct radix_tree_node *node)
 285 {
 286         node->count -= 1U << RADIX_TREE_COUNT_SHIFT;
 287 }
 288
 289 /* linux/mm/page_alloc.c */
 290 extern unsigned long totalram_pages;
 291 extern unsigned long totalreserve_pages;
 292 extern unsigned long dirty_balance_reserve;
 293 extern unsigned long nr_free_buffer_pages(void);
 294 extern unsigned long nr_free_pagecache_pages(void);
 295
 296 /* Definition of global_page_state not available yet */
 297 #define nr_free_pages() global_page_state(NR_FREE_PAGES)
 298
 299
 300 /* linux/mm/swap.c */
 301 DECLARE_LOCAL_IRQ_LOCK(swapvec_lock);
 302 extern void lru_cache_add(struct page *);
 303 extern void lru_cache_add_anon(struct page *page);
 304 extern void lru_cache_add_file(struct page *page);
 305 extern void lru_add_page_tail(struct page *page, struct page *page_tail,
 306                          struct lruvec *lruvec, struct list_head *head);
 307 extern void activate_page(struct page *);
 308 extern void mark_page_accessed(struct page *);
 309 extern void lru_add_drain(void);
 310 extern void lru_add_drain_cpu(int cpu);
 311 extern void lru_add_drain_all(void);
 312 extern void rotate_reclaimable_page(struct page *page);
 313 extern void deactivate_file_page(struct page *page);
 314 extern void swap_setup(void);
 315
 316 extern void add_page_to_unevictable_list(struct page *page);
 317
 318 extern void lru_cache_add_active_or_unevictable(struct page *page,
 319                                                 struct vm_area_struct *vma);
 320
 321 /* linux/mm/vmscan.c */
 322 extern unsigned long try_to_free_pages(struct zonelist *zonelist, int order,
 323                                         gfp_t gfp_mask, nodemask_t *mask);
 324 extern int __isolate_lru_page(struct page *page, isolate_mode_t mode);
 325 extern unsigned long try_to_free_mem_cgroup_pages(struct mem_cgroup *memcg,
 326                                                   unsigned long nr_pages,
 327                                                   gfp_t gfp_mask,
 328                                                   bool may_swap);
 329 extern unsigned long mem_cgroup_shrink_node_zone(struct mem_cgroup *mem,
 330                                                 gfp_t gfp_mask, bool noswap,
 331                                                 struct zone *zone,
 332                                                 unsigned long *nr_scanned);
 333 extern unsigned long shrink_all_memory(unsigned long nr_pages);
 334 extern int vm_swappiness;
 335 extern int remove_mapping(struct address_space *mapping, struct page *page);
 336 extern unsigned long vm_total_pages;
 337
 338 #ifdef CONFIG_NUMA
 339 extern int zone_reclaim_mode;
 340 extern int sysctl_min_unmapped_ratio;
 341 extern int sysctl_min_slab_ratio;
 342 extern int zone_reclaim(struct zone *, gfp_t, unsigned int);
 343 #else
 344 #define zone_reclaim_mode 0
 345 static inline int zone_reclaim(struct zone *z, gfp_t mask, unsigned int order)
 346 {
 347         return 0;
 348 }
 349 #endif
 350
 351 extern int page_evictable(struct page *page);
 352 extern void check_move_unevictable_pages(struct page **, int nr_pages);
 353
 354 extern int kswapd_run(int nid);
 355 extern void kswapd_stop(int nid);
 356 #ifdef CONFIG_MEMCG
 357 extern int mem_cgroup_swappiness(struct mem_cgroup *mem);
 358 #else
 359 static inline int mem_cgroup_swappiness(struct mem_cgroup *mem)
 360 {
 361         return vm_swappiness;
 362 }
 363 #endif
 364 #ifdef CONFIG_MEMCG_SWAP
 365 extern void mem_cgroup_swapout(struct page *page, swp_entry_t entry);
 366 extern void mem_cgroup_uncharge_swap(swp_entry_t entry);
 367 #else
 368 static inline void mem_cgroup_swapout(struct page *page, swp_entry_t entry)
 369 {
 370 }
 371 static inline void mem_cgroup_uncharge_swap(swp_entry_t entry)
 372 {
 373 }
 374 #endif
 375 #ifdef CONFIG_SWAP
 376 /* linux/mm/page_io.c */
 377 extern int swap_readpage(struct page *);
 378 extern int swap_writepage(struct page *page, struct writeback_control *wbc);
 379 extern void end_swap_bio_write(struct bio *bio, int err);
 380 extern int __swap_writepage(struct page *page, struct writeback_control *wbc,
 381         void (*end_write_func)(struct bio *, int));
 382 extern int swap_set_page_dirty(struct page *page);
 383 extern void end_swap_bio_read(struct bio *bio, int err);
 384
 385 int add_swap_extent(struct swap_info_struct *sis, unsigned long start_page,
 386                 unsigned long nr_pages, sector_t start_block);
 387 int generic_swapfile_activate(struct swap_info_struct *, struct file *,
 388                 sector_t *);
 389
 390 /* linux/mm/swap_state.c */
 391 extern struct address_space swapper_spaces[];
 392 #define swap_address_space(entry) (&swapper_spaces[swp_type(entry)])
 393 extern unsigned long total_swapcache_pages(void);
 394 extern void show_swap_cache_info(void);
 395 extern int add_to_swap(struct page *, struct list_head *list);
 396 extern int add_to_swap_cache(struct page *, swp_entry_t, gfp_t);
 397 extern int __add_to_swap_cache(struct page *page, swp_entry_t entry);
 398 extern void __delete_from_swap_cache(struct page *);
 399 extern void delete_from_swap_cache(struct page *);
 400 extern void free_page_and_swap_cache(struct page *);
 401 extern void free_pages_and_swap_cache(struct page **, int);
 402 extern struct page *lookup_swap_cache(swp_entry_t);
 403 extern struct page *read_swap_cache_async(swp_entry_t, gfp_t,
 404                         struct vm_area_struct *vma, unsigned long addr);
 405 extern struct page *swapin_readahead(swp_entry_t, gfp_t,
 406                         struct vm_area_struct *vma, unsigned long addr);
 407
 408 /* linux/mm/swapfile.c */
 409 extern atomic_long_t nr_swap_pages;
 410 extern long total_swap_pages;
 411
 412 /* Swap 50% full? Release swapcache more aggressively.. */
 413 static inline bool vm_swap_full(void)
 414 {
 415         return atomic_long_read(&nr_swap_pages) * 2 < total_swap_pages;
 416 }
 417
 418 static inline long get_nr_swap_pages(void)
 419 {
 420         return atomic_long_read(&nr_swap_pages);
 421 }
 422
 423 extern void si_swapinfo(struct sysinfo *);
 424 extern swp_entry_t get_swap_page(void);
 425 extern swp_entry_t get_swap_page_of_type(int);
 426 extern int add_swap_count_continuation(swp_entry_t, gfp_t);
 427 extern void swap_shmem_alloc(swp_entry_t);
 428 extern int swap_duplicate(swp_entry_t);
 429 extern int swapcache_prepare(swp_entry_t);
 430 extern void swap_free(swp_entry_t);
 431 extern void swapcache_free(swp_entry_t);
 432 extern int free_swap_and_cache(swp_entry_t);
 433 extern int swap_type_of(dev_t, sector_t, struct block_device **);
 434 extern unsigned int count_swap_pages(int, int);
 435 extern sector_t map_swap_page(struct page *, struct block_device **);
 436 extern sector_t swapdev_block(int, pgoff_t);
 437 extern int page_swapcount(struct page *);
 438 extern struct swap_info_struct *page_swap_info(struct page *);
 439 extern int reuse_swap_page(struct page *);
 440 extern int try_to_free_swap(struct page *);
 441 struct backing_dev_info;
 442
 443 #else /* CONFIG_SWAP */
 444
 445 #define swap_address_space(entry)               (NULL)
 446 #define get_nr_swap_pages()                     0L
 447 #define total_swap_pages                        0L
 448 #define total_swapcache_pages()                 0UL
 449 #define vm_swap_full()                          0
 450
 451 #define si_swapinfo(val) \
 452         do { (val)->freeswap = (val)->totalswap = 0; } while (0)
 453 /* only sparc can not include linux/pagemap.h in this file
 454  * so leave page_cache_release and release_pages undeclared... */
 455 #define free_page_and_swap_cache(page) \
 456         page_cache_release(page)
 457 #define free_pages_and_swap_cache(pages, nr) \
 458         release_pages((pages), (nr), false);
 459
 460 static inline void show_swap_cache_info(void)
 461 {
 462 }
 463
 464 #define free_swap_and_cache(swp)        is_migration_entry(swp)
 465 #define swapcache_prepare(swp)          is_migration_entry(swp)
 466
 467 static inline int add_swap_count_continuation(swp_entry_t swp, gfp_t gfp_mask)
 468 {
 469         return 0;
 470 }
 471
 472 static inline void swap_shmem_alloc(swp_entry_t swp)
 473 {
 474 }
 475
 476 static inline int swap_duplicate(swp_entry_t swp)
 477 {
 478         return 0;
 479 }
 480
 481 static inline void swap_free(swp_entry_t swp)
 482 {
 483 }
 484
 485 static inline void swapcache_free(swp_entry_t swp)
 486 {
 487 }
 488
 489 static inline struct page *swapin_readahead(swp_entry_t swp, gfp_t gfp_mask,
 490                         struct vm_area_struct *vma, unsigned long addr)
 491 {
 492         return NULL;
 493 }
 494
 495 static inline int swap_writepage(struct page *p, struct writeback_control *wbc)
 496 {
 497         return 0;
 498 }
 499
 500 static inline struct page *lookup_swap_cache(swp_entry_t swp)
 501 {
 502         return NULL;
 503 }
 504
 505 static inline int add_to_swap(struct page *page, struct list_head *list)
 506 {
 507         return 0;
 508 }
 509
 510 static inline int add_to_swap_cache(struct page *page, swp_entry_t entry,
 511                                                         gfp_t gfp_mask)
 512 {
 513         return -1;
 514 }
 515
 516 static inline void __delete_from_swap_cache(struct page *page)
 517 {
 518 }
 519
 520 static inline void delete_from_swap_cache(struct page *page)
 521 {
 522 }
 523
 524 static inline int page_swapcount(struct page *page)
 525 {
 526         return 0;
 527 }
 528
 529 #define reuse_swap_page(page)   (page_mapcount(page) == 1)
 530
 531 static inline int try_to_free_swap(struct page *page)
 532 {
 533         return 0;
 534 }
 535
 536 static inline swp_entry_t get_swap_page(void)
 537 {
 538         swp_entry_t entry;
 539         entry.val = 0;
 540         return entry;
 541 }
 542
 543 #endif /* CONFIG_SWAP */
 544 #endif /* __KERNEL__*/
 545 #endif /* _LINUX_SWAP_H */