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