xref: /linux-6.15/include/linux/hugetlb.h (revision a671de08)
1 #ifndef _LINUX_HUGETLB_H
2 #define _LINUX_HUGETLB_H
3 
4 #include <linux/mm_types.h>
5 #include <linux/fs.h>
6 #include <linux/hugetlb_inline.h>
7 #include <linux/cgroup.h>
8 
9 struct ctl_table;
10 struct user_struct;
11 struct mmu_gather;
12 
13 #ifdef CONFIG_HUGETLB_PAGE
14 
15 #include <linux/mempolicy.h>
16 #include <linux/shm.h>
17 #include <asm/tlbflush.h>
18 
19 struct hugepage_subpool {
20 	spinlock_t lock;
21 	long count;
22 	long max_hpages, used_hpages;
23 };
24 
25 extern spinlock_t hugetlb_lock;
26 extern int hugetlb_max_hstate __read_mostly;
27 #define for_each_hstate(h) \
28 	for ((h) = hstates; (h) < &hstates[hugetlb_max_hstate]; (h)++)
29 
30 struct hugepage_subpool *hugepage_new_subpool(long nr_blocks);
31 void hugepage_put_subpool(struct hugepage_subpool *spool);
32 
33 int PageHuge(struct page *page);
34 
35 void reset_vma_resv_huge_pages(struct vm_area_struct *vma);
36 int hugetlb_sysctl_handler(struct ctl_table *, int, void __user *, size_t *, loff_t *);
37 int hugetlb_overcommit_handler(struct ctl_table *, int, void __user *, size_t *, loff_t *);
38 int hugetlb_treat_movable_handler(struct ctl_table *, int, void __user *, size_t *, loff_t *);
39 
40 #ifdef CONFIG_NUMA
41 int hugetlb_mempolicy_sysctl_handler(struct ctl_table *, int,
42 					void __user *, size_t *, loff_t *);
43 #endif
44 
45 int copy_hugetlb_page_range(struct mm_struct *, struct mm_struct *, struct vm_area_struct *);
46 int follow_hugetlb_page(struct mm_struct *, struct vm_area_struct *,
47 			struct page **, struct vm_area_struct **,
48 			unsigned long *, int *, int, unsigned int flags);
49 void unmap_hugepage_range(struct vm_area_struct *,
50 			  unsigned long, unsigned long, struct page *);
51 void __unmap_hugepage_range_final(struct mmu_gather *tlb,
52 			  struct vm_area_struct *vma,
53 			  unsigned long start, unsigned long end,
54 			  struct page *ref_page);
55 void __unmap_hugepage_range(struct mmu_gather *tlb, struct vm_area_struct *vma,
56 				unsigned long start, unsigned long end,
57 				struct page *ref_page);
58 int hugetlb_prefault(struct address_space *, struct vm_area_struct *);
59 void hugetlb_report_meminfo(struct seq_file *);
60 int hugetlb_report_node_meminfo(int, char *);
61 unsigned long hugetlb_total_pages(void);
62 int hugetlb_fault(struct mm_struct *mm, struct vm_area_struct *vma,
63 			unsigned long address, unsigned int flags);
64 int hugetlb_reserve_pages(struct inode *inode, long from, long to,
65 						struct vm_area_struct *vma,
66 						vm_flags_t vm_flags);
67 void hugetlb_unreserve_pages(struct inode *inode, long offset, long freed);
68 int dequeue_hwpoisoned_huge_page(struct page *page);
69 void copy_huge_page(struct page *dst, struct page *src);
70 
71 extern unsigned long hugepages_treat_as_movable;
72 extern const unsigned long hugetlb_zero, hugetlb_infinity;
73 extern int sysctl_hugetlb_shm_group;
74 extern struct list_head huge_boot_pages;
75 
76 /* arch callbacks */
77 
78 pte_t *huge_pte_alloc(struct mm_struct *mm,
79 			unsigned long addr, unsigned long sz);
80 pte_t *huge_pte_offset(struct mm_struct *mm, unsigned long addr);
81 int huge_pmd_unshare(struct mm_struct *mm, unsigned long *addr, pte_t *ptep);
82 struct page *follow_huge_addr(struct mm_struct *mm, unsigned long address,
83 			      int write);
84 struct page *follow_huge_pmd(struct mm_struct *mm, unsigned long address,
85 				pmd_t *pmd, int write);
86 struct page *follow_huge_pud(struct mm_struct *mm, unsigned long address,
87 				pud_t *pud, int write);
88 int pmd_huge(pmd_t pmd);
89 int pud_huge(pud_t pmd);
90 void hugetlb_change_protection(struct vm_area_struct *vma,
91 		unsigned long address, unsigned long end, pgprot_t newprot);
92 
93 #else /* !CONFIG_HUGETLB_PAGE */
94 
95 static inline int PageHuge(struct page *page)
96 {
97 	return 0;
98 }
99 
100 static inline void reset_vma_resv_huge_pages(struct vm_area_struct *vma)
101 {
102 }
103 
104 static inline unsigned long hugetlb_total_pages(void)
105 {
106 	return 0;
107 }
108 
109 #define follow_hugetlb_page(m,v,p,vs,a,b,i,w)	({ BUG(); 0; })
110 #define follow_huge_addr(mm, addr, write)	ERR_PTR(-EINVAL)
111 #define copy_hugetlb_page_range(src, dst, vma)	({ BUG(); 0; })
112 #define hugetlb_prefault(mapping, vma)		({ BUG(); 0; })
113 static inline void hugetlb_report_meminfo(struct seq_file *m)
114 {
115 }
116 #define hugetlb_report_node_meminfo(n, buf)	0
117 #define follow_huge_pmd(mm, addr, pmd, write)	NULL
118 #define follow_huge_pud(mm, addr, pud, write)	NULL
119 #define prepare_hugepage_range(file, addr, len)	(-EINVAL)
120 #define pmd_huge(x)	0
121 #define pud_huge(x)	0
122 #define is_hugepage_only_range(mm, addr, len)	0
123 #define hugetlb_free_pgd_range(tlb, addr, end, floor, ceiling) ({BUG(); 0; })
124 #define hugetlb_fault(mm, vma, addr, flags)	({ BUG(); 0; })
125 #define huge_pte_offset(mm, address)	0
126 static inline int dequeue_hwpoisoned_huge_page(struct page *page)
127 {
128 	return 0;
129 }
130 
131 static inline void copy_huge_page(struct page *dst, struct page *src)
132 {
133 }
134 
135 #define hugetlb_change_protection(vma, address, end, newprot)
136 
137 static inline void __unmap_hugepage_range_final(struct mmu_gather *tlb,
138 			struct vm_area_struct *vma, unsigned long start,
139 			unsigned long end, struct page *ref_page)
140 {
141 	BUG();
142 }
143 
144 static inline void __unmap_hugepage_range(struct mmu_gather *tlb,
145 			struct vm_area_struct *vma, unsigned long start,
146 			unsigned long end, struct page *ref_page)
147 {
148 	BUG();
149 }
150 
151 #endif /* !CONFIG_HUGETLB_PAGE */
152 
153 #define HUGETLB_ANON_FILE "anon_hugepage"
154 
155 enum {
156 	/*
157 	 * The file will be used as an shm file so shmfs accounting rules
158 	 * apply
159 	 */
160 	HUGETLB_SHMFS_INODE     = 1,
161 	/*
162 	 * The file is being created on the internal vfs mount and shmfs
163 	 * accounting rules do not apply
164 	 */
165 	HUGETLB_ANONHUGE_INODE  = 2,
166 };
167 
168 #ifdef CONFIG_HUGETLBFS
169 struct hugetlbfs_sb_info {
170 	long	max_inodes;   /* inodes allowed */
171 	long	free_inodes;  /* inodes free */
172 	spinlock_t	stat_lock;
173 	struct hstate *hstate;
174 	struct hugepage_subpool *spool;
175 };
176 
177 static inline struct hugetlbfs_sb_info *HUGETLBFS_SB(struct super_block *sb)
178 {
179 	return sb->s_fs_info;
180 }
181 
182 extern const struct file_operations hugetlbfs_file_operations;
183 extern const struct vm_operations_struct hugetlb_vm_ops;
184 struct file *hugetlb_file_setup(const char *name, unsigned long addr,
185 				size_t size, vm_flags_t acct,
186 				struct user_struct **user, int creat_flags,
187 				int page_size_log);
188 
189 static inline int is_file_hugepages(struct file *file)
190 {
191 	if (file->f_op == &hugetlbfs_file_operations)
192 		return 1;
193 	if (is_file_shm_hugepages(file))
194 		return 1;
195 
196 	return 0;
197 }
198 
199 
200 #else /* !CONFIG_HUGETLBFS */
201 
202 #define is_file_hugepages(file)			0
203 static inline struct file *
204 hugetlb_file_setup(const char *name, unsigned long addr, size_t size,
205 		vm_flags_t acctflag, struct user_struct **user, int creat_flags,
206 		int page_size_log)
207 {
208 	return ERR_PTR(-ENOSYS);
209 }
210 
211 #endif /* !CONFIG_HUGETLBFS */
212 
213 #ifdef HAVE_ARCH_HUGETLB_UNMAPPED_AREA
214 unsigned long hugetlb_get_unmapped_area(struct file *file, unsigned long addr,
215 					unsigned long len, unsigned long pgoff,
216 					unsigned long flags);
217 #endif /* HAVE_ARCH_HUGETLB_UNMAPPED_AREA */
218 
219 #ifdef CONFIG_HUGETLB_PAGE
220 
221 #define HSTATE_NAME_LEN 32
222 /* Defines one hugetlb page size */
223 struct hstate {
224 	int next_nid_to_alloc;
225 	int next_nid_to_free;
226 	unsigned int order;
227 	unsigned long mask;
228 	unsigned long max_huge_pages;
229 	unsigned long nr_huge_pages;
230 	unsigned long free_huge_pages;
231 	unsigned long resv_huge_pages;
232 	unsigned long surplus_huge_pages;
233 	unsigned long nr_overcommit_huge_pages;
234 	struct list_head hugepage_activelist;
235 	struct list_head hugepage_freelists[MAX_NUMNODES];
236 	unsigned int nr_huge_pages_node[MAX_NUMNODES];
237 	unsigned int free_huge_pages_node[MAX_NUMNODES];
238 	unsigned int surplus_huge_pages_node[MAX_NUMNODES];
239 #ifdef CONFIG_CGROUP_HUGETLB
240 	/* cgroup control files */
241 	struct cftype cgroup_files[5];
242 #endif
243 	char name[HSTATE_NAME_LEN];
244 };
245 
246 struct huge_bootmem_page {
247 	struct list_head list;
248 	struct hstate *hstate;
249 #ifdef CONFIG_HIGHMEM
250 	phys_addr_t phys;
251 #endif
252 };
253 
254 struct page *alloc_huge_page_node(struct hstate *h, int nid);
255 
256 /* arch callback */
257 int __init alloc_bootmem_huge_page(struct hstate *h);
258 
259 void __init hugetlb_add_hstate(unsigned order);
260 struct hstate *size_to_hstate(unsigned long size);
261 
262 #ifndef HUGE_MAX_HSTATE
263 #define HUGE_MAX_HSTATE 1
264 #endif
265 
266 extern struct hstate hstates[HUGE_MAX_HSTATE];
267 extern unsigned int default_hstate_idx;
268 
269 #define default_hstate (hstates[default_hstate_idx])
270 
271 static inline struct hstate *hstate_inode(struct inode *i)
272 {
273 	struct hugetlbfs_sb_info *hsb;
274 	hsb = HUGETLBFS_SB(i->i_sb);
275 	return hsb->hstate;
276 }
277 
278 static inline struct hstate *hstate_file(struct file *f)
279 {
280 	return hstate_inode(f->f_dentry->d_inode);
281 }
282 
283 static inline struct hstate *hstate_vma(struct vm_area_struct *vma)
284 {
285 	return hstate_file(vma->vm_file);
286 }
287 
288 static inline unsigned long huge_page_size(struct hstate *h)
289 {
290 	return (unsigned long)PAGE_SIZE << h->order;
291 }
292 
293 extern unsigned long vma_kernel_pagesize(struct vm_area_struct *vma);
294 
295 extern unsigned long vma_mmu_pagesize(struct vm_area_struct *vma);
296 
297 static inline unsigned long huge_page_mask(struct hstate *h)
298 {
299 	return h->mask;
300 }
301 
302 static inline unsigned int huge_page_order(struct hstate *h)
303 {
304 	return h->order;
305 }
306 
307 static inline unsigned huge_page_shift(struct hstate *h)
308 {
309 	return h->order + PAGE_SHIFT;
310 }
311 
312 static inline unsigned int pages_per_huge_page(struct hstate *h)
313 {
314 	return 1 << h->order;
315 }
316 
317 static inline unsigned int blocks_per_huge_page(struct hstate *h)
318 {
319 	return huge_page_size(h) / 512;
320 }
321 
322 #include <asm/hugetlb.h>
323 
324 #ifndef arch_make_huge_pte
325 static inline pte_t arch_make_huge_pte(pte_t entry, struct vm_area_struct *vma,
326 				       struct page *page, int writable)
327 {
328 	return entry;
329 }
330 #endif
331 
332 static inline struct hstate *page_hstate(struct page *page)
333 {
334 	return size_to_hstate(PAGE_SIZE << compound_order(page));
335 }
336 
337 static inline unsigned hstate_index_to_shift(unsigned index)
338 {
339 	return hstates[index].order + PAGE_SHIFT;
340 }
341 
342 static inline int hstate_index(struct hstate *h)
343 {
344 	return h - hstates;
345 }
346 
347 #else
348 struct hstate {};
349 #define alloc_huge_page_node(h, nid) NULL
350 #define alloc_bootmem_huge_page(h) NULL
351 #define hstate_file(f) NULL
352 #define hstate_vma(v) NULL
353 #define hstate_inode(i) NULL
354 #define huge_page_size(h) PAGE_SIZE
355 #define huge_page_mask(h) PAGE_MASK
356 #define vma_kernel_pagesize(v) PAGE_SIZE
357 #define vma_mmu_pagesize(v) PAGE_SIZE
358 #define huge_page_order(h) 0
359 #define huge_page_shift(h) PAGE_SHIFT
360 static inline unsigned int pages_per_huge_page(struct hstate *h)
361 {
362 	return 1;
363 }
364 #define hstate_index_to_shift(index) 0
365 #define hstate_index(h) 0
366 #endif
367 
368 #endif /* _LINUX_HUGETLB_H */
369