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