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