mm: memcontrol: fix potential oom_lock recursion deadlock
[linux-block.git] / mm / internal.h
CommitLineData
2874c5fd 1/* SPDX-License-Identifier: GPL-2.0-or-later */
1da177e4
LT
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)
1da177e4 6 */
0f8053a5
NP
7#ifndef __MM_INTERNAL_H
8#define __MM_INTERNAL_H
9
29f175d1 10#include <linux/fs.h>
0f8053a5 11#include <linux/mm.h>
e9b61f19 12#include <linux/pagemap.h>
2aff7a47 13#include <linux/rmap.h>
edf14cdb 14#include <linux/tracepoint-defs.h>
1da177e4 15
0e499ed3
MWO
16struct folio_batch;
17
dd56b046
MG
18/*
19 * The set of flags that only affect watermark checking and reclaim
20 * behaviour. This is used by the MM to obey the caller constraints
21 * about IO, FS and watermark checking while ignoring placement
22 * hints such as HIGHMEM usage.
23 */
24#define GFP_RECLAIM_MASK (__GFP_RECLAIM|__GFP_HIGH|__GFP_IO|__GFP_FS|\
dcda9b04 25 __GFP_NOWARN|__GFP_RETRY_MAYFAIL|__GFP_NOFAIL|\
e838a45f 26 __GFP_NORETRY|__GFP_MEMALLOC|__GFP_NOMEMALLOC|\
704687de 27 __GFP_ATOMIC|__GFP_NOLOCKDEP)
dd56b046
MG
28
29/* The GFP flags allowed during early boot */
30#define GFP_BOOT_MASK (__GFP_BITS_MASK & ~(__GFP_RECLAIM|__GFP_IO|__GFP_FS))
31
32/* Control allocation cpuset and node placement constraints */
33#define GFP_CONSTRAINT_MASK (__GFP_HARDWALL|__GFP_THISNODE)
34
35/* Do not use these with a slab allocator */
36#define GFP_SLAB_BUG_MASK (__GFP_DMA32|__GFP_HIGHMEM|~__GFP_BITS_MASK)
37
3f913fc5
QZ
38/*
39 * Different from WARN_ON_ONCE(), no warning will be issued
40 * when we specify __GFP_NOWARN.
41 */
42#define WARN_ON_ONCE_GFP(cond, gfp) ({ \
43 static bool __section(".data.once") __warned; \
44 int __ret_warn_once = !!(cond); \
45 \
46 if (unlikely(!(gfp & __GFP_NOWARN) && __ret_warn_once && !__warned)) { \
47 __warned = true; \
48 WARN_ON(1); \
49 } \
50 unlikely(__ret_warn_once); \
51})
52
62906027
NP
53void page_writeback_init(void);
54
64601000
MWO
55static inline void *folio_raw_mapping(struct folio *folio)
56{
57 unsigned long mapping = (unsigned long)folio->mapping;
58
59 return (void *)(mapping & ~PAGE_MAPPING_FLAGS);
60}
61
512b7931 62void __acct_reclaim_writeback(pg_data_t *pgdat, struct folio *folio,
8cd7c588 63 int nr_throttled);
512b7931 64static inline void acct_reclaim_writeback(struct folio *folio)
8cd7c588 65{
512b7931 66 pg_data_t *pgdat = folio_pgdat(folio);
8cd7c588
MG
67 int nr_throttled = atomic_read(&pgdat->nr_writeback_throttled);
68
69 if (nr_throttled)
512b7931 70 __acct_reclaim_writeback(pgdat, folio, nr_throttled);
8cd7c588
MG
71}
72
d818fca1
MG
73static inline void wake_throttle_isolated(pg_data_t *pgdat)
74{
75 wait_queue_head_t *wqh;
76
77 wqh = &pgdat->reclaim_wait[VMSCAN_THROTTLE_ISOLATED];
78 if (waitqueue_active(wqh))
79 wake_up(wqh);
80}
81
2b740303 82vm_fault_t do_swap_page(struct vm_fault *vmf);
575ced1c 83void folio_rotate_reclaimable(struct folio *folio);
269ccca3 84bool __folio_end_writeback(struct folio *folio);
261b6840 85void deactivate_file_folio(struct folio *folio);
8a966ed7 86
42b77728
JB
87void free_pgtables(struct mmu_gather *tlb, struct vm_area_struct *start_vma,
88 unsigned long floor, unsigned long ceiling);
03c4f204 89void pmd_install(struct mm_struct *mm, pmd_t *pmd, pgtable_t *pte);
42b77728 90
3506659e 91struct zap_details;
aac45363
MH
92void unmap_page_range(struct mmu_gather *tlb,
93 struct vm_area_struct *vma,
94 unsigned long addr, unsigned long end,
95 struct zap_details *details);
96
56a4d67c
MWO
97void page_cache_ra_order(struct readahead_control *, struct file_ra_state *,
98 unsigned int order);
fcd9ae4f 99void force_page_cache_ra(struct readahead_control *, unsigned long nr);
7b3df3b9
DH
100static inline void force_page_cache_readahead(struct address_space *mapping,
101 struct file *file, pgoff_t index, unsigned long nr_to_read)
102{
fcd9ae4f
MWO
103 DEFINE_READAHEAD(ractl, file, &file->f_ra, mapping, index);
104 force_page_cache_ra(&ractl, nr_to_read);
7b3df3b9 105}
29f175d1 106
5c211ba2 107unsigned find_lock_entries(struct address_space *mapping, pgoff_t start,
51dcbdac 108 pgoff_t end, struct folio_batch *fbatch, pgoff_t *indices);
0e499ed3
MWO
109unsigned find_get_entries(struct address_space *mapping, pgoff_t start,
110 pgoff_t end, struct folio_batch *fbatch, pgoff_t *indices);
78f42660 111void filemap_free_folio(struct address_space *mapping, struct folio *folio);
1e84a3d9 112int truncate_inode_folio(struct address_space *mapping, struct folio *folio);
b9a8a419
MWO
113bool truncate_inode_partial_folio(struct folio *folio, loff_t start,
114 loff_t end);
d6c75dc2 115long invalidate_inode_page(struct page *page);
c56109dd
MWO
116unsigned long invalidate_mapping_pagevec(struct address_space *mapping,
117 pgoff_t start, pgoff_t end, unsigned long *nr_pagevec);
5c211ba2 118
1eb6234e 119/**
3eed3ef5
MWO
120 * folio_evictable - Test whether a folio is evictable.
121 * @folio: The folio to test.
1eb6234e 122 *
3eed3ef5
MWO
123 * Test whether @folio is evictable -- i.e., should be placed on
124 * active/inactive lists vs unevictable list.
1eb6234e 125 *
3eed3ef5
MWO
126 * Reasons folio might not be evictable:
127 * 1. folio's mapping marked unevictable
128 * 2. One of the pages in the folio is part of an mlocked VMA
1eb6234e 129 */
3eed3ef5
MWO
130static inline bool folio_evictable(struct folio *folio)
131{
132 bool ret;
133
134 /* Prevent address_space of inode and swap cache from being freed */
135 rcu_read_lock();
136 ret = !mapping_unevictable(folio_mapping(folio)) &&
137 !folio_test_mlocked(folio);
138 rcu_read_unlock();
139 return ret;
140}
141
1eb6234e
YS
142static inline bool page_evictable(struct page *page)
143{
144 bool ret;
145
146 /* Prevent address_space of inode and swap cache from being freed */
147 rcu_read_lock();
148 ret = !mapping_unevictable(page_mapping(page)) && !PageMlocked(page);
149 rcu_read_unlock();
150 return ret;
151}
152
7835e98b 153/*
0139aa7b 154 * Turn a non-refcounted page (->_refcount == 0) into refcounted with
7835e98b
NP
155 * a count of one.
156 */
157static inline void set_page_refcounted(struct page *page)
158{
309381fe 159 VM_BUG_ON_PAGE(PageTail(page), page);
fe896d18 160 VM_BUG_ON_PAGE(page_ref_count(page), page);
77a8a788 161 set_page_count(page, 1);
77a8a788
NP
162}
163
03f6462a
HD
164extern unsigned long highest_memmap_pfn;
165
c73322d0
JW
166/*
167 * Maximum number of reclaim retries without progress before the OOM
168 * killer is consider the only way forward.
169 */
170#define MAX_RECLAIM_RETRIES 16
171
be4893d9
VB
172/*
173 * in mm/early_ioremap.c
174 */
175pgprot_t __init early_memremap_pgprot_adjust(resource_size_t phys_addr,
176 unsigned long size, pgprot_t prot);
177
894bc310
LS
178/*
179 * in mm/vmscan.c:
180 */
d1d8a3b4
MWO
181int isolate_lru_page(struct page *page);
182int folio_isolate_lru(struct folio *folio);
ca6d60f3
MWO
183void putback_lru_page(struct page *page);
184void folio_putback_lru(struct folio *folio);
c3f4a9a2 185extern void reclaim_throttle(pg_data_t *pgdat, enum vmscan_throttle_state reason);
62695a84 186
6219049a
BL
187/*
188 * in mm/rmap.c:
189 */
190extern pmd_t *mm_find_pmd(struct mm_struct *mm, unsigned long address);
191
894bc310
LS
192/*
193 * in mm/page_alloc.c
194 */
3c605096 195
1a6d53a1
VB
196/*
197 * Structure for holding the mostly immutable allocation parameters passed
198 * between functions involved in allocations, including the alloc_pages*
199 * family of functions.
200 *
97a225e6 201 * nodemask, migratetype and highest_zoneidx are initialized only once in
84172f4b 202 * __alloc_pages() and then never change.
1a6d53a1 203 *
97a225e6 204 * zonelist, preferred_zone and highest_zoneidx are set first in
84172f4b 205 * __alloc_pages() for the fast path, and might be later changed
68956ccb 206 * in __alloc_pages_slowpath(). All other functions pass the whole structure
1a6d53a1
VB
207 * by a const pointer.
208 */
209struct alloc_context {
210 struct zonelist *zonelist;
211 nodemask_t *nodemask;
c33d6c06 212 struct zoneref *preferred_zoneref;
1a6d53a1 213 int migratetype;
97a225e6
JK
214
215 /*
216 * highest_zoneidx represents highest usable zone index of
217 * the allocation request. Due to the nature of the zone,
218 * memory on lower zone than the highest_zoneidx will be
219 * protected by lowmem_reserve[highest_zoneidx].
220 *
221 * highest_zoneidx is also used by reclaim/compaction to limit
222 * the target zone since higher zone than this index cannot be
223 * usable for this allocation request.
224 */
225 enum zone_type highest_zoneidx;
c9ab0c4f 226 bool spread_dirty_pages;
1a6d53a1
VB
227};
228
8170ac47
ZY
229/*
230 * This function returns the order of a free page in the buddy system. In
231 * general, page_zone(page)->lock must be held by the caller to prevent the
232 * page from being allocated in parallel and returning garbage as the order.
233 * If a caller does not hold page_zone(page)->lock, it must guarantee that the
234 * page cannot be allocated or merged in parallel. Alternatively, it must
235 * handle invalid values gracefully, and use buddy_order_unsafe() below.
236 */
237static inline unsigned int buddy_order(struct page *page)
238{
239 /* PageBuddy() must be checked by the caller */
240 return page_private(page);
241}
242
243/*
244 * Like buddy_order(), but for callers who cannot afford to hold the zone lock.
245 * PageBuddy() should be checked first by the caller to minimize race window,
246 * and invalid values must be handled gracefully.
247 *
248 * READ_ONCE is used so that if the caller assigns the result into a local
249 * variable and e.g. tests it for valid range before using, the compiler cannot
250 * decide to remove the variable and inline the page_private(page) multiple
251 * times, potentially observing different values in the tests and the actual
252 * use of the result.
253 */
254#define buddy_order_unsafe(page) READ_ONCE(page_private(page))
255
256/*
257 * This function checks whether a page is free && is the buddy
258 * we can coalesce a page and its buddy if
259 * (a) the buddy is not in a hole (check before calling!) &&
260 * (b) the buddy is in the buddy system &&
261 * (c) a page and its buddy have the same order &&
262 * (d) a page and its buddy are in the same zone.
263 *
264 * For recording whether a page is in the buddy system, we set PageBuddy.
265 * Setting, clearing, and testing PageBuddy is serialized by zone->lock.
266 *
267 * For recording page's order, we use page_private(page).
268 */
269static inline bool page_is_buddy(struct page *page, struct page *buddy,
270 unsigned int order)
271{
272 if (!page_is_guard(buddy) && !PageBuddy(buddy))
273 return false;
274
275 if (buddy_order(buddy) != order)
276 return false;
277
278 /*
279 * zone check is done late to avoid uselessly calculating
280 * zone/node ids for pages that could never merge.
281 */
282 if (page_zone_id(page) != page_zone_id(buddy))
283 return false;
284
285 VM_BUG_ON_PAGE(page_count(buddy) != 0, buddy);
286
287 return true;
288}
289
3c605096
JK
290/*
291 * Locate the struct page for both the matching buddy in our
292 * pair (buddy1) and the combined O(n+1) page they form (page).
293 *
294 * 1) Any buddy B1 will have an order O twin B2 which satisfies
295 * the following equation:
296 * B2 = B1 ^ (1 << O)
297 * For example, if the starting buddy (buddy2) is #8 its order
298 * 1 buddy is #10:
299 * B2 = 8 ^ (1 << 1) = 8 ^ 2 = 10
300 *
301 * 2) Any buddy B will have an order O+1 parent P which
302 * satisfies the following equation:
303 * P = B & ~(1 << O)
304 *
305 * Assumption: *_mem_map is contiguous at least up to MAX_ORDER
306 */
307static inline unsigned long
76741e77 308__find_buddy_pfn(unsigned long page_pfn, unsigned int order)
3c605096 309{
76741e77 310 return page_pfn ^ (1 << order);
3c605096
JK
311}
312
8170ac47
ZY
313/*
314 * Find the buddy of @page and validate it.
315 * @page: The input page
316 * @pfn: The pfn of the page, it saves a call to page_to_pfn() when the
317 * function is used in the performance-critical __free_one_page().
318 * @order: The order of the page
319 * @buddy_pfn: The output pointer to the buddy pfn, it also saves a call to
320 * page_to_pfn().
321 *
322 * The found buddy can be a non PageBuddy, out of @page's zone, or its order is
323 * not the same as @page. The validation is necessary before use it.
324 *
325 * Return: the found buddy page or NULL if not found.
326 */
327static inline struct page *find_buddy_page_pfn(struct page *page,
328 unsigned long pfn, unsigned int order, unsigned long *buddy_pfn)
329{
330 unsigned long __buddy_pfn = __find_buddy_pfn(pfn, order);
331 struct page *buddy;
332
333 buddy = page + (__buddy_pfn - pfn);
334 if (buddy_pfn)
335 *buddy_pfn = __buddy_pfn;
336
337 if (page_is_buddy(page, buddy, order))
338 return buddy;
339 return NULL;
340}
341
7cf91a98
JK
342extern struct page *__pageblock_pfn_to_page(unsigned long start_pfn,
343 unsigned long end_pfn, struct zone *zone);
344
345static inline struct page *pageblock_pfn_to_page(unsigned long start_pfn,
346 unsigned long end_pfn, struct zone *zone)
347{
348 if (zone->contiguous)
349 return pfn_to_page(start_pfn);
350
351 return __pageblock_pfn_to_page(start_pfn, end_pfn, zone);
352}
353
3c605096 354extern int __isolate_free_page(struct page *page, unsigned int order);
624f58d8
AD
355extern void __putback_isolated_page(struct page *page, unsigned int order,
356 int mt);
7c2ee349 357extern void memblock_free_pages(struct page *page, unsigned long pfn,
d70ddd7a 358 unsigned int order);
a9cd410a 359extern void __free_pages_core(struct page *page, unsigned int order);
d00181b9 360extern void prep_compound_page(struct page *page, unsigned int order);
46f24fd8
JK
361extern void post_alloc_hook(struct page *page, unsigned int order,
362 gfp_t gfp_flags);
42aa83cb 363extern int user_min_free_kbytes;
20a0307c 364
44042b44 365extern void free_unref_page(struct page *page, unsigned int order);
0966aeb4
MWO
366extern void free_unref_page_list(struct list_head *list);
367
04f8cfea 368extern void zone_pcp_update(struct zone *zone, int cpu_online);
68265390 369extern void zone_pcp_reset(struct zone *zone);
ec6e8c7e
VB
370extern void zone_pcp_disable(struct zone *zone);
371extern void zone_pcp_enable(struct zone *zone);
68265390 372
c803b3c8
MR
373extern void *memmap_alloc(phys_addr_t size, phys_addr_t align,
374 phys_addr_t min_addr,
375 int nid, bool exact_nid);
376
86d28b07
ZY
377int split_free_page(struct page *free_page,
378 unsigned int order, unsigned long split_pfn_offset);
b2c9e2fb 379
ff9543fd
MN
380#if defined CONFIG_COMPACTION || defined CONFIG_CMA
381
382/*
383 * in mm/compaction.c
384 */
385/*
386 * compact_control is used to track pages being migrated and the free pages
387 * they are being migrated to during memory compaction. The free_pfn starts
388 * at the end of a zone and migrate_pfn begins at the start. Movable pages
389 * are moved to the end of a zone during a compaction run and the run
390 * completes when free_pfn <= migrate_pfn
391 */
392struct compact_control {
393 struct list_head freepages; /* List of free pages to migrate to */
394 struct list_head migratepages; /* List of pages being migrated */
c5fbd937
MG
395 unsigned int nr_freepages; /* Number of isolated free pages */
396 unsigned int nr_migratepages; /* Number of pages to migrate */
ff9543fd 397 unsigned long free_pfn; /* isolate_freepages search base */
c2ad7a1f
OS
398 /*
399 * Acts as an in/out parameter to page isolation for migration.
400 * isolate_migratepages uses it as a search base.
401 * isolate_migratepages_block will update the value to the next pfn
402 * after the last isolated one.
403 */
404 unsigned long migrate_pfn;
70b44595 405 unsigned long fast_start_pfn; /* a pfn to start linear scan from */
c5943b9c
MG
406 struct zone *zone;
407 unsigned long total_migrate_scanned;
408 unsigned long total_free_scanned;
dbe2d4e4
MG
409 unsigned short fast_search_fail;/* failures to use free list searches */
410 short search_order; /* order to start a fast search at */
f25ba6dc
VB
411 const gfp_t gfp_mask; /* gfp mask of a direct compactor */
412 int order; /* order a direct compactor needs */
d39773a0 413 int migratetype; /* migratetype of direct compactor */
f25ba6dc 414 const unsigned int alloc_flags; /* alloc flags of a direct compactor */
97a225e6 415 const int highest_zoneidx; /* zone index of a direct compactor */
e0b9daeb 416 enum migrate_mode mode; /* Async or sync migration mode */
bb13ffeb 417 bool ignore_skip_hint; /* Scan blocks even if marked skip */
2583d671 418 bool no_set_skip_hint; /* Don't mark blocks for skipping */
9f7e3387 419 bool ignore_block_suitable; /* Scan blocks considered unsuitable */
accf6242 420 bool direct_compaction; /* False from kcompactd or /proc/... */
facdaa91 421 bool proactive_compaction; /* kcompactd proactive compaction */
06ed2998 422 bool whole_zone; /* Whole zone should/has been scanned */
d56c1584 423 bool contended; /* Signal lock contention */
804d3121 424 bool rescan; /* Rescanning the same pageblock */
b06eda09 425 bool alloc_contig; /* alloc_contig_range allocation */
ff9543fd
MN
426};
427
5e1f0f09
MG
428/*
429 * Used in direct compaction when a page should be taken from the freelists
430 * immediately when one is created during the free path.
431 */
432struct capture_control {
433 struct compact_control *cc;
434 struct page *page;
435};
436
ff9543fd 437unsigned long
bb13ffeb
MG
438isolate_freepages_range(struct compact_control *cc,
439 unsigned long start_pfn, unsigned long end_pfn);
c2ad7a1f 440int
edc2ca61
VB
441isolate_migratepages_range(struct compact_control *cc,
442 unsigned long low_pfn, unsigned long end_pfn);
b2c9e2fb
ZY
443
444int __alloc_contig_migrate_range(struct compact_control *cc,
445 unsigned long start, unsigned long end);
ffd8f251 446#endif
2149cdae
JK
447int find_suitable_fallback(struct free_area *area, unsigned int order,
448 int migratetype, bool only_stealable, bool *can_steal);
ff9543fd 449
30bdbb78
KK
450/*
451 * These three helpers classifies VMAs for virtual memory accounting.
452 */
453
454/*
455 * Executable code area - executable, not writable, not stack
456 */
d977d56c
KK
457static inline bool is_exec_mapping(vm_flags_t flags)
458{
30bdbb78 459 return (flags & (VM_EXEC | VM_WRITE | VM_STACK)) == VM_EXEC;
d977d56c
KK
460}
461
30bdbb78 462/*
f0953a1b 463 * Stack area - automatically grows in one direction
30bdbb78
KK
464 *
465 * VM_GROWSUP / VM_GROWSDOWN VMAs are always private anonymous:
466 * do_mmap() forbids all other combinations.
467 */
d977d56c
KK
468static inline bool is_stack_mapping(vm_flags_t flags)
469{
30bdbb78 470 return (flags & VM_STACK) == VM_STACK;
d977d56c
KK
471}
472
30bdbb78
KK
473/*
474 * Data area - private, writable, not stack
475 */
d977d56c
KK
476static inline bool is_data_mapping(vm_flags_t flags)
477{
30bdbb78 478 return (flags & (VM_WRITE | VM_SHARED | VM_STACK)) == VM_WRITE;
d977d56c
KK
479}
480
6038def0
NK
481/* mm/util.c */
482void __vma_link_list(struct mm_struct *mm, struct vm_area_struct *vma,
aba6dfb7 483 struct vm_area_struct *prev);
1b9fc5b2 484void __vma_unlink_list(struct mm_struct *mm, struct vm_area_struct *vma);
e05b3453 485struct anon_vma *folio_anon_vma(struct folio *folio);
6038def0 486
af8e3354 487#ifdef CONFIG_MMU
3506659e 488void unmap_mapping_folio(struct folio *folio);
fc05f566 489extern long populate_vma_page_range(struct vm_area_struct *vma,
a78f1ccd 490 unsigned long start, unsigned long end, int *locked);
4ca9b385
DH
491extern long faultin_vma_page_range(struct vm_area_struct *vma,
492 unsigned long start, unsigned long end,
493 bool write, int *locked);
6aeb2542
MR
494extern int mlock_future_check(struct mm_struct *mm, unsigned long flags,
495 unsigned long len);
b291f000 496/*
cea86fe2
HD
497 * mlock_vma_page() and munlock_vma_page():
498 * should be called with vma's mmap_lock held for read or write,
499 * under page table lock for the pte/pmd being added or removed.
b291f000 500 *
cea86fe2
HD
501 * mlock is usually called at the end of page_add_*_rmap(),
502 * munlock at the end of page_remove_rmap(); but new anon
2fbb0c10
HD
503 * pages are managed by lru_cache_add_inactive_or_unevictable()
504 * calling mlock_new_page().
cea86fe2
HD
505 *
506 * @compound is used to include pmd mappings of THPs, but filter out
507 * pte mappings of THPs, which cannot be consistently counted: a pte
508 * mapping of the THP head cannot be distinguished by the page alone.
b291f000 509 */
dcc5d337
MWO
510void mlock_folio(struct folio *folio);
511static inline void mlock_vma_folio(struct folio *folio,
cea86fe2
HD
512 struct vm_area_struct *vma, bool compound)
513{
c8263bd6
HD
514 /*
515 * The VM_SPECIAL check here serves two purposes.
516 * 1) VM_IO check prevents migration from double-counting during mlock.
517 * 2) Although mmap_region() and mlock_fixup() take care that VM_LOCKED
518 * is never left set on a VM_SPECIAL vma, there is an interval while
519 * file->f_op->mmap() is using vm_insert_page(s), when VM_LOCKED may
520 * still be set while VM_SPECIAL bits are added: so ignore it then.
521 */
522 if (unlikely((vma->vm_flags & (VM_LOCKED|VM_SPECIAL)) == VM_LOCKED) &&
dcc5d337
MWO
523 (compound || !folio_test_large(folio)))
524 mlock_folio(folio);
525}
526
527static inline void mlock_vma_page(struct page *page,
528 struct vm_area_struct *vma, bool compound)
529{
530 mlock_vma_folio(page_folio(page), vma, compound);
cea86fe2 531}
dcc5d337 532
cea86fe2
HD
533void munlock_page(struct page *page);
534static inline void munlock_vma_page(struct page *page,
535 struct vm_area_struct *vma, bool compound)
536{
537 if (unlikely(vma->vm_flags & VM_LOCKED) &&
538 (compound || !PageTransCompound(page)))
539 munlock_page(page);
540}
2fbb0c10
HD
541void mlock_new_page(struct page *page);
542bool need_mlock_page_drain(int cpu);
adb11e78
SAS
543void mlock_page_drain_local(void);
544void mlock_page_drain_remote(int cpu);
b291f000 545
f55e1014 546extern pmd_t maybe_pmd_mkwrite(pmd_t pmd, struct vm_area_struct *vma);
b32967ff 547
e9b61f19 548/*
6a8e0596
MS
549 * Return the start of user virtual address at the specific offset within
550 * a vma.
e9b61f19
KS
551 */
552static inline unsigned long
6a8e0596
MS
553vma_pgoff_address(pgoff_t pgoff, unsigned long nr_pages,
554 struct vm_area_struct *vma)
e9b61f19 555{
494334e4
HD
556 unsigned long address;
557
494334e4
HD
558 if (pgoff >= vma->vm_pgoff) {
559 address = vma->vm_start +
560 ((pgoff - vma->vm_pgoff) << PAGE_SHIFT);
561 /* Check for address beyond vma (or wrapped through 0?) */
562 if (address < vma->vm_start || address >= vma->vm_end)
563 address = -EFAULT;
6a8e0596 564 } else if (pgoff + nr_pages - 1 >= vma->vm_pgoff) {
494334e4
HD
565 /* Test above avoids possibility of wrap to 0 on 32-bit */
566 address = vma->vm_start;
567 } else {
568 address = -EFAULT;
569 }
570 return address;
e9b61f19
KS
571}
572
6a8e0596
MS
573/*
574 * Return the start of user virtual address of a page within a vma.
575 * Returns -EFAULT if all of the page is outside the range of vma.
576 * If page is a compound head, the entire compound page is considered.
577 */
578static inline unsigned long
579vma_address(struct page *page, struct vm_area_struct *vma)
580{
581 VM_BUG_ON_PAGE(PageKsm(page), page); /* KSM page->index unusable */
582 return vma_pgoff_address(page_to_pgoff(page), compound_nr(page), vma);
583}
584
494334e4 585/*
2aff7a47 586 * Then at what user virtual address will none of the range be found in vma?
494334e4 587 * Assumes that vma_address() already returned a good starting address.
494334e4 588 */
2aff7a47 589static inline unsigned long vma_address_end(struct page_vma_mapped_walk *pvmw)
e9b61f19 590{
2aff7a47 591 struct vm_area_struct *vma = pvmw->vma;
494334e4
HD
592 pgoff_t pgoff;
593 unsigned long address;
594
2aff7a47
MWO
595 /* Common case, plus ->pgoff is invalid for KSM */
596 if (pvmw->nr_pages == 1)
597 return pvmw->address + PAGE_SIZE;
598
599 pgoff = pvmw->pgoff + pvmw->nr_pages;
494334e4
HD
600 address = vma->vm_start + ((pgoff - vma->vm_pgoff) << PAGE_SHIFT);
601 /* Check for address beyond vma (or wrapped through 0?) */
602 if (address < vma->vm_start || address > vma->vm_end)
603 address = vma->vm_end;
604 return address;
e9b61f19
KS
605}
606
89b15332
JW
607static inline struct file *maybe_unlock_mmap_for_io(struct vm_fault *vmf,
608 struct file *fpin)
609{
610 int flags = vmf->flags;
611
612 if (fpin)
613 return fpin;
614
615 /*
616 * FAULT_FLAG_RETRY_NOWAIT means we don't want to wait on page locks or
c1e8d7c6 617 * anything, so we only pin the file and drop the mmap_lock if only
4064b982 618 * FAULT_FLAG_ALLOW_RETRY is set, while this is the first attempt.
89b15332 619 */
4064b982
PX
620 if (fault_flag_allow_retry_first(flags) &&
621 !(flags & FAULT_FLAG_RETRY_NOWAIT)) {
89b15332 622 fpin = get_file(vmf->vma->vm_file);
d8ed45c5 623 mmap_read_unlock(vmf->vma->vm_mm);
89b15332
JW
624 }
625 return fpin;
626}
af8e3354 627#else /* !CONFIG_MMU */
3506659e 628static inline void unmap_mapping_folio(struct folio *folio) { }
cea86fe2
HD
629static inline void mlock_vma_page(struct page *page,
630 struct vm_area_struct *vma, bool compound) { }
631static inline void munlock_vma_page(struct page *page,
632 struct vm_area_struct *vma, bool compound) { }
2fbb0c10
HD
633static inline void mlock_new_page(struct page *page) { }
634static inline bool need_mlock_page_drain(int cpu) { return false; }
adb11e78
SAS
635static inline void mlock_page_drain_local(void) { }
636static inline void mlock_page_drain_remote(int cpu) { }
4ad0ae8c
NP
637static inline void vunmap_range_noflush(unsigned long start, unsigned long end)
638{
639}
af8e3354 640#endif /* !CONFIG_MMU */
894bc310 641
69d177c2
AW
642/*
643 * Return the mem_map entry representing the 'offset' subpage within
644 * the maximally aligned gigantic page 'base'. Handle any discontiguity
645 * in the mem_map at MAX_ORDER_NR_PAGES boundaries.
646 */
647static inline struct page *mem_map_offset(struct page *base, int offset)
648{
649 if (unlikely(offset >= MAX_ORDER_NR_PAGES))
bc7f84c0 650 return nth_page(base, offset);
69d177c2
AW
651 return base + offset;
652}
653
654/*
25985edc 655 * Iterator over all subpages within the maximally aligned gigantic
69d177c2
AW
656 * page 'base'. Handle any discontiguity in the mem_map.
657 */
658static inline struct page *mem_map_next(struct page *iter,
659 struct page *base, int offset)
660{
661 if (unlikely((offset & (MAX_ORDER_NR_PAGES - 1)) == 0)) {
662 unsigned long pfn = page_to_pfn(base) + offset;
663 if (!pfn_valid(pfn))
664 return NULL;
665 return pfn_to_page(pfn);
666 }
667 return iter + 1;
668}
669
6b74ab97
MG
670/* Memory initialisation debug and verification */
671enum mminit_level {
672 MMINIT_WARNING,
673 MMINIT_VERIFY,
674 MMINIT_TRACE
675};
676
677#ifdef CONFIG_DEBUG_MEMORY_INIT
678
679extern int mminit_loglevel;
680
681#define mminit_dprintk(level, prefix, fmt, arg...) \
682do { \
683 if (level < mminit_loglevel) { \
fc5199d1 684 if (level <= MMINIT_WARNING) \
1170532b 685 pr_warn("mminit::" prefix " " fmt, ##arg); \
fc5199d1
RV
686 else \
687 printk(KERN_DEBUG "mminit::" prefix " " fmt, ##arg); \
6b74ab97
MG
688 } \
689} while (0)
690
708614e6 691extern void mminit_verify_pageflags_layout(void);
68ad8df4 692extern void mminit_verify_zonelist(void);
6b74ab97
MG
693#else
694
695static inline void mminit_dprintk(enum mminit_level level,
696 const char *prefix, const char *fmt, ...)
697{
698}
699
708614e6
MG
700static inline void mminit_verify_pageflags_layout(void)
701{
702}
703
68ad8df4
MG
704static inline void mminit_verify_zonelist(void)
705{
706}
6b74ab97 707#endif /* CONFIG_DEBUG_MEMORY_INIT */
2dbb51c4 708
a5f5f91d
MG
709#define NODE_RECLAIM_NOSCAN -2
710#define NODE_RECLAIM_FULL -1
711#define NODE_RECLAIM_SOME 0
712#define NODE_RECLAIM_SUCCESS 1
7c116f2b 713
8b09549c
WY
714#ifdef CONFIG_NUMA
715extern int node_reclaim(struct pglist_data *, gfp_t, unsigned int);
79c28a41 716extern int find_next_best_node(int node, nodemask_t *used_node_mask);
8b09549c
WY
717#else
718static inline int node_reclaim(struct pglist_data *pgdat, gfp_t mask,
719 unsigned int order)
720{
721 return NODE_RECLAIM_NOSCAN;
722}
79c28a41
DH
723static inline int find_next_best_node(int node, nodemask_t *used_node_mask)
724{
725 return NUMA_NO_NODE;
726}
8b09549c
WY
727#endif
728
60f272f6 729/*
730 * mm/memory-failure.c
731 */
31d3d348
WF
732extern int hwpoison_filter(struct page *p);
733
7c116f2b
WF
734extern u32 hwpoison_filter_dev_major;
735extern u32 hwpoison_filter_dev_minor;
478c5ffc
WF
736extern u64 hwpoison_filter_flags_mask;
737extern u64 hwpoison_filter_flags_value;
4fd466eb 738extern u64 hwpoison_filter_memcg;
1bfe5feb 739extern u32 hwpoison_filter_enable;
eb36c587 740
60f272f6 741#ifdef CONFIG_MEMORY_FAILURE
742void clear_hwpoisoned_pages(struct page *memmap, int nr_pages);
743#else
744static inline void clear_hwpoisoned_pages(struct page *memmap, int nr_pages)
745{
746}
747#endif
748
dc0ef0df 749extern unsigned long __must_check vm_mmap_pgoff(struct file *, unsigned long,
eb36c587 750 unsigned long, unsigned long,
9fbeb5ab 751 unsigned long, unsigned long);
ca57df79
XQ
752
753extern void set_pageblock_order(void);
730ec8c0 754unsigned int reclaim_clean_pages_from_list(struct zone *zone,
02c6de8d 755 struct list_head *page_list);
d95ea5d1
BZ
756/* The ALLOC_WMARK bits are used as an index to zone->watermark */
757#define ALLOC_WMARK_MIN WMARK_MIN
758#define ALLOC_WMARK_LOW WMARK_LOW
759#define ALLOC_WMARK_HIGH WMARK_HIGH
760#define ALLOC_NO_WATERMARKS 0x04 /* don't check watermarks at all */
761
762/* Mask to get the watermark bits */
763#define ALLOC_WMARK_MASK (ALLOC_NO_WATERMARKS-1)
764
cd04ae1e
MH
765/*
766 * Only MMU archs have async oom victim reclaim - aka oom_reaper so we
767 * cannot assume a reduced access to memory reserves is sufficient for
768 * !MMU
769 */
770#ifdef CONFIG_MMU
771#define ALLOC_OOM 0x08
772#else
773#define ALLOC_OOM ALLOC_NO_WATERMARKS
774#endif
775
6bb15450
MG
776#define ALLOC_HARDER 0x10 /* try to alloc harder */
777#define ALLOC_HIGH 0x20 /* __GFP_HIGH set */
778#define ALLOC_CPUSET 0x40 /* check for correct cpuset */
779#define ALLOC_CMA 0x80 /* allow allocations from CMA areas */
780#ifdef CONFIG_ZONE_DMA32
781#define ALLOC_NOFRAGMENT 0x100 /* avoid mixing pageblock types */
782#else
783#define ALLOC_NOFRAGMENT 0x0
784#endif
736838e9 785#define ALLOC_KSWAPD 0x800 /* allow waking of kswapd, __GFP_KSWAPD_RECLAIM set */
d95ea5d1 786
72b252ae
MG
787enum ttu_flags;
788struct tlbflush_unmap_batch;
789
ce612879
MH
790
791/*
792 * only for MM internal work items which do not depend on
793 * any allocations or locks which might depend on allocations
794 */
795extern struct workqueue_struct *mm_percpu_wq;
796
72b252ae
MG
797#ifdef CONFIG_ARCH_WANT_BATCHED_UNMAP_TLB_FLUSH
798void try_to_unmap_flush(void);
d950c947 799void try_to_unmap_flush_dirty(void);
3ea27719 800void flush_tlb_batched_pending(struct mm_struct *mm);
72b252ae
MG
801#else
802static inline void try_to_unmap_flush(void)
803{
804}
d950c947
MG
805static inline void try_to_unmap_flush_dirty(void)
806{
807}
3ea27719
MG
808static inline void flush_tlb_batched_pending(struct mm_struct *mm)
809{
810}
72b252ae 811#endif /* CONFIG_ARCH_WANT_BATCHED_UNMAP_TLB_FLUSH */
edf14cdb
VB
812
813extern const struct trace_print_flags pageflag_names[];
814extern const struct trace_print_flags vmaflag_names[];
815extern const struct trace_print_flags gfpflag_names[];
816
a6ffdc07
XQ
817static inline bool is_migrate_highatomic(enum migratetype migratetype)
818{
819 return migratetype == MIGRATE_HIGHATOMIC;
820}
821
822static inline bool is_migrate_highatomic_page(struct page *page)
823{
824 return get_pageblock_migratetype(page) == MIGRATE_HIGHATOMIC;
825}
826
72675e13 827void setup_zone_pageset(struct zone *zone);
19fc7bed
JK
828
829struct migration_target_control {
830 int nid; /* preferred node id */
831 nodemask_t *nmask;
832 gfp_t gfp_mask;
833};
834
b67177ec
NP
835/*
836 * mm/vmalloc.c
837 */
4ad0ae8c 838#ifdef CONFIG_MMU
b67177ec
NP
839int vmap_pages_range_noflush(unsigned long addr, unsigned long end,
840 pgprot_t prot, struct page **pages, unsigned int page_shift);
4ad0ae8c
NP
841#else
842static inline
843int vmap_pages_range_noflush(unsigned long addr, unsigned long end,
844 pgprot_t prot, struct page **pages, unsigned int page_shift)
845{
846 return -EINVAL;
847}
848#endif
849
850void vunmap_range_noflush(unsigned long start, unsigned long end);
b67177ec 851
f4c0d836
YS
852int numa_migrate_prep(struct page *page, struct vm_area_struct *vma,
853 unsigned long addr, int page_nid, int *flags);
854
27674ef6 855void free_zone_device_page(struct page *page);
b05a79d4 856int migrate_device_coherent_page(struct page *page);
27674ef6 857
ece1ed7b
MWO
858/*
859 * mm/gup.c
860 */
861struct folio *try_grab_folio(struct page *page, int refs, unsigned int flags);
862
09f49dca
MH
863DECLARE_PER_CPU(struct per_cpu_nodestat, boot_nodestats);
864
db971418 865#endif /* __MM_INTERNAL_H */