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 * Written by Koji Sato.
20 #include <linux/wait.h>
21 #include <linux/slab.h>
22 #include <linux/capability.h> /* capable() */
23 #include <linux/uaccess.h> /* copy_from_user(), copy_to_user() */
24 #include <linux/vmalloc.h>
25 #include <linux/compat.h> /* compat_ptr() */
26 #include <linux/mount.h> /* mnt_want_write_file(), mnt_drop_write_file() */
27 #include <linux/buffer_head.h>
28 #include <linux/nilfs2_fs.h>
37 * nilfs_ioctl_wrap_copy - wrapping function of get/set metadata info
38 * @nilfs: nilfs object
39 * @argv: vector of arguments from userspace
40 * @dir: set of direction flags
41 * @dofunc: concrete function of get/set metadata info
43 * Description: nilfs_ioctl_wrap_copy() gets/sets metadata info by means of
44 * calling dofunc() function on the basis of @argv argument.
46 * Return Value: On success, 0 is returned and requested metadata info
47 * is copied into userspace. On error, one of the following
48 * negative error codes is returned.
50 * %-EINVAL - Invalid arguments from userspace.
52 * %-ENOMEM - Insufficient amount of memory available.
54 * %-EFAULT - Failure during execution of requested operation.
56 static int nilfs_ioctl_wrap_copy(struct the_nilfs *nilfs,
57 struct nilfs_argv *argv, int dir,
58 ssize_t (*dofunc)(struct the_nilfs *,
60 void *, size_t, size_t))
63 void __user *base = (void __user *)(unsigned long)argv->v_base;
64 size_t maxmembs, total, n;
69 if (argv->v_nmembs == 0)
72 if (argv->v_size > PAGE_SIZE)
76 * Reject pairs of a start item position (argv->v_index) and a
77 * total count (argv->v_nmembs) which leads position 'pos' to
78 * overflow by the increment at the end of the loop.
80 if (argv->v_index > ~(__u64)0 - argv->v_nmembs)
83 buf = (void *)__get_free_pages(GFP_NOFS, 0);
86 maxmembs = PAGE_SIZE / argv->v_size;
91 for (i = 0; i < argv->v_nmembs; i += n) {
92 n = (argv->v_nmembs - i < maxmembs) ?
93 argv->v_nmembs - i : maxmembs;
94 if ((dir & _IOC_WRITE) &&
95 copy_from_user(buf, base + argv->v_size * i,
101 nr = dofunc(nilfs, &pos, argv->v_flags, buf, argv->v_size,
107 if ((dir & _IOC_READ) &&
108 copy_to_user(base + argv->v_size * i, buf,
109 argv->v_size * nr)) {
119 argv->v_nmembs = total;
121 free_pages((unsigned long)buf, 0);
126 * nilfs_ioctl_getflags - ioctl to support lsattr
128 static int nilfs_ioctl_getflags(struct inode *inode, void __user *argp)
130 unsigned int flags = NILFS_I(inode)->i_flags & FS_FL_USER_VISIBLE;
132 return put_user(flags, (int __user *)argp);
136 * nilfs_ioctl_setflags - ioctl to support chattr
138 static int nilfs_ioctl_setflags(struct inode *inode, struct file *filp,
141 struct nilfs_transaction_info ti;
142 unsigned int flags, oldflags;
145 if (!inode_owner_or_capable(inode))
148 if (get_user(flags, (int __user *)argp))
151 ret = mnt_want_write_file(filp);
155 flags = nilfs_mask_flags(inode->i_mode, flags);
159 oldflags = NILFS_I(inode)->i_flags;
162 * The IMMUTABLE and APPEND_ONLY flags can only be changed by the
163 * relevant capability.
166 if (((flags ^ oldflags) & (FS_APPEND_FL | FS_IMMUTABLE_FL)) &&
167 !capable(CAP_LINUX_IMMUTABLE))
170 ret = nilfs_transaction_begin(inode->i_sb, &ti, 0);
174 NILFS_I(inode)->i_flags = (oldflags & ~FS_FL_USER_MODIFIABLE) |
175 (flags & FS_FL_USER_MODIFIABLE);
177 nilfs_set_inode_flags(inode);
178 inode->i_ctime = CURRENT_TIME;
180 nilfs_set_transaction_flag(NILFS_TI_SYNC);
182 nilfs_mark_inode_dirty(inode);
183 ret = nilfs_transaction_commit(inode->i_sb);
186 mnt_drop_write_file(filp);
191 * nilfs_ioctl_getversion - get info about a file's version (generation number)
193 static int nilfs_ioctl_getversion(struct inode *inode, void __user *argp)
195 return put_user(inode->i_generation, (int __user *)argp);
199 * nilfs_ioctl_change_cpmode - change checkpoint mode (checkpoint/snapshot)
200 * @inode: inode object
202 * @cmd: ioctl's request code
203 * @argp: pointer on argument from userspace
205 * Description: nilfs_ioctl_change_cpmode() function changes mode of
206 * given checkpoint between checkpoint and snapshot state. This ioctl
207 * is used in chcp and mkcp utilities.
209 * Return Value: On success, 0 is returned and mode of a checkpoint is
210 * changed. On error, one of the following negative error codes
213 * %-EPERM - Operation not permitted.
215 * %-EFAULT - Failure during checkpoint mode changing.
217 static int nilfs_ioctl_change_cpmode(struct inode *inode, struct file *filp,
218 unsigned int cmd, void __user *argp)
220 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
221 struct nilfs_transaction_info ti;
222 struct nilfs_cpmode cpmode;
225 if (!capable(CAP_SYS_ADMIN))
228 ret = mnt_want_write_file(filp);
233 if (copy_from_user(&cpmode, argp, sizeof(cpmode)))
236 mutex_lock(&nilfs->ns_snapshot_mount_mutex);
238 nilfs_transaction_begin(inode->i_sb, &ti, 0);
239 ret = nilfs_cpfile_change_cpmode(
240 nilfs->ns_cpfile, cpmode.cm_cno, cpmode.cm_mode);
241 if (unlikely(ret < 0))
242 nilfs_transaction_abort(inode->i_sb);
244 nilfs_transaction_commit(inode->i_sb); /* never fails */
246 mutex_unlock(&nilfs->ns_snapshot_mount_mutex);
248 mnt_drop_write_file(filp);
253 * nilfs_ioctl_delete_checkpoint - remove checkpoint
254 * @inode: inode object
256 * @cmd: ioctl's request code
257 * @argp: pointer on argument from userspace
259 * Description: nilfs_ioctl_delete_checkpoint() function removes
260 * checkpoint from NILFS2 file system. This ioctl is used in rmcp
263 * Return Value: On success, 0 is returned and a checkpoint is
264 * removed. On error, one of the following negative error codes
267 * %-EPERM - Operation not permitted.
269 * %-EFAULT - Failure during checkpoint removing.
272 nilfs_ioctl_delete_checkpoint(struct inode *inode, struct file *filp,
273 unsigned int cmd, void __user *argp)
275 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
276 struct nilfs_transaction_info ti;
280 if (!capable(CAP_SYS_ADMIN))
283 ret = mnt_want_write_file(filp);
288 if (copy_from_user(&cno, argp, sizeof(cno)))
291 nilfs_transaction_begin(inode->i_sb, &ti, 0);
292 ret = nilfs_cpfile_delete_checkpoint(nilfs->ns_cpfile, cno);
293 if (unlikely(ret < 0))
294 nilfs_transaction_abort(inode->i_sb);
296 nilfs_transaction_commit(inode->i_sb); /* never fails */
298 mnt_drop_write_file(filp);
303 * nilfs_ioctl_do_get_cpinfo - callback method getting info about checkpoints
304 * @nilfs: nilfs object
305 * @posp: pointer on array of checkpoint's numbers
306 * @flags: checkpoint mode (checkpoint or snapshot)
307 * @buf: buffer for storing checkponts' info
308 * @size: size in bytes of one checkpoint info item in array
309 * @nmembs: number of checkpoints in array (numbers and infos)
311 * Description: nilfs_ioctl_do_get_cpinfo() function returns info about
312 * requested checkpoints. The NILFS_IOCTL_GET_CPINFO ioctl is used in
313 * lscp utility and by nilfs_cleanerd daemon.
315 * Return value: count of nilfs_cpinfo structures in output buffer.
318 nilfs_ioctl_do_get_cpinfo(struct the_nilfs *nilfs, __u64 *posp, int flags,
319 void *buf, size_t size, size_t nmembs)
323 down_read(&nilfs->ns_segctor_sem);
324 ret = nilfs_cpfile_get_cpinfo(nilfs->ns_cpfile, posp, flags, buf,
326 up_read(&nilfs->ns_segctor_sem);
331 * nilfs_ioctl_get_cpstat - get checkpoints statistics
332 * @inode: inode object
334 * @cmd: ioctl's request code
335 * @argp: pointer on argument from userspace
337 * Description: nilfs_ioctl_get_cpstat() returns information about checkpoints.
338 * The NILFS_IOCTL_GET_CPSTAT ioctl is used by lscp, rmcp utilities
339 * and by nilfs_cleanerd daemon.
341 * Return Value: On success, 0 is returned, and checkpoints information is
342 * copied into userspace pointer @argp. On error, one of the following
343 * negative error codes is returned.
347 * %-ENOMEM - Insufficient amount of memory available.
349 * %-EFAULT - Failure during getting checkpoints statistics.
351 static int nilfs_ioctl_get_cpstat(struct inode *inode, struct file *filp,
352 unsigned int cmd, void __user *argp)
354 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
355 struct nilfs_cpstat cpstat;
358 down_read(&nilfs->ns_segctor_sem);
359 ret = nilfs_cpfile_get_stat(nilfs->ns_cpfile, &cpstat);
360 up_read(&nilfs->ns_segctor_sem);
364 if (copy_to_user(argp, &cpstat, sizeof(cpstat)))
370 * nilfs_ioctl_do_get_suinfo - callback method getting segment usage info
371 * @nilfs: nilfs object
372 * @posp: pointer on array of segment numbers
374 * @buf: buffer for storing suinfo array
375 * @size: size in bytes of one suinfo item in array
376 * @nmembs: count of segment numbers and suinfos in array
378 * Description: nilfs_ioctl_do_get_suinfo() function returns segment usage
379 * info about requested segments. The NILFS_IOCTL_GET_SUINFO ioctl is used
380 * in lssu, nilfs_resize utilities and by nilfs_cleanerd daemon.
382 * Return value: count of nilfs_suinfo structures in output buffer.
385 nilfs_ioctl_do_get_suinfo(struct the_nilfs *nilfs, __u64 *posp, int flags,
386 void *buf, size_t size, size_t nmembs)
390 down_read(&nilfs->ns_segctor_sem);
391 ret = nilfs_sufile_get_suinfo(nilfs->ns_sufile, *posp, buf, size,
393 up_read(&nilfs->ns_segctor_sem);
398 * nilfs_ioctl_get_sustat - get segment usage statistics
399 * @inode: inode object
401 * @cmd: ioctl's request code
402 * @argp: pointer on argument from userspace
404 * Description: nilfs_ioctl_get_sustat() returns segment usage statistics.
405 * The NILFS_IOCTL_GET_SUSTAT ioctl is used in lssu, nilfs_resize utilities
406 * and by nilfs_cleanerd daemon.
408 * Return Value: On success, 0 is returned, and segment usage information is
409 * copied into userspace pointer @argp. On error, one of the following
410 * negative error codes is returned.
414 * %-ENOMEM - Insufficient amount of memory available.
416 * %-EFAULT - Failure during getting segment usage statistics.
418 static int nilfs_ioctl_get_sustat(struct inode *inode, struct file *filp,
419 unsigned int cmd, void __user *argp)
421 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
422 struct nilfs_sustat sustat;
425 down_read(&nilfs->ns_segctor_sem);
426 ret = nilfs_sufile_get_stat(nilfs->ns_sufile, &sustat);
427 up_read(&nilfs->ns_segctor_sem);
431 if (copy_to_user(argp, &sustat, sizeof(sustat)))
437 * nilfs_ioctl_do_get_vinfo - callback method getting virtual blocks info
438 * @nilfs: nilfs object
441 * @buf: buffer for storing array of nilfs_vinfo structures
442 * @size: size in bytes of one vinfo item in array
443 * @nmembs: count of vinfos in array
445 * Description: nilfs_ioctl_do_get_vinfo() function returns information
446 * on virtual block addresses. The NILFS_IOCTL_GET_VINFO ioctl is used
447 * by nilfs_cleanerd daemon.
449 * Return value: count of nilfs_vinfo structures in output buffer.
452 nilfs_ioctl_do_get_vinfo(struct the_nilfs *nilfs, __u64 *posp, int flags,
453 void *buf, size_t size, size_t nmembs)
457 down_read(&nilfs->ns_segctor_sem);
458 ret = nilfs_dat_get_vinfo(nilfs->ns_dat, buf, size, nmembs);
459 up_read(&nilfs->ns_segctor_sem);
464 * nilfs_ioctl_do_get_bdescs - callback method getting disk block descriptors
465 * @nilfs: nilfs object
468 * @buf: buffer for storing array of nilfs_bdesc structures
469 * @size: size in bytes of one bdesc item in array
470 * @nmembs: count of bdescs in array
472 * Description: nilfs_ioctl_do_get_bdescs() function returns information
473 * about descriptors of disk block numbers. The NILFS_IOCTL_GET_BDESCS ioctl
474 * is used by nilfs_cleanerd daemon.
476 * Return value: count of nilfs_bdescs structures in output buffer.
479 nilfs_ioctl_do_get_bdescs(struct the_nilfs *nilfs, __u64 *posp, int flags,
480 void *buf, size_t size, size_t nmembs)
482 struct nilfs_bmap *bmap = NILFS_I(nilfs->ns_dat)->i_bmap;
483 struct nilfs_bdesc *bdescs = buf;
486 down_read(&nilfs->ns_segctor_sem);
487 for (i = 0; i < nmembs; i++) {
488 ret = nilfs_bmap_lookup_at_level(bmap,
490 bdescs[i].bd_level + 1,
491 &bdescs[i].bd_blocknr);
493 if (ret != -ENOENT) {
494 up_read(&nilfs->ns_segctor_sem);
497 bdescs[i].bd_blocknr = 0;
500 up_read(&nilfs->ns_segctor_sem);
505 * nilfs_ioctl_get_bdescs - get disk block descriptors
506 * @inode: inode object
508 * @cmd: ioctl's request code
509 * @argp: pointer on argument from userspace
511 * Description: nilfs_ioctl_do_get_bdescs() function returns information
512 * about descriptors of disk block numbers. The NILFS_IOCTL_GET_BDESCS ioctl
513 * is used by nilfs_cleanerd daemon.
515 * Return Value: On success, 0 is returned, and disk block descriptors are
516 * copied into userspace pointer @argp. On error, one of the following
517 * negative error codes is returned.
519 * %-EINVAL - Invalid arguments from userspace.
523 * %-ENOMEM - Insufficient amount of memory available.
525 * %-EFAULT - Failure during getting disk block descriptors.
527 static int nilfs_ioctl_get_bdescs(struct inode *inode, struct file *filp,
528 unsigned int cmd, void __user *argp)
530 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
531 struct nilfs_argv argv;
534 if (copy_from_user(&argv, argp, sizeof(argv)))
537 if (argv.v_size != sizeof(struct nilfs_bdesc))
540 ret = nilfs_ioctl_wrap_copy(nilfs, &argv, _IOC_DIR(cmd),
541 nilfs_ioctl_do_get_bdescs);
545 if (copy_to_user(argp, &argv, sizeof(argv)))
551 * nilfs_ioctl_move_inode_block - prepare data/node block for moving by GC
552 * @inode: inode object
553 * @vdesc: descriptor of virtual block number
554 * @buffers: list of moving buffers
556 * Description: nilfs_ioctl_move_inode_block() function registers data/node
557 * buffer in the GC pagecache and submit read request.
559 * Return Value: On success, 0 is returned. On error, one of the following
560 * negative error codes is returned.
564 * %-ENOMEM - Insufficient amount of memory available.
566 * %-ENOENT - Requested block doesn't exist.
568 * %-EEXIST - Blocks conflict is detected.
570 static int nilfs_ioctl_move_inode_block(struct inode *inode,
571 struct nilfs_vdesc *vdesc,
572 struct list_head *buffers)
574 struct buffer_head *bh;
577 if (vdesc->vd_flags == 0)
578 ret = nilfs_gccache_submit_read_data(
579 inode, vdesc->vd_offset, vdesc->vd_blocknr,
580 vdesc->vd_vblocknr, &bh);
582 ret = nilfs_gccache_submit_read_node(
583 inode, vdesc->vd_blocknr, vdesc->vd_vblocknr, &bh);
585 if (unlikely(ret < 0)) {
588 "%s: invalid virtual block address (%s): "
589 "ino=%llu, cno=%llu, offset=%llu, "
590 "blocknr=%llu, vblocknr=%llu\n",
591 __func__, vdesc->vd_flags ? "node" : "data",
592 (unsigned long long)vdesc->vd_ino,
593 (unsigned long long)vdesc->vd_cno,
594 (unsigned long long)vdesc->vd_offset,
595 (unsigned long long)vdesc->vd_blocknr,
596 (unsigned long long)vdesc->vd_vblocknr);
599 if (unlikely(!list_empty(&bh->b_assoc_buffers))) {
600 printk(KERN_CRIT "%s: conflicting %s buffer: ino=%llu, "
601 "cno=%llu, offset=%llu, blocknr=%llu, vblocknr=%llu\n",
602 __func__, vdesc->vd_flags ? "node" : "data",
603 (unsigned long long)vdesc->vd_ino,
604 (unsigned long long)vdesc->vd_cno,
605 (unsigned long long)vdesc->vd_offset,
606 (unsigned long long)vdesc->vd_blocknr,
607 (unsigned long long)vdesc->vd_vblocknr);
611 list_add_tail(&bh->b_assoc_buffers, buffers);
616 * nilfs_ioctl_move_blocks - move valid inode's blocks during garbage collection
617 * @sb: superblock object
618 * @argv: vector of arguments from userspace
619 * @buf: array of nilfs_vdesc structures
621 * Description: nilfs_ioctl_move_blocks() function reads valid data/node
622 * blocks that garbage collector specified with the array of nilfs_vdesc
623 * structures and stores them into page caches of GC inodes.
625 * Return Value: Number of processed nilfs_vdesc structures or
626 * error code, otherwise.
628 static int nilfs_ioctl_move_blocks(struct super_block *sb,
629 struct nilfs_argv *argv, void *buf)
631 size_t nmembs = argv->v_nmembs;
632 struct the_nilfs *nilfs = sb->s_fs_info;
634 struct nilfs_vdesc *vdesc;
635 struct buffer_head *bh, *n;
641 for (i = 0, vdesc = buf; i < nmembs; ) {
644 inode = nilfs_iget_for_gc(sb, ino, cno);
646 ret = PTR_ERR(inode);
649 if (list_empty(&NILFS_I(inode)->i_dirty)) {
651 * Add the inode to GC inode list. Garbage Collection
652 * is serialized and no two processes manipulate the
653 * list simultaneously.
656 list_add(&NILFS_I(inode)->i_dirty,
657 &nilfs->ns_gc_inodes);
661 ret = nilfs_ioctl_move_inode_block(inode, vdesc,
663 if (unlikely(ret < 0)) {
668 } while (++i < nmembs &&
669 vdesc->vd_ino == ino && vdesc->vd_cno == cno);
671 iput(inode); /* The inode still remains in GC inode list */
674 list_for_each_entry_safe(bh, n, &buffers, b_assoc_buffers) {
675 ret = nilfs_gccache_wait_and_mark_dirty(bh);
676 if (unlikely(ret < 0)) {
677 WARN_ON(ret == -EEXIST);
680 list_del_init(&bh->b_assoc_buffers);
686 list_for_each_entry_safe(bh, n, &buffers, b_assoc_buffers) {
687 list_del_init(&bh->b_assoc_buffers);
694 * nilfs_ioctl_delete_checkpoints - delete checkpoints
695 * @nilfs: nilfs object
696 * @argv: vector of arguments from userspace
697 * @buf: array of periods of checkpoints numbers
699 * Description: nilfs_ioctl_delete_checkpoints() function deletes checkpoints
700 * in the period from p_start to p_end, excluding p_end itself. The checkpoints
701 * which have been already deleted are ignored.
703 * Return Value: Number of processed nilfs_period structures or
704 * error code, otherwise.
708 * %-ENOMEM - Insufficient amount of memory available.
710 * %-EINVAL - invalid checkpoints.
712 static int nilfs_ioctl_delete_checkpoints(struct the_nilfs *nilfs,
713 struct nilfs_argv *argv, void *buf)
715 size_t nmembs = argv->v_nmembs;
716 struct inode *cpfile = nilfs->ns_cpfile;
717 struct nilfs_period *periods = buf;
720 for (i = 0; i < nmembs; i++) {
721 ret = nilfs_cpfile_delete_checkpoints(
722 cpfile, periods[i].p_start, periods[i].p_end);
730 * nilfs_ioctl_free_vblocknrs - free virtual block numbers
731 * @nilfs: nilfs object
732 * @argv: vector of arguments from userspace
733 * @buf: array of virtual block numbers
735 * Description: nilfs_ioctl_free_vblocknrs() function frees
736 * the virtual block numbers specified by @buf and @argv->v_nmembs.
738 * Return Value: Number of processed virtual block numbers or
739 * error code, otherwise.
743 * %-ENOMEM - Insufficient amount of memory available.
745 * %-ENOENT - The virtual block number have not been allocated.
747 static int nilfs_ioctl_free_vblocknrs(struct the_nilfs *nilfs,
748 struct nilfs_argv *argv, void *buf)
750 size_t nmembs = argv->v_nmembs;
753 ret = nilfs_dat_freev(nilfs->ns_dat, buf, nmembs);
755 return (ret < 0) ? ret : nmembs;
759 * nilfs_ioctl_mark_blocks_dirty - mark blocks dirty
760 * @nilfs: nilfs object
761 * @argv: vector of arguments from userspace
762 * @buf: array of block descriptors
764 * Description: nilfs_ioctl_mark_blocks_dirty() function marks
765 * metadata file or data blocks as dirty.
767 * Return Value: Number of processed block descriptors or
768 * error code, otherwise.
770 * %-ENOMEM - Insufficient memory available.
774 * %-ENOENT - the specified block does not exist (hole block)
776 static int nilfs_ioctl_mark_blocks_dirty(struct the_nilfs *nilfs,
777 struct nilfs_argv *argv, void *buf)
779 size_t nmembs = argv->v_nmembs;
780 struct nilfs_bmap *bmap = NILFS_I(nilfs->ns_dat)->i_bmap;
781 struct nilfs_bdesc *bdescs = buf;
782 struct buffer_head *bh;
785 for (i = 0; i < nmembs; i++) {
786 /* XXX: use macro or inline func to check liveness */
787 ret = nilfs_bmap_lookup_at_level(bmap,
789 bdescs[i].bd_level + 1,
790 &bdescs[i].bd_blocknr);
794 bdescs[i].bd_blocknr = 0;
796 if (bdescs[i].bd_blocknr != bdescs[i].bd_oblocknr)
797 /* skip dead block */
799 if (bdescs[i].bd_level == 0) {
800 ret = nilfs_mdt_get_block(nilfs->ns_dat,
804 WARN_ON(ret == -ENOENT);
807 mark_buffer_dirty(bh);
808 nilfs_mdt_mark_dirty(nilfs->ns_dat);
811 ret = nilfs_bmap_mark(bmap, bdescs[i].bd_offset,
814 WARN_ON(ret == -ENOENT);
822 int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *nilfs,
823 struct nilfs_argv *argv, void **kbufs)
828 ret = nilfs_ioctl_delete_checkpoints(nilfs, &argv[1], kbufs[1]);
831 * can safely abort because checkpoints can be removed
834 msg = "cannot delete checkpoints";
837 ret = nilfs_ioctl_free_vblocknrs(nilfs, &argv[2], kbufs[2]);
840 * can safely abort because DAT file is updated atomically
841 * using a copy-on-write technique.
843 msg = "cannot delete virtual blocks from DAT file";
846 ret = nilfs_ioctl_mark_blocks_dirty(nilfs, &argv[3], kbufs[3]);
849 * can safely abort because the operation is nondestructive.
851 msg = "cannot mark copying blocks dirty";
857 printk(KERN_ERR "NILFS: GC failed during preparation: %s: err=%d\n",
863 * nilfs_ioctl_clean_segments - clean segments
864 * @inode: inode object
866 * @cmd: ioctl's request code
867 * @argp: pointer on argument from userspace
869 * Description: nilfs_ioctl_clean_segments() function makes garbage
870 * collection operation in the environment of requested parameters
871 * from userspace. The NILFS_IOCTL_CLEAN_SEGMENTS ioctl is used by
872 * nilfs_cleanerd daemon.
874 * Return Value: On success, 0 is returned or error code, otherwise.
876 static int nilfs_ioctl_clean_segments(struct inode *inode, struct file *filp,
877 unsigned int cmd, void __user *argp)
879 struct nilfs_argv argv[5];
880 static const size_t argsz[5] = {
881 sizeof(struct nilfs_vdesc),
882 sizeof(struct nilfs_period),
884 sizeof(struct nilfs_bdesc),
889 struct the_nilfs *nilfs;
893 if (!capable(CAP_SYS_ADMIN))
896 ret = mnt_want_write_file(filp);
901 if (copy_from_user(argv, argp, sizeof(argv)))
905 nsegs = argv[4].v_nmembs;
906 if (argv[4].v_size != argsz[4])
908 if (nsegs > UINT_MAX / sizeof(__u64))
912 * argv[4] points to segment numbers this ioctl cleans. We
913 * use kmalloc() for its buffer because memory used for the
914 * segment numbers is enough small.
916 kbufs[4] = memdup_user((void __user *)(unsigned long)argv[4].v_base,
917 nsegs * sizeof(__u64));
918 if (IS_ERR(kbufs[4])) {
919 ret = PTR_ERR(kbufs[4]);
922 nilfs = inode->i_sb->s_fs_info;
924 for (n = 0; n < 4; n++) {
926 if (argv[n].v_size != argsz[n])
929 if (argv[n].v_nmembs > nsegs * nilfs->ns_blocks_per_segment)
932 if (argv[n].v_nmembs >= UINT_MAX / argv[n].v_size)
935 len = argv[n].v_size * argv[n].v_nmembs;
936 base = (void __user *)(unsigned long)argv[n].v_base;
942 kbufs[n] = vmalloc(len);
947 if (copy_from_user(kbufs[n], base, len)) {
955 * nilfs_ioctl_move_blocks() will call nilfs_iget_for_gc(),
956 * which will operates an inode list without blocking.
957 * To protect the list from concurrent operations,
958 * nilfs_ioctl_move_blocks should be atomic operation.
960 if (test_and_set_bit(THE_NILFS_GC_RUNNING, &nilfs->ns_flags)) {
965 ret = nilfs_ioctl_move_blocks(inode->i_sb, &argv[0], kbufs[0]);
967 printk(KERN_ERR "NILFS: GC failed during preparation: "
968 "cannot read source blocks: err=%d\n", ret);
970 if (nilfs_sb_need_update(nilfs))
971 set_nilfs_discontinued(nilfs);
972 ret = nilfs_clean_segments(inode->i_sb, argv, kbufs);
975 nilfs_remove_all_gcinodes(nilfs);
976 clear_nilfs_gc_running(nilfs);
983 mnt_drop_write_file(filp);
988 * nilfs_ioctl_sync - make a checkpoint
989 * @inode: inode object
991 * @cmd: ioctl's request code
992 * @argp: pointer on argument from userspace
994 * Description: nilfs_ioctl_sync() function constructs a logical segment
995 * for checkpointing. This function guarantees that all modified data
996 * and metadata are written out to the device when it successfully
999 * Return Value: On success, 0 is retured. On errors, one of the following
1000 * negative error code is returned.
1002 * %-EROFS - Read only filesystem.
1006 * %-ENOSPC - No space left on device (only in a panic state).
1008 * %-ERESTARTSYS - Interrupted.
1010 * %-ENOMEM - Insufficient memory available.
1012 * %-EFAULT - Failure during execution of requested operation.
1014 static int nilfs_ioctl_sync(struct inode *inode, struct file *filp,
1015 unsigned int cmd, void __user *argp)
1019 struct the_nilfs *nilfs;
1021 ret = nilfs_construct_segment(inode->i_sb);
1025 nilfs = inode->i_sb->s_fs_info;
1026 ret = nilfs_flush_device(nilfs);
1031 down_read(&nilfs->ns_segctor_sem);
1032 cno = nilfs->ns_cno - 1;
1033 up_read(&nilfs->ns_segctor_sem);
1034 if (copy_to_user(argp, &cno, sizeof(cno)))
1041 * nilfs_ioctl_resize - resize NILFS2 volume
1042 * @inode: inode object
1043 * @filp: file object
1044 * @argp: pointer on argument from userspace
1046 * Return Value: On success, 0 is returned or error code, otherwise.
1048 static int nilfs_ioctl_resize(struct inode *inode, struct file *filp,
1054 if (!capable(CAP_SYS_ADMIN))
1057 ret = mnt_want_write_file(filp);
1062 if (copy_from_user(&newsize, argp, sizeof(newsize)))
1063 goto out_drop_write;
1065 ret = nilfs_resize_fs(inode->i_sb, newsize);
1068 mnt_drop_write_file(filp);
1074 * nilfs_ioctl_trim_fs() - trim ioctl handle function
1075 * @inode: inode object
1076 * @argp: pointer on argument from userspace
1078 * Decription: nilfs_ioctl_trim_fs is the FITRIM ioctl handle function. It
1079 * checks the arguments from userspace and calls nilfs_sufile_trim_fs, which
1080 * performs the actual trim operation.
1082 * Return Value: On success, 0 is returned or negative error code, otherwise.
1084 static int nilfs_ioctl_trim_fs(struct inode *inode, void __user *argp)
1086 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
1087 struct request_queue *q = bdev_get_queue(nilfs->ns_bdev);
1088 struct fstrim_range range;
1091 if (!capable(CAP_SYS_ADMIN))
1094 if (!blk_queue_discard(q))
1097 if (copy_from_user(&range, argp, sizeof(range)))
1100 range.minlen = max_t(u64, range.minlen, q->limits.discard_granularity);
1102 down_read(&nilfs->ns_segctor_sem);
1103 ret = nilfs_sufile_trim_fs(nilfs->ns_sufile, &range);
1104 up_read(&nilfs->ns_segctor_sem);
1109 if (copy_to_user(argp, &range, sizeof(range)))
1116 * nilfs_ioctl_set_alloc_range - limit range of segments to be allocated
1117 * @inode: inode object
1118 * @argp: pointer on argument from userspace
1120 * Decription: nilfs_ioctl_set_alloc_range() function defines lower limit
1121 * of segments in bytes and upper limit of segments in bytes.
1122 * The NILFS_IOCTL_SET_ALLOC_RANGE is used by nilfs_resize utility.
1124 * Return Value: On success, 0 is returned or error code, otherwise.
1126 static int nilfs_ioctl_set_alloc_range(struct inode *inode, void __user *argp)
1128 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
1130 __u64 minseg, maxseg;
1131 unsigned long segbytes;
1134 if (!capable(CAP_SYS_ADMIN))
1138 if (copy_from_user(range, argp, sizeof(__u64[2])))
1142 if (range[1] > i_size_read(inode->i_sb->s_bdev->bd_inode))
1145 segbytes = nilfs->ns_blocks_per_segment * nilfs->ns_blocksize;
1147 minseg = range[0] + segbytes - 1;
1148 do_div(minseg, segbytes);
1149 maxseg = NILFS_SB2_OFFSET_BYTES(range[1]);
1150 do_div(maxseg, segbytes);
1153 ret = nilfs_sufile_set_alloc_range(nilfs->ns_sufile, minseg, maxseg);
1159 * nilfs_ioctl_get_info - wrapping function of get metadata info
1160 * @inode: inode object
1161 * @filp: file object
1162 * @cmd: ioctl's request code
1163 * @argp: pointer on argument from userspace
1164 * @membsz: size of an item in bytes
1165 * @dofunc: concrete function of getting metadata info
1167 * Description: nilfs_ioctl_get_info() gets metadata info by means of
1168 * calling dofunc() function.
1170 * Return Value: On success, 0 is returned and requested metadata info
1171 * is copied into userspace. On error, one of the following
1172 * negative error codes is returned.
1174 * %-EINVAL - Invalid arguments from userspace.
1176 * %-ENOMEM - Insufficient amount of memory available.
1178 * %-EFAULT - Failure during execution of requested operation.
1180 static int nilfs_ioctl_get_info(struct inode *inode, struct file *filp,
1181 unsigned int cmd, void __user *argp,
1183 ssize_t (*dofunc)(struct the_nilfs *,
1185 void *, size_t, size_t))
1188 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
1189 struct nilfs_argv argv;
1192 if (copy_from_user(&argv, argp, sizeof(argv)))
1195 if (argv.v_size < membsz)
1198 ret = nilfs_ioctl_wrap_copy(nilfs, &argv, _IOC_DIR(cmd), dofunc);
1202 if (copy_to_user(argp, &argv, sizeof(argv)))
1208 * nilfs_ioctl_set_suinfo - set segment usage info
1209 * @inode: inode object
1210 * @filp: file object
1211 * @cmd: ioctl's request code
1212 * @argp: pointer on argument from userspace
1214 * Description: Expects an array of nilfs_suinfo_update structures
1215 * encapsulated in nilfs_argv and updates the segment usage info
1216 * according to the flags in nilfs_suinfo_update.
1218 * Return Value: On success, 0 is returned. On error, one of the
1219 * following negative error codes is returned.
1221 * %-EPERM - Not enough permissions
1223 * %-EFAULT - Error copying input data
1225 * %-EIO - I/O error.
1227 * %-ENOMEM - Insufficient amount of memory available.
1229 * %-EINVAL - Invalid values in input (segment number, flags or nblocks)
1231 static int nilfs_ioctl_set_suinfo(struct inode *inode, struct file *filp,
1232 unsigned int cmd, void __user *argp)
1234 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
1235 struct nilfs_transaction_info ti;
1236 struct nilfs_argv argv;
1242 if (!capable(CAP_SYS_ADMIN))
1245 ret = mnt_want_write_file(filp);
1250 if (copy_from_user(&argv, argp, sizeof(argv)))
1254 if (argv.v_size < sizeof(struct nilfs_suinfo_update))
1257 if (argv.v_nmembs > nilfs->ns_nsegments)
1260 if (argv.v_nmembs >= UINT_MAX / argv.v_size)
1263 len = argv.v_size * argv.v_nmembs;
1269 base = (void __user *)(unsigned long)argv.v_base;
1270 kbuf = vmalloc(len);
1276 if (copy_from_user(kbuf, base, len)) {
1281 nilfs_transaction_begin(inode->i_sb, &ti, 0);
1282 ret = nilfs_sufile_set_suinfo(nilfs->ns_sufile, kbuf, argv.v_size,
1284 if (unlikely(ret < 0))
1285 nilfs_transaction_abort(inode->i_sb);
1287 nilfs_transaction_commit(inode->i_sb); /* never fails */
1292 mnt_drop_write_file(filp);
1296 long nilfs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
1298 struct inode *inode = file_inode(filp);
1299 void __user *argp = (void __user *)arg;
1302 case FS_IOC_GETFLAGS:
1303 return nilfs_ioctl_getflags(inode, argp);
1304 case FS_IOC_SETFLAGS:
1305 return nilfs_ioctl_setflags(inode, filp, argp);
1306 case FS_IOC_GETVERSION:
1307 return nilfs_ioctl_getversion(inode, argp);
1308 case NILFS_IOCTL_CHANGE_CPMODE:
1309 return nilfs_ioctl_change_cpmode(inode, filp, cmd, argp);
1310 case NILFS_IOCTL_DELETE_CHECKPOINT:
1311 return nilfs_ioctl_delete_checkpoint(inode, filp, cmd, argp);
1312 case NILFS_IOCTL_GET_CPINFO:
1313 return nilfs_ioctl_get_info(inode, filp, cmd, argp,
1314 sizeof(struct nilfs_cpinfo),
1315 nilfs_ioctl_do_get_cpinfo);
1316 case NILFS_IOCTL_GET_CPSTAT:
1317 return nilfs_ioctl_get_cpstat(inode, filp, cmd, argp);
1318 case NILFS_IOCTL_GET_SUINFO:
1319 return nilfs_ioctl_get_info(inode, filp, cmd, argp,
1320 sizeof(struct nilfs_suinfo),
1321 nilfs_ioctl_do_get_suinfo);
1322 case NILFS_IOCTL_SET_SUINFO:
1323 return nilfs_ioctl_set_suinfo(inode, filp, cmd, argp);
1324 case NILFS_IOCTL_GET_SUSTAT:
1325 return nilfs_ioctl_get_sustat(inode, filp, cmd, argp);
1326 case NILFS_IOCTL_GET_VINFO:
1327 return nilfs_ioctl_get_info(inode, filp, cmd, argp,
1328 sizeof(struct nilfs_vinfo),
1329 nilfs_ioctl_do_get_vinfo);
1330 case NILFS_IOCTL_GET_BDESCS:
1331 return nilfs_ioctl_get_bdescs(inode, filp, cmd, argp);
1332 case NILFS_IOCTL_CLEAN_SEGMENTS:
1333 return nilfs_ioctl_clean_segments(inode, filp, cmd, argp);
1334 case NILFS_IOCTL_SYNC:
1335 return nilfs_ioctl_sync(inode, filp, cmd, argp);
1336 case NILFS_IOCTL_RESIZE:
1337 return nilfs_ioctl_resize(inode, filp, argp);
1338 case NILFS_IOCTL_SET_ALLOC_RANGE:
1339 return nilfs_ioctl_set_alloc_range(inode, argp);
1341 return nilfs_ioctl_trim_fs(inode, argp);
1347 #ifdef CONFIG_COMPAT
1348 long nilfs_compat_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
1351 case FS_IOC32_GETFLAGS:
1352 cmd = FS_IOC_GETFLAGS;
1354 case FS_IOC32_SETFLAGS:
1355 cmd = FS_IOC_SETFLAGS;
1357 case FS_IOC32_GETVERSION:
1358 cmd = FS_IOC_GETVERSION;
1360 case NILFS_IOCTL_CHANGE_CPMODE:
1361 case NILFS_IOCTL_DELETE_CHECKPOINT:
1362 case NILFS_IOCTL_GET_CPINFO:
1363 case NILFS_IOCTL_GET_CPSTAT:
1364 case NILFS_IOCTL_GET_SUINFO:
1365 case NILFS_IOCTL_SET_SUINFO:
1366 case NILFS_IOCTL_GET_SUSTAT:
1367 case NILFS_IOCTL_GET_VINFO:
1368 case NILFS_IOCTL_GET_BDESCS:
1369 case NILFS_IOCTL_CLEAN_SEGMENTS:
1370 case NILFS_IOCTL_SYNC:
1371 case NILFS_IOCTL_RESIZE:
1372 case NILFS_IOCTL_SET_ALLOC_RANGE:
1375 return -ENOIOCTLCMD;
1377 return nilfs_ioctl(filp, cmd, (unsigned long)compat_ptr(arg));