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, nmembs);
186 up_read(&nilfs->ns_segctor_sem);
190 static int nilfs_ioctl_get_sustat(struct inode *inode, struct file *filp,
191 unsigned int cmd, void __user *argp)
193 struct the_nilfs *nilfs = NILFS_SB(inode->i_sb)->s_nilfs;
194 struct nilfs_sustat sustat;
197 down_read(&nilfs->ns_segctor_sem);
198 ret = nilfs_sufile_get_stat(nilfs->ns_sufile, &sustat);
199 up_read(&nilfs->ns_segctor_sem);
203 if (copy_to_user(argp, &sustat, sizeof(sustat)))
209 nilfs_ioctl_do_get_vinfo(struct the_nilfs *nilfs, __u64 *posp, int flags,
210 void *buf, size_t size, size_t nmembs)
214 down_read(&nilfs->ns_segctor_sem);
215 ret = nilfs_dat_get_vinfo(nilfs_dat_inode(nilfs), buf, nmembs);
216 up_read(&nilfs->ns_segctor_sem);
221 nilfs_ioctl_do_get_bdescs(struct the_nilfs *nilfs, __u64 *posp, int flags,
222 void *buf, size_t size, size_t nmembs)
224 struct inode *dat = nilfs_dat_inode(nilfs);
225 struct nilfs_bmap *bmap = NILFS_I(dat)->i_bmap;
226 struct nilfs_bdesc *bdescs = buf;
229 down_read(&nilfs->ns_segctor_sem);
230 for (i = 0; i < nmembs; i++) {
231 ret = nilfs_bmap_lookup_at_level(bmap,
233 bdescs[i].bd_level + 1,
234 &bdescs[i].bd_blocknr);
236 if (ret != -ENOENT) {
237 up_read(&nilfs->ns_segctor_sem);
240 bdescs[i].bd_blocknr = 0;
243 up_read(&nilfs->ns_segctor_sem);
247 static int nilfs_ioctl_get_bdescs(struct inode *inode, struct file *filp,
248 unsigned int cmd, void __user *argp)
250 struct the_nilfs *nilfs = NILFS_SB(inode->i_sb)->s_nilfs;
251 struct nilfs_argv argv;
254 if (copy_from_user(&argv, argp, sizeof(argv)))
257 ret = nilfs_ioctl_wrap_copy(nilfs, &argv, _IOC_DIR(cmd),
258 nilfs_ioctl_do_get_bdescs);
262 if (copy_to_user(argp, &argv, sizeof(argv)))
267 static int nilfs_ioctl_move_inode_block(struct inode *inode,
268 struct nilfs_vdesc *vdesc,
269 struct list_head *buffers)
271 struct buffer_head *bh;
274 if (vdesc->vd_flags == 0)
275 ret = nilfs_gccache_submit_read_data(
276 inode, vdesc->vd_offset, vdesc->vd_blocknr,
277 vdesc->vd_vblocknr, &bh);
279 ret = nilfs_gccache_submit_read_node(
280 inode, vdesc->vd_blocknr, vdesc->vd_vblocknr, &bh);
282 if (unlikely(ret < 0)) {
285 "%s: invalid virtual block address (%s): "
286 "ino=%llu, cno=%llu, offset=%llu, "
287 "blocknr=%llu, vblocknr=%llu\n",
288 __func__, vdesc->vd_flags ? "node" : "data",
289 (unsigned long long)vdesc->vd_ino,
290 (unsigned long long)vdesc->vd_cno,
291 (unsigned long long)vdesc->vd_offset,
292 (unsigned long long)vdesc->vd_blocknr,
293 (unsigned long long)vdesc->vd_vblocknr);
296 bh->b_private = vdesc;
297 list_add_tail(&bh->b_assoc_buffers, buffers);
301 static int nilfs_ioctl_move_blocks(struct the_nilfs *nilfs,
302 struct nilfs_argv *argv, void *buf)
304 size_t nmembs = argv->v_nmembs;
306 struct nilfs_vdesc *vdesc;
307 struct buffer_head *bh, *n;
313 for (i = 0, vdesc = buf; i < nmembs; ) {
316 inode = nilfs_gc_iget(nilfs, ino, cno);
317 if (unlikely(inode == NULL)) {
322 ret = nilfs_ioctl_move_inode_block(inode, vdesc,
324 if (unlikely(ret < 0))
327 } while (++i < nmembs &&
328 vdesc->vd_ino == ino && vdesc->vd_cno == cno);
331 list_for_each_entry_safe(bh, n, &buffers, b_assoc_buffers) {
332 ret = nilfs_gccache_wait_and_mark_dirty(bh);
333 if (unlikely(ret < 0)) {
334 if (ret == -EEXIST) {
335 vdesc = bh->b_private;
337 "%s: conflicting %s buffer: "
338 "ino=%llu, cno=%llu, offset=%llu, "
339 "blocknr=%llu, vblocknr=%llu\n",
341 vdesc->vd_flags ? "node" : "data",
342 (unsigned long long)vdesc->vd_ino,
343 (unsigned long long)vdesc->vd_cno,
344 (unsigned long long)vdesc->vd_offset,
345 (unsigned long long)vdesc->vd_blocknr,
346 (unsigned long long)vdesc->vd_vblocknr);
350 list_del_init(&bh->b_assoc_buffers);
351 bh->b_private = NULL;
357 list_for_each_entry_safe(bh, n, &buffers, b_assoc_buffers) {
358 list_del_init(&bh->b_assoc_buffers);
359 bh->b_private = NULL;
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 static int nilfs_ioctl_free_segments(struct the_nilfs *nilfs,
436 struct nilfs_argv *argv, void *buf)
438 size_t nmembs = argv->v_nmembs;
439 struct nilfs_sb_info *sbi = nilfs->ns_writer;
442 if (unlikely(!sbi)) {
443 /* never happens because called for a writable mount */
447 ret = nilfs_segctor_add_segments_to_be_freed(
448 NILFS_SC(sbi), buf, nmembs);
450 return (ret < 0) ? ret : nmembs;
453 int nilfs_ioctl_prepare_clean_segments(struct the_nilfs *nilfs,
454 struct nilfs_argv *argv, void **kbufs)
459 ret = nilfs_ioctl_move_blocks(nilfs, &argv[0], kbufs[0]);
461 msg = "cannot read source blocks";
465 ret = nilfs_ioctl_delete_checkpoints(nilfs, &argv[1], kbufs[1]);
468 * can safely abort because checkpoints can be removed
471 msg = "cannot delete checkpoints";
474 ret = nilfs_ioctl_free_vblocknrs(nilfs, &argv[2], kbufs[2]);
477 * can safely abort because DAT file is updated atomically
478 * using a copy-on-write technique.
480 msg = "cannot delete virtual blocks from DAT file";
483 ret = nilfs_ioctl_mark_blocks_dirty(nilfs, &argv[3], kbufs[3]);
486 * can safely abort because the operation is nondestructive.
488 msg = "cannot mark copying blocks dirty";
491 ret = nilfs_ioctl_free_segments(nilfs, &argv[4], kbufs[4]);
494 * can safely abort because this operation is atomic.
496 msg = "cannot set segments to be freed";
502 nilfs_remove_all_gcinode(nilfs);
503 printk(KERN_ERR "NILFS: GC failed during preparation: %s: err=%d\n",
508 static int nilfs_ioctl_clean_segments(struct inode *inode, struct file *filp,
509 unsigned int cmd, void __user *argp)
511 struct nilfs_argv argv[5];
512 const static size_t argsz[5] = {
513 sizeof(struct nilfs_vdesc),
514 sizeof(struct nilfs_period),
516 sizeof(struct nilfs_bdesc),
521 struct the_nilfs *nilfs;
525 if (!capable(CAP_SYS_ADMIN))
528 if (copy_from_user(argv, argp, sizeof(argv)))
531 nsegs = argv[4].v_nmembs;
532 if (argv[4].v_size != argsz[4])
535 * argv[4] points to segment numbers this ioctl cleans. We
536 * use kmalloc() for its buffer because memory used for the
537 * segment numbers is enough small.
539 kbufs[4] = memdup_user((void __user *)(unsigned long)argv[4].v_base,
540 nsegs * sizeof(__u64));
541 if (IS_ERR(kbufs[4]))
542 return PTR_ERR(kbufs[4]);
544 nilfs = NILFS_SB(inode->i_sb)->s_nilfs;
546 for (n = 0; n < 4; n++) {
548 if (argv[n].v_size != argsz[n])
551 if (argv[n].v_nmembs > nsegs * nilfs->ns_blocks_per_segment)
554 len = argv[n].v_size * argv[n].v_nmembs;
555 base = (void __user *)(unsigned long)argv[n].v_base;
561 kbufs[n] = vmalloc(len);
566 if (copy_from_user(kbufs[n], base, len)) {
573 ret = nilfs_clean_segments(inode->i_sb, argv, kbufs);
582 static int nilfs_ioctl_sync(struct inode *inode, struct file *filp,
583 unsigned int cmd, void __user *argp)
588 ret = nilfs_construct_segment(inode->i_sb);
593 cno = NILFS_SB(inode->i_sb)->s_nilfs->ns_cno - 1;
594 if (copy_to_user(argp, &cno, sizeof(cno)))
600 static int nilfs_ioctl_get_info(struct inode *inode, struct file *filp,
601 unsigned int cmd, void __user *argp,
602 ssize_t (*dofunc)(struct the_nilfs *,
604 void *, size_t, size_t))
607 struct the_nilfs *nilfs = NILFS_SB(inode->i_sb)->s_nilfs;
608 struct nilfs_argv argv;
611 if (copy_from_user(&argv, argp, sizeof(argv)))
614 ret = nilfs_ioctl_wrap_copy(nilfs, &argv, _IOC_DIR(cmd), dofunc);
618 if (copy_to_user(argp, &argv, sizeof(argv)))
623 long nilfs_ioctl(struct file *filp, unsigned int cmd, unsigned long arg)
625 struct inode *inode = filp->f_dentry->d_inode;
626 void __user *argp = (void * __user *)arg;
629 case NILFS_IOCTL_CHANGE_CPMODE:
630 return nilfs_ioctl_change_cpmode(inode, filp, cmd, argp);
631 case NILFS_IOCTL_DELETE_CHECKPOINT:
632 return nilfs_ioctl_delete_checkpoint(inode, filp, cmd, argp);
633 case NILFS_IOCTL_GET_CPINFO:
634 return nilfs_ioctl_get_info(inode, filp, cmd, argp,
635 nilfs_ioctl_do_get_cpinfo);
636 case NILFS_IOCTL_GET_CPSTAT:
637 return nilfs_ioctl_get_cpstat(inode, filp, cmd, argp);
638 case NILFS_IOCTL_GET_SUINFO:
639 return nilfs_ioctl_get_info(inode, filp, cmd, argp,
640 nilfs_ioctl_do_get_suinfo);
641 case NILFS_IOCTL_GET_SUSTAT:
642 return nilfs_ioctl_get_sustat(inode, filp, cmd, argp);
643 case NILFS_IOCTL_GET_VINFO:
644 return nilfs_ioctl_get_info(inode, filp, cmd, argp,
645 nilfs_ioctl_do_get_vinfo);
646 case NILFS_IOCTL_GET_BDESCS:
647 return nilfs_ioctl_get_bdescs(inode, filp, cmd, argp);
648 case NILFS_IOCTL_CLEAN_SEGMENTS:
649 return nilfs_ioctl_clean_segments(inode, filp, cmd, argp);
650 case NILFS_IOCTL_SYNC:
651 return nilfs_ioctl_sync(inode, filp, cmd, argp);