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 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
20 * Written by Koji Sato <koji@osrg.net>.
24 #include <linux/wait.h>
25 #include <linux/smp_lock.h> /* lock_kernel(), unlock_kernel() */
26 #include <linux/capability.h> /* capable() */
27 #include <linux/uaccess.h> /* copy_from_user(), copy_to_user() */
28 #include <linux/vmalloc.h>
29 #include <linux/nilfs2_fs.h>
38 static int nilfs_ioctl_wrap_copy(struct the_nilfs *nilfs,
39 struct nilfs_argv *argv, int dir,
40 ssize_t (*dofunc)(struct the_nilfs *,
42 void *, size_t, size_t))
45 void __user *base = (void __user *)(unsigned long)argv->v_base;
46 size_t maxmembs, total, n;
51 if (argv->v_nmembs == 0)
54 if (argv->v_size > PAGE_SIZE)
57 buf = (void *)__get_free_pages(GFP_NOFS, 0);
60 maxmembs = PAGE_SIZE / argv->v_size;
65 for (i = 0; i < argv->v_nmembs; i += n) {
66 n = (argv->v_nmembs - i < maxmembs) ?
67 argv->v_nmembs - i : maxmembs;
68 if ((dir & _IOC_WRITE) &&
69 copy_from_user(buf, base + argv->v_size * i,
75 nr = dofunc(nilfs, &pos, argv->v_flags, buf, argv->v_size,
81 if ((dir & _IOC_READ) &&
82 copy_to_user(base + argv->v_size * i, buf,
93 argv->v_nmembs = total;
95 free_pages((unsigned long)buf, 0);
99 static int nilfs_ioctl_change_cpmode(struct inode *inode, struct file *filp,
100 unsigned int cmd, void __user *argp)
102 struct inode *cpfile = NILFS_SB(inode->i_sb)->s_nilfs->ns_cpfile;
103 struct nilfs_transaction_info ti;
104 struct nilfs_cpmode cpmode;
107 if (!capable(CAP_SYS_ADMIN))
109 if (copy_from_user(&cpmode, argp, sizeof(cpmode)))
112 nilfs_transaction_begin(inode->i_sb, &ti, 0);
113 ret = nilfs_cpfile_change_cpmode(
114 cpfile, cpmode.cm_cno, cpmode.cm_mode);
115 if (unlikely(ret < 0)) {
116 nilfs_transaction_abort(inode->i_sb);
119 nilfs_transaction_commit(inode->i_sb); /* never fails */
124 nilfs_ioctl_delete_checkpoint(struct inode *inode, struct file *filp,
125 unsigned int cmd, void __user *argp)
127 struct inode *cpfile = NILFS_SB(inode->i_sb)->s_nilfs->ns_cpfile;
128 struct nilfs_transaction_info ti;
132 if (!capable(CAP_SYS_ADMIN))
134 if (copy_from_user(&cno, argp, sizeof(cno)))
137 nilfs_transaction_begin(inode->i_sb, &ti, 0);
138 ret = nilfs_cpfile_delete_checkpoint(cpfile, cno);
139 if (unlikely(ret < 0)) {
140 nilfs_transaction_abort(inode->i_sb);
143 nilfs_transaction_commit(inode->i_sb); /* never fails */
148 nilfs_ioctl_do_get_cpinfo(struct the_nilfs *nilfs, __u64 *posp, int flags,
149 void *buf, size_t size, size_t nmembs)
153 down_read(&nilfs->ns_segctor_sem);
154 ret = nilfs_cpfile_get_cpinfo(nilfs->ns_cpfile, posp, flags, buf,
156 up_read(&nilfs->ns_segctor_sem);
160 static int nilfs_ioctl_get_cpstat(struct inode *inode, struct file *filp,
161 unsigned int cmd, void __user *argp)
163 struct the_nilfs *nilfs = NILFS_SB(inode->i_sb)->s_nilfs;
164 struct nilfs_cpstat cpstat;
167 down_read(&nilfs->ns_segctor_sem);
168 ret = nilfs_cpfile_get_stat(nilfs->ns_cpfile, &cpstat);
169 up_read(&nilfs->ns_segctor_sem);
173 if (copy_to_user(argp, &cpstat, sizeof(cpstat)))
179 nilfs_ioctl_do_get_suinfo(struct the_nilfs *nilfs, __u64 *posp, int flags,
180 void *buf, size_t size, size_t nmembs)
184 down_read(&nilfs->ns_segctor_sem);
185 ret = nilfs_sufile_get_suinfo(nilfs->ns_sufile, *posp, buf, size,
187 up_read(&nilfs->ns_segctor_sem);
191 static int nilfs_ioctl_get_sustat(struct inode *inode, struct file *filp,
192 unsigned int cmd, void __user *argp)
194 struct the_nilfs *nilfs = NILFS_SB(inode->i_sb)->s_nilfs;
195 struct nilfs_sustat sustat;
198 down_read(&nilfs->ns_segctor_sem);
199 ret = nilfs_sufile_get_stat(nilfs->ns_sufile, &sustat);
200 up_read(&nilfs->ns_segctor_sem);
204 if (copy_to_user(argp, &sustat, sizeof(sustat)))
210 nilfs_ioctl_do_get_vinfo(struct the_nilfs *nilfs, __u64 *posp, int flags,
211 void *buf, size_t size, size_t nmembs)
215 down_read(&nilfs->ns_segctor_sem);
216 ret = nilfs_dat_get_vinfo(nilfs_dat_inode(nilfs), buf, size, nmembs);
217 up_read(&nilfs->ns_segctor_sem);
222 nilfs_ioctl_do_get_bdescs(struct the_nilfs *nilfs, __u64 *posp, int flags,
223 void *buf, size_t size, size_t nmembs)
225 struct inode *dat = nilfs_dat_inode(nilfs);
226 struct nilfs_bmap *bmap = NILFS_I(dat)->i_bmap;
227 struct nilfs_bdesc *bdescs = buf;
230 down_read(&nilfs->ns_segctor_sem);
231 for (i = 0; i < nmembs; i++) {
232 ret = nilfs_bmap_lookup_at_level(bmap,
234 bdescs[i].bd_level + 1,
235 &bdescs[i].bd_blocknr);
237 if (ret != -ENOENT) {
238 up_read(&nilfs->ns_segctor_sem);
241 bdescs[i].bd_blocknr = 0;
244 up_read(&nilfs->ns_segctor_sem);
248 static int nilfs_ioctl_get_bdescs(struct inode *inode, struct file *filp,
249 unsigned int cmd, void __user *argp)
251 struct the_nilfs *nilfs = NILFS_SB(inode->i_sb)->s_nilfs;
252 struct nilfs_argv argv;
255 if (copy_from_user(&argv, argp, sizeof(argv)))
258 if (argv.v_size != sizeof(struct nilfs_bdesc))
261 ret = nilfs_ioctl_wrap_copy(nilfs, &argv, _IOC_DIR(cmd),
262 nilfs_ioctl_do_get_bdescs);
266 if (copy_to_user(argp, &argv, sizeof(argv)))
271 static int nilfs_ioctl_move_inode_block(struct inode *inode,
272 struct nilfs_vdesc *vdesc,
273 struct list_head *buffers)
275 struct buffer_head *bh;
278 if (vdesc->vd_flags == 0)
279 ret = nilfs_gccache_submit_read_data(
280 inode, vdesc->vd_offset, vdesc->vd_blocknr,
281 vdesc->vd_vblocknr, &bh);
283 ret = nilfs_gccache_submit_read_node(
284 inode, vdesc->vd_blocknr, vdesc->vd_vblocknr, &bh);
286 if (unlikely(ret < 0)) {
289 "%s: invalid virtual block address (%s): "
290 "ino=%llu, cno=%llu, offset=%llu, "
291 "blocknr=%llu, vblocknr=%llu\n",
292 __func__, vdesc->vd_flags ? "node" : "data",
293 (unsigned long long)vdesc->vd_ino,
294 (unsigned long long)vdesc->vd_cno,
295 (unsigned long long)vdesc->vd_offset,
296 (unsigned long long)vdesc->vd_blocknr,
297 (unsigned long long)vdesc->vd_vblocknr);
300 if (unlikely(!list_empty(&bh->b_assoc_buffers))) {
301 printk(KERN_CRIT "%s: conflicting %s buffer: ino=%llu, "
302 "cno=%llu, offset=%llu, blocknr=%llu, vblocknr=%llu\n",
303 __func__, vdesc->vd_flags ? "node" : "data",
304 (unsigned long long)vdesc->vd_ino,
305 (unsigned long long)vdesc->vd_cno,
306 (unsigned long long)vdesc->vd_offset,
307 (unsigned long long)vdesc->vd_blocknr,
308 (unsigned long long)vdesc->vd_vblocknr);
312 list_add_tail(&bh->b_assoc_buffers, buffers);
316 static int nilfs_ioctl_move_blocks(struct the_nilfs *nilfs,
317 struct nilfs_argv *argv, void *buf)
319 size_t nmembs = argv->v_nmembs;
321 struct nilfs_vdesc *vdesc;
322 struct buffer_head *bh, *n;
328 for (i = 0, vdesc = buf; i < nmembs; ) {
331 inode = nilfs_gc_iget(nilfs, ino, cno);
332 if (unlikely(inode == NULL)) {
337 ret = nilfs_ioctl_move_inode_block(inode, vdesc,
339 if (unlikely(ret < 0))
342 } while (++i < nmembs &&
343 vdesc->vd_ino == ino && vdesc->vd_cno == cno);
346 list_for_each_entry_safe(bh, n, &buffers, b_assoc_buffers) {
347 ret = nilfs_gccache_wait_and_mark_dirty(bh);
348 if (unlikely(ret < 0)) {
349 WARN_ON(ret == -EEXIST);
352 list_del_init(&bh->b_assoc_buffers);
358 list_for_each_entry_safe(bh, n, &buffers, b_assoc_buffers) {
359 list_del_init(&bh->b_assoc_buffers);
365 static int nilfs_ioctl_delete_checkpoints(struct the_nilfs *nilfs,
366 struct nilfs_argv *argv, void *buf)
368 size_t nmembs = argv->v_nmembs;
369 struct inode *cpfile = nilfs->ns_cpfile;
370 struct nilfs_period *periods = buf;
373 for (i = 0; i < nmembs; i++) {
374 ret = nilfs_cpfile_delete_checkpoints(
375 cpfile, periods[i].p_start, periods[i].p_end);
382 static int nilfs_ioctl_free_vblocknrs(struct the_nilfs *nilfs,
383 struct nilfs_argv *argv, void *buf)
385 size_t nmembs = argv->v_nmembs;
388 ret = nilfs_dat_freev(nilfs_dat_inode(nilfs), buf, nmembs);
390 return (ret < 0) ? ret : nmembs;
393 static int nilfs_ioctl_mark_blocks_dirty(struct the_nilfs *nilfs,
394 struct nilfs_argv *argv, void *buf)
396 size_t nmembs = argv->v_nmembs;
397 struct inode *dat = nilfs_dat_inode(nilfs);
398 struct nilfs_bmap *bmap = NILFS_I(dat)->i_bmap;
399 struct nilfs_bdesc *bdescs = buf;
402 for (i = 0; i < nmembs; i++) {
403 /* XXX: use macro or inline func to check liveness */
404 ret = nilfs_bmap_lookup_at_level(bmap,
406 bdescs[i].bd_level + 1,
407 &bdescs[i].bd_blocknr);
411 bdescs[i].bd_blocknr = 0;
413 if (bdescs[i].bd_blocknr != bdescs[i].bd_oblocknr)
414 /* skip dead block */
416 if (bdescs[i].bd_level == 0) {
417 ret = nilfs_mdt_mark_block_dirty(dat,
418 bdescs[i].bd_offset);
420 WARN_ON(ret == -ENOENT);
424 ret = nilfs_bmap_mark(bmap, bdescs[i].bd_offset,
427 WARN_ON(ret == -ENOENT);
435 int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *nilfs,
436 struct nilfs_argv *argv, void **kbufs)
441 ret = nilfs_ioctl_delete_checkpoints(nilfs, &argv[1], kbufs[1]);
444 * can safely abort because checkpoints can be removed
447 msg = "cannot delete checkpoints";
450 ret = nilfs_ioctl_free_vblocknrs(nilfs, &argv[2], kbufs[2]);
453 * can safely abort because DAT file is updated atomically
454 * using a copy-on-write technique.
456 msg = "cannot delete virtual blocks from DAT file";
459 ret = nilfs_ioctl_mark_blocks_dirty(nilfs, &argv[3], kbufs[3]);
462 * can safely abort because the operation is nondestructive.
464 msg = "cannot mark copying blocks dirty";
470 printk(KERN_ERR "NILFS: GC failed during preparation: %s: err=%d\n",
475 static int nilfs_ioctl_clean_segments(struct inode *inode, struct file *filp,
476 unsigned int cmd, void __user *argp)
478 struct nilfs_argv argv[5];
479 const static size_t argsz[5] = {
480 sizeof(struct nilfs_vdesc),
481 sizeof(struct nilfs_period),
483 sizeof(struct nilfs_bdesc),
488 struct the_nilfs *nilfs;
492 if (!capable(CAP_SYS_ADMIN))
495 if (copy_from_user(argv, argp, sizeof(argv)))
498 nsegs = argv[4].v_nmembs;
499 if (argv[4].v_size != argsz[4])
502 * argv[4] points to segment numbers this ioctl cleans. We
503 * use kmalloc() for its buffer because memory used for the
504 * segment numbers is enough small.
506 kbufs[4] = memdup_user((void __user *)(unsigned long)argv[4].v_base,
507 nsegs * sizeof(__u64));
508 if (IS_ERR(kbufs[4]))
509 return PTR_ERR(kbufs[4]);
511 nilfs = NILFS_SB(inode->i_sb)->s_nilfs;
513 for (n = 0; n < 4; n++) {
515 if (argv[n].v_size != argsz[n])
518 if (argv[n].v_nmembs > nsegs * nilfs->ns_blocks_per_segment)
521 len = argv[n].v_size * argv[n].v_nmembs;
522 base = (void __user *)(unsigned long)argv[n].v_base;
528 kbufs[n] = vmalloc(len);
533 if (copy_from_user(kbufs[n], base, len)) {
541 * nilfs_ioctl_move_blocks() will call nilfs_gc_iget(),
542 * which will operates an inode list without blocking.
543 * To protect the list from concurrent operations,
544 * nilfs_ioctl_move_blocks should be atomic operation.
546 if (test_and_set_bit(THE_NILFS_GC_RUNNING, &nilfs->ns_flags)) {
551 ret = nilfs_ioctl_move_blocks(nilfs, &argv[0], kbufs[0]);
553 printk(KERN_ERR "NILFS: GC failed during preparation: "
554 "cannot read source blocks: err=%d\n", ret);
556 ret = nilfs_clean_segments(inode->i_sb, argv, kbufs);
559 nilfs_remove_all_gcinode(nilfs);
560 clear_nilfs_gc_running(nilfs);
569 static int nilfs_ioctl_sync(struct inode *inode, struct file *filp,
570 unsigned int cmd, void __user *argp)
575 ret = nilfs_construct_segment(inode->i_sb);
580 cno = NILFS_SB(inode->i_sb)->s_nilfs->ns_cno - 1;
581 if (copy_to_user(argp, &cno, sizeof(cno)))
587 static int nilfs_ioctl_get_info(struct inode *inode, struct file *filp,
588 unsigned int cmd, void __user *argp,
590 ssize_t (*dofunc)(struct the_nilfs *,
592 void *, size_t, size_t))
595 struct the_nilfs *nilfs = NILFS_SB(inode->i_sb)->s_nilfs;
596 struct nilfs_argv argv;
599 if (copy_from_user(&argv, argp, sizeof(argv)))
602 if (argv.v_size < membsz)
605 ret = nilfs_ioctl_wrap_copy(nilfs, &argv, _IOC_DIR(cmd), dofunc);
609 if (copy_to_user(argp, &argv, sizeof(argv)))
614 long nilfs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
616 struct inode *inode = filp->f_dentry->d_inode;
617 void __user *argp = (void * __user *)arg;
620 case NILFS_IOCTL_CHANGE_CPMODE:
621 return nilfs_ioctl_change_cpmode(inode, filp, cmd, argp);
622 case NILFS_IOCTL_DELETE_CHECKPOINT:
623 return nilfs_ioctl_delete_checkpoint(inode, filp, cmd, argp);
624 case NILFS_IOCTL_GET_CPINFO:
625 return nilfs_ioctl_get_info(inode, filp, cmd, argp,
626 sizeof(struct nilfs_cpinfo),
627 nilfs_ioctl_do_get_cpinfo);
628 case NILFS_IOCTL_GET_CPSTAT:
629 return nilfs_ioctl_get_cpstat(inode, filp, cmd, argp);
630 case NILFS_IOCTL_GET_SUINFO:
631 return nilfs_ioctl_get_info(inode, filp, cmd, argp,
632 sizeof(struct nilfs_suinfo),
633 nilfs_ioctl_do_get_suinfo);
634 case NILFS_IOCTL_GET_SUSTAT:
635 return nilfs_ioctl_get_sustat(inode, filp, cmd, argp);
636 case NILFS_IOCTL_GET_VINFO:
637 return nilfs_ioctl_get_info(inode, filp, cmd, argp,
638 sizeof(struct nilfs_vinfo),
639 nilfs_ioctl_do_get_vinfo);
640 case NILFS_IOCTL_GET_BDESCS:
641 return nilfs_ioctl_get_bdescs(inode, filp, cmd, argp);
642 case NILFS_IOCTL_CLEAN_SEGMENTS:
643 return nilfs_ioctl_clean_segments(inode, filp, cmd, argp);
644 case NILFS_IOCTL_SYNC:
645 return nilfs_ioctl_sync(inode, filp, cmd, argp);