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/fs.h>
  15 #include <linux/mm.h>
  16
  17 /*
  18  * The set of flags that only affect watermark checking and reclaim
  19  * behaviour. This is used by the MM to obey the caller constraints
  20  * about IO, FS and watermark checking while ignoring placement
  21  * hints such as HIGHMEM usage.
  22  */
  23 #define GFP_RECLAIM_MASK (__GFP_RECLAIM|__GFP_HIGH|__GFP_IO|__GFP_FS|\
  24                         __GFP_NOWARN|__GFP_REPEAT|__GFP_NOFAIL|\
  25                         __GFP_NORETRY|__GFP_MEMALLOC|__GFP_NOMEMALLOC|\
  26                         __GFP_ATOMIC)
  27
  28 /* The GFP flags allowed during early boot */
  29 #define GFP_BOOT_MASK (__GFP_BITS_MASK & ~(__GFP_RECLAIM|__GFP_IO|__GFP_FS))
  30
  31 /* Control allocation cpuset and node placement constraints */
  32 #define GFP_CONSTRAINT_MASK (__GFP_HARDWALL|__GFP_THISNODE)
  33
  34 /* Do not use these with a slab allocator */
  35 #define GFP_SLAB_BUG_MASK (__GFP_DMA32|__GFP_HIGHMEM|~__GFP_BITS_MASK)
  36
  37 void free_pgtables(struct mmu_gather *tlb, struct vm_area_struct *start_vma,
  38                 unsigned long floor, unsigned long ceiling);
  39
  40 static inline void set_page_count(struct page *page, int v)
  41 {
  42         atomic_set(&page->_count, v);
  43 }
  44
  45 extern int __do_page_cache_readahead(struct address_space *mapping,
  46                 struct file *filp, pgoff_t offset, unsigned long nr_to_read,
  47                 unsigned long lookahead_size);
  48
  49 /*
  50  * Submit IO for the read-ahead request in file_ra_state.
  51  */
  52 static inline unsigned long ra_submit(struct file_ra_state *ra,
  53                 struct address_space *mapping, struct file *filp)
  54 {
  55         return __do_page_cache_readahead(mapping, filp,
  56                                         ra->start, ra->size, ra->async_size);
  57 }
  58
  59 /*
  60  * Turn a non-refcounted page (->_count == 0) into refcounted with
  61  * a count of one.
  62  */
  63 static inline void set_page_refcounted(struct page *page)
  64 {
  65         VM_BUG_ON_PAGE(PageTail(page), page);
  66         VM_BUG_ON_PAGE(atomic_read(&page->_count), page);
  67         set_page_count(page, 1);
  68 }
  69
  70 static inline void __get_page_tail_foll(struct page *page,
  71                                         bool get_page_head)
  72 {
  73         /*
  74          * If we're getting a tail page, the elevated page->_count is
  75          * required only in the head page and we will elevate the head
  76          * page->_count and tail page->_mapcount.
  77          *
  78          * We elevate page_tail->_mapcount for tail pages to force
  79          * page_tail->_count to be zero at all times to avoid getting
  80          * false positives from get_page_unless_zero() with
  81          * speculative page access (like in
  82          * page_cache_get_speculative()) on tail pages.
  83          */
  84         VM_BUG_ON_PAGE(page_ref_zero_or_close_to_overflow(compound_head(page)),
  85                        page);
  86         if (get_page_head)
  87                 atomic_inc(&compound_head(page)->_count);
  88         get_huge_page_tail(page);
  89 }
  90
  91 /*
  92  * This is meant to be called as the FOLL_GET operation of
  93  * follow_page() and it must be called while holding the proper PT
  94  * lock while the pte (or pmd_trans_huge) is still mapping the page.
  95  */
  96 static inline void get_page_foll(struct page *page)
  97 {
  98         if (unlikely(PageTail(page)))
  99                 /*
 100                  * This is safe only because
 101                  * __split_huge_page_refcount() can't run under
 102                  * get_page_foll() because we hold the proper PT lock.
 103                  */
 104                 __get_page_tail_foll(page, true);
 105         else {
 106                 /*
 107                  * Getting a normal page or the head of a compound page
 108                  * requires to already have an elevated page->_count.
 109                  */
 110                 VM_BUG_ON_PAGE(page_ref_zero_or_close_to_overflow(page), page);
 111                 atomic_inc(&page->_count);
 112         }
 113 }
 114
 115 static inline __must_check bool try_get_page_foll(struct page *page)
 116 {
 117         if (unlikely(PageTail(page))) {
 118                 if (WARN_ON_ONCE(atomic_read(&compound_head(page)->_count) <= 0))
 119                         return false;
 120                 /*
 121                  * This is safe only because
 122                  * __split_huge_page_refcount() can't run under
 123                  * get_page_foll() because we hold the proper PT lock.
 124                  */
 125                 __get_page_tail_foll(page, true);
 126         } else {
 127                 /*
 128                  * Getting a normal page or the head of a compound page
 129                  * requires to already have an elevated page->_count.
 130                  */
 131                 if (WARN_ON_ONCE(atomic_read(&page->_count) <= 0))
 132                         return false;
 133                 atomic_inc(&page->_count);
 134         }
 135         return true;
 136 }
 137
 138 extern unsigned long highest_memmap_pfn;
 139
 140 /*
 141  * in mm/vmscan.c:
 142  */
 143 extern int isolate_lru_page(struct page *page);
 144 extern void putback_lru_page(struct page *page);
 145 extern bool zone_reclaimable(struct zone *zone);
 146
 147 /*
 148  * in mm/rmap.c:
 149  */
 150 extern pmd_t *mm_find_pmd(struct mm_struct *mm, unsigned long address);
 151
 152 /*
 153  * in mm/page_alloc.c
 154  */
 155
 156 /*
 157  * Structure for holding the mostly immutable allocation parameters passed
 158  * between functions involved in allocations, including the alloc_pages*
 159  * family of functions.
 160  *
 161  * nodemask, migratetype and high_zoneidx are initialized only once in
 162  * __alloc_pages_nodemask() and then never change.
 163  *
 164  * zonelist, preferred_zone and classzone_idx are set first in
 165  * __alloc_pages_nodemask() for the fast path, and might be later changed
 166  * in __alloc_pages_slowpath(). All other functions pass the whole strucure
 167  * by a const pointer.
 168  */
 169 struct alloc_context {
 170         struct zonelist *zonelist;
 171         nodemask_t *nodemask;
 172         struct zone *preferred_zone;
 173         int classzone_idx;
 174         int migratetype;
 175         enum zone_type high_zoneidx;
 176         bool spread_dirty_pages;
 177 };
 178
 179 /*
 180  * Locate the struct page for both the matching buddy in our
 181  * pair (buddy1) and the combined O(n+1) page they form (page).
 182  *
 183  * 1) Any buddy B1 will have an order O twin B2 which satisfies
 184  * the following equation:
 185  *     B2 = B1 ^ (1 << O)
 186  * For example, if the starting buddy (buddy2) is #8 its order
 187  * 1 buddy is #10:
 188  *     B2 = 8 ^ (1 << 1) = 8 ^ 2 = 10
 189  *
 190  * 2) Any buddy B will have an order O+1 parent P which
 191  * satisfies the following equation:
 192  *     P = B & ~(1 << O)
 193  *
 194  * Assumption: *_mem_map is contiguous at least up to MAX_ORDER
 195  */
 196 static inline unsigned long
 197 __find_buddy_index(unsigned long page_idx, unsigned int order)
 198 {
 199         return page_idx ^ (1 << order);
 200 }
 201
 202 extern int __isolate_free_page(struct page *page, unsigned int order);
 203 extern void __free_pages_bootmem(struct page *page, unsigned long pfn,
 204                                         unsigned int order);
 205 extern void prep_compound_page(struct page *page, unsigned int order);
 206 #ifdef CONFIG_MEMORY_FAILURE
 207 extern bool is_free_buddy_page(struct page *page);
 208 #endif
 209 extern int user_min_free_kbytes;
 210
 211 #if defined CONFIG_COMPACTION || defined CONFIG_CMA
 212
 213 /*
 214  * in mm/compaction.c
 215  */
 216 /*
 217  * compact_control is used to track pages being migrated and the free pages
 218  * they are being migrated to during memory compaction. The free_pfn starts
 219  * at the end of a zone and migrate_pfn begins at the start. Movable pages
 220  * are moved to the end of a zone during a compaction run and the run
 221  * completes when free_pfn <= migrate_pfn
 222  */
 223 struct compact_control {
 224         struct list_head freepages;     /* List of free pages to migrate to */
 225         struct list_head migratepages;  /* List of pages being migrated */
 226         unsigned long nr_freepages;     /* Number of isolated free pages */
 227         unsigned long nr_migratepages;  /* Number of pages to migrate */
 228         unsigned long free_pfn;         /* isolate_freepages search base */
 229         unsigned long migrate_pfn;      /* isolate_migratepages search base */
 230         unsigned long last_migrated_pfn;/* Not yet flushed page being freed */
 231         enum migrate_mode mode;         /* Async or sync migration mode */
 232         bool ignore_skip_hint;          /* Scan blocks even if marked skip */
 233         int order;                      /* order a direct compactor needs */
 234         const gfp_t gfp_mask;           /* gfp mask of a direct compactor */
 235         const int alloc_flags;          /* alloc flags of a direct compactor */
 236         const int classzone_idx;        /* zone index of a direct compactor */
 237         struct zone *zone;
 238         int contended;                  /* Signal need_sched() or lock
 239                                          * contention detected during
 240                                          * compaction
 241                                          */
 242 };
 243
 244 unsigned long
 245 isolate_freepages_range(struct compact_control *cc,
 246                         unsigned long start_pfn, unsigned long end_pfn);
 247 unsigned long
 248 isolate_migratepages_range(struct compact_control *cc,
 249                            unsigned long low_pfn, unsigned long end_pfn);
 250 int find_suitable_fallback(struct free_area *area, unsigned int order,
 251                         int migratetype, bool only_stealable, bool *can_steal);
 252
 253 #endif
 254
 255 /*
 256  * This function returns the order of a free page in the buddy system. In
 257  * general, page_zone(page)->lock must be held by the caller to prevent the
 258  * page from being allocated in parallel and returning garbage as the order.
 259  * If a caller does not hold page_zone(page)->lock, it must guarantee that the
 260  * page cannot be allocated or merged in parallel. Alternatively, it must
 261  * handle invalid values gracefully, and use page_order_unsafe() below.
 262  */
 263 static inline unsigned int page_order(struct page *page)
 264 {
 265         /* PageBuddy() must be checked by the caller */
 266         return page_private(page);
 267 }
 268
 269 /*
 270  * Like page_order(), but for callers who cannot afford to hold the zone lock.
 271  * PageBuddy() should be checked first by the caller to minimize race window,
 272  * and invalid values must be handled gracefully.
 273  *
 274  * READ_ONCE is used so that if the caller assigns the result into a local
 275  * variable and e.g. tests it for valid range before using, the compiler cannot
 276  * decide to remove the variable and inline the page_private(page) multiple
 277  * times, potentially observing different values in the tests and the actual
 278  * use of the result.
 279  */
 280 #define page_order_unsafe(page)         READ_ONCE(page_private(page))
 281
 282 static inline bool is_cow_mapping(vm_flags_t flags)
 283 {
 284         return (flags & (VM_SHARED | VM_MAYWRITE)) == VM_MAYWRITE;
 285 }
 286
 287 /* mm/util.c */
 288 void __vma_link_list(struct mm_struct *mm, struct vm_area_struct *vma,
 289                 struct vm_area_struct *prev, struct rb_node *rb_parent);
 290
 291 #ifdef CONFIG_MMU
 292 extern long populate_vma_page_range(struct vm_area_struct *vma,
 293                 unsigned long start, unsigned long end, int *nonblocking);
 294 extern void munlock_vma_pages_range(struct vm_area_struct *vma,
 295                         unsigned long start, unsigned long end);
 296 static inline void munlock_vma_pages_all(struct vm_area_struct *vma)
 297 {
 298         munlock_vma_pages_range(vma, vma->vm_start, vma->vm_end);
 299 }
 300
 301 /*
 302  * must be called with vma's mmap_sem held for read or write, and page locked.
 303  */
 304 extern void mlock_vma_page(struct page *page);
 305 extern unsigned int munlock_vma_page(struct page *page);
 306
 307 /*
 308  * Clear the page's PageMlocked().  This can be useful in a situation where
 309  * we want to unconditionally remove a page from the pagecache -- e.g.,
 310  * on truncation or freeing.
 311  *
 312  * It is legal to call this function for any page, mlocked or not.
 313  * If called for a page that is still mapped by mlocked vmas, all we do
 314  * is revert to lazy LRU behaviour -- semantics are not broken.
 315  */
 316 extern void clear_page_mlock(struct page *page);
 317
 318 /*
 319  * mlock_migrate_page - called only from migrate_misplaced_transhuge_page()
 320  * (because that does not go through the full procedure of migration ptes):
 321  * to migrate the Mlocked page flag; update statistics.
 322  */
 323 static inline void mlock_migrate_page(struct page *newpage, struct page *page)
 324 {
 325         if (TestClearPageMlocked(page)) {
 326                 int nr_pages = hpage_nr_pages(page);
 327
 328                 /* Holding pmd lock, no change in irq context: __mod is safe */
 329                 __mod_zone_page_state(page_zone(page), NR_MLOCK, -nr_pages);
 330                 SetPageMlocked(newpage);
 331                 __mod_zone_page_state(page_zone(newpage), NR_MLOCK, nr_pages);
 332         }
 333 }
 334
 335 extern pmd_t maybe_pmd_mkwrite(pmd_t pmd, struct vm_area_struct *vma);
 336
 337 #ifdef CONFIG_TRANSPARENT_HUGEPAGE
 338 extern unsigned long vma_address(struct page *page,
 339                                  struct vm_area_struct *vma);
 340 #endif
 341 #else /* !CONFIG_MMU */
 342 static inline void clear_page_mlock(struct page *page) { }
 343 static inline void mlock_vma_page(struct page *page) { }
 344 static inline void mlock_migrate_page(struct page *new, struct page *old) { }
 345
 346 #endif /* !CONFIG_MMU */
 347
 348 /*
 349  * Return the mem_map entry representing the 'offset' subpage within
 350  * the maximally aligned gigantic page 'base'.  Handle any discontiguity
 351  * in the mem_map at MAX_ORDER_NR_PAGES boundaries.
 352  */
 353 static inline struct page *mem_map_offset(struct page *base, int offset)
 354 {
 355         if (unlikely(offset >= MAX_ORDER_NR_PAGES))
 356                 return nth_page(base, offset);
 357         return base + offset;
 358 }
 359
 360 /*
 361  * Iterator over all subpages within the maximally aligned gigantic
 362  * page 'base'.  Handle any discontiguity in the mem_map.
 363  */
 364 static inline struct page *mem_map_next(struct page *iter,
 365                                                 struct page *base, int offset)
 366 {
 367         if (unlikely((offset & (MAX_ORDER_NR_PAGES - 1)) == 0)) {
 368                 unsigned long pfn = page_to_pfn(base) + offset;
 369                 if (!pfn_valid(pfn))
 370                         return NULL;
 371                 return pfn_to_page(pfn);
 372         }
 373         return iter + 1;
 374 }
 375
 376 /*
 377  * FLATMEM and DISCONTIGMEM configurations use alloc_bootmem_node,
 378  * so all functions starting at paging_init should be marked __init
 379  * in those cases. SPARSEMEM, however, allows for memory hotplug,
 380  * and alloc_bootmem_node is not used.
 381  */
 382 #ifdef CONFIG_SPARSEMEM
 383 #define __paginginit __meminit
 384 #else
 385 #define __paginginit __init
 386 #endif
 387
 388 /* Memory initialisation debug and verification */
 389 enum mminit_level {
 390         MMINIT_WARNING,
 391         MMINIT_VERIFY,
 392         MMINIT_TRACE
 393 };
 394
 395 #ifdef CONFIG_DEBUG_MEMORY_INIT
 396
 397 extern int mminit_loglevel;
 398
 399 #define mminit_dprintk(level, prefix, fmt, arg...) \
 400 do { \
 401         if (level < mminit_loglevel) { \
 402                 if (level <= MMINIT_WARNING) \
 403                         printk(KERN_WARNING "mminit::" prefix " " fmt, ##arg); \
 404                 else \
 405                         printk(KERN_DEBUG "mminit::" prefix " " fmt, ##arg); \
 406         } \
 407 } while (0)
 408
 409 extern void mminit_verify_pageflags_layout(void);
 410 extern void mminit_verify_zonelist(void);
 411 #else
 412
 413 static inline void mminit_dprintk(enum mminit_level level,
 414                                 const char *prefix, const char *fmt, ...)
 415 {
 416 }
 417
 418 static inline void mminit_verify_pageflags_layout(void)
 419 {
 420 }
 421
 422 static inline void mminit_verify_zonelist(void)
 423 {
 424 }
 425 #endif /* CONFIG_DEBUG_MEMORY_INIT */
 426
 427 /* mminit_validate_memmodel_limits is independent of CONFIG_DEBUG_MEMORY_INIT */
 428 #if defined(CONFIG_SPARSEMEM)
 429 extern void mminit_validate_memmodel_limits(unsigned long *start_pfn,
 430                                 unsigned long *end_pfn);
 431 #else
 432 static inline void mminit_validate_memmodel_limits(unsigned long *start_pfn,
 433                                 unsigned long *end_pfn)
 434 {
 435 }
 436 #endif /* CONFIG_SPARSEMEM */
 437
 438 #define ZONE_RECLAIM_NOSCAN     -2
 439 #define ZONE_RECLAIM_FULL       -1
 440 #define ZONE_RECLAIM_SOME       0
 441 #define ZONE_RECLAIM_SUCCESS    1
 442
 443 extern int hwpoison_filter(struct page *p);
 444
 445 extern u32 hwpoison_filter_dev_major;
 446 extern u32 hwpoison_filter_dev_minor;
 447 extern u64 hwpoison_filter_flags_mask;
 448 extern u64 hwpoison_filter_flags_value;
 449 extern u64 hwpoison_filter_memcg;
 450 extern u32 hwpoison_filter_enable;
 451
 452 extern unsigned long vm_mmap_pgoff(struct file *, unsigned long,
 453         unsigned long, unsigned long,
 454         unsigned long, unsigned long);
 455
 456 extern void set_pageblock_order(void);
 457 unsigned long reclaim_clean_pages_from_list(struct zone *zone,
 458                                             struct list_head *page_list);
 459 /* The ALLOC_WMARK bits are used as an index to zone->watermark */
 460 #define ALLOC_WMARK_MIN         WMARK_MIN
 461 #define ALLOC_WMARK_LOW         WMARK_LOW
 462 #define ALLOC_WMARK_HIGH        WMARK_HIGH
 463 #define ALLOC_NO_WATERMARKS     0x04 /* don't check watermarks at all */
 464
 465 /* Mask to get the watermark bits */
 466 #define ALLOC_WMARK_MASK        (ALLOC_NO_WATERMARKS-1)
 467
 468 #define ALLOC_HARDER            0x10 /* try to alloc harder */
 469 #define ALLOC_HIGH              0x20 /* __GFP_HIGH set */
 470 #define ALLOC_CPUSET            0x40 /* check for correct cpuset */
 471 #define ALLOC_CMA               0x80 /* allow allocations from CMA areas */
 472 #define ALLOC_FAIR              0x100 /* fair zone allocation */
 473
 474 enum ttu_flags;
 475 struct tlbflush_unmap_batch;
 476
 477 #ifdef CONFIG_ARCH_WANT_BATCHED_UNMAP_TLB_FLUSH
 478 void try_to_unmap_flush(void);
 479 void try_to_unmap_flush_dirty(void);
 480 void flush_tlb_batched_pending(struct mm_struct *mm);
 481 #else
 482 static inline void try_to_unmap_flush(void)
 483 {
 484 }
 485 static inline void try_to_unmap_flush_dirty(void)
 486 {
 487 }
 488 static inline void flush_tlb_batched_pending(struct mm_struct *mm)
 489 {
 490 }
 491 #endif /* CONFIG_ARCH_WANT_BATCHED_UNMAP_TLB_FLUSH */
 492 #endif  /* __MM_INTERNAL_H */