2 * ioctl.c - NILFS ioctl operations.
4 * Copyright (C) 2007, 2008 Nippon Telegraph and Telephone Corporation.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
24 #include <linux/wait.h>
25 #include <linux/slab.h>
26 #include <linux/capability.h> /* capable() */
27 #include <linux/uaccess.h> /* copy_from_user(), copy_to_user() */
28 #include <linux/vmalloc.h>
29 #include <linux/compat.h> /* compat_ptr() */
30 #include <linux/mount.h> /* mnt_want_write_file(), mnt_drop_write_file() */
31 #include <linux/buffer_head.h>
32 #include <linux/nilfs2_fs.h>
41 static int nilfs_ioctl_wrap_copy(struct the_nilfs *nilfs,
42 struct nilfs_argv *argv, int dir,
43 ssize_t (*dofunc)(struct the_nilfs *,
45 void *, size_t, size_t))
48 void __user *base = (void __user *)(unsigned long)argv->v_base;
49 size_t maxmembs, total, n;
54 if (argv->v_nmembs == 0)
57 if (argv->v_size > PAGE_SIZE)
60 buf = (void *)__get_free_pages(GFP_NOFS, 0);
63 maxmembs = PAGE_SIZE / argv->v_size;
68 for (i = 0; i < argv->v_nmembs; i += n) {
69 n = (argv->v_nmembs - i < maxmembs) ?
70 argv->v_nmembs - i : maxmembs;
71 if ((dir & _IOC_WRITE) &&
72 copy_from_user(buf, base + argv->v_size * i,
78 nr = dofunc(nilfs, &pos, argv->v_flags, buf, argv->v_size,
84 if ((dir & _IOC_READ) &&
85 copy_to_user(base + argv->v_size * i, buf,
96 argv->v_nmembs = total;
98 free_pages((unsigned long)buf, 0);
102 static int nilfs_ioctl_getflags(struct inode *inode, void __user *argp)
104 unsigned int flags = NILFS_I(inode)->i_flags & FS_FL_USER_VISIBLE;
106 return put_user(flags, (int __user *)argp);
109 static int nilfs_ioctl_setflags(struct inode *inode, struct file *filp,
112 struct nilfs_transaction_info ti;
113 unsigned int flags, oldflags;
116 if (!inode_owner_or_capable(inode))
119 if (get_user(flags, (int __user *)argp))
122 ret = mnt_want_write_file(filp);
126 flags = nilfs_mask_flags(inode->i_mode, flags);
128 mutex_lock(&inode->i_mutex);
130 oldflags = NILFS_I(inode)->i_flags;
133 * The IMMUTABLE and APPEND_ONLY flags can only be changed by the
134 * relevant capability.
137 if (((flags ^ oldflags) & (FS_APPEND_FL | FS_IMMUTABLE_FL)) &&
138 !capable(CAP_LINUX_IMMUTABLE))
141 ret = nilfs_transaction_begin(inode->i_sb, &ti, 0);
145 NILFS_I(inode)->i_flags = (oldflags & ~FS_FL_USER_MODIFIABLE) |
146 (flags & FS_FL_USER_MODIFIABLE);
148 nilfs_set_inode_flags(inode);
149 inode->i_ctime = CURRENT_TIME;
151 nilfs_set_transaction_flag(NILFS_TI_SYNC);
153 nilfs_mark_inode_dirty(inode);
154 ret = nilfs_transaction_commit(inode->i_sb);
156 mutex_unlock(&inode->i_mutex);
157 mnt_drop_write_file(filp);
161 static int nilfs_ioctl_getversion(struct inode *inode, void __user *argp)
163 return put_user(inode->i_generation, (int __user *)argp);
166 static int nilfs_ioctl_change_cpmode(struct inode *inode, struct file *filp,
167 unsigned int cmd, void __user *argp)
169 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
170 struct nilfs_transaction_info ti;
171 struct nilfs_cpmode cpmode;
174 if (!capable(CAP_SYS_ADMIN))
177 ret = mnt_want_write_file(filp);
182 if (copy_from_user(&cpmode, argp, sizeof(cpmode)))
185 down_read(&inode->i_sb->s_umount);
187 nilfs_transaction_begin(inode->i_sb, &ti, 0);
188 ret = nilfs_cpfile_change_cpmode(
189 nilfs->ns_cpfile, cpmode.cm_cno, cpmode.cm_mode);
190 if (unlikely(ret < 0))
191 nilfs_transaction_abort(inode->i_sb);
193 nilfs_transaction_commit(inode->i_sb); /* never fails */
195 up_read(&inode->i_sb->s_umount);
197 mnt_drop_write_file(filp);
202 nilfs_ioctl_delete_checkpoint(struct inode *inode, struct file *filp,
203 unsigned int cmd, void __user *argp)
205 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
206 struct nilfs_transaction_info ti;
210 if (!capable(CAP_SYS_ADMIN))
213 ret = mnt_want_write_file(filp);
218 if (copy_from_user(&cno, argp, sizeof(cno)))
221 nilfs_transaction_begin(inode->i_sb, &ti, 0);
222 ret = nilfs_cpfile_delete_checkpoint(nilfs->ns_cpfile, cno);
223 if (unlikely(ret < 0))
224 nilfs_transaction_abort(inode->i_sb);
226 nilfs_transaction_commit(inode->i_sb); /* never fails */
228 mnt_drop_write_file(filp);
233 nilfs_ioctl_do_get_cpinfo(struct the_nilfs *nilfs, __u64 *posp, int flags,
234 void *buf, size_t size, size_t nmembs)
238 down_read(&nilfs->ns_segctor_sem);
239 ret = nilfs_cpfile_get_cpinfo(nilfs->ns_cpfile, posp, flags, buf,
241 up_read(&nilfs->ns_segctor_sem);
245 static int nilfs_ioctl_get_cpstat(struct inode *inode, struct file *filp,
246 unsigned int cmd, void __user *argp)
248 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
249 struct nilfs_cpstat cpstat;
252 down_read(&nilfs->ns_segctor_sem);
253 ret = nilfs_cpfile_get_stat(nilfs->ns_cpfile, &cpstat);
254 up_read(&nilfs->ns_segctor_sem);
258 if (copy_to_user(argp, &cpstat, sizeof(cpstat)))
264 nilfs_ioctl_do_get_suinfo(struct the_nilfs *nilfs, __u64 *posp, int flags,
265 void *buf, size_t size, size_t nmembs)
269 down_read(&nilfs->ns_segctor_sem);
270 ret = nilfs_sufile_get_suinfo(nilfs->ns_sufile, *posp, buf, size,
272 up_read(&nilfs->ns_segctor_sem);
276 static int nilfs_ioctl_get_sustat(struct inode *inode, struct file *filp,
277 unsigned int cmd, void __user *argp)
279 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
280 struct nilfs_sustat sustat;
283 down_read(&nilfs->ns_segctor_sem);
284 ret = nilfs_sufile_get_stat(nilfs->ns_sufile, &sustat);
285 up_read(&nilfs->ns_segctor_sem);
289 if (copy_to_user(argp, &sustat, sizeof(sustat)))
295 nilfs_ioctl_do_get_vinfo(struct the_nilfs *nilfs, __u64 *posp, int flags,
296 void *buf, size_t size, size_t nmembs)
300 down_read(&nilfs->ns_segctor_sem);
301 ret = nilfs_dat_get_vinfo(nilfs->ns_dat, buf, size, nmembs);
302 up_read(&nilfs->ns_segctor_sem);
307 nilfs_ioctl_do_get_bdescs(struct the_nilfs *nilfs, __u64 *posp, int flags,
308 void *buf, size_t size, size_t nmembs)
310 struct nilfs_bmap *bmap = NILFS_I(nilfs->ns_dat)->i_bmap;
311 struct nilfs_bdesc *bdescs = buf;
314 down_read(&nilfs->ns_segctor_sem);
315 for (i = 0; i < nmembs; i++) {
316 ret = nilfs_bmap_lookup_at_level(bmap,
318 bdescs[i].bd_level + 1,
319 &bdescs[i].bd_blocknr);
321 if (ret != -ENOENT) {
322 up_read(&nilfs->ns_segctor_sem);
325 bdescs[i].bd_blocknr = 0;
328 up_read(&nilfs->ns_segctor_sem);
332 static int nilfs_ioctl_get_bdescs(struct inode *inode, struct file *filp,
333 unsigned int cmd, void __user *argp)
335 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
336 struct nilfs_argv argv;
339 if (copy_from_user(&argv, argp, sizeof(argv)))
342 if (argv.v_size != sizeof(struct nilfs_bdesc))
345 ret = nilfs_ioctl_wrap_copy(nilfs, &argv, _IOC_DIR(cmd),
346 nilfs_ioctl_do_get_bdescs);
350 if (copy_to_user(argp, &argv, sizeof(argv)))
355 static int nilfs_ioctl_move_inode_block(struct inode *inode,
356 struct nilfs_vdesc *vdesc,
357 struct list_head *buffers)
359 struct buffer_head *bh;
362 if (vdesc->vd_flags == 0)
363 ret = nilfs_gccache_submit_read_data(
364 inode, vdesc->vd_offset, vdesc->vd_blocknr,
365 vdesc->vd_vblocknr, &bh);
367 ret = nilfs_gccache_submit_read_node(
368 inode, vdesc->vd_blocknr, vdesc->vd_vblocknr, &bh);
370 if (unlikely(ret < 0)) {
373 "%s: invalid virtual block address (%s): "
374 "ino=%llu, cno=%llu, offset=%llu, "
375 "blocknr=%llu, vblocknr=%llu\n",
376 __func__, vdesc->vd_flags ? "node" : "data",
377 (unsigned long long)vdesc->vd_ino,
378 (unsigned long long)vdesc->vd_cno,
379 (unsigned long long)vdesc->vd_offset,
380 (unsigned long long)vdesc->vd_blocknr,
381 (unsigned long long)vdesc->vd_vblocknr);
384 if (unlikely(!list_empty(&bh->b_assoc_buffers))) {
385 printk(KERN_CRIT "%s: conflicting %s buffer: ino=%llu, "
386 "cno=%llu, offset=%llu, blocknr=%llu, vblocknr=%llu\n",
387 __func__, vdesc->vd_flags ? "node" : "data",
388 (unsigned long long)vdesc->vd_ino,
389 (unsigned long long)vdesc->vd_cno,
390 (unsigned long long)vdesc->vd_offset,
391 (unsigned long long)vdesc->vd_blocknr,
392 (unsigned long long)vdesc->vd_vblocknr);
396 list_add_tail(&bh->b_assoc_buffers, buffers);
400 static int nilfs_ioctl_move_blocks(struct super_block *sb,
401 struct nilfs_argv *argv, void *buf)
403 size_t nmembs = argv->v_nmembs;
404 struct the_nilfs *nilfs = sb->s_fs_info;
406 struct nilfs_vdesc *vdesc;
407 struct buffer_head *bh, *n;
413 for (i = 0, vdesc = buf; i < nmembs; ) {
416 inode = nilfs_iget_for_gc(sb, ino, cno);
418 ret = PTR_ERR(inode);
421 if (list_empty(&NILFS_I(inode)->i_dirty)) {
423 * Add the inode to GC inode list. Garbage Collection
424 * is serialized and no two processes manipulate the
425 * list simultaneously.
428 list_add(&NILFS_I(inode)->i_dirty,
429 &nilfs->ns_gc_inodes);
433 ret = nilfs_ioctl_move_inode_block(inode, vdesc,
435 if (unlikely(ret < 0)) {
440 } while (++i < nmembs &&
441 vdesc->vd_ino == ino && vdesc->vd_cno == cno);
443 iput(inode); /* The inode still remains in GC inode list */
446 list_for_each_entry_safe(bh, n, &buffers, b_assoc_buffers) {
447 ret = nilfs_gccache_wait_and_mark_dirty(bh);
448 if (unlikely(ret < 0)) {
449 WARN_ON(ret == -EEXIST);
452 list_del_init(&bh->b_assoc_buffers);
458 list_for_each_entry_safe(bh, n, &buffers, b_assoc_buffers) {
459 list_del_init(&bh->b_assoc_buffers);
465 static int nilfs_ioctl_delete_checkpoints(struct the_nilfs *nilfs,
466 struct nilfs_argv *argv, void *buf)
468 size_t nmembs = argv->v_nmembs;
469 struct inode *cpfile = nilfs->ns_cpfile;
470 struct nilfs_period *periods = buf;
473 for (i = 0; i < nmembs; i++) {
474 ret = nilfs_cpfile_delete_checkpoints(
475 cpfile, periods[i].p_start, periods[i].p_end);
482 static int nilfs_ioctl_free_vblocknrs(struct the_nilfs *nilfs,
483 struct nilfs_argv *argv, void *buf)
485 size_t nmembs = argv->v_nmembs;
488 ret = nilfs_dat_freev(nilfs->ns_dat, buf, nmembs);
490 return (ret < 0) ? ret : nmembs;
493 static int nilfs_ioctl_mark_blocks_dirty(struct the_nilfs *nilfs,
494 struct nilfs_argv *argv, void *buf)
496 size_t nmembs = argv->v_nmembs;
497 struct nilfs_bmap *bmap = NILFS_I(nilfs->ns_dat)->i_bmap;
498 struct nilfs_bdesc *bdescs = buf;
501 for (i = 0; i < nmembs; i++) {
502 /* XXX: use macro or inline func to check liveness */
503 ret = nilfs_bmap_lookup_at_level(bmap,
505 bdescs[i].bd_level + 1,
506 &bdescs[i].bd_blocknr);
510 bdescs[i].bd_blocknr = 0;
512 if (bdescs[i].bd_blocknr != bdescs[i].bd_oblocknr)
513 /* skip dead block */
515 if (bdescs[i].bd_level == 0) {
516 ret = nilfs_mdt_mark_block_dirty(nilfs->ns_dat,
517 bdescs[i].bd_offset);
519 WARN_ON(ret == -ENOENT);
523 ret = nilfs_bmap_mark(bmap, bdescs[i].bd_offset,
526 WARN_ON(ret == -ENOENT);
534 int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *nilfs,
535 struct nilfs_argv *argv, void **kbufs)
540 ret = nilfs_ioctl_delete_checkpoints(nilfs, &argv[1], kbufs[1]);
543 * can safely abort because checkpoints can be removed
546 msg = "cannot delete checkpoints";
549 ret = nilfs_ioctl_free_vblocknrs(nilfs, &argv[2], kbufs[2]);
552 * can safely abort because DAT file is updated atomically
553 * using a copy-on-write technique.
555 msg = "cannot delete virtual blocks from DAT file";
558 ret = nilfs_ioctl_mark_blocks_dirty(nilfs, &argv[3], kbufs[3]);
561 * can safely abort because the operation is nondestructive.
563 msg = "cannot mark copying blocks dirty";
569 printk(KERN_ERR "NILFS: GC failed during preparation: %s: err=%d\n",
574 static int nilfs_ioctl_clean_segments(struct inode *inode, struct file *filp,
575 unsigned int cmd, void __user *argp)
577 struct nilfs_argv argv[5];
578 static const size_t argsz[5] = {
579 sizeof(struct nilfs_vdesc),
580 sizeof(struct nilfs_period),
582 sizeof(struct nilfs_bdesc),
587 struct the_nilfs *nilfs;
591 if (!capable(CAP_SYS_ADMIN))
594 ret = mnt_want_write_file(filp);
599 if (copy_from_user(argv, argp, sizeof(argv)))
603 nsegs = argv[4].v_nmembs;
604 if (argv[4].v_size != argsz[4])
608 * argv[4] points to segment numbers this ioctl cleans. We
609 * use kmalloc() for its buffer because memory used for the
610 * segment numbers is enough small.
612 kbufs[4] = memdup_user((void __user *)(unsigned long)argv[4].v_base,
613 nsegs * sizeof(__u64));
614 if (IS_ERR(kbufs[4])) {
615 ret = PTR_ERR(kbufs[4]);
618 nilfs = inode->i_sb->s_fs_info;
620 for (n = 0; n < 4; n++) {
622 if (argv[n].v_size != argsz[n])
625 if (argv[n].v_nmembs > nsegs * nilfs->ns_blocks_per_segment)
628 if (argv[n].v_nmembs >= UINT_MAX / argv[n].v_size)
631 len = argv[n].v_size * argv[n].v_nmembs;
632 base = (void __user *)(unsigned long)argv[n].v_base;
638 kbufs[n] = vmalloc(len);
643 if (copy_from_user(kbufs[n], base, len)) {
651 * nilfs_ioctl_move_blocks() will call nilfs_iget_for_gc(),
652 * which will operates an inode list without blocking.
653 * To protect the list from concurrent operations,
654 * nilfs_ioctl_move_blocks should be atomic operation.
656 if (test_and_set_bit(THE_NILFS_GC_RUNNING, &nilfs->ns_flags)) {
661 vfs_check_frozen(inode->i_sb, SB_FREEZE_WRITE);
663 ret = nilfs_ioctl_move_blocks(inode->i_sb, &argv[0], kbufs[0]);
665 printk(KERN_ERR "NILFS: GC failed during preparation: "
666 "cannot read source blocks: err=%d\n", ret);
668 ret = nilfs_clean_segments(inode->i_sb, argv, kbufs);
670 nilfs_remove_all_gcinodes(nilfs);
671 clear_nilfs_gc_running(nilfs);
678 mnt_drop_write_file(filp);
682 static int nilfs_ioctl_sync(struct inode *inode, struct file *filp,
683 unsigned int cmd, void __user *argp)
687 struct the_nilfs *nilfs;
689 ret = nilfs_construct_segment(inode->i_sb);
694 nilfs = inode->i_sb->s_fs_info;
695 down_read(&nilfs->ns_segctor_sem);
696 cno = nilfs->ns_cno - 1;
697 up_read(&nilfs->ns_segctor_sem);
698 if (copy_to_user(argp, &cno, sizeof(cno)))
704 static int nilfs_ioctl_resize(struct inode *inode, struct file *filp,
710 if (!capable(CAP_SYS_ADMIN))
713 ret = mnt_want_write_file(filp);
718 if (copy_from_user(&newsize, argp, sizeof(newsize)))
721 ret = nilfs_resize_fs(inode->i_sb, newsize);
724 mnt_drop_write_file(filp);
729 static int nilfs_ioctl_set_alloc_range(struct inode *inode, void __user *argp)
731 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
733 __u64 minseg, maxseg;
734 unsigned long segbytes;
737 if (!capable(CAP_SYS_ADMIN))
741 if (copy_from_user(range, argp, sizeof(__u64[2])))
745 if (range[1] > i_size_read(inode->i_sb->s_bdev->bd_inode))
748 segbytes = nilfs->ns_blocks_per_segment * nilfs->ns_blocksize;
750 minseg = range[0] + segbytes - 1;
751 do_div(minseg, segbytes);
752 maxseg = NILFS_SB2_OFFSET_BYTES(range[1]);
753 do_div(maxseg, segbytes);
756 ret = nilfs_sufile_set_alloc_range(nilfs->ns_sufile, minseg, maxseg);
761 static int nilfs_ioctl_get_info(struct inode *inode, struct file *filp,
762 unsigned int cmd, void __user *argp,
764 ssize_t (*dofunc)(struct the_nilfs *,
766 void *, size_t, size_t))
769 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
770 struct nilfs_argv argv;
773 if (copy_from_user(&argv, argp, sizeof(argv)))
776 if (argv.v_size < membsz)
779 ret = nilfs_ioctl_wrap_copy(nilfs, &argv, _IOC_DIR(cmd), dofunc);
783 if (copy_to_user(argp, &argv, sizeof(argv)))
788 long nilfs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
790 struct inode *inode = filp->f_dentry->d_inode;
791 void __user *argp = (void __user *)arg;
794 case FS_IOC_GETFLAGS:
795 return nilfs_ioctl_getflags(inode, argp);
796 case FS_IOC_SETFLAGS:
797 return nilfs_ioctl_setflags(inode, filp, argp);
798 case FS_IOC_GETVERSION:
799 return nilfs_ioctl_getversion(inode, argp);
800 case NILFS_IOCTL_CHANGE_CPMODE:
801 return nilfs_ioctl_change_cpmode(inode, filp, cmd, argp);
802 case NILFS_IOCTL_DELETE_CHECKPOINT:
803 return nilfs_ioctl_delete_checkpoint(inode, filp, cmd, argp);
804 case NILFS_IOCTL_GET_CPINFO:
805 return nilfs_ioctl_get_info(inode, filp, cmd, argp,
806 sizeof(struct nilfs_cpinfo),
807 nilfs_ioctl_do_get_cpinfo);
808 case NILFS_IOCTL_GET_CPSTAT:
809 return nilfs_ioctl_get_cpstat(inode, filp, cmd, argp);
810 case NILFS_IOCTL_GET_SUINFO:
811 return nilfs_ioctl_get_info(inode, filp, cmd, argp,
812 sizeof(struct nilfs_suinfo),
813 nilfs_ioctl_do_get_suinfo);
814 case NILFS_IOCTL_GET_SUSTAT:
815 return nilfs_ioctl_get_sustat(inode, filp, cmd, argp);
816 case NILFS_IOCTL_GET_VINFO:
817 return nilfs_ioctl_get_info(inode, filp, cmd, argp,
818 sizeof(struct nilfs_vinfo),
819 nilfs_ioctl_do_get_vinfo);
820 case NILFS_IOCTL_GET_BDESCS:
821 return nilfs_ioctl_get_bdescs(inode, filp, cmd, argp);
822 case NILFS_IOCTL_CLEAN_SEGMENTS:
823 return nilfs_ioctl_clean_segments(inode, filp, cmd, argp);
824 case NILFS_IOCTL_SYNC:
825 return nilfs_ioctl_sync(inode, filp, cmd, argp);
826 case NILFS_IOCTL_RESIZE:
827 return nilfs_ioctl_resize(inode, filp, argp);
828 case NILFS_IOCTL_SET_ALLOC_RANGE:
829 return nilfs_ioctl_set_alloc_range(inode, argp);
836 long nilfs_compat_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
839 case FS_IOC32_GETFLAGS:
840 cmd = FS_IOC_GETFLAGS;
842 case FS_IOC32_SETFLAGS:
843 cmd = FS_IOC_SETFLAGS;
845 case FS_IOC32_GETVERSION:
846 cmd = FS_IOC_GETVERSION;
848 case NILFS_IOCTL_CHANGE_CPMODE:
849 case NILFS_IOCTL_DELETE_CHECKPOINT:
850 case NILFS_IOCTL_GET_CPINFO:
851 case NILFS_IOCTL_GET_CPSTAT:
852 case NILFS_IOCTL_GET_SUINFO:
853 case NILFS_IOCTL_GET_SUSTAT:
854 case NILFS_IOCTL_GET_VINFO:
855 case NILFS_IOCTL_GET_BDESCS:
856 case NILFS_IOCTL_CLEAN_SEGMENTS:
857 case NILFS_IOCTL_SYNC:
858 case NILFS_IOCTL_RESIZE:
859 case NILFS_IOCTL_SET_ALLOC_RANGE:
864 return nilfs_ioctl(filp, cmd, (unsigned long)compat_ptr(arg));