mm/internal.h

   1 /* internal.h: mm/ internal definitions
   2  *
   3  * Copyright (C) 2004 Red Hat, Inc. All Rights Reserved.
   4  * Written by David Howells (dhowells@redhat.com)
   5  *
   6  * This program is free software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License
   8  * as published by the Free Software Foundation; either version
   9  * 2 of the License, or (at your option) any later version.
  10  */
  11 #ifndef __MM_INTERNAL_H
  12 #define __MM_INTERNAL_H
  13
  14 #include <linux/mm.h>
  15 #include <linux/rmap.h>
  16
  17 void free_pgtables(struct mmu_gather *tlb, struct vm_area_struct *start_vma,
  18                 unsigned long floor, unsigned long ceiling);
  19
  20 static inline void set_page_count(struct page *page, int v)
  21 {
  22         atomic_set(&page->_count, v);
  23 }
  24
  25 /*
  26  * Turn a non-refcounted page (->_count == 0) into refcounted with
  27  * a count of one.
  28  */
  29 static inline void set_page_refcounted(struct page *page)
  30 {
  31         VM_BUG_ON(PageTail(page));
  32         VM_BUG_ON(atomic_read(&page->_count));
  33         set_page_count(page, 1);
  34 }
  35
  36 static inline void __put_page(struct page *page)
  37 {
  38         atomic_dec(&page->_count);
  39 }
  40
  41 static inline void __get_page_tail_foll(struct page *page,
  42                                         bool get_page_head)
  43 {
  44         /*
  45          * If we're getting a tail page, the elevated page->_count is
  46          * required only in the head page and we will elevate the head
  47          * page->_count and tail page->_mapcount.
  48          *
  49          * We elevate page_tail->_mapcount for tail pages to force
  50          * page_tail->_count to be zero at all times to avoid getting
  51          * false positives from get_page_unless_zero() with
  52          * speculative page access (like in
  53          * page_cache_get_speculative()) on tail pages.
  54          */
  55         VM_BUG_ON(atomic_read(&page->first_page->_count) <= 0);
  56         VM_BUG_ON(atomic_read(&page->_count) != 0);
  57         VM_BUG_ON(page_mapcount(page) < 0);
  58         if (get_page_head)
  59                 atomic_inc(&page->first_page->_count);
  60         atomic_inc(&page->_mapcount);
  61 }
  62
  63 /*
  64  * This is meant to be called as the FOLL_GET operation of
  65  * follow_page() and it must be called while holding the proper PT
  66  * lock while the pte (or pmd_trans_huge) is still mapping the page.
  67  */
  68 static inline void get_page_foll(struct page *page)
  69 {
  70         if (unlikely(PageTail(page)))
  71                 /*
  72                  * This is safe only because
  73                  * __split_huge_page_refcount() can't run under
  74                  * get_page_foll() because we hold the proper PT lock.
  75                  */
  76                 __get_page_tail_foll(page, true);
  77         else {
  78                 /*
  79                  * Getting a normal page or the head of a compound page
  80                  * requires to already have an elevated page->_count.
  81                  */
  82                 VM_BUG_ON(atomic_read(&page->_count) <= 0);
  83                 atomic_inc(&page->_count);
  84         }
  85 }
  86
  87 extern unsigned long highest_memmap_pfn;
  88
  89 /*
  90  * in mm/vmscan.c:
  91  */
  92 extern int isolate_lru_page(struct page *page);
  93 extern void putback_lru_page(struct page *page);
  94
  95 /*
  96  * in mm/page_alloc.c
  97  */
  98 extern void __free_pages_bootmem(struct page *page, unsigned int order);
  99 extern void prep_compound_page(struct page *page, unsigned long order);
 100 #ifdef CONFIG_MEMORY_FAILURE
 101 extern bool is_free_buddy_page(struct page *page);
 102 #endif
 103
 104 #if defined CONFIG_COMPACTION || defined CONFIG_CMA
 105
 106 /*
 107  * in mm/compaction.c
 108  */
 109 /*
 110  * compact_control is used to track pages being migrated and the free pages
 111  * they are being migrated to during memory compaction. The free_pfn starts
 112  * at the end of a zone and migrate_pfn begins at the start. Movable pages
 113  * are moved to the end of a zone during a compaction run and the run
 114  * completes when free_pfn <= migrate_pfn
 115  */
 116 struct compact_control {
 117         struct list_head freepages;     /* List of free pages to migrate to */
 118         struct list_head migratepages;  /* List of pages being migrated */
 119         unsigned long nr_freepages;     /* Number of isolated free pages */
 120         unsigned long nr_migratepages;  /* Number of pages to migrate */
 121         unsigned long free_pfn;         /* isolate_freepages search base */
 122         unsigned long start_free_pfn;   /* where we started the search */
 123         unsigned long migrate_pfn;      /* isolate_migratepages search base */
 124         bool sync;                      /* Synchronous migration */
 125         bool wrapped;                   /* Order > 0 compactions are
 126                                            incremental, once free_pfn
 127                                            and migrate_pfn meet, we restart
 128                                            from the top of the zone;
 129                                            remember we wrapped around. */
 130
 131         int order;                      /* order a direct compactor needs */
 132         int migratetype;                /* MOVABLE, RECLAIMABLE etc */
 133         struct zone *zone;
 134         bool *contended;                /* True if a lock was contended */
 135         struct page **page;             /* Page captured of requested size */
 136 };
 137
 138 unsigned long
 139 isolate_freepages_range(unsigned long start_pfn, unsigned long end_pfn);
 140 unsigned long
 141 isolate_migratepages_range(struct zone *zone, struct compact_control *cc,
 142                            unsigned long low_pfn, unsigned long end_pfn);
 143
 144 #endif
 145
 146 /*
 147  * function for dealing with page's order in buddy system.
 148  * zone->lock is already acquired when we use these.
 149  * So, we don't need atomic page->flags operations here.
 150  */
 151 static inline unsigned long page_order(struct page *page)
 152 {
 153         /* PageBuddy() must be checked by the caller */
 154         return page_private(page);
 155 }
 156
 157 /* mm/util.c */
 158 void __vma_link_list(struct mm_struct *mm, struct vm_area_struct *vma,
 159                 struct vm_area_struct *prev, struct rb_node *rb_parent);
 160
 161 #ifdef CONFIG_MMU
 162 extern long mlock_vma_pages_range(struct vm_area_struct *vma,
 163                         unsigned long start, unsigned long end);
 164 extern void munlock_vma_pages_range(struct vm_area_struct *vma,
 165                         unsigned long start, unsigned long end);
 166 static inline void munlock_vma_pages_all(struct vm_area_struct *vma)
 167 {
 168         munlock_vma_pages_range(vma, vma->vm_start, vma->vm_end);
 169 }
 170
 171 /*
 172  * Called only in fault path via page_evictable() for a new page
 173  * to determine if it's being mapped into a LOCKED vma.
 174  * If so, mark page as mlocked.
 175  */
 176 static inline int mlocked_vma_newpage(struct vm_area_struct *vma,
 177                                     struct page *page)
 178 {
 179         VM_BUG_ON(PageLRU(page));
 180
 181         if (likely((vma->vm_flags & (VM_LOCKED | VM_SPECIAL)) != VM_LOCKED))
 182                 return 0;
 183
 184         if (!TestSetPageMlocked(page)) {
 185                 inc_zone_page_state(page, NR_MLOCK);
 186                 count_vm_event(UNEVICTABLE_PGMLOCKED);
 187         }
 188         return 1;
 189 }
 190
 191 /*
 192  * must be called with vma's mmap_sem held for read or write, and page locked.
 193  */
 194 extern void mlock_vma_page(struct page *page);
 195 extern void munlock_vma_page(struct page *page);
 196
 197 /*
 198  * Clear the page's PageMlocked().  This can be useful in a situation where
 199  * we want to unconditionally remove a page from the pagecache -- e.g.,
 200  * on truncation or freeing.
 201  *
 202  * It is legal to call this function for any page, mlocked or not.
 203  * If called for a page that is still mapped by mlocked vmas, all we do
 204  * is revert to lazy LRU behaviour -- semantics are not broken.
 205  */
 206 extern void __clear_page_mlock(struct page *page);
 207 static inline void clear_page_mlock(struct page *page)
 208 {
 209         if (unlikely(TestClearPageMlocked(page)))
 210                 __clear_page_mlock(page);
 211 }
 212
 213 /*
 214  * mlock_migrate_page - called only from migrate_page_copy() to
 215  * migrate the Mlocked page flag; update statistics.
 216  */
 217 static inline void mlock_migrate_page(struct page *newpage, struct page *page)
 218 {
 219         if (TestClearPageMlocked(page)) {
 220                 unsigned long flags;
 221
 222                 local_irq_save(flags);
 223                 __dec_zone_page_state(page, NR_MLOCK);
 224                 SetPageMlocked(newpage);
 225                 __inc_zone_page_state(newpage, NR_MLOCK);
 226                 local_irq_restore(flags);
 227         }
 228 }
 229
 230 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 231 extern unsigned long vma_address(struct page *page,
 232                                  struct vm_area_struct *vma);
 233 #endif
 234 #else /* !CONFIG_MMU */
 235 static inline int mlocked_vma_newpage(struct vm_area_struct *v, struct page *p)
 236 {
 237         return 0;
 238 }
 239 static inline void clear_page_mlock(struct page *page) { }
 240 static inline void mlock_vma_page(struct page *page) { }
 241 static inline void mlock_migrate_page(struct page *new, struct page *old) { }
 242
 243 #endif /* !CONFIG_MMU */
 244
 245 /*
 246  * Return the mem_map entry representing the 'offset' subpage within
 247  * the maximally aligned gigantic page 'base'.  Handle any discontiguity
 248  * in the mem_map at MAX_ORDER_NR_PAGES boundaries.
 249  */
 250 static inline struct page *mem_map_offset(struct page *base, int offset)
 251 {
 252         if (unlikely(offset >= MAX_ORDER_NR_PAGES))
 253                 return pfn_to_page(page_to_pfn(base) + offset);
 254         return base + offset;
 255 }
 256
 257 /*
 258  * Iterator over all subpages within the maximally aligned gigantic
 259  * page 'base'.  Handle any discontiguity in the mem_map.
 260  */
 261 static inline struct page *mem_map_next(struct page *iter,
 262                                                 struct page *base, int offset)
 263 {
 264         if (unlikely((offset & (MAX_ORDER_NR_PAGES - 1)) == 0)) {
 265                 unsigned long pfn = page_to_pfn(base) + offset;
 266                 if (!pfn_valid(pfn))
 267                         return NULL;
 268                 return pfn_to_page(pfn);
 269         }
 270         return iter + 1;
 271 }
 272
 273 /*
 274  * FLATMEM and DISCONTIGMEM configurations use alloc_bootmem_node,
 275  * so all functions starting at paging_init should be marked __init
 276  * in those cases. SPARSEMEM, however, allows for memory hotplug,
 277  * and alloc_bootmem_node is not used.
 278  */
 279 #ifdef CONFIG_SPARSEMEM
 280 #define __paginginit __meminit
 281 #else
 282 #define __paginginit __init
 283 #endif
 284
 285 /* Memory initialisation debug and verification */
 286 enum mminit_level {
 287         MMINIT_WARNING,
 288         MMINIT_VERIFY,
 289         MMINIT_TRACE
 290 };
 291
 292 #ifdef CONFIG_DEBUG_MEMORY_INIT
 293
 294 extern int mminit_loglevel;
 295
 296 #define mminit_dprintk(level, prefix, fmt, arg...) \
 297 do { \
 298         if (level < mminit_loglevel) { \
 299                 printk(level <= MMINIT_WARNING ? KERN_WARNING : KERN_DEBUG); \
 300                 printk(KERN_CONT "mminit::" prefix " " fmt, ##arg); \
 301         } \
 302 } while (0)
 303
 304 extern void mminit_verify_pageflags_layout(void);
 305 extern void mminit_verify_page_links(struct page *page,
 306                 enum zone_type zone, unsigned long nid, unsigned long pfn);
 307 extern void mminit_verify_zonelist(void);
 308
 309 #else
 310
 311 static inline void mminit_dprintk(enum mminit_level level,
 312                                 const char *prefix, const char *fmt, ...)
 313 {
 314 }
 315
 316 static inline void mminit_verify_pageflags_layout(void)
 317 {
 318 }
 319
 320 static inline void mminit_verify_page_links(struct page *page,
 321                 enum zone_type zone, unsigned long nid, unsigned long pfn)
 322 {
 323 }
 324
 325 static inline void mminit_verify_zonelist(void)
 326 {
 327 }
 328 #endif /* CONFIG_DEBUG_MEMORY_INIT */
 329
 330 /* mminit_validate_memmodel_limits is independent of CONFIG_DEBUG_MEMORY_INIT */
 331 #if defined(CONFIG_SPARSEMEM)
 332 extern void mminit_validate_memmodel_limits(unsigned long *start_pfn,
 333                                 unsigned long *end_pfn);
 334 #else
 335 static inline void mminit_validate_memmodel_limits(unsigned long *start_pfn,
 336                                 unsigned long *end_pfn)
 337 {
 338 }
 339 #endif /* CONFIG_SPARSEMEM */
 340
 341 #define ZONE_RECLAIM_NOSCAN     -2
 342 #define ZONE_RECLAIM_FULL       -1
 343 #define ZONE_RECLAIM_SOME       0
 344 #define ZONE_RECLAIM_SUCCESS    1
 345
 346 extern int hwpoison_filter(struct page *p);
 347
 348 extern u32 hwpoison_filter_dev_major;
 349 extern u32 hwpoison_filter_dev_minor;
 350 extern u64 hwpoison_filter_flags_mask;
 351 extern u64 hwpoison_filter_flags_value;
 352 extern u64 hwpoison_filter_memcg;
 353 extern u32 hwpoison_filter_enable;
 354
 355 extern unsigned long vm_mmap_pgoff(struct file *, unsigned long,
 356         unsigned long, unsigned long,
 357         unsigned long, unsigned long);
 358
 359 extern void set_pageblock_order(void);
 360 unsigned long reclaim_clean_pages_from_list(struct zone *zone,
 361                                             struct list_head *page_list);
 362 /* The ALLOC_WMARK bits are used as an index to zone->watermark */
 363 #define ALLOC_WMARK_MIN         WMARK_MIN
 364 #define ALLOC_WMARK_LOW         WMARK_LOW
 365 #define ALLOC_WMARK_HIGH        WMARK_HIGH
 366 #define ALLOC_NO_WATERMARKS     0x04 /* don't check watermarks at all */
 367
 368 /* Mask to get the watermark bits */
 369 #define ALLOC_WMARK_MASK        (ALLOC_NO_WATERMARKS-1)
 370
 371 #define ALLOC_HARDER            0x10 /* try to alloc harder */
 372 #define ALLOC_HIGH              0x20 /* __GFP_HIGH set */
 373 #define ALLOC_CPUSET            0x40 /* check for correct cpuset */
 374 #define ALLOC_CMA               0x80 /* allow allocations from CMA areas */
 375
 376 /*
 377  * Unnecessary readahead harms performance, especially for SSD devices, where
 378  * large reads are significantly more expensive than small ones.
 379  * These implements simple swap random access detection. In swap page fault: if
 380  * the page is found in swapcache, decrease a counter in the vma, otherwise we
 381  * need to perform sync swapin and the counter is increased.  Optionally swapin
 382  * will perform readahead if the counter is below a threshold.
 383  */
 384 #ifdef CONFIG_SWAP
 385 #define SWAPRA_MISS_THRESHOLD  (100)
 386 #define SWAPRA_MAX_MISS ((SWAPRA_MISS_THRESHOLD) * 10)
 387 static inline void swap_cache_hit(struct vm_area_struct *vma)
 388 {
 389         if (vma && vma->anon_vma)
 390                 atomic_dec_if_positive(&vma->anon_vma->swapra_miss);
 391 }
 392
 393 static inline void swap_cache_miss(struct vm_area_struct *vma)
 394 {
 395         if (!vma || !vma->anon_vma)
 396                 return;
 397         if (atomic_read(&vma->anon_vma->swapra_miss) < SWAPRA_MAX_MISS)
 398                 atomic_inc(&vma->anon_vma->swapra_miss);
 399 }
 400
 401 static inline int swap_cache_skip_readahead(struct vm_area_struct *vma)
 402 {
 403         if (!vma || !vma->anon_vma)
 404                 return 0;
 405         return atomic_read(&vma->anon_vma->swapra_miss) >
 406                 SWAPRA_MISS_THRESHOLD;
 407 }
 408 #else
 409 static inline void swap_cache_hit(struct vm_area_struct *vma)
 410 {
 411 }
 412
 413 static inline void swap_cache_miss(struct vm_area_struct *vma)
 414 {
 415 }
 416
 417 static inline int swap_cache_skip_readahead(struct vm_area_struct *vma)
 418 {
 419         return 0;
 420 }
 421 #endif  /* CONFIG_SWAP */
 422
 423 #endif  /* __MM_INTERNAL_H */