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