GNU Linux-libre 4.19.209-gnu1
[releases.git] / include / linux / hugetlb.h
1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_HUGETLB_H
3 #define _LINUX_HUGETLB_H
4
5 #include <linux/mm_types.h>
6 #include <linux/mmdebug.h>
7 #include <linux/fs.h>
8 #include <linux/hugetlb_inline.h>
9 #include <linux/cgroup.h>
10 #include <linux/list.h>
11 #include <linux/kref.h>
12 #include <asm/pgtable.h>
13
14 struct ctl_table;
15 struct user_struct;
16 struct mmu_gather;
17
18 #ifndef is_hugepd
19 /*
20  * Some architectures requires a hugepage directory format that is
21  * required to support multiple hugepage sizes. For example
22  * a4fe3ce76 "powerpc/mm: Allow more flexible layouts for hugepage pagetables"
23  * introduced the same on powerpc. This allows for a more flexible hugepage
24  * pagetable layout.
25  */
26 typedef struct { unsigned long pd; } hugepd_t;
27 #define is_hugepd(hugepd) (0)
28 #define __hugepd(x) ((hugepd_t) { (x) })
29 static inline int gup_huge_pd(hugepd_t hugepd, unsigned long addr,
30                               unsigned pdshift, unsigned long end,
31                               int write, struct page **pages, int *nr)
32 {
33         return 0;
34 }
35 #else
36 extern int gup_huge_pd(hugepd_t hugepd, unsigned long addr,
37                        unsigned pdshift, unsigned long end,
38                        int write, struct page **pages, int *nr);
39 #endif
40
41
42 #ifdef CONFIG_HUGETLB_PAGE
43
44 #include <linux/mempolicy.h>
45 #include <linux/shm.h>
46 #include <asm/tlbflush.h>
47
48 struct hugepage_subpool {
49         spinlock_t lock;
50         long count;
51         long max_hpages;        /* Maximum huge pages or -1 if no maximum. */
52         long used_hpages;       /* Used count against maximum, includes */
53                                 /* both alloced and reserved pages. */
54         struct hstate *hstate;
55         long min_hpages;        /* Minimum huge pages or -1 if no minimum. */
56         long rsv_hpages;        /* Pages reserved against global pool to */
57                                 /* sasitfy minimum size. */
58 };
59
60 struct resv_map {
61         struct kref refs;
62         spinlock_t lock;
63         struct list_head regions;
64         long adds_in_progress;
65         struct list_head region_cache;
66         long region_cache_count;
67 };
68 extern struct resv_map *resv_map_alloc(void);
69 void resv_map_release(struct kref *ref);
70
71 extern spinlock_t hugetlb_lock;
72 extern int hugetlb_max_hstate __read_mostly;
73 #define for_each_hstate(h) \
74         for ((h) = hstates; (h) < &hstates[hugetlb_max_hstate]; (h)++)
75
76 struct hugepage_subpool *hugepage_new_subpool(struct hstate *h, long max_hpages,
77                                                 long min_hpages);
78 void hugepage_put_subpool(struct hugepage_subpool *spool);
79
80 void reset_vma_resv_huge_pages(struct vm_area_struct *vma);
81 int hugetlb_sysctl_handler(struct ctl_table *, int, void __user *, size_t *, loff_t *);
82 int hugetlb_overcommit_handler(struct ctl_table *, int, void __user *, size_t *, loff_t *);
83 int hugetlb_treat_movable_handler(struct ctl_table *, int, void __user *, size_t *, loff_t *);
84
85 #ifdef CONFIG_NUMA
86 int hugetlb_mempolicy_sysctl_handler(struct ctl_table *, int,
87                                         void __user *, size_t *, loff_t *);
88 #endif
89
90 int copy_hugetlb_page_range(struct mm_struct *, struct mm_struct *, struct vm_area_struct *);
91 long follow_hugetlb_page(struct mm_struct *, struct vm_area_struct *,
92                          struct page **, struct vm_area_struct **,
93                          unsigned long *, unsigned long *, long, unsigned int,
94                          int *);
95 void unmap_hugepage_range(struct vm_area_struct *,
96                           unsigned long, unsigned long, struct page *);
97 void __unmap_hugepage_range_final(struct mmu_gather *tlb,
98                           struct vm_area_struct *vma,
99                           unsigned long start, unsigned long end,
100                           struct page *ref_page);
101 void __unmap_hugepage_range(struct mmu_gather *tlb, struct vm_area_struct *vma,
102                                 unsigned long start, unsigned long end,
103                                 struct page *ref_page);
104 void hugetlb_report_meminfo(struct seq_file *);
105 int hugetlb_report_node_meminfo(int, char *);
106 void hugetlb_show_meminfo(void);
107 unsigned long hugetlb_total_pages(void);
108 vm_fault_t hugetlb_fault(struct mm_struct *mm, struct vm_area_struct *vma,
109                         unsigned long address, unsigned int flags);
110 int hugetlb_mcopy_atomic_pte(struct mm_struct *dst_mm, pte_t *dst_pte,
111                                 struct vm_area_struct *dst_vma,
112                                 unsigned long dst_addr,
113                                 unsigned long src_addr,
114                                 struct page **pagep);
115 int hugetlb_reserve_pages(struct inode *inode, long from, long to,
116                                                 struct vm_area_struct *vma,
117                                                 vm_flags_t vm_flags);
118 long hugetlb_unreserve_pages(struct inode *inode, long start, long end,
119                                                 long freed);
120 bool isolate_huge_page(struct page *page, struct list_head *list);
121 void putback_active_hugepage(struct page *page);
122 void move_hugetlb_state(struct page *oldpage, struct page *newpage, int reason);
123 void free_huge_page(struct page *page);
124 void hugetlb_fix_reserve_counts(struct inode *inode);
125 extern struct mutex *hugetlb_fault_mutex_table;
126 u32 hugetlb_fault_mutex_hash(struct hstate *h, struct address_space *mapping,
127                                 pgoff_t idx);
128
129 pte_t *huge_pmd_share(struct mm_struct *mm, unsigned long addr, pud_t *pud);
130
131 extern int sysctl_hugetlb_shm_group;
132 extern struct list_head huge_boot_pages;
133
134 /* arch callbacks */
135
136 pte_t *huge_pte_alloc(struct mm_struct *mm,
137                         unsigned long addr, unsigned long sz);
138 pte_t *huge_pte_offset(struct mm_struct *mm,
139                        unsigned long addr, unsigned long sz);
140 int huge_pmd_unshare(struct mm_struct *mm, unsigned long *addr, pte_t *ptep);
141 void adjust_range_if_pmd_sharing_possible(struct vm_area_struct *vma,
142                                 unsigned long *start, unsigned long *end);
143 struct page *follow_huge_addr(struct mm_struct *mm, unsigned long address,
144                               int write);
145 struct page *follow_huge_pd(struct vm_area_struct *vma,
146                             unsigned long address, hugepd_t hpd,
147                             int flags, int pdshift);
148 struct page *follow_huge_pmd(struct mm_struct *mm, unsigned long address,
149                                 pmd_t *pmd, int flags);
150 struct page *follow_huge_pud(struct mm_struct *mm, unsigned long address,
151                                 pud_t *pud, int flags);
152 struct page *follow_huge_pgd(struct mm_struct *mm, unsigned long address,
153                              pgd_t *pgd, int flags);
154
155 int pmd_huge(pmd_t pmd);
156 int pud_huge(pud_t pud);
157 unsigned long hugetlb_change_protection(struct vm_area_struct *vma,
158                 unsigned long address, unsigned long end, pgprot_t newprot);
159
160 bool is_hugetlb_entry_migration(pte_t pte);
161
162 #else /* !CONFIG_HUGETLB_PAGE */
163
164 static inline void reset_vma_resv_huge_pages(struct vm_area_struct *vma)
165 {
166 }
167
168 static inline unsigned long hugetlb_total_pages(void)
169 {
170         return 0;
171 }
172
173 static inline int huge_pmd_unshare(struct mm_struct *mm, unsigned long *addr,
174                                         pte_t *ptep)
175 {
176         return 0;
177 }
178
179 static inline void adjust_range_if_pmd_sharing_possible(
180                                 struct vm_area_struct *vma,
181                                 unsigned long *start, unsigned long *end)
182 {
183 }
184
185 #define follow_hugetlb_page(m,v,p,vs,a,b,i,w,n) ({ BUG(); 0; })
186 #define follow_huge_addr(mm, addr, write)       ERR_PTR(-EINVAL)
187 #define copy_hugetlb_page_range(src, dst, vma)  ({ BUG(); 0; })
188 static inline void hugetlb_report_meminfo(struct seq_file *m)
189 {
190 }
191 #define hugetlb_report_node_meminfo(n, buf)     0
192 static inline void hugetlb_show_meminfo(void)
193 {
194 }
195 #define follow_huge_pd(vma, addr, hpd, flags, pdshift) NULL
196 #define follow_huge_pmd(mm, addr, pmd, flags)   NULL
197 #define follow_huge_pud(mm, addr, pud, flags)   NULL
198 #define follow_huge_pgd(mm, addr, pgd, flags)   NULL
199 #define prepare_hugepage_range(file, addr, len) (-EINVAL)
200 #define pmd_huge(x)     0
201 #define pud_huge(x)     0
202 #define is_hugepage_only_range(mm, addr, len)   0
203 #define hugetlb_free_pgd_range(tlb, addr, end, floor, ceiling) ({BUG(); 0; })
204 #define hugetlb_fault(mm, vma, addr, flags)     ({ BUG(); 0; })
205 #define hugetlb_mcopy_atomic_pte(dst_mm, dst_pte, dst_vma, dst_addr, \
206                                 src_addr, pagep)        ({ BUG(); 0; })
207 #define huge_pte_offset(mm, address, sz)        0
208
209 static inline bool isolate_huge_page(struct page *page, struct list_head *list)
210 {
211         return false;
212 }
213 #define putback_active_hugepage(p)      do {} while (0)
214 #define move_hugetlb_state(old, new, reason)    do {} while (0)
215
216 static inline unsigned long hugetlb_change_protection(struct vm_area_struct *vma,
217                 unsigned long address, unsigned long end, pgprot_t newprot)
218 {
219         return 0;
220 }
221
222 static inline void __unmap_hugepage_range_final(struct mmu_gather *tlb,
223                         struct vm_area_struct *vma, unsigned long start,
224                         unsigned long end, struct page *ref_page)
225 {
226         BUG();
227 }
228
229 static inline void __unmap_hugepage_range(struct mmu_gather *tlb,
230                         struct vm_area_struct *vma, unsigned long start,
231                         unsigned long end, struct page *ref_page)
232 {
233         BUG();
234 }
235
236 #endif /* !CONFIG_HUGETLB_PAGE */
237 /*
238  * hugepages at page global directory. If arch support
239  * hugepages at pgd level, they need to define this.
240  */
241 #ifndef pgd_huge
242 #define pgd_huge(x)     0
243 #endif
244 #ifndef p4d_huge
245 #define p4d_huge(x)     0
246 #endif
247
248 #ifndef pgd_write
249 static inline int pgd_write(pgd_t pgd)
250 {
251         BUG();
252         return 0;
253 }
254 #endif
255
256 #define HUGETLB_ANON_FILE "anon_hugepage"
257
258 enum {
259         /*
260          * The file will be used as an shm file so shmfs accounting rules
261          * apply
262          */
263         HUGETLB_SHMFS_INODE     = 1,
264         /*
265          * The file is being created on the internal vfs mount and shmfs
266          * accounting rules do not apply
267          */
268         HUGETLB_ANONHUGE_INODE  = 2,
269 };
270
271 #ifdef CONFIG_HUGETLBFS
272 struct hugetlbfs_sb_info {
273         long    max_inodes;   /* inodes allowed */
274         long    free_inodes;  /* inodes free */
275         spinlock_t      stat_lock;
276         struct hstate *hstate;
277         struct hugepage_subpool *spool;
278         kuid_t  uid;
279         kgid_t  gid;
280         umode_t mode;
281 };
282
283 static inline struct hugetlbfs_sb_info *HUGETLBFS_SB(struct super_block *sb)
284 {
285         return sb->s_fs_info;
286 }
287
288 struct hugetlbfs_inode_info {
289         struct shared_policy policy;
290         struct inode vfs_inode;
291         unsigned int seals;
292 };
293
294 static inline struct hugetlbfs_inode_info *HUGETLBFS_I(struct inode *inode)
295 {
296         return container_of(inode, struct hugetlbfs_inode_info, vfs_inode);
297 }
298
299 extern const struct file_operations hugetlbfs_file_operations;
300 extern const struct vm_operations_struct hugetlb_vm_ops;
301 struct file *hugetlb_file_setup(const char *name, size_t size, vm_flags_t acct,
302                                 struct user_struct **user, int creat_flags,
303                                 int page_size_log);
304
305 static inline bool is_file_hugepages(struct file *file)
306 {
307         if (file->f_op == &hugetlbfs_file_operations)
308                 return true;
309
310         return is_file_shm_hugepages(file);
311 }
312
313
314 #else /* !CONFIG_HUGETLBFS */
315
316 #define is_file_hugepages(file)                 false
317 static inline struct file *
318 hugetlb_file_setup(const char *name, size_t size, vm_flags_t acctflag,
319                 struct user_struct **user, int creat_flags,
320                 int page_size_log)
321 {
322         return ERR_PTR(-ENOSYS);
323 }
324
325 #endif /* !CONFIG_HUGETLBFS */
326
327 #ifdef HAVE_ARCH_HUGETLB_UNMAPPED_AREA
328 unsigned long hugetlb_get_unmapped_area(struct file *file, unsigned long addr,
329                                         unsigned long len, unsigned long pgoff,
330                                         unsigned long flags);
331 #endif /* HAVE_ARCH_HUGETLB_UNMAPPED_AREA */
332
333 #ifdef CONFIG_HUGETLB_PAGE
334
335 #define HSTATE_NAME_LEN 32
336 /* Defines one hugetlb page size */
337 struct hstate {
338         int next_nid_to_alloc;
339         int next_nid_to_free;
340         unsigned int order;
341         unsigned long mask;
342         unsigned long max_huge_pages;
343         unsigned long nr_huge_pages;
344         unsigned long free_huge_pages;
345         unsigned long resv_huge_pages;
346         unsigned long surplus_huge_pages;
347         unsigned long nr_overcommit_huge_pages;
348         struct list_head hugepage_activelist;
349         struct list_head hugepage_freelists[MAX_NUMNODES];
350         unsigned int nr_huge_pages_node[MAX_NUMNODES];
351         unsigned int free_huge_pages_node[MAX_NUMNODES];
352         unsigned int surplus_huge_pages_node[MAX_NUMNODES];
353 #ifdef CONFIG_CGROUP_HUGETLB
354         /* cgroup control files */
355         struct cftype cgroup_files[5];
356 #endif
357         char name[HSTATE_NAME_LEN];
358 };
359
360 struct huge_bootmem_page {
361         struct list_head list;
362         struct hstate *hstate;
363 };
364
365 struct page *alloc_huge_page(struct vm_area_struct *vma,
366                                 unsigned long addr, int avoid_reserve);
367 struct page *alloc_huge_page_node(struct hstate *h, int nid);
368 struct page *alloc_huge_page_nodemask(struct hstate *h, int preferred_nid,
369                                 nodemask_t *nmask);
370 struct page *alloc_huge_page_vma(struct hstate *h, struct vm_area_struct *vma,
371                                 unsigned long address);
372 int huge_add_to_page_cache(struct page *page, struct address_space *mapping,
373                         pgoff_t idx);
374
375 /* arch callback */
376 int __init __alloc_bootmem_huge_page(struct hstate *h);
377 int __init alloc_bootmem_huge_page(struct hstate *h);
378
379 void __init hugetlb_bad_size(void);
380 void __init hugetlb_add_hstate(unsigned order);
381 struct hstate *size_to_hstate(unsigned long size);
382
383 #ifndef HUGE_MAX_HSTATE
384 #define HUGE_MAX_HSTATE 1
385 #endif
386
387 extern struct hstate hstates[HUGE_MAX_HSTATE];
388 extern unsigned int default_hstate_idx;
389
390 #define default_hstate (hstates[default_hstate_idx])
391
392 static inline struct hstate *hstate_inode(struct inode *i)
393 {
394         return HUGETLBFS_SB(i->i_sb)->hstate;
395 }
396
397 static inline struct hstate *hstate_file(struct file *f)
398 {
399         return hstate_inode(file_inode(f));
400 }
401
402 static inline struct hstate *hstate_sizelog(int page_size_log)
403 {
404         if (!page_size_log)
405                 return &default_hstate;
406
407         return size_to_hstate(1UL << page_size_log);
408 }
409
410 static inline struct hstate *hstate_vma(struct vm_area_struct *vma)
411 {
412         return hstate_file(vma->vm_file);
413 }
414
415 static inline unsigned long huge_page_size(struct hstate *h)
416 {
417         return (unsigned long)PAGE_SIZE << h->order;
418 }
419
420 extern unsigned long vma_kernel_pagesize(struct vm_area_struct *vma);
421
422 extern unsigned long vma_mmu_pagesize(struct vm_area_struct *vma);
423
424 static inline unsigned long huge_page_mask(struct hstate *h)
425 {
426         return h->mask;
427 }
428
429 static inline unsigned int huge_page_order(struct hstate *h)
430 {
431         return h->order;
432 }
433
434 static inline unsigned huge_page_shift(struct hstate *h)
435 {
436         return h->order + PAGE_SHIFT;
437 }
438
439 static inline bool hstate_is_gigantic(struct hstate *h)
440 {
441         return huge_page_order(h) >= MAX_ORDER;
442 }
443
444 static inline unsigned int pages_per_huge_page(struct hstate *h)
445 {
446         return 1 << h->order;
447 }
448
449 static inline unsigned int blocks_per_huge_page(struct hstate *h)
450 {
451         return huge_page_size(h) / 512;
452 }
453
454 #include <asm/hugetlb.h>
455
456 #ifndef arch_make_huge_pte
457 static inline pte_t arch_make_huge_pte(pte_t entry, struct vm_area_struct *vma,
458                                        struct page *page, int writable)
459 {
460         return entry;
461 }
462 #endif
463
464 static inline struct hstate *page_hstate(struct page *page)
465 {
466         VM_BUG_ON_PAGE(!PageHuge(page), page);
467         return size_to_hstate(PAGE_SIZE << compound_order(page));
468 }
469
470 static inline unsigned hstate_index_to_shift(unsigned index)
471 {
472         return hstates[index].order + PAGE_SHIFT;
473 }
474
475 static inline int hstate_index(struct hstate *h)
476 {
477         return h - hstates;
478 }
479
480 extern int dissolve_free_huge_page(struct page *page);
481 extern int dissolve_free_huge_pages(unsigned long start_pfn,
482                                     unsigned long end_pfn);
483 static inline bool hugepage_migration_supported(struct hstate *h)
484 {
485 #ifdef CONFIG_ARCH_ENABLE_HUGEPAGE_MIGRATION
486         if ((huge_page_shift(h) == PMD_SHIFT) ||
487                 (huge_page_shift(h) == PGDIR_SHIFT))
488                 return true;
489         else
490                 return false;
491 #else
492         return false;
493 #endif
494 }
495
496 static inline spinlock_t *huge_pte_lockptr(struct hstate *h,
497                                            struct mm_struct *mm, pte_t *pte)
498 {
499         if (huge_page_size(h) == PMD_SIZE)
500                 return pmd_lockptr(mm, (pmd_t *) pte);
501         VM_BUG_ON(huge_page_size(h) == PAGE_SIZE);
502         return &mm->page_table_lock;
503 }
504
505 #ifndef hugepages_supported
506 /*
507  * Some platform decide whether they support huge pages at boot
508  * time. Some of them, such as powerpc, set HPAGE_SHIFT to 0
509  * when there is no such support
510  */
511 #define hugepages_supported() (HPAGE_SHIFT != 0)
512 #endif
513
514 void hugetlb_report_usage(struct seq_file *m, struct mm_struct *mm);
515
516 static inline void hugetlb_count_init(struct mm_struct *mm)
517 {
518         atomic_long_set(&mm->hugetlb_usage, 0);
519 }
520
521 static inline void hugetlb_count_add(long l, struct mm_struct *mm)
522 {
523         atomic_long_add(l, &mm->hugetlb_usage);
524 }
525
526 static inline void hugetlb_count_sub(long l, struct mm_struct *mm)
527 {
528         atomic_long_sub(l, &mm->hugetlb_usage);
529 }
530
531 #ifndef set_huge_swap_pte_at
532 static inline void set_huge_swap_pte_at(struct mm_struct *mm, unsigned long addr,
533                                         pte_t *ptep, pte_t pte, unsigned long sz)
534 {
535         set_huge_pte_at(mm, addr, ptep, pte);
536 }
537 #endif
538
539 void set_page_huge_active(struct page *page);
540
541 #else   /* CONFIG_HUGETLB_PAGE */
542 struct hstate {};
543 #define alloc_huge_page(v, a, r) NULL
544 #define alloc_huge_page_node(h, nid) NULL
545 #define alloc_huge_page_nodemask(h, preferred_nid, nmask) NULL
546 #define alloc_huge_page_vma(h, vma, address) NULL
547 #define alloc_bootmem_huge_page(h) NULL
548 #define hstate_file(f) NULL
549 #define hstate_sizelog(s) NULL
550 #define hstate_vma(v) NULL
551 #define hstate_inode(i) NULL
552 #define page_hstate(page) NULL
553 #define huge_page_size(h) PAGE_SIZE
554 #define huge_page_mask(h) PAGE_MASK
555 #define vma_kernel_pagesize(v) PAGE_SIZE
556 #define vma_mmu_pagesize(v) PAGE_SIZE
557 #define huge_page_order(h) 0
558 #define huge_page_shift(h) PAGE_SHIFT
559 static inline bool hstate_is_gigantic(struct hstate *h)
560 {
561         return false;
562 }
563
564 static inline unsigned int pages_per_huge_page(struct hstate *h)
565 {
566         return 1;
567 }
568
569 static inline unsigned hstate_index_to_shift(unsigned index)
570 {
571         return 0;
572 }
573
574 static inline int hstate_index(struct hstate *h)
575 {
576         return 0;
577 }
578
579 static inline int dissolve_free_huge_page(struct page *page)
580 {
581         return 0;
582 }
583
584 static inline int dissolve_free_huge_pages(unsigned long start_pfn,
585                                            unsigned long end_pfn)
586 {
587         return 0;
588 }
589
590 static inline bool hugepage_migration_supported(struct hstate *h)
591 {
592         return false;
593 }
594
595 static inline spinlock_t *huge_pte_lockptr(struct hstate *h,
596                                            struct mm_struct *mm, pte_t *pte)
597 {
598         return &mm->page_table_lock;
599 }
600
601 static inline void hugetlb_count_init(struct mm_struct *mm)
602 {
603 }
604
605 static inline void hugetlb_report_usage(struct seq_file *f, struct mm_struct *m)
606 {
607 }
608
609 static inline void hugetlb_count_sub(long l, struct mm_struct *mm)
610 {
611 }
612
613 static inline void set_huge_swap_pte_at(struct mm_struct *mm, unsigned long addr,
614                                         pte_t *ptep, pte_t pte, unsigned long sz)
615 {
616 }
617 #endif  /* CONFIG_HUGETLB_PAGE */
618
619 static inline spinlock_t *huge_pte_lock(struct hstate *h,
620                                         struct mm_struct *mm, pte_t *pte)
621 {
622         spinlock_t *ptl;
623
624         ptl = huge_pte_lockptr(h, mm, pte);
625         spin_lock(ptl);
626         return ptl;
627 }
628
629 #endif /* _LINUX_HUGETLB_H */