1 // SPDX-License-Identifier: GPL-2.0
2 #ifndef NO_BCACHEFS_CHARDEV
5 #include "bcachefs_ioctl.h"
8 #include "disk_accounting.h"
12 #include "recovery_passes.h"
15 #include "thread_with_file.h"
17 #include <linux/cdev.h>
18 #include <linux/device.h>
20 #include <linux/ioctl.h>
21 #include <linux/major.h>
22 #include <linux/sched/task.h>
23 #include <linux/slab.h>
24 #include <linux/uaccess.h>
26 /* returns with ref on ca->ref */
27 static struct bch_dev *bch2_device_lookup(struct bch_fs *c, u64 dev,
32 if (flags & BCH_BY_INDEX) {
33 if (dev >= c->sb.nr_devices)
34 return ERR_PTR(-EINVAL);
36 ca = bch2_dev_tryget_noerror(c, dev);
38 return ERR_PTR(-EINVAL);
42 path = strndup_user((const char __user *)
43 (unsigned long) dev, PATH_MAX);
45 return ERR_CAST(path);
47 ca = bch2_dev_lookup(c, path);
55 static long bch2_ioctl_assemble(struct bch_ioctl_assemble __user *user_arg)
57 struct bch_ioctl_assemble arg;
59 u64 *user_devs = NULL;
64 if (copy_from_user(&arg, user_arg, sizeof(arg)))
67 if (arg.flags || arg.pad)
70 user_devs = kmalloc_array(arg.nr_devs, sizeof(u64), GFP_KERNEL);
74 devs = kcalloc(arg.nr_devs, sizeof(char *), GFP_KERNEL);
76 if (copy_from_user(user_devs, user_arg->devs,
77 sizeof(u64) * arg.nr_devs))
80 for (i = 0; i < arg.nr_devs; i++) {
81 devs[i] = strndup_user((const char __user *)(unsigned long)
84 ret= PTR_ERR_OR_ZERO(devs[i]);
89 c = bch2_fs_open(devs, arg.nr_devs, bch2_opts_empty());
90 ret = PTR_ERR_OR_ZERO(c);
95 for (i = 0; i < arg.nr_devs; i++)
101 static long bch2_ioctl_incremental(struct bch_ioctl_incremental __user *user_arg)
103 struct bch_ioctl_incremental arg;
107 if (copy_from_user(&arg, user_arg, sizeof(arg)))
110 if (arg.flags || arg.pad)
113 path = strndup_user((const char __user *)(unsigned long) arg.dev, PATH_MAX);
114 ret = PTR_ERR_OR_ZERO(path);
118 err = bch2_fs_open_incremental(path);
122 pr_err("Could not register bcachefs devices: %s", err);
130 static long bch2_global_ioctl(unsigned cmd, void __user *arg)
136 case BCH_IOCTL_ASSEMBLE:
137 return bch2_ioctl_assemble(arg);
138 case BCH_IOCTL_INCREMENTAL:
139 return bch2_ioctl_incremental(arg);
141 case BCH_IOCTL_FSCK_OFFLINE: {
142 ret = bch2_ioctl_fsck_offline(arg);
151 ret = bch2_err_class(ret);
155 static long bch2_ioctl_query_uuid(struct bch_fs *c,
156 struct bch_ioctl_query_uuid __user *user_arg)
158 return copy_to_user_errcode(&user_arg->uuid, &c->sb.user_uuid,
159 sizeof(c->sb.user_uuid));
163 static long bch2_ioctl_start(struct bch_fs *c, struct bch_ioctl_start arg)
165 if (!capable(CAP_SYS_ADMIN))
168 if (arg.flags || arg.pad)
171 return bch2_fs_start(c);
174 static long bch2_ioctl_stop(struct bch_fs *c)
176 if (!capable(CAP_SYS_ADMIN))
184 static long bch2_ioctl_disk_add(struct bch_fs *c, struct bch_ioctl_disk arg)
189 if (!capable(CAP_SYS_ADMIN))
192 if (arg.flags || arg.pad)
195 path = strndup_user((const char __user *)(unsigned long) arg.dev, PATH_MAX);
196 ret = PTR_ERR_OR_ZERO(path);
200 ret = bch2_dev_add(c, path);
207 static long bch2_ioctl_disk_remove(struct bch_fs *c, struct bch_ioctl_disk arg)
211 if (!capable(CAP_SYS_ADMIN))
214 if ((arg.flags & ~(BCH_FORCE_IF_DATA_LOST|
215 BCH_FORCE_IF_METADATA_LOST|
216 BCH_FORCE_IF_DEGRADED|
221 ca = bch2_device_lookup(c, arg.dev, arg.flags);
225 return bch2_dev_remove(c, ca, arg.flags);
228 static long bch2_ioctl_disk_online(struct bch_fs *c, struct bch_ioctl_disk arg)
233 if (!capable(CAP_SYS_ADMIN))
236 if (arg.flags || arg.pad)
239 path = strndup_user((const char __user *)(unsigned long) arg.dev, PATH_MAX);
240 ret = PTR_ERR_OR_ZERO(path);
244 ret = bch2_dev_online(c, path);
249 static long bch2_ioctl_disk_offline(struct bch_fs *c, struct bch_ioctl_disk arg)
254 if (!capable(CAP_SYS_ADMIN))
257 if ((arg.flags & ~(BCH_FORCE_IF_DATA_LOST|
258 BCH_FORCE_IF_METADATA_LOST|
259 BCH_FORCE_IF_DEGRADED|
264 ca = bch2_device_lookup(c, arg.dev, arg.flags);
268 ret = bch2_dev_offline(c, ca, arg.flags);
273 static long bch2_ioctl_disk_set_state(struct bch_fs *c,
274 struct bch_ioctl_disk_set_state arg)
279 if (!capable(CAP_SYS_ADMIN))
282 if ((arg.flags & ~(BCH_FORCE_IF_DATA_LOST|
283 BCH_FORCE_IF_METADATA_LOST|
284 BCH_FORCE_IF_DEGRADED|
286 arg.pad[0] || arg.pad[1] || arg.pad[2] ||
287 arg.new_state >= BCH_MEMBER_STATE_NR)
290 ca = bch2_device_lookup(c, arg.dev, arg.flags);
294 ret = bch2_dev_set_state(c, ca, arg.new_state, arg.flags);
296 bch_err(c, "Error setting device state: %s", bch2_err_str(ret));
302 struct bch_data_ctx {
303 struct thread_with_file thr;
306 struct bch_ioctl_data arg;
307 struct bch_move_stats stats;
310 static int bch2_data_thread(void *arg)
312 struct bch_data_ctx *ctx = container_of(arg, struct bch_data_ctx, thr);
314 ctx->thr.ret = bch2_data_job(ctx->c, &ctx->stats, ctx->arg);
315 ctx->stats.data_type = U8_MAX;
319 static int bch2_data_job_release(struct inode *inode, struct file *file)
321 struct bch_data_ctx *ctx = container_of(file->private_data, struct bch_data_ctx, thr);
323 bch2_thread_with_file_exit(&ctx->thr);
328 static ssize_t bch2_data_job_read(struct file *file, char __user *buf,
329 size_t len, loff_t *ppos)
331 struct bch_data_ctx *ctx = container_of(file->private_data, struct bch_data_ctx, thr);
332 struct bch_fs *c = ctx->c;
333 struct bch_ioctl_data_event e = {
334 .type = BCH_DATA_EVENT_PROGRESS,
335 .p.data_type = ctx->stats.data_type,
336 .p.btree_id = ctx->stats.pos.btree,
337 .p.pos = ctx->stats.pos.pos,
338 .p.sectors_done = atomic64_read(&ctx->stats.sectors_seen),
339 .p.sectors_total = bch2_fs_usage_read_short(c).used,
345 return copy_to_user_errcode(buf, &e, sizeof(e)) ?: sizeof(e);
348 static const struct file_operations bcachefs_data_ops = {
349 .release = bch2_data_job_release,
350 .read = bch2_data_job_read,
353 static long bch2_ioctl_data(struct bch_fs *c,
354 struct bch_ioctl_data arg)
356 struct bch_data_ctx *ctx;
359 if (!capable(CAP_SYS_ADMIN))
362 if (arg.op >= BCH_DATA_OP_NR || arg.flags)
365 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
372 ret = bch2_run_thread_with_file(&ctx->thr,
380 static long bch2_ioctl_fs_usage(struct bch_fs *c,
381 struct bch_ioctl_fs_usage __user *user_arg)
383 struct bch_ioctl_fs_usage arg = {};
384 darray_char replicas = {};
385 u32 replica_entries_bytes;
388 if (!test_bit(BCH_FS_started, &c->flags))
391 if (get_user(replica_entries_bytes, &user_arg->replica_entries_bytes))
394 ret = bch2_fs_replicas_usage_read(c, &replicas) ?:
395 (replica_entries_bytes < replicas.nr ? -ERANGE : 0) ?:
396 copy_to_user_errcode(&user_arg->replicas, replicas.data, replicas.nr);
400 struct bch_fs_usage_short u = bch2_fs_usage_read_short(c);
401 arg.capacity = c->capacity;
403 arg.online_reserved = percpu_u64_get(c->online_reserved);
404 arg.replica_entries_bytes = replicas.nr;
406 for (unsigned i = 0; i < BCH_REPLICAS_MAX; i++) {
407 struct disk_accounting_pos k = {
408 .type = BCH_DISK_ACCOUNTING_persistent_reserved,
409 .persistent_reserved.nr_replicas = i,
412 bch2_accounting_mem_read(c,
413 disk_accounting_pos_to_bpos(&k),
414 &arg.persistent_reserved[i], 1);
417 ret = copy_to_user_errcode(user_arg, &arg, sizeof(arg));
419 darray_exit(&replicas);
423 static long bch2_ioctl_query_accounting(struct bch_fs *c,
424 struct bch_ioctl_query_accounting __user *user_arg)
426 struct bch_ioctl_query_accounting arg;
427 darray_char accounting = {};
430 if (!test_bit(BCH_FS_started, &c->flags))
433 ret = copy_from_user_errcode(&arg, user_arg, sizeof(arg)) ?:
434 bch2_fs_accounting_read(c, &accounting, arg.accounting_types_mask) ?:
435 (arg.accounting_u64s * sizeof(u64) < accounting.nr ? -ERANGE : 0) ?:
436 copy_to_user_errcode(&user_arg->accounting, accounting.data, accounting.nr);
440 arg.capacity = c->capacity;
441 arg.used = bch2_fs_usage_read_short(c).used;
442 arg.online_reserved = percpu_u64_get(c->online_reserved);
443 arg.accounting_u64s = accounting.nr / sizeof(u64);
445 ret = copy_to_user_errcode(user_arg, &arg, sizeof(arg));
447 darray_exit(&accounting);
451 /* obsolete, didn't allow for new data types: */
452 static long bch2_ioctl_dev_usage(struct bch_fs *c,
453 struct bch_ioctl_dev_usage __user *user_arg)
455 struct bch_ioctl_dev_usage arg;
456 struct bch_dev_usage src;
460 if (!test_bit(BCH_FS_started, &c->flags))
463 if (copy_from_user(&arg, user_arg, sizeof(arg)))
466 if ((arg.flags & ~BCH_BY_INDEX) ||
472 ca = bch2_device_lookup(c, arg.dev, arg.flags);
476 src = bch2_dev_usage_read(ca);
478 arg.state = ca->mi.state;
479 arg.bucket_size = ca->mi.bucket_size;
480 arg.nr_buckets = ca->mi.nbuckets - ca->mi.first_bucket;
482 for (i = 0; i < ARRAY_SIZE(arg.d); i++) {
483 arg.d[i].buckets = src.d[i].buckets;
484 arg.d[i].sectors = src.d[i].sectors;
485 arg.d[i].fragmented = src.d[i].fragmented;
490 return copy_to_user_errcode(user_arg, &arg, sizeof(arg));
493 static long bch2_ioctl_dev_usage_v2(struct bch_fs *c,
494 struct bch_ioctl_dev_usage_v2 __user *user_arg)
496 struct bch_ioctl_dev_usage_v2 arg;
497 struct bch_dev_usage src;
501 if (!test_bit(BCH_FS_started, &c->flags))
504 if (copy_from_user(&arg, user_arg, sizeof(arg)))
507 if ((arg.flags & ~BCH_BY_INDEX) ||
513 ca = bch2_device_lookup(c, arg.dev, arg.flags);
517 src = bch2_dev_usage_read(ca);
519 arg.state = ca->mi.state;
520 arg.bucket_size = ca->mi.bucket_size;
521 arg.nr_data_types = min(arg.nr_data_types, BCH_DATA_NR);
522 arg.nr_buckets = ca->mi.nbuckets - ca->mi.first_bucket;
524 ret = copy_to_user_errcode(user_arg, &arg, sizeof(arg));
528 for (unsigned i = 0; i < arg.nr_data_types; i++) {
529 struct bch_ioctl_dev_usage_type t = {
530 .buckets = src.d[i].buckets,
531 .sectors = src.d[i].sectors,
532 .fragmented = src.d[i].fragmented,
535 ret = copy_to_user_errcode(&user_arg->d[i], &t, sizeof(t));
544 static long bch2_ioctl_read_super(struct bch_fs *c,
545 struct bch_ioctl_read_super arg)
547 struct bch_dev *ca = NULL;
551 if (!capable(CAP_SYS_ADMIN))
554 if ((arg.flags & ~(BCH_BY_INDEX|BCH_READ_DEV)) ||
558 mutex_lock(&c->sb_lock);
560 if (arg.flags & BCH_READ_DEV) {
561 ca = bch2_device_lookup(c, arg.dev, arg.flags);
562 ret = PTR_ERR_OR_ZERO(ca);
571 if (vstruct_bytes(sb) > arg.size) {
576 ret = copy_to_user_errcode((void __user *)(unsigned long)arg.sb, sb,
581 mutex_unlock(&c->sb_lock);
585 static long bch2_ioctl_disk_get_idx(struct bch_fs *c,
586 struct bch_ioctl_disk_get_idx arg)
588 dev_t dev = huge_decode_dev(arg.dev);
590 if (!capable(CAP_SYS_ADMIN))
596 for_each_online_member(c, ca)
597 if (ca->dev == dev) {
598 percpu_ref_put(&ca->io_ref);
602 return -BCH_ERR_ENOENT_dev_idx_not_found;
605 static long bch2_ioctl_disk_resize(struct bch_fs *c,
606 struct bch_ioctl_disk_resize arg)
611 if (!capable(CAP_SYS_ADMIN))
614 if ((arg.flags & ~BCH_BY_INDEX) ||
618 ca = bch2_device_lookup(c, arg.dev, arg.flags);
622 ret = bch2_dev_resize(c, ca, arg.nbuckets);
628 static long bch2_ioctl_disk_resize_journal(struct bch_fs *c,
629 struct bch_ioctl_disk_resize_journal arg)
634 if (!capable(CAP_SYS_ADMIN))
637 if ((arg.flags & ~BCH_BY_INDEX) ||
641 if (arg.nbuckets > U32_MAX)
644 ca = bch2_device_lookup(c, arg.dev, arg.flags);
648 ret = bch2_set_nr_journal_buckets(c, ca, arg.nbuckets);
654 #define BCH_IOCTL(_name, _argtype) \
658 if (copy_from_user(&i, arg, sizeof(i))) \
660 ret = bch2_ioctl_##_name(c, i); \
664 long bch2_fs_ioctl(struct bch_fs *c, unsigned cmd, void __user *arg)
669 case BCH_IOCTL_QUERY_UUID:
670 return bch2_ioctl_query_uuid(c, arg);
671 case BCH_IOCTL_FS_USAGE:
672 return bch2_ioctl_fs_usage(c, arg);
673 case BCH_IOCTL_DEV_USAGE:
674 return bch2_ioctl_dev_usage(c, arg);
675 case BCH_IOCTL_DEV_USAGE_V2:
676 return bch2_ioctl_dev_usage_v2(c, arg);
678 case BCH_IOCTL_START:
679 BCH_IOCTL(start, struct bch_ioctl_start);
681 return bch2_ioctl_stop(c);
683 case BCH_IOCTL_READ_SUPER:
684 BCH_IOCTL(read_super, struct bch_ioctl_read_super);
685 case BCH_IOCTL_DISK_GET_IDX:
686 BCH_IOCTL(disk_get_idx, struct bch_ioctl_disk_get_idx);
689 if (!test_bit(BCH_FS_started, &c->flags))
693 case BCH_IOCTL_DISK_ADD:
694 BCH_IOCTL(disk_add, struct bch_ioctl_disk);
695 case BCH_IOCTL_DISK_REMOVE:
696 BCH_IOCTL(disk_remove, struct bch_ioctl_disk);
697 case BCH_IOCTL_DISK_ONLINE:
698 BCH_IOCTL(disk_online, struct bch_ioctl_disk);
699 case BCH_IOCTL_DISK_OFFLINE:
700 BCH_IOCTL(disk_offline, struct bch_ioctl_disk);
701 case BCH_IOCTL_DISK_SET_STATE:
702 BCH_IOCTL(disk_set_state, struct bch_ioctl_disk_set_state);
704 BCH_IOCTL(data, struct bch_ioctl_data);
705 case BCH_IOCTL_DISK_RESIZE:
706 BCH_IOCTL(disk_resize, struct bch_ioctl_disk_resize);
707 case BCH_IOCTL_DISK_RESIZE_JOURNAL:
708 BCH_IOCTL(disk_resize_journal, struct bch_ioctl_disk_resize_journal);
709 case BCH_IOCTL_FSCK_ONLINE:
710 BCH_IOCTL(fsck_online, struct bch_ioctl_fsck_online);
711 case BCH_IOCTL_QUERY_ACCOUNTING:
712 return bch2_ioctl_query_accounting(c, arg);
718 ret = bch2_err_class(ret);
722 static DEFINE_IDR(bch_chardev_minor);
724 static long bch2_chardev_ioctl(struct file *filp, unsigned cmd, unsigned long v)
726 unsigned minor = iminor(file_inode(filp));
727 struct bch_fs *c = minor < U8_MAX ? idr_find(&bch_chardev_minor, minor) : NULL;
728 void __user *arg = (void __user *) v;
731 ? bch2_fs_ioctl(c, cmd, arg)
732 : bch2_global_ioctl(cmd, arg);
735 static const struct file_operations bch_chardev_fops = {
736 .owner = THIS_MODULE,
737 .unlocked_ioctl = bch2_chardev_ioctl,
738 .open = nonseekable_open,
741 static int bch_chardev_major;
742 static const struct class bch_chardev_class = {
745 static struct device *bch_chardev;
747 void bch2_fs_chardev_exit(struct bch_fs *c)
749 if (!IS_ERR_OR_NULL(c->chardev))
750 device_unregister(c->chardev);
752 idr_remove(&bch_chardev_minor, c->minor);
755 int bch2_fs_chardev_init(struct bch_fs *c)
757 c->minor = idr_alloc(&bch_chardev_minor, c, 0, 0, GFP_KERNEL);
761 c->chardev = device_create(&bch_chardev_class, NULL,
762 MKDEV(bch_chardev_major, c->minor), c,
763 "bcachefs%u-ctl", c->minor);
764 if (IS_ERR(c->chardev))
765 return PTR_ERR(c->chardev);
770 void bch2_chardev_exit(void)
772 device_destroy(&bch_chardev_class, MKDEV(bch_chardev_major, U8_MAX));
773 class_unregister(&bch_chardev_class);
774 if (bch_chardev_major > 0)
775 unregister_chrdev(bch_chardev_major, "bcachefs");
778 int __init bch2_chardev_init(void)
782 bch_chardev_major = register_chrdev(0, "bcachefs-ctl", &bch_chardev_fops);
783 if (bch_chardev_major < 0)
784 return bch_chardev_major;
786 ret = class_register(&bch_chardev_class);
790 bch_chardev = device_create(&bch_chardev_class, NULL,
791 MKDEV(bch_chardev_major, U8_MAX),
792 NULL, "bcachefs-ctl");
793 if (IS_ERR(bch_chardev)) {
794 ret = PTR_ERR(bch_chardev);
801 class_unregister(&bch_chardev_class);
803 unregister_chrdev(bch_chardev_major, "bcachefs-ctl");
807 #endif /* NO_BCACHEFS_CHARDEV */