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