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