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