xref: /linux-6.15/include/linux/hugetlb.h (revision 8fdff1dc)
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 unsigned long 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 static inline unsigned long hugetlb_change_protection(struct vm_area_struct *vma,
136 		unsigned long address, unsigned long end, pgprot_t newprot)
137 {
138 	return 0;
139 }
140 
141 static inline void __unmap_hugepage_range_final(struct mmu_gather *tlb,
142 			struct vm_area_struct *vma, unsigned long start,
143 			unsigned long end, struct page *ref_page)
144 {
145 	BUG();
146 }
147 
148 static inline void __unmap_hugepage_range(struct mmu_gather *tlb,
149 			struct vm_area_struct *vma, unsigned long start,
150 			unsigned long end, struct page *ref_page)
151 {
152 	BUG();
153 }
154 
155 #endif /* !CONFIG_HUGETLB_PAGE */
156 
157 #define HUGETLB_ANON_FILE "anon_hugepage"
158 
159 enum {
160 	/*
161 	 * The file will be used as an shm file so shmfs accounting rules
162 	 * apply
163 	 */
164 	HUGETLB_SHMFS_INODE     = 1,
165 	/*
166 	 * The file is being created on the internal vfs mount and shmfs
167 	 * accounting rules do not apply
168 	 */
169 	HUGETLB_ANONHUGE_INODE  = 2,
170 };
171 
172 #ifdef CONFIG_HUGETLBFS
173 struct hugetlbfs_sb_info {
174 	long	max_inodes;   /* inodes allowed */
175 	long	free_inodes;  /* inodes free */
176 	spinlock_t	stat_lock;
177 	struct hstate *hstate;
178 	struct hugepage_subpool *spool;
179 };
180 
181 static inline struct hugetlbfs_sb_info *HUGETLBFS_SB(struct super_block *sb)
182 {
183 	return sb->s_fs_info;
184 }
185 
186 extern const struct file_operations hugetlbfs_file_operations;
187 extern const struct vm_operations_struct hugetlb_vm_ops;
188 struct file *hugetlb_file_setup(const char *name, unsigned long addr,
189 				size_t size, vm_flags_t acct,
190 				struct user_struct **user, int creat_flags,
191 				int page_size_log);
192 
193 static inline int is_file_hugepages(struct file *file)
194 {
195 	if (file->f_op == &hugetlbfs_file_operations)
196 		return 1;
197 	if (is_file_shm_hugepages(file))
198 		return 1;
199 
200 	return 0;
201 }
202 
203 
204 #else /* !CONFIG_HUGETLBFS */
205 
206 #define is_file_hugepages(file)			0
207 static inline struct file *
208 hugetlb_file_setup(const char *name, unsigned long addr, size_t size,
209 		vm_flags_t acctflag, struct user_struct **user, int creat_flags,
210 		int page_size_log)
211 {
212 	return ERR_PTR(-ENOSYS);
213 }
214 
215 #endif /* !CONFIG_HUGETLBFS */
216 
217 #ifdef HAVE_ARCH_HUGETLB_UNMAPPED_AREA
218 unsigned long hugetlb_get_unmapped_area(struct file *file, unsigned long addr,
219 					unsigned long len, unsigned long pgoff,
220 					unsigned long flags);
221 #endif /* HAVE_ARCH_HUGETLB_UNMAPPED_AREA */
222 
223 #ifdef CONFIG_HUGETLB_PAGE
224 
225 #define HSTATE_NAME_LEN 32
226 /* Defines one hugetlb page size */
227 struct hstate {
228 	int next_nid_to_alloc;
229 	int next_nid_to_free;
230 	unsigned int order;
231 	unsigned long mask;
232 	unsigned long max_huge_pages;
233 	unsigned long nr_huge_pages;
234 	unsigned long free_huge_pages;
235 	unsigned long resv_huge_pages;
236 	unsigned long surplus_huge_pages;
237 	unsigned long nr_overcommit_huge_pages;
238 	struct list_head hugepage_activelist;
239 	struct list_head hugepage_freelists[MAX_NUMNODES];
240 	unsigned int nr_huge_pages_node[MAX_NUMNODES];
241 	unsigned int free_huge_pages_node[MAX_NUMNODES];
242 	unsigned int surplus_huge_pages_node[MAX_NUMNODES];
243 #ifdef CONFIG_CGROUP_HUGETLB
244 	/* cgroup control files */
245 	struct cftype cgroup_files[5];
246 #endif
247 	char name[HSTATE_NAME_LEN];
248 };
249 
250 struct huge_bootmem_page {
251 	struct list_head list;
252 	struct hstate *hstate;
253 #ifdef CONFIG_HIGHMEM
254 	phys_addr_t phys;
255 #endif
256 };
257 
258 struct page *alloc_huge_page_node(struct hstate *h, int nid);
259 
260 /* arch callback */
261 int __init alloc_bootmem_huge_page(struct hstate *h);
262 
263 void __init hugetlb_add_hstate(unsigned order);
264 struct hstate *size_to_hstate(unsigned long size);
265 
266 #ifndef HUGE_MAX_HSTATE
267 #define HUGE_MAX_HSTATE 1
268 #endif
269 
270 extern struct hstate hstates[HUGE_MAX_HSTATE];
271 extern unsigned int default_hstate_idx;
272 
273 #define default_hstate (hstates[default_hstate_idx])
274 
275 static inline struct hstate *hstate_inode(struct inode *i)
276 {
277 	struct hugetlbfs_sb_info *hsb;
278 	hsb = HUGETLBFS_SB(i->i_sb);
279 	return hsb->hstate;
280 }
281 
282 static inline struct hstate *hstate_file(struct file *f)
283 {
284 	return hstate_inode(f->f_dentry->d_inode);
285 }
286 
287 static inline struct hstate *hstate_vma(struct vm_area_struct *vma)
288 {
289 	return hstate_file(vma->vm_file);
290 }
291 
292 static inline unsigned long huge_page_size(struct hstate *h)
293 {
294 	return (unsigned long)PAGE_SIZE << h->order;
295 }
296 
297 extern unsigned long vma_kernel_pagesize(struct vm_area_struct *vma);
298 
299 extern unsigned long vma_mmu_pagesize(struct vm_area_struct *vma);
300 
301 static inline unsigned long huge_page_mask(struct hstate *h)
302 {
303 	return h->mask;
304 }
305 
306 static inline unsigned int huge_page_order(struct hstate *h)
307 {
308 	return h->order;
309 }
310 
311 static inline unsigned huge_page_shift(struct hstate *h)
312 {
313 	return h->order + PAGE_SHIFT;
314 }
315 
316 static inline unsigned int pages_per_huge_page(struct hstate *h)
317 {
318 	return 1 << h->order;
319 }
320 
321 static inline unsigned int blocks_per_huge_page(struct hstate *h)
322 {
323 	return huge_page_size(h) / 512;
324 }
325 
326 #include <asm/hugetlb.h>
327 
328 #ifndef arch_make_huge_pte
329 static inline pte_t arch_make_huge_pte(pte_t entry, struct vm_area_struct *vma,
330 				       struct page *page, int writable)
331 {
332 	return entry;
333 }
334 #endif
335 
336 static inline struct hstate *page_hstate(struct page *page)
337 {
338 	return size_to_hstate(PAGE_SIZE << compound_order(page));
339 }
340 
341 static inline unsigned hstate_index_to_shift(unsigned index)
342 {
343 	return hstates[index].order + PAGE_SHIFT;
344 }
345 
346 static inline int hstate_index(struct hstate *h)
347 {
348 	return h - hstates;
349 }
350 
351 #else
352 struct hstate {};
353 #define alloc_huge_page_node(h, nid) NULL
354 #define alloc_bootmem_huge_page(h) NULL
355 #define hstate_file(f) NULL
356 #define hstate_vma(v) NULL
357 #define hstate_inode(i) NULL
358 #define huge_page_size(h) PAGE_SIZE
359 #define huge_page_mask(h) PAGE_MASK
360 #define vma_kernel_pagesize(v) PAGE_SIZE
361 #define vma_mmu_pagesize(v) PAGE_SIZE
362 #define huge_page_order(h) 0
363 #define huge_page_shift(h) PAGE_SHIFT
364 static inline unsigned int pages_per_huge_page(struct hstate *h)
365 {
366 	return 1;
367 }
368 #define hstate_index_to_shift(index) 0
369 #define hstate_index(h) 0
370 #endif
371 
372 #endif /* _LINUX_HUGETLB_H */
373