1 /* SPDX-License-Identifier: GPL-2.0 */
2 #ifndef _BCACHEFS_IOCTL_H
3 #define _BCACHEFS_IOCTL_H
5 #include <linux/uuid.h>
7 #include "bcachefs_format.h"
10 * Flags common to multiple ioctls:
12 #define BCH_FORCE_IF_DATA_LOST (1 << 0)
13 #define BCH_FORCE_IF_METADATA_LOST (1 << 1)
14 #define BCH_FORCE_IF_DATA_DEGRADED (1 << 2)
15 #define BCH_FORCE_IF_METADATA_DEGRADED (1 << 3)
17 #define BCH_FORCE_IF_LOST \
18 (BCH_FORCE_IF_DATA_LOST| \
19 BCH_FORCE_IF_METADATA_LOST)
20 #define BCH_FORCE_IF_DEGRADED \
21 (BCH_FORCE_IF_DATA_DEGRADED| \
22 BCH_FORCE_IF_METADATA_DEGRADED)
25 * If cleared, ioctl that refer to a device pass it as a pointer to a pathname
26 * (e.g. /dev/sda1); if set, the dev field is the device's index within the
29 #define BCH_BY_INDEX (1 << 4)
32 * For BCH_IOCTL_READ_SUPER: get superblock of a specific device, not filesystem
35 #define BCH_READ_DEV (1 << 5)
37 /* global control dev: */
39 /* These are currently broken, and probably unnecessary: */
41 #define BCH_IOCTL_ASSEMBLE _IOW(0xbc, 1, struct bch_ioctl_assemble)
42 #define BCH_IOCTL_INCREMENTAL _IOW(0xbc, 2, struct bch_ioctl_incremental)
44 struct bch_ioctl_assemble {
51 struct bch_ioctl_incremental {
58 /* filesystem ioctls: */
60 #define BCH_IOCTL_QUERY_UUID _IOR(0xbc, 1, struct bch_ioctl_query_uuid)
62 /* These only make sense when we also have incremental assembly */
64 #define BCH_IOCTL_START _IOW(0xbc, 2, struct bch_ioctl_start)
65 #define BCH_IOCTL_STOP _IO(0xbc, 3)
68 #define BCH_IOCTL_DISK_ADD _IOW(0xbc, 4, struct bch_ioctl_disk)
69 #define BCH_IOCTL_DISK_REMOVE _IOW(0xbc, 5, struct bch_ioctl_disk)
70 #define BCH_IOCTL_DISK_ONLINE _IOW(0xbc, 6, struct bch_ioctl_disk)
71 #define BCH_IOCTL_DISK_OFFLINE _IOW(0xbc, 7, struct bch_ioctl_disk)
72 #define BCH_IOCTL_DISK_SET_STATE _IOW(0xbc, 8, struct bch_ioctl_disk_set_state)
73 #define BCH_IOCTL_DATA _IOW(0xbc, 10, struct bch_ioctl_data)
74 #define BCH_IOCTL_FS_USAGE _IOWR(0xbc, 11, struct bch_ioctl_fs_usage)
75 #define BCH_IOCTL_DEV_USAGE _IOWR(0xbc, 11, struct bch_ioctl_dev_usage)
76 #define BCH_IOCTL_READ_SUPER _IOW(0xbc, 12, struct bch_ioctl_read_super)
77 #define BCH_IOCTL_DISK_GET_IDX _IOW(0xbc, 13, struct bch_ioctl_disk_get_idx)
78 #define BCH_IOCTL_DISK_RESIZE _IOW(0xbc, 14, struct bch_ioctl_disk_resize)
79 #define BCH_IOCTL_DISK_RESIZE_JOURNAL _IOW(0xbc,15, struct bch_ioctl_disk_resize_journal)
81 #define BCH_IOCTL_SUBVOLUME_CREATE _IOW(0xbc, 16, struct bch_ioctl_subvolume)
82 #define BCH_IOCTL_SUBVOLUME_DESTROY _IOW(0xbc, 17, struct bch_ioctl_subvolume)
84 #define BCH_IOCTL_DEV_USAGE_V2 _IOWR(0xbc, 18, struct bch_ioctl_dev_usage_v2)
86 #define BCH_IOCTL_FSCK_OFFLINE _IOW(0xbc, 19, struct bch_ioctl_fsck_offline)
87 #define BCH_IOCTL_FSCK_ONLINE _IOW(0xbc, 20, struct bch_ioctl_fsck_online)
89 /* ioctl below act on a particular file, not the filesystem as a whole: */
91 #define BCHFS_IOC_REINHERIT_ATTRS _IOR(0xbc, 64, const char __user *)
94 * BCH_IOCTL_QUERY_UUID: get filesystem UUID
96 * Returns user visible UUID, not internal UUID (which may not ever be changed);
97 * the filesystem's sysfs directory may be found under /sys/fs/bcachefs with
100 struct bch_ioctl_query_uuid {
105 struct bch_ioctl_start {
112 * BCH_IOCTL_DISK_ADD: add a new device to an existing filesystem
114 * The specified device must not be open or in use. On success, the new device
115 * will be an online member of the filesystem just like any other member.
117 * The device must first be prepared by userspace by formatting with a bcachefs
118 * superblock, which is only used for passing in superblock options/parameters
119 * for that device (in struct bch_member). The new device's superblock should
120 * not claim to be a member of any existing filesystem - UUIDs on it will be
125 * BCH_IOCTL_DISK_REMOVE: permanently remove a member device from a filesystem
127 * Any data present on @dev will be permanently deleted, and @dev will be
128 * removed from its slot in the filesystem's list of member devices. The device
129 * may be either offline or offline.
131 * Will fail removing @dev would leave us with insufficient read write devices
132 * or degraded/unavailable data, unless the approprate BCH_FORCE_IF_* flags are
137 * BCH_IOCTL_DISK_ONLINE: given a disk that is already a member of a filesystem
138 * but is not open (e.g. because we started in degraded mode), bring it online
140 * all existing data on @dev will be available once the device is online,
141 * exactly as if @dev was present when the filesystem was first mounted
145 * BCH_IOCTL_DISK_OFFLINE: offline a disk, causing the kernel to close that
146 * block device, without removing it from the filesystem (so it can be brought
149 * Data present on @dev will be unavailable while @dev is offline (unless
150 * replicated), but will still be intact and untouched if @dev is brought back
153 * Will fail (similarly to BCH_IOCTL_DISK_SET_STATE) if offlining @dev would
154 * leave us with insufficient read write devices or degraded/unavailable data,
155 * unless the approprate BCH_FORCE_IF_* flags are set.
158 struct bch_ioctl_disk {
165 * BCH_IOCTL_DISK_SET_STATE: modify state of a member device of a filesystem
167 * @new_state - one of the bch_member_state states (rw, ro, failed,
170 * Will refuse to change member state if we would then have insufficient devices
171 * to write to, or if it would result in degraded data (when @new_state is
172 * failed or spare) unless the appropriate BCH_FORCE_IF_* flags are set.
174 struct bch_ioctl_disk_set_state {
181 #define BCH_DATA_OPS() \
185 x(rewrite_old_nodes, 3) \
186 x(drop_extra_replicas, 4)
189 #define x(t, n) BCH_DATA_OP_##t = n,
196 * BCH_IOCTL_DATA: operations that walk and manipulate filesystem data (e.g.
197 * scrub, rereplicate, migrate).
199 * This ioctl kicks off a job in the background, and returns a file descriptor.
200 * Reading from the file descriptor returns a struct bch_ioctl_data_event,
201 * indicating current progress, and closing the file descriptor will stop the
202 * job. The file descriptor is O_CLOEXEC.
204 struct bch_ioctl_data {
210 struct bpos start_pos;
222 } __packed __aligned(8);
224 enum bch_data_event {
225 BCH_DATA_EVENT_PROGRESS = 0,
226 /* XXX: add an event for reporting errors */
227 BCH_DATA_EVENT_NR = 1,
230 struct bch_ioctl_data_progress {
238 } __packed __aligned(8);
240 struct bch_ioctl_data_event {
244 struct bch_ioctl_data_progress p;
247 } __packed __aligned(8);
249 struct bch_replicas_usage {
251 struct bch_replicas_entry_v1 r;
254 static inline struct bch_replicas_usage *
255 replicas_usage_next(struct bch_replicas_usage *u)
257 return (void *) u + replicas_entry_bytes(&u->r) + 8;
261 * BCH_IOCTL_FS_USAGE: query filesystem disk space usage
263 * Returns disk space usage broken out by data type, number of replicas, and
264 * by component device
266 * @replica_entries_bytes - size, in bytes, allocated for replica usage entries
268 * On success, @replica_entries_bytes will be changed to indicate the number of
269 * bytes actually used.
271 * Returns -ERANGE if @replica_entries_bytes was too small
273 struct bch_ioctl_fs_usage {
276 __u64 online_reserved;
277 __u64 persistent_reserved[BCH_REPLICAS_MAX];
279 __u32 replica_entries_bytes;
282 struct bch_replicas_usage replicas[];
286 * BCH_IOCTL_DEV_USAGE: query device disk space usage
288 * Returns disk space usage broken out by data type - both by buckets and
291 struct bch_ioctl_dev_usage {
302 struct bch_ioctl_dev_usage_type {
309 struct bch_ioctl_dev_usage_v2 {
319 struct bch_ioctl_dev_usage_type d[];
323 * BCH_IOCTL_READ_SUPER: read filesystem superblock
325 * Equivalent to reading the superblock directly from the block device, except
326 * avoids racing with the kernel writing the superblock or having to figure out
327 * which block device to read
329 * @sb - buffer to read into
330 * @size - size of userspace allocated buffer
331 * @dev - device to read superblock for, if BCH_READ_DEV flag is
334 * Returns -ERANGE if buffer provided is too small
336 struct bch_ioctl_read_super {
345 * BCH_IOCTL_DISK_GET_IDX: give a path to a block device, query filesystem to
346 * determine if disk is a (online) member - if so, returns device's index
348 * Returns -ENOENT if not found
350 struct bch_ioctl_disk_get_idx {
355 * BCH_IOCTL_DISK_RESIZE: resize filesystem on a device
357 * @dev - member to resize
358 * @nbuckets - new number of buckets
360 struct bch_ioctl_disk_resize {
368 * BCH_IOCTL_DISK_RESIZE_JOURNAL: resize journal on a device
370 * @dev - member to resize
371 * @nbuckets - new number of buckets
373 struct bch_ioctl_disk_resize_journal {
380 struct bch_ioctl_subvolume {
389 #define BCH_SUBVOL_SNAPSHOT_CREATE (1U << 0)
390 #define BCH_SUBVOL_SNAPSHOT_RO (1U << 1)
393 * BCH_IOCTL_FSCK_OFFLINE: run fsck from the 'bcachefs fsck' userspace command,
394 * but with the kernel's implementation of fsck:
396 struct bch_ioctl_fsck_offline {
398 __u64 opts; /* string */
400 __u64 devs[] __counted_by(nr_devs);
404 * BCH_IOCTL_FSCK_ONLINE: run fsck from the 'bcachefs fsck' userspace command,
405 * but with the kernel's implementation of fsck:
407 struct bch_ioctl_fsck_online {
409 __u64 opts; /* string */
412 #endif /* _BCACHEFS_IOCTL_H */