Merge branches 'pm-cpufreq' and 'pm-acpi'
[platform/kernel/linux-starfive.git] / mm / internal.h
1 /* SPDX-License-Identifier: GPL-2.0-or-later */
2 /* internal.h: mm/ internal definitions
3  *
4  * Copyright (C) 2004 Red Hat, Inc. All Rights Reserved.
5  * Written by David Howells (dhowells@redhat.com)
6  */
7 #ifndef __MM_INTERNAL_H
8 #define __MM_INTERNAL_H
9
10 #include <linux/fs.h>
11 #include <linux/mm.h>
12 #include <linux/pagemap.h>
13 #include <linux/tracepoint-defs.h>
14
15 /*
16  * The set of flags that only affect watermark checking and reclaim
17  * behaviour. This is used by the MM to obey the caller constraints
18  * about IO, FS and watermark checking while ignoring placement
19  * hints such as HIGHMEM usage.
20  */
21 #define GFP_RECLAIM_MASK (__GFP_RECLAIM|__GFP_HIGH|__GFP_IO|__GFP_FS|\
22                         __GFP_NOWARN|__GFP_RETRY_MAYFAIL|__GFP_NOFAIL|\
23                         __GFP_NORETRY|__GFP_MEMALLOC|__GFP_NOMEMALLOC|\
24                         __GFP_ATOMIC)
25
26 /* The GFP flags allowed during early boot */
27 #define GFP_BOOT_MASK (__GFP_BITS_MASK & ~(__GFP_RECLAIM|__GFP_IO|__GFP_FS))
28
29 /* Control allocation cpuset and node placement constraints */
30 #define GFP_CONSTRAINT_MASK (__GFP_HARDWALL|__GFP_THISNODE)
31
32 /* Do not use these with a slab allocator */
33 #define GFP_SLAB_BUG_MASK (__GFP_DMA32|__GFP_HIGHMEM|~__GFP_BITS_MASK)
34
35 void page_writeback_init(void);
36
37 vm_fault_t do_swap_page(struct vm_fault *vmf);
38
39 void free_pgtables(struct mmu_gather *tlb, struct vm_area_struct *start_vma,
40                 unsigned long floor, unsigned long ceiling);
41
42 static inline bool can_madv_lru_vma(struct vm_area_struct *vma)
43 {
44         return !(vma->vm_flags & (VM_LOCKED|VM_HUGETLB|VM_PFNMAP));
45 }
46
47 void unmap_page_range(struct mmu_gather *tlb,
48                              struct vm_area_struct *vma,
49                              unsigned long addr, unsigned long end,
50                              struct zap_details *details);
51
52 void force_page_cache_readahead(struct address_space *, struct file *,
53                 pgoff_t index, unsigned long nr_to_read);
54 void __do_page_cache_readahead(struct address_space *, struct file *,
55                 pgoff_t index, unsigned long nr_to_read,
56                 unsigned long lookahead_size);
57
58 /*
59  * Submit IO for the read-ahead request in file_ra_state.
60  */
61 static inline void ra_submit(struct file_ra_state *ra,
62                 struct address_space *mapping, struct file *filp)
63 {
64         __do_page_cache_readahead(mapping, filp,
65                         ra->start, ra->size, ra->async_size);
66 }
67
68 /**
69  * page_evictable - test whether a page is evictable
70  * @page: the page to test
71  *
72  * Test whether page is evictable--i.e., should be placed on active/inactive
73  * lists vs unevictable list.
74  *
75  * Reasons page might not be evictable:
76  * (1) page's mapping marked unevictable
77  * (2) page is part of an mlocked VMA
78  *
79  */
80 static inline bool page_evictable(struct page *page)
81 {
82         bool ret;
83
84         /* Prevent address_space of inode and swap cache from being freed */
85         rcu_read_lock();
86         ret = !mapping_unevictable(page_mapping(page)) && !PageMlocked(page);
87         rcu_read_unlock();
88         return ret;
89 }
90
91 /*
92  * Turn a non-refcounted page (->_refcount == 0) into refcounted with
93  * a count of one.
94  */
95 static inline void set_page_refcounted(struct page *page)
96 {
97         VM_BUG_ON_PAGE(PageTail(page), page);
98         VM_BUG_ON_PAGE(page_ref_count(page), page);
99         set_page_count(page, 1);
100 }
101
102 extern unsigned long highest_memmap_pfn;
103
104 /*
105  * Maximum number of reclaim retries without progress before the OOM
106  * killer is consider the only way forward.
107  */
108 #define MAX_RECLAIM_RETRIES 16
109
110 /*
111  * in mm/vmscan.c:
112  */
113 extern int isolate_lru_page(struct page *page);
114 extern void putback_lru_page(struct page *page);
115
116 /*
117  * in mm/rmap.c:
118  */
119 extern pmd_t *mm_find_pmd(struct mm_struct *mm, unsigned long address);
120
121 /*
122  * in mm/page_alloc.c
123  */
124
125 /*
126  * Structure for holding the mostly immutable allocation parameters passed
127  * between functions involved in allocations, including the alloc_pages*
128  * family of functions.
129  *
130  * nodemask, migratetype and high_zoneidx are initialized only once in
131  * __alloc_pages_nodemask() and then never change.
132  *
133  * zonelist, preferred_zone and classzone_idx are set first in
134  * __alloc_pages_nodemask() for the fast path, and might be later changed
135  * in __alloc_pages_slowpath(). All other functions pass the whole strucure
136  * by a const pointer.
137  */
138 struct alloc_context {
139         struct zonelist *zonelist;
140         nodemask_t *nodemask;
141         struct zoneref *preferred_zoneref;
142         int migratetype;
143         enum zone_type high_zoneidx;
144         bool spread_dirty_pages;
145 };
146
147 #define ac_classzone_idx(ac) zonelist_zone_idx(ac->preferred_zoneref)
148
149 /*
150  * Locate the struct page for both the matching buddy in our
151  * pair (buddy1) and the combined O(n+1) page they form (page).
152  *
153  * 1) Any buddy B1 will have an order O twin B2 which satisfies
154  * the following equation:
155  *     B2 = B1 ^ (1 << O)
156  * For example, if the starting buddy (buddy2) is #8 its order
157  * 1 buddy is #10:
158  *     B2 = 8 ^ (1 << 1) = 8 ^ 2 = 10
159  *
160  * 2) Any buddy B will have an order O+1 parent P which
161  * satisfies the following equation:
162  *     P = B & ~(1 << O)
163  *
164  * Assumption: *_mem_map is contiguous at least up to MAX_ORDER
165  */
166 static inline unsigned long
167 __find_buddy_pfn(unsigned long page_pfn, unsigned int order)
168 {
169         return page_pfn ^ (1 << order);
170 }
171
172 extern struct page *__pageblock_pfn_to_page(unsigned long start_pfn,
173                                 unsigned long end_pfn, struct zone *zone);
174
175 static inline struct page *pageblock_pfn_to_page(unsigned long start_pfn,
176                                 unsigned long end_pfn, struct zone *zone)
177 {
178         if (zone->contiguous)
179                 return pfn_to_page(start_pfn);
180
181         return __pageblock_pfn_to_page(start_pfn, end_pfn, zone);
182 }
183
184 extern int __isolate_free_page(struct page *page, unsigned int order);
185 extern void __putback_isolated_page(struct page *page, unsigned int order,
186                                     int mt);
187 extern void memblock_free_pages(struct page *page, unsigned long pfn,
188                                         unsigned int order);
189 extern void __free_pages_core(struct page *page, unsigned int order);
190 extern void prep_compound_page(struct page *page, unsigned int order);
191 extern void post_alloc_hook(struct page *page, unsigned int order,
192                                         gfp_t gfp_flags);
193 extern int user_min_free_kbytes;
194
195 extern void zone_pcp_update(struct zone *zone);
196 extern void zone_pcp_reset(struct zone *zone);
197
198 #if defined CONFIG_COMPACTION || defined CONFIG_CMA
199
200 /*
201  * in mm/compaction.c
202  */
203 /*
204  * compact_control is used to track pages being migrated and the free pages
205  * they are being migrated to during memory compaction. The free_pfn starts
206  * at the end of a zone and migrate_pfn begins at the start. Movable pages
207  * are moved to the end of a zone during a compaction run and the run
208  * completes when free_pfn <= migrate_pfn
209  */
210 struct compact_control {
211         struct list_head freepages;     /* List of free pages to migrate to */
212         struct list_head migratepages;  /* List of pages being migrated */
213         unsigned int nr_freepages;      /* Number of isolated free pages */
214         unsigned int nr_migratepages;   /* Number of pages to migrate */
215         unsigned long free_pfn;         /* isolate_freepages search base */
216         unsigned long migrate_pfn;      /* isolate_migratepages search base */
217         unsigned long fast_start_pfn;   /* a pfn to start linear scan from */
218         struct zone *zone;
219         unsigned long total_migrate_scanned;
220         unsigned long total_free_scanned;
221         unsigned short fast_search_fail;/* failures to use free list searches */
222         short search_order;             /* order to start a fast search at */
223         const gfp_t gfp_mask;           /* gfp mask of a direct compactor */
224         int order;                      /* order a direct compactor needs */
225         int migratetype;                /* migratetype of direct compactor */
226         const unsigned int alloc_flags; /* alloc flags of a direct compactor */
227         const int classzone_idx;        /* zone index of a direct compactor */
228         enum migrate_mode mode;         /* Async or sync migration mode */
229         bool ignore_skip_hint;          /* Scan blocks even if marked skip */
230         bool no_set_skip_hint;          /* Don't mark blocks for skipping */
231         bool ignore_block_suitable;     /* Scan blocks considered unsuitable */
232         bool direct_compaction;         /* False from kcompactd or /proc/... */
233         bool whole_zone;                /* Whole zone should/has been scanned */
234         bool contended;                 /* Signal lock or sched contention */
235         bool rescan;                    /* Rescanning the same pageblock */
236         bool alloc_contig;              /* alloc_contig_range allocation */
237 };
238
239 /*
240  * Used in direct compaction when a page should be taken from the freelists
241  * immediately when one is created during the free path.
242  */
243 struct capture_control {
244         struct compact_control *cc;
245         struct page *page;
246 };
247
248 unsigned long
249 isolate_freepages_range(struct compact_control *cc,
250                         unsigned long start_pfn, unsigned long end_pfn);
251 unsigned long
252 isolate_migratepages_range(struct compact_control *cc,
253                            unsigned long low_pfn, unsigned long end_pfn);
254 int find_suitable_fallback(struct free_area *area, unsigned int order,
255                         int migratetype, bool only_stealable, bool *can_steal);
256
257 #endif
258
259 /*
260  * This function returns the order of a free page in the buddy system. In
261  * general, page_zone(page)->lock must be held by the caller to prevent the
262  * page from being allocated in parallel and returning garbage as the order.
263  * If a caller does not hold page_zone(page)->lock, it must guarantee that the
264  * page cannot be allocated or merged in parallel. Alternatively, it must
265  * handle invalid values gracefully, and use page_order_unsafe() below.
266  */
267 static inline unsigned int page_order(struct page *page)
268 {
269         /* PageBuddy() must be checked by the caller */
270         return page_private(page);
271 }
272
273 /*
274  * Like page_order(), but for callers who cannot afford to hold the zone lock.
275  * PageBuddy() should be checked first by the caller to minimize race window,
276  * and invalid values must be handled gracefully.
277  *
278  * READ_ONCE is used so that if the caller assigns the result into a local
279  * variable and e.g. tests it for valid range before using, the compiler cannot
280  * decide to remove the variable and inline the page_private(page) multiple
281  * times, potentially observing different values in the tests and the actual
282  * use of the result.
283  */
284 #define page_order_unsafe(page)         READ_ONCE(page_private(page))
285
286 static inline bool is_cow_mapping(vm_flags_t flags)
287 {
288         return (flags & (VM_SHARED | VM_MAYWRITE)) == VM_MAYWRITE;
289 }
290
291 /*
292  * These three helpers classifies VMAs for virtual memory accounting.
293  */
294
295 /*
296  * Executable code area - executable, not writable, not stack
297  */
298 static inline bool is_exec_mapping(vm_flags_t flags)
299 {
300         return (flags & (VM_EXEC | VM_WRITE | VM_STACK)) == VM_EXEC;
301 }
302
303 /*
304  * Stack area - atomatically grows in one direction
305  *
306  * VM_GROWSUP / VM_GROWSDOWN VMAs are always private anonymous:
307  * do_mmap() forbids all other combinations.
308  */
309 static inline bool is_stack_mapping(vm_flags_t flags)
310 {
311         return (flags & VM_STACK) == VM_STACK;
312 }
313
314 /*
315  * Data area - private, writable, not stack
316  */
317 static inline bool is_data_mapping(vm_flags_t flags)
318 {
319         return (flags & (VM_WRITE | VM_SHARED | VM_STACK)) == VM_WRITE;
320 }
321
322 /* mm/util.c */
323 void __vma_link_list(struct mm_struct *mm, struct vm_area_struct *vma,
324                 struct vm_area_struct *prev);
325 void __vma_unlink_list(struct mm_struct *mm, struct vm_area_struct *vma);
326
327 #ifdef CONFIG_MMU
328 extern long populate_vma_page_range(struct vm_area_struct *vma,
329                 unsigned long start, unsigned long end, int *nonblocking);
330 extern void munlock_vma_pages_range(struct vm_area_struct *vma,
331                         unsigned long start, unsigned long end);
332 static inline void munlock_vma_pages_all(struct vm_area_struct *vma)
333 {
334         munlock_vma_pages_range(vma, vma->vm_start, vma->vm_end);
335 }
336
337 /*
338  * must be called with vma's mmap_sem held for read or write, and page locked.
339  */
340 extern void mlock_vma_page(struct page *page);
341 extern unsigned int munlock_vma_page(struct page *page);
342
343 /*
344  * Clear the page's PageMlocked().  This can be useful in a situation where
345  * we want to unconditionally remove a page from the pagecache -- e.g.,
346  * on truncation or freeing.
347  *
348  * It is legal to call this function for any page, mlocked or not.
349  * If called for a page that is still mapped by mlocked vmas, all we do
350  * is revert to lazy LRU behaviour -- semantics are not broken.
351  */
352 extern void clear_page_mlock(struct page *page);
353
354 /*
355  * mlock_migrate_page - called only from migrate_misplaced_transhuge_page()
356  * (because that does not go through the full procedure of migration ptes):
357  * to migrate the Mlocked page flag; update statistics.
358  */
359 static inline void mlock_migrate_page(struct page *newpage, struct page *page)
360 {
361         if (TestClearPageMlocked(page)) {
362                 int nr_pages = hpage_nr_pages(page);
363
364                 /* Holding pmd lock, no change in irq context: __mod is safe */
365                 __mod_zone_page_state(page_zone(page), NR_MLOCK, -nr_pages);
366                 SetPageMlocked(newpage);
367                 __mod_zone_page_state(page_zone(newpage), NR_MLOCK, nr_pages);
368         }
369 }
370
371 extern pmd_t maybe_pmd_mkwrite(pmd_t pmd, struct vm_area_struct *vma);
372
373 /*
374  * At what user virtual address is page expected in @vma?
375  */
376 static inline unsigned long
377 __vma_address(struct page *page, struct vm_area_struct *vma)
378 {
379         pgoff_t pgoff = page_to_pgoff(page);
380         return vma->vm_start + ((pgoff - vma->vm_pgoff) << PAGE_SHIFT);
381 }
382
383 static inline unsigned long
384 vma_address(struct page *page, struct vm_area_struct *vma)
385 {
386         unsigned long start, end;
387
388         start = __vma_address(page, vma);
389         end = start + PAGE_SIZE * (hpage_nr_pages(page) - 1);
390
391         /* page should be within @vma mapping range */
392         VM_BUG_ON_VMA(end < vma->vm_start || start >= vma->vm_end, vma);
393
394         return max(start, vma->vm_start);
395 }
396
397 static inline struct file *maybe_unlock_mmap_for_io(struct vm_fault *vmf,
398                                                     struct file *fpin)
399 {
400         int flags = vmf->flags;
401
402         if (fpin)
403                 return fpin;
404
405         /*
406          * FAULT_FLAG_RETRY_NOWAIT means we don't want to wait on page locks or
407          * anything, so we only pin the file and drop the mmap_sem if only
408          * FAULT_FLAG_ALLOW_RETRY is set, while this is the first attempt.
409          */
410         if (fault_flag_allow_retry_first(flags) &&
411             !(flags & FAULT_FLAG_RETRY_NOWAIT)) {
412                 fpin = get_file(vmf->vma->vm_file);
413                 up_read(&vmf->vma->vm_mm->mmap_sem);
414         }
415         return fpin;
416 }
417
418 #else /* !CONFIG_MMU */
419 static inline void clear_page_mlock(struct page *page) { }
420 static inline void mlock_vma_page(struct page *page) { }
421 static inline void mlock_migrate_page(struct page *new, struct page *old) { }
422
423 #endif /* !CONFIG_MMU */
424
425 /*
426  * Return the mem_map entry representing the 'offset' subpage within
427  * the maximally aligned gigantic page 'base'.  Handle any discontiguity
428  * in the mem_map at MAX_ORDER_NR_PAGES boundaries.
429  */
430 static inline struct page *mem_map_offset(struct page *base, int offset)
431 {
432         if (unlikely(offset >= MAX_ORDER_NR_PAGES))
433                 return nth_page(base, offset);
434         return base + offset;
435 }
436
437 /*
438  * Iterator over all subpages within the maximally aligned gigantic
439  * page 'base'.  Handle any discontiguity in the mem_map.
440  */
441 static inline struct page *mem_map_next(struct page *iter,
442                                                 struct page *base, int offset)
443 {
444         if (unlikely((offset & (MAX_ORDER_NR_PAGES - 1)) == 0)) {
445                 unsigned long pfn = page_to_pfn(base) + offset;
446                 if (!pfn_valid(pfn))
447                         return NULL;
448                 return pfn_to_page(pfn);
449         }
450         return iter + 1;
451 }
452
453 /* Memory initialisation debug and verification */
454 enum mminit_level {
455         MMINIT_WARNING,
456         MMINIT_VERIFY,
457         MMINIT_TRACE
458 };
459
460 #ifdef CONFIG_DEBUG_MEMORY_INIT
461
462 extern int mminit_loglevel;
463
464 #define mminit_dprintk(level, prefix, fmt, arg...) \
465 do { \
466         if (level < mminit_loglevel) { \
467                 if (level <= MMINIT_WARNING) \
468                         pr_warn("mminit::" prefix " " fmt, ##arg);      \
469                 else \
470                         printk(KERN_DEBUG "mminit::" prefix " " fmt, ##arg); \
471         } \
472 } while (0)
473
474 extern void mminit_verify_pageflags_layout(void);
475 extern void mminit_verify_zonelist(void);
476 #else
477
478 static inline void mminit_dprintk(enum mminit_level level,
479                                 const char *prefix, const char *fmt, ...)
480 {
481 }
482
483 static inline void mminit_verify_pageflags_layout(void)
484 {
485 }
486
487 static inline void mminit_verify_zonelist(void)
488 {
489 }
490 #endif /* CONFIG_DEBUG_MEMORY_INIT */
491
492 /* mminit_validate_memmodel_limits is independent of CONFIG_DEBUG_MEMORY_INIT */
493 #if defined(CONFIG_SPARSEMEM)
494 extern void mminit_validate_memmodel_limits(unsigned long *start_pfn,
495                                 unsigned long *end_pfn);
496 #else
497 static inline void mminit_validate_memmodel_limits(unsigned long *start_pfn,
498                                 unsigned long *end_pfn)
499 {
500 }
501 #endif /* CONFIG_SPARSEMEM */
502
503 #define NODE_RECLAIM_NOSCAN     -2
504 #define NODE_RECLAIM_FULL       -1
505 #define NODE_RECLAIM_SOME       0
506 #define NODE_RECLAIM_SUCCESS    1
507
508 #ifdef CONFIG_NUMA
509 extern int node_reclaim(struct pglist_data *, gfp_t, unsigned int);
510 #else
511 static inline int node_reclaim(struct pglist_data *pgdat, gfp_t mask,
512                                 unsigned int order)
513 {
514         return NODE_RECLAIM_NOSCAN;
515 }
516 #endif
517
518 extern int hwpoison_filter(struct page *p);
519
520 extern u32 hwpoison_filter_dev_major;
521 extern u32 hwpoison_filter_dev_minor;
522 extern u64 hwpoison_filter_flags_mask;
523 extern u64 hwpoison_filter_flags_value;
524 extern u64 hwpoison_filter_memcg;
525 extern u32 hwpoison_filter_enable;
526
527 extern unsigned long  __must_check vm_mmap_pgoff(struct file *, unsigned long,
528         unsigned long, unsigned long,
529         unsigned long, unsigned long);
530
531 extern void set_pageblock_order(void);
532 unsigned long reclaim_clean_pages_from_list(struct zone *zone,
533                                             struct list_head *page_list);
534 /* The ALLOC_WMARK bits are used as an index to zone->watermark */
535 #define ALLOC_WMARK_MIN         WMARK_MIN
536 #define ALLOC_WMARK_LOW         WMARK_LOW
537 #define ALLOC_WMARK_HIGH        WMARK_HIGH
538 #define ALLOC_NO_WATERMARKS     0x04 /* don't check watermarks at all */
539
540 /* Mask to get the watermark bits */
541 #define ALLOC_WMARK_MASK        (ALLOC_NO_WATERMARKS-1)
542
543 /*
544  * Only MMU archs have async oom victim reclaim - aka oom_reaper so we
545  * cannot assume a reduced access to memory reserves is sufficient for
546  * !MMU
547  */
548 #ifdef CONFIG_MMU
549 #define ALLOC_OOM               0x08
550 #else
551 #define ALLOC_OOM               ALLOC_NO_WATERMARKS
552 #endif
553
554 #define ALLOC_HARDER             0x10 /* try to alloc harder */
555 #define ALLOC_HIGH               0x20 /* __GFP_HIGH set */
556 #define ALLOC_CPUSET             0x40 /* check for correct cpuset */
557 #define ALLOC_CMA                0x80 /* allow allocations from CMA areas */
558 #ifdef CONFIG_ZONE_DMA32
559 #define ALLOC_NOFRAGMENT        0x100 /* avoid mixing pageblock types */
560 #else
561 #define ALLOC_NOFRAGMENT          0x0
562 #endif
563 #define ALLOC_KSWAPD            0x800 /* allow waking of kswapd, __GFP_KSWAPD_RECLAIM set */
564
565 enum ttu_flags;
566 struct tlbflush_unmap_batch;
567
568
569 /*
570  * only for MM internal work items which do not depend on
571  * any allocations or locks which might depend on allocations
572  */
573 extern struct workqueue_struct *mm_percpu_wq;
574
575 #ifdef CONFIG_ARCH_WANT_BATCHED_UNMAP_TLB_FLUSH
576 void try_to_unmap_flush(void);
577 void try_to_unmap_flush_dirty(void);
578 void flush_tlb_batched_pending(struct mm_struct *mm);
579 #else
580 static inline void try_to_unmap_flush(void)
581 {
582 }
583 static inline void try_to_unmap_flush_dirty(void)
584 {
585 }
586 static inline void flush_tlb_batched_pending(struct mm_struct *mm)
587 {
588 }
589 #endif /* CONFIG_ARCH_WANT_BATCHED_UNMAP_TLB_FLUSH */
590
591 extern const struct trace_print_flags pageflag_names[];
592 extern const struct trace_print_flags vmaflag_names[];
593 extern const struct trace_print_flags gfpflag_names[];
594
595 static inline bool is_migrate_highatomic(enum migratetype migratetype)
596 {
597         return migratetype == MIGRATE_HIGHATOMIC;
598 }
599
600 static inline bool is_migrate_highatomic_page(struct page *page)
601 {
602         return get_pageblock_migratetype(page) == MIGRATE_HIGHATOMIC;
603 }
604
605 void setup_zone_pageset(struct zone *zone);
606 extern struct page *alloc_new_node_page(struct page *page, unsigned long node);
607 #endif  /* __MM_INTERNAL_H */