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