1 // SPDX-License-Identifier: GPL-2.0+
3 * ioctl.c - NILFS ioctl operations.
5 * Copyright (C) 2007, 2008 Nippon Telegraph and Telephone Corporation.
7 * Written by Koji Sato.
11 #include <linux/wait.h>
12 #include <linux/slab.h>
13 #include <linux/capability.h> /* capable() */
14 #include <linux/uaccess.h> /* copy_from_user(), copy_to_user() */
15 #include <linux/vmalloc.h>
16 #include <linux/compat.h> /* compat_ptr() */
17 #include <linux/mount.h> /* mnt_want_write_file(), mnt_drop_write_file() */
18 #include <linux/buffer_head.h>
27 * nilfs_ioctl_wrap_copy - wrapping function of get/set metadata info
28 * @nilfs: nilfs object
29 * @argv: vector of arguments from userspace
30 * @dir: set of direction flags
31 * @dofunc: concrete function of get/set metadata info
33 * Description: nilfs_ioctl_wrap_copy() gets/sets metadata info by means of
34 * calling dofunc() function on the basis of @argv argument.
36 * Return Value: On success, 0 is returned and requested metadata info
37 * is copied into userspace. On error, one of the following
38 * negative error codes is returned.
40 * %-EINVAL - Invalid arguments from userspace.
42 * %-ENOMEM - Insufficient amount of memory available.
44 * %-EFAULT - Failure during execution of requested operation.
46 static int nilfs_ioctl_wrap_copy(struct the_nilfs *nilfs,
47 struct nilfs_argv *argv, int dir,
48 ssize_t (*dofunc)(struct the_nilfs *,
50 void *, size_t, size_t))
53 void __user *base = (void __user *)(unsigned long)argv->v_base;
54 size_t maxmembs, total, n;
59 if (argv->v_nmembs == 0)
62 if (argv->v_size > PAGE_SIZE)
66 * Reject pairs of a start item position (argv->v_index) and a
67 * total count (argv->v_nmembs) which leads position 'pos' to
68 * overflow by the increment at the end of the loop.
70 if (argv->v_index > ~(__u64)0 - argv->v_nmembs)
73 buf = (void *)__get_free_pages(GFP_NOFS, 0);
76 maxmembs = PAGE_SIZE / argv->v_size;
81 for (i = 0; i < argv->v_nmembs; i += n) {
82 n = (argv->v_nmembs - i < maxmembs) ?
83 argv->v_nmembs - i : maxmembs;
84 if ((dir & _IOC_WRITE) &&
85 copy_from_user(buf, base + argv->v_size * i,
91 nr = dofunc(nilfs, &pos, argv->v_flags, buf, argv->v_size,
97 if ((dir & _IOC_READ) &&
98 copy_to_user(base + argv->v_size * i, buf,
109 argv->v_nmembs = total;
111 free_pages((unsigned long)buf, 0);
116 * nilfs_ioctl_getflags - ioctl to support lsattr
118 static int nilfs_ioctl_getflags(struct inode *inode, void __user *argp)
120 unsigned int flags = NILFS_I(inode)->i_flags & FS_FL_USER_VISIBLE;
122 return put_user(flags, (int __user *)argp);
126 * nilfs_ioctl_setflags - ioctl to support chattr
128 static int nilfs_ioctl_setflags(struct inode *inode, struct file *filp,
131 struct nilfs_transaction_info ti;
132 unsigned int flags, oldflags;
135 if (!inode_owner_or_capable(inode))
138 if (get_user(flags, (int __user *)argp))
141 ret = mnt_want_write_file(filp);
145 flags = nilfs_mask_flags(inode->i_mode, flags);
149 oldflags = NILFS_I(inode)->i_flags;
152 * The IMMUTABLE and APPEND_ONLY flags can only be changed by the
153 * relevant capability.
156 if (((flags ^ oldflags) & (FS_APPEND_FL | FS_IMMUTABLE_FL)) &&
157 !capable(CAP_LINUX_IMMUTABLE))
160 ret = nilfs_transaction_begin(inode->i_sb, &ti, 0);
164 NILFS_I(inode)->i_flags = (oldflags & ~FS_FL_USER_MODIFIABLE) |
165 (flags & FS_FL_USER_MODIFIABLE);
167 nilfs_set_inode_flags(inode);
168 inode->i_ctime = current_time(inode);
170 nilfs_set_transaction_flag(NILFS_TI_SYNC);
172 nilfs_mark_inode_dirty(inode);
173 ret = nilfs_transaction_commit(inode->i_sb);
176 mnt_drop_write_file(filp);
181 * nilfs_ioctl_getversion - get info about a file's version (generation number)
183 static int nilfs_ioctl_getversion(struct inode *inode, void __user *argp)
185 return put_user(inode->i_generation, (int __user *)argp);
189 * nilfs_ioctl_change_cpmode - change checkpoint mode (checkpoint/snapshot)
190 * @inode: inode object
192 * @cmd: ioctl's request code
193 * @argp: pointer on argument from userspace
195 * Description: nilfs_ioctl_change_cpmode() function changes mode of
196 * given checkpoint between checkpoint and snapshot state. This ioctl
197 * is used in chcp and mkcp utilities.
199 * Return Value: On success, 0 is returned and mode of a checkpoint is
200 * changed. On error, one of the following negative error codes
203 * %-EPERM - Operation not permitted.
205 * %-EFAULT - Failure during checkpoint mode changing.
207 static int nilfs_ioctl_change_cpmode(struct inode *inode, struct file *filp,
208 unsigned int cmd, void __user *argp)
210 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
211 struct nilfs_transaction_info ti;
212 struct nilfs_cpmode cpmode;
215 if (!capable(CAP_SYS_ADMIN))
218 ret = mnt_want_write_file(filp);
223 if (copy_from_user(&cpmode, argp, sizeof(cpmode)))
226 mutex_lock(&nilfs->ns_snapshot_mount_mutex);
228 nilfs_transaction_begin(inode->i_sb, &ti, 0);
229 ret = nilfs_cpfile_change_cpmode(
230 nilfs->ns_cpfile, cpmode.cm_cno, cpmode.cm_mode);
231 if (unlikely(ret < 0))
232 nilfs_transaction_abort(inode->i_sb);
234 nilfs_transaction_commit(inode->i_sb); /* never fails */
236 mutex_unlock(&nilfs->ns_snapshot_mount_mutex);
238 mnt_drop_write_file(filp);
243 * nilfs_ioctl_delete_checkpoint - remove checkpoint
244 * @inode: inode object
246 * @cmd: ioctl's request code
247 * @argp: pointer on argument from userspace
249 * Description: nilfs_ioctl_delete_checkpoint() function removes
250 * checkpoint from NILFS2 file system. This ioctl is used in rmcp
253 * Return Value: On success, 0 is returned and a checkpoint is
254 * removed. On error, one of the following negative error codes
257 * %-EPERM - Operation not permitted.
259 * %-EFAULT - Failure during checkpoint removing.
262 nilfs_ioctl_delete_checkpoint(struct inode *inode, struct file *filp,
263 unsigned int cmd, void __user *argp)
265 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
266 struct nilfs_transaction_info ti;
270 if (!capable(CAP_SYS_ADMIN))
273 ret = mnt_want_write_file(filp);
278 if (copy_from_user(&cno, argp, sizeof(cno)))
281 nilfs_transaction_begin(inode->i_sb, &ti, 0);
282 ret = nilfs_cpfile_delete_checkpoint(nilfs->ns_cpfile, cno);
283 if (unlikely(ret < 0))
284 nilfs_transaction_abort(inode->i_sb);
286 nilfs_transaction_commit(inode->i_sb); /* never fails */
288 mnt_drop_write_file(filp);
293 * nilfs_ioctl_do_get_cpinfo - callback method getting info about checkpoints
294 * @nilfs: nilfs object
295 * @posp: pointer on array of checkpoint's numbers
296 * @flags: checkpoint mode (checkpoint or snapshot)
297 * @buf: buffer for storing checkponts' info
298 * @size: size in bytes of one checkpoint info item in array
299 * @nmembs: number of checkpoints in array (numbers and infos)
301 * Description: nilfs_ioctl_do_get_cpinfo() function returns info about
302 * requested checkpoints. The NILFS_IOCTL_GET_CPINFO ioctl is used in
303 * lscp utility and by nilfs_cleanerd daemon.
305 * Return value: count of nilfs_cpinfo structures in output buffer.
308 nilfs_ioctl_do_get_cpinfo(struct the_nilfs *nilfs, __u64 *posp, int flags,
309 void *buf, size_t size, size_t nmembs)
313 down_read(&nilfs->ns_segctor_sem);
314 ret = nilfs_cpfile_get_cpinfo(nilfs->ns_cpfile, posp, flags, buf,
316 up_read(&nilfs->ns_segctor_sem);
321 * nilfs_ioctl_get_cpstat - get checkpoints statistics
322 * @inode: inode object
324 * @cmd: ioctl's request code
325 * @argp: pointer on argument from userspace
327 * Description: nilfs_ioctl_get_cpstat() returns information about checkpoints.
328 * The NILFS_IOCTL_GET_CPSTAT ioctl is used by lscp, rmcp utilities
329 * and by nilfs_cleanerd daemon.
331 * Return Value: On success, 0 is returned, and checkpoints information is
332 * copied into userspace pointer @argp. On error, one of the following
333 * negative error codes is returned.
337 * %-ENOMEM - Insufficient amount of memory available.
339 * %-EFAULT - Failure during getting checkpoints statistics.
341 static int nilfs_ioctl_get_cpstat(struct inode *inode, struct file *filp,
342 unsigned int cmd, void __user *argp)
344 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
345 struct nilfs_cpstat cpstat;
348 down_read(&nilfs->ns_segctor_sem);
349 ret = nilfs_cpfile_get_stat(nilfs->ns_cpfile, &cpstat);
350 up_read(&nilfs->ns_segctor_sem);
354 if (copy_to_user(argp, &cpstat, sizeof(cpstat)))
360 * nilfs_ioctl_do_get_suinfo - callback method getting segment usage info
361 * @nilfs: nilfs object
362 * @posp: pointer on array of segment numbers
364 * @buf: buffer for storing suinfo array
365 * @size: size in bytes of one suinfo item in array
366 * @nmembs: count of segment numbers and suinfos in array
368 * Description: nilfs_ioctl_do_get_suinfo() function returns segment usage
369 * info about requested segments. The NILFS_IOCTL_GET_SUINFO ioctl is used
370 * in lssu, nilfs_resize utilities and by nilfs_cleanerd daemon.
372 * Return value: count of nilfs_suinfo structures in output buffer.
375 nilfs_ioctl_do_get_suinfo(struct the_nilfs *nilfs, __u64 *posp, int flags,
376 void *buf, size_t size, size_t nmembs)
380 down_read(&nilfs->ns_segctor_sem);
381 ret = nilfs_sufile_get_suinfo(nilfs->ns_sufile, *posp, buf, size,
383 up_read(&nilfs->ns_segctor_sem);
388 * nilfs_ioctl_get_sustat - get segment usage statistics
389 * @inode: inode object
391 * @cmd: ioctl's request code
392 * @argp: pointer on argument from userspace
394 * Description: nilfs_ioctl_get_sustat() returns segment usage statistics.
395 * The NILFS_IOCTL_GET_SUSTAT ioctl is used in lssu, nilfs_resize utilities
396 * and by nilfs_cleanerd daemon.
398 * Return Value: On success, 0 is returned, and segment usage information is
399 * copied into userspace pointer @argp. On error, one of the following
400 * negative error codes is returned.
404 * %-ENOMEM - Insufficient amount of memory available.
406 * %-EFAULT - Failure during getting segment usage statistics.
408 static int nilfs_ioctl_get_sustat(struct inode *inode, struct file *filp,
409 unsigned int cmd, void __user *argp)
411 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
412 struct nilfs_sustat sustat;
415 down_read(&nilfs->ns_segctor_sem);
416 ret = nilfs_sufile_get_stat(nilfs->ns_sufile, &sustat);
417 up_read(&nilfs->ns_segctor_sem);
421 if (copy_to_user(argp, &sustat, sizeof(sustat)))
427 * nilfs_ioctl_do_get_vinfo - callback method getting virtual blocks info
428 * @nilfs: nilfs object
431 * @buf: buffer for storing array of nilfs_vinfo structures
432 * @size: size in bytes of one vinfo item in array
433 * @nmembs: count of vinfos in array
435 * Description: nilfs_ioctl_do_get_vinfo() function returns information
436 * on virtual block addresses. The NILFS_IOCTL_GET_VINFO ioctl is used
437 * by nilfs_cleanerd daemon.
439 * Return value: count of nilfs_vinfo structures in output buffer.
442 nilfs_ioctl_do_get_vinfo(struct the_nilfs *nilfs, __u64 *posp, int flags,
443 void *buf, size_t size, size_t nmembs)
447 down_read(&nilfs->ns_segctor_sem);
448 ret = nilfs_dat_get_vinfo(nilfs->ns_dat, buf, size, nmembs);
449 up_read(&nilfs->ns_segctor_sem);
454 * nilfs_ioctl_do_get_bdescs - callback method getting disk block descriptors
455 * @nilfs: nilfs object
458 * @buf: buffer for storing array of nilfs_bdesc structures
459 * @size: size in bytes of one bdesc item in array
460 * @nmembs: count of bdescs in array
462 * Description: nilfs_ioctl_do_get_bdescs() function returns information
463 * about descriptors of disk block numbers. The NILFS_IOCTL_GET_BDESCS ioctl
464 * is used by nilfs_cleanerd daemon.
466 * Return value: count of nilfs_bdescs structures in output buffer.
469 nilfs_ioctl_do_get_bdescs(struct the_nilfs *nilfs, __u64 *posp, int flags,
470 void *buf, size_t size, size_t nmembs)
472 struct nilfs_bmap *bmap = NILFS_I(nilfs->ns_dat)->i_bmap;
473 struct nilfs_bdesc *bdescs = buf;
476 down_read(&nilfs->ns_segctor_sem);
477 for (i = 0; i < nmembs; i++) {
478 ret = nilfs_bmap_lookup_at_level(bmap,
480 bdescs[i].bd_level + 1,
481 &bdescs[i].bd_blocknr);
483 if (ret != -ENOENT) {
484 up_read(&nilfs->ns_segctor_sem);
487 bdescs[i].bd_blocknr = 0;
490 up_read(&nilfs->ns_segctor_sem);
495 * nilfs_ioctl_get_bdescs - get disk block descriptors
496 * @inode: inode object
498 * @cmd: ioctl's request code
499 * @argp: pointer on argument from userspace
501 * Description: nilfs_ioctl_do_get_bdescs() function returns information
502 * about descriptors of disk block numbers. The NILFS_IOCTL_GET_BDESCS ioctl
503 * is used by nilfs_cleanerd daemon.
505 * Return Value: On success, 0 is returned, and disk block descriptors are
506 * copied into userspace pointer @argp. On error, one of the following
507 * negative error codes is returned.
509 * %-EINVAL - Invalid arguments from userspace.
513 * %-ENOMEM - Insufficient amount of memory available.
515 * %-EFAULT - Failure during getting disk block descriptors.
517 static int nilfs_ioctl_get_bdescs(struct inode *inode, struct file *filp,
518 unsigned int cmd, void __user *argp)
520 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
521 struct nilfs_argv argv;
524 if (copy_from_user(&argv, argp, sizeof(argv)))
527 if (argv.v_size != sizeof(struct nilfs_bdesc))
530 ret = nilfs_ioctl_wrap_copy(nilfs, &argv, _IOC_DIR(cmd),
531 nilfs_ioctl_do_get_bdescs);
535 if (copy_to_user(argp, &argv, sizeof(argv)))
541 * nilfs_ioctl_move_inode_block - prepare data/node block for moving by GC
542 * @inode: inode object
543 * @vdesc: descriptor of virtual block number
544 * @buffers: list of moving buffers
546 * Description: nilfs_ioctl_move_inode_block() function registers data/node
547 * buffer in the GC pagecache and submit read request.
549 * Return Value: On success, 0 is returned. On error, one of the following
550 * negative error codes is returned.
554 * %-ENOMEM - Insufficient amount of memory available.
556 * %-ENOENT - Requested block doesn't exist.
558 * %-EEXIST - Blocks conflict is detected.
560 static int nilfs_ioctl_move_inode_block(struct inode *inode,
561 struct nilfs_vdesc *vdesc,
562 struct list_head *buffers)
564 struct buffer_head *bh;
567 if (vdesc->vd_flags == 0)
568 ret = nilfs_gccache_submit_read_data(
569 inode, vdesc->vd_offset, vdesc->vd_blocknr,
570 vdesc->vd_vblocknr, &bh);
572 ret = nilfs_gccache_submit_read_node(
573 inode, vdesc->vd_blocknr, vdesc->vd_vblocknr, &bh);
575 if (unlikely(ret < 0)) {
577 nilfs_msg(inode->i_sb, KERN_CRIT,
578 "%s: invalid virtual block address (%s): ino=%llu, cno=%llu, offset=%llu, blocknr=%llu, vblocknr=%llu",
579 __func__, vdesc->vd_flags ? "node" : "data",
580 (unsigned long long)vdesc->vd_ino,
581 (unsigned long long)vdesc->vd_cno,
582 (unsigned long long)vdesc->vd_offset,
583 (unsigned long long)vdesc->vd_blocknr,
584 (unsigned long long)vdesc->vd_vblocknr);
587 if (unlikely(!list_empty(&bh->b_assoc_buffers))) {
588 nilfs_msg(inode->i_sb, KERN_CRIT,
589 "%s: conflicting %s buffer: ino=%llu, cno=%llu, offset=%llu, blocknr=%llu, vblocknr=%llu",
590 __func__, vdesc->vd_flags ? "node" : "data",
591 (unsigned long long)vdesc->vd_ino,
592 (unsigned long long)vdesc->vd_cno,
593 (unsigned long long)vdesc->vd_offset,
594 (unsigned long long)vdesc->vd_blocknr,
595 (unsigned long long)vdesc->vd_vblocknr);
599 list_add_tail(&bh->b_assoc_buffers, buffers);
604 * nilfs_ioctl_move_blocks - move valid inode's blocks during garbage collection
605 * @sb: superblock object
606 * @argv: vector of arguments from userspace
607 * @buf: array of nilfs_vdesc structures
609 * Description: nilfs_ioctl_move_blocks() function reads valid data/node
610 * blocks that garbage collector specified with the array of nilfs_vdesc
611 * structures and stores them into page caches of GC inodes.
613 * Return Value: Number of processed nilfs_vdesc structures or
614 * error code, otherwise.
616 static int nilfs_ioctl_move_blocks(struct super_block *sb,
617 struct nilfs_argv *argv, void *buf)
619 size_t nmembs = argv->v_nmembs;
620 struct the_nilfs *nilfs = sb->s_fs_info;
622 struct nilfs_vdesc *vdesc;
623 struct buffer_head *bh, *n;
629 for (i = 0, vdesc = buf; i < nmembs; ) {
632 inode = nilfs_iget_for_gc(sb, ino, cno);
634 ret = PTR_ERR(inode);
637 if (list_empty(&NILFS_I(inode)->i_dirty)) {
639 * Add the inode to GC inode list. Garbage Collection
640 * is serialized and no two processes manipulate the
641 * list simultaneously.
644 list_add(&NILFS_I(inode)->i_dirty,
645 &nilfs->ns_gc_inodes);
649 ret = nilfs_ioctl_move_inode_block(inode, vdesc,
651 if (unlikely(ret < 0)) {
656 } while (++i < nmembs &&
657 vdesc->vd_ino == ino && vdesc->vd_cno == cno);
659 iput(inode); /* The inode still remains in GC inode list */
662 list_for_each_entry_safe(bh, n, &buffers, b_assoc_buffers) {
663 ret = nilfs_gccache_wait_and_mark_dirty(bh);
664 if (unlikely(ret < 0)) {
665 WARN_ON(ret == -EEXIST);
668 list_del_init(&bh->b_assoc_buffers);
674 list_for_each_entry_safe(bh, n, &buffers, b_assoc_buffers) {
675 list_del_init(&bh->b_assoc_buffers);
682 * nilfs_ioctl_delete_checkpoints - delete checkpoints
683 * @nilfs: nilfs object
684 * @argv: vector of arguments from userspace
685 * @buf: array of periods of checkpoints numbers
687 * Description: nilfs_ioctl_delete_checkpoints() function deletes checkpoints
688 * in the period from p_start to p_end, excluding p_end itself. The checkpoints
689 * which have been already deleted are ignored.
691 * Return Value: Number of processed nilfs_period structures or
692 * error code, otherwise.
696 * %-ENOMEM - Insufficient amount of memory available.
698 * %-EINVAL - invalid checkpoints.
700 static int nilfs_ioctl_delete_checkpoints(struct the_nilfs *nilfs,
701 struct nilfs_argv *argv, void *buf)
703 size_t nmembs = argv->v_nmembs;
704 struct inode *cpfile = nilfs->ns_cpfile;
705 struct nilfs_period *periods = buf;
708 for (i = 0; i < nmembs; i++) {
709 ret = nilfs_cpfile_delete_checkpoints(
710 cpfile, periods[i].p_start, periods[i].p_end);
718 * nilfs_ioctl_free_vblocknrs - free virtual block numbers
719 * @nilfs: nilfs object
720 * @argv: vector of arguments from userspace
721 * @buf: array of virtual block numbers
723 * Description: nilfs_ioctl_free_vblocknrs() function frees
724 * the virtual block numbers specified by @buf and @argv->v_nmembs.
726 * Return Value: Number of processed virtual block numbers or
727 * error code, otherwise.
731 * %-ENOMEM - Insufficient amount of memory available.
733 * %-ENOENT - The virtual block number have not been allocated.
735 static int nilfs_ioctl_free_vblocknrs(struct the_nilfs *nilfs,
736 struct nilfs_argv *argv, void *buf)
738 size_t nmembs = argv->v_nmembs;
741 ret = nilfs_dat_freev(nilfs->ns_dat, buf, nmembs);
743 return (ret < 0) ? ret : nmembs;
747 * nilfs_ioctl_mark_blocks_dirty - mark blocks dirty
748 * @nilfs: nilfs object
749 * @argv: vector of arguments from userspace
750 * @buf: array of block descriptors
752 * Description: nilfs_ioctl_mark_blocks_dirty() function marks
753 * metadata file or data blocks as dirty.
755 * Return Value: Number of processed block descriptors or
756 * error code, otherwise.
758 * %-ENOMEM - Insufficient memory available.
762 * %-ENOENT - the specified block does not exist (hole block)
764 static int nilfs_ioctl_mark_blocks_dirty(struct the_nilfs *nilfs,
765 struct nilfs_argv *argv, void *buf)
767 size_t nmembs = argv->v_nmembs;
768 struct nilfs_bmap *bmap = NILFS_I(nilfs->ns_dat)->i_bmap;
769 struct nilfs_bdesc *bdescs = buf;
770 struct buffer_head *bh;
773 for (i = 0; i < nmembs; i++) {
774 /* XXX: use macro or inline func to check liveness */
775 ret = nilfs_bmap_lookup_at_level(bmap,
777 bdescs[i].bd_level + 1,
778 &bdescs[i].bd_blocknr);
782 bdescs[i].bd_blocknr = 0;
784 if (bdescs[i].bd_blocknr != bdescs[i].bd_oblocknr)
785 /* skip dead block */
787 if (bdescs[i].bd_level == 0) {
788 ret = nilfs_mdt_get_block(nilfs->ns_dat,
792 WARN_ON(ret == -ENOENT);
795 mark_buffer_dirty(bh);
796 nilfs_mdt_mark_dirty(nilfs->ns_dat);
799 ret = nilfs_bmap_mark(bmap, bdescs[i].bd_offset,
802 WARN_ON(ret == -ENOENT);
810 int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *nilfs,
811 struct nilfs_argv *argv, void **kbufs)
816 ret = nilfs_ioctl_delete_checkpoints(nilfs, &argv[1], kbufs[1]);
819 * can safely abort because checkpoints can be removed
822 msg = "cannot delete checkpoints";
825 ret = nilfs_ioctl_free_vblocknrs(nilfs, &argv[2], kbufs[2]);
828 * can safely abort because DAT file is updated atomically
829 * using a copy-on-write technique.
831 msg = "cannot delete virtual blocks from DAT file";
834 ret = nilfs_ioctl_mark_blocks_dirty(nilfs, &argv[3], kbufs[3]);
837 * can safely abort because the operation is nondestructive.
839 msg = "cannot mark copying blocks dirty";
845 nilfs_msg(nilfs->ns_sb, KERN_ERR, "error %d preparing GC: %s", ret,
851 * nilfs_ioctl_clean_segments - clean segments
852 * @inode: inode object
854 * @cmd: ioctl's request code
855 * @argp: pointer on argument from userspace
857 * Description: nilfs_ioctl_clean_segments() function makes garbage
858 * collection operation in the environment of requested parameters
859 * from userspace. The NILFS_IOCTL_CLEAN_SEGMENTS ioctl is used by
860 * nilfs_cleanerd daemon.
862 * Return Value: On success, 0 is returned or error code, otherwise.
864 static int nilfs_ioctl_clean_segments(struct inode *inode, struct file *filp,
865 unsigned int cmd, void __user *argp)
867 struct nilfs_argv argv[5];
868 static const size_t argsz[5] = {
869 sizeof(struct nilfs_vdesc),
870 sizeof(struct nilfs_period),
872 sizeof(struct nilfs_bdesc),
877 struct the_nilfs *nilfs;
881 if (!capable(CAP_SYS_ADMIN))
884 ret = mnt_want_write_file(filp);
889 if (copy_from_user(argv, argp, sizeof(argv)))
893 nsegs = argv[4].v_nmembs;
894 if (argv[4].v_size != argsz[4])
896 if (nsegs > UINT_MAX / sizeof(__u64))
900 * argv[4] points to segment numbers this ioctl cleans. We
901 * use kmalloc() for its buffer because memory used for the
902 * segment numbers is enough small.
904 kbufs[4] = memdup_user((void __user *)(unsigned long)argv[4].v_base,
905 nsegs * sizeof(__u64));
906 if (IS_ERR(kbufs[4])) {
907 ret = PTR_ERR(kbufs[4]);
910 nilfs = inode->i_sb->s_fs_info;
912 for (n = 0; n < 4; n++) {
914 if (argv[n].v_size != argsz[n])
917 if (argv[n].v_nmembs > nsegs * nilfs->ns_blocks_per_segment)
920 if (argv[n].v_nmembs >= UINT_MAX / argv[n].v_size)
923 len = argv[n].v_size * argv[n].v_nmembs;
924 base = (void __user *)(unsigned long)argv[n].v_base;
930 kbufs[n] = vmalloc(len);
935 if (copy_from_user(kbufs[n], base, len)) {
943 * nilfs_ioctl_move_blocks() will call nilfs_iget_for_gc(),
944 * which will operates an inode list without blocking.
945 * To protect the list from concurrent operations,
946 * nilfs_ioctl_move_blocks should be atomic operation.
948 if (test_and_set_bit(THE_NILFS_GC_RUNNING, &nilfs->ns_flags)) {
953 ret = nilfs_ioctl_move_blocks(inode->i_sb, &argv[0], kbufs[0]);
955 nilfs_msg(inode->i_sb, KERN_ERR,
956 "error %d preparing GC: cannot read source blocks",
959 if (nilfs_sb_need_update(nilfs))
960 set_nilfs_discontinued(nilfs);
961 ret = nilfs_clean_segments(inode->i_sb, argv, kbufs);
964 nilfs_remove_all_gcinodes(nilfs);
965 clear_nilfs_gc_running(nilfs);
972 mnt_drop_write_file(filp);
977 * nilfs_ioctl_sync - make a checkpoint
978 * @inode: inode object
980 * @cmd: ioctl's request code
981 * @argp: pointer on argument from userspace
983 * Description: nilfs_ioctl_sync() function constructs a logical segment
984 * for checkpointing. This function guarantees that all modified data
985 * and metadata are written out to the device when it successfully
988 * Return Value: On success, 0 is retured. On errors, one of the following
989 * negative error code is returned.
991 * %-EROFS - Read only filesystem.
995 * %-ENOSPC - No space left on device (only in a panic state).
997 * %-ERESTARTSYS - Interrupted.
999 * %-ENOMEM - Insufficient memory available.
1001 * %-EFAULT - Failure during execution of requested operation.
1003 static int nilfs_ioctl_sync(struct inode *inode, struct file *filp,
1004 unsigned int cmd, void __user *argp)
1008 struct the_nilfs *nilfs;
1010 ret = nilfs_construct_segment(inode->i_sb);
1014 nilfs = inode->i_sb->s_fs_info;
1015 ret = nilfs_flush_device(nilfs);
1020 down_read(&nilfs->ns_segctor_sem);
1021 cno = nilfs->ns_cno - 1;
1022 up_read(&nilfs->ns_segctor_sem);
1023 if (copy_to_user(argp, &cno, sizeof(cno)))
1030 * nilfs_ioctl_resize - resize NILFS2 volume
1031 * @inode: inode object
1032 * @filp: file object
1033 * @argp: pointer on argument from userspace
1035 * Return Value: On success, 0 is returned or error code, otherwise.
1037 static int nilfs_ioctl_resize(struct inode *inode, struct file *filp,
1043 if (!capable(CAP_SYS_ADMIN))
1046 ret = mnt_want_write_file(filp);
1051 if (copy_from_user(&newsize, argp, sizeof(newsize)))
1052 goto out_drop_write;
1054 ret = nilfs_resize_fs(inode->i_sb, newsize);
1057 mnt_drop_write_file(filp);
1063 * nilfs_ioctl_trim_fs() - trim ioctl handle function
1064 * @inode: inode object
1065 * @argp: pointer on argument from userspace
1067 * Decription: nilfs_ioctl_trim_fs is the FITRIM ioctl handle function. It
1068 * checks the arguments from userspace and calls nilfs_sufile_trim_fs, which
1069 * performs the actual trim operation.
1071 * Return Value: On success, 0 is returned or negative error code, otherwise.
1073 static int nilfs_ioctl_trim_fs(struct inode *inode, void __user *argp)
1075 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
1076 struct request_queue *q = bdev_get_queue(nilfs->ns_bdev);
1077 struct fstrim_range range;
1080 if (!capable(CAP_SYS_ADMIN))
1083 if (!blk_queue_discard(q))
1086 if (copy_from_user(&range, argp, sizeof(range)))
1089 range.minlen = max_t(u64, range.minlen, q->limits.discard_granularity);
1091 down_read(&nilfs->ns_segctor_sem);
1092 ret = nilfs_sufile_trim_fs(nilfs->ns_sufile, &range);
1093 up_read(&nilfs->ns_segctor_sem);
1098 if (copy_to_user(argp, &range, sizeof(range)))
1105 * nilfs_ioctl_set_alloc_range - limit range of segments to be allocated
1106 * @inode: inode object
1107 * @argp: pointer on argument from userspace
1109 * Decription: nilfs_ioctl_set_alloc_range() function defines lower limit
1110 * of segments in bytes and upper limit of segments in bytes.
1111 * The NILFS_IOCTL_SET_ALLOC_RANGE is used by nilfs_resize utility.
1113 * Return Value: On success, 0 is returned or error code, otherwise.
1115 static int nilfs_ioctl_set_alloc_range(struct inode *inode, void __user *argp)
1117 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
1119 __u64 minseg, maxseg;
1120 unsigned long segbytes;
1123 if (!capable(CAP_SYS_ADMIN))
1127 if (copy_from_user(range, argp, sizeof(__u64[2])))
1131 if (range[1] > i_size_read(inode->i_sb->s_bdev->bd_inode))
1134 segbytes = nilfs->ns_blocks_per_segment * nilfs->ns_blocksize;
1136 minseg = range[0] + segbytes - 1;
1137 do_div(minseg, segbytes);
1138 maxseg = NILFS_SB2_OFFSET_BYTES(range[1]);
1139 do_div(maxseg, segbytes);
1142 ret = nilfs_sufile_set_alloc_range(nilfs->ns_sufile, minseg, maxseg);
1148 * nilfs_ioctl_get_info - wrapping function of get metadata info
1149 * @inode: inode object
1150 * @filp: file object
1151 * @cmd: ioctl's request code
1152 * @argp: pointer on argument from userspace
1153 * @membsz: size of an item in bytes
1154 * @dofunc: concrete function of getting metadata info
1156 * Description: nilfs_ioctl_get_info() gets metadata info by means of
1157 * calling dofunc() function.
1159 * Return Value: On success, 0 is returned and requested metadata info
1160 * is copied into userspace. On error, one of the following
1161 * negative error codes is returned.
1163 * %-EINVAL - Invalid arguments from userspace.
1165 * %-ENOMEM - Insufficient amount of memory available.
1167 * %-EFAULT - Failure during execution of requested operation.
1169 static int nilfs_ioctl_get_info(struct inode *inode, struct file *filp,
1170 unsigned int cmd, void __user *argp,
1172 ssize_t (*dofunc)(struct the_nilfs *,
1174 void *, size_t, size_t))
1177 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
1178 struct nilfs_argv argv;
1181 if (copy_from_user(&argv, argp, sizeof(argv)))
1184 if (argv.v_size < membsz)
1187 ret = nilfs_ioctl_wrap_copy(nilfs, &argv, _IOC_DIR(cmd), dofunc);
1191 if (copy_to_user(argp, &argv, sizeof(argv)))
1197 * nilfs_ioctl_set_suinfo - set segment usage info
1198 * @inode: inode object
1199 * @filp: file object
1200 * @cmd: ioctl's request code
1201 * @argp: pointer on argument from userspace
1203 * Description: Expects an array of nilfs_suinfo_update structures
1204 * encapsulated in nilfs_argv and updates the segment usage info
1205 * according to the flags in nilfs_suinfo_update.
1207 * Return Value: On success, 0 is returned. On error, one of the
1208 * following negative error codes is returned.
1210 * %-EPERM - Not enough permissions
1212 * %-EFAULT - Error copying input data
1214 * %-EIO - I/O error.
1216 * %-ENOMEM - Insufficient amount of memory available.
1218 * %-EINVAL - Invalid values in input (segment number, flags or nblocks)
1220 static int nilfs_ioctl_set_suinfo(struct inode *inode, struct file *filp,
1221 unsigned int cmd, void __user *argp)
1223 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
1224 struct nilfs_transaction_info ti;
1225 struct nilfs_argv argv;
1231 if (!capable(CAP_SYS_ADMIN))
1234 ret = mnt_want_write_file(filp);
1239 if (copy_from_user(&argv, argp, sizeof(argv)))
1243 if (argv.v_size < sizeof(struct nilfs_suinfo_update))
1246 if (argv.v_nmembs > nilfs->ns_nsegments)
1249 if (argv.v_nmembs >= UINT_MAX / argv.v_size)
1252 len = argv.v_size * argv.v_nmembs;
1258 base = (void __user *)(unsigned long)argv.v_base;
1259 kbuf = vmalloc(len);
1265 if (copy_from_user(kbuf, base, len)) {
1270 nilfs_transaction_begin(inode->i_sb, &ti, 0);
1271 ret = nilfs_sufile_set_suinfo(nilfs->ns_sufile, kbuf, argv.v_size,
1273 if (unlikely(ret < 0))
1274 nilfs_transaction_abort(inode->i_sb);
1276 nilfs_transaction_commit(inode->i_sb); /* never fails */
1281 mnt_drop_write_file(filp);
1285 long nilfs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
1287 struct inode *inode = file_inode(filp);
1288 void __user *argp = (void __user *)arg;
1291 case FS_IOC_GETFLAGS:
1292 return nilfs_ioctl_getflags(inode, argp);
1293 case FS_IOC_SETFLAGS:
1294 return nilfs_ioctl_setflags(inode, filp, argp);
1295 case FS_IOC_GETVERSION:
1296 return nilfs_ioctl_getversion(inode, argp);
1297 case NILFS_IOCTL_CHANGE_CPMODE:
1298 return nilfs_ioctl_change_cpmode(inode, filp, cmd, argp);
1299 case NILFS_IOCTL_DELETE_CHECKPOINT:
1300 return nilfs_ioctl_delete_checkpoint(inode, filp, cmd, argp);
1301 case NILFS_IOCTL_GET_CPINFO:
1302 return nilfs_ioctl_get_info(inode, filp, cmd, argp,
1303 sizeof(struct nilfs_cpinfo),
1304 nilfs_ioctl_do_get_cpinfo);
1305 case NILFS_IOCTL_GET_CPSTAT:
1306 return nilfs_ioctl_get_cpstat(inode, filp, cmd, argp);
1307 case NILFS_IOCTL_GET_SUINFO:
1308 return nilfs_ioctl_get_info(inode, filp, cmd, argp,
1309 sizeof(struct nilfs_suinfo),
1310 nilfs_ioctl_do_get_suinfo);
1311 case NILFS_IOCTL_SET_SUINFO:
1312 return nilfs_ioctl_set_suinfo(inode, filp, cmd, argp);
1313 case NILFS_IOCTL_GET_SUSTAT:
1314 return nilfs_ioctl_get_sustat(inode, filp, cmd, argp);
1315 case NILFS_IOCTL_GET_VINFO:
1316 return nilfs_ioctl_get_info(inode, filp, cmd, argp,
1317 sizeof(struct nilfs_vinfo),
1318 nilfs_ioctl_do_get_vinfo);
1319 case NILFS_IOCTL_GET_BDESCS:
1320 return nilfs_ioctl_get_bdescs(inode, filp, cmd, argp);
1321 case NILFS_IOCTL_CLEAN_SEGMENTS:
1322 return nilfs_ioctl_clean_segments(inode, filp, cmd, argp);
1323 case NILFS_IOCTL_SYNC:
1324 return nilfs_ioctl_sync(inode, filp, cmd, argp);
1325 case NILFS_IOCTL_RESIZE:
1326 return nilfs_ioctl_resize(inode, filp, argp);
1327 case NILFS_IOCTL_SET_ALLOC_RANGE:
1328 return nilfs_ioctl_set_alloc_range(inode, argp);
1330 return nilfs_ioctl_trim_fs(inode, argp);
1336 #ifdef CONFIG_COMPAT
1337 long nilfs_compat_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
1340 case FS_IOC32_GETFLAGS:
1341 cmd = FS_IOC_GETFLAGS;
1343 case FS_IOC32_SETFLAGS:
1344 cmd = FS_IOC_SETFLAGS;
1346 case FS_IOC32_GETVERSION:
1347 cmd = FS_IOC_GETVERSION;
1349 case NILFS_IOCTL_CHANGE_CPMODE:
1350 case NILFS_IOCTL_DELETE_CHECKPOINT:
1351 case NILFS_IOCTL_GET_CPINFO:
1352 case NILFS_IOCTL_GET_CPSTAT:
1353 case NILFS_IOCTL_GET_SUINFO:
1354 case NILFS_IOCTL_SET_SUINFO:
1355 case NILFS_IOCTL_GET_SUSTAT:
1356 case NILFS_IOCTL_GET_VINFO:
1357 case NILFS_IOCTL_GET_BDESCS:
1358 case NILFS_IOCTL_CLEAN_SEGMENTS:
1359 case NILFS_IOCTL_SYNC:
1360 case NILFS_IOCTL_RESIZE:
1361 case NILFS_IOCTL_SET_ALLOC_RANGE:
1364 return -ENOIOCTLCMD;
1366 return nilfs_ioctl(filp, cmd, (unsigned long)compat_ptr(arg));