iov_iter: Convert iter_xarray to use folios
[linux-block.git] / include / linux / huge_mm.h
CommitLineData
b2441318 1/* SPDX-License-Identifier: GPL-2.0 */
71e3aac0
AA
2#ifndef _LINUX_HUGE_MM_H
3#define _LINUX_HUGE_MM_H
4
16981d76 5#include <linux/sched/coredump.h>
226ab561 6#include <linux/mm_types.h>
16981d76 7
baabda26
DW
8#include <linux/fs.h> /* only for vma_is_dax() */
9
ebfe1b8f
RC
10vm_fault_t do_huge_pmd_anonymous_page(struct vm_fault *vmf);
11int copy_huge_pmd(struct mm_struct *dst_mm, struct mm_struct *src_mm,
12 pmd_t *dst_pmd, pmd_t *src_pmd, unsigned long addr,
8f34f1ea 13 struct vm_area_struct *dst_vma, struct vm_area_struct *src_vma);
5db4f15c 14void huge_pmd_set_accessed(struct vm_fault *vmf);
ebfe1b8f
RC
15int copy_huge_pud(struct mm_struct *dst_mm, struct mm_struct *src_mm,
16 pud_t *dst_pud, pud_t *src_pud, unsigned long addr,
17 struct vm_area_struct *vma);
a00cc7d9
MW
18
19#ifdef CONFIG_HAVE_ARCH_TRANSPARENT_HUGEPAGE_PUD
ebfe1b8f 20void huge_pud_set_accessed(struct vm_fault *vmf, pud_t orig_pud);
a00cc7d9
MW
21#else
22static inline void huge_pud_set_accessed(struct vm_fault *vmf, pud_t orig_pud)
23{
24}
25#endif
26
5db4f15c 27vm_fault_t do_huge_pmd_wp_page(struct vm_fault *vmf);
ebfe1b8f
RC
28struct page *follow_trans_huge_pmd(struct vm_area_struct *vma,
29 unsigned long addr, pmd_t *pmd,
30 unsigned int flags);
31bool madvise_free_huge_pmd(struct mmu_gather *tlb, struct vm_area_struct *vma,
32 pmd_t *pmd, unsigned long addr, unsigned long next);
33int zap_huge_pmd(struct mmu_gather *tlb, struct vm_area_struct *vma, pmd_t *pmd,
34 unsigned long addr);
35int zap_huge_pud(struct mmu_gather *tlb, struct vm_area_struct *vma, pud_t *pud,
36 unsigned long addr);
37bool move_huge_pmd(struct vm_area_struct *vma, unsigned long old_addr,
38 unsigned long new_addr, pmd_t *old_pmd, pmd_t *new_pmd);
39int change_huge_pmd(struct vm_area_struct *vma, pmd_t *pmd, unsigned long addr,
40 pgprot_t newprot, unsigned long cp_flags);
9a9731b1
THV
41vm_fault_t vmf_insert_pfn_pmd_prot(struct vm_fault *vmf, pfn_t pfn,
42 pgprot_t pgprot, bool write);
43
44/**
45 * vmf_insert_pfn_pmd - insert a pmd size pfn
46 * @vmf: Structure describing the fault
47 * @pfn: pfn to insert
48 * @pgprot: page protection to use
49 * @write: whether it's a write fault
50 *
51 * Insert a pmd size pfn. See vmf_insert_pfn() for additional info.
52 *
53 * Return: vm_fault_t value.
54 */
55static inline vm_fault_t vmf_insert_pfn_pmd(struct vm_fault *vmf, pfn_t pfn,
56 bool write)
57{
58 return vmf_insert_pfn_pmd_prot(vmf, pfn, vmf->vma->vm_page_prot, write);
59}
60vm_fault_t vmf_insert_pfn_pud_prot(struct vm_fault *vmf, pfn_t pfn,
61 pgprot_t pgprot, bool write);
62
63/**
64 * vmf_insert_pfn_pud - insert a pud size pfn
65 * @vmf: Structure describing the fault
66 * @pfn: pfn to insert
67 * @pgprot: page protection to use
68 * @write: whether it's a write fault
69 *
70 * Insert a pud size pfn. See vmf_insert_pfn() for additional info.
71 *
72 * Return: vm_fault_t value.
73 */
74static inline vm_fault_t vmf_insert_pfn_pud(struct vm_fault *vmf, pfn_t pfn,
75 bool write)
76{
77 return vmf_insert_pfn_pud_prot(vmf, pfn, vmf->vma->vm_page_prot, write);
78}
79
71e3aac0 80enum transparent_hugepage_flag {
bae84953 81 TRANSPARENT_HUGEPAGE_NEVER_DAX,
71e3aac0
AA
82 TRANSPARENT_HUGEPAGE_FLAG,
83 TRANSPARENT_HUGEPAGE_REQ_MADV_FLAG,
444eb2a4
MG
84 TRANSPARENT_HUGEPAGE_DEFRAG_DIRECT_FLAG,
85 TRANSPARENT_HUGEPAGE_DEFRAG_KSWAPD_FLAG,
21440d7e 86 TRANSPARENT_HUGEPAGE_DEFRAG_KSWAPD_OR_MADV_FLAG,
71e3aac0 87 TRANSPARENT_HUGEPAGE_DEFRAG_REQ_MADV_FLAG,
ba76149f 88 TRANSPARENT_HUGEPAGE_DEFRAG_KHUGEPAGED_FLAG,
79da5407 89 TRANSPARENT_HUGEPAGE_USE_ZERO_PAGE_FLAG,
71e3aac0
AA
90};
91
b46e756f
KS
92struct kobject;
93struct kobj_attribute;
94
ebfe1b8f
RC
95ssize_t single_hugepage_flag_store(struct kobject *kobj,
96 struct kobj_attribute *attr,
97 const char *buf, size_t count,
98 enum transparent_hugepage_flag flag);
99ssize_t single_hugepage_flag_show(struct kobject *kobj,
100 struct kobj_attribute *attr, char *buf,
101 enum transparent_hugepage_flag flag);
5a6e75f8
KS
102extern struct kobj_attribute shmem_enabled_attr;
103
d8c37c48
NH
104#define HPAGE_PMD_ORDER (HPAGE_PMD_SHIFT-PAGE_SHIFT)
105#define HPAGE_PMD_NR (1<<HPAGE_PMD_ORDER)
106
71e3aac0 107#ifdef CONFIG_TRANSPARENT_HUGEPAGE
fde52796
AK
108#define HPAGE_PMD_SHIFT PMD_SHIFT
109#define HPAGE_PMD_SIZE ((1UL) << HPAGE_PMD_SHIFT)
110#define HPAGE_PMD_MASK (~(HPAGE_PMD_SIZE - 1))
71e3aac0 111
a00cc7d9
MW
112#define HPAGE_PUD_SHIFT PUD_SHIFT
113#define HPAGE_PUD_SIZE ((1UL) << HPAGE_PUD_SHIFT)
114#define HPAGE_PUD_MASK (~(HPAGE_PUD_SIZE - 1))
115
16981d76
DW
116extern unsigned long transparent_hugepage_flags;
117
e6be37b2
ML
118static inline bool transhuge_vma_suitable(struct vm_area_struct *vma,
119 unsigned long haddr)
120{
121 /* Don't have to check pgoff for anonymous vma */
122 if (!vma_is_anonymous(vma)) {
123 if (!IS_ALIGNED((vma->vm_start >> PAGE_SHIFT) - vma->vm_pgoff,
124 HPAGE_PMD_NR))
125 return false;
126 }
127
128 if (haddr < vma->vm_start || haddr + HPAGE_PMD_SIZE > vma->vm_end)
129 return false;
130 return true;
131}
132
133static inline bool transhuge_vma_enabled(struct vm_area_struct *vma,
134 unsigned long vm_flags)
135{
136 /* Explicitly disabled through madvise. */
137 if ((vm_flags & VM_NOHUGEPAGE) ||
138 test_bit(MMF_DISABLE_THP, &vma->vm_mm->flags))
139 return false;
140 return true;
141}
142
7635d9cb
MH
143/*
144 * to be used on vmas which are known to support THP.
e6be37b2 145 * Use transparent_hugepage_active otherwise
7635d9cb
MH
146 */
147static inline bool __transparent_hugepage_enabled(struct vm_area_struct *vma)
16981d76 148{
bae84953
AK
149
150 /*
151 * If the hardware/firmware marked hugepage support disabled.
152 */
153 if (transparent_hugepage_flags & (1 << TRANSPARENT_HUGEPAGE_NEVER_DAX))
154 return false;
155
e6be37b2 156 if (!transhuge_vma_enabled(vma, vma->vm_flags))
16981d76
DW
157 return false;
158
222100ee 159 if (vma_is_temporary_stack(vma))
16981d76
DW
160 return false;
161
16981d76
DW
162 if (transparent_hugepage_flags & (1 << TRANSPARENT_HUGEPAGE_FLAG))
163 return true;
bae84953 164
baabda26
DW
165 if (vma_is_dax(vma))
166 return true;
167
16981d76
DW
168 if (transparent_hugepage_flags &
169 (1 << TRANSPARENT_HUGEPAGE_REQ_MADV_FLAG))
170 return !!(vma->vm_flags & VM_HUGEPAGE);
171
172 return false;
173}
174
e6be37b2 175bool transparent_hugepage_active(struct vm_area_struct *vma);
43675e6f 176
79da5407
KS
177#define transparent_hugepage_use_zero_page() \
178 (transparent_hugepage_flags & \
179 (1<<TRANSPARENT_HUGEPAGE_USE_ZERO_PAGE_FLAG))
71e3aac0 180
ebfe1b8f
RC
181unsigned long thp_get_unmapped_area(struct file *filp, unsigned long addr,
182 unsigned long len, unsigned long pgoff, unsigned long flags);
74d2fad1 183
ebfe1b8f
RC
184void prep_transhuge_page(struct page *page);
185void free_transhuge_page(struct page *page);
005ba37c 186bool is_transparent_hugepage(struct page *page);
9a982250 187
b8f593cd 188bool can_split_huge_page(struct page *page, int *pextra_pins);
e9b61f19
KS
189int split_huge_page_to_list(struct page *page, struct list_head *list);
190static inline int split_huge_page(struct page *page)
191{
192 return split_huge_page_to_list(page, NULL);
193}
9a982250 194void deferred_split_huge_page(struct page *page);
eef1b3ba
KS
195
196void __split_huge_pmd(struct vm_area_struct *vma, pmd_t *pmd,
33f4751e 197 unsigned long address, bool freeze, struct page *page);
eef1b3ba
KS
198
199#define split_huge_pmd(__vma, __pmd, __address) \
200 do { \
201 pmd_t *____pmd = (__pmd); \
84c3fc4e 202 if (is_swap_pmd(*____pmd) || pmd_trans_huge(*____pmd) \
5c7fb56e 203 || pmd_devmap(*____pmd)) \
fec89c10 204 __split_huge_pmd(__vma, __pmd, __address, \
33f4751e 205 false, NULL); \
eef1b3ba 206 } while (0)
ad0bed24 207
2a52bcbc 208
fec89c10
KS
209void split_huge_pmd_address(struct vm_area_struct *vma, unsigned long address,
210 bool freeze, struct page *page);
2a52bcbc 211
a00cc7d9
MW
212void __split_huge_pud(struct vm_area_struct *vma, pud_t *pud,
213 unsigned long address);
214
215#define split_huge_pud(__vma, __pud, __address) \
216 do { \
217 pud_t *____pud = (__pud); \
218 if (pud_trans_huge(*____pud) \
219 || pud_devmap(*____pud)) \
220 __split_huge_pud(__vma, __pud, __address); \
221 } while (0)
222
ebfe1b8f
RC
223int hugepage_madvise(struct vm_area_struct *vma, unsigned long *vm_flags,
224 int advice);
225void vma_adjust_trans_huge(struct vm_area_struct *vma, unsigned long start,
226 unsigned long end, long adjust_next);
227spinlock_t *__pmd_trans_huge_lock(pmd_t *pmd, struct vm_area_struct *vma);
228spinlock_t *__pud_trans_huge_lock(pud_t *pud, struct vm_area_struct *vma);
84c3fc4e
ZY
229
230static inline int is_swap_pmd(pmd_t pmd)
231{
232 return !pmd_none(pmd) && !pmd_present(pmd);
233}
234
c1e8d7c6 235/* mmap_lock must be held on entry */
b6ec57f4
KS
236static inline spinlock_t *pmd_trans_huge_lock(pmd_t *pmd,
237 struct vm_area_struct *vma)
025c5b24 238{
84c3fc4e 239 if (is_swap_pmd(*pmd) || pmd_trans_huge(*pmd) || pmd_devmap(*pmd))
b6ec57f4 240 return __pmd_trans_huge_lock(pmd, vma);
025c5b24 241 else
969e8d7e 242 return NULL;
025c5b24 243}
a00cc7d9
MW
244static inline spinlock_t *pud_trans_huge_lock(pud_t *pud,
245 struct vm_area_struct *vma)
246{
a00cc7d9
MW
247 if (pud_trans_huge(*pud) || pud_devmap(*pud))
248 return __pud_trans_huge_lock(pud, vma);
249 else
250 return NULL;
251}
6ffbb458
MWO
252
253/**
254 * thp_order - Order of a transparent huge page.
255 * @page: Head page of a transparent huge page.
256 */
257static inline unsigned int thp_order(struct page *page)
258{
259 VM_BUG_ON_PGFLAGS(PageTail(page), page);
260 if (PageHead(page))
261 return HPAGE_PMD_ORDER;
262 return 0;
263}
264
6c357848
MWO
265/**
266 * thp_nr_pages - The number of regular pages in this huge page.
267 * @page: The head page of a huge page.
268 */
269static inline int thp_nr_pages(struct page *page)
2c888cfb 270{
6c357848
MWO
271 VM_BUG_ON_PGFLAGS(PageTail(page), page);
272 if (PageHead(page))
2c888cfb
RR
273 return HPAGE_PMD_NR;
274 return 1;
275}
d10e63f2 276
a00cc7d9 277struct page *follow_devmap_pmd(struct vm_area_struct *vma, unsigned long addr,
df06b37f 278 pmd_t *pmd, int flags, struct dev_pagemap **pgmap);
a00cc7d9 279struct page *follow_devmap_pud(struct vm_area_struct *vma, unsigned long addr,
df06b37f 280 pud_t *pud, int flags, struct dev_pagemap **pgmap);
a00cc7d9 281
5db4f15c 282vm_fault_t do_huge_pmd_numa_page(struct vm_fault *vmf);
d10e63f2 283
56873f43 284extern struct page *huge_zero_page;
3b77e8c8 285extern unsigned long huge_zero_pfn;
56873f43
WY
286
287static inline bool is_huge_zero_page(struct page *page)
288{
6aa7de05 289 return READ_ONCE(huge_zero_page) == page;
56873f43
WY
290}
291
fc437044
MW
292static inline bool is_huge_zero_pmd(pmd_t pmd)
293{
3b77e8c8 294 return READ_ONCE(huge_zero_pfn) == pmd_pfn(pmd) && pmd_present(pmd);
fc437044
MW
295}
296
a00cc7d9
MW
297static inline bool is_huge_zero_pud(pud_t pud)
298{
299 return false;
300}
301
6fcb52a5
AL
302struct page *mm_get_huge_zero_page(struct mm_struct *mm);
303void mm_put_huge_zero_page(struct mm_struct *mm);
fc437044 304
10102459
KS
305#define mk_huge_pmd(page, prot) pmd_mkhuge(mk_pmd(page, prot))
306
9c670ea3
NH
307static inline bool thp_migration_supported(void)
308{
309 return IS_ENABLED(CONFIG_ARCH_ENABLE_THP_MIGRATION);
310}
311
87eaceb3
YS
312static inline struct list_head *page_deferred_list(struct page *page)
313{
314 /*
315 * Global or memcg deferred list in the second tail pages is
316 * occupied by compound_head.
317 */
318 return &page[2].deferred_list;
319}
320
71e3aac0 321#else /* CONFIG_TRANSPARENT_HUGEPAGE */
d8c37c48
NH
322#define HPAGE_PMD_SHIFT ({ BUILD_BUG(); 0; })
323#define HPAGE_PMD_MASK ({ BUILD_BUG(); 0; })
324#define HPAGE_PMD_SIZE ({ BUILD_BUG(); 0; })
71e3aac0 325
a00cc7d9
MW
326#define HPAGE_PUD_SHIFT ({ BUILD_BUG(); 0; })
327#define HPAGE_PUD_MASK ({ BUILD_BUG(); 0; })
328#define HPAGE_PUD_SIZE ({ BUILD_BUG(); 0; })
329
6ffbb458
MWO
330static inline unsigned int thp_order(struct page *page)
331{
332 VM_BUG_ON_PGFLAGS(PageTail(page), page);
333 return 0;
334}
335
6c357848 336static inline int thp_nr_pages(struct page *page)
77d6b909 337{
6c357848 338 VM_BUG_ON_PGFLAGS(PageTail(page), page);
77d6b909
MWO
339 return 1;
340}
2c888cfb 341
7635d9cb
MH
342static inline bool __transparent_hugepage_enabled(struct vm_area_struct *vma)
343{
344 return false;
345}
346
e6be37b2 347static inline bool transparent_hugepage_active(struct vm_area_struct *vma)
16981d76
DW
348{
349 return false;
350}
71e3aac0 351
43675e6f
YS
352static inline bool transhuge_vma_suitable(struct vm_area_struct *vma,
353 unsigned long haddr)
354{
355 return false;
356}
357
e6be37b2
ML
358static inline bool transhuge_vma_enabled(struct vm_area_struct *vma,
359 unsigned long vm_flags)
360{
361 return false;
362}
363
800d8c63
KS
364static inline void prep_transhuge_page(struct page *page) {}
365
005ba37c
SC
366static inline bool is_transparent_hugepage(struct page *page)
367{
368 return false;
369}
370
71e3aac0 371#define transparent_hugepage_flags 0UL
74d2fad1
TK
372
373#define thp_get_unmapped_area NULL
374
b8f593cd
HY
375static inline bool
376can_split_huge_page(struct page *page, int *pextra_pins)
377{
378 BUILD_BUG();
379 return false;
380}
5bc7b8ac
SL
381static inline int
382split_huge_page_to_list(struct page *page, struct list_head *list)
383{
384 return 0;
385}
71e3aac0
AA
386static inline int split_huge_page(struct page *page)
387{
388 return 0;
389}
9a982250 390static inline void deferred_split_huge_page(struct page *page) {}
78ddc534 391#define split_huge_pmd(__vma, __pmd, __address) \
e180377f 392 do { } while (0)
2a52bcbc 393
fd60775a
DR
394static inline void __split_huge_pmd(struct vm_area_struct *vma, pmd_t *pmd,
395 unsigned long address, bool freeze, struct page *page) {}
2a52bcbc 396static inline void split_huge_pmd_address(struct vm_area_struct *vma,
fec89c10 397 unsigned long address, bool freeze, struct page *page) {}
2a52bcbc 398
a00cc7d9
MW
399#define split_huge_pud(__vma, __pmd, __address) \
400 do { } while (0)
401
60ab3244
AA
402static inline int hugepage_madvise(struct vm_area_struct *vma,
403 unsigned long *vm_flags, int advice)
0af4e98b
AA
404{
405 BUG();
406 return 0;
407}
94fcc585
AA
408static inline void vma_adjust_trans_huge(struct vm_area_struct *vma,
409 unsigned long start,
410 unsigned long end,
411 long adjust_next)
412{
413}
84c3fc4e
ZY
414static inline int is_swap_pmd(pmd_t pmd)
415{
416 return 0;
417}
b6ec57f4
KS
418static inline spinlock_t *pmd_trans_huge_lock(pmd_t *pmd,
419 struct vm_area_struct *vma)
025c5b24 420{
b6ec57f4 421 return NULL;
025c5b24 422}
a00cc7d9
MW
423static inline spinlock_t *pud_trans_huge_lock(pud_t *pud,
424 struct vm_area_struct *vma)
425{
426 return NULL;
427}
d10e63f2 428
5db4f15c 429static inline vm_fault_t do_huge_pmd_numa_page(struct vm_fault *vmf)
d10e63f2 430{
4daae3b4 431 return 0;
d10e63f2
MG
432}
433
56873f43
WY
434static inline bool is_huge_zero_page(struct page *page)
435{
436 return false;
437}
438
3b77e8c8
HD
439static inline bool is_huge_zero_pmd(pmd_t pmd)
440{
441 return false;
442}
443
a00cc7d9
MW
444static inline bool is_huge_zero_pud(pud_t pud)
445{
446 return false;
447}
448
6fcb52a5 449static inline void mm_put_huge_zero_page(struct mm_struct *mm)
aa88b68c 450{
6fcb52a5 451 return;
aa88b68c 452}
3565fce3
DW
453
454static inline struct page *follow_devmap_pmd(struct vm_area_struct *vma,
df06b37f 455 unsigned long addr, pmd_t *pmd, int flags, struct dev_pagemap **pgmap)
3565fce3
DW
456{
457 return NULL;
458}
a00cc7d9
MW
459
460static inline struct page *follow_devmap_pud(struct vm_area_struct *vma,
df06b37f 461 unsigned long addr, pud_t *pud, int flags, struct dev_pagemap **pgmap)
a00cc7d9
MW
462{
463 return NULL;
464}
9c670ea3
NH
465
466static inline bool thp_migration_supported(void)
467{
468 return false;
469}
71e3aac0
AA
470#endif /* CONFIG_TRANSPARENT_HUGEPAGE */
471
af3bbc12
MWO
472/**
473 * thp_size - Size of a transparent huge page.
474 * @page: Head page of a transparent huge page.
475 *
476 * Return: Number of bytes in this page.
477 */
478static inline unsigned long thp_size(struct page *page)
479{
480 return PAGE_SIZE << thp_order(page);
481}
482
71e3aac0 483#endif /* _LINUX_HUGE_MM_H */