1 // SPDX-License-Identifier: GPL-2.0+
3 * 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>
19 #include <linux/fileattr.h>
28 * nilfs_ioctl_wrap_copy - wrapping function of get/set metadata info
29 * @nilfs: nilfs object
30 * @argv: vector of arguments from userspace
31 * @dir: set of direction flags
32 * @dofunc: concrete function of get/set metadata info
34 * Description: nilfs_ioctl_wrap_copy() gets/sets metadata info by means of
35 * calling dofunc() function on the basis of @argv argument.
37 * Return Value: On success, 0 is returned and requested metadata info
38 * is copied into userspace. On error, one of the following
39 * negative error codes is returned.
41 * %-EINVAL - Invalid arguments from userspace.
43 * %-ENOMEM - Insufficient amount of memory available.
45 * %-EFAULT - Failure during execution of requested operation.
47 static int nilfs_ioctl_wrap_copy(struct the_nilfs *nilfs,
48 struct nilfs_argv *argv, int dir,
49 ssize_t (*dofunc)(struct the_nilfs *,
51 void *, size_t, size_t))
54 void __user *base = (void __user *)(unsigned long)argv->v_base;
55 size_t maxmembs, total, n;
60 if (argv->v_nmembs == 0)
63 if (argv->v_size > PAGE_SIZE)
67 * Reject pairs of a start item position (argv->v_index) and a
68 * total count (argv->v_nmembs) which leads position 'pos' to
69 * overflow by the increment at the end of the loop.
71 if (argv->v_index > ~(__u64)0 - argv->v_nmembs)
74 buf = (void *)get_zeroed_page(GFP_NOFS);
77 maxmembs = PAGE_SIZE / argv->v_size;
82 for (i = 0; i < argv->v_nmembs; i += n) {
83 n = (argv->v_nmembs - i < maxmembs) ?
84 argv->v_nmembs - i : maxmembs;
85 if ((dir & _IOC_WRITE) &&
86 copy_from_user(buf, base + argv->v_size * i,
92 nr = dofunc(nilfs, &pos, argv->v_flags, buf, argv->v_size,
98 if ((dir & _IOC_READ) &&
99 copy_to_user(base + argv->v_size * i, buf,
100 argv->v_size * nr)) {
110 argv->v_nmembs = total;
112 free_pages((unsigned long)buf, 0);
117 * nilfs_fileattr_get - ioctl to support lsattr
119 int nilfs_fileattr_get(struct dentry *dentry, struct fileattr *fa)
121 struct inode *inode = d_inode(dentry);
123 fileattr_fill_flags(fa, NILFS_I(inode)->i_flags & FS_FL_USER_VISIBLE);
129 * nilfs_fileattr_set - ioctl to support chattr
131 int nilfs_fileattr_set(struct mnt_idmap *idmap,
132 struct dentry *dentry, struct fileattr *fa)
134 struct inode *inode = d_inode(dentry);
135 struct nilfs_transaction_info ti;
136 unsigned int flags, oldflags;
139 if (fileattr_has_fsx(fa))
142 flags = nilfs_mask_flags(inode->i_mode, fa->flags);
144 ret = nilfs_transaction_begin(inode->i_sb, &ti, 0);
148 oldflags = NILFS_I(inode)->i_flags & ~FS_FL_USER_MODIFIABLE;
149 NILFS_I(inode)->i_flags = oldflags | (flags & FS_FL_USER_MODIFIABLE);
151 nilfs_set_inode_flags(inode);
152 inode_set_ctime_current(inode);
154 nilfs_set_transaction_flag(NILFS_TI_SYNC);
156 nilfs_mark_inode_dirty(inode);
157 return nilfs_transaction_commit(inode->i_sb);
161 * nilfs_ioctl_getversion - get info about a file's version (generation number)
163 static int nilfs_ioctl_getversion(struct inode *inode, void __user *argp)
165 return put_user(inode->i_generation, (int __user *)argp);
169 * nilfs_ioctl_change_cpmode - change checkpoint mode (checkpoint/snapshot)
170 * @inode: inode object
172 * @cmd: ioctl's request code
173 * @argp: pointer on argument from userspace
175 * Description: nilfs_ioctl_change_cpmode() function changes mode of
176 * given checkpoint between checkpoint and snapshot state. This ioctl
177 * is used in chcp and mkcp utilities.
179 * Return Value: On success, 0 is returned and mode of a checkpoint is
180 * changed. On error, one of the following negative error codes
183 * %-EPERM - Operation not permitted.
185 * %-EFAULT - Failure during checkpoint mode changing.
187 static int nilfs_ioctl_change_cpmode(struct inode *inode, struct file *filp,
188 unsigned int cmd, void __user *argp)
190 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
191 struct nilfs_transaction_info ti;
192 struct nilfs_cpmode cpmode;
195 if (!capable(CAP_SYS_ADMIN))
198 ret = mnt_want_write_file(filp);
203 if (copy_from_user(&cpmode, argp, sizeof(cpmode)))
206 mutex_lock(&nilfs->ns_snapshot_mount_mutex);
208 nilfs_transaction_begin(inode->i_sb, &ti, 0);
209 ret = nilfs_cpfile_change_cpmode(
210 nilfs->ns_cpfile, cpmode.cm_cno, cpmode.cm_mode);
211 if (unlikely(ret < 0))
212 nilfs_transaction_abort(inode->i_sb);
214 nilfs_transaction_commit(inode->i_sb); /* never fails */
216 mutex_unlock(&nilfs->ns_snapshot_mount_mutex);
218 mnt_drop_write_file(filp);
223 * nilfs_ioctl_delete_checkpoint - remove checkpoint
224 * @inode: inode object
226 * @cmd: ioctl's request code
227 * @argp: pointer on argument from userspace
229 * Description: nilfs_ioctl_delete_checkpoint() function removes
230 * checkpoint from NILFS2 file system. This ioctl is used in rmcp
233 * Return Value: On success, 0 is returned and a checkpoint is
234 * removed. On error, one of the following negative error codes
237 * %-EPERM - Operation not permitted.
239 * %-EFAULT - Failure during checkpoint removing.
242 nilfs_ioctl_delete_checkpoint(struct inode *inode, struct file *filp,
243 unsigned int cmd, void __user *argp)
245 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
246 struct nilfs_transaction_info ti;
250 if (!capable(CAP_SYS_ADMIN))
253 ret = mnt_want_write_file(filp);
258 if (copy_from_user(&cno, argp, sizeof(cno)))
261 nilfs_transaction_begin(inode->i_sb, &ti, 0);
262 ret = nilfs_cpfile_delete_checkpoint(nilfs->ns_cpfile, cno);
263 if (unlikely(ret < 0))
264 nilfs_transaction_abort(inode->i_sb);
266 nilfs_transaction_commit(inode->i_sb); /* never fails */
268 mnt_drop_write_file(filp);
273 * nilfs_ioctl_do_get_cpinfo - callback method getting info about checkpoints
274 * @nilfs: nilfs object
275 * @posp: pointer on array of checkpoint's numbers
276 * @flags: checkpoint mode (checkpoint or snapshot)
277 * @buf: buffer for storing checkponts' info
278 * @size: size in bytes of one checkpoint info item in array
279 * @nmembs: number of checkpoints in array (numbers and infos)
281 * Description: nilfs_ioctl_do_get_cpinfo() function returns info about
282 * requested checkpoints. The NILFS_IOCTL_GET_CPINFO ioctl is used in
283 * lscp utility and by nilfs_cleanerd daemon.
285 * Return value: count of nilfs_cpinfo structures in output buffer.
288 nilfs_ioctl_do_get_cpinfo(struct the_nilfs *nilfs, __u64 *posp, int flags,
289 void *buf, size_t size, size_t nmembs)
293 down_read(&nilfs->ns_segctor_sem);
294 ret = nilfs_cpfile_get_cpinfo(nilfs->ns_cpfile, posp, flags, buf,
296 up_read(&nilfs->ns_segctor_sem);
301 * nilfs_ioctl_get_cpstat - get checkpoints statistics
302 * @inode: inode object
304 * @cmd: ioctl's request code
305 * @argp: pointer on argument from userspace
307 * Description: nilfs_ioctl_get_cpstat() returns information about checkpoints.
308 * The NILFS_IOCTL_GET_CPSTAT ioctl is used by lscp, rmcp utilities
309 * and by nilfs_cleanerd daemon.
311 * Return Value: On success, 0 is returned, and checkpoints information is
312 * copied into userspace pointer @argp. On error, one of the following
313 * negative error codes is returned.
317 * %-ENOMEM - Insufficient amount of memory available.
319 * %-EFAULT - Failure during getting checkpoints statistics.
321 static int nilfs_ioctl_get_cpstat(struct inode *inode, struct file *filp,
322 unsigned int cmd, void __user *argp)
324 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
325 struct nilfs_cpstat cpstat;
328 down_read(&nilfs->ns_segctor_sem);
329 ret = nilfs_cpfile_get_stat(nilfs->ns_cpfile, &cpstat);
330 up_read(&nilfs->ns_segctor_sem);
334 if (copy_to_user(argp, &cpstat, sizeof(cpstat)))
340 * nilfs_ioctl_do_get_suinfo - callback method getting segment usage info
341 * @nilfs: nilfs object
342 * @posp: pointer on array of segment numbers
344 * @buf: buffer for storing suinfo array
345 * @size: size in bytes of one suinfo item in array
346 * @nmembs: count of segment numbers and suinfos in array
348 * Description: nilfs_ioctl_do_get_suinfo() function returns segment usage
349 * info about requested segments. The NILFS_IOCTL_GET_SUINFO ioctl is used
350 * in lssu, nilfs_resize utilities and by nilfs_cleanerd daemon.
352 * Return value: count of nilfs_suinfo structures in output buffer.
355 nilfs_ioctl_do_get_suinfo(struct the_nilfs *nilfs, __u64 *posp, int flags,
356 void *buf, size_t size, size_t nmembs)
360 down_read(&nilfs->ns_segctor_sem);
361 ret = nilfs_sufile_get_suinfo(nilfs->ns_sufile, *posp, buf, size,
363 up_read(&nilfs->ns_segctor_sem);
368 * nilfs_ioctl_get_sustat - get segment usage statistics
369 * @inode: inode object
371 * @cmd: ioctl's request code
372 * @argp: pointer on argument from userspace
374 * Description: nilfs_ioctl_get_sustat() returns segment usage statistics.
375 * The NILFS_IOCTL_GET_SUSTAT ioctl is used in lssu, nilfs_resize utilities
376 * and by nilfs_cleanerd daemon.
378 * Return Value: On success, 0 is returned, and segment usage information is
379 * copied into userspace pointer @argp. On error, one of the following
380 * negative error codes is returned.
384 * %-ENOMEM - Insufficient amount of memory available.
386 * %-EFAULT - Failure during getting segment usage statistics.
388 static int nilfs_ioctl_get_sustat(struct inode *inode, struct file *filp,
389 unsigned int cmd, void __user *argp)
391 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
392 struct nilfs_sustat sustat;
395 down_read(&nilfs->ns_segctor_sem);
396 ret = nilfs_sufile_get_stat(nilfs->ns_sufile, &sustat);
397 up_read(&nilfs->ns_segctor_sem);
401 if (copy_to_user(argp, &sustat, sizeof(sustat)))
407 * nilfs_ioctl_do_get_vinfo - callback method getting virtual blocks info
408 * @nilfs: nilfs object
411 * @buf: buffer for storing array of nilfs_vinfo structures
412 * @size: size in bytes of one vinfo item in array
413 * @nmembs: count of vinfos in array
415 * Description: nilfs_ioctl_do_get_vinfo() function returns information
416 * on virtual block addresses. The NILFS_IOCTL_GET_VINFO ioctl is used
417 * by nilfs_cleanerd daemon.
419 * Return value: count of nilfs_vinfo structures in output buffer.
422 nilfs_ioctl_do_get_vinfo(struct the_nilfs *nilfs, __u64 *posp, int flags,
423 void *buf, size_t size, size_t nmembs)
427 down_read(&nilfs->ns_segctor_sem);
428 ret = nilfs_dat_get_vinfo(nilfs->ns_dat, buf, size, nmembs);
429 up_read(&nilfs->ns_segctor_sem);
434 * nilfs_ioctl_do_get_bdescs - callback method getting disk block descriptors
435 * @nilfs: nilfs object
438 * @buf: buffer for storing array of nilfs_bdesc structures
439 * @size: size in bytes of one bdesc item in array
440 * @nmembs: count of bdescs in array
442 * Description: nilfs_ioctl_do_get_bdescs() function returns information
443 * about descriptors of disk block numbers. The NILFS_IOCTL_GET_BDESCS ioctl
444 * is used by nilfs_cleanerd daemon.
446 * Return value: count of nilfs_bdescs structures in output buffer.
449 nilfs_ioctl_do_get_bdescs(struct the_nilfs *nilfs, __u64 *posp, int flags,
450 void *buf, size_t size, size_t nmembs)
452 struct nilfs_bmap *bmap = NILFS_I(nilfs->ns_dat)->i_bmap;
453 struct nilfs_bdesc *bdescs = buf;
456 down_read(&nilfs->ns_segctor_sem);
457 for (i = 0; i < nmembs; i++) {
458 ret = nilfs_bmap_lookup_at_level(bmap,
460 bdescs[i].bd_level + 1,
461 &bdescs[i].bd_blocknr);
463 if (ret != -ENOENT) {
464 up_read(&nilfs->ns_segctor_sem);
467 bdescs[i].bd_blocknr = 0;
470 up_read(&nilfs->ns_segctor_sem);
475 * nilfs_ioctl_get_bdescs - get disk block descriptors
476 * @inode: inode object
478 * @cmd: ioctl's request code
479 * @argp: pointer on argument from userspace
481 * Description: nilfs_ioctl_do_get_bdescs() function returns information
482 * about descriptors of disk block numbers. The NILFS_IOCTL_GET_BDESCS ioctl
483 * is used by nilfs_cleanerd daemon.
485 * Return Value: On success, 0 is returned, and disk block descriptors are
486 * copied into userspace pointer @argp. On error, one of the following
487 * negative error codes is returned.
489 * %-EINVAL - Invalid arguments from userspace.
493 * %-ENOMEM - Insufficient amount of memory available.
495 * %-EFAULT - Failure during getting disk block descriptors.
497 static int nilfs_ioctl_get_bdescs(struct inode *inode, struct file *filp,
498 unsigned int cmd, void __user *argp)
500 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
501 struct nilfs_argv argv;
504 if (copy_from_user(&argv, argp, sizeof(argv)))
507 if (argv.v_size != sizeof(struct nilfs_bdesc))
510 ret = nilfs_ioctl_wrap_copy(nilfs, &argv, _IOC_DIR(cmd),
511 nilfs_ioctl_do_get_bdescs);
515 if (copy_to_user(argp, &argv, sizeof(argv)))
521 * nilfs_ioctl_move_inode_block - prepare data/node block for moving by GC
522 * @inode: inode object
523 * @vdesc: descriptor of virtual block number
524 * @buffers: list of moving buffers
526 * Description: nilfs_ioctl_move_inode_block() function registers data/node
527 * buffer in the GC pagecache and submit read request.
529 * Return Value: On success, 0 is returned. On error, one of the following
530 * negative error codes is returned.
534 * %-ENOMEM - Insufficient amount of memory available.
536 * %-ENOENT - Requested block doesn't exist.
538 * %-EEXIST - Blocks conflict is detected.
540 static int nilfs_ioctl_move_inode_block(struct inode *inode,
541 struct nilfs_vdesc *vdesc,
542 struct list_head *buffers)
544 struct buffer_head *bh;
547 if (vdesc->vd_flags == 0)
548 ret = nilfs_gccache_submit_read_data(
549 inode, vdesc->vd_offset, vdesc->vd_blocknr,
550 vdesc->vd_vblocknr, &bh);
552 ret = nilfs_gccache_submit_read_node(
553 inode, vdesc->vd_blocknr, vdesc->vd_vblocknr, &bh);
555 if (unlikely(ret < 0)) {
557 nilfs_crit(inode->i_sb,
558 "%s: invalid virtual block address (%s): ino=%llu, cno=%llu, offset=%llu, blocknr=%llu, vblocknr=%llu",
559 __func__, vdesc->vd_flags ? "node" : "data",
560 (unsigned long long)vdesc->vd_ino,
561 (unsigned long long)vdesc->vd_cno,
562 (unsigned long long)vdesc->vd_offset,
563 (unsigned long long)vdesc->vd_blocknr,
564 (unsigned long long)vdesc->vd_vblocknr);
567 if (unlikely(!list_empty(&bh->b_assoc_buffers))) {
568 nilfs_crit(inode->i_sb,
569 "%s: conflicting %s buffer: ino=%llu, cno=%llu, offset=%llu, blocknr=%llu, vblocknr=%llu",
570 __func__, vdesc->vd_flags ? "node" : "data",
571 (unsigned long long)vdesc->vd_ino,
572 (unsigned long long)vdesc->vd_cno,
573 (unsigned long long)vdesc->vd_offset,
574 (unsigned long long)vdesc->vd_blocknr,
575 (unsigned long long)vdesc->vd_vblocknr);
579 list_add_tail(&bh->b_assoc_buffers, buffers);
584 * nilfs_ioctl_move_blocks - move valid inode's blocks during garbage collection
585 * @sb: superblock object
586 * @argv: vector of arguments from userspace
587 * @buf: array of nilfs_vdesc structures
589 * Description: nilfs_ioctl_move_blocks() function reads valid data/node
590 * blocks that garbage collector specified with the array of nilfs_vdesc
591 * structures and stores them into page caches of GC inodes.
593 * Return Value: Number of processed nilfs_vdesc structures or
594 * error code, otherwise.
596 static int nilfs_ioctl_move_blocks(struct super_block *sb,
597 struct nilfs_argv *argv, void *buf)
599 size_t nmembs = argv->v_nmembs;
600 struct the_nilfs *nilfs = sb->s_fs_info;
602 struct nilfs_vdesc *vdesc;
603 struct buffer_head *bh, *n;
609 for (i = 0, vdesc = buf; i < nmembs; ) {
612 inode = nilfs_iget_for_gc(sb, ino, cno);
614 ret = PTR_ERR(inode);
617 if (list_empty(&NILFS_I(inode)->i_dirty)) {
619 * Add the inode to GC inode list. Garbage Collection
620 * is serialized and no two processes manipulate the
621 * list simultaneously.
624 list_add(&NILFS_I(inode)->i_dirty,
625 &nilfs->ns_gc_inodes);
629 ret = nilfs_ioctl_move_inode_block(inode, vdesc,
631 if (unlikely(ret < 0)) {
636 } while (++i < nmembs &&
637 vdesc->vd_ino == ino && vdesc->vd_cno == cno);
639 iput(inode); /* The inode still remains in GC inode list */
642 list_for_each_entry_safe(bh, n, &buffers, b_assoc_buffers) {
643 ret = nilfs_gccache_wait_and_mark_dirty(bh);
644 if (unlikely(ret < 0)) {
645 WARN_ON(ret == -EEXIST);
648 list_del_init(&bh->b_assoc_buffers);
654 list_for_each_entry_safe(bh, n, &buffers, b_assoc_buffers) {
655 list_del_init(&bh->b_assoc_buffers);
662 * nilfs_ioctl_delete_checkpoints - delete checkpoints
663 * @nilfs: nilfs object
664 * @argv: vector of arguments from userspace
665 * @buf: array of periods of checkpoints numbers
667 * Description: nilfs_ioctl_delete_checkpoints() function deletes checkpoints
668 * in the period from p_start to p_end, excluding p_end itself. The checkpoints
669 * which have been already deleted are ignored.
671 * Return Value: Number of processed nilfs_period structures or
672 * error code, otherwise.
676 * %-ENOMEM - Insufficient amount of memory available.
678 * %-EINVAL - invalid checkpoints.
680 static int nilfs_ioctl_delete_checkpoints(struct the_nilfs *nilfs,
681 struct nilfs_argv *argv, void *buf)
683 size_t nmembs = argv->v_nmembs;
684 struct inode *cpfile = nilfs->ns_cpfile;
685 struct nilfs_period *periods = buf;
688 for (i = 0; i < nmembs; i++) {
689 ret = nilfs_cpfile_delete_checkpoints(
690 cpfile, periods[i].p_start, periods[i].p_end);
698 * nilfs_ioctl_free_vblocknrs - free virtual block numbers
699 * @nilfs: nilfs object
700 * @argv: vector of arguments from userspace
701 * @buf: array of virtual block numbers
703 * Description: nilfs_ioctl_free_vblocknrs() function frees
704 * the virtual block numbers specified by @buf and @argv->v_nmembs.
706 * Return Value: Number of processed virtual block numbers or
707 * error code, otherwise.
711 * %-ENOMEM - Insufficient amount of memory available.
713 * %-ENOENT - The virtual block number have not been allocated.
715 static int nilfs_ioctl_free_vblocknrs(struct the_nilfs *nilfs,
716 struct nilfs_argv *argv, void *buf)
718 size_t nmembs = argv->v_nmembs;
721 ret = nilfs_dat_freev(nilfs->ns_dat, buf, nmembs);
723 return (ret < 0) ? ret : nmembs;
727 * nilfs_ioctl_mark_blocks_dirty - mark blocks dirty
728 * @nilfs: nilfs object
729 * @argv: vector of arguments from userspace
730 * @buf: array of block descriptors
732 * Description: nilfs_ioctl_mark_blocks_dirty() function marks
733 * metadata file or data blocks as dirty.
735 * Return Value: Number of processed block descriptors or
736 * error code, otherwise.
738 * %-ENOMEM - Insufficient memory available.
742 * %-ENOENT - the specified block does not exist (hole block)
744 static int nilfs_ioctl_mark_blocks_dirty(struct the_nilfs *nilfs,
745 struct nilfs_argv *argv, void *buf)
747 size_t nmembs = argv->v_nmembs;
748 struct nilfs_bmap *bmap = NILFS_I(nilfs->ns_dat)->i_bmap;
749 struct nilfs_bdesc *bdescs = buf;
750 struct buffer_head *bh;
753 for (i = 0; i < nmembs; i++) {
754 /* XXX: use macro or inline func to check liveness */
755 ret = nilfs_bmap_lookup_at_level(bmap,
757 bdescs[i].bd_level + 1,
758 &bdescs[i].bd_blocknr);
762 bdescs[i].bd_blocknr = 0;
764 if (bdescs[i].bd_blocknr != bdescs[i].bd_oblocknr)
765 /* skip dead block */
767 if (bdescs[i].bd_level == 0) {
768 ret = nilfs_mdt_get_block(nilfs->ns_dat,
772 WARN_ON(ret == -ENOENT);
775 mark_buffer_dirty(bh);
776 nilfs_mdt_mark_dirty(nilfs->ns_dat);
779 ret = nilfs_bmap_mark(bmap, bdescs[i].bd_offset,
782 WARN_ON(ret == -ENOENT);
790 int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *nilfs,
791 struct nilfs_argv *argv, void **kbufs)
796 ret = nilfs_ioctl_delete_checkpoints(nilfs, &argv[1], kbufs[1]);
799 * can safely abort because checkpoints can be removed
802 msg = "cannot delete checkpoints";
805 ret = nilfs_ioctl_free_vblocknrs(nilfs, &argv[2], kbufs[2]);
808 * can safely abort because DAT file is updated atomically
809 * using a copy-on-write technique.
811 msg = "cannot delete virtual blocks from DAT file";
814 ret = nilfs_ioctl_mark_blocks_dirty(nilfs, &argv[3], kbufs[3]);
817 * can safely abort because the operation is nondestructive.
819 msg = "cannot mark copying blocks dirty";
825 nilfs_err(nilfs->ns_sb, "error %d preparing GC: %s", ret, msg);
830 * nilfs_ioctl_clean_segments - clean segments
831 * @inode: inode object
833 * @cmd: ioctl's request code
834 * @argp: pointer on argument from userspace
836 * Description: nilfs_ioctl_clean_segments() function makes garbage
837 * collection operation in the environment of requested parameters
838 * from userspace. The NILFS_IOCTL_CLEAN_SEGMENTS ioctl is used by
839 * nilfs_cleanerd daemon.
841 * Return Value: On success, 0 is returned or error code, otherwise.
843 static int nilfs_ioctl_clean_segments(struct inode *inode, struct file *filp,
844 unsigned int cmd, void __user *argp)
846 struct nilfs_argv argv[5];
847 static const size_t argsz[5] = {
848 sizeof(struct nilfs_vdesc),
849 sizeof(struct nilfs_period),
851 sizeof(struct nilfs_bdesc),
856 struct the_nilfs *nilfs;
860 if (!capable(CAP_SYS_ADMIN))
863 ret = mnt_want_write_file(filp);
868 if (copy_from_user(argv, argp, sizeof(argv)))
872 nsegs = argv[4].v_nmembs;
873 if (argv[4].v_size != argsz[4])
875 if (nsegs > UINT_MAX / sizeof(__u64))
879 * argv[4] points to segment numbers this ioctl cleans. We
880 * use kmalloc() for its buffer because memory used for the
881 * segment numbers is enough small.
883 kbufs[4] = memdup_user((void __user *)(unsigned long)argv[4].v_base,
884 nsegs * sizeof(__u64));
885 if (IS_ERR(kbufs[4])) {
886 ret = PTR_ERR(kbufs[4]);
889 nilfs = inode->i_sb->s_fs_info;
891 for (n = 0; n < 4; n++) {
893 if (argv[n].v_size != argsz[n])
896 if (argv[n].v_nmembs > nsegs * nilfs->ns_blocks_per_segment)
899 if (argv[n].v_nmembs >= UINT_MAX / argv[n].v_size)
902 len = argv[n].v_size * argv[n].v_nmembs;
903 base = (void __user *)(unsigned long)argv[n].v_base;
909 kbufs[n] = vmalloc(len);
914 if (copy_from_user(kbufs[n], base, len)) {
922 * nilfs_ioctl_move_blocks() will call nilfs_iget_for_gc(),
923 * which will operates an inode list without blocking.
924 * To protect the list from concurrent operations,
925 * nilfs_ioctl_move_blocks should be atomic operation.
927 if (test_and_set_bit(THE_NILFS_GC_RUNNING, &nilfs->ns_flags)) {
932 ret = nilfs_ioctl_move_blocks(inode->i_sb, &argv[0], kbufs[0]);
934 nilfs_err(inode->i_sb,
935 "error %d preparing GC: cannot read source blocks",
938 if (nilfs_sb_need_update(nilfs))
939 set_nilfs_discontinued(nilfs);
940 ret = nilfs_clean_segments(inode->i_sb, argv, kbufs);
943 nilfs_remove_all_gcinodes(nilfs);
944 clear_nilfs_gc_running(nilfs);
951 mnt_drop_write_file(filp);
956 * nilfs_ioctl_sync - make a checkpoint
957 * @inode: inode object
959 * @cmd: ioctl's request code
960 * @argp: pointer on argument from userspace
962 * Description: nilfs_ioctl_sync() function constructs a logical segment
963 * for checkpointing. This function guarantees that all modified data
964 * and metadata are written out to the device when it successfully
967 * Return Value: On success, 0 is retured. On errors, one of the following
968 * negative error code is returned.
970 * %-EROFS - Read only filesystem.
974 * %-ENOSPC - No space left on device (only in a panic state).
976 * %-ERESTARTSYS - Interrupted.
978 * %-ENOMEM - Insufficient memory available.
980 * %-EFAULT - Failure during execution of requested operation.
982 static int nilfs_ioctl_sync(struct inode *inode, struct file *filp,
983 unsigned int cmd, void __user *argp)
987 struct the_nilfs *nilfs;
989 ret = nilfs_construct_segment(inode->i_sb);
993 nilfs = inode->i_sb->s_fs_info;
994 ret = nilfs_flush_device(nilfs);
999 down_read(&nilfs->ns_segctor_sem);
1000 cno = nilfs->ns_cno - 1;
1001 up_read(&nilfs->ns_segctor_sem);
1002 if (copy_to_user(argp, &cno, sizeof(cno)))
1009 * nilfs_ioctl_resize - resize NILFS2 volume
1010 * @inode: inode object
1011 * @filp: file object
1012 * @argp: pointer on argument from userspace
1014 * Return Value: On success, 0 is returned or error code, otherwise.
1016 static int nilfs_ioctl_resize(struct inode *inode, struct file *filp,
1022 if (!capable(CAP_SYS_ADMIN))
1025 ret = mnt_want_write_file(filp);
1030 if (copy_from_user(&newsize, argp, sizeof(newsize)))
1031 goto out_drop_write;
1033 ret = nilfs_resize_fs(inode->i_sb, newsize);
1036 mnt_drop_write_file(filp);
1042 * nilfs_ioctl_trim_fs() - trim ioctl handle function
1043 * @inode: inode object
1044 * @argp: pointer on argument from userspace
1046 * Description: nilfs_ioctl_trim_fs is the FITRIM ioctl handle function. It
1047 * checks the arguments from userspace and calls nilfs_sufile_trim_fs, which
1048 * performs the actual trim operation.
1050 * Return Value: On success, 0 is returned or negative error code, otherwise.
1052 static int nilfs_ioctl_trim_fs(struct inode *inode, void __user *argp)
1054 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
1055 struct fstrim_range range;
1058 if (!capable(CAP_SYS_ADMIN))
1061 if (!bdev_max_discard_sectors(nilfs->ns_bdev))
1064 if (copy_from_user(&range, argp, sizeof(range)))
1067 range.minlen = max_t(u64, range.minlen,
1068 bdev_discard_granularity(nilfs->ns_bdev));
1070 down_read(&nilfs->ns_segctor_sem);
1071 ret = nilfs_sufile_trim_fs(nilfs->ns_sufile, &range);
1072 up_read(&nilfs->ns_segctor_sem);
1077 if (copy_to_user(argp, &range, sizeof(range)))
1084 * nilfs_ioctl_set_alloc_range - limit range of segments to be allocated
1085 * @inode: inode object
1086 * @argp: pointer on argument from userspace
1088 * Description: nilfs_ioctl_set_alloc_range() function defines lower limit
1089 * of segments in bytes and upper limit of segments in bytes.
1090 * The NILFS_IOCTL_SET_ALLOC_RANGE is used by nilfs_resize utility.
1092 * Return Value: On success, 0 is returned or error code, otherwise.
1094 static int nilfs_ioctl_set_alloc_range(struct inode *inode, void __user *argp)
1096 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
1098 __u64 minseg, maxseg;
1099 unsigned long segbytes;
1102 if (!capable(CAP_SYS_ADMIN))
1106 if (copy_from_user(range, argp, sizeof(__u64[2])))
1110 if (range[1] > bdev_nr_bytes(inode->i_sb->s_bdev))
1113 segbytes = nilfs->ns_blocks_per_segment * nilfs->ns_blocksize;
1115 minseg = range[0] + segbytes - 1;
1116 do_div(minseg, segbytes);
1118 if (range[1] < 4096)
1121 maxseg = NILFS_SB2_OFFSET_BYTES(range[1]);
1122 if (maxseg < segbytes)
1125 do_div(maxseg, segbytes);
1128 ret = nilfs_sufile_set_alloc_range(nilfs->ns_sufile, minseg, maxseg);
1134 * nilfs_ioctl_get_info - wrapping function of get metadata info
1135 * @inode: inode object
1136 * @filp: file object
1137 * @cmd: ioctl's request code
1138 * @argp: pointer on argument from userspace
1139 * @membsz: size of an item in bytes
1140 * @dofunc: concrete function of getting metadata info
1142 * Description: nilfs_ioctl_get_info() gets metadata info by means of
1143 * calling dofunc() function.
1145 * Return Value: On success, 0 is returned and requested metadata info
1146 * is copied into userspace. On error, one of the following
1147 * negative error codes is returned.
1149 * %-EINVAL - Invalid arguments from userspace.
1151 * %-ENOMEM - Insufficient amount of memory available.
1153 * %-EFAULT - Failure during execution of requested operation.
1155 static int nilfs_ioctl_get_info(struct inode *inode, struct file *filp,
1156 unsigned int cmd, void __user *argp,
1158 ssize_t (*dofunc)(struct the_nilfs *,
1160 void *, size_t, size_t))
1163 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
1164 struct nilfs_argv argv;
1167 if (copy_from_user(&argv, argp, sizeof(argv)))
1170 if (argv.v_size < membsz)
1173 ret = nilfs_ioctl_wrap_copy(nilfs, &argv, _IOC_DIR(cmd), dofunc);
1177 if (copy_to_user(argp, &argv, sizeof(argv)))
1183 * nilfs_ioctl_set_suinfo - set segment usage info
1184 * @inode: inode object
1185 * @filp: file object
1186 * @cmd: ioctl's request code
1187 * @argp: pointer on argument from userspace
1189 * Description: Expects an array of nilfs_suinfo_update structures
1190 * encapsulated in nilfs_argv and updates the segment usage info
1191 * according to the flags in nilfs_suinfo_update.
1193 * Return Value: On success, 0 is returned. On error, one of the
1194 * following negative error codes is returned.
1196 * %-EPERM - Not enough permissions
1198 * %-EFAULT - Error copying input data
1200 * %-EIO - I/O error.
1202 * %-ENOMEM - Insufficient amount of memory available.
1204 * %-EINVAL - Invalid values in input (segment number, flags or nblocks)
1206 static int nilfs_ioctl_set_suinfo(struct inode *inode, struct file *filp,
1207 unsigned int cmd, void __user *argp)
1209 struct the_nilfs *nilfs = inode->i_sb->s_fs_info;
1210 struct nilfs_transaction_info ti;
1211 struct nilfs_argv argv;
1217 if (!capable(CAP_SYS_ADMIN))
1220 ret = mnt_want_write_file(filp);
1225 if (copy_from_user(&argv, argp, sizeof(argv)))
1229 if (argv.v_size < sizeof(struct nilfs_suinfo_update))
1232 if (argv.v_nmembs > nilfs->ns_nsegments)
1235 if (argv.v_nmembs >= UINT_MAX / argv.v_size)
1238 len = argv.v_size * argv.v_nmembs;
1244 base = (void __user *)(unsigned long)argv.v_base;
1245 kbuf = vmalloc(len);
1251 if (copy_from_user(kbuf, base, len)) {
1256 nilfs_transaction_begin(inode->i_sb, &ti, 0);
1257 ret = nilfs_sufile_set_suinfo(nilfs->ns_sufile, kbuf, argv.v_size,
1259 if (unlikely(ret < 0))
1260 nilfs_transaction_abort(inode->i_sb);
1262 nilfs_transaction_commit(inode->i_sb); /* never fails */
1267 mnt_drop_write_file(filp);
1271 long nilfs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
1273 struct inode *inode = file_inode(filp);
1274 void __user *argp = (void __user *)arg;
1277 case FS_IOC_GETVERSION:
1278 return nilfs_ioctl_getversion(inode, argp);
1279 case NILFS_IOCTL_CHANGE_CPMODE:
1280 return nilfs_ioctl_change_cpmode(inode, filp, cmd, argp);
1281 case NILFS_IOCTL_DELETE_CHECKPOINT:
1282 return nilfs_ioctl_delete_checkpoint(inode, filp, cmd, argp);
1283 case NILFS_IOCTL_GET_CPINFO:
1284 return nilfs_ioctl_get_info(inode, filp, cmd, argp,
1285 sizeof(struct nilfs_cpinfo),
1286 nilfs_ioctl_do_get_cpinfo);
1287 case NILFS_IOCTL_GET_CPSTAT:
1288 return nilfs_ioctl_get_cpstat(inode, filp, cmd, argp);
1289 case NILFS_IOCTL_GET_SUINFO:
1290 return nilfs_ioctl_get_info(inode, filp, cmd, argp,
1291 sizeof(struct nilfs_suinfo),
1292 nilfs_ioctl_do_get_suinfo);
1293 case NILFS_IOCTL_SET_SUINFO:
1294 return nilfs_ioctl_set_suinfo(inode, filp, cmd, argp);
1295 case NILFS_IOCTL_GET_SUSTAT:
1296 return nilfs_ioctl_get_sustat(inode, filp, cmd, argp);
1297 case NILFS_IOCTL_GET_VINFO:
1298 return nilfs_ioctl_get_info(inode, filp, cmd, argp,
1299 sizeof(struct nilfs_vinfo),
1300 nilfs_ioctl_do_get_vinfo);
1301 case NILFS_IOCTL_GET_BDESCS:
1302 return nilfs_ioctl_get_bdescs(inode, filp, cmd, argp);
1303 case NILFS_IOCTL_CLEAN_SEGMENTS:
1304 return nilfs_ioctl_clean_segments(inode, filp, cmd, argp);
1305 case NILFS_IOCTL_SYNC:
1306 return nilfs_ioctl_sync(inode, filp, cmd, argp);
1307 case NILFS_IOCTL_RESIZE:
1308 return nilfs_ioctl_resize(inode, filp, argp);
1309 case NILFS_IOCTL_SET_ALLOC_RANGE:
1310 return nilfs_ioctl_set_alloc_range(inode, argp);
1312 return nilfs_ioctl_trim_fs(inode, argp);
1318 #ifdef CONFIG_COMPAT
1319 long nilfs_compat_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
1322 case FS_IOC32_GETVERSION:
1323 cmd = FS_IOC_GETVERSION;
1325 case NILFS_IOCTL_CHANGE_CPMODE:
1326 case NILFS_IOCTL_DELETE_CHECKPOINT:
1327 case NILFS_IOCTL_GET_CPINFO:
1328 case NILFS_IOCTL_GET_CPSTAT:
1329 case NILFS_IOCTL_GET_SUINFO:
1330 case NILFS_IOCTL_SET_SUINFO:
1331 case NILFS_IOCTL_GET_SUSTAT:
1332 case NILFS_IOCTL_GET_VINFO:
1333 case NILFS_IOCTL_GET_BDESCS:
1334 case NILFS_IOCTL_CLEAN_SEGMENTS:
1335 case NILFS_IOCTL_SYNC:
1336 case NILFS_IOCTL_RESIZE:
1337 case NILFS_IOCTL_SET_ALLOC_RANGE:
1341 return -ENOIOCTLCMD;
1343 return nilfs_ioctl(filp, cmd, (unsigned long)compat_ptr(arg));