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
  12 #include <asm/atomic.h>
  13 #include <asm/page.h>
  14
  15 struct notifier_block;
  16
  17 struct bio;
  18
  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 #define SWAP_FLAG_DISCARD       0x10000 /* discard swap cluster after use */
  23
  24 static 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
  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)
  52 #else
  53 #define SWP_MIGRATION_NUM 0
  54 #endif
  55
  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
  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  */
  81 union swap_header {
  82         struct {
  83                 char reserved[PAGE_SIZE - 10];
  84                 char magic[10];                 /* SWAP-SPACE or SWAPSPACE2 */
  85         } magic;
  86         struct {
  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];
  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   */
 102 typedef 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  */
 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),     /* swapon+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                                         /* add others here before... */
 152         SWP_SCANNING    = (1 << 8),     /* refcount in scan_swap_map */
 153 };
 154
 155 #define SWAP_CLUSTER_MAX 32
 156 #define COMPACT_CLUSTER_MAX SWAP_CLUSTER_MAX
 157
 158 #define SWAP_MAP_MAX    0x3e    /* Max duplication count, in first swap_map */
 159 #define SWAP_MAP_BAD    0x3f    /* Note pageblock is bad, in first swap_map */
 160 #define SWAP_HAS_CACHE  0x40    /* Flag page is cached, in first swap_map */
 161 #define SWAP_CONT_MAX   0x7f    /* Max count, in each swap_map continuation */
 162 #define COUNT_CONTINUED 0x80    /* See swap_map continuation for full count */
 163 #define SWAP_MAP_SHMEM  0xbf    /* Owned by shmem/tmpfs, in first swap_map */
 164
 165 /*
 166  * The in-memory structure used to track swap areas.
 167  */
 168 struct swap_info_struct {
 169         unsigned long   flags;          /* SWP_USED etc: see above */
 170         signed short    prio;           /* swap priority of this type */
 171         signed char     type;           /* strange name for an index */
 172         signed char     next;           /* next type on the swap list */
 173         unsigned int    max;            /* extent of the swap_map */
 174         unsigned char *swap_map;        /* vmalloc'ed array of usage counts */
 175         unsigned int lowest_bit;        /* index of first free in swap_map */
 176         unsigned int highest_bit;       /* index of last free in swap_map */
 177         unsigned int pages;             /* total of usable pages of swap */
 178         unsigned int inuse_pages;       /* number of those currently in use */
 179         unsigned int cluster_next;      /* likely index for next allocation */
 180         unsigned int cluster_nr;        /* countdown to next cluster search */
 181         unsigned int lowest_alloc;      /* while preparing discard cluster */
 182         unsigned int highest_alloc;     /* while preparing discard cluster */
 183         struct swap_extent *curr_swap_extent;
 184         struct swap_extent first_swap_extent;
 185         struct block_device *bdev;      /* swap device or bdev of swap file */
 186         struct file *swap_file;         /* seldom referenced */
 187         unsigned int old_block_size;    /* seldom referenced */
 188         void (*notify_swap_entry_free_fn) (unsigned long);
 189 };
 190
 191 struct swap_list_t {
 192         int head;       /* head of priority-ordered swapfile list */
 193         int next;       /* swapfile to be used next */
 194 };
 195
 196 /* Swap 50% full? Release swapcache more aggressively.. */
 197 #define vm_swap_full() (nr_swap_pages*2 < total_swap_pages)
 198
 199 /* linux/mm/page_alloc.c */
 200 extern unsigned long totalram_pages;
 201 extern unsigned long totalreserve_pages;
 202 extern unsigned int nr_free_buffer_pages(void);
 203 extern unsigned int nr_free_pagecache_pages(void);
 204
 205 /* Definition of global_page_state not available yet */
 206 #define nr_free_pages() global_page_state(NR_FREE_PAGES)
 207
 208
 209 /* linux/mm/swap.c */
 210 extern void __lru_cache_add(struct page *, enum lru_list lru);
 211 extern void lru_cache_add_lru(struct page *, enum lru_list lru);
 212 extern void lru_add_page_tail(struct zone* zone,
 213                               struct page *page, struct page *page_tail);
 214 extern void activate_page(struct page *);
 215 extern void mark_page_accessed(struct page *);
 216 extern void lru_add_drain(void);
 217 extern int lru_add_drain_all(void);
 218 extern void rotate_reclaimable_page(struct page *page);
 219 extern void swap_setup(void);
 220
 221 extern void add_page_to_unevictable_list(struct page *page);
 222
 223 /**
 224  * lru_cache_add: add a page to the page lists
 225  * @page: the page to add
 226  */
 227 static inline void lru_cache_add_anon(struct page *page)
 228 {
 229         __lru_cache_add(page, LRU_INACTIVE_ANON);
 230 }
 231
 232 static inline void lru_cache_add_file(struct page *page)
 233 {
 234         __lru_cache_add(page, LRU_INACTIVE_FILE);
 235 }
 236
 237 /* LRU Isolation modes. */
 238 #define ISOLATE_INACTIVE 0      /* Isolate inactive pages. */
 239 #define ISOLATE_ACTIVE 1        /* Isolate active pages. */
 240 #define ISOLATE_BOTH 2          /* Isolate both active and inactive pages. */
 241
 242 /* linux/mm/vmscan.c */
 243 extern unsigned long try_to_free_pages(struct zonelist *zonelist, int order,
 244                                         gfp_t gfp_mask, nodemask_t *mask);
 245 extern unsigned long try_to_free_mem_cgroup_pages(struct mem_cgroup *mem,
 246                                                   gfp_t gfp_mask, bool noswap,
 247                                                   unsigned int swappiness);
 248 extern unsigned long mem_cgroup_shrink_node_zone(struct mem_cgroup *mem,
 249                                                 gfp_t gfp_mask, bool noswap,
 250                                                 unsigned int swappiness,
 251                                                 struct zone *zone);
 252 extern int __isolate_lru_page(struct page *page, int mode, int file);
 253 extern unsigned long shrink_all_memory(unsigned long nr_pages);
 254 extern int vm_swappiness;
 255 extern int remove_mapping(struct address_space *mapping, struct page *page);
 256 extern long vm_total_pages;
 257
 258 #ifdef CONFIG_NUMA
 259 extern int zone_reclaim_mode;
 260 extern int sysctl_min_unmapped_ratio;
 261 extern int sysctl_min_slab_ratio;
 262 extern int zone_reclaim(struct zone *, gfp_t, unsigned int);
 263 #else
 264 #define zone_reclaim_mode 0
 265 static inline int zone_reclaim(struct zone *z, gfp_t mask, unsigned int order)
 266 {
 267         return 0;
 268 }
 269 #endif
 270
 271 extern int page_evictable(struct page *page, struct vm_area_struct *vma);
 272 extern void scan_mapping_unevictable_pages(struct address_space *);
 273
 274 extern unsigned long scan_unevictable_pages;
 275 extern int scan_unevictable_handler(struct ctl_table *, int,
 276                                         void __user *, size_t *, loff_t *);
 277 #ifdef CONFIG_NUMA
 278 extern int scan_unevictable_register_node(struct node *node);
 279 extern void scan_unevictable_unregister_node(struct node *node);
 280 #else
 281 static inline int scan_unevictable_register_node(struct node *node)
 282 {
 283         return 0;
 284 }
 285 static inline void scan_unevictable_unregister_node(struct node *node)
 286 {
 287 }
 288 #endif
 289
 290 extern int kswapd_run(int nid);
 291 extern void kswapd_stop(int nid);
 292
 293 #ifdef CONFIG_MMU
 294 /* linux/mm/shmem.c */
 295 extern int shmem_unuse(swp_entry_t entry, struct page *page);
 296 #endif /* CONFIG_MMU */
 297
 298 #ifdef CONFIG_CGROUP_MEM_RES_CTLR
 299 extern void mem_cgroup_get_shmem_target(struct inode *inode, pgoff_t pgoff,
 300                                         struct page **pagep, swp_entry_t *ent);
 301 #endif
 302
 303 extern void swap_unplug_io_fn(struct backing_dev_info *, struct page *);
 304
 305 #ifdef CONFIG_SWAP
 306 /* linux/mm/page_io.c */
 307 extern int swap_readpage(struct page *);
 308 extern int swap_writepage(struct page *page, struct writeback_control *wbc);
 309 extern void end_swap_bio_read(struct bio *bio, int err);
 310
 311 /* linux/mm/swap_state.c */
 312 extern struct address_space swapper_space;
 313 #define total_swapcache_pages  swapper_space.nrpages
 314 extern void show_swap_cache_info(void);
 315 extern int add_to_swap(struct page *);
 316 extern int add_to_swap_cache(struct page *, swp_entry_t, gfp_t);
 317 extern void __delete_from_swap_cache(struct page *);
 318 extern void delete_from_swap_cache(struct page *);
 319 extern void free_page_and_swap_cache(struct page *);
 320 extern void free_pages_and_swap_cache(struct page **, int);
 321 extern struct page *lookup_swap_cache(swp_entry_t);
 322 extern struct page *read_swap_cache_async(swp_entry_t, gfp_t,
 323                         struct vm_area_struct *vma, unsigned long addr);
 324 extern struct page *swapin_readahead(swp_entry_t, gfp_t,
 325                         struct vm_area_struct *vma, unsigned long addr);
 326
 327 /* linux/mm/swapfile.c */
 328 extern long nr_swap_pages;
 329 extern long total_swap_pages;
 330 extern void si_swapinfo(struct sysinfo *);
 331 extern swp_entry_t get_swap_page(void);
 332 extern swp_entry_t get_swap_page_of_type(int);
 333 extern int valid_swaphandles(swp_entry_t, unsigned long *);
 334 extern int add_swap_count_continuation(swp_entry_t, gfp_t);
 335 extern void swap_shmem_alloc(swp_entry_t);
 336 extern int swap_duplicate(swp_entry_t);
 337 extern int swapcache_prepare(swp_entry_t);
 338 extern void swap_free(swp_entry_t);
 339 extern void swapcache_free(swp_entry_t, struct page *page);
 340 extern int free_swap_and_cache(swp_entry_t);
 341 extern int swap_type_of(dev_t, sector_t, struct block_device **);
 342 extern unsigned int count_swap_pages(int, int);
 343 extern sector_t map_swap_page(struct page *, struct block_device **);
 344 extern sector_t swapdev_block(int, pgoff_t);
 345 extern int reuse_swap_page(struct page *);
 346 extern int try_to_free_swap(struct page *);
 347 struct backing_dev_info;
 348 extern void set_notify_swap_entry_free(unsigned, void (*) (unsigned long));
 349
 350 /* linux/mm/thrash.c */
 351 extern struct mm_struct *swap_token_mm;
 352 extern void grab_swap_token(struct mm_struct *);
 353 extern void __put_swap_token(struct mm_struct *);
 354
 355 static inline int has_swap_token(struct mm_struct *mm)
 356 {
 357         return (mm == swap_token_mm);
 358 }
 359
 360 static inline void put_swap_token(struct mm_struct *mm)
 361 {
 362         if (has_swap_token(mm))
 363                 __put_swap_token(mm);
 364 }
 365
 366 static inline void disable_swap_token(void)
 367 {
 368         put_swap_token(swap_token_mm);
 369 }
 370
 371 #ifdef CONFIG_CGROUP_MEM_RES_CTLR
 372 extern void
 373 mem_cgroup_uncharge_swapcache(struct page *page, swp_entry_t ent, bool swapout);
 374 extern int mem_cgroup_count_swap_user(swp_entry_t ent, struct page **pagep);
 375 #else
 376 static inline void
 377 mem_cgroup_uncharge_swapcache(struct page *page, swp_entry_t ent, bool swapout)
 378 {
 379 }
 380 #endif
 381 #ifdef CONFIG_CGROUP_MEM_RES_CTLR_SWAP
 382 extern void mem_cgroup_uncharge_swap(swp_entry_t ent);
 383 #else
 384 static inline void mem_cgroup_uncharge_swap(swp_entry_t ent)
 385 {
 386 }
 387 #endif
 388
 389 #else /* CONFIG_SWAP */
 390
 391 #define nr_swap_pages                           0L
 392 #define total_swap_pages                        0L
 393 #define total_swapcache_pages                   0UL
 394
 395 #define si_swapinfo(val) \
 396         do { (val)->freeswap = (val)->totalswap = 0; } while (0)
 397 /* only sparc can not include linux/pagemap.h in this file
 398  * so leave page_cache_release and release_pages undeclared... */
 399 #define free_page_and_swap_cache(page) \
 400         page_cache_release(page)
 401 #define free_pages_and_swap_cache(pages, nr) \
 402         release_pages((pages), (nr), 0);
 403
 404 static inline void show_swap_cache_info(void)
 405 {
 406 }
 407
 408 #define free_swap_and_cache(swp)        is_migration_entry(swp)
 409 #define swapcache_prepare(swp)          is_migration_entry(swp)
 410
 411 static inline int add_swap_count_continuation(swp_entry_t swp, gfp_t gfp_mask)
 412 {
 413         return 0;
 414 }
 415
 416 static inline void swap_shmem_alloc(swp_entry_t swp)
 417 {
 418 }
 419
 420 static inline int swap_duplicate(swp_entry_t swp)
 421 {
 422         return 0;
 423 }
 424
 425 static inline void swap_free(swp_entry_t swp)
 426 {
 427 }
 428
 429 static inline void swapcache_free(swp_entry_t swp, struct page *page)
 430 {
 431 }
 432
 433 static inline struct page *swapin_readahead(swp_entry_t swp, gfp_t gfp_mask,
 434                         struct vm_area_struct *vma, unsigned long addr)
 435 {
 436         return NULL;
 437 }
 438
 439 static inline int swap_writepage(struct page *p, struct writeback_control *wbc)
 440 {
 441         return 0;
 442 }
 443
 444 static inline struct page *lookup_swap_cache(swp_entry_t swp)
 445 {
 446         return NULL;
 447 }
 448
 449 static inline int add_to_swap(struct page *page)
 450 {
 451         return 0;
 452 }
 453
 454 static inline int add_to_swap_cache(struct page *page, swp_entry_t entry,
 455                                                         gfp_t gfp_mask)
 456 {
 457         return -1;
 458 }
 459
 460 static inline void __delete_from_swap_cache(struct page *page)
 461 {
 462 }
 463
 464 static inline void delete_from_swap_cache(struct page *page)
 465 {
 466 }
 467
 468 #define reuse_swap_page(page)   (page_mapcount(page) == 1)
 469
 470 static inline int try_to_free_swap(struct page *page)
 471 {
 472         return 0;
 473 }
 474
 475 static inline swp_entry_t get_swap_page(void)
 476 {
 477         swp_entry_t entry;
 478         entry.val = 0;
 479         return entry;
 480 }
 481
 482 /* linux/mm/thrash.c */
 483 static inline void put_swap_token(struct mm_struct *mm)
 484 {
 485 }
 486
 487 static inline void grab_swap_token(struct mm_struct *mm)
 488 {
 489 }
 490
 491 static inline int has_swap_token(struct mm_struct *mm)
 492 {
 493         return 0;
 494 }
 495
 496 static inline void disable_swap_token(void)
 497 {
 498 }
 499
 500 static inline void
 501 mem_cgroup_uncharge_swapcache(struct page *page, swp_entry_t ent)
 502 {
 503 }
 504
 505 #ifdef CONFIG_CGROUP_MEM_RES_CTLR
 506 static inline int
 507 mem_cgroup_count_swap_user(swp_entry_t ent, struct page **pagep)
 508 {
 509         return 0;
 510 }
 511 #endif
 512
 513 #endif /* CONFIG_SWAP */
 514 #endif /* __KERNEL__*/
 515 #endif /* _LINUX_SWAP_H */