1 // SPDX-License-Identifier: GPL-2.0
2 #ifndef NO_BCACHEFS_CHARDEV
5 #include "bcachefs_ioctl.h"
10 #include "recovery_passes.h"
14 #include "thread_with_file.h"
16 #include <linux/cdev.h>
17 #include <linux/device.h>
19 #include <linux/ioctl.h>
20 #include <linux/major.h>
21 #include <linux/sched/task.h>
22 #include <linux/slab.h>
23 #include <linux/uaccess.h>
25 /* returns with ref on ca->ref */
26 static struct bch_dev *bch2_device_lookup(struct bch_fs *c, u64 dev,
31 if (flags & BCH_BY_INDEX) {
32 if (dev >= c->sb.nr_devices)
33 return ERR_PTR(-EINVAL);
35 ca = bch2_dev_tryget_noerror(c, dev);
37 return ERR_PTR(-EINVAL);
41 path = strndup_user((const char __user *)
42 (unsigned long) dev, PATH_MAX);
44 return ERR_CAST(path);
46 ca = bch2_dev_lookup(c, path);
54 static long bch2_ioctl_assemble(struct bch_ioctl_assemble __user *user_arg)
56 struct bch_ioctl_assemble arg;
58 u64 *user_devs = NULL;
63 if (copy_from_user(&arg, user_arg, sizeof(arg)))
66 if (arg.flags || arg.pad)
69 user_devs = kmalloc_array(arg.nr_devs, sizeof(u64), GFP_KERNEL);
73 devs = kcalloc(arg.nr_devs, sizeof(char *), GFP_KERNEL);
75 if (copy_from_user(user_devs, user_arg->devs,
76 sizeof(u64) * arg.nr_devs))
79 for (i = 0; i < arg.nr_devs; i++) {
80 devs[i] = strndup_user((const char __user *)(unsigned long)
83 ret= PTR_ERR_OR_ZERO(devs[i]);
88 c = bch2_fs_open(devs, arg.nr_devs, bch2_opts_empty());
89 ret = PTR_ERR_OR_ZERO(c);
94 for (i = 0; i < arg.nr_devs; i++)
100 static long bch2_ioctl_incremental(struct bch_ioctl_incremental __user *user_arg)
102 struct bch_ioctl_incremental arg;
106 if (copy_from_user(&arg, user_arg, sizeof(arg)))
109 if (arg.flags || arg.pad)
112 path = strndup_user((const char __user *)(unsigned long) arg.dev, PATH_MAX);
113 ret = PTR_ERR_OR_ZERO(path);
117 err = bch2_fs_open_incremental(path);
121 pr_err("Could not register bcachefs devices: %s", err);
130 struct thread_with_stdio thr;
132 struct bch_opts opts;
135 static void bch2_fsck_thread_exit(struct thread_with_stdio *_thr)
137 struct fsck_thread *thr = container_of(_thr, struct fsck_thread, thr);
141 static int bch2_fsck_offline_thread_fn(struct thread_with_stdio *stdio)
143 struct fsck_thread *thr = container_of(stdio, struct fsck_thread, thr);
144 struct bch_fs *c = thr->c;
146 int ret = PTR_ERR_OR_ZERO(c);
150 ret = bch2_fs_start(thr->c);
154 if (test_bit(BCH_FS_errors_fixed, &c->flags)) {
155 bch2_stdio_redirect_printf(&stdio->stdio, false, "%s: errors fixed\n", c->name);
158 if (test_bit(BCH_FS_error, &c->flags)) {
159 bch2_stdio_redirect_printf(&stdio->stdio, false, "%s: still has errors\n", c->name);
167 static const struct thread_with_stdio_ops bch2_offline_fsck_ops = {
168 .exit = bch2_fsck_thread_exit,
169 .fn = bch2_fsck_offline_thread_fn,
172 static long bch2_ioctl_fsck_offline(struct bch_ioctl_fsck_offline __user *user_arg)
174 struct bch_ioctl_fsck_offline arg;
175 struct fsck_thread *thr = NULL;
176 darray_str(devs) = {};
179 if (copy_from_user(&arg, user_arg, sizeof(arg)))
185 if (!capable(CAP_SYS_ADMIN))
188 for (size_t i = 0; i < arg.nr_devs; i++) {
190 ret = copy_from_user_errcode(&dev_u64, &user_arg->devs[i], sizeof(u64));
194 char *dev_str = strndup_user((char __user *)(unsigned long) dev_u64, PATH_MAX);
195 ret = PTR_ERR_OR_ZERO(dev_str);
199 ret = darray_push(&devs, dev_str);
206 thr = kzalloc(sizeof(*thr), GFP_KERNEL);
212 thr->opts = bch2_opts_empty();
215 char *optstr = strndup_user((char __user *)(unsigned long) arg.opts, 1 << 16);
217 ret = PTR_ERR_OR_ZERO(optstr) ?:
218 bch2_parse_mount_opts(NULL, &thr->opts, optstr);
225 opt_set(thr->opts, stdio, (u64)(unsigned long)&thr->thr.stdio);
227 /* We need request_key() to be called before we punt to kthread: */
228 opt_set(thr->opts, nostart, true);
230 bch2_thread_with_stdio_init(&thr->thr, &bch2_offline_fsck_ops);
232 thr->c = bch2_fs_open(devs.data, arg.nr_devs, thr->opts);
234 if (!IS_ERR(thr->c) &&
235 thr->c->opts.errors == BCH_ON_ERROR_panic)
236 thr->c->opts.errors = BCH_ON_ERROR_ro;
238 ret = __bch2_run_thread_with_stdio(&thr->thr);
240 darray_for_each(devs, i)
246 bch2_fsck_thread_exit(&thr->thr);
247 pr_err("ret %s", bch2_err_str(ret));
251 static long bch2_global_ioctl(unsigned cmd, void __user *arg)
257 case BCH_IOCTL_ASSEMBLE:
258 return bch2_ioctl_assemble(arg);
259 case BCH_IOCTL_INCREMENTAL:
260 return bch2_ioctl_incremental(arg);
262 case BCH_IOCTL_FSCK_OFFLINE: {
263 ret = bch2_ioctl_fsck_offline(arg);
272 ret = bch2_err_class(ret);
276 static long bch2_ioctl_query_uuid(struct bch_fs *c,
277 struct bch_ioctl_query_uuid __user *user_arg)
279 return copy_to_user_errcode(&user_arg->uuid, &c->sb.user_uuid,
280 sizeof(c->sb.user_uuid));
284 static long bch2_ioctl_start(struct bch_fs *c, struct bch_ioctl_start arg)
286 if (!capable(CAP_SYS_ADMIN))
289 if (arg.flags || arg.pad)
292 return bch2_fs_start(c);
295 static long bch2_ioctl_stop(struct bch_fs *c)
297 if (!capable(CAP_SYS_ADMIN))
305 static long bch2_ioctl_disk_add(struct bch_fs *c, struct bch_ioctl_disk arg)
310 if (!capable(CAP_SYS_ADMIN))
313 if (arg.flags || arg.pad)
316 path = strndup_user((const char __user *)(unsigned long) arg.dev, PATH_MAX);
317 ret = PTR_ERR_OR_ZERO(path);
321 ret = bch2_dev_add(c, path);
327 static long bch2_ioctl_disk_remove(struct bch_fs *c, struct bch_ioctl_disk arg)
331 if (!capable(CAP_SYS_ADMIN))
334 if ((arg.flags & ~(BCH_FORCE_IF_DATA_LOST|
335 BCH_FORCE_IF_METADATA_LOST|
336 BCH_FORCE_IF_DEGRADED|
341 ca = bch2_device_lookup(c, arg.dev, arg.flags);
345 return bch2_dev_remove(c, ca, arg.flags);
348 static long bch2_ioctl_disk_online(struct bch_fs *c, struct bch_ioctl_disk arg)
353 if (!capable(CAP_SYS_ADMIN))
356 if (arg.flags || arg.pad)
359 path = strndup_user((const char __user *)(unsigned long) arg.dev, PATH_MAX);
360 ret = PTR_ERR_OR_ZERO(path);
364 ret = bch2_dev_online(c, path);
369 static long bch2_ioctl_disk_offline(struct bch_fs *c, struct bch_ioctl_disk arg)
374 if (!capable(CAP_SYS_ADMIN))
377 if ((arg.flags & ~(BCH_FORCE_IF_DATA_LOST|
378 BCH_FORCE_IF_METADATA_LOST|
379 BCH_FORCE_IF_DEGRADED|
384 ca = bch2_device_lookup(c, arg.dev, arg.flags);
388 ret = bch2_dev_offline(c, ca, arg.flags);
393 static long bch2_ioctl_disk_set_state(struct bch_fs *c,
394 struct bch_ioctl_disk_set_state arg)
399 if (!capable(CAP_SYS_ADMIN))
402 if ((arg.flags & ~(BCH_FORCE_IF_DATA_LOST|
403 BCH_FORCE_IF_METADATA_LOST|
404 BCH_FORCE_IF_DEGRADED|
406 arg.pad[0] || arg.pad[1] || arg.pad[2] ||
407 arg.new_state >= BCH_MEMBER_STATE_NR)
410 ca = bch2_device_lookup(c, arg.dev, arg.flags);
414 ret = bch2_dev_set_state(c, ca, arg.new_state, arg.flags);
416 bch_err(c, "Error setting device state: %s", bch2_err_str(ret));
422 struct bch_data_ctx {
423 struct thread_with_file thr;
426 struct bch_ioctl_data arg;
427 struct bch_move_stats stats;
430 static int bch2_data_thread(void *arg)
432 struct bch_data_ctx *ctx = container_of(arg, struct bch_data_ctx, thr);
434 ctx->thr.ret = bch2_data_job(ctx->c, &ctx->stats, ctx->arg);
435 ctx->stats.data_type = U8_MAX;
439 static int bch2_data_job_release(struct inode *inode, struct file *file)
441 struct bch_data_ctx *ctx = container_of(file->private_data, struct bch_data_ctx, thr);
443 bch2_thread_with_file_exit(&ctx->thr);
448 static ssize_t bch2_data_job_read(struct file *file, char __user *buf,
449 size_t len, loff_t *ppos)
451 struct bch_data_ctx *ctx = container_of(file->private_data, struct bch_data_ctx, thr);
452 struct bch_fs *c = ctx->c;
453 struct bch_ioctl_data_event e = {
454 .type = BCH_DATA_EVENT_PROGRESS,
455 .p.data_type = ctx->stats.data_type,
456 .p.btree_id = ctx->stats.pos.btree,
457 .p.pos = ctx->stats.pos.pos,
458 .p.sectors_done = atomic64_read(&ctx->stats.sectors_seen),
459 .p.sectors_total = bch2_fs_usage_read_short(c).used,
465 return copy_to_user_errcode(buf, &e, sizeof(e)) ?: sizeof(e);
468 static const struct file_operations bcachefs_data_ops = {
469 .release = bch2_data_job_release,
470 .read = bch2_data_job_read,
474 static long bch2_ioctl_data(struct bch_fs *c,
475 struct bch_ioctl_data arg)
477 struct bch_data_ctx *ctx;
480 if (!capable(CAP_SYS_ADMIN))
483 if (arg.op >= BCH_DATA_OP_NR || arg.flags)
486 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
493 ret = bch2_run_thread_with_file(&ctx->thr,
501 static long bch2_ioctl_fs_usage(struct bch_fs *c,
502 struct bch_ioctl_fs_usage __user *user_arg)
504 struct bch_ioctl_fs_usage *arg = NULL;
505 struct bch_replicas_usage *dst_e, *dst_end;
506 struct bch_fs_usage_online *src;
507 u32 replica_entries_bytes;
511 if (!test_bit(BCH_FS_started, &c->flags))
514 if (get_user(replica_entries_bytes, &user_arg->replica_entries_bytes))
517 arg = kzalloc(size_add(sizeof(*arg), replica_entries_bytes), GFP_KERNEL);
521 src = bch2_fs_usage_read(c);
527 arg->capacity = c->capacity;
528 arg->used = bch2_fs_sectors_used(c, src);
529 arg->online_reserved = src->online_reserved;
531 for (i = 0; i < BCH_REPLICAS_MAX; i++)
532 arg->persistent_reserved[i] = src->u.persistent_reserved[i];
534 dst_e = arg->replicas;
535 dst_end = (void *) arg->replicas + replica_entries_bytes;
537 for (i = 0; i < c->replicas.nr; i++) {
538 struct bch_replicas_entry_v1 *src_e =
539 cpu_replicas_entry(&c->replicas, i);
541 /* check that we have enough space for one replicas entry */
542 if (dst_e + 1 > dst_end) {
547 dst_e->sectors = src->u.replicas[i];
550 /* recheck after setting nr_devs: */
551 if (replicas_usage_next(dst_e) > dst_end) {
556 memcpy(dst_e->r.devs, src_e->devs, src_e->nr_devs);
558 dst_e = replicas_usage_next(dst_e);
561 arg->replica_entries_bytes = (void *) dst_e - (void *) arg->replicas;
563 percpu_up_read(&c->mark_lock);
569 ret = copy_to_user_errcode(user_arg, arg,
570 sizeof(*arg) + arg->replica_entries_bytes);
576 /* obsolete, didn't allow for new data types: */
577 static long bch2_ioctl_dev_usage(struct bch_fs *c,
578 struct bch_ioctl_dev_usage __user *user_arg)
580 struct bch_ioctl_dev_usage arg;
581 struct bch_dev_usage src;
585 if (!test_bit(BCH_FS_started, &c->flags))
588 if (copy_from_user(&arg, user_arg, sizeof(arg)))
591 if ((arg.flags & ~BCH_BY_INDEX) ||
597 ca = bch2_device_lookup(c, arg.dev, arg.flags);
601 src = bch2_dev_usage_read(ca);
603 arg.state = ca->mi.state;
604 arg.bucket_size = ca->mi.bucket_size;
605 arg.nr_buckets = ca->mi.nbuckets - ca->mi.first_bucket;
607 for (i = 0; i < BCH_DATA_NR; i++) {
608 arg.d[i].buckets = src.d[i].buckets;
609 arg.d[i].sectors = src.d[i].sectors;
610 arg.d[i].fragmented = src.d[i].fragmented;
615 return copy_to_user_errcode(user_arg, &arg, sizeof(arg));
618 static long bch2_ioctl_dev_usage_v2(struct bch_fs *c,
619 struct bch_ioctl_dev_usage_v2 __user *user_arg)
621 struct bch_ioctl_dev_usage_v2 arg;
622 struct bch_dev_usage src;
626 if (!test_bit(BCH_FS_started, &c->flags))
629 if (copy_from_user(&arg, user_arg, sizeof(arg)))
632 if ((arg.flags & ~BCH_BY_INDEX) ||
638 ca = bch2_device_lookup(c, arg.dev, arg.flags);
642 src = bch2_dev_usage_read(ca);
644 arg.state = ca->mi.state;
645 arg.bucket_size = ca->mi.bucket_size;
646 arg.nr_data_types = min(arg.nr_data_types, BCH_DATA_NR);
647 arg.nr_buckets = ca->mi.nbuckets - ca->mi.first_bucket;
649 ret = copy_to_user_errcode(user_arg, &arg, sizeof(arg));
653 for (unsigned i = 0; i < arg.nr_data_types; i++) {
654 struct bch_ioctl_dev_usage_type t = {
655 .buckets = src.d[i].buckets,
656 .sectors = src.d[i].sectors,
657 .fragmented = src.d[i].fragmented,
660 ret = copy_to_user_errcode(&user_arg->d[i], &t, sizeof(t));
669 static long bch2_ioctl_read_super(struct bch_fs *c,
670 struct bch_ioctl_read_super arg)
672 struct bch_dev *ca = NULL;
676 if (!capable(CAP_SYS_ADMIN))
679 if ((arg.flags & ~(BCH_BY_INDEX|BCH_READ_DEV)) ||
683 mutex_lock(&c->sb_lock);
685 if (arg.flags & BCH_READ_DEV) {
686 ca = bch2_device_lookup(c, arg.dev, arg.flags);
687 ret = PTR_ERR_OR_ZERO(ca);
696 if (vstruct_bytes(sb) > arg.size) {
701 ret = copy_to_user_errcode((void __user *)(unsigned long)arg.sb, sb,
706 mutex_unlock(&c->sb_lock);
710 static long bch2_ioctl_disk_get_idx(struct bch_fs *c,
711 struct bch_ioctl_disk_get_idx arg)
713 dev_t dev = huge_decode_dev(arg.dev);
715 if (!capable(CAP_SYS_ADMIN))
721 for_each_online_member(c, ca)
722 if (ca->dev == dev) {
723 percpu_ref_put(&ca->io_ref);
727 return -BCH_ERR_ENOENT_dev_idx_not_found;
730 static long bch2_ioctl_disk_resize(struct bch_fs *c,
731 struct bch_ioctl_disk_resize arg)
736 if (!capable(CAP_SYS_ADMIN))
739 if ((arg.flags & ~BCH_BY_INDEX) ||
743 ca = bch2_device_lookup(c, arg.dev, arg.flags);
747 ret = bch2_dev_resize(c, ca, arg.nbuckets);
753 static long bch2_ioctl_disk_resize_journal(struct bch_fs *c,
754 struct bch_ioctl_disk_resize_journal arg)
759 if (!capable(CAP_SYS_ADMIN))
762 if ((arg.flags & ~BCH_BY_INDEX) ||
766 if (arg.nbuckets > U32_MAX)
769 ca = bch2_device_lookup(c, arg.dev, arg.flags);
773 ret = bch2_set_nr_journal_buckets(c, ca, arg.nbuckets);
779 static int bch2_fsck_online_thread_fn(struct thread_with_stdio *stdio)
781 struct fsck_thread *thr = container_of(stdio, struct fsck_thread, thr);
782 struct bch_fs *c = thr->c;
784 c->stdio_filter = current;
785 c->stdio = &thr->thr.stdio;
788 * XXX: can we figure out a way to do this without mucking with c->opts?
790 unsigned old_fix_errors = c->opts.fix_errors;
791 if (opt_defined(thr->opts, fix_errors))
792 c->opts.fix_errors = thr->opts.fix_errors;
794 c->opts.fix_errors = FSCK_FIX_ask;
797 set_bit(BCH_FS_fsck_running, &c->flags);
799 c->curr_recovery_pass = BCH_RECOVERY_PASS_check_alloc_info;
800 int ret = bch2_run_online_recovery_passes(c);
802 clear_bit(BCH_FS_fsck_running, &c->flags);
806 c->stdio_filter = NULL;
807 c->opts.fix_errors = old_fix_errors;
809 up(&c->online_fsck_mutex);
814 static const struct thread_with_stdio_ops bch2_online_fsck_ops = {
815 .exit = bch2_fsck_thread_exit,
816 .fn = bch2_fsck_online_thread_fn,
819 static long bch2_ioctl_fsck_online(struct bch_fs *c,
820 struct bch_ioctl_fsck_online arg)
822 struct fsck_thread *thr = NULL;
828 if (!capable(CAP_SYS_ADMIN))
831 if (!bch2_ro_ref_tryget(c))
834 if (down_trylock(&c->online_fsck_mutex)) {
839 thr = kzalloc(sizeof(*thr), GFP_KERNEL);
846 thr->opts = bch2_opts_empty();
849 char *optstr = strndup_user((char __user *)(unsigned long) arg.opts, 1 << 16);
851 ret = PTR_ERR_OR_ZERO(optstr) ?:
852 bch2_parse_mount_opts(c, &thr->opts, optstr);
859 ret = bch2_run_thread_with_stdio(&thr->thr, &bch2_online_fsck_ops);
864 bch2_fsck_thread_exit(&thr->thr);
865 up(&c->online_fsck_mutex);
871 #define BCH_IOCTL(_name, _argtype) \
875 if (copy_from_user(&i, arg, sizeof(i))) \
877 ret = bch2_ioctl_##_name(c, i); \
881 long bch2_fs_ioctl(struct bch_fs *c, unsigned cmd, void __user *arg)
886 case BCH_IOCTL_QUERY_UUID:
887 return bch2_ioctl_query_uuid(c, arg);
888 case BCH_IOCTL_FS_USAGE:
889 return bch2_ioctl_fs_usage(c, arg);
890 case BCH_IOCTL_DEV_USAGE:
891 return bch2_ioctl_dev_usage(c, arg);
892 case BCH_IOCTL_DEV_USAGE_V2:
893 return bch2_ioctl_dev_usage_v2(c, arg);
895 case BCH_IOCTL_START:
896 BCH_IOCTL(start, struct bch_ioctl_start);
898 return bch2_ioctl_stop(c);
900 case BCH_IOCTL_READ_SUPER:
901 BCH_IOCTL(read_super, struct bch_ioctl_read_super);
902 case BCH_IOCTL_DISK_GET_IDX:
903 BCH_IOCTL(disk_get_idx, struct bch_ioctl_disk_get_idx);
906 if (!test_bit(BCH_FS_started, &c->flags))
910 case BCH_IOCTL_DISK_ADD:
911 BCH_IOCTL(disk_add, struct bch_ioctl_disk);
912 case BCH_IOCTL_DISK_REMOVE:
913 BCH_IOCTL(disk_remove, struct bch_ioctl_disk);
914 case BCH_IOCTL_DISK_ONLINE:
915 BCH_IOCTL(disk_online, struct bch_ioctl_disk);
916 case BCH_IOCTL_DISK_OFFLINE:
917 BCH_IOCTL(disk_offline, struct bch_ioctl_disk);
918 case BCH_IOCTL_DISK_SET_STATE:
919 BCH_IOCTL(disk_set_state, struct bch_ioctl_disk_set_state);
921 BCH_IOCTL(data, struct bch_ioctl_data);
922 case BCH_IOCTL_DISK_RESIZE:
923 BCH_IOCTL(disk_resize, struct bch_ioctl_disk_resize);
924 case BCH_IOCTL_DISK_RESIZE_JOURNAL:
925 BCH_IOCTL(disk_resize_journal, struct bch_ioctl_disk_resize_journal);
926 case BCH_IOCTL_FSCK_ONLINE:
927 BCH_IOCTL(fsck_online, struct bch_ioctl_fsck_online);
933 ret = bch2_err_class(ret);
937 static DEFINE_IDR(bch_chardev_minor);
939 static long bch2_chardev_ioctl(struct file *filp, unsigned cmd, unsigned long v)
941 unsigned minor = iminor(file_inode(filp));
942 struct bch_fs *c = minor < U8_MAX ? idr_find(&bch_chardev_minor, minor) : NULL;
943 void __user *arg = (void __user *) v;
946 ? bch2_fs_ioctl(c, cmd, arg)
947 : bch2_global_ioctl(cmd, arg);
950 static const struct file_operations bch_chardev_fops = {
951 .owner = THIS_MODULE,
952 .unlocked_ioctl = bch2_chardev_ioctl,
953 .open = nonseekable_open,
956 static int bch_chardev_major;
957 static const struct class bch_chardev_class = {
960 static struct device *bch_chardev;
962 void bch2_fs_chardev_exit(struct bch_fs *c)
964 if (!IS_ERR_OR_NULL(c->chardev))
965 device_unregister(c->chardev);
967 idr_remove(&bch_chardev_minor, c->minor);
970 int bch2_fs_chardev_init(struct bch_fs *c)
972 c->minor = idr_alloc(&bch_chardev_minor, c, 0, 0, GFP_KERNEL);
976 c->chardev = device_create(&bch_chardev_class, NULL,
977 MKDEV(bch_chardev_major, c->minor), c,
978 "bcachefs%u-ctl", c->minor);
979 if (IS_ERR(c->chardev))
980 return PTR_ERR(c->chardev);
985 void bch2_chardev_exit(void)
987 device_destroy(&bch_chardev_class, MKDEV(bch_chardev_major, U8_MAX));
988 class_unregister(&bch_chardev_class);
989 if (bch_chardev_major > 0)
990 unregister_chrdev(bch_chardev_major, "bcachefs");
993 int __init bch2_chardev_init(void)
997 bch_chardev_major = register_chrdev(0, "bcachefs-ctl", &bch_chardev_fops);
998 if (bch_chardev_major < 0)
999 return bch_chardev_major;
1001 ret = class_register(&bch_chardev_class);
1005 bch_chardev = device_create(&bch_chardev_class, NULL,
1006 MKDEV(bch_chardev_major, U8_MAX),
1007 NULL, "bcachefs-ctl");
1008 if (IS_ERR(bch_chardev)) {
1009 ret = PTR_ERR(bch_chardev);
1016 class_unregister(&bch_chardev_class);
1018 unregister_chrdev(bch_chardev_major, "bcachefs-ctl");
1022 #endif /* NO_BCACHEFS_CHARDEV */