2 * hugetlbpage-backed filesystem. Based on ramfs.
6 * Copyright (C) 2002 Linus Torvalds.
9 #include <linux/module.h>
10 #include <linux/thread_info.h>
11 #include <asm/current.h>
12 #include <linux/sched.h> /* remove ASAP */
14 #include <linux/mount.h>
15 #include <linux/file.h>
16 #include <linux/kernel.h>
17 #include <linux/writeback.h>
18 #include <linux/pagemap.h>
19 #include <linux/highmem.h>
20 #include <linux/init.h>
21 #include <linux/string.h>
22 #include <linux/capability.h>
23 #include <linux/ctype.h>
24 #include <linux/backing-dev.h>
25 #include <linux/hugetlb.h>
26 #include <linux/pagevec.h>
27 #include <linux/parser.h>
28 #include <linux/mman.h>
29 #include <linux/quotaops.h>
30 #include <linux/slab.h>
31 #include <linux/dnotify.h>
32 #include <linux/statfs.h>
33 #include <linux/security.h>
35 #include <asm/uaccess.h>
37 /* some random number */
38 #define HUGETLBFS_MAGIC 0x958458f6
40 static const struct super_operations hugetlbfs_ops;
41 static const struct address_space_operations hugetlbfs_aops;
42 const struct file_operations hugetlbfs_file_operations;
43 static const struct inode_operations hugetlbfs_dir_inode_operations;
44 static const struct inode_operations hugetlbfs_inode_operations;
46 static struct backing_dev_info hugetlbfs_backing_dev_info = {
47 .ra_pages = 0, /* No readahead */
48 .capabilities = BDI_CAP_NO_ACCT_DIRTY | BDI_CAP_NO_WRITEBACK,
51 int sysctl_hugetlb_shm_group;
54 Opt_size, Opt_nr_inodes,
55 Opt_mode, Opt_uid, Opt_gid,
59 static match_table_t tokens = {
60 {Opt_size, "size=%s"},
61 {Opt_nr_inodes, "nr_inodes=%s"},
62 {Opt_mode, "mode=%o"},
68 static void huge_pagevec_release(struct pagevec *pvec)
72 for (i = 0; i < pagevec_count(pvec); ++i)
73 put_page(pvec->pages[i]);
78 static int hugetlbfs_file_mmap(struct file *file, struct vm_area_struct *vma)
80 struct inode *inode = file->f_path.dentry->d_inode;
85 * vma address alignment (but not the pgoff alignment) has
86 * already been checked by prepare_hugepage_range. If you add
87 * any error returns here, do so after setting VM_HUGETLB, so
88 * is_vm_hugetlb_page tests below unmap_region go the right
89 * way when do_mmap_pgoff unwinds (may be important on powerpc
92 vma->vm_flags |= VM_HUGETLB | VM_RESERVED;
93 vma->vm_ops = &hugetlb_vm_ops;
95 if (vma->vm_pgoff & ~(HPAGE_MASK >> PAGE_SHIFT))
98 vma_len = (loff_t)(vma->vm_end - vma->vm_start);
100 mutex_lock(&inode->i_mutex);
104 len = vma_len + ((loff_t)vma->vm_pgoff << PAGE_SHIFT);
106 if (vma->vm_flags & VM_MAYSHARE &&
107 hugetlb_reserve_pages(inode, vma->vm_pgoff >> (HPAGE_SHIFT-PAGE_SHIFT),
112 hugetlb_prefault_arch_hook(vma->vm_mm);
113 if (vma->vm_flags & VM_WRITE && inode->i_size < len)
116 mutex_unlock(&inode->i_mutex);
122 * Called under down_write(mmap_sem).
125 #ifndef HAVE_ARCH_HUGETLB_UNMAPPED_AREA
127 hugetlb_get_unmapped_area(struct file *file, unsigned long addr,
128 unsigned long len, unsigned long pgoff, unsigned long flags)
130 struct mm_struct *mm = current->mm;
131 struct vm_area_struct *vma;
132 unsigned long start_addr;
134 if (len & ~HPAGE_MASK)
139 if (flags & MAP_FIXED) {
140 if (prepare_hugepage_range(addr, len))
146 addr = ALIGN(addr, HPAGE_SIZE);
147 vma = find_vma(mm, addr);
148 if (TASK_SIZE - len >= addr &&
149 (!vma || addr + len <= vma->vm_start))
153 start_addr = mm->free_area_cache;
155 if (len <= mm->cached_hole_size)
156 start_addr = TASK_UNMAPPED_BASE;
159 addr = ALIGN(start_addr, HPAGE_SIZE);
161 for (vma = find_vma(mm, addr); ; vma = vma->vm_next) {
162 /* At this point: (!vma || addr < vma->vm_end). */
163 if (TASK_SIZE - len < addr) {
165 * Start a new search - just in case we missed
168 if (start_addr != TASK_UNMAPPED_BASE) {
169 start_addr = TASK_UNMAPPED_BASE;
175 if (!vma || addr + len <= vma->vm_start)
177 addr = ALIGN(vma->vm_end, HPAGE_SIZE);
183 * Read a page. Again trivial. If it didn't already exist
184 * in the page cache, it is zero-filled.
186 static int hugetlbfs_readpage(struct file *file, struct page * page)
192 static int hugetlbfs_prepare_write(struct file *file,
193 struct page *page, unsigned offset, unsigned to)
198 static int hugetlbfs_commit_write(struct file *file,
199 struct page *page, unsigned offset, unsigned to)
204 static void truncate_huge_page(struct page *page)
206 cancel_dirty_page(page, /* No IO accounting for huge pages? */0);
207 ClearPageUptodate(page);
208 remove_from_page_cache(page);
212 static void truncate_hugepages(struct inode *inode, loff_t lstart)
214 struct address_space *mapping = &inode->i_data;
215 const pgoff_t start = lstart >> HPAGE_SHIFT;
220 pagevec_init(&pvec, 0);
223 if (!pagevec_lookup(&pvec, mapping, next, PAGEVEC_SIZE)) {
230 for (i = 0; i < pagevec_count(&pvec); ++i) {
231 struct page *page = pvec.pages[i];
234 if (page->index > next)
237 truncate_huge_page(page);
239 hugetlb_put_quota(mapping);
242 huge_pagevec_release(&pvec);
244 BUG_ON(!lstart && mapping->nrpages);
245 hugetlb_unreserve_pages(inode, start, freed);
248 static void hugetlbfs_delete_inode(struct inode *inode)
250 truncate_hugepages(inode, 0);
254 static void hugetlbfs_forget_inode(struct inode *inode) __releases(inode_lock)
256 struct super_block *sb = inode->i_sb;
258 if (!hlist_unhashed(&inode->i_hash)) {
259 if (!(inode->i_state & (I_DIRTY|I_LOCK)))
260 list_move(&inode->i_list, &inode_unused);
261 inodes_stat.nr_unused++;
262 if (!sb || (sb->s_flags & MS_ACTIVE)) {
263 spin_unlock(&inode_lock);
266 inode->i_state |= I_WILL_FREE;
267 spin_unlock(&inode_lock);
269 * write_inode_now is a noop as we set BDI_CAP_NO_WRITEBACK
270 * in our backing_dev_info.
272 write_inode_now(inode, 1);
273 spin_lock(&inode_lock);
274 inode->i_state &= ~I_WILL_FREE;
275 inodes_stat.nr_unused--;
276 hlist_del_init(&inode->i_hash);
278 list_del_init(&inode->i_list);
279 list_del_init(&inode->i_sb_list);
280 inode->i_state |= I_FREEING;
281 inodes_stat.nr_inodes--;
282 spin_unlock(&inode_lock);
283 truncate_hugepages(inode, 0);
285 destroy_inode(inode);
288 static void hugetlbfs_drop_inode(struct inode *inode)
291 generic_delete_inode(inode);
293 hugetlbfs_forget_inode(inode);
297 hugetlb_vmtruncate_list(struct prio_tree_root *root, pgoff_t pgoff)
299 struct vm_area_struct *vma;
300 struct prio_tree_iter iter;
302 vma_prio_tree_foreach(vma, &iter, root, pgoff, ULONG_MAX) {
303 unsigned long v_offset;
306 * Can the expression below overflow on 32-bit arches?
307 * No, because the prio_tree returns us only those vmas
308 * which overlap the truncated area starting at pgoff,
309 * and no vma on a 32-bit arch can span beyond the 4GB.
311 if (vma->vm_pgoff < pgoff)
312 v_offset = (pgoff - vma->vm_pgoff) << PAGE_SHIFT;
316 __unmap_hugepage_range(vma,
317 vma->vm_start + v_offset, vma->vm_end);
322 * Expanding truncates are not allowed.
324 static int hugetlb_vmtruncate(struct inode *inode, loff_t offset)
327 struct address_space *mapping = inode->i_mapping;
329 if (offset > inode->i_size)
332 BUG_ON(offset & ~HPAGE_MASK);
333 pgoff = offset >> PAGE_SHIFT;
335 inode->i_size = offset;
336 spin_lock(&mapping->i_mmap_lock);
337 if (!prio_tree_empty(&mapping->i_mmap))
338 hugetlb_vmtruncate_list(&mapping->i_mmap, pgoff);
339 spin_unlock(&mapping->i_mmap_lock);
340 truncate_hugepages(inode, offset);
344 static int hugetlbfs_setattr(struct dentry *dentry, struct iattr *attr)
346 struct inode *inode = dentry->d_inode;
348 unsigned int ia_valid = attr->ia_valid;
352 error = inode_change_ok(inode, attr);
356 if (ia_valid & ATTR_SIZE) {
358 if (!(attr->ia_size & ~HPAGE_MASK))
359 error = hugetlb_vmtruncate(inode, attr->ia_size);
362 attr->ia_valid &= ~ATTR_SIZE;
364 error = inode_setattr(inode, attr);
369 static struct inode *hugetlbfs_get_inode(struct super_block *sb, uid_t uid,
370 gid_t gid, int mode, dev_t dev)
374 inode = new_inode(sb);
376 struct hugetlbfs_inode_info *info;
377 inode->i_mode = mode;
381 inode->i_mapping->a_ops = &hugetlbfs_aops;
382 inode->i_mapping->backing_dev_info =&hugetlbfs_backing_dev_info;
383 inode->i_atime = inode->i_mtime = inode->i_ctime = CURRENT_TIME;
384 INIT_LIST_HEAD(&inode->i_mapping->private_list);
385 info = HUGETLBFS_I(inode);
386 mpol_shared_policy_init(&info->policy, MPOL_DEFAULT, NULL);
387 switch (mode & S_IFMT) {
389 init_special_inode(inode, mode, dev);
392 inode->i_op = &hugetlbfs_inode_operations;
393 inode->i_fop = &hugetlbfs_file_operations;
396 inode->i_op = &hugetlbfs_dir_inode_operations;
397 inode->i_fop = &simple_dir_operations;
399 /* directory inodes start off with i_nlink == 2 (for "." entry) */
403 inode->i_op = &page_symlink_inode_operations;
411 * File creation. Allocate an inode, and we're done..
413 static int hugetlbfs_mknod(struct inode *dir,
414 struct dentry *dentry, int mode, dev_t dev)
420 if (dir->i_mode & S_ISGID) {
425 gid = current->fsgid;
427 inode = hugetlbfs_get_inode(dir->i_sb, current->fsuid, gid, mode, dev);
429 dir->i_ctime = dir->i_mtime = CURRENT_TIME;
430 d_instantiate(dentry, inode);
431 dget(dentry); /* Extra count - pin the dentry in core */
437 static int hugetlbfs_mkdir(struct inode *dir, struct dentry *dentry, int mode)
439 int retval = hugetlbfs_mknod(dir, dentry, mode | S_IFDIR, 0);
445 static int hugetlbfs_create(struct inode *dir, struct dentry *dentry, int mode, struct nameidata *nd)
447 return hugetlbfs_mknod(dir, dentry, mode | S_IFREG, 0);
450 static int hugetlbfs_symlink(struct inode *dir,
451 struct dentry *dentry, const char *symname)
457 if (dir->i_mode & S_ISGID)
460 gid = current->fsgid;
462 inode = hugetlbfs_get_inode(dir->i_sb, current->fsuid,
463 gid, S_IFLNK|S_IRWXUGO, 0);
465 int l = strlen(symname)+1;
466 error = page_symlink(inode, symname, l);
468 d_instantiate(dentry, inode);
473 dir->i_ctime = dir->i_mtime = CURRENT_TIME;
479 * mark the head page dirty
481 static int hugetlbfs_set_page_dirty(struct page *page)
483 struct page *head = compound_head(page);
489 static int hugetlbfs_statfs(struct dentry *dentry, struct kstatfs *buf)
491 struct hugetlbfs_sb_info *sbinfo = HUGETLBFS_SB(dentry->d_sb);
493 buf->f_type = HUGETLBFS_MAGIC;
494 buf->f_bsize = HPAGE_SIZE;
496 spin_lock(&sbinfo->stat_lock);
497 /* If no limits set, just report 0 for max/free/used
498 * blocks, like simple_statfs() */
499 if (sbinfo->max_blocks >= 0) {
500 buf->f_blocks = sbinfo->max_blocks;
501 buf->f_bavail = buf->f_bfree = sbinfo->free_blocks;
502 buf->f_files = sbinfo->max_inodes;
503 buf->f_ffree = sbinfo->free_inodes;
505 spin_unlock(&sbinfo->stat_lock);
507 buf->f_namelen = NAME_MAX;
511 static void hugetlbfs_put_super(struct super_block *sb)
513 struct hugetlbfs_sb_info *sbi = HUGETLBFS_SB(sb);
516 sb->s_fs_info = NULL;
521 static inline int hugetlbfs_dec_free_inodes(struct hugetlbfs_sb_info *sbinfo)
523 if (sbinfo->free_inodes >= 0) {
524 spin_lock(&sbinfo->stat_lock);
525 if (unlikely(!sbinfo->free_inodes)) {
526 spin_unlock(&sbinfo->stat_lock);
529 sbinfo->free_inodes--;
530 spin_unlock(&sbinfo->stat_lock);
536 static void hugetlbfs_inc_free_inodes(struct hugetlbfs_sb_info *sbinfo)
538 if (sbinfo->free_inodes >= 0) {
539 spin_lock(&sbinfo->stat_lock);
540 sbinfo->free_inodes++;
541 spin_unlock(&sbinfo->stat_lock);
546 static struct kmem_cache *hugetlbfs_inode_cachep;
548 static struct inode *hugetlbfs_alloc_inode(struct super_block *sb)
550 struct hugetlbfs_sb_info *sbinfo = HUGETLBFS_SB(sb);
551 struct hugetlbfs_inode_info *p;
553 if (unlikely(!hugetlbfs_dec_free_inodes(sbinfo)))
555 p = kmem_cache_alloc(hugetlbfs_inode_cachep, GFP_KERNEL);
557 hugetlbfs_inc_free_inodes(sbinfo);
560 return &p->vfs_inode;
563 static void hugetlbfs_destroy_inode(struct inode *inode)
565 hugetlbfs_inc_free_inodes(HUGETLBFS_SB(inode->i_sb));
566 mpol_free_shared_policy(&HUGETLBFS_I(inode)->policy);
567 kmem_cache_free(hugetlbfs_inode_cachep, HUGETLBFS_I(inode));
570 static const struct address_space_operations hugetlbfs_aops = {
571 .readpage = hugetlbfs_readpage,
572 .prepare_write = hugetlbfs_prepare_write,
573 .commit_write = hugetlbfs_commit_write,
574 .set_page_dirty = hugetlbfs_set_page_dirty,
578 static void init_once(void *foo, struct kmem_cache *cachep, unsigned long flags)
580 struct hugetlbfs_inode_info *ei = (struct hugetlbfs_inode_info *)foo;
582 inode_init_once(&ei->vfs_inode);
585 const struct file_operations hugetlbfs_file_operations = {
586 .mmap = hugetlbfs_file_mmap,
587 .fsync = simple_sync_file,
588 .get_unmapped_area = hugetlb_get_unmapped_area,
591 static const struct inode_operations hugetlbfs_dir_inode_operations = {
592 .create = hugetlbfs_create,
593 .lookup = simple_lookup,
595 .unlink = simple_unlink,
596 .symlink = hugetlbfs_symlink,
597 .mkdir = hugetlbfs_mkdir,
598 .rmdir = simple_rmdir,
599 .mknod = hugetlbfs_mknod,
600 .rename = simple_rename,
601 .setattr = hugetlbfs_setattr,
604 static const struct inode_operations hugetlbfs_inode_operations = {
605 .setattr = hugetlbfs_setattr,
608 static const struct super_operations hugetlbfs_ops = {
609 .alloc_inode = hugetlbfs_alloc_inode,
610 .destroy_inode = hugetlbfs_destroy_inode,
611 .statfs = hugetlbfs_statfs,
612 .delete_inode = hugetlbfs_delete_inode,
613 .drop_inode = hugetlbfs_drop_inode,
614 .put_super = hugetlbfs_put_super,
618 hugetlbfs_parse_options(char *options, struct hugetlbfs_config *pconfig)
621 substring_t args[MAX_OPT_ARGS];
627 while ((p = strsep(&options, ",")) != NULL) {
632 token = match_token(p, tokens, args);
635 if (match_int(&args[0], &option))
637 pconfig->uid = option;
641 if (match_int(&args[0], &option))
643 pconfig->gid = option;
647 if (match_octal(&args[0], &option))
649 pconfig->mode = option & 0777U;
653 unsigned long long size;
654 /* memparse() will accept a K/M/G without a digit */
655 if (!isdigit(*args[0].from))
657 size = memparse(args[0].from, &rest);
659 size <<= HPAGE_SHIFT;
660 size *= max_huge_pages;
663 pconfig->nr_blocks = (size >> HPAGE_SHIFT);
668 /* memparse() will accept a K/M/G without a digit */
669 if (!isdigit(*args[0].from))
671 pconfig->nr_inodes = memparse(args[0].from, &rest);
675 printk(KERN_ERR "hugetlbfs: Bad mount option: \"%s\"\n",
684 printk(KERN_ERR "hugetlbfs: Bad value '%s' for mount option '%s'\n",
690 hugetlbfs_fill_super(struct super_block *sb, void *data, int silent)
692 struct inode * inode;
693 struct dentry * root;
695 struct hugetlbfs_config config;
696 struct hugetlbfs_sb_info *sbinfo;
698 config.nr_blocks = -1; /* No limit on size by default */
699 config.nr_inodes = -1; /* No limit on number of inodes by default */
700 config.uid = current->fsuid;
701 config.gid = current->fsgid;
703 ret = hugetlbfs_parse_options(data, &config);
707 sbinfo = kmalloc(sizeof(struct hugetlbfs_sb_info), GFP_KERNEL);
710 sb->s_fs_info = sbinfo;
711 spin_lock_init(&sbinfo->stat_lock);
712 sbinfo->max_blocks = config.nr_blocks;
713 sbinfo->free_blocks = config.nr_blocks;
714 sbinfo->max_inodes = config.nr_inodes;
715 sbinfo->free_inodes = config.nr_inodes;
716 sb->s_maxbytes = MAX_LFS_FILESIZE;
717 sb->s_blocksize = HPAGE_SIZE;
718 sb->s_blocksize_bits = HPAGE_SHIFT;
719 sb->s_magic = HUGETLBFS_MAGIC;
720 sb->s_op = &hugetlbfs_ops;
722 inode = hugetlbfs_get_inode(sb, config.uid, config.gid,
723 S_IFDIR | config.mode, 0);
727 root = d_alloc_root(inode);
739 int hugetlb_get_quota(struct address_space *mapping)
742 struct hugetlbfs_sb_info *sbinfo = HUGETLBFS_SB(mapping->host->i_sb);
744 if (sbinfo->free_blocks > -1) {
745 spin_lock(&sbinfo->stat_lock);
746 if (sbinfo->free_blocks > 0)
747 sbinfo->free_blocks--;
750 spin_unlock(&sbinfo->stat_lock);
756 void hugetlb_put_quota(struct address_space *mapping)
758 struct hugetlbfs_sb_info *sbinfo = HUGETLBFS_SB(mapping->host->i_sb);
760 if (sbinfo->free_blocks > -1) {
761 spin_lock(&sbinfo->stat_lock);
762 sbinfo->free_blocks++;
763 spin_unlock(&sbinfo->stat_lock);
767 static int hugetlbfs_get_sb(struct file_system_type *fs_type,
768 int flags, const char *dev_name, void *data, struct vfsmount *mnt)
770 return get_sb_nodev(fs_type, flags, data, hugetlbfs_fill_super, mnt);
773 static struct file_system_type hugetlbfs_fs_type = {
775 .get_sb = hugetlbfs_get_sb,
776 .kill_sb = kill_litter_super,
779 static struct vfsmount *hugetlbfs_vfsmount;
781 static int can_do_hugetlb_shm(void)
783 return likely(capable(CAP_IPC_LOCK) ||
784 in_group_p(sysctl_hugetlb_shm_group) ||
788 struct file *hugetlb_file_setup(const char *name, size_t size)
793 struct dentry *dentry, *root;
794 struct qstr quick_string;
796 if (!hugetlbfs_vfsmount)
797 return ERR_PTR(-ENOENT);
799 if (!can_do_hugetlb_shm())
800 return ERR_PTR(-EPERM);
802 if (!user_shm_lock(size, current->user))
803 return ERR_PTR(-ENOMEM);
805 root = hugetlbfs_vfsmount->mnt_root;
806 quick_string.name = name;
807 quick_string.len = strlen(quick_string.name);
808 quick_string.hash = 0;
809 dentry = d_alloc(root, &quick_string);
814 file = get_empty_filp();
819 inode = hugetlbfs_get_inode(root->d_sb, current->fsuid,
820 current->fsgid, S_IFREG | S_IRWXUGO, 0);
825 if (hugetlb_reserve_pages(inode, 0, size >> HPAGE_SHIFT))
828 d_instantiate(dentry, inode);
829 inode->i_size = size;
831 file->f_path.mnt = mntget(hugetlbfs_vfsmount);
832 file->f_path.dentry = dentry;
833 file->f_mapping = inode->i_mapping;
834 file->f_op = &hugetlbfs_file_operations;
835 file->f_mode = FMODE_WRITE | FMODE_READ;
845 user_shm_unlock(size, current->user);
846 return ERR_PTR(error);
849 static int __init init_hugetlbfs_fs(void)
852 struct vfsmount *vfsmount;
854 hugetlbfs_inode_cachep = kmem_cache_create("hugetlbfs_inode_cache",
855 sizeof(struct hugetlbfs_inode_info),
857 if (hugetlbfs_inode_cachep == NULL)
860 error = register_filesystem(&hugetlbfs_fs_type);
864 vfsmount = kern_mount(&hugetlbfs_fs_type);
866 if (!IS_ERR(vfsmount)) {
867 hugetlbfs_vfsmount = vfsmount;
871 error = PTR_ERR(vfsmount);
875 kmem_cache_destroy(hugetlbfs_inode_cachep);
879 static void __exit exit_hugetlbfs_fs(void)
881 kmem_cache_destroy(hugetlbfs_inode_cachep);
882 unregister_filesystem(&hugetlbfs_fs_type);
885 module_init(init_hugetlbfs_fs)
886 module_exit(exit_hugetlbfs_fs)
888 MODULE_LICENSE("GPL");