1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _LINUX_HUGETLB_H
3 #define _LINUX_HUGETLB_H
5 #include <linux/mm_types.h>
6 #include <linux/mmdebug.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>
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
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)
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);
42 #ifdef CONFIG_HUGETLB_PAGE
44 #include <linux/mempolicy.h>
45 #include <linux/shm.h>
46 #include <asm/tlbflush.h>
48 struct hugepage_subpool {
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. */
63 struct list_head regions;
64 long adds_in_progress;
65 struct list_head region_cache;
66 long region_cache_count;
68 extern struct resv_map *resv_map_alloc(void);
69 void resv_map_release(struct kref *ref);
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)++)
76 struct hugepage_subpool *hugepage_new_subpool(struct hstate *h, long max_hpages,
78 void hugepage_put_subpool(struct hugepage_subpool *spool);
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 *);
86 int hugetlb_mempolicy_sysctl_handler(struct ctl_table *, int,
87 void __user *, size_t *, loff_t *);
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,
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,
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 mm_struct *mm,
127 struct vm_area_struct *vma,
128 struct address_space *mapping,
129 pgoff_t idx, unsigned long address);
131 pte_t *huge_pmd_share(struct mm_struct *mm, unsigned long addr, pud_t *pud);
133 extern int sysctl_hugetlb_shm_group;
134 extern struct list_head huge_boot_pages;
138 pte_t *huge_pte_alloc(struct mm_struct *mm,
139 unsigned long addr, unsigned long sz);
140 pte_t *huge_pte_offset(struct mm_struct *mm,
141 unsigned long addr, unsigned long sz);
142 int huge_pmd_unshare(struct mm_struct *mm, unsigned long *addr, pte_t *ptep);
143 void adjust_range_if_pmd_sharing_possible(struct vm_area_struct *vma,
144 unsigned long *start, unsigned long *end);
145 struct page *follow_huge_addr(struct mm_struct *mm, unsigned long address,
147 struct page *follow_huge_pd(struct vm_area_struct *vma,
148 unsigned long address, hugepd_t hpd,
149 int flags, int pdshift);
150 struct page *follow_huge_pmd(struct mm_struct *mm, unsigned long address,
151 pmd_t *pmd, int flags);
152 struct page *follow_huge_pud(struct mm_struct *mm, unsigned long address,
153 pud_t *pud, int flags);
154 struct page *follow_huge_pgd(struct mm_struct *mm, unsigned long address,
155 pgd_t *pgd, int flags);
157 int pmd_huge(pmd_t pmd);
158 int pud_huge(pud_t pud);
159 unsigned long hugetlb_change_protection(struct vm_area_struct *vma,
160 unsigned long address, unsigned long end, pgprot_t newprot);
162 bool is_hugetlb_entry_migration(pte_t pte);
164 #else /* !CONFIG_HUGETLB_PAGE */
166 static inline void reset_vma_resv_huge_pages(struct vm_area_struct *vma)
170 static inline unsigned long hugetlb_total_pages(void)
175 static inline int huge_pmd_unshare(struct mm_struct *mm, unsigned long *addr,
181 static inline void adjust_range_if_pmd_sharing_possible(
182 struct vm_area_struct *vma,
183 unsigned long *start, unsigned long *end)
187 #define follow_hugetlb_page(m,v,p,vs,a,b,i,w,n) ({ BUG(); 0; })
188 #define follow_huge_addr(mm, addr, write) ERR_PTR(-EINVAL)
189 #define copy_hugetlb_page_range(src, dst, vma) ({ BUG(); 0; })
190 static inline void hugetlb_report_meminfo(struct seq_file *m)
193 #define hugetlb_report_node_meminfo(n, buf) 0
194 static inline void hugetlb_show_meminfo(void)
197 #define follow_huge_pd(vma, addr, hpd, flags, pdshift) NULL
198 #define follow_huge_pmd(mm, addr, pmd, flags) NULL
199 #define follow_huge_pud(mm, addr, pud, flags) NULL
200 #define follow_huge_pgd(mm, addr, pgd, flags) NULL
201 #define prepare_hugepage_range(file, addr, len) (-EINVAL)
202 #define pmd_huge(x) 0
203 #define pud_huge(x) 0
204 #define is_hugepage_only_range(mm, addr, len) 0
205 #define hugetlb_free_pgd_range(tlb, addr, end, floor, ceiling) ({BUG(); 0; })
206 #define hugetlb_mcopy_atomic_pte(dst_mm, dst_pte, dst_vma, dst_addr, \
207 src_addr, pagep) ({ BUG(); 0; })
208 #define huge_pte_offset(mm, address, sz) 0
210 static inline bool isolate_huge_page(struct page *page, struct list_head *list)
214 #define putback_active_hugepage(p) do {} while (0)
215 #define move_hugetlb_state(old, new, reason) do {} while (0)
217 static inline unsigned long hugetlb_change_protection(struct vm_area_struct *vma,
218 unsigned long address, unsigned long end, pgprot_t newprot)
223 static inline void __unmap_hugepage_range_final(struct mmu_gather *tlb,
224 struct vm_area_struct *vma, unsigned long start,
225 unsigned long end, struct page *ref_page)
230 static inline void __unmap_hugepage_range(struct mmu_gather *tlb,
231 struct vm_area_struct *vma, unsigned long start,
232 unsigned long end, struct page *ref_page)
236 static inline vm_fault_t hugetlb_fault(struct mm_struct *mm,
237 struct vm_area_struct *vma, unsigned long address,
244 #endif /* !CONFIG_HUGETLB_PAGE */
246 * hugepages at page global directory. If arch support
247 * hugepages at pgd level, they need to define this.
250 #define pgd_huge(x) 0
253 #define p4d_huge(x) 0
257 static inline int pgd_write(pgd_t pgd)
264 #define HUGETLB_ANON_FILE "anon_hugepage"
268 * The file will be used as an shm file so shmfs accounting rules
271 HUGETLB_SHMFS_INODE = 1,
273 * The file is being created on the internal vfs mount and shmfs
274 * accounting rules do not apply
276 HUGETLB_ANONHUGE_INODE = 2,
279 #ifdef CONFIG_HUGETLBFS
280 struct hugetlbfs_sb_info {
281 long max_inodes; /* inodes allowed */
282 long free_inodes; /* inodes free */
283 spinlock_t stat_lock;
284 struct hstate *hstate;
285 struct hugepage_subpool *spool;
291 static inline struct hugetlbfs_sb_info *HUGETLBFS_SB(struct super_block *sb)
293 return sb->s_fs_info;
296 struct hugetlbfs_inode_info {
297 struct shared_policy policy;
298 struct inode vfs_inode;
302 static inline struct hugetlbfs_inode_info *HUGETLBFS_I(struct inode *inode)
304 return container_of(inode, struct hugetlbfs_inode_info, vfs_inode);
307 extern const struct file_operations hugetlbfs_file_operations;
308 extern const struct vm_operations_struct hugetlb_vm_ops;
309 struct file *hugetlb_file_setup(const char *name, size_t size, vm_flags_t acct,
310 struct user_struct **user, int creat_flags,
313 static inline bool is_file_hugepages(struct file *file)
315 if (file->f_op == &hugetlbfs_file_operations)
318 return is_file_shm_hugepages(file);
322 #else /* !CONFIG_HUGETLBFS */
324 #define is_file_hugepages(file) false
325 static inline struct file *
326 hugetlb_file_setup(const char *name, size_t size, vm_flags_t acctflag,
327 struct user_struct **user, int creat_flags,
330 return ERR_PTR(-ENOSYS);
333 #endif /* !CONFIG_HUGETLBFS */
335 #ifdef HAVE_ARCH_HUGETLB_UNMAPPED_AREA
336 unsigned long hugetlb_get_unmapped_area(struct file *file, unsigned long addr,
337 unsigned long len, unsigned long pgoff,
338 unsigned long flags);
339 #endif /* HAVE_ARCH_HUGETLB_UNMAPPED_AREA */
341 #ifdef CONFIG_HUGETLB_PAGE
343 #define HSTATE_NAME_LEN 32
344 /* Defines one hugetlb page size */
346 int next_nid_to_alloc;
347 int next_nid_to_free;
350 unsigned long max_huge_pages;
351 unsigned long nr_huge_pages;
352 unsigned long free_huge_pages;
353 unsigned long resv_huge_pages;
354 unsigned long surplus_huge_pages;
355 unsigned long nr_overcommit_huge_pages;
356 struct list_head hugepage_activelist;
357 struct list_head hugepage_freelists[MAX_NUMNODES];
358 unsigned int nr_huge_pages_node[MAX_NUMNODES];
359 unsigned int free_huge_pages_node[MAX_NUMNODES];
360 unsigned int surplus_huge_pages_node[MAX_NUMNODES];
361 #ifdef CONFIG_CGROUP_HUGETLB
362 /* cgroup control files */
363 struct cftype cgroup_files[5];
365 char name[HSTATE_NAME_LEN];
368 struct huge_bootmem_page {
369 struct list_head list;
370 struct hstate *hstate;
373 struct page *alloc_huge_page(struct vm_area_struct *vma,
374 unsigned long addr, int avoid_reserve);
375 struct page *alloc_huge_page_node(struct hstate *h, int nid);
376 struct page *alloc_huge_page_nodemask(struct hstate *h, int preferred_nid,
378 struct page *alloc_huge_page_vma(struct hstate *h, struct vm_area_struct *vma,
379 unsigned long address);
380 struct page *alloc_migrate_huge_page(struct hstate *h, gfp_t gfp_mask,
381 int nid, nodemask_t *nmask);
382 int huge_add_to_page_cache(struct page *page, struct address_space *mapping,
386 int __init __alloc_bootmem_huge_page(struct hstate *h);
387 int __init alloc_bootmem_huge_page(struct hstate *h);
389 void __init hugetlb_bad_size(void);
390 void __init hugetlb_add_hstate(unsigned order);
391 struct hstate *size_to_hstate(unsigned long size);
393 #ifndef HUGE_MAX_HSTATE
394 #define HUGE_MAX_HSTATE 1
397 extern struct hstate hstates[HUGE_MAX_HSTATE];
398 extern unsigned int default_hstate_idx;
400 #define default_hstate (hstates[default_hstate_idx])
402 static inline struct hstate *hstate_inode(struct inode *i)
404 return HUGETLBFS_SB(i->i_sb)->hstate;
407 static inline struct hstate *hstate_file(struct file *f)
409 return hstate_inode(file_inode(f));
412 static inline struct hstate *hstate_sizelog(int page_size_log)
415 return &default_hstate;
417 return size_to_hstate(1UL << page_size_log);
420 static inline struct hstate *hstate_vma(struct vm_area_struct *vma)
422 return hstate_file(vma->vm_file);
425 static inline unsigned long huge_page_size(struct hstate *h)
427 return (unsigned long)PAGE_SIZE << h->order;
430 extern unsigned long vma_kernel_pagesize(struct vm_area_struct *vma);
432 extern unsigned long vma_mmu_pagesize(struct vm_area_struct *vma);
434 static inline unsigned long huge_page_mask(struct hstate *h)
439 static inline unsigned int huge_page_order(struct hstate *h)
444 static inline unsigned huge_page_shift(struct hstate *h)
446 return h->order + PAGE_SHIFT;
449 static inline bool hstate_is_gigantic(struct hstate *h)
451 return huge_page_order(h) >= MAX_ORDER;
454 static inline unsigned int pages_per_huge_page(struct hstate *h)
456 return 1 << h->order;
459 static inline unsigned int blocks_per_huge_page(struct hstate *h)
461 return huge_page_size(h) / 512;
464 #include <asm/hugetlb.h>
466 #ifndef arch_make_huge_pte
467 static inline pte_t arch_make_huge_pte(pte_t entry, struct vm_area_struct *vma,
468 struct page *page, int writable)
474 static inline struct hstate *page_hstate(struct page *page)
476 VM_BUG_ON_PAGE(!PageHuge(page), page);
477 return size_to_hstate(PAGE_SIZE << compound_order(page));
480 static inline unsigned hstate_index_to_shift(unsigned index)
482 return hstates[index].order + PAGE_SHIFT;
485 static inline int hstate_index(struct hstate *h)
490 pgoff_t __basepage_index(struct page *page);
492 /* Return page->index in PAGE_SIZE units */
493 static inline pgoff_t basepage_index(struct page *page)
495 if (!PageCompound(page))
498 return __basepage_index(page);
501 extern int dissolve_free_huge_page(struct page *page);
502 extern int dissolve_free_huge_pages(unsigned long start_pfn,
503 unsigned long end_pfn);
505 #ifdef CONFIG_ARCH_ENABLE_HUGEPAGE_MIGRATION
506 #ifndef arch_hugetlb_migration_supported
507 static inline bool arch_hugetlb_migration_supported(struct hstate *h)
509 if ((huge_page_shift(h) == PMD_SHIFT) ||
510 (huge_page_shift(h) == PUD_SHIFT) ||
511 (huge_page_shift(h) == PGDIR_SHIFT))
518 static inline bool arch_hugetlb_migration_supported(struct hstate *h)
524 static inline bool hugepage_migration_supported(struct hstate *h)
526 return arch_hugetlb_migration_supported(h);
530 * Movability check is different as compared to migration check.
531 * It determines whether or not a huge page should be placed on
532 * movable zone or not. Movability of any huge page should be
533 * required only if huge page size is supported for migration.
534 * There wont be any reason for the huge page to be movable if
535 * it is not migratable to start with. Also the size of the huge
536 * page should be large enough to be placed under a movable zone
537 * and still feasible enough to be migratable. Just the presence
538 * in movable zone does not make the migration feasible.
540 * So even though large huge page sizes like the gigantic ones
541 * are migratable they should not be movable because its not
542 * feasible to migrate them from movable zone.
544 static inline bool hugepage_movable_supported(struct hstate *h)
546 if (!hugepage_migration_supported(h))
549 if (hstate_is_gigantic(h))
554 static inline spinlock_t *huge_pte_lockptr(struct hstate *h,
555 struct mm_struct *mm, pte_t *pte)
557 if (huge_page_size(h) == PMD_SIZE)
558 return pmd_lockptr(mm, (pmd_t *) pte);
559 VM_BUG_ON(huge_page_size(h) == PAGE_SIZE);
560 return &mm->page_table_lock;
563 #ifndef hugepages_supported
565 * Some platform decide whether they support huge pages at boot
566 * time. Some of them, such as powerpc, set HPAGE_SHIFT to 0
567 * when there is no such support
569 #define hugepages_supported() (HPAGE_SHIFT != 0)
572 void hugetlb_report_usage(struct seq_file *m, struct mm_struct *mm);
574 static inline void hugetlb_count_add(long l, struct mm_struct *mm)
576 atomic_long_add(l, &mm->hugetlb_usage);
579 static inline void hugetlb_count_sub(long l, struct mm_struct *mm)
581 atomic_long_sub(l, &mm->hugetlb_usage);
584 #ifndef set_huge_swap_pte_at
585 static inline void set_huge_swap_pte_at(struct mm_struct *mm, unsigned long addr,
586 pte_t *ptep, pte_t pte, unsigned long sz)
588 set_huge_pte_at(mm, addr, ptep, pte);
592 #ifndef huge_ptep_modify_prot_start
593 #define huge_ptep_modify_prot_start huge_ptep_modify_prot_start
594 static inline pte_t huge_ptep_modify_prot_start(struct vm_area_struct *vma,
595 unsigned long addr, pte_t *ptep)
597 return huge_ptep_get_and_clear(vma->vm_mm, addr, ptep);
601 #ifndef huge_ptep_modify_prot_commit
602 #define huge_ptep_modify_prot_commit huge_ptep_modify_prot_commit
603 static inline void huge_ptep_modify_prot_commit(struct vm_area_struct *vma,
604 unsigned long addr, pte_t *ptep,
605 pte_t old_pte, pte_t pte)
607 set_huge_pte_at(vma->vm_mm, addr, ptep, pte);
611 #else /* CONFIG_HUGETLB_PAGE */
613 #define alloc_huge_page(v, a, r) NULL
614 #define alloc_huge_page_node(h, nid) NULL
615 #define alloc_huge_page_nodemask(h, preferred_nid, nmask) NULL
616 #define alloc_huge_page_vma(h, vma, address) NULL
617 #define alloc_bootmem_huge_page(h) NULL
618 #define hstate_file(f) NULL
619 #define hstate_sizelog(s) NULL
620 #define hstate_vma(v) NULL
621 #define hstate_inode(i) NULL
622 #define page_hstate(page) NULL
623 #define huge_page_size(h) PAGE_SIZE
624 #define huge_page_mask(h) PAGE_MASK
625 #define vma_kernel_pagesize(v) PAGE_SIZE
626 #define vma_mmu_pagesize(v) PAGE_SIZE
627 #define huge_page_order(h) 0
628 #define huge_page_shift(h) PAGE_SHIFT
629 static inline bool hstate_is_gigantic(struct hstate *h)
634 static inline unsigned int pages_per_huge_page(struct hstate *h)
639 static inline unsigned hstate_index_to_shift(unsigned index)
644 static inline int hstate_index(struct hstate *h)
649 static inline pgoff_t basepage_index(struct page *page)
654 static inline int dissolve_free_huge_page(struct page *page)
659 static inline int dissolve_free_huge_pages(unsigned long start_pfn,
660 unsigned long end_pfn)
665 static inline bool hugepage_migration_supported(struct hstate *h)
670 static inline bool hugepage_movable_supported(struct hstate *h)
675 static inline spinlock_t *huge_pte_lockptr(struct hstate *h,
676 struct mm_struct *mm, pte_t *pte)
678 return &mm->page_table_lock;
681 static inline void hugetlb_report_usage(struct seq_file *f, struct mm_struct *m)
685 static inline void hugetlb_count_sub(long l, struct mm_struct *mm)
689 static inline void set_huge_swap_pte_at(struct mm_struct *mm, unsigned long addr,
690 pte_t *ptep, pte_t pte, unsigned long sz)
693 #endif /* CONFIG_HUGETLB_PAGE */
695 static inline spinlock_t *huge_pte_lock(struct hstate *h,
696 struct mm_struct *mm, pte_t *pte)
700 ptl = huge_pte_lockptr(h, mm, pte);
705 #endif /* _LINUX_HUGETLB_H */