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