2 * ioctl.c - NILFS ioctl operations.
4 * Copyright (C) 2007, 2008 Nippon Telegraph and Telephone Corporation.
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * Written by Koji Sato.
20 #include <linux/wait.h>
21 #include <linux/slab.h>
22 #include <linux/capability.h> /* capable() */
23 #include <linux/uaccess.h> /* copy_from_user(), copy_to_user() */
24 #include <linux/vmalloc.h>
25 #include <linux/compat.h> /* compat_ptr() */
26 #include <linux/mount.h> /* mnt_want_write_file(), mnt_drop_write_file() */
27 #include <linux/buffer_head.h>
28 #include <linux/nilfs2_fs.h>
37 * nilfs_ioctl_wrap_copy - wrapping function of get/set metadata info
38 * @nilfs: nilfs object
39 * @argv: vector of arguments from userspace
40 * @dir: set of direction flags
41 * @dofunc: concrete function of get/set metadata info
43 * Description: nilfs_ioctl_wrap_copy() gets/sets metadata info by means of
44 * calling dofunc() function on the basis of @argv argument.
46 * Return Value: On success, 0 is returned and requested metadata info
47 * is copied into userspace. On error, one of the following
48 * negative error codes is returned.
50 * %-EINVAL - Invalid arguments from userspace.
52 * %-ENOMEM - Insufficient amount of memory available.
54 * %-EFAULT - Failure during execution of requested operation.
56 static int nilfs_ioctl_wrap_copy(struct the_nilfs
*nilfs
,
57 struct nilfs_argv
*argv
, int dir
,
58 ssize_t (*dofunc
)(struct the_nilfs
*,
60 void *, size_t, size_t))
63 void __user
*base
= (void __user
*)(unsigned long)argv
->v_base
;
64 size_t maxmembs
, total
, n
;
69 if (argv
->v_nmembs
== 0)
72 if (argv
->v_size
> PAGE_SIZE
)
76 * Reject pairs of a start item position (argv->v_index) and a
77 * total count (argv->v_nmembs) which leads position 'pos' to
78 * overflow by the increment at the end of the loop.
80 if (argv
->v_index
> ~(__u64
)0 - argv
->v_nmembs
)
83 buf
= (void *)__get_free_pages(GFP_NOFS
, 0);
86 maxmembs
= PAGE_SIZE
/ argv
->v_size
;
91 for (i
= 0; i
< argv
->v_nmembs
; i
+= n
) {
92 n
= (argv
->v_nmembs
- i
< maxmembs
) ?
93 argv
->v_nmembs
- i
: maxmembs
;
94 if ((dir
& _IOC_WRITE
) &&
95 copy_from_user(buf
, base
+ argv
->v_size
* i
,
101 nr
= dofunc(nilfs
, &pos
, argv
->v_flags
, buf
, argv
->v_size
,
107 if ((dir
& _IOC_READ
) &&
108 copy_to_user(base
+ argv
->v_size
* i
, buf
,
109 argv
->v_size
* nr
)) {
119 argv
->v_nmembs
= total
;
121 free_pages((unsigned long)buf
, 0);
126 * nilfs_ioctl_getflags - ioctl to support lsattr
128 static int nilfs_ioctl_getflags(struct inode
*inode
, void __user
*argp
)
130 unsigned int flags
= NILFS_I(inode
)->i_flags
& FS_FL_USER_VISIBLE
;
132 return put_user(flags
, (int __user
*)argp
);
136 * nilfs_ioctl_setflags - ioctl to support chattr
138 static int nilfs_ioctl_setflags(struct inode
*inode
, struct file
*filp
,
141 struct nilfs_transaction_info ti
;
142 unsigned int flags
, oldflags
;
145 if (!inode_owner_or_capable(inode
))
148 if (get_user(flags
, (int __user
*)argp
))
151 ret
= mnt_want_write_file(filp
);
155 flags
= nilfs_mask_flags(inode
->i_mode
, flags
);
159 oldflags
= NILFS_I(inode
)->i_flags
;
162 * The IMMUTABLE and APPEND_ONLY flags can only be changed by the
163 * relevant capability.
166 if (((flags
^ oldflags
) & (FS_APPEND_FL
| FS_IMMUTABLE_FL
)) &&
167 !capable(CAP_LINUX_IMMUTABLE
))
170 ret
= nilfs_transaction_begin(inode
->i_sb
, &ti
, 0);
174 NILFS_I(inode
)->i_flags
= (oldflags
& ~FS_FL_USER_MODIFIABLE
) |
175 (flags
& FS_FL_USER_MODIFIABLE
);
177 nilfs_set_inode_flags(inode
);
178 inode
->i_ctime
= CURRENT_TIME
;
180 nilfs_set_transaction_flag(NILFS_TI_SYNC
);
182 nilfs_mark_inode_dirty(inode
);
183 ret
= nilfs_transaction_commit(inode
->i_sb
);
186 mnt_drop_write_file(filp
);
191 * nilfs_ioctl_getversion - get info about a file's version (generation number)
193 static int nilfs_ioctl_getversion(struct inode
*inode
, void __user
*argp
)
195 return put_user(inode
->i_generation
, (int __user
*)argp
);
199 * nilfs_ioctl_change_cpmode - change checkpoint mode (checkpoint/snapshot)
200 * @inode: inode object
202 * @cmd: ioctl's request code
203 * @argp: pointer on argument from userspace
205 * Description: nilfs_ioctl_change_cpmode() function changes mode of
206 * given checkpoint between checkpoint and snapshot state. This ioctl
207 * is used in chcp and mkcp utilities.
209 * Return Value: On success, 0 is returned and mode of a checkpoint is
210 * changed. On error, one of the following negative error codes
213 * %-EPERM - Operation not permitted.
215 * %-EFAULT - Failure during checkpoint mode changing.
217 static int nilfs_ioctl_change_cpmode(struct inode
*inode
, struct file
*filp
,
218 unsigned int cmd
, void __user
*argp
)
220 struct the_nilfs
*nilfs
= inode
->i_sb
->s_fs_info
;
221 struct nilfs_transaction_info ti
;
222 struct nilfs_cpmode cpmode
;
225 if (!capable(CAP_SYS_ADMIN
))
228 ret
= mnt_want_write_file(filp
);
233 if (copy_from_user(&cpmode
, argp
, sizeof(cpmode
)))
236 mutex_lock(&nilfs
->ns_snapshot_mount_mutex
);
238 nilfs_transaction_begin(inode
->i_sb
, &ti
, 0);
239 ret
= nilfs_cpfile_change_cpmode(
240 nilfs
->ns_cpfile
, cpmode
.cm_cno
, cpmode
.cm_mode
);
241 if (unlikely(ret
< 0))
242 nilfs_transaction_abort(inode
->i_sb
);
244 nilfs_transaction_commit(inode
->i_sb
); /* never fails */
246 mutex_unlock(&nilfs
->ns_snapshot_mount_mutex
);
248 mnt_drop_write_file(filp
);
253 * nilfs_ioctl_delete_checkpoint - remove checkpoint
254 * @inode: inode object
256 * @cmd: ioctl's request code
257 * @argp: pointer on argument from userspace
259 * Description: nilfs_ioctl_delete_checkpoint() function removes
260 * checkpoint from NILFS2 file system. This ioctl is used in rmcp
263 * Return Value: On success, 0 is returned and a checkpoint is
264 * removed. On error, one of the following negative error codes
267 * %-EPERM - Operation not permitted.
269 * %-EFAULT - Failure during checkpoint removing.
272 nilfs_ioctl_delete_checkpoint(struct inode
*inode
, struct file
*filp
,
273 unsigned int cmd
, void __user
*argp
)
275 struct the_nilfs
*nilfs
= inode
->i_sb
->s_fs_info
;
276 struct nilfs_transaction_info ti
;
280 if (!capable(CAP_SYS_ADMIN
))
283 ret
= mnt_want_write_file(filp
);
288 if (copy_from_user(&cno
, argp
, sizeof(cno
)))
291 nilfs_transaction_begin(inode
->i_sb
, &ti
, 0);
292 ret
= nilfs_cpfile_delete_checkpoint(nilfs
->ns_cpfile
, cno
);
293 if (unlikely(ret
< 0))
294 nilfs_transaction_abort(inode
->i_sb
);
296 nilfs_transaction_commit(inode
->i_sb
); /* never fails */
298 mnt_drop_write_file(filp
);
303 * nilfs_ioctl_do_get_cpinfo - callback method getting info about checkpoints
304 * @nilfs: nilfs object
305 * @posp: pointer on array of checkpoint's numbers
306 * @flags: checkpoint mode (checkpoint or snapshot)
307 * @buf: buffer for storing checkponts' info
308 * @size: size in bytes of one checkpoint info item in array
309 * @nmembs: number of checkpoints in array (numbers and infos)
311 * Description: nilfs_ioctl_do_get_cpinfo() function returns info about
312 * requested checkpoints. The NILFS_IOCTL_GET_CPINFO ioctl is used in
313 * lscp utility and by nilfs_cleanerd daemon.
315 * Return value: count of nilfs_cpinfo structures in output buffer.
318 nilfs_ioctl_do_get_cpinfo(struct the_nilfs
*nilfs
, __u64
*posp
, int flags
,
319 void *buf
, size_t size
, size_t nmembs
)
323 down_read(&nilfs
->ns_segctor_sem
);
324 ret
= nilfs_cpfile_get_cpinfo(nilfs
->ns_cpfile
, posp
, flags
, buf
,
326 up_read(&nilfs
->ns_segctor_sem
);
331 * nilfs_ioctl_get_cpstat - get checkpoints statistics
332 * @inode: inode object
334 * @cmd: ioctl's request code
335 * @argp: pointer on argument from userspace
337 * Description: nilfs_ioctl_get_cpstat() returns information about checkpoints.
338 * The NILFS_IOCTL_GET_CPSTAT ioctl is used by lscp, rmcp utilities
339 * and by nilfs_cleanerd daemon.
341 * Return Value: On success, 0 is returned, and checkpoints information is
342 * copied into userspace pointer @argp. On error, one of the following
343 * negative error codes is returned.
347 * %-ENOMEM - Insufficient amount of memory available.
349 * %-EFAULT - Failure during getting checkpoints statistics.
351 static int nilfs_ioctl_get_cpstat(struct inode
*inode
, struct file
*filp
,
352 unsigned int cmd
, void __user
*argp
)
354 struct the_nilfs
*nilfs
= inode
->i_sb
->s_fs_info
;
355 struct nilfs_cpstat cpstat
;
358 down_read(&nilfs
->ns_segctor_sem
);
359 ret
= nilfs_cpfile_get_stat(nilfs
->ns_cpfile
, &cpstat
);
360 up_read(&nilfs
->ns_segctor_sem
);
364 if (copy_to_user(argp
, &cpstat
, sizeof(cpstat
)))
370 * nilfs_ioctl_do_get_suinfo - callback method getting segment usage info
371 * @nilfs: nilfs object
372 * @posp: pointer on array of segment numbers
374 * @buf: buffer for storing suinfo array
375 * @size: size in bytes of one suinfo item in array
376 * @nmembs: count of segment numbers and suinfos in array
378 * Description: nilfs_ioctl_do_get_suinfo() function returns segment usage
379 * info about requested segments. The NILFS_IOCTL_GET_SUINFO ioctl is used
380 * in lssu, nilfs_resize utilities and by nilfs_cleanerd daemon.
382 * Return value: count of nilfs_suinfo structures in output buffer.
385 nilfs_ioctl_do_get_suinfo(struct the_nilfs
*nilfs
, __u64
*posp
, int flags
,
386 void *buf
, size_t size
, size_t nmembs
)
390 down_read(&nilfs
->ns_segctor_sem
);
391 ret
= nilfs_sufile_get_suinfo(nilfs
->ns_sufile
, *posp
, buf
, size
,
393 up_read(&nilfs
->ns_segctor_sem
);
398 * nilfs_ioctl_get_sustat - get segment usage statistics
399 * @inode: inode object
401 * @cmd: ioctl's request code
402 * @argp: pointer on argument from userspace
404 * Description: nilfs_ioctl_get_sustat() returns segment usage statistics.
405 * The NILFS_IOCTL_GET_SUSTAT ioctl is used in lssu, nilfs_resize utilities
406 * and by nilfs_cleanerd daemon.
408 * Return Value: On success, 0 is returned, and segment usage information is
409 * copied into userspace pointer @argp. On error, one of the following
410 * negative error codes is returned.
414 * %-ENOMEM - Insufficient amount of memory available.
416 * %-EFAULT - Failure during getting segment usage statistics.
418 static int nilfs_ioctl_get_sustat(struct inode
*inode
, struct file
*filp
,
419 unsigned int cmd
, void __user
*argp
)
421 struct the_nilfs
*nilfs
= inode
->i_sb
->s_fs_info
;
422 struct nilfs_sustat sustat
;
425 down_read(&nilfs
->ns_segctor_sem
);
426 ret
= nilfs_sufile_get_stat(nilfs
->ns_sufile
, &sustat
);
427 up_read(&nilfs
->ns_segctor_sem
);
431 if (copy_to_user(argp
, &sustat
, sizeof(sustat
)))
437 * nilfs_ioctl_do_get_vinfo - callback method getting virtual blocks info
438 * @nilfs: nilfs object
441 * @buf: buffer for storing array of nilfs_vinfo structures
442 * @size: size in bytes of one vinfo item in array
443 * @nmembs: count of vinfos in array
445 * Description: nilfs_ioctl_do_get_vinfo() function returns information
446 * on virtual block addresses. The NILFS_IOCTL_GET_VINFO ioctl is used
447 * by nilfs_cleanerd daemon.
449 * Return value: count of nilfs_vinfo structures in output buffer.
452 nilfs_ioctl_do_get_vinfo(struct the_nilfs
*nilfs
, __u64
*posp
, int flags
,
453 void *buf
, size_t size
, size_t nmembs
)
457 down_read(&nilfs
->ns_segctor_sem
);
458 ret
= nilfs_dat_get_vinfo(nilfs
->ns_dat
, buf
, size
, nmembs
);
459 up_read(&nilfs
->ns_segctor_sem
);
464 * nilfs_ioctl_do_get_bdescs - callback method getting disk block descriptors
465 * @nilfs: nilfs object
468 * @buf: buffer for storing array of nilfs_bdesc structures
469 * @size: size in bytes of one bdesc item in array
470 * @nmembs: count of bdescs in array
472 * Description: nilfs_ioctl_do_get_bdescs() function returns information
473 * about descriptors of disk block numbers. The NILFS_IOCTL_GET_BDESCS ioctl
474 * is used by nilfs_cleanerd daemon.
476 * Return value: count of nilfs_bdescs structures in output buffer.
479 nilfs_ioctl_do_get_bdescs(struct the_nilfs
*nilfs
, __u64
*posp
, int flags
,
480 void *buf
, size_t size
, size_t nmembs
)
482 struct nilfs_bmap
*bmap
= NILFS_I(nilfs
->ns_dat
)->i_bmap
;
483 struct nilfs_bdesc
*bdescs
= buf
;
486 down_read(&nilfs
->ns_segctor_sem
);
487 for (i
= 0; i
< nmembs
; i
++) {
488 ret
= nilfs_bmap_lookup_at_level(bmap
,
490 bdescs
[i
].bd_level
+ 1,
491 &bdescs
[i
].bd_blocknr
);
493 if (ret
!= -ENOENT
) {
494 up_read(&nilfs
->ns_segctor_sem
);
497 bdescs
[i
].bd_blocknr
= 0;
500 up_read(&nilfs
->ns_segctor_sem
);
505 * nilfs_ioctl_get_bdescs - get disk block descriptors
506 * @inode: inode object
508 * @cmd: ioctl's request code
509 * @argp: pointer on argument from userspace
511 * Description: nilfs_ioctl_do_get_bdescs() function returns information
512 * about descriptors of disk block numbers. The NILFS_IOCTL_GET_BDESCS ioctl
513 * is used by nilfs_cleanerd daemon.
515 * Return Value: On success, 0 is returned, and disk block descriptors are
516 * copied into userspace pointer @argp. On error, one of the following
517 * negative error codes is returned.
519 * %-EINVAL - Invalid arguments from userspace.
523 * %-ENOMEM - Insufficient amount of memory available.
525 * %-EFAULT - Failure during getting disk block descriptors.
527 static int nilfs_ioctl_get_bdescs(struct inode
*inode
, struct file
*filp
,
528 unsigned int cmd
, void __user
*argp
)
530 struct the_nilfs
*nilfs
= inode
->i_sb
->s_fs_info
;
531 struct nilfs_argv argv
;
534 if (copy_from_user(&argv
, argp
, sizeof(argv
)))
537 if (argv
.v_size
!= sizeof(struct nilfs_bdesc
))
540 ret
= nilfs_ioctl_wrap_copy(nilfs
, &argv
, _IOC_DIR(cmd
),
541 nilfs_ioctl_do_get_bdescs
);
545 if (copy_to_user(argp
, &argv
, sizeof(argv
)))
551 * nilfs_ioctl_move_inode_block - prepare data/node block for moving by GC
552 * @inode: inode object
553 * @vdesc: descriptor of virtual block number
554 * @buffers: list of moving buffers
556 * Description: nilfs_ioctl_move_inode_block() function registers data/node
557 * buffer in the GC pagecache and submit read request.
559 * Return Value: On success, 0 is returned. On error, one of the following
560 * negative error codes is returned.
564 * %-ENOMEM - Insufficient amount of memory available.
566 * %-ENOENT - Requested block doesn't exist.
568 * %-EEXIST - Blocks conflict is detected.
570 static int nilfs_ioctl_move_inode_block(struct inode
*inode
,
571 struct nilfs_vdesc
*vdesc
,
572 struct list_head
*buffers
)
574 struct buffer_head
*bh
;
577 if (vdesc
->vd_flags
== 0)
578 ret
= nilfs_gccache_submit_read_data(
579 inode
, vdesc
->vd_offset
, vdesc
->vd_blocknr
,
580 vdesc
->vd_vblocknr
, &bh
);
582 ret
= nilfs_gccache_submit_read_node(
583 inode
, vdesc
->vd_blocknr
, vdesc
->vd_vblocknr
, &bh
);
585 if (unlikely(ret
< 0)) {
587 nilfs_msg(inode
->i_sb
, KERN_CRIT
,
588 "%s: invalid virtual block address (%s): ino=%llu, cno=%llu, offset=%llu, blocknr=%llu, vblocknr=%llu",
589 __func__
, vdesc
->vd_flags
? "node" : "data",
590 (unsigned long long)vdesc
->vd_ino
,
591 (unsigned long long)vdesc
->vd_cno
,
592 (unsigned long long)vdesc
->vd_offset
,
593 (unsigned long long)vdesc
->vd_blocknr
,
594 (unsigned long long)vdesc
->vd_vblocknr
);
597 if (unlikely(!list_empty(&bh
->b_assoc_buffers
))) {
598 nilfs_msg(inode
->i_sb
, KERN_CRIT
,
599 "%s: conflicting %s buffer: ino=%llu, cno=%llu, offset=%llu, blocknr=%llu, vblocknr=%llu",
600 __func__
, vdesc
->vd_flags
? "node" : "data",
601 (unsigned long long)vdesc
->vd_ino
,
602 (unsigned long long)vdesc
->vd_cno
,
603 (unsigned long long)vdesc
->vd_offset
,
604 (unsigned long long)vdesc
->vd_blocknr
,
605 (unsigned long long)vdesc
->vd_vblocknr
);
609 list_add_tail(&bh
->b_assoc_buffers
, buffers
);
614 * nilfs_ioctl_move_blocks - move valid inode's blocks during garbage collection
615 * @sb: superblock object
616 * @argv: vector of arguments from userspace
617 * @buf: array of nilfs_vdesc structures
619 * Description: nilfs_ioctl_move_blocks() function reads valid data/node
620 * blocks that garbage collector specified with the array of nilfs_vdesc
621 * structures and stores them into page caches of GC inodes.
623 * Return Value: Number of processed nilfs_vdesc structures or
624 * error code, otherwise.
626 static int nilfs_ioctl_move_blocks(struct super_block
*sb
,
627 struct nilfs_argv
*argv
, void *buf
)
629 size_t nmembs
= argv
->v_nmembs
;
630 struct the_nilfs
*nilfs
= sb
->s_fs_info
;
632 struct nilfs_vdesc
*vdesc
;
633 struct buffer_head
*bh
, *n
;
639 for (i
= 0, vdesc
= buf
; i
< nmembs
; ) {
642 inode
= nilfs_iget_for_gc(sb
, ino
, cno
);
644 ret
= PTR_ERR(inode
);
647 if (list_empty(&NILFS_I(inode
)->i_dirty
)) {
649 * Add the inode to GC inode list. Garbage Collection
650 * is serialized and no two processes manipulate the
651 * list simultaneously.
654 list_add(&NILFS_I(inode
)->i_dirty
,
655 &nilfs
->ns_gc_inodes
);
659 ret
= nilfs_ioctl_move_inode_block(inode
, vdesc
,
661 if (unlikely(ret
< 0)) {
666 } while (++i
< nmembs
&&
667 vdesc
->vd_ino
== ino
&& vdesc
->vd_cno
== cno
);
669 iput(inode
); /* The inode still remains in GC inode list */
672 list_for_each_entry_safe(bh
, n
, &buffers
, b_assoc_buffers
) {
673 ret
= nilfs_gccache_wait_and_mark_dirty(bh
);
674 if (unlikely(ret
< 0)) {
675 WARN_ON(ret
== -EEXIST
);
678 list_del_init(&bh
->b_assoc_buffers
);
684 list_for_each_entry_safe(bh
, n
, &buffers
, b_assoc_buffers
) {
685 list_del_init(&bh
->b_assoc_buffers
);
692 * nilfs_ioctl_delete_checkpoints - delete checkpoints
693 * @nilfs: nilfs object
694 * @argv: vector of arguments from userspace
695 * @buf: array of periods of checkpoints numbers
697 * Description: nilfs_ioctl_delete_checkpoints() function deletes checkpoints
698 * in the period from p_start to p_end, excluding p_end itself. The checkpoints
699 * which have been already deleted are ignored.
701 * Return Value: Number of processed nilfs_period structures or
702 * error code, otherwise.
706 * %-ENOMEM - Insufficient amount of memory available.
708 * %-EINVAL - invalid checkpoints.
710 static int nilfs_ioctl_delete_checkpoints(struct the_nilfs
*nilfs
,
711 struct nilfs_argv
*argv
, void *buf
)
713 size_t nmembs
= argv
->v_nmembs
;
714 struct inode
*cpfile
= nilfs
->ns_cpfile
;
715 struct nilfs_period
*periods
= buf
;
718 for (i
= 0; i
< nmembs
; i
++) {
719 ret
= nilfs_cpfile_delete_checkpoints(
720 cpfile
, periods
[i
].p_start
, periods
[i
].p_end
);
728 * nilfs_ioctl_free_vblocknrs - free virtual block numbers
729 * @nilfs: nilfs object
730 * @argv: vector of arguments from userspace
731 * @buf: array of virtual block numbers
733 * Description: nilfs_ioctl_free_vblocknrs() function frees
734 * the virtual block numbers specified by @buf and @argv->v_nmembs.
736 * Return Value: Number of processed virtual block numbers or
737 * error code, otherwise.
741 * %-ENOMEM - Insufficient amount of memory available.
743 * %-ENOENT - The virtual block number have not been allocated.
745 static int nilfs_ioctl_free_vblocknrs(struct the_nilfs
*nilfs
,
746 struct nilfs_argv
*argv
, void *buf
)
748 size_t nmembs
= argv
->v_nmembs
;
751 ret
= nilfs_dat_freev(nilfs
->ns_dat
, buf
, nmembs
);
753 return (ret
< 0) ? ret
: nmembs
;
757 * nilfs_ioctl_mark_blocks_dirty - mark blocks dirty
758 * @nilfs: nilfs object
759 * @argv: vector of arguments from userspace
760 * @buf: array of block descriptors
762 * Description: nilfs_ioctl_mark_blocks_dirty() function marks
763 * metadata file or data blocks as dirty.
765 * Return Value: Number of processed block descriptors or
766 * error code, otherwise.
768 * %-ENOMEM - Insufficient memory available.
772 * %-ENOENT - the specified block does not exist (hole block)
774 static int nilfs_ioctl_mark_blocks_dirty(struct the_nilfs
*nilfs
,
775 struct nilfs_argv
*argv
, void *buf
)
777 size_t nmembs
= argv
->v_nmembs
;
778 struct nilfs_bmap
*bmap
= NILFS_I(nilfs
->ns_dat
)->i_bmap
;
779 struct nilfs_bdesc
*bdescs
= buf
;
780 struct buffer_head
*bh
;
783 for (i
= 0; i
< nmembs
; i
++) {
784 /* XXX: use macro or inline func to check liveness */
785 ret
= nilfs_bmap_lookup_at_level(bmap
,
787 bdescs
[i
].bd_level
+ 1,
788 &bdescs
[i
].bd_blocknr
);
792 bdescs
[i
].bd_blocknr
= 0;
794 if (bdescs
[i
].bd_blocknr
!= bdescs
[i
].bd_oblocknr
)
795 /* skip dead block */
797 if (bdescs
[i
].bd_level
== 0) {
798 ret
= nilfs_mdt_get_block(nilfs
->ns_dat
,
802 WARN_ON(ret
== -ENOENT
);
805 mark_buffer_dirty(bh
);
806 nilfs_mdt_mark_dirty(nilfs
->ns_dat
);
809 ret
= nilfs_bmap_mark(bmap
, bdescs
[i
].bd_offset
,
812 WARN_ON(ret
== -ENOENT
);
820 int nilfs_ioctl_prepare_clean_segments(struct the_nilfs
*nilfs
,
821 struct nilfs_argv
*argv
, void **kbufs
)
826 ret
= nilfs_ioctl_delete_checkpoints(nilfs
, &argv
[1], kbufs
[1]);
829 * can safely abort because checkpoints can be removed
832 msg
= "cannot delete checkpoints";
835 ret
= nilfs_ioctl_free_vblocknrs(nilfs
, &argv
[2], kbufs
[2]);
838 * can safely abort because DAT file is updated atomically
839 * using a copy-on-write technique.
841 msg
= "cannot delete virtual blocks from DAT file";
844 ret
= nilfs_ioctl_mark_blocks_dirty(nilfs
, &argv
[3], kbufs
[3]);
847 * can safely abort because the operation is nondestructive.
849 msg
= "cannot mark copying blocks dirty";
855 nilfs_msg(nilfs
->ns_sb
, KERN_ERR
, "error %d preparing GC: %s", ret
,
861 * nilfs_ioctl_clean_segments - clean segments
862 * @inode: inode object
864 * @cmd: ioctl's request code
865 * @argp: pointer on argument from userspace
867 * Description: nilfs_ioctl_clean_segments() function makes garbage
868 * collection operation in the environment of requested parameters
869 * from userspace. The NILFS_IOCTL_CLEAN_SEGMENTS ioctl is used by
870 * nilfs_cleanerd daemon.
872 * Return Value: On success, 0 is returned or error code, otherwise.
874 static int nilfs_ioctl_clean_segments(struct inode
*inode
, struct file
*filp
,
875 unsigned int cmd
, void __user
*argp
)
877 struct nilfs_argv argv
[5];
878 static const size_t argsz
[5] = {
879 sizeof(struct nilfs_vdesc
),
880 sizeof(struct nilfs_period
),
882 sizeof(struct nilfs_bdesc
),
887 struct the_nilfs
*nilfs
;
891 if (!capable(CAP_SYS_ADMIN
))
894 ret
= mnt_want_write_file(filp
);
899 if (copy_from_user(argv
, argp
, sizeof(argv
)))
903 nsegs
= argv
[4].v_nmembs
;
904 if (argv
[4].v_size
!= argsz
[4])
906 if (nsegs
> UINT_MAX
/ sizeof(__u64
))
910 * argv[4] points to segment numbers this ioctl cleans. We
911 * use kmalloc() for its buffer because memory used for the
912 * segment numbers is enough small.
914 kbufs
[4] = memdup_user((void __user
*)(unsigned long)argv
[4].v_base
,
915 nsegs
* sizeof(__u64
));
916 if (IS_ERR(kbufs
[4])) {
917 ret
= PTR_ERR(kbufs
[4]);
920 nilfs
= inode
->i_sb
->s_fs_info
;
922 for (n
= 0; n
< 4; n
++) {
924 if (argv
[n
].v_size
!= argsz
[n
])
927 if (argv
[n
].v_nmembs
> nsegs
* nilfs
->ns_blocks_per_segment
)
930 if (argv
[n
].v_nmembs
>= UINT_MAX
/ argv
[n
].v_size
)
933 len
= argv
[n
].v_size
* argv
[n
].v_nmembs
;
934 base
= (void __user
*)(unsigned long)argv
[n
].v_base
;
940 kbufs
[n
] = vmalloc(len
);
945 if (copy_from_user(kbufs
[n
], base
, len
)) {
953 * nilfs_ioctl_move_blocks() will call nilfs_iget_for_gc(),
954 * which will operates an inode list without blocking.
955 * To protect the list from concurrent operations,
956 * nilfs_ioctl_move_blocks should be atomic operation.
958 if (test_and_set_bit(THE_NILFS_GC_RUNNING
, &nilfs
->ns_flags
)) {
963 ret
= nilfs_ioctl_move_blocks(inode
->i_sb
, &argv
[0], kbufs
[0]);
965 nilfs_msg(inode
->i_sb
, KERN_ERR
,
966 "error %d preparing GC: cannot read source blocks",
969 if (nilfs_sb_need_update(nilfs
))
970 set_nilfs_discontinued(nilfs
);
971 ret
= nilfs_clean_segments(inode
->i_sb
, argv
, kbufs
);
974 nilfs_remove_all_gcinodes(nilfs
);
975 clear_nilfs_gc_running(nilfs
);
982 mnt_drop_write_file(filp
);
987 * nilfs_ioctl_sync - make a checkpoint
988 * @inode: inode object
990 * @cmd: ioctl's request code
991 * @argp: pointer on argument from userspace
993 * Description: nilfs_ioctl_sync() function constructs a logical segment
994 * for checkpointing. This function guarantees that all modified data
995 * and metadata are written out to the device when it successfully
998 * Return Value: On success, 0 is retured. On errors, one of the following
999 * negative error code is returned.
1001 * %-EROFS - Read only filesystem.
1005 * %-ENOSPC - No space left on device (only in a panic state).
1007 * %-ERESTARTSYS - Interrupted.
1009 * %-ENOMEM - Insufficient memory available.
1011 * %-EFAULT - Failure during execution of requested operation.
1013 static int nilfs_ioctl_sync(struct inode
*inode
, struct file
*filp
,
1014 unsigned int cmd
, void __user
*argp
)
1018 struct the_nilfs
*nilfs
;
1020 ret
= nilfs_construct_segment(inode
->i_sb
);
1024 nilfs
= inode
->i_sb
->s_fs_info
;
1025 ret
= nilfs_flush_device(nilfs
);
1030 down_read(&nilfs
->ns_segctor_sem
);
1031 cno
= nilfs
->ns_cno
- 1;
1032 up_read(&nilfs
->ns_segctor_sem
);
1033 if (copy_to_user(argp
, &cno
, sizeof(cno
)))
1040 * nilfs_ioctl_resize - resize NILFS2 volume
1041 * @inode: inode object
1042 * @filp: file object
1043 * @argp: pointer on argument from userspace
1045 * Return Value: On success, 0 is returned or error code, otherwise.
1047 static int nilfs_ioctl_resize(struct inode
*inode
, struct file
*filp
,
1053 if (!capable(CAP_SYS_ADMIN
))
1056 ret
= mnt_want_write_file(filp
);
1061 if (copy_from_user(&newsize
, argp
, sizeof(newsize
)))
1062 goto out_drop_write
;
1064 ret
= nilfs_resize_fs(inode
->i_sb
, newsize
);
1067 mnt_drop_write_file(filp
);
1073 * nilfs_ioctl_trim_fs() - trim ioctl handle function
1074 * @inode: inode object
1075 * @argp: pointer on argument from userspace
1077 * Decription: nilfs_ioctl_trim_fs is the FITRIM ioctl handle function. It
1078 * checks the arguments from userspace and calls nilfs_sufile_trim_fs, which
1079 * performs the actual trim operation.
1081 * Return Value: On success, 0 is returned or negative error code, otherwise.
1083 static int nilfs_ioctl_trim_fs(struct inode
*inode
, void __user
*argp
)
1085 struct the_nilfs
*nilfs
= inode
->i_sb
->s_fs_info
;
1086 struct request_queue
*q
= bdev_get_queue(nilfs
->ns_bdev
);
1087 struct fstrim_range range
;
1090 if (!capable(CAP_SYS_ADMIN
))
1093 if (!blk_queue_discard(q
))
1096 if (copy_from_user(&range
, argp
, sizeof(range
)))
1099 range
.minlen
= max_t(u64
, range
.minlen
, q
->limits
.discard_granularity
);
1101 down_read(&nilfs
->ns_segctor_sem
);
1102 ret
= nilfs_sufile_trim_fs(nilfs
->ns_sufile
, &range
);
1103 up_read(&nilfs
->ns_segctor_sem
);
1108 if (copy_to_user(argp
, &range
, sizeof(range
)))
1115 * nilfs_ioctl_set_alloc_range - limit range of segments to be allocated
1116 * @inode: inode object
1117 * @argp: pointer on argument from userspace
1119 * Decription: nilfs_ioctl_set_alloc_range() function defines lower limit
1120 * of segments in bytes and upper limit of segments in bytes.
1121 * The NILFS_IOCTL_SET_ALLOC_RANGE is used by nilfs_resize utility.
1123 * Return Value: On success, 0 is returned or error code, otherwise.
1125 static int nilfs_ioctl_set_alloc_range(struct inode
*inode
, void __user
*argp
)
1127 struct the_nilfs
*nilfs
= inode
->i_sb
->s_fs_info
;
1129 __u64 minseg
, maxseg
;
1130 unsigned long segbytes
;
1133 if (!capable(CAP_SYS_ADMIN
))
1137 if (copy_from_user(range
, argp
, sizeof(__u64
[2])))
1141 if (range
[1] > i_size_read(inode
->i_sb
->s_bdev
->bd_inode
))
1144 segbytes
= nilfs
->ns_blocks_per_segment
* nilfs
->ns_blocksize
;
1146 minseg
= range
[0] + segbytes
- 1;
1147 do_div(minseg
, segbytes
);
1148 maxseg
= NILFS_SB2_OFFSET_BYTES(range
[1]);
1149 do_div(maxseg
, segbytes
);
1152 ret
= nilfs_sufile_set_alloc_range(nilfs
->ns_sufile
, minseg
, maxseg
);
1158 * nilfs_ioctl_get_info - wrapping function of get metadata info
1159 * @inode: inode object
1160 * @filp: file object
1161 * @cmd: ioctl's request code
1162 * @argp: pointer on argument from userspace
1163 * @membsz: size of an item in bytes
1164 * @dofunc: concrete function of getting metadata info
1166 * Description: nilfs_ioctl_get_info() gets metadata info by means of
1167 * calling dofunc() function.
1169 * Return Value: On success, 0 is returned and requested metadata info
1170 * is copied into userspace. On error, one of the following
1171 * negative error codes is returned.
1173 * %-EINVAL - Invalid arguments from userspace.
1175 * %-ENOMEM - Insufficient amount of memory available.
1177 * %-EFAULT - Failure during execution of requested operation.
1179 static int nilfs_ioctl_get_info(struct inode
*inode
, struct file
*filp
,
1180 unsigned int cmd
, void __user
*argp
,
1182 ssize_t (*dofunc
)(struct the_nilfs
*,
1184 void *, size_t, size_t))
1187 struct the_nilfs
*nilfs
= inode
->i_sb
->s_fs_info
;
1188 struct nilfs_argv argv
;
1191 if (copy_from_user(&argv
, argp
, sizeof(argv
)))
1194 if (argv
.v_size
< membsz
)
1197 ret
= nilfs_ioctl_wrap_copy(nilfs
, &argv
, _IOC_DIR(cmd
), dofunc
);
1201 if (copy_to_user(argp
, &argv
, sizeof(argv
)))
1207 * nilfs_ioctl_set_suinfo - set segment usage info
1208 * @inode: inode object
1209 * @filp: file object
1210 * @cmd: ioctl's request code
1211 * @argp: pointer on argument from userspace
1213 * Description: Expects an array of nilfs_suinfo_update structures
1214 * encapsulated in nilfs_argv and updates the segment usage info
1215 * according to the flags in nilfs_suinfo_update.
1217 * Return Value: On success, 0 is returned. On error, one of the
1218 * following negative error codes is returned.
1220 * %-EPERM - Not enough permissions
1222 * %-EFAULT - Error copying input data
1224 * %-EIO - I/O error.
1226 * %-ENOMEM - Insufficient amount of memory available.
1228 * %-EINVAL - Invalid values in input (segment number, flags or nblocks)
1230 static int nilfs_ioctl_set_suinfo(struct inode
*inode
, struct file
*filp
,
1231 unsigned int cmd
, void __user
*argp
)
1233 struct the_nilfs
*nilfs
= inode
->i_sb
->s_fs_info
;
1234 struct nilfs_transaction_info ti
;
1235 struct nilfs_argv argv
;
1241 if (!capable(CAP_SYS_ADMIN
))
1244 ret
= mnt_want_write_file(filp
);
1249 if (copy_from_user(&argv
, argp
, sizeof(argv
)))
1253 if (argv
.v_size
< sizeof(struct nilfs_suinfo_update
))
1256 if (argv
.v_nmembs
> nilfs
->ns_nsegments
)
1259 if (argv
.v_nmembs
>= UINT_MAX
/ argv
.v_size
)
1262 len
= argv
.v_size
* argv
.v_nmembs
;
1268 base
= (void __user
*)(unsigned long)argv
.v_base
;
1269 kbuf
= vmalloc(len
);
1275 if (copy_from_user(kbuf
, base
, len
)) {
1280 nilfs_transaction_begin(inode
->i_sb
, &ti
, 0);
1281 ret
= nilfs_sufile_set_suinfo(nilfs
->ns_sufile
, kbuf
, argv
.v_size
,
1283 if (unlikely(ret
< 0))
1284 nilfs_transaction_abort(inode
->i_sb
);
1286 nilfs_transaction_commit(inode
->i_sb
); /* never fails */
1291 mnt_drop_write_file(filp
);
1295 long nilfs_ioctl(struct file
*filp
, unsigned int cmd
, unsigned long arg
)
1297 struct inode
*inode
= file_inode(filp
);
1298 void __user
*argp
= (void __user
*)arg
;
1301 case FS_IOC_GETFLAGS
:
1302 return nilfs_ioctl_getflags(inode
, argp
);
1303 case FS_IOC_SETFLAGS
:
1304 return nilfs_ioctl_setflags(inode
, filp
, argp
);
1305 case FS_IOC_GETVERSION
:
1306 return nilfs_ioctl_getversion(inode
, argp
);
1307 case NILFS_IOCTL_CHANGE_CPMODE
:
1308 return nilfs_ioctl_change_cpmode(inode
, filp
, cmd
, argp
);
1309 case NILFS_IOCTL_DELETE_CHECKPOINT
:
1310 return nilfs_ioctl_delete_checkpoint(inode
, filp
, cmd
, argp
);
1311 case NILFS_IOCTL_GET_CPINFO
:
1312 return nilfs_ioctl_get_info(inode
, filp
, cmd
, argp
,
1313 sizeof(struct nilfs_cpinfo
),
1314 nilfs_ioctl_do_get_cpinfo
);
1315 case NILFS_IOCTL_GET_CPSTAT
:
1316 return nilfs_ioctl_get_cpstat(inode
, filp
, cmd
, argp
);
1317 case NILFS_IOCTL_GET_SUINFO
:
1318 return nilfs_ioctl_get_info(inode
, filp
, cmd
, argp
,
1319 sizeof(struct nilfs_suinfo
),
1320 nilfs_ioctl_do_get_suinfo
);
1321 case NILFS_IOCTL_SET_SUINFO
:
1322 return nilfs_ioctl_set_suinfo(inode
, filp
, cmd
, argp
);
1323 case NILFS_IOCTL_GET_SUSTAT
:
1324 return nilfs_ioctl_get_sustat(inode
, filp
, cmd
, argp
);
1325 case NILFS_IOCTL_GET_VINFO
:
1326 return nilfs_ioctl_get_info(inode
, filp
, cmd
, argp
,
1327 sizeof(struct nilfs_vinfo
),
1328 nilfs_ioctl_do_get_vinfo
);
1329 case NILFS_IOCTL_GET_BDESCS
:
1330 return nilfs_ioctl_get_bdescs(inode
, filp
, cmd
, argp
);
1331 case NILFS_IOCTL_CLEAN_SEGMENTS
:
1332 return nilfs_ioctl_clean_segments(inode
, filp
, cmd
, argp
);
1333 case NILFS_IOCTL_SYNC
:
1334 return nilfs_ioctl_sync(inode
, filp
, cmd
, argp
);
1335 case NILFS_IOCTL_RESIZE
:
1336 return nilfs_ioctl_resize(inode
, filp
, argp
);
1337 case NILFS_IOCTL_SET_ALLOC_RANGE
:
1338 return nilfs_ioctl_set_alloc_range(inode
, argp
);
1340 return nilfs_ioctl_trim_fs(inode
, argp
);
1346 #ifdef CONFIG_COMPAT
1347 long nilfs_compat_ioctl(struct file
*filp
, unsigned int cmd
, unsigned long arg
)
1350 case FS_IOC32_GETFLAGS
:
1351 cmd
= FS_IOC_GETFLAGS
;
1353 case FS_IOC32_SETFLAGS
:
1354 cmd
= FS_IOC_SETFLAGS
;
1356 case FS_IOC32_GETVERSION
:
1357 cmd
= FS_IOC_GETVERSION
;
1359 case NILFS_IOCTL_CHANGE_CPMODE
:
1360 case NILFS_IOCTL_DELETE_CHECKPOINT
:
1361 case NILFS_IOCTL_GET_CPINFO
:
1362 case NILFS_IOCTL_GET_CPSTAT
:
1363 case NILFS_IOCTL_GET_SUINFO
:
1364 case NILFS_IOCTL_SET_SUINFO
:
1365 case NILFS_IOCTL_GET_SUSTAT
:
1366 case NILFS_IOCTL_GET_VINFO
:
1367 case NILFS_IOCTL_GET_BDESCS
:
1368 case NILFS_IOCTL_CLEAN_SEGMENTS
:
1369 case NILFS_IOCTL_SYNC
:
1370 case NILFS_IOCTL_RESIZE
:
1371 case NILFS_IOCTL_SET_ALLOC_RANGE
:
1374 return -ENOIOCTLCMD
;
1376 return nilfs_ioctl(filp
, cmd
, (unsigned long)compat_ptr(arg
));