1 // SPDX-License-Identifier: GPL-2.0
2 #ifndef NO_BCACHEFS_CHARDEV
5 #include "bcachefs_ioctl.h"
14 #include <linux/anon_inodes.h>
15 #include <linux/cdev.h>
16 #include <linux/device.h>
17 #include <linux/file.h>
19 #include <linux/ioctl.h>
20 #include <linux/kthread.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);
37 ca = rcu_dereference(c->devs[dev]);
39 percpu_ref_get(&ca->ref);
43 return ERR_PTR(-EINVAL);
47 path = strndup_user((const char __user *)
48 (unsigned long) dev, PATH_MAX);
50 return ERR_CAST(path);
52 ca = bch2_dev_lookup(c, path);
60 static long bch2_ioctl_assemble(struct bch_ioctl_assemble __user *user_arg)
62 struct bch_ioctl_assemble arg;
64 u64 *user_devs = NULL;
69 if (copy_from_user(&arg, user_arg, sizeof(arg)))
72 if (arg.flags || arg.pad)
75 user_devs = kmalloc_array(arg.nr_devs, sizeof(u64), GFP_KERNEL);
79 devs = kcalloc(arg.nr_devs, sizeof(char *), GFP_KERNEL);
81 if (copy_from_user(user_devs, user_arg->devs,
82 sizeof(u64) * arg.nr_devs))
85 for (i = 0; i < arg.nr_devs; i++) {
86 devs[i] = strndup_user((const char __user *)(unsigned long)
95 c = bch2_fs_open(devs, arg.nr_devs, bch2_opts_empty());
96 ret = PTR_ERR_OR_ZERO(c);
101 for (i = 0; i < arg.nr_devs; i++)
107 static long bch2_ioctl_incremental(struct bch_ioctl_incremental __user *user_arg)
109 struct bch_ioctl_incremental arg;
113 if (copy_from_user(&arg, user_arg, sizeof(arg)))
116 if (arg.flags || arg.pad)
119 path = strndup_user((const char __user *)(unsigned long) arg.dev, PATH_MAX);
123 err = bch2_fs_open_incremental(path);
127 pr_err("Could not register bcachefs devices: %s", err);
135 static long bch2_global_ioctl(unsigned cmd, void __user *arg)
139 case BCH_IOCTL_ASSEMBLE:
140 return bch2_ioctl_assemble(arg);
141 case BCH_IOCTL_INCREMENTAL:
142 return bch2_ioctl_incremental(arg);
149 static long bch2_ioctl_query_uuid(struct bch_fs *c,
150 struct bch_ioctl_query_uuid __user *user_arg)
152 return copy_to_user(&user_arg->uuid,
154 sizeof(c->sb.user_uuid));
158 static long bch2_ioctl_start(struct bch_fs *c, struct bch_ioctl_start arg)
160 if (!capable(CAP_SYS_ADMIN))
163 if (arg.flags || arg.pad)
166 return bch2_fs_start(c);
169 static long bch2_ioctl_stop(struct bch_fs *c)
171 if (!capable(CAP_SYS_ADMIN))
179 static long bch2_ioctl_disk_add(struct bch_fs *c, struct bch_ioctl_disk arg)
184 if (!capable(CAP_SYS_ADMIN))
187 if (arg.flags || arg.pad)
190 path = strndup_user((const char __user *)(unsigned long) arg.dev, PATH_MAX);
194 ret = bch2_dev_add(c, path);
200 static long bch2_ioctl_disk_remove(struct bch_fs *c, struct bch_ioctl_disk arg)
204 if (!capable(CAP_SYS_ADMIN))
207 if ((arg.flags & ~(BCH_FORCE_IF_DATA_LOST|
208 BCH_FORCE_IF_METADATA_LOST|
209 BCH_FORCE_IF_DEGRADED|
214 ca = bch2_device_lookup(c, arg.dev, arg.flags);
218 return bch2_dev_remove(c, ca, arg.flags);
221 static long bch2_ioctl_disk_online(struct bch_fs *c, struct bch_ioctl_disk arg)
226 if (!capable(CAP_SYS_ADMIN))
229 if (arg.flags || arg.pad)
232 path = strndup_user((const char __user *)(unsigned long) arg.dev, PATH_MAX);
236 ret = bch2_dev_online(c, path);
241 static long bch2_ioctl_disk_offline(struct bch_fs *c, struct bch_ioctl_disk arg)
246 if (!capable(CAP_SYS_ADMIN))
249 if ((arg.flags & ~(BCH_FORCE_IF_DATA_LOST|
250 BCH_FORCE_IF_METADATA_LOST|
251 BCH_FORCE_IF_DEGRADED|
256 ca = bch2_device_lookup(c, arg.dev, arg.flags);
260 ret = bch2_dev_offline(c, ca, arg.flags);
261 percpu_ref_put(&ca->ref);
265 static long bch2_ioctl_disk_set_state(struct bch_fs *c,
266 struct bch_ioctl_disk_set_state arg)
271 if (!capable(CAP_SYS_ADMIN))
274 if ((arg.flags & ~(BCH_FORCE_IF_DATA_LOST|
275 BCH_FORCE_IF_METADATA_LOST|
276 BCH_FORCE_IF_DEGRADED|
278 arg.pad[0] || arg.pad[1] || arg.pad[2] ||
279 arg.new_state >= BCH_MEMBER_STATE_NR)
282 ca = bch2_device_lookup(c, arg.dev, arg.flags);
286 ret = bch2_dev_set_state(c, ca, arg.new_state, arg.flags);
288 percpu_ref_put(&ca->ref);
292 struct bch_data_ctx {
294 struct bch_ioctl_data arg;
295 struct bch_move_stats stats;
299 struct task_struct *thread;
302 static int bch2_data_thread(void *arg)
304 struct bch_data_ctx *ctx = arg;
306 ctx->ret = bch2_data_job(ctx->c, &ctx->stats, ctx->arg);
308 ctx->stats.data_type = U8_MAX;
312 static int bch2_data_job_release(struct inode *inode, struct file *file)
314 struct bch_data_ctx *ctx = file->private_data;
316 kthread_stop(ctx->thread);
317 put_task_struct(ctx->thread);
322 static ssize_t bch2_data_job_read(struct file *file, char __user *buf,
323 size_t len, loff_t *ppos)
325 struct bch_data_ctx *ctx = file->private_data;
326 struct bch_fs *c = ctx->c;
327 struct bch_ioctl_data_event e = {
328 .type = BCH_DATA_EVENT_PROGRESS,
329 .p.data_type = ctx->stats.data_type,
330 .p.btree_id = ctx->stats.btree_id,
331 .p.pos = ctx->stats.pos,
332 .p.sectors_done = atomic64_read(&ctx->stats.sectors_seen),
333 .p.sectors_total = bch2_fs_usage_read_short(c).used,
339 return copy_to_user(buf, &e, sizeof(e)) ?: sizeof(e);
342 static const struct file_operations bcachefs_data_ops = {
343 .release = bch2_data_job_release,
344 .read = bch2_data_job_read,
348 static long bch2_ioctl_data(struct bch_fs *c,
349 struct bch_ioctl_data arg)
351 struct bch_data_ctx *ctx = NULL;
352 struct file *file = NULL;
353 unsigned flags = O_RDONLY|O_CLOEXEC|O_NONBLOCK;
356 if (!capable(CAP_SYS_ADMIN))
359 if (arg.op >= BCH_DATA_OP_NR || arg.flags)
362 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
369 ctx->thread = kthread_create(bch2_data_thread, ctx,
370 "bch-data/%s", c->name);
371 if (IS_ERR(ctx->thread)) {
372 ret = PTR_ERR(ctx->thread);
376 ret = get_unused_fd_flags(flags);
381 file = anon_inode_getfile("[bcachefs]", &bcachefs_data_ops, ctx, flags);
387 fd_install(fd, file);
389 get_task_struct(ctx->thread);
390 wake_up_process(ctx->thread);
396 if (!IS_ERR_OR_NULL(ctx->thread))
397 kthread_stop(ctx->thread);
402 static long bch2_ioctl_fs_usage(struct bch_fs *c,
403 struct bch_ioctl_fs_usage __user *user_arg)
405 struct bch_ioctl_fs_usage *arg = NULL;
406 struct bch_replicas_usage *dst_e, *dst_end;
407 struct bch_fs_usage_online *src;
408 u32 replica_entries_bytes;
412 if (!test_bit(BCH_FS_STARTED, &c->flags))
415 if (get_user(replica_entries_bytes, &user_arg->replica_entries_bytes))
418 arg = kzalloc(sizeof(*arg) + replica_entries_bytes, GFP_KERNEL);
422 src = bch2_fs_usage_read(c);
428 arg->capacity = c->capacity;
429 arg->used = bch2_fs_sectors_used(c, src);
430 arg->online_reserved = src->online_reserved;
432 for (i = 0; i < BCH_REPLICAS_MAX; i++)
433 arg->persistent_reserved[i] = src->u.persistent_reserved[i];
435 dst_e = arg->replicas;
436 dst_end = (void *) arg->replicas + replica_entries_bytes;
438 for (i = 0; i < c->replicas.nr; i++) {
439 struct bch_replicas_entry *src_e =
440 cpu_replicas_entry(&c->replicas, i);
442 /* check that we have enough space for one replicas entry */
443 if (dst_e + 1 > dst_end) {
448 dst_e->sectors = src->u.replicas[i];
451 /* recheck after setting nr_devs: */
452 if (replicas_usage_next(dst_e) > dst_end) {
457 memcpy(dst_e->r.devs, src_e->devs, src_e->nr_devs);
459 dst_e = replicas_usage_next(dst_e);
462 arg->replica_entries_bytes = (void *) dst_e - (void *) arg->replicas;
464 percpu_up_read(&c->mark_lock);
468 ret = copy_to_user(user_arg, arg,
469 sizeof(*arg) + arg->replica_entries_bytes);
475 static long bch2_ioctl_dev_usage(struct bch_fs *c,
476 struct bch_ioctl_dev_usage __user *user_arg)
478 struct bch_ioctl_dev_usage arg;
479 struct bch_dev_usage src;
483 if (!test_bit(BCH_FS_STARTED, &c->flags))
486 if (copy_from_user(&arg, user_arg, sizeof(arg)))
489 if ((arg.flags & ~BCH_BY_INDEX) ||
495 ca = bch2_device_lookup(c, arg.dev, arg.flags);
499 src = bch2_dev_usage_read(ca);
501 arg.state = ca->mi.state;
502 arg.bucket_size = ca->mi.bucket_size;
503 arg.nr_buckets = ca->mi.nbuckets - ca->mi.first_bucket;
504 arg.buckets_ec = src.buckets_ec;
506 for (i = 0; i < BCH_DATA_NR; i++) {
507 arg.d[i].buckets = src.d[i].buckets;
508 arg.d[i].sectors = src.d[i].sectors;
509 arg.d[i].fragmented = src.d[i].fragmented;
512 percpu_ref_put(&ca->ref);
514 return copy_to_user(user_arg, &arg, sizeof(arg));
517 static long bch2_ioctl_read_super(struct bch_fs *c,
518 struct bch_ioctl_read_super arg)
520 struct bch_dev *ca = NULL;
524 if (!capable(CAP_SYS_ADMIN))
527 if ((arg.flags & ~(BCH_BY_INDEX|BCH_READ_DEV)) ||
531 mutex_lock(&c->sb_lock);
533 if (arg.flags & BCH_READ_DEV) {
534 ca = bch2_device_lookup(c, arg.dev, arg.flags);
546 if (vstruct_bytes(sb) > arg.size) {
551 ret = copy_to_user((void __user *)(unsigned long)arg.sb,
552 sb, vstruct_bytes(sb));
554 if (!IS_ERR_OR_NULL(ca))
555 percpu_ref_put(&ca->ref);
556 mutex_unlock(&c->sb_lock);
560 static long bch2_ioctl_disk_get_idx(struct bch_fs *c,
561 struct bch_ioctl_disk_get_idx arg)
563 dev_t dev = huge_decode_dev(arg.dev);
567 if (!capable(CAP_SYS_ADMIN))
573 for_each_online_member(ca, c, i)
574 if (ca->dev == dev) {
575 percpu_ref_put(&ca->io_ref);
582 static long bch2_ioctl_disk_resize(struct bch_fs *c,
583 struct bch_ioctl_disk_resize arg)
588 if (!capable(CAP_SYS_ADMIN))
591 if ((arg.flags & ~BCH_BY_INDEX) ||
595 ca = bch2_device_lookup(c, arg.dev, arg.flags);
599 ret = bch2_dev_resize(c, ca, arg.nbuckets);
601 percpu_ref_put(&ca->ref);
605 static long bch2_ioctl_disk_resize_journal(struct bch_fs *c,
606 struct bch_ioctl_disk_resize_journal 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_set_nr_journal_buckets(c, ca, arg.nbuckets);
624 percpu_ref_put(&ca->ref);
628 #define BCH_IOCTL(_name, _argtype) \
632 if (copy_from_user(&i, arg, sizeof(i))) \
634 return bch2_ioctl_##_name(c, i); \
637 long bch2_fs_ioctl(struct bch_fs *c, unsigned cmd, void __user *arg)
640 case BCH_IOCTL_QUERY_UUID:
641 return bch2_ioctl_query_uuid(c, arg);
642 case BCH_IOCTL_FS_USAGE:
643 return bch2_ioctl_fs_usage(c, arg);
644 case BCH_IOCTL_DEV_USAGE:
645 return bch2_ioctl_dev_usage(c, arg);
647 case BCH_IOCTL_START:
648 BCH_IOCTL(start, struct bch_ioctl_start);
650 return bch2_ioctl_stop(c);
652 case BCH_IOCTL_READ_SUPER:
653 BCH_IOCTL(read_super, struct bch_ioctl_read_super);
654 case BCH_IOCTL_DISK_GET_IDX:
655 BCH_IOCTL(disk_get_idx, struct bch_ioctl_disk_get_idx);
658 if (!test_bit(BCH_FS_STARTED, &c->flags))
662 case BCH_IOCTL_DISK_ADD:
663 BCH_IOCTL(disk_add, struct bch_ioctl_disk);
664 case BCH_IOCTL_DISK_REMOVE:
665 BCH_IOCTL(disk_remove, struct bch_ioctl_disk);
666 case BCH_IOCTL_DISK_ONLINE:
667 BCH_IOCTL(disk_online, struct bch_ioctl_disk);
668 case BCH_IOCTL_DISK_OFFLINE:
669 BCH_IOCTL(disk_offline, struct bch_ioctl_disk);
670 case BCH_IOCTL_DISK_SET_STATE:
671 BCH_IOCTL(disk_set_state, struct bch_ioctl_disk_set_state);
673 BCH_IOCTL(data, struct bch_ioctl_data);
674 case BCH_IOCTL_DISK_RESIZE:
675 BCH_IOCTL(disk_resize, struct bch_ioctl_disk_resize);
676 case BCH_IOCTL_DISK_RESIZE_JOURNAL:
677 BCH_IOCTL(disk_resize_journal, struct bch_ioctl_disk_resize_journal);
684 static DEFINE_IDR(bch_chardev_minor);
686 static long bch2_chardev_ioctl(struct file *filp, unsigned cmd, unsigned long v)
688 unsigned minor = iminor(file_inode(filp));
689 struct bch_fs *c = minor < U8_MAX ? idr_find(&bch_chardev_minor, minor) : NULL;
690 void __user *arg = (void __user *) v;
693 ? bch2_fs_ioctl(c, cmd, arg)
694 : bch2_global_ioctl(cmd, arg);
697 static const struct file_operations bch_chardev_fops = {
698 .owner = THIS_MODULE,
699 .unlocked_ioctl = bch2_chardev_ioctl,
700 .open = nonseekable_open,
703 static int bch_chardev_major;
704 static struct class *bch_chardev_class;
705 static struct device *bch_chardev;
707 void bch2_fs_chardev_exit(struct bch_fs *c)
709 if (!IS_ERR_OR_NULL(c->chardev))
710 device_unregister(c->chardev);
712 idr_remove(&bch_chardev_minor, c->minor);
715 int bch2_fs_chardev_init(struct bch_fs *c)
717 c->minor = idr_alloc(&bch_chardev_minor, c, 0, 0, GFP_KERNEL);
721 c->chardev = device_create(bch_chardev_class, NULL,
722 MKDEV(bch_chardev_major, c->minor), c,
723 "bcachefs%u-ctl", c->minor);
724 if (IS_ERR(c->chardev))
725 return PTR_ERR(c->chardev);
730 void bch2_chardev_exit(void)
732 if (!IS_ERR_OR_NULL(bch_chardev_class))
733 device_destroy(bch_chardev_class,
734 MKDEV(bch_chardev_major, U8_MAX));
735 if (!IS_ERR_OR_NULL(bch_chardev_class))
736 class_destroy(bch_chardev_class);
737 if (bch_chardev_major > 0)
738 unregister_chrdev(bch_chardev_major, "bcachefs");
741 int __init bch2_chardev_init(void)
743 bch_chardev_major = register_chrdev(0, "bcachefs-ctl", &bch_chardev_fops);
744 if (bch_chardev_major < 0)
745 return bch_chardev_major;
747 bch_chardev_class = class_create(THIS_MODULE, "bcachefs");
748 if (IS_ERR(bch_chardev_class))
749 return PTR_ERR(bch_chardev_class);
751 bch_chardev = device_create(bch_chardev_class, NULL,
752 MKDEV(bch_chardev_major, U8_MAX),
753 NULL, "bcachefs-ctl");
754 if (IS_ERR(bch_chardev))
755 return PTR_ERR(bch_chardev);
760 #endif /* NO_BCACHEFS_CHARDEV */