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>
36 * nilfs_ioctl_wrap_copy - wrapping function of get/set metadata info
37 * @nilfs: nilfs object
38 * @argv: vector of arguments from userspace
39 * @dir: set of direction flags
40 * @dofunc: concrete function of get/set metadata info
42 * Description: nilfs_ioctl_wrap_copy() gets/sets metadata info by means of
43 * calling dofunc() function on the basis of @argv argument.
45 * Return Value: On success, 0 is returned and requested metadata info
46 * is copied into userspace. On error, one of the following
47 * negative error codes is returned.
49 * %-EINVAL - Invalid arguments from userspace.
51 * %-ENOMEM - Insufficient amount of memory available.
53 * %-EFAULT - Failure during execution of requested operation.
55 static int nilfs_ioctl_wrap_copy(struct the_nilfs *nilfs,
56 struct nilfs_argv *argv, int dir,
57 ssize_t (*dofunc)(struct the_nilfs *,
59 void *, size_t, size_t))
62 void __user *base = (void __user *)(unsigned long)argv->v_base;
63 size_t maxmembs, total, n;
68 if (argv->v_nmembs == 0)
71 if (argv->v_size > PAGE_SIZE)
75 * Reject pairs of a start item position (argv->v_index) and a
76 * total count (argv->v_nmembs) which leads position 'pos' to
77 * overflow by the increment at the end of the loop.
79 if (argv->v_index > ~(__u64)0 - argv->v_nmembs)
82 buf = (void *)__get_free_pages(GFP_NOFS, 0);
85 maxmembs = PAGE_SIZE / argv->v_size;
90 for (i = 0; i < argv->v_nmembs; i += n) {
91 n = (argv->v_nmembs - i < maxmembs) ?
92 argv->v_nmembs - i : maxmembs;
93 if ((dir & _IOC_WRITE) &&
94 copy_from_user(buf, base + argv->v_size * i,
100 nr = dofunc(nilfs, &pos, argv->v_flags, buf, argv->v_size,
106 if ((dir & _IOC_READ) &&
107 copy_to_user(base + argv->v_size * i, buf,
108 argv->v_size * nr)) {
118 argv->v_nmembs = total;
120 free_pages((unsigned long)buf, 0);
125 * nilfs_ioctl_getflags - ioctl to support lsattr
127 static int nilfs_ioctl_getflags(struct inode *inode, void __user *argp)
129 unsigned int flags = NILFS_I(inode)->i_flags & FS_FL_USER_VISIBLE;
131 return put_user(flags, (int __user *)argp);
135 * nilfs_ioctl_setflags - ioctl to support chattr
137 static int nilfs_ioctl_setflags(struct inode *inode, struct file *filp,
140 struct nilfs_transaction_info ti;
141 unsigned int flags, oldflags;
144 if (!inode_owner_or_capable(inode))
147 if (get_user(flags, (int __user *)argp))
150 ret = mnt_want_write_file(filp);
154 flags = nilfs_mask_flags(inode->i_mode, flags);
158 oldflags = NILFS_I(inode)->i_flags;
161 * The IMMUTABLE and APPEND_ONLY flags can only be changed by the
162 * relevant capability.
165 if (((flags ^ oldflags) & (FS_APPEND_FL | FS_IMMUTABLE_FL)) &&
166 !capable(CAP_LINUX_IMMUTABLE))
169 ret = nilfs_transaction_begin(inode->i_sb, &ti, 0);
173 NILFS_I(inode)->i_flags = (oldflags & ~FS_FL_USER_MODIFIABLE) |
174 (flags & FS_FL_USER_MODIFIABLE);
176 nilfs_set_inode_flags(inode);
177 inode->i_ctime = current_time(inode);
179 nilfs_set_transaction_flag(NILFS_TI_SYNC);
181 nilfs_mark_inode_dirty(inode);
182 ret = nilfs_transaction_commit(inode->i_sb);
185 mnt_drop_write_file(filp);
190 * nilfs_ioctl_getversion - get info about a file's version (generation number)
192 static int nilfs_ioctl_getversion(struct inode *inode, void __user *argp)
194 return put_user(inode->i_generation, (int __user *)argp);
198 * nilfs_ioctl_change_cpmode - change checkpoint mode (checkpoint/snapshot)
199 * @inode: inode object
201 * @cmd: ioctl's request code
202 * @argp: pointer on argument from userspace
204 * Description: nilfs_ioctl_change_cpmode() function changes mode of
205 * given checkpoint between checkpoint and snapshot state. This ioctl
206 * is used in chcp and mkcp utilities.
208 * Return Value: On success, 0 is returned and mode of a checkpoint is
209 * changed. On error, one of the following negative error codes
212 * %-EPERM - Operation not permitted.
214 * %-EFAULT - Failure during checkpoint mode changing.
216 static int nilfs_ioctl_change_cpmode(struct inode *inode, struct file *filp,
217 unsigned int cmd, void __user *argp)
219 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
220 struct nilfs_transaction_info ti;
221 struct nilfs_cpmode cpmode;
224 if (!capable(CAP_SYS_ADMIN))
227 ret = mnt_want_write_file(filp);
232 if (copy_from_user(&cpmode, argp, sizeof(cpmode)))
235 mutex_lock(&nilfs->ns_snapshot_mount_mutex);
237 nilfs_transaction_begin(inode->i_sb, &ti, 0);
238 ret = nilfs_cpfile_change_cpmode(
239 nilfs->ns_cpfile, cpmode.cm_cno, cpmode.cm_mode);
240 if (unlikely(ret < 0))
241 nilfs_transaction_abort(inode->i_sb);
243 nilfs_transaction_commit(inode->i_sb); /* never fails */
245 mutex_unlock(&nilfs->ns_snapshot_mount_mutex);
247 mnt_drop_write_file(filp);
252 * nilfs_ioctl_delete_checkpoint - remove checkpoint
253 * @inode: inode object
255 * @cmd: ioctl's request code
256 * @argp: pointer on argument from userspace
258 * Description: nilfs_ioctl_delete_checkpoint() function removes
259 * checkpoint from NILFS2 file system. This ioctl is used in rmcp
262 * Return Value: On success, 0 is returned and a checkpoint is
263 * removed. On error, one of the following negative error codes
266 * %-EPERM - Operation not permitted.
268 * %-EFAULT - Failure during checkpoint removing.
271 nilfs_ioctl_delete_checkpoint(struct inode *inode, struct file *filp,
272 unsigned int cmd, void __user *argp)
274 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
275 struct nilfs_transaction_info ti;
279 if (!capable(CAP_SYS_ADMIN))
282 ret = mnt_want_write_file(filp);
287 if (copy_from_user(&cno, argp, sizeof(cno)))
290 nilfs_transaction_begin(inode->i_sb, &ti, 0);
291 ret = nilfs_cpfile_delete_checkpoint(nilfs->ns_cpfile, cno);
292 if (unlikely(ret < 0))
293 nilfs_transaction_abort(inode->i_sb);
295 nilfs_transaction_commit(inode->i_sb); /* never fails */
297 mnt_drop_write_file(filp);
302 * nilfs_ioctl_do_get_cpinfo - callback method getting info about checkpoints
303 * @nilfs: nilfs object
304 * @posp: pointer on array of checkpoint's numbers
305 * @flags: checkpoint mode (checkpoint or snapshot)
306 * @buf: buffer for storing checkponts' info
307 * @size: size in bytes of one checkpoint info item in array
308 * @nmembs: number of checkpoints in array (numbers and infos)
310 * Description: nilfs_ioctl_do_get_cpinfo() function returns info about
311 * requested checkpoints. The NILFS_IOCTL_GET_CPINFO ioctl is used in
312 * lscp utility and by nilfs_cleanerd daemon.
314 * Return value: count of nilfs_cpinfo structures in output buffer.
317 nilfs_ioctl_do_get_cpinfo(struct the_nilfs *nilfs, __u64 *posp, int flags,
318 void *buf, size_t size, size_t nmembs)
322 down_read(&nilfs->ns_segctor_sem);
323 ret = nilfs_cpfile_get_cpinfo(nilfs->ns_cpfile, posp, flags, buf,
325 up_read(&nilfs->ns_segctor_sem);
330 * nilfs_ioctl_get_cpstat - get checkpoints statistics
331 * @inode: inode object
333 * @cmd: ioctl's request code
334 * @argp: pointer on argument from userspace
336 * Description: nilfs_ioctl_get_cpstat() returns information about checkpoints.
337 * The NILFS_IOCTL_GET_CPSTAT ioctl is used by lscp, rmcp utilities
338 * and by nilfs_cleanerd daemon.
340 * Return Value: On success, 0 is returned, and checkpoints information is
341 * copied into userspace pointer @argp. On error, one of the following
342 * negative error codes is returned.
346 * %-ENOMEM - Insufficient amount of memory available.
348 * %-EFAULT - Failure during getting checkpoints statistics.
350 static int nilfs_ioctl_get_cpstat(struct inode *inode, struct file *filp,
351 unsigned int cmd, void __user *argp)
353 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
354 struct nilfs_cpstat cpstat;
357 down_read(&nilfs->ns_segctor_sem);
358 ret = nilfs_cpfile_get_stat(nilfs->ns_cpfile, &cpstat);
359 up_read(&nilfs->ns_segctor_sem);
363 if (copy_to_user(argp, &cpstat, sizeof(cpstat)))
369 * nilfs_ioctl_do_get_suinfo - callback method getting segment usage info
370 * @nilfs: nilfs object
371 * @posp: pointer on array of segment numbers
373 * @buf: buffer for storing suinfo array
374 * @size: size in bytes of one suinfo item in array
375 * @nmembs: count of segment numbers and suinfos in array
377 * Description: nilfs_ioctl_do_get_suinfo() function returns segment usage
378 * info about requested segments. The NILFS_IOCTL_GET_SUINFO ioctl is used
379 * in lssu, nilfs_resize utilities and by nilfs_cleanerd daemon.
381 * Return value: count of nilfs_suinfo structures in output buffer.
384 nilfs_ioctl_do_get_suinfo(struct the_nilfs *nilfs, __u64 *posp, int flags,
385 void *buf, size_t size, size_t nmembs)
389 down_read(&nilfs->ns_segctor_sem);
390 ret = nilfs_sufile_get_suinfo(nilfs->ns_sufile, *posp, buf, size,
392 up_read(&nilfs->ns_segctor_sem);
397 * nilfs_ioctl_get_sustat - get segment usage statistics
398 * @inode: inode object
400 * @cmd: ioctl's request code
401 * @argp: pointer on argument from userspace
403 * Description: nilfs_ioctl_get_sustat() returns segment usage statistics.
404 * The NILFS_IOCTL_GET_SUSTAT ioctl is used in lssu, nilfs_resize utilities
405 * and by nilfs_cleanerd daemon.
407 * Return Value: On success, 0 is returned, and segment usage information is
408 * copied into userspace pointer @argp. On error, one of the following
409 * negative error codes is returned.
413 * %-ENOMEM - Insufficient amount of memory available.
415 * %-EFAULT - Failure during getting segment usage statistics.
417 static int nilfs_ioctl_get_sustat(struct inode *inode, struct file *filp,
418 unsigned int cmd, void __user *argp)
420 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
421 struct nilfs_sustat sustat;
424 down_read(&nilfs->ns_segctor_sem);
425 ret = nilfs_sufile_get_stat(nilfs->ns_sufile, &sustat);
426 up_read(&nilfs->ns_segctor_sem);
430 if (copy_to_user(argp, &sustat, sizeof(sustat)))
436 * nilfs_ioctl_do_get_vinfo - callback method getting virtual blocks info
437 * @nilfs: nilfs object
440 * @buf: buffer for storing array of nilfs_vinfo structures
441 * @size: size in bytes of one vinfo item in array
442 * @nmembs: count of vinfos in array
444 * Description: nilfs_ioctl_do_get_vinfo() function returns information
445 * on virtual block addresses. The NILFS_IOCTL_GET_VINFO ioctl is used
446 * by nilfs_cleanerd daemon.
448 * Return value: count of nilfs_vinfo structures in output buffer.
451 nilfs_ioctl_do_get_vinfo(struct the_nilfs *nilfs, __u64 *posp, int flags,
452 void *buf, size_t size, size_t nmembs)
456 down_read(&nilfs->ns_segctor_sem);
457 ret = nilfs_dat_get_vinfo(nilfs->ns_dat, buf, size, nmembs);
458 up_read(&nilfs->ns_segctor_sem);
463 * nilfs_ioctl_do_get_bdescs - callback method getting disk block descriptors
464 * @nilfs: nilfs object
467 * @buf: buffer for storing array of nilfs_bdesc structures
468 * @size: size in bytes of one bdesc item in array
469 * @nmembs: count of bdescs in array
471 * Description: nilfs_ioctl_do_get_bdescs() function returns information
472 * about descriptors of disk block numbers. The NILFS_IOCTL_GET_BDESCS ioctl
473 * is used by nilfs_cleanerd daemon.
475 * Return value: count of nilfs_bdescs structures in output buffer.
478 nilfs_ioctl_do_get_bdescs(struct the_nilfs *nilfs, __u64 *posp, int flags,
479 void *buf, size_t size, size_t nmembs)
481 struct nilfs_bmap *bmap = NILFS_I(nilfs->ns_dat)->i_bmap;
482 struct nilfs_bdesc *bdescs = buf;
485 down_read(&nilfs->ns_segctor_sem);
486 for (i = 0; i < nmembs; i++) {
487 ret = nilfs_bmap_lookup_at_level(bmap,
489 bdescs[i].bd_level + 1,
490 &bdescs[i].bd_blocknr);
492 if (ret != -ENOENT) {
493 up_read(&nilfs->ns_segctor_sem);
496 bdescs[i].bd_blocknr = 0;
499 up_read(&nilfs->ns_segctor_sem);
504 * nilfs_ioctl_get_bdescs - get disk block descriptors
505 * @inode: inode object
507 * @cmd: ioctl's request code
508 * @argp: pointer on argument from userspace
510 * Description: nilfs_ioctl_do_get_bdescs() function returns information
511 * about descriptors of disk block numbers. The NILFS_IOCTL_GET_BDESCS ioctl
512 * is used by nilfs_cleanerd daemon.
514 * Return Value: On success, 0 is returned, and disk block descriptors are
515 * copied into userspace pointer @argp. On error, one of the following
516 * negative error codes is returned.
518 * %-EINVAL - Invalid arguments from userspace.
522 * %-ENOMEM - Insufficient amount of memory available.
524 * %-EFAULT - Failure during getting disk block descriptors.
526 static int nilfs_ioctl_get_bdescs(struct inode *inode, struct file *filp,
527 unsigned int cmd, void __user *argp)
529 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
530 struct nilfs_argv argv;
533 if (copy_from_user(&argv, argp, sizeof(argv)))
536 if (argv.v_size != sizeof(struct nilfs_bdesc))
539 ret = nilfs_ioctl_wrap_copy(nilfs, &argv, _IOC_DIR(cmd),
540 nilfs_ioctl_do_get_bdescs);
544 if (copy_to_user(argp, &argv, sizeof(argv)))
550 * nilfs_ioctl_move_inode_block - prepare data/node block for moving by GC
551 * @inode: inode object
552 * @vdesc: descriptor of virtual block number
553 * @buffers: list of moving buffers
555 * Description: nilfs_ioctl_move_inode_block() function registers data/node
556 * buffer in the GC pagecache and submit read request.
558 * Return Value: On success, 0 is returned. On error, one of the following
559 * negative error codes is returned.
563 * %-ENOMEM - Insufficient amount of memory available.
565 * %-ENOENT - Requested block doesn't exist.
567 * %-EEXIST - Blocks conflict is detected.
569 static int nilfs_ioctl_move_inode_block(struct inode *inode,
570 struct nilfs_vdesc *vdesc,
571 struct list_head *buffers)
573 struct buffer_head *bh;
576 if (vdesc->vd_flags == 0)
577 ret = nilfs_gccache_submit_read_data(
578 inode, vdesc->vd_offset, vdesc->vd_blocknr,
579 vdesc->vd_vblocknr, &bh);
581 ret = nilfs_gccache_submit_read_node(
582 inode, vdesc->vd_blocknr, vdesc->vd_vblocknr, &bh);
584 if (unlikely(ret < 0)) {
586 nilfs_msg(inode->i_sb, KERN_CRIT,
587 "%s: invalid virtual block address (%s): ino=%llu, cno=%llu, offset=%llu, blocknr=%llu, vblocknr=%llu",
588 __func__, vdesc->vd_flags ? "node" : "data",
589 (unsigned long long)vdesc->vd_ino,
590 (unsigned long long)vdesc->vd_cno,
591 (unsigned long long)vdesc->vd_offset,
592 (unsigned long long)vdesc->vd_blocknr,
593 (unsigned long long)vdesc->vd_vblocknr);
596 if (unlikely(!list_empty(&bh->b_assoc_buffers))) {
597 nilfs_msg(inode->i_sb, KERN_CRIT,
598 "%s: conflicting %s buffer: ino=%llu, cno=%llu, offset=%llu, blocknr=%llu, vblocknr=%llu",
599 __func__, vdesc->vd_flags ? "node" : "data",
600 (unsigned long long)vdesc->vd_ino,
601 (unsigned long long)vdesc->vd_cno,
602 (unsigned long long)vdesc->vd_offset,
603 (unsigned long long)vdesc->vd_blocknr,
604 (unsigned long long)vdesc->vd_vblocknr);
608 list_add_tail(&bh->b_assoc_buffers, buffers);
613 * nilfs_ioctl_move_blocks - move valid inode's blocks during garbage collection
614 * @sb: superblock object
615 * @argv: vector of arguments from userspace
616 * @buf: array of nilfs_vdesc structures
618 * Description: nilfs_ioctl_move_blocks() function reads valid data/node
619 * blocks that garbage collector specified with the array of nilfs_vdesc
620 * structures and stores them into page caches of GC inodes.
622 * Return Value: Number of processed nilfs_vdesc structures or
623 * error code, otherwise.
625 static int nilfs_ioctl_move_blocks(struct super_block *sb,
626 struct nilfs_argv *argv, void *buf)
628 size_t nmembs = argv->v_nmembs;
629 struct the_nilfs *nilfs = sb->s_fs_info;
631 struct nilfs_vdesc *vdesc;
632 struct buffer_head *bh, *n;
638 for (i = 0, vdesc = buf; i < nmembs; ) {
641 inode = nilfs_iget_for_gc(sb, ino, cno);
643 ret = PTR_ERR(inode);
646 if (list_empty(&NILFS_I(inode)->i_dirty)) {
648 * Add the inode to GC inode list. Garbage Collection
649 * is serialized and no two processes manipulate the
650 * list simultaneously.
653 list_add(&NILFS_I(inode)->i_dirty,
654 &nilfs->ns_gc_inodes);
658 ret = nilfs_ioctl_move_inode_block(inode, vdesc,
660 if (unlikely(ret < 0)) {
665 } while (++i < nmembs &&
666 vdesc->vd_ino == ino && vdesc->vd_cno == cno);
668 iput(inode); /* The inode still remains in GC inode list */
671 list_for_each_entry_safe(bh, n, &buffers, b_assoc_buffers) {
672 ret = nilfs_gccache_wait_and_mark_dirty(bh);
673 if (unlikely(ret < 0)) {
674 WARN_ON(ret == -EEXIST);
677 list_del_init(&bh->b_assoc_buffers);
683 list_for_each_entry_safe(bh, n, &buffers, b_assoc_buffers) {
684 list_del_init(&bh->b_assoc_buffers);
691 * nilfs_ioctl_delete_checkpoints - delete checkpoints
692 * @nilfs: nilfs object
693 * @argv: vector of arguments from userspace
694 * @buf: array of periods of checkpoints numbers
696 * Description: nilfs_ioctl_delete_checkpoints() function deletes checkpoints
697 * in the period from p_start to p_end, excluding p_end itself. The checkpoints
698 * which have been already deleted are ignored.
700 * Return Value: Number of processed nilfs_period structures or
701 * error code, otherwise.
705 * %-ENOMEM - Insufficient amount of memory available.
707 * %-EINVAL - invalid checkpoints.
709 static int nilfs_ioctl_delete_checkpoints(struct the_nilfs *nilfs,
710 struct nilfs_argv *argv, void *buf)
712 size_t nmembs = argv->v_nmembs;
713 struct inode *cpfile = nilfs->ns_cpfile;
714 struct nilfs_period *periods = buf;
717 for (i = 0; i < nmembs; i++) {
718 ret = nilfs_cpfile_delete_checkpoints(
719 cpfile, periods[i].p_start, periods[i].p_end);
727 * nilfs_ioctl_free_vblocknrs - free virtual block numbers
728 * @nilfs: nilfs object
729 * @argv: vector of arguments from userspace
730 * @buf: array of virtual block numbers
732 * Description: nilfs_ioctl_free_vblocknrs() function frees
733 * the virtual block numbers specified by @buf and @argv->v_nmembs.
735 * Return Value: Number of processed virtual block numbers or
736 * error code, otherwise.
740 * %-ENOMEM - Insufficient amount of memory available.
742 * %-ENOENT - The virtual block number have not been allocated.
744 static int nilfs_ioctl_free_vblocknrs(struct the_nilfs *nilfs,
745 struct nilfs_argv *argv, void *buf)
747 size_t nmembs = argv->v_nmembs;
750 ret = nilfs_dat_freev(nilfs->ns_dat, buf, nmembs);
752 return (ret < 0) ? ret : nmembs;
756 * nilfs_ioctl_mark_blocks_dirty - mark blocks dirty
757 * @nilfs: nilfs object
758 * @argv: vector of arguments from userspace
759 * @buf: array of block descriptors
761 * Description: nilfs_ioctl_mark_blocks_dirty() function marks
762 * metadata file or data blocks as dirty.
764 * Return Value: Number of processed block descriptors or
765 * error code, otherwise.
767 * %-ENOMEM - Insufficient memory available.
771 * %-ENOENT - the specified block does not exist (hole block)
773 static int nilfs_ioctl_mark_blocks_dirty(struct the_nilfs *nilfs,
774 struct nilfs_argv *argv, void *buf)
776 size_t nmembs = argv->v_nmembs;
777 struct nilfs_bmap *bmap = NILFS_I(nilfs->ns_dat)->i_bmap;
778 struct nilfs_bdesc *bdescs = buf;
779 struct buffer_head *bh;
782 for (i = 0; i < nmembs; i++) {
783 /* XXX: use macro or inline func to check liveness */
784 ret = nilfs_bmap_lookup_at_level(bmap,
786 bdescs[i].bd_level + 1,
787 &bdescs[i].bd_blocknr);
791 bdescs[i].bd_blocknr = 0;
793 if (bdescs[i].bd_blocknr != bdescs[i].bd_oblocknr)
794 /* skip dead block */
796 if (bdescs[i].bd_level == 0) {
797 ret = nilfs_mdt_get_block(nilfs->ns_dat,
801 WARN_ON(ret == -ENOENT);
804 mark_buffer_dirty(bh);
805 nilfs_mdt_mark_dirty(nilfs->ns_dat);
808 ret = nilfs_bmap_mark(bmap, bdescs[i].bd_offset,
811 WARN_ON(ret == -ENOENT);
819 int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *nilfs,
820 struct nilfs_argv *argv, void **kbufs)
825 ret = nilfs_ioctl_delete_checkpoints(nilfs, &argv[1], kbufs[1]);
828 * can safely abort because checkpoints can be removed
831 msg = "cannot delete checkpoints";
834 ret = nilfs_ioctl_free_vblocknrs(nilfs, &argv[2], kbufs[2]);
837 * can safely abort because DAT file is updated atomically
838 * using a copy-on-write technique.
840 msg = "cannot delete virtual blocks from DAT file";
843 ret = nilfs_ioctl_mark_blocks_dirty(nilfs, &argv[3], kbufs[3]);
846 * can safely abort because the operation is nondestructive.
848 msg = "cannot mark copying blocks dirty";
854 nilfs_msg(nilfs->ns_sb, KERN_ERR, "error %d preparing GC: %s", ret,
860 * nilfs_ioctl_clean_segments - clean segments
861 * @inode: inode object
863 * @cmd: ioctl's request code
864 * @argp: pointer on argument from userspace
866 * Description: nilfs_ioctl_clean_segments() function makes garbage
867 * collection operation in the environment of requested parameters
868 * from userspace. The NILFS_IOCTL_CLEAN_SEGMENTS ioctl is used by
869 * nilfs_cleanerd daemon.
871 * Return Value: On success, 0 is returned or error code, otherwise.
873 static int nilfs_ioctl_clean_segments(struct inode *inode, struct file *filp,
874 unsigned int cmd, void __user *argp)
876 struct nilfs_argv argv[5];
877 static const size_t argsz[5] = {
878 sizeof(struct nilfs_vdesc),
879 sizeof(struct nilfs_period),
881 sizeof(struct nilfs_bdesc),
886 struct the_nilfs *nilfs;
890 if (!capable(CAP_SYS_ADMIN))
893 ret = mnt_want_write_file(filp);
898 if (copy_from_user(argv, argp, sizeof(argv)))
902 nsegs = argv[4].v_nmembs;
903 if (argv[4].v_size != argsz[4])
905 if (nsegs > UINT_MAX / sizeof(__u64))
909 * argv[4] points to segment numbers this ioctl cleans. We
910 * use kmalloc() for its buffer because memory used for the
911 * segment numbers is enough small.
913 kbufs[4] = memdup_user((void __user *)(unsigned long)argv[4].v_base,
914 nsegs * sizeof(__u64));
915 if (IS_ERR(kbufs[4])) {
916 ret = PTR_ERR(kbufs[4]);
919 nilfs = inode->i_sb->s_fs_info;
921 for (n = 0; n < 4; n++) {
923 if (argv[n].v_size != argsz[n])
926 if (argv[n].v_nmembs > nsegs * nilfs->ns_blocks_per_segment)
929 if (argv[n].v_nmembs >= UINT_MAX / argv[n].v_size)
932 len = argv[n].v_size * argv[n].v_nmembs;
933 base = (void __user *)(unsigned long)argv[n].v_base;
939 kbufs[n] = vmalloc(len);
944 if (copy_from_user(kbufs[n], base, len)) {
952 * nilfs_ioctl_move_blocks() will call nilfs_iget_for_gc(),
953 * which will operates an inode list without blocking.
954 * To protect the list from concurrent operations,
955 * nilfs_ioctl_move_blocks should be atomic operation.
957 if (test_and_set_bit(THE_NILFS_GC_RUNNING, &nilfs->ns_flags)) {
962 ret = nilfs_ioctl_move_blocks(inode->i_sb, &argv[0], kbufs[0]);
964 nilfs_msg(inode->i_sb, KERN_ERR,
965 "error %d preparing GC: cannot read source blocks",
968 if (nilfs_sb_need_update(nilfs))
969 set_nilfs_discontinued(nilfs);
970 ret = nilfs_clean_segments(inode->i_sb, argv, kbufs);
973 nilfs_remove_all_gcinodes(nilfs);
974 clear_nilfs_gc_running(nilfs);
981 mnt_drop_write_file(filp);
986 * nilfs_ioctl_sync - make a checkpoint
987 * @inode: inode object
989 * @cmd: ioctl's request code
990 * @argp: pointer on argument from userspace
992 * Description: nilfs_ioctl_sync() function constructs a logical segment
993 * for checkpointing. This function guarantees that all modified data
994 * and metadata are written out to the device when it successfully
997 * Return Value: On success, 0 is retured. On errors, one of the following
998 * negative error code is returned.
1000 * %-EROFS - Read only filesystem.
1004 * %-ENOSPC - No space left on device (only in a panic state).
1006 * %-ERESTARTSYS - Interrupted.
1008 * %-ENOMEM - Insufficient memory available.
1010 * %-EFAULT - Failure during execution of requested operation.
1012 static int nilfs_ioctl_sync(struct inode *inode, struct file *filp,
1013 unsigned int cmd, void __user *argp)
1017 struct the_nilfs *nilfs;
1019 ret = nilfs_construct_segment(inode->i_sb);
1023 nilfs = inode->i_sb->s_fs_info;
1024 ret = nilfs_flush_device(nilfs);
1029 down_read(&nilfs->ns_segctor_sem);
1030 cno = nilfs->ns_cno - 1;
1031 up_read(&nilfs->ns_segctor_sem);
1032 if (copy_to_user(argp, &cno, sizeof(cno)))
1039 * nilfs_ioctl_resize - resize NILFS2 volume
1040 * @inode: inode object
1041 * @filp: file object
1042 * @argp: pointer on argument from userspace
1044 * Return Value: On success, 0 is returned or error code, otherwise.
1046 static int nilfs_ioctl_resize(struct inode *inode, struct file *filp,
1052 if (!capable(CAP_SYS_ADMIN))
1055 ret = mnt_want_write_file(filp);
1060 if (copy_from_user(&newsize, argp, sizeof(newsize)))
1061 goto out_drop_write;
1063 ret = nilfs_resize_fs(inode->i_sb, newsize);
1066 mnt_drop_write_file(filp);
1072 * nilfs_ioctl_trim_fs() - trim ioctl handle function
1073 * @inode: inode object
1074 * @argp: pointer on argument from userspace
1076 * Decription: nilfs_ioctl_trim_fs is the FITRIM ioctl handle function. It
1077 * checks the arguments from userspace and calls nilfs_sufile_trim_fs, which
1078 * performs the actual trim operation.
1080 * Return Value: On success, 0 is returned or negative error code, otherwise.
1082 static int nilfs_ioctl_trim_fs(struct inode *inode, void __user *argp)
1084 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
1085 struct request_queue *q = bdev_get_queue(nilfs->ns_bdev);
1086 struct fstrim_range range;
1089 if (!capable(CAP_SYS_ADMIN))
1092 if (!blk_queue_discard(q))
1095 if (copy_from_user(&range, argp, sizeof(range)))
1098 range.minlen = max_t(u64, range.minlen, q->limits.discard_granularity);
1100 down_read(&nilfs->ns_segctor_sem);
1101 ret = nilfs_sufile_trim_fs(nilfs->ns_sufile, &range);
1102 up_read(&nilfs->ns_segctor_sem);
1107 if (copy_to_user(argp, &range, sizeof(range)))
1114 * nilfs_ioctl_set_alloc_range - limit range of segments to be allocated
1115 * @inode: inode object
1116 * @argp: pointer on argument from userspace
1118 * Decription: nilfs_ioctl_set_alloc_range() function defines lower limit
1119 * of segments in bytes and upper limit of segments in bytes.
1120 * The NILFS_IOCTL_SET_ALLOC_RANGE is used by nilfs_resize utility.
1122 * Return Value: On success, 0 is returned or error code, otherwise.
1124 static int nilfs_ioctl_set_alloc_range(struct inode *inode, void __user *argp)
1126 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
1128 __u64 minseg, maxseg;
1129 unsigned long segbytes;
1132 if (!capable(CAP_SYS_ADMIN))
1136 if (copy_from_user(range, argp, sizeof(__u64[2])))
1140 if (range[1] > i_size_read(inode->i_sb->s_bdev->bd_inode))
1143 segbytes = nilfs->ns_blocks_per_segment * nilfs->ns_blocksize;
1145 minseg = range[0] + segbytes - 1;
1146 do_div(minseg, segbytes);
1147 maxseg = NILFS_SB2_OFFSET_BYTES(range[1]);
1148 do_div(maxseg, segbytes);
1151 ret = nilfs_sufile_set_alloc_range(nilfs->ns_sufile, minseg, maxseg);
1157 * nilfs_ioctl_get_info - wrapping function of get metadata info
1158 * @inode: inode object
1159 * @filp: file object
1160 * @cmd: ioctl's request code
1161 * @argp: pointer on argument from userspace
1162 * @membsz: size of an item in bytes
1163 * @dofunc: concrete function of getting metadata info
1165 * Description: nilfs_ioctl_get_info() gets metadata info by means of
1166 * calling dofunc() function.
1168 * Return Value: On success, 0 is returned and requested metadata info
1169 * is copied into userspace. On error, one of the following
1170 * negative error codes is returned.
1172 * %-EINVAL - Invalid arguments from userspace.
1174 * %-ENOMEM - Insufficient amount of memory available.
1176 * %-EFAULT - Failure during execution of requested operation.
1178 static int nilfs_ioctl_get_info(struct inode *inode, struct file *filp,
1179 unsigned int cmd, void __user *argp,
1181 ssize_t (*dofunc)(struct the_nilfs *,
1183 void *, size_t, size_t))
1186 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
1187 struct nilfs_argv argv;
1190 if (copy_from_user(&argv, argp, sizeof(argv)))
1193 if (argv.v_size < membsz)
1196 ret = nilfs_ioctl_wrap_copy(nilfs, &argv, _IOC_DIR(cmd), dofunc);
1200 if (copy_to_user(argp, &argv, sizeof(argv)))
1206 * nilfs_ioctl_set_suinfo - set segment usage info
1207 * @inode: inode object
1208 * @filp: file object
1209 * @cmd: ioctl's request code
1210 * @argp: pointer on argument from userspace
1212 * Description: Expects an array of nilfs_suinfo_update structures
1213 * encapsulated in nilfs_argv and updates the segment usage info
1214 * according to the flags in nilfs_suinfo_update.
1216 * Return Value: On success, 0 is returned. On error, one of the
1217 * following negative error codes is returned.
1219 * %-EPERM - Not enough permissions
1221 * %-EFAULT - Error copying input data
1223 * %-EIO - I/O error.
1225 * %-ENOMEM - Insufficient amount of memory available.
1227 * %-EINVAL - Invalid values in input (segment number, flags or nblocks)
1229 static int nilfs_ioctl_set_suinfo(struct inode *inode, struct file *filp,
1230 unsigned int cmd, void __user *argp)
1232 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
1233 struct nilfs_transaction_info ti;
1234 struct nilfs_argv argv;
1240 if (!capable(CAP_SYS_ADMIN))
1243 ret = mnt_want_write_file(filp);
1248 if (copy_from_user(&argv, argp, sizeof(argv)))
1252 if (argv.v_size < sizeof(struct nilfs_suinfo_update))
1255 if (argv.v_nmembs > nilfs->ns_nsegments)
1258 if (argv.v_nmembs >= UINT_MAX / argv.v_size)
1261 len = argv.v_size * argv.v_nmembs;
1267 base = (void __user *)(unsigned long)argv.v_base;
1268 kbuf = vmalloc(len);
1274 if (copy_from_user(kbuf, base, len)) {
1279 nilfs_transaction_begin(inode->i_sb, &ti, 0);
1280 ret = nilfs_sufile_set_suinfo(nilfs->ns_sufile, kbuf, argv.v_size,
1282 if (unlikely(ret < 0))
1283 nilfs_transaction_abort(inode->i_sb);
1285 nilfs_transaction_commit(inode->i_sb); /* never fails */
1290 mnt_drop_write_file(filp);
1294 long nilfs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
1296 struct inode *inode = file_inode(filp);
1297 void __user *argp = (void __user *)arg;
1300 case FS_IOC_GETFLAGS:
1301 return nilfs_ioctl_getflags(inode, argp);
1302 case FS_IOC_SETFLAGS:
1303 return nilfs_ioctl_setflags(inode, filp, argp);
1304 case FS_IOC_GETVERSION:
1305 return nilfs_ioctl_getversion(inode, argp);
1306 case NILFS_IOCTL_CHANGE_CPMODE:
1307 return nilfs_ioctl_change_cpmode(inode, filp, cmd, argp);
1308 case NILFS_IOCTL_DELETE_CHECKPOINT:
1309 return nilfs_ioctl_delete_checkpoint(inode, filp, cmd, argp);
1310 case NILFS_IOCTL_GET_CPINFO:
1311 return nilfs_ioctl_get_info(inode, filp, cmd, argp,
1312 sizeof(struct nilfs_cpinfo),
1313 nilfs_ioctl_do_get_cpinfo);
1314 case NILFS_IOCTL_GET_CPSTAT:
1315 return nilfs_ioctl_get_cpstat(inode, filp, cmd, argp);
1316 case NILFS_IOCTL_GET_SUINFO:
1317 return nilfs_ioctl_get_info(inode, filp, cmd, argp,
1318 sizeof(struct nilfs_suinfo),
1319 nilfs_ioctl_do_get_suinfo);
1320 case NILFS_IOCTL_SET_SUINFO:
1321 return nilfs_ioctl_set_suinfo(inode, filp, cmd, argp);
1322 case NILFS_IOCTL_GET_SUSTAT:
1323 return nilfs_ioctl_get_sustat(inode, filp, cmd, argp);
1324 case NILFS_IOCTL_GET_VINFO:
1325 return nilfs_ioctl_get_info(inode, filp, cmd, argp,
1326 sizeof(struct nilfs_vinfo),
1327 nilfs_ioctl_do_get_vinfo);
1328 case NILFS_IOCTL_GET_BDESCS:
1329 return nilfs_ioctl_get_bdescs(inode, filp, cmd, argp);
1330 case NILFS_IOCTL_CLEAN_SEGMENTS:
1331 return nilfs_ioctl_clean_segments(inode, filp, cmd, argp);
1332 case NILFS_IOCTL_SYNC:
1333 return nilfs_ioctl_sync(inode, filp, cmd, argp);
1334 case NILFS_IOCTL_RESIZE:
1335 return nilfs_ioctl_resize(inode, filp, argp);
1336 case NILFS_IOCTL_SET_ALLOC_RANGE:
1337 return nilfs_ioctl_set_alloc_range(inode, argp);
1339 return nilfs_ioctl_trim_fs(inode, argp);
1345 #ifdef CONFIG_COMPAT
1346 long nilfs_compat_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
1349 case FS_IOC32_GETFLAGS:
1350 cmd = FS_IOC_GETFLAGS;
1352 case FS_IOC32_SETFLAGS:
1353 cmd = FS_IOC_SETFLAGS;
1355 case FS_IOC32_GETVERSION:
1356 cmd = FS_IOC_GETVERSION;
1358 case NILFS_IOCTL_CHANGE_CPMODE:
1359 case NILFS_IOCTL_DELETE_CHECKPOINT:
1360 case NILFS_IOCTL_GET_CPINFO:
1361 case NILFS_IOCTL_GET_CPSTAT:
1362 case NILFS_IOCTL_GET_SUINFO:
1363 case NILFS_IOCTL_SET_SUINFO:
1364 case NILFS_IOCTL_GET_SUSTAT:
1365 case NILFS_IOCTL_GET_VINFO:
1366 case NILFS_IOCTL_GET_BDESCS:
1367 case NILFS_IOCTL_CLEAN_SEGMENTS:
1368 case NILFS_IOCTL_SYNC:
1369 case NILFS_IOCTL_RESIZE:
1370 case NILFS_IOCTL_SET_ALLOC_RANGE:
1373 return -ENOIOCTLCMD;
1375 return nilfs_ioctl(filp, cmd, (unsigned long)compat_ptr(arg));