xref: /linux/fs/hugetlbfs/inode.c (revision 334fbe734e687404f346eba7d5d96ed2b44d35ab)
1 /*
2  * hugetlbpage-backed filesystem.  Based on ramfs.
3  *
4  * Nadia Yvette Chambers, 2002
5  *
6  * Copyright (C) 2002 Linus Torvalds.
7  * License: GPL
8  */
9 
10 #define pr_fmt(fmt) KBUILD_MODNAME ": " fmt
11 
12 #include <linux/thread_info.h>
13 #include <asm/current.h>
14 #include <linux/falloc.h>
15 #include <linux/fs.h>
16 #include <linux/mount.h>
17 #include <linux/file.h>
18 #include <linux/kernel.h>
19 #include <linux/writeback.h>
20 #include <linux/pagemap.h>
21 #include <linux/highmem.h>
22 #include <linux/init.h>
23 #include <linux/string.h>
24 #include <linux/capability.h>
25 #include <linux/ctype.h>
26 #include <linux/backing-dev.h>
27 #include <linux/hugetlb.h>
28 #include <linux/folio_batch.h>
29 #include <linux/fs_parser.h>
30 #include <linux/mman.h>
31 #include <linux/slab.h>
32 #include <linux/dnotify.h>
33 #include <linux/statfs.h>
34 #include <linux/security.h>
35 #include <linux/magic.h>
36 #include <linux/migrate.h>
37 #include <linux/uio.h>
38 
39 #include <linux/uaccess.h>
40 #include <linux/sched/mm.h>
41 
42 #define CREATE_TRACE_POINTS
43 #include <trace/events/hugetlbfs.h>
44 
45 static const struct address_space_operations hugetlbfs_aops;
46 static const struct file_operations hugetlbfs_file_operations;
47 static const struct inode_operations hugetlbfs_dir_inode_operations;
48 static const struct inode_operations hugetlbfs_inode_operations;
49 
50 enum hugetlbfs_size_type { NO_SIZE, SIZE_STD, SIZE_PERCENT };
51 
52 struct hugetlbfs_fs_context {
53 	struct hstate		*hstate;
54 	unsigned long long	max_size_opt;
55 	unsigned long long	min_size_opt;
56 	long			max_hpages;
57 	long			nr_inodes;
58 	long			min_hpages;
59 	enum hugetlbfs_size_type max_val_type;
60 	enum hugetlbfs_size_type min_val_type;
61 	kuid_t			uid;
62 	kgid_t			gid;
63 	umode_t			mode;
64 };
65 
66 int sysctl_hugetlb_shm_group;
67 
68 enum hugetlb_param {
69 	Opt_gid,
70 	Opt_min_size,
71 	Opt_mode,
72 	Opt_nr_inodes,
73 	Opt_pagesize,
74 	Opt_size,
75 	Opt_uid,
76 };
77 
78 static const struct fs_parameter_spec hugetlb_fs_parameters[] = {
79 	fsparam_gid   ("gid",		Opt_gid),
80 	fsparam_string("min_size",	Opt_min_size),
81 	fsparam_u32oct("mode",		Opt_mode),
82 	fsparam_string("nr_inodes",	Opt_nr_inodes),
83 	fsparam_string("pagesize",	Opt_pagesize),
84 	fsparam_string("size",		Opt_size),
85 	fsparam_uid   ("uid",		Opt_uid),
86 	{}
87 };
88 
89 /*
90  * Mask used when checking the page offset value passed in via system
91  * calls.  This value will be converted to a loff_t which is signed.
92  * Therefore, we want to check the upper PAGE_SHIFT + 1 bits of the
93  * value.  The extra bit (- 1 in the shift value) is to take the sign
94  * bit into account.
95  */
96 #define PGOFF_LOFFT_MAX \
97 	(((1UL << (PAGE_SHIFT + 1)) - 1) <<  (BITS_PER_LONG - (PAGE_SHIFT + 1)))
98 
hugetlb_file_mmap_prepare_success(const struct vm_area_struct * vma)99 static int hugetlb_file_mmap_prepare_success(const struct vm_area_struct *vma)
100 {
101 	/* Unfortunate we have to reassign vma->vm_private_data. */
102 	return hugetlb_vma_lock_alloc((struct vm_area_struct *)vma);
103 }
104 
hugetlbfs_file_mmap_prepare(struct vm_area_desc * desc)105 static int hugetlbfs_file_mmap_prepare(struct vm_area_desc *desc)
106 {
107 	struct file *file = desc->file;
108 	struct inode *inode = file_inode(file);
109 	loff_t len, vma_len;
110 	int ret;
111 	struct hstate *h = hstate_file(file);
112 	vma_flags_t vma_flags;
113 
114 	/*
115 	 * vma address alignment (but not the pgoff alignment) has
116 	 * already been checked by prepare_hugepage_range.  If you add
117 	 * any error returns here, do so after setting VM_HUGETLB, so
118 	 * is_vm_hugetlb_page tests below unmap_region go the right
119 	 * way when do_mmap unwinds (may be important on powerpc
120 	 * and ia64).
121 	 */
122 	vma_desc_set_flags(desc, VMA_HUGETLB_BIT, VMA_DONTEXPAND_BIT);
123 	desc->vm_ops = &hugetlb_vm_ops;
124 
125 	/*
126 	 * page based offset in vm_pgoff could be sufficiently large to
127 	 * overflow a loff_t when converted to byte offset.  This can
128 	 * only happen on architectures where sizeof(loff_t) ==
129 	 * sizeof(unsigned long).  So, only check in those instances.
130 	 */
131 	if (sizeof(unsigned long) == sizeof(loff_t)) {
132 		if (desc->pgoff & PGOFF_LOFFT_MAX)
133 			return -EINVAL;
134 	}
135 
136 	/* must be huge page aligned */
137 	if (desc->pgoff & (~huge_page_mask(h) >> PAGE_SHIFT))
138 		return -EINVAL;
139 
140 	vma_len = (loff_t)vma_desc_size(desc);
141 	len = vma_len + ((loff_t)desc->pgoff << PAGE_SHIFT);
142 	/* check for overflow */
143 	if (len < vma_len)
144 		return -EINVAL;
145 
146 	inode_lock(inode);
147 	file_accessed(file);
148 
149 	ret = -ENOMEM;
150 
151 	vma_flags = desc->vma_flags;
152 	/*
153 	 * for SHM_HUGETLB, the pages are reserved in the shmget() call so skip
154 	 * reserving here. Note: only for SHM hugetlbfs file, the inode
155 	 * flag S_PRIVATE is set.
156 	 */
157 	if (inode->i_flags & S_PRIVATE)
158 		vma_flags_set(&vma_flags, VMA_NORESERVE_BIT);
159 
160 	if (hugetlb_reserve_pages(inode,
161 			desc->pgoff >> huge_page_order(h),
162 			len >> huge_page_shift(h), desc,
163 			vma_flags) < 0)
164 		goto out;
165 
166 	ret = 0;
167 	if (vma_desc_test(desc, VMA_WRITE_BIT) && inode->i_size < len)
168 		i_size_write(inode, len);
169 out:
170 	inode_unlock(inode);
171 
172 	if (!ret) {
173 		/* Allocate the VMA lock after we set it up. */
174 		desc->action.success_hook = hugetlb_file_mmap_prepare_success;
175 		/*
176 		 * We cannot permit the rmap finding this VMA in the time
177 		 * between the VMA being inserted into the VMA tree and the
178 		 * completion/success hook being invoked.
179 		 *
180 		 * This is because we establish a per-VMA hugetlb lock which can
181 		 * be raced by rmap.
182 		 */
183 		desc->action.hide_from_rmap_until_complete = true;
184 	}
185 	return ret;
186 }
187 
188 /*
189  * Called under mmap_write_lock(mm).
190  */
191 
192 unsigned long
hugetlb_get_unmapped_area(struct file * file,unsigned long addr,unsigned long len,unsigned long pgoff,unsigned long flags)193 hugetlb_get_unmapped_area(struct file *file, unsigned long addr,
194 			    unsigned long len, unsigned long pgoff,
195 			    unsigned long flags)
196 {
197 	unsigned long addr0 = 0;
198 	struct hstate *h = hstate_file(file);
199 
200 	if (len & ~huge_page_mask(h))
201 		return -EINVAL;
202 	if ((flags & MAP_FIXED) && (addr & ~huge_page_mask(h)))
203 		return -EINVAL;
204 	if (addr)
205 		addr0 = ALIGN(addr, huge_page_size(h));
206 
207 	return mm_get_unmapped_area_vmflags(file, addr0, len, pgoff, flags, 0);
208 }
209 
210 /*
211  * Someone wants to read @bytes from a HWPOISON hugetlb @folio from @offset.
212  * Returns the maximum number of bytes one can read without touching the 1st raw
213  * HWPOISON page.
214  */
adjust_range_hwpoison(struct folio * folio,size_t offset,size_t bytes)215 static size_t adjust_range_hwpoison(struct folio *folio, size_t offset,
216 		size_t bytes)
217 {
218 	struct page *page = folio_page(folio, offset / PAGE_SIZE);
219 	size_t safe_bytes;
220 
221 	if (is_raw_hwpoison_page_in_hugepage(page))
222 		return 0;
223 	/* Safe to read the remaining bytes in this page. */
224 	safe_bytes = PAGE_SIZE - (offset % PAGE_SIZE);
225 	page++;
226 
227 	/* Check each remaining page as long as we are not done yet. */
228 	for (; safe_bytes < bytes; safe_bytes += PAGE_SIZE, page++)
229 		if (is_raw_hwpoison_page_in_hugepage(page))
230 			break;
231 
232 	return min(safe_bytes, bytes);
233 }
234 
235 /*
236  * Support for read() - Find the page attached to f_mapping and copy out the
237  * data. This provides functionality similar to filemap_read().
238  */
hugetlbfs_read_iter(struct kiocb * iocb,struct iov_iter * to)239 static ssize_t hugetlbfs_read_iter(struct kiocb *iocb, struct iov_iter *to)
240 {
241 	struct file *file = iocb->ki_filp;
242 	struct hstate *h = hstate_file(file);
243 	struct address_space *mapping = file->f_mapping;
244 	struct inode *inode = mapping->host;
245 	unsigned long index = iocb->ki_pos >> huge_page_shift(h);
246 	unsigned long offset = iocb->ki_pos & ~huge_page_mask(h);
247 	unsigned long end_index;
248 	loff_t isize;
249 	ssize_t retval = 0;
250 
251 	while (iov_iter_count(to)) {
252 		struct folio *folio;
253 		size_t nr, copied, want;
254 
255 		/* nr is the maximum number of bytes to copy from this page */
256 		nr = huge_page_size(h);
257 		isize = i_size_read(inode);
258 		if (!isize)
259 			break;
260 		end_index = (isize - 1) >> huge_page_shift(h);
261 		if (index > end_index)
262 			break;
263 		if (index == end_index) {
264 			nr = ((isize - 1) & ~huge_page_mask(h)) + 1;
265 			if (nr <= offset)
266 				break;
267 		}
268 		nr = nr - offset;
269 
270 		/* Find the folio */
271 		folio = filemap_lock_hugetlb_folio(h, mapping, index);
272 		if (IS_ERR(folio)) {
273 			/*
274 			 * We have a HOLE, zero out the user-buffer for the
275 			 * length of the hole or request.
276 			 */
277 			copied = iov_iter_zero(nr, to);
278 		} else {
279 			folio_unlock(folio);
280 
281 			if (!folio_test_hwpoison(folio))
282 				want = nr;
283 			else {
284 				/*
285 				 * Adjust how many bytes safe to read without
286 				 * touching the 1st raw HWPOISON page after
287 				 * offset.
288 				 */
289 				want = adjust_range_hwpoison(folio, offset, nr);
290 				if (want == 0) {
291 					folio_put(folio);
292 					retval = -EIO;
293 					break;
294 				}
295 			}
296 
297 			/*
298 			 * We have the folio, copy it to user space buffer.
299 			 */
300 			copied = copy_folio_to_iter(folio, offset, want, to);
301 			folio_put(folio);
302 		}
303 		offset += copied;
304 		retval += copied;
305 		if (copied != nr && iov_iter_count(to)) {
306 			if (!retval)
307 				retval = -EFAULT;
308 			break;
309 		}
310 		index += offset >> huge_page_shift(h);
311 		offset &= ~huge_page_mask(h);
312 	}
313 	iocb->ki_pos = ((loff_t)index << huge_page_shift(h)) + offset;
314 	return retval;
315 }
316 
hugetlbfs_write_begin(const struct kiocb * iocb,struct address_space * mapping,loff_t pos,unsigned len,struct folio ** foliop,void ** fsdata)317 static int hugetlbfs_write_begin(const struct kiocb *iocb,
318 			struct address_space *mapping,
319 			loff_t pos, unsigned len,
320 			struct folio **foliop, void **fsdata)
321 {
322 	return -EINVAL;
323 }
324 
hugetlbfs_write_end(const struct kiocb * iocb,struct address_space * mapping,loff_t pos,unsigned len,unsigned copied,struct folio * folio,void * fsdata)325 static int hugetlbfs_write_end(const struct kiocb *iocb,
326 			       struct address_space *mapping,
327 			       loff_t pos, unsigned len, unsigned copied,
328 			       struct folio *folio, void *fsdata)
329 {
330 	BUG();
331 	return -EINVAL;
332 }
333 
hugetlb_delete_from_page_cache(struct folio * folio)334 static void hugetlb_delete_from_page_cache(struct folio *folio)
335 {
336 	folio_clear_dirty(folio);
337 	folio_clear_uptodate(folio);
338 	filemap_remove_folio(folio);
339 }
340 
341 /*
342  * Called with i_mmap_rwsem held for inode based vma maps.  This makes
343  * sure vma (and vm_mm) will not go away.  We also hold the hugetlb fault
344  * mutex for the page in the mapping.  So, we can not race with page being
345  * faulted into the vma.
346  */
hugetlb_vma_maps_pfn(struct vm_area_struct * vma,unsigned long addr,unsigned long pfn)347 static bool hugetlb_vma_maps_pfn(struct vm_area_struct *vma,
348 				unsigned long addr, unsigned long pfn)
349 {
350 	pte_t *ptep, pte;
351 
352 	ptep = hugetlb_walk(vma, addr, huge_page_size(hstate_vma(vma)));
353 	if (!ptep)
354 		return false;
355 
356 	pte = huge_ptep_get(vma->vm_mm, addr, ptep);
357 	if (huge_pte_none(pte) || !pte_present(pte))
358 		return false;
359 
360 	if (pte_pfn(pte) == pfn)
361 		return true;
362 
363 	return false;
364 }
365 
366 /*
367  * Can vma_offset_start/vma_offset_end overflow on 32-bit arches?
368  * No, because the interval tree returns us only those vmas
369  * which overlap the truncated area starting at pgoff,
370  * and no vma on a 32-bit arch can span beyond the 4GB.
371  */
vma_offset_start(struct vm_area_struct * vma,pgoff_t start)372 static unsigned long vma_offset_start(struct vm_area_struct *vma, pgoff_t start)
373 {
374 	unsigned long offset = 0;
375 
376 	if (vma->vm_pgoff < start)
377 		offset = (start - vma->vm_pgoff) << PAGE_SHIFT;
378 
379 	return vma->vm_start + offset;
380 }
381 
vma_offset_end(struct vm_area_struct * vma,pgoff_t end)382 static unsigned long vma_offset_end(struct vm_area_struct *vma, pgoff_t end)
383 {
384 	unsigned long t_end;
385 
386 	if (!end)
387 		return vma->vm_end;
388 
389 	t_end = ((end - vma->vm_pgoff) << PAGE_SHIFT) + vma->vm_start;
390 	if (t_end > vma->vm_end)
391 		t_end = vma->vm_end;
392 	return t_end;
393 }
394 
395 /*
396  * Called with hugetlb fault mutex held.  Therefore, no more mappings to
397  * this folio can be created while executing the routine.
398  */
hugetlb_unmap_file_folio(struct hstate * h,struct address_space * mapping,struct folio * folio,pgoff_t index)399 static void hugetlb_unmap_file_folio(struct hstate *h,
400 					struct address_space *mapping,
401 					struct folio *folio, pgoff_t index)
402 {
403 	struct rb_root_cached *root = &mapping->i_mmap;
404 	struct hugetlb_vma_lock *vma_lock;
405 	unsigned long pfn = folio_pfn(folio);
406 	struct vm_area_struct *vma;
407 	unsigned long v_start;
408 	unsigned long v_end;
409 	pgoff_t start, end;
410 
411 	start = index * pages_per_huge_page(h);
412 	end = (index + 1) * pages_per_huge_page(h);
413 
414 	i_mmap_lock_write(mapping);
415 retry:
416 	vma_lock = NULL;
417 	vma_interval_tree_foreach(vma, root, start, end - 1) {
418 		v_start = vma_offset_start(vma, start);
419 		v_end = vma_offset_end(vma, end);
420 
421 		if (!hugetlb_vma_maps_pfn(vma, v_start, pfn))
422 			continue;
423 
424 		if (!hugetlb_vma_trylock_write(vma)) {
425 			vma_lock = vma->vm_private_data;
426 			/*
427 			 * If we can not get vma lock, we need to drop
428 			 * immap_sema and take locks in order.  First,
429 			 * take a ref on the vma_lock structure so that
430 			 * we can be guaranteed it will not go away when
431 			 * dropping immap_sema.
432 			 */
433 			kref_get(&vma_lock->refs);
434 			break;
435 		}
436 
437 		unmap_hugepage_range(vma, v_start, v_end, NULL,
438 				     ZAP_FLAG_DROP_MARKER);
439 		hugetlb_vma_unlock_write(vma);
440 	}
441 
442 	i_mmap_unlock_write(mapping);
443 
444 	if (vma_lock) {
445 		/*
446 		 * Wait on vma_lock.  We know it is still valid as we have
447 		 * a reference.  We must 'open code' vma locking as we do
448 		 * not know if vma_lock is still attached to vma.
449 		 */
450 		down_write(&vma_lock->rw_sema);
451 		i_mmap_lock_write(mapping);
452 
453 		vma = vma_lock->vma;
454 		if (!vma) {
455 			/*
456 			 * If lock is no longer attached to vma, then just
457 			 * unlock, drop our reference and retry looking for
458 			 * other vmas.
459 			 */
460 			up_write(&vma_lock->rw_sema);
461 			kref_put(&vma_lock->refs, hugetlb_vma_lock_release);
462 			goto retry;
463 		}
464 
465 		/*
466 		 * vma_lock is still attached to vma.  Check to see if vma
467 		 * still maps page and if so, unmap.
468 		 */
469 		v_start = vma_offset_start(vma, start);
470 		v_end = vma_offset_end(vma, end);
471 		if (hugetlb_vma_maps_pfn(vma, v_start, pfn))
472 			unmap_hugepage_range(vma, v_start, v_end, NULL,
473 					     ZAP_FLAG_DROP_MARKER);
474 
475 		kref_put(&vma_lock->refs, hugetlb_vma_lock_release);
476 		hugetlb_vma_unlock_write(vma);
477 
478 		goto retry;
479 	}
480 }
481 
482 static void
hugetlb_vmdelete_list(struct rb_root_cached * root,pgoff_t start,pgoff_t end,zap_flags_t zap_flags)483 hugetlb_vmdelete_list(struct rb_root_cached *root, pgoff_t start, pgoff_t end,
484 		      zap_flags_t zap_flags)
485 {
486 	struct vm_area_struct *vma;
487 
488 	/*
489 	 * end == 0 indicates that the entire range after start should be
490 	 * unmapped.  Note, end is exclusive, whereas the interval tree takes
491 	 * an inclusive "last".
492 	 */
493 	vma_interval_tree_foreach(vma, root, start, end ? end - 1 : ULONG_MAX) {
494 		unsigned long v_start;
495 		unsigned long v_end;
496 
497 		if (!hugetlb_vma_trylock_write(vma))
498 			continue;
499 
500 		v_start = vma_offset_start(vma, start);
501 		v_end = vma_offset_end(vma, end);
502 
503 		unmap_hugepage_range(vma, v_start, v_end, NULL, zap_flags);
504 
505 		/*
506 		 * Note that vma lock only exists for shared/non-private
507 		 * vmas.  Therefore, lock is not held when calling
508 		 * unmap_hugepage_range for private vmas.
509 		 */
510 		hugetlb_vma_unlock_write(vma);
511 	}
512 }
513 
514 /*
515  * Called with hugetlb fault mutex held.
516  */
remove_inode_single_folio(struct hstate * h,struct inode * inode,struct address_space * mapping,struct folio * folio,pgoff_t index,bool truncate_op)517 static void remove_inode_single_folio(struct hstate *h, struct inode *inode,
518 		struct address_space *mapping, struct folio *folio,
519 		pgoff_t index, bool truncate_op)
520 {
521 	/*
522 	 * If folio is mapped, it was faulted in after being
523 	 * unmapped in caller or hugetlb_vmdelete_list() skips
524 	 * unmapping it due to fail to grab lock.  Unmap (again)
525 	 * while holding the fault mutex.  The mutex will prevent
526 	 * faults until we finish removing the folio.  Hold folio
527 	 * lock to guarantee no concurrent migration.
528 	 */
529 	folio_lock(folio);
530 	if (unlikely(folio_mapped(folio)))
531 		hugetlb_unmap_file_folio(h, mapping, folio, index);
532 
533 	/*
534 	 * We must remove the folio from page cache before removing
535 	 * the region/ reserve map (hugetlb_unreserve_pages).  In
536 	 * rare out of memory conditions, removal of the region/reserve
537 	 * map could fail.  Correspondingly, the subpool and global
538 	 * reserve usage count can need to be adjusted.
539 	 */
540 	VM_BUG_ON_FOLIO(folio_test_hugetlb_restore_reserve(folio), folio);
541 	hugetlb_delete_from_page_cache(folio);
542 	if (!truncate_op) {
543 		if (unlikely(hugetlb_unreserve_pages(inode, index,
544 							index + 1, 1)))
545 			hugetlb_fix_reserve_counts(inode);
546 	}
547 
548 	folio_unlock(folio);
549 }
550 
551 /*
552  * remove_inode_hugepages handles two distinct cases: truncation and hole
553  * punch.  There are subtle differences in operation for each case.
554  *
555  * truncation is indicated by end of range being LLONG_MAX
556  *	In this case, we first scan the range and release found pages.
557  *	After releasing pages, hugetlb_unreserve_pages cleans up region/reserve
558  *	maps and global counts.  Page faults can race with truncation.
559  *	During faults, hugetlb_no_page() checks i_size before page allocation,
560  *	and again after obtaining page table lock.  It will 'back out'
561  *	allocations in the truncated range.
562  * hole punch is indicated if end is not LLONG_MAX
563  *	In the hole punch case we scan the range and release found pages.
564  *	Only when releasing a page is the associated region/reserve map
565  *	deleted.  The region/reserve map for ranges without associated
566  *	pages are not modified.  Page faults can race with hole punch.
567  *	This is indicated if we find a mapped page.
568  * Note: If the passed end of range value is beyond the end of file, but
569  * not LLONG_MAX this routine still performs a hole punch operation.
570  */
remove_inode_hugepages(struct inode * inode,loff_t lstart,loff_t lend)571 static void remove_inode_hugepages(struct inode *inode, loff_t lstart,
572 				   loff_t lend)
573 {
574 	struct hstate *h = hstate_inode(inode);
575 	struct address_space *mapping = &inode->i_data;
576 	const pgoff_t end = lend >> PAGE_SHIFT;
577 	struct folio_batch fbatch;
578 	pgoff_t next, index;
579 	int i, freed = 0;
580 	bool truncate_op = (lend == LLONG_MAX);
581 
582 	folio_batch_init(&fbatch);
583 	next = lstart >> PAGE_SHIFT;
584 	while (filemap_get_folios(mapping, &next, end - 1, &fbatch)) {
585 		for (i = 0; i < folio_batch_count(&fbatch); ++i) {
586 			struct folio *folio = fbatch.folios[i];
587 			u32 hash = 0;
588 
589 			index = folio->index >> huge_page_order(h);
590 			hash = hugetlb_fault_mutex_hash(mapping, index);
591 			mutex_lock(&hugetlb_fault_mutex_table[hash]);
592 
593 			/*
594 			 * Remove folio that was part of folio_batch.
595 			 */
596 			remove_inode_single_folio(h, inode, mapping, folio,
597 						  index, truncate_op);
598 			freed++;
599 
600 			mutex_unlock(&hugetlb_fault_mutex_table[hash]);
601 		}
602 		folio_batch_release(&fbatch);
603 		cond_resched();
604 	}
605 
606 	if (truncate_op)
607 		(void)hugetlb_unreserve_pages(inode,
608 				lstart >> huge_page_shift(h),
609 				LONG_MAX, freed);
610 }
611 
hugetlbfs_evict_inode(struct inode * inode)612 static void hugetlbfs_evict_inode(struct inode *inode)
613 {
614 	struct resv_map *resv_map;
615 
616 	trace_hugetlbfs_evict_inode(inode);
617 	remove_inode_hugepages(inode, 0, LLONG_MAX);
618 
619 	resv_map = HUGETLBFS_I(inode)->resv_map;
620 	/* Only regular and link inodes have associated reserve maps */
621 	if (resv_map)
622 		resv_map_release(&resv_map->refs);
623 	clear_inode(inode);
624 }
625 
hugetlb_vmtruncate(struct inode * inode,loff_t offset)626 static void hugetlb_vmtruncate(struct inode *inode, loff_t offset)
627 {
628 	pgoff_t pgoff;
629 	struct address_space *mapping = inode->i_mapping;
630 	struct hstate *h = hstate_inode(inode);
631 
632 	BUG_ON(offset & ~huge_page_mask(h));
633 	pgoff = offset >> PAGE_SHIFT;
634 
635 	i_size_write(inode, offset);
636 	i_mmap_lock_write(mapping);
637 	if (!RB_EMPTY_ROOT(&mapping->i_mmap.rb_root))
638 		hugetlb_vmdelete_list(&mapping->i_mmap, pgoff, 0,
639 				      ZAP_FLAG_DROP_MARKER);
640 	i_mmap_unlock_write(mapping);
641 	remove_inode_hugepages(inode, offset, LLONG_MAX);
642 }
643 
hugetlbfs_zero_partial_page(struct hstate * h,struct address_space * mapping,loff_t start,loff_t end)644 static void hugetlbfs_zero_partial_page(struct hstate *h,
645 					struct address_space *mapping,
646 					loff_t start,
647 					loff_t end)
648 {
649 	pgoff_t idx = start >> huge_page_shift(h);
650 	struct folio *folio;
651 
652 	folio = filemap_lock_hugetlb_folio(h, mapping, idx);
653 	if (IS_ERR(folio))
654 		return;
655 
656 	start = start & ~huge_page_mask(h);
657 	end = end & ~huge_page_mask(h);
658 	if (!end)
659 		end = huge_page_size(h);
660 
661 	folio_zero_segment(folio, (size_t)start, (size_t)end);
662 
663 	folio_unlock(folio);
664 	folio_put(folio);
665 }
666 
hugetlbfs_punch_hole(struct inode * inode,loff_t offset,loff_t len)667 static long hugetlbfs_punch_hole(struct inode *inode, loff_t offset, loff_t len)
668 {
669 	struct hugetlbfs_inode_info *info = HUGETLBFS_I(inode);
670 	struct address_space *mapping = inode->i_mapping;
671 	struct hstate *h = hstate_inode(inode);
672 	loff_t hpage_size = huge_page_size(h);
673 	loff_t hole_start, hole_end;
674 
675 	/*
676 	 * hole_start and hole_end indicate the full pages within the hole.
677 	 */
678 	hole_start = round_up(offset, hpage_size);
679 	hole_end = round_down(offset + len, hpage_size);
680 
681 	inode_lock(inode);
682 
683 	/* protected by i_rwsem */
684 	if (info->seals & (F_SEAL_WRITE | F_SEAL_FUTURE_WRITE)) {
685 		inode_unlock(inode);
686 		return -EPERM;
687 	}
688 
689 	i_mmap_lock_write(mapping);
690 
691 	/* If range starts before first full page, zero partial page. */
692 	if (offset < hole_start)
693 		hugetlbfs_zero_partial_page(h, mapping,
694 				offset, min(offset + len, hole_start));
695 
696 	/* Unmap users of full pages in the hole. */
697 	if (hole_end > hole_start) {
698 		if (!RB_EMPTY_ROOT(&mapping->i_mmap.rb_root))
699 			hugetlb_vmdelete_list(&mapping->i_mmap,
700 					      hole_start >> PAGE_SHIFT,
701 					      hole_end >> PAGE_SHIFT, 0);
702 	}
703 
704 	/* If range extends beyond last full page, zero partial page. */
705 	if ((offset + len) > hole_end && (offset + len) > hole_start)
706 		hugetlbfs_zero_partial_page(h, mapping,
707 				hole_end, offset + len);
708 
709 	i_mmap_unlock_write(mapping);
710 
711 	/* Remove full pages from the file. */
712 	if (hole_end > hole_start)
713 		remove_inode_hugepages(inode, hole_start, hole_end);
714 
715 	inode_unlock(inode);
716 
717 	return 0;
718 }
719 
hugetlbfs_fallocate(struct file * file,int mode,loff_t offset,loff_t len)720 static long hugetlbfs_fallocate(struct file *file, int mode, loff_t offset,
721 				loff_t len)
722 {
723 	struct inode *inode = file_inode(file);
724 	struct hugetlbfs_inode_info *info = HUGETLBFS_I(inode);
725 	struct address_space *mapping = inode->i_mapping;
726 	struct hstate *h = hstate_inode(inode);
727 	struct vm_area_struct pseudo_vma;
728 	struct mm_struct *mm = current->mm;
729 	loff_t hpage_size = huge_page_size(h);
730 	unsigned long hpage_shift = huge_page_shift(h);
731 	pgoff_t start, index, end;
732 	int error;
733 	u32 hash;
734 
735 	if (mode & ~(FALLOC_FL_KEEP_SIZE | FALLOC_FL_PUNCH_HOLE))
736 		return -EOPNOTSUPP;
737 
738 	if (mode & FALLOC_FL_PUNCH_HOLE) {
739 		error = hugetlbfs_punch_hole(inode, offset, len);
740 		goto out_nolock;
741 	}
742 
743 	/*
744 	 * Default preallocate case.
745 	 * For this range, start is rounded down and end is rounded up
746 	 * as well as being converted to page offsets.
747 	 */
748 	start = offset >> hpage_shift;
749 	end = (offset + len + hpage_size - 1) >> hpage_shift;
750 
751 	inode_lock(inode);
752 
753 	/* We need to check rlimit even when FALLOC_FL_KEEP_SIZE */
754 	error = inode_newsize_ok(inode, offset + len);
755 	if (error)
756 		goto out;
757 
758 	if ((info->seals & F_SEAL_GROW) && offset + len > inode->i_size) {
759 		error = -EPERM;
760 		goto out;
761 	}
762 
763 	/*
764 	 * Initialize a pseudo vma as this is required by the huge page
765 	 * allocation routines.
766 	 */
767 	vma_init(&pseudo_vma, mm);
768 	vm_flags_init(&pseudo_vma, VM_HUGETLB | VM_MAYSHARE | VM_SHARED);
769 	pseudo_vma.vm_file = file;
770 
771 	for (index = start; index < end; index++) {
772 		/*
773 		 * This is supposed to be the vaddr where the page is being
774 		 * faulted in, but we have no vaddr here.
775 		 */
776 		struct folio *folio;
777 		unsigned long addr;
778 
779 		cond_resched();
780 
781 		/*
782 		 * fallocate(2) manpage permits EINTR; we may have been
783 		 * interrupted because we are using up too much memory.
784 		 */
785 		if (signal_pending(current)) {
786 			error = -EINTR;
787 			break;
788 		}
789 
790 		/* addr is the offset within the file (zero based) */
791 		addr = index * hpage_size;
792 
793 		/* mutex taken here, fault path and hole punch */
794 		hash = hugetlb_fault_mutex_hash(mapping, index);
795 		mutex_lock(&hugetlb_fault_mutex_table[hash]);
796 
797 		/* See if already present in mapping to avoid alloc/free */
798 		folio = filemap_get_folio(mapping, index << huge_page_order(h));
799 		if (!IS_ERR(folio)) {
800 			folio_put(folio);
801 			mutex_unlock(&hugetlb_fault_mutex_table[hash]);
802 			continue;
803 		}
804 
805 		/*
806 		 * Allocate folio without setting the avoid_reserve argument.
807 		 * There certainly are no reserves associated with the
808 		 * pseudo_vma.  However, there could be shared mappings with
809 		 * reserves for the file at the inode level.  If we fallocate
810 		 * folios in these areas, we need to consume the reserves
811 		 * to keep reservation accounting consistent.
812 		 */
813 		folio = alloc_hugetlb_folio(&pseudo_vma, addr, false);
814 		if (IS_ERR(folio)) {
815 			mutex_unlock(&hugetlb_fault_mutex_table[hash]);
816 			error = PTR_ERR(folio);
817 			goto out;
818 		}
819 		folio_zero_user(folio, addr);
820 		__folio_mark_uptodate(folio);
821 		error = hugetlb_add_to_page_cache(folio, mapping, index);
822 		if (unlikely(error)) {
823 			restore_reserve_on_error(h, &pseudo_vma, addr, folio);
824 			folio_put(folio);
825 			mutex_unlock(&hugetlb_fault_mutex_table[hash]);
826 			goto out;
827 		}
828 
829 		mutex_unlock(&hugetlb_fault_mutex_table[hash]);
830 
831 		folio_set_hugetlb_migratable(folio);
832 		/*
833 		 * folio_unlock because locked by hugetlb_add_to_page_cache()
834 		 * folio_put() due to reference from alloc_hugetlb_folio()
835 		 */
836 		folio_unlock(folio);
837 		folio_put(folio);
838 	}
839 
840 	if (!(mode & FALLOC_FL_KEEP_SIZE) && offset + len > inode->i_size)
841 		i_size_write(inode, offset + len);
842 	inode_set_ctime_current(inode);
843 out:
844 	inode_unlock(inode);
845 
846 out_nolock:
847 	trace_hugetlbfs_fallocate(inode, mode, offset, len, error);
848 	return error;
849 }
850 
hugetlbfs_setattr(struct mnt_idmap * idmap,struct dentry * dentry,struct iattr * attr)851 static int hugetlbfs_setattr(struct mnt_idmap *idmap,
852 			     struct dentry *dentry, struct iattr *attr)
853 {
854 	struct inode *inode = d_inode(dentry);
855 	struct hstate *h = hstate_inode(inode);
856 	int error;
857 	unsigned int ia_valid = attr->ia_valid;
858 	struct hugetlbfs_inode_info *info = HUGETLBFS_I(inode);
859 
860 	error = setattr_prepare(idmap, dentry, attr);
861 	if (error)
862 		return error;
863 
864 	trace_hugetlbfs_setattr(inode, dentry, attr);
865 
866 	if (ia_valid & ATTR_SIZE) {
867 		loff_t oldsize = inode->i_size;
868 		loff_t newsize = attr->ia_size;
869 
870 		if (newsize & ~huge_page_mask(h))
871 			return -EINVAL;
872 		/* protected by i_rwsem */
873 		if ((newsize < oldsize && (info->seals & F_SEAL_SHRINK)) ||
874 		    (newsize > oldsize && (info->seals & F_SEAL_GROW)))
875 			return -EPERM;
876 		hugetlb_vmtruncate(inode, newsize);
877 	}
878 
879 	setattr_copy(idmap, inode, attr);
880 	mark_inode_dirty(inode);
881 	return 0;
882 }
883 
hugetlbfs_get_root(struct super_block * sb,struct hugetlbfs_fs_context * ctx)884 static struct inode *hugetlbfs_get_root(struct super_block *sb,
885 					struct hugetlbfs_fs_context *ctx)
886 {
887 	struct inode *inode;
888 
889 	inode = new_inode(sb);
890 	if (inode) {
891 		inode->i_ino = get_next_ino();
892 		inode->i_mode = S_IFDIR | ctx->mode;
893 		inode->i_uid = ctx->uid;
894 		inode->i_gid = ctx->gid;
895 		simple_inode_init_ts(inode);
896 		inode->i_op = &hugetlbfs_dir_inode_operations;
897 		inode->i_fop = &simple_dir_operations;
898 		HUGETLBFS_I(inode)->resv_map = NULL;
899 		/* directory inodes start off with i_nlink == 2 (for "." entry) */
900 		inc_nlink(inode);
901 		lockdep_annotate_inode_mutex_key(inode);
902 	}
903 	return inode;
904 }
905 
906 /*
907  * Hugetlbfs is not reclaimable; therefore its i_mmap_rwsem will never
908  * be taken from reclaim -- unlike regular filesystems. This needs an
909  * annotation because huge_pmd_share() does an allocation under hugetlb's
910  * i_mmap_rwsem.
911  */
912 static struct lock_class_key hugetlbfs_i_mmap_rwsem_key;
913 
hugetlbfs_get_inode(struct super_block * sb,struct mnt_idmap * idmap,struct inode * dir,umode_t mode,dev_t dev)914 static struct inode *hugetlbfs_get_inode(struct super_block *sb,
915 					struct mnt_idmap *idmap,
916 					struct inode *dir,
917 					umode_t mode, dev_t dev)
918 {
919 	struct inode *inode;
920 	struct resv_map *resv_map = NULL;
921 
922 	/*
923 	 * Reserve maps are only needed for inodes that can have associated
924 	 * page allocations.
925 	 */
926 	if (S_ISREG(mode) || S_ISLNK(mode)) {
927 		resv_map = resv_map_alloc();
928 		if (!resv_map)
929 			return NULL;
930 	}
931 
932 	inode = new_inode(sb);
933 	if (inode) {
934 		struct hugetlbfs_inode_info *info = HUGETLBFS_I(inode);
935 
936 		inode->i_ino = get_next_ino();
937 		inode_init_owner(idmap, inode, dir, mode);
938 		lockdep_set_class(&inode->i_mapping->i_mmap_rwsem,
939 				&hugetlbfs_i_mmap_rwsem_key);
940 		inode->i_mapping->a_ops = &hugetlbfs_aops;
941 		simple_inode_init_ts(inode);
942 		info->resv_map = resv_map;
943 		info->seals = F_SEAL_SEAL;
944 		switch (mode & S_IFMT) {
945 		default:
946 			init_special_inode(inode, mode, dev);
947 			break;
948 		case S_IFREG:
949 			inode->i_op = &hugetlbfs_inode_operations;
950 			inode->i_fop = &hugetlbfs_file_operations;
951 			break;
952 		case S_IFDIR:
953 			inode->i_op = &hugetlbfs_dir_inode_operations;
954 			inode->i_fop = &simple_dir_operations;
955 
956 			/* directory inodes start off with i_nlink == 2 (for "." entry) */
957 			inc_nlink(inode);
958 			break;
959 		case S_IFLNK:
960 			inode->i_op = &page_symlink_inode_operations;
961 			inode_nohighmem(inode);
962 			break;
963 		}
964 		lockdep_annotate_inode_mutex_key(inode);
965 		trace_hugetlbfs_alloc_inode(inode, dir, mode);
966 	} else {
967 		if (resv_map)
968 			kref_put(&resv_map->refs, resv_map_release);
969 	}
970 
971 	return inode;
972 }
973 
974 /*
975  * File creation. Allocate an inode, and we're done..
976  */
hugetlbfs_mknod(struct mnt_idmap * idmap,struct inode * dir,struct dentry * dentry,umode_t mode,dev_t dev)977 static int hugetlbfs_mknod(struct mnt_idmap *idmap, struct inode *dir,
978 			   struct dentry *dentry, umode_t mode, dev_t dev)
979 {
980 	struct inode *inode;
981 
982 	inode = hugetlbfs_get_inode(dir->i_sb, idmap, dir, mode, dev);
983 	if (!inode)
984 		return -ENOSPC;
985 	inode_set_mtime_to_ts(dir, inode_set_ctime_current(dir));
986 	d_make_persistent(dentry, inode);
987 	return 0;
988 }
989 
hugetlbfs_mkdir(struct mnt_idmap * idmap,struct inode * dir,struct dentry * dentry,umode_t mode)990 static struct dentry *hugetlbfs_mkdir(struct mnt_idmap *idmap, struct inode *dir,
991 				      struct dentry *dentry, umode_t mode)
992 {
993 	int retval = hugetlbfs_mknod(idmap, dir, dentry,
994 				     mode | S_IFDIR, 0);
995 	if (!retval)
996 		inc_nlink(dir);
997 	return ERR_PTR(retval);
998 }
999 
hugetlbfs_create(struct mnt_idmap * idmap,struct inode * dir,struct dentry * dentry,umode_t mode,bool excl)1000 static int hugetlbfs_create(struct mnt_idmap *idmap,
1001 			    struct inode *dir, struct dentry *dentry,
1002 			    umode_t mode, bool excl)
1003 {
1004 	return hugetlbfs_mknod(idmap, dir, dentry, mode | S_IFREG, 0);
1005 }
1006 
hugetlbfs_tmpfile(struct mnt_idmap * idmap,struct inode * dir,struct file * file,umode_t mode)1007 static int hugetlbfs_tmpfile(struct mnt_idmap *idmap,
1008 			     struct inode *dir, struct file *file,
1009 			     umode_t mode)
1010 {
1011 	struct inode *inode;
1012 
1013 	inode = hugetlbfs_get_inode(dir->i_sb, idmap, dir, mode | S_IFREG, 0);
1014 	if (!inode)
1015 		return -ENOSPC;
1016 	inode_set_mtime_to_ts(dir, inode_set_ctime_current(dir));
1017 	d_tmpfile(file, inode);
1018 	return finish_open_simple(file, 0);
1019 }
1020 
hugetlbfs_symlink(struct mnt_idmap * idmap,struct inode * dir,struct dentry * dentry,const char * symname)1021 static int hugetlbfs_symlink(struct mnt_idmap *idmap,
1022 			     struct inode *dir, struct dentry *dentry,
1023 			     const char *symname)
1024 {
1025 	const umode_t mode = S_IFLNK|S_IRWXUGO;
1026 	struct inode *inode;
1027 	int error = -ENOSPC;
1028 
1029 	inode = hugetlbfs_get_inode(dir->i_sb, idmap, dir, mode, 0);
1030 	if (inode) {
1031 		int l = strlen(symname)+1;
1032 		error = page_symlink(inode, symname, l);
1033 		if (!error)
1034 			d_make_persistent(dentry, inode);
1035 		else
1036 			iput(inode);
1037 	}
1038 	inode_set_mtime_to_ts(dir, inode_set_ctime_current(dir));
1039 
1040 	return error;
1041 }
1042 
1043 #ifdef CONFIG_MIGRATION
hugetlbfs_migrate_folio(struct address_space * mapping,struct folio * dst,struct folio * src,enum migrate_mode mode)1044 static int hugetlbfs_migrate_folio(struct address_space *mapping,
1045 				struct folio *dst, struct folio *src,
1046 				enum migrate_mode mode)
1047 {
1048 	int rc;
1049 
1050 	rc = migrate_huge_page_move_mapping(mapping, dst, src);
1051 	if (rc)
1052 		return rc;
1053 
1054 	if (hugetlb_folio_subpool(src)) {
1055 		hugetlb_set_folio_subpool(dst,
1056 					hugetlb_folio_subpool(src));
1057 		hugetlb_set_folio_subpool(src, NULL);
1058 	}
1059 
1060 	folio_migrate_flags(dst, src);
1061 
1062 	return 0;
1063 }
1064 #else
1065 #define hugetlbfs_migrate_folio NULL
1066 #endif
1067 
hugetlbfs_error_remove_folio(struct address_space * mapping,struct folio * folio)1068 static int hugetlbfs_error_remove_folio(struct address_space *mapping,
1069 				struct folio *folio)
1070 {
1071 	return 0;
1072 }
1073 
1074 /*
1075  * Display the mount options in /proc/mounts.
1076  */
hugetlbfs_show_options(struct seq_file * m,struct dentry * root)1077 static int hugetlbfs_show_options(struct seq_file *m, struct dentry *root)
1078 {
1079 	struct hugetlbfs_sb_info *sbinfo = HUGETLBFS_SB(root->d_sb);
1080 	struct hugepage_subpool *spool = sbinfo->spool;
1081 	unsigned long hpage_size = huge_page_size(sbinfo->hstate);
1082 	unsigned hpage_shift = huge_page_shift(sbinfo->hstate);
1083 	char mod;
1084 
1085 	if (!uid_eq(sbinfo->uid, GLOBAL_ROOT_UID))
1086 		seq_printf(m, ",uid=%u",
1087 			   from_kuid_munged(&init_user_ns, sbinfo->uid));
1088 	if (!gid_eq(sbinfo->gid, GLOBAL_ROOT_GID))
1089 		seq_printf(m, ",gid=%u",
1090 			   from_kgid_munged(&init_user_ns, sbinfo->gid));
1091 	if (sbinfo->mode != 0755)
1092 		seq_printf(m, ",mode=%o", sbinfo->mode);
1093 	if (sbinfo->max_inodes != -1)
1094 		seq_printf(m, ",nr_inodes=%lu", sbinfo->max_inodes);
1095 
1096 	hpage_size /= 1024;
1097 	mod = 'K';
1098 	if (hpage_size >= 1024) {
1099 		hpage_size /= 1024;
1100 		mod = 'M';
1101 	}
1102 	seq_printf(m, ",pagesize=%lu%c", hpage_size, mod);
1103 	if (spool) {
1104 		if (spool->max_hpages != -1)
1105 			seq_printf(m, ",size=%llu",
1106 				   (unsigned long long)spool->max_hpages << hpage_shift);
1107 		if (spool->min_hpages != -1)
1108 			seq_printf(m, ",min_size=%llu",
1109 				   (unsigned long long)spool->min_hpages << hpage_shift);
1110 	}
1111 	return 0;
1112 }
1113 
hugetlbfs_statfs(struct dentry * dentry,struct kstatfs * buf)1114 static int hugetlbfs_statfs(struct dentry *dentry, struct kstatfs *buf)
1115 {
1116 	struct hugetlbfs_sb_info *sbinfo = HUGETLBFS_SB(dentry->d_sb);
1117 	struct hstate *h = hstate_inode(d_inode(dentry));
1118 	u64 id = huge_encode_dev(dentry->d_sb->s_dev);
1119 
1120 	buf->f_fsid = u64_to_fsid(id);
1121 	buf->f_type = HUGETLBFS_MAGIC;
1122 	buf->f_bsize = huge_page_size(h);
1123 	if (sbinfo) {
1124 		spin_lock(&sbinfo->stat_lock);
1125 		/* If no limits set, just report 0 or -1 for max/free/used
1126 		 * blocks, like simple_statfs() */
1127 		if (sbinfo->spool) {
1128 			long free_pages;
1129 
1130 			spin_lock_irq(&sbinfo->spool->lock);
1131 			buf->f_blocks = sbinfo->spool->max_hpages;
1132 			free_pages = sbinfo->spool->max_hpages
1133 				- sbinfo->spool->used_hpages;
1134 			buf->f_bavail = buf->f_bfree = free_pages;
1135 			spin_unlock_irq(&sbinfo->spool->lock);
1136 			buf->f_files = sbinfo->max_inodes;
1137 			buf->f_ffree = sbinfo->free_inodes;
1138 		}
1139 		spin_unlock(&sbinfo->stat_lock);
1140 	}
1141 	buf->f_namelen = NAME_MAX;
1142 	return 0;
1143 }
1144 
hugetlbfs_put_super(struct super_block * sb)1145 static void hugetlbfs_put_super(struct super_block *sb)
1146 {
1147 	struct hugetlbfs_sb_info *sbi = HUGETLBFS_SB(sb);
1148 
1149 	if (sbi) {
1150 		sb->s_fs_info = NULL;
1151 
1152 		if (sbi->spool)
1153 			hugepage_put_subpool(sbi->spool);
1154 
1155 		kfree(sbi);
1156 	}
1157 }
1158 
hugetlbfs_dec_free_inodes(struct hugetlbfs_sb_info * sbinfo)1159 static inline int hugetlbfs_dec_free_inodes(struct hugetlbfs_sb_info *sbinfo)
1160 {
1161 	if (sbinfo->free_inodes >= 0) {
1162 		spin_lock(&sbinfo->stat_lock);
1163 		if (unlikely(!sbinfo->free_inodes)) {
1164 			spin_unlock(&sbinfo->stat_lock);
1165 			return 0;
1166 		}
1167 		sbinfo->free_inodes--;
1168 		spin_unlock(&sbinfo->stat_lock);
1169 	}
1170 
1171 	return 1;
1172 }
1173 
hugetlbfs_inc_free_inodes(struct hugetlbfs_sb_info * sbinfo)1174 static void hugetlbfs_inc_free_inodes(struct hugetlbfs_sb_info *sbinfo)
1175 {
1176 	if (sbinfo->free_inodes >= 0) {
1177 		spin_lock(&sbinfo->stat_lock);
1178 		sbinfo->free_inodes++;
1179 		spin_unlock(&sbinfo->stat_lock);
1180 	}
1181 }
1182 
1183 
1184 static struct kmem_cache *hugetlbfs_inode_cachep;
1185 
hugetlbfs_alloc_inode(struct super_block * sb)1186 static struct inode *hugetlbfs_alloc_inode(struct super_block *sb)
1187 {
1188 	struct hugetlbfs_sb_info *sbinfo = HUGETLBFS_SB(sb);
1189 	struct hugetlbfs_inode_info *p;
1190 
1191 	if (unlikely(!hugetlbfs_dec_free_inodes(sbinfo)))
1192 		return NULL;
1193 	p = alloc_inode_sb(sb, hugetlbfs_inode_cachep, GFP_KERNEL);
1194 	if (unlikely(!p)) {
1195 		hugetlbfs_inc_free_inodes(sbinfo);
1196 		return NULL;
1197 	}
1198 	return &p->vfs_inode;
1199 }
1200 
hugetlbfs_free_inode(struct inode * inode)1201 static void hugetlbfs_free_inode(struct inode *inode)
1202 {
1203 	trace_hugetlbfs_free_inode(inode);
1204 	kmem_cache_free(hugetlbfs_inode_cachep, HUGETLBFS_I(inode));
1205 }
1206 
hugetlbfs_destroy_inode(struct inode * inode)1207 static void hugetlbfs_destroy_inode(struct inode *inode)
1208 {
1209 	hugetlbfs_inc_free_inodes(HUGETLBFS_SB(inode->i_sb));
1210 }
1211 
1212 static const struct address_space_operations hugetlbfs_aops = {
1213 	.write_begin	= hugetlbfs_write_begin,
1214 	.write_end	= hugetlbfs_write_end,
1215 	.dirty_folio	= noop_dirty_folio,
1216 	.migrate_folio  = hugetlbfs_migrate_folio,
1217 	.error_remove_folio	= hugetlbfs_error_remove_folio,
1218 };
1219 
1220 
init_once(void * foo)1221 static void init_once(void *foo)
1222 {
1223 	struct hugetlbfs_inode_info *ei = foo;
1224 
1225 	inode_init_once(&ei->vfs_inode);
1226 }
1227 
1228 static const struct file_operations hugetlbfs_file_operations = {
1229 	.read_iter		= hugetlbfs_read_iter,
1230 	.mmap_prepare		= hugetlbfs_file_mmap_prepare,
1231 	.fsync			= noop_fsync,
1232 	.get_unmapped_area	= hugetlb_get_unmapped_area,
1233 	.llseek			= default_llseek,
1234 	.fallocate		= hugetlbfs_fallocate,
1235 	.fop_flags		= FOP_HUGE_PAGES,
1236 };
1237 
1238 static const struct inode_operations hugetlbfs_dir_inode_operations = {
1239 	.create		= hugetlbfs_create,
1240 	.lookup		= simple_lookup,
1241 	.link		= simple_link,
1242 	.unlink		= simple_unlink,
1243 	.symlink	= hugetlbfs_symlink,
1244 	.mkdir		= hugetlbfs_mkdir,
1245 	.rmdir		= simple_rmdir,
1246 	.mknod		= hugetlbfs_mknod,
1247 	.rename		= simple_rename,
1248 	.setattr	= hugetlbfs_setattr,
1249 	.tmpfile	= hugetlbfs_tmpfile,
1250 };
1251 
1252 static const struct inode_operations hugetlbfs_inode_operations = {
1253 	.setattr	= hugetlbfs_setattr,
1254 };
1255 
1256 static const struct super_operations hugetlbfs_ops = {
1257 	.alloc_inode    = hugetlbfs_alloc_inode,
1258 	.free_inode     = hugetlbfs_free_inode,
1259 	.destroy_inode  = hugetlbfs_destroy_inode,
1260 	.evict_inode	= hugetlbfs_evict_inode,
1261 	.statfs		= hugetlbfs_statfs,
1262 	.put_super	= hugetlbfs_put_super,
1263 	.show_options	= hugetlbfs_show_options,
1264 };
1265 
1266 /*
1267  * Convert size option passed from command line to number of huge pages
1268  * in the pool specified by hstate.  Size option could be in bytes
1269  * (val_type == SIZE_STD) or percentage of the pool (val_type == SIZE_PERCENT).
1270  */
1271 static long
hugetlbfs_size_to_hpages(struct hstate * h,unsigned long long size_opt,enum hugetlbfs_size_type val_type)1272 hugetlbfs_size_to_hpages(struct hstate *h, unsigned long long size_opt,
1273 			 enum hugetlbfs_size_type val_type)
1274 {
1275 	if (val_type == NO_SIZE)
1276 		return -1;
1277 
1278 	if (val_type == SIZE_PERCENT) {
1279 		size_opt <<= huge_page_shift(h);
1280 		size_opt *= h->max_huge_pages;
1281 		do_div(size_opt, 100);
1282 	}
1283 
1284 	size_opt >>= huge_page_shift(h);
1285 	return size_opt;
1286 }
1287 
1288 /*
1289  * Parse one mount parameter.
1290  */
hugetlbfs_parse_param(struct fs_context * fc,struct fs_parameter * param)1291 static int hugetlbfs_parse_param(struct fs_context *fc, struct fs_parameter *param)
1292 {
1293 	struct hugetlbfs_fs_context *ctx = fc->fs_private;
1294 	struct fs_parse_result result;
1295 	struct hstate *h;
1296 	char *rest;
1297 	unsigned long ps;
1298 	int opt;
1299 
1300 	opt = fs_parse(fc, hugetlb_fs_parameters, param, &result);
1301 	if (opt < 0)
1302 		return opt;
1303 
1304 	switch (opt) {
1305 	case Opt_uid:
1306 		ctx->uid = result.uid;
1307 		return 0;
1308 
1309 	case Opt_gid:
1310 		ctx->gid = result.gid;
1311 		return 0;
1312 
1313 	case Opt_mode:
1314 		ctx->mode = result.uint_32 & 01777U;
1315 		return 0;
1316 
1317 	case Opt_size:
1318 		/* memparse() will accept a K/M/G without a digit */
1319 		if (!param->string || !isdigit(param->string[0]))
1320 			goto bad_val;
1321 		ctx->max_size_opt = memparse(param->string, &rest);
1322 		ctx->max_val_type = SIZE_STD;
1323 		if (*rest == '%')
1324 			ctx->max_val_type = SIZE_PERCENT;
1325 		return 0;
1326 
1327 	case Opt_nr_inodes:
1328 		/* memparse() will accept a K/M/G without a digit */
1329 		if (!param->string || !isdigit(param->string[0]))
1330 			goto bad_val;
1331 		ctx->nr_inodes = memparse(param->string, &rest);
1332 		return 0;
1333 
1334 	case Opt_pagesize:
1335 		ps = memparse(param->string, &rest);
1336 		h = size_to_hstate(ps);
1337 		if (!h) {
1338 			pr_err("Unsupported page size %lu MB\n", ps / SZ_1M);
1339 			return -EINVAL;
1340 		}
1341 		ctx->hstate = h;
1342 		return 0;
1343 
1344 	case Opt_min_size:
1345 		/* memparse() will accept a K/M/G without a digit */
1346 		if (!param->string || !isdigit(param->string[0]))
1347 			goto bad_val;
1348 		ctx->min_size_opt = memparse(param->string, &rest);
1349 		ctx->min_val_type = SIZE_STD;
1350 		if (*rest == '%')
1351 			ctx->min_val_type = SIZE_PERCENT;
1352 		return 0;
1353 
1354 	default:
1355 		return -EINVAL;
1356 	}
1357 
1358 bad_val:
1359 	return invalfc(fc, "Bad value '%s' for mount option '%s'\n",
1360 		      param->string, param->key);
1361 }
1362 
1363 /*
1364  * Validate the parsed options.
1365  */
hugetlbfs_validate(struct fs_context * fc)1366 static int hugetlbfs_validate(struct fs_context *fc)
1367 {
1368 	struct hugetlbfs_fs_context *ctx = fc->fs_private;
1369 
1370 	/*
1371 	 * Use huge page pool size (in hstate) to convert the size
1372 	 * options to number of huge pages.  If NO_SIZE, -1 is returned.
1373 	 */
1374 	ctx->max_hpages = hugetlbfs_size_to_hpages(ctx->hstate,
1375 						   ctx->max_size_opt,
1376 						   ctx->max_val_type);
1377 	ctx->min_hpages = hugetlbfs_size_to_hpages(ctx->hstate,
1378 						   ctx->min_size_opt,
1379 						   ctx->min_val_type);
1380 
1381 	/*
1382 	 * If max_size was specified, then min_size must be smaller
1383 	 */
1384 	if (ctx->max_val_type > NO_SIZE &&
1385 	    ctx->min_hpages > ctx->max_hpages) {
1386 		pr_err("Minimum size can not be greater than maximum size\n");
1387 		return -EINVAL;
1388 	}
1389 
1390 	return 0;
1391 }
1392 
1393 static int
hugetlbfs_fill_super(struct super_block * sb,struct fs_context * fc)1394 hugetlbfs_fill_super(struct super_block *sb, struct fs_context *fc)
1395 {
1396 	struct hugetlbfs_fs_context *ctx = fc->fs_private;
1397 	struct hugetlbfs_sb_info *sbinfo;
1398 
1399 	sbinfo = kmalloc_obj(struct hugetlbfs_sb_info);
1400 	if (!sbinfo)
1401 		return -ENOMEM;
1402 	sb->s_fs_info = sbinfo;
1403 	spin_lock_init(&sbinfo->stat_lock);
1404 	sbinfo->hstate		= ctx->hstate;
1405 	sbinfo->max_inodes	= ctx->nr_inodes;
1406 	sbinfo->free_inodes	= ctx->nr_inodes;
1407 	sbinfo->spool		= NULL;
1408 	sbinfo->uid		= ctx->uid;
1409 	sbinfo->gid		= ctx->gid;
1410 	sbinfo->mode		= ctx->mode;
1411 
1412 	/*
1413 	 * Allocate and initialize subpool if maximum or minimum size is
1414 	 * specified.  Any needed reservations (for minimum size) are taken
1415 	 * when the subpool is created.
1416 	 */
1417 	if (ctx->max_hpages != -1 || ctx->min_hpages != -1) {
1418 		sbinfo->spool = hugepage_new_subpool(ctx->hstate,
1419 						     ctx->max_hpages,
1420 						     ctx->min_hpages);
1421 		if (!sbinfo->spool)
1422 			goto out_free;
1423 	}
1424 	sb->s_maxbytes = MAX_LFS_FILESIZE;
1425 	sb->s_blocksize = huge_page_size(ctx->hstate);
1426 	sb->s_blocksize_bits = huge_page_shift(ctx->hstate);
1427 	sb->s_magic = HUGETLBFS_MAGIC;
1428 	sb->s_op = &hugetlbfs_ops;
1429 	sb->s_d_flags = DCACHE_DONTCACHE;
1430 	sb->s_time_gran = 1;
1431 
1432 	/*
1433 	 * Due to the special and limited functionality of hugetlbfs, it does
1434 	 * not work well as a stacking filesystem.
1435 	 */
1436 	sb->s_stack_depth = FILESYSTEM_MAX_STACK_DEPTH;
1437 	sb->s_root = d_make_root(hugetlbfs_get_root(sb, ctx));
1438 	if (!sb->s_root)
1439 		goto out_free;
1440 	return 0;
1441 out_free:
1442 	kfree(sbinfo->spool);
1443 	kfree(sbinfo);
1444 	return -ENOMEM;
1445 }
1446 
hugetlbfs_get_tree(struct fs_context * fc)1447 static int hugetlbfs_get_tree(struct fs_context *fc)
1448 {
1449 	int err = hugetlbfs_validate(fc);
1450 	if (err)
1451 		return err;
1452 	return get_tree_nodev(fc, hugetlbfs_fill_super);
1453 }
1454 
hugetlbfs_fs_context_free(struct fs_context * fc)1455 static void hugetlbfs_fs_context_free(struct fs_context *fc)
1456 {
1457 	kfree(fc->fs_private);
1458 }
1459 
1460 static const struct fs_context_operations hugetlbfs_fs_context_ops = {
1461 	.free		= hugetlbfs_fs_context_free,
1462 	.parse_param	= hugetlbfs_parse_param,
1463 	.get_tree	= hugetlbfs_get_tree,
1464 };
1465 
hugetlbfs_init_fs_context(struct fs_context * fc)1466 static int hugetlbfs_init_fs_context(struct fs_context *fc)
1467 {
1468 	struct hugetlbfs_fs_context *ctx;
1469 
1470 	ctx = kzalloc_obj(struct hugetlbfs_fs_context);
1471 	if (!ctx)
1472 		return -ENOMEM;
1473 
1474 	ctx->max_hpages	= -1; /* No limit on size by default */
1475 	ctx->nr_inodes	= -1; /* No limit on number of inodes by default */
1476 	ctx->uid	= current_fsuid();
1477 	ctx->gid	= current_fsgid();
1478 	ctx->mode	= 0755;
1479 	ctx->hstate	= &default_hstate;
1480 	ctx->min_hpages	= -1; /* No default minimum size */
1481 	ctx->max_val_type = NO_SIZE;
1482 	ctx->min_val_type = NO_SIZE;
1483 	fc->fs_private = ctx;
1484 	fc->ops	= &hugetlbfs_fs_context_ops;
1485 	return 0;
1486 }
1487 
1488 static struct file_system_type hugetlbfs_fs_type = {
1489 	.name			= "hugetlbfs",
1490 	.init_fs_context	= hugetlbfs_init_fs_context,
1491 	.parameters		= hugetlb_fs_parameters,
1492 	.kill_sb		= kill_anon_super,
1493 	.fs_flags               = FS_ALLOW_IDMAP,
1494 };
1495 
1496 static struct vfsmount *hugetlbfs_vfsmount[HUGE_MAX_HSTATE];
1497 
can_do_hugetlb_shm(void)1498 static int can_do_hugetlb_shm(void)
1499 {
1500 	kgid_t shm_group;
1501 	shm_group = make_kgid(&init_user_ns, sysctl_hugetlb_shm_group);
1502 	return capable(CAP_IPC_LOCK) || in_group_p(shm_group);
1503 }
1504 
get_hstate_idx(int page_size_log)1505 static int get_hstate_idx(int page_size_log)
1506 {
1507 	struct hstate *h = hstate_sizelog(page_size_log);
1508 
1509 	if (!h)
1510 		return -1;
1511 	return hstate_index(h);
1512 }
1513 
1514 /*
1515  * Note that size should be aligned to proper hugepage size in caller side,
1516  * otherwise hugetlb_reserve_pages reserves one less hugepages than intended.
1517  */
hugetlb_file_setup(const char * name,size_t size,vma_flags_t acctflag,int creat_flags,int page_size_log)1518 struct file *hugetlb_file_setup(const char *name, size_t size,
1519 				vma_flags_t acctflag, int creat_flags,
1520 				int page_size_log)
1521 {
1522 	struct inode *inode;
1523 	struct vfsmount *mnt;
1524 	int hstate_idx;
1525 	struct file *file;
1526 
1527 	hstate_idx = get_hstate_idx(page_size_log);
1528 	if (hstate_idx < 0)
1529 		return ERR_PTR(-ENODEV);
1530 
1531 	mnt = hugetlbfs_vfsmount[hstate_idx];
1532 	if (!mnt)
1533 		return ERR_PTR(-ENOENT);
1534 
1535 	if (creat_flags == HUGETLB_SHMFS_INODE && !can_do_hugetlb_shm()) {
1536 		struct ucounts *ucounts = current_ucounts();
1537 
1538 		if (user_shm_lock(size, ucounts)) {
1539 			pr_warn_once("%s (%d): Using mlock ulimits for SHM_HUGETLB is obsolete\n",
1540 				current->comm, current->pid);
1541 			user_shm_unlock(size, ucounts);
1542 		}
1543 		return ERR_PTR(-EPERM);
1544 	}
1545 
1546 	file = ERR_PTR(-ENOSPC);
1547 	/* hugetlbfs_vfsmount[] mounts do not use idmapped mounts.  */
1548 	inode = hugetlbfs_get_inode(mnt->mnt_sb, &nop_mnt_idmap, NULL,
1549 				    S_IFREG | S_IRWXUGO, 0);
1550 	if (!inode)
1551 		goto out;
1552 	if (creat_flags == HUGETLB_SHMFS_INODE)
1553 		inode->i_flags |= S_PRIVATE;
1554 
1555 	inode->i_size = size;
1556 	clear_nlink(inode);
1557 
1558 	if (hugetlb_reserve_pages(inode, 0,
1559 			size >> huge_page_shift(hstate_inode(inode)), NULL,
1560 			acctflag) < 0)
1561 		file = ERR_PTR(-ENOMEM);
1562 	else
1563 		file = alloc_file_pseudo(inode, mnt, name, O_RDWR,
1564 					&hugetlbfs_file_operations);
1565 	if (!IS_ERR(file))
1566 		return file;
1567 
1568 	iput(inode);
1569 out:
1570 	return file;
1571 }
1572 
mount_one_hugetlbfs(struct hstate * h)1573 static struct vfsmount *__init mount_one_hugetlbfs(struct hstate *h)
1574 {
1575 	struct fs_context *fc;
1576 	struct vfsmount *mnt;
1577 
1578 	fc = fs_context_for_mount(&hugetlbfs_fs_type, SB_KERNMOUNT);
1579 	if (IS_ERR(fc)) {
1580 		mnt = ERR_CAST(fc);
1581 	} else {
1582 		struct hugetlbfs_fs_context *ctx = fc->fs_private;
1583 		ctx->hstate = h;
1584 		mnt = fc_mount_longterm(fc);
1585 		put_fs_context(fc);
1586 	}
1587 	if (IS_ERR(mnt))
1588 		pr_err("Cannot mount internal hugetlbfs for page size %luK",
1589 		       huge_page_size(h) / SZ_1K);
1590 	return mnt;
1591 }
1592 
init_hugetlbfs_fs(void)1593 static int __init init_hugetlbfs_fs(void)
1594 {
1595 	struct vfsmount *mnt;
1596 	struct hstate *h;
1597 	int error;
1598 	int i;
1599 
1600 	if (!hugepages_supported()) {
1601 		pr_info("disabling because there are no supported hugepage sizes\n");
1602 		return -ENOTSUPP;
1603 	}
1604 
1605 	error = -ENOMEM;
1606 	hugetlbfs_inode_cachep = kmem_cache_create("hugetlbfs_inode_cache",
1607 					sizeof(struct hugetlbfs_inode_info),
1608 					0, SLAB_ACCOUNT, init_once);
1609 	if (hugetlbfs_inode_cachep == NULL)
1610 		goto out;
1611 
1612 	error = register_filesystem(&hugetlbfs_fs_type);
1613 	if (error)
1614 		goto out_free;
1615 
1616 	/* default hstate mount is required */
1617 	mnt = mount_one_hugetlbfs(&default_hstate);
1618 	if (IS_ERR(mnt)) {
1619 		error = PTR_ERR(mnt);
1620 		goto out_unreg;
1621 	}
1622 	hugetlbfs_vfsmount[default_hstate_idx] = mnt;
1623 
1624 	/* other hstates are optional */
1625 	i = 0;
1626 	for_each_hstate(h) {
1627 		if (i == default_hstate_idx) {
1628 			i++;
1629 			continue;
1630 		}
1631 
1632 		mnt = mount_one_hugetlbfs(h);
1633 		if (IS_ERR(mnt))
1634 			hugetlbfs_vfsmount[i] = NULL;
1635 		else
1636 			hugetlbfs_vfsmount[i] = mnt;
1637 		i++;
1638 	}
1639 
1640 	return 0;
1641 
1642  out_unreg:
1643 	(void)unregister_filesystem(&hugetlbfs_fs_type);
1644  out_free:
1645 	kmem_cache_destroy(hugetlbfs_inode_cachep);
1646  out:
1647 	return error;
1648 }
1649 fs_initcall(init_hugetlbfs_fs)
1650