1 #ifndef _BCACHEFS_IOCTL_H
2 #define _BCACHEFS_IOCTL_H
4 #include <linux/uuid.h>
6 #include "bcachefs_format.h"
9 * Flags common to multiple ioctls:
11 #define BCH_FORCE_IF_DATA_LOST (1 << 0)
12 #define BCH_FORCE_IF_METADATA_LOST (1 << 1)
13 #define BCH_FORCE_IF_DATA_DEGRADED (1 << 2)
14 #define BCH_FORCE_IF_METADATA_DEGRADED (1 << 3)
16 #define BCH_FORCE_IF_DEGRADED \
17 (BCH_FORCE_IF_DATA_DEGRADED| \
18 BCH_FORCE_IF_METADATA_DEGRADED)
21 * If cleared, ioctl that refer to a device pass it as a pointer to a pathname
22 * (e.g. /dev/sda1); if set, the dev field is the device's index within the
25 #define BCH_BY_INDEX (1 << 4)
28 * For BCH_IOCTL_READ_SUPER: get superblock of a specific device, not filesystem
31 #define BCH_READ_DEV (1 << 5)
33 /* global control dev: */
35 /* These are currently broken, and probably unnecessary: */
37 #define BCH_IOCTL_ASSEMBLE _IOW(0xbc, 1, struct bch_ioctl_assemble)
38 #define BCH_IOCTL_INCREMENTAL _IOW(0xbc, 2, struct bch_ioctl_incremental)
40 struct bch_ioctl_assemble {
47 struct bch_ioctl_incremental {
54 /* filesystem ioctls: */
56 #define BCH_IOCTL_QUERY_UUID _IOR(0xbc, 1, struct bch_ioctl_query_uuid)
58 /* These only make sense when we also have incremental assembly */
60 #define BCH_IOCTL_START _IOW(0xbc, 2, struct bch_ioctl_start)
61 #define BCH_IOCTL_STOP _IO(0xbc, 3)
64 #define BCH_IOCTL_DISK_ADD _IOW(0xbc, 4, struct bch_ioctl_disk)
65 #define BCH_IOCTL_DISK_REMOVE _IOW(0xbc, 5, struct bch_ioctl_disk)
66 #define BCH_IOCTL_DISK_ONLINE _IOW(0xbc, 6, struct bch_ioctl_disk)
67 #define BCH_IOCTL_DISK_OFFLINE _IOW(0xbc, 7, struct bch_ioctl_disk)
68 #define BCH_IOCTL_DISK_SET_STATE _IOW(0xbc, 8, struct bch_ioctl_disk_set_state)
69 #define BCH_IOCTL_DATA _IOW(0xbc, 10, struct bch_ioctl_data)
70 #define BCH_IOCTL_USAGE _IOWR(0xbc, 11, struct bch_ioctl_usage)
71 #define BCH_IOCTL_READ_SUPER _IOW(0xbc, 12, struct bch_ioctl_read_super)
72 #define BCH_IOCTL_DISK_GET_IDX _IOW(0xbc, 13, struct bch_ioctl_disk_get_idx)
73 #define BCH_IOCTL_DISK_RESIZE _IOW(0xbc, 14, struct bch_ioctl_disk_resize)
75 /* ioctl below act on a particular file, not the filesystem as a whole: */
77 #define BCHFS_IOC_REINHERIT_ATTRS _IOR(0xbc, 64, const char __user *)
80 * BCH_IOCTL_QUERY_UUID: get filesystem UUID
82 * Returns user visible UUID, not internal UUID (which may not ever be changed);
83 * the filesystem's sysfs directory may be found under /sys/fs/bcachefs with
86 struct bch_ioctl_query_uuid {
91 struct bch_ioctl_start {
98 * BCH_IOCTL_DISK_ADD: add a new device to an existing filesystem
100 * The specified device must not be open or in use. On success, the new device
101 * will be an online member of the filesystem just like any other member.
103 * The device must first be prepared by userspace by formatting with a bcachefs
104 * superblock, which is only used for passing in superblock options/parameters
105 * for that device (in struct bch_member). The new device's superblock should
106 * not claim to be a member of any existing filesystem - UUIDs on it will be
111 * BCH_IOCTL_DISK_REMOVE: permanently remove a member device from a filesystem
113 * Any data present on @dev will be permanently deleted, and @dev will be
114 * removed from its slot in the filesystem's list of member devices. The device
115 * may be either offline or offline.
117 * Will fail removing @dev would leave us with insufficient read write devices
118 * or degraded/unavailable data, unless the approprate BCH_FORCE_IF_* flags are
123 * BCH_IOCTL_DISK_ONLINE: given a disk that is already a member of a filesystem
124 * but is not open (e.g. because we started in degraded mode), bring it online
126 * all existing data on @dev will be available once the device is online,
127 * exactly as if @dev was present when the filesystem was first mounted
131 * BCH_IOCTL_DISK_OFFLINE: offline a disk, causing the kernel to close that
132 * block device, without removing it from the filesystem (so it can be brought
135 * Data present on @dev will be unavailable while @dev is offline (unless
136 * replicated), but will still be intact and untouched if @dev is brought back
139 * Will fail (similarly to BCH_IOCTL_DISK_SET_STATE) if offlining @dev would
140 * leave us with insufficient read write devices or degraded/unavailable data,
141 * unless the approprate BCH_FORCE_IF_* flags are set.
144 struct bch_ioctl_disk {
151 * BCH_IOCTL_DISK_SET_STATE: modify state of a member device of a filesystem
153 * @new_state - one of the bch_member_state states (rw, ro, failed,
156 * Will refuse to change member state if we would then have insufficient devices
157 * to write to, or if it would result in degraded data (when @new_state is
158 * failed or spare) unless the appropriate BCH_FORCE_IF_* flags are set.
160 struct bch_ioctl_disk_set_state {
168 BCH_DATA_OP_SCRUB = 0,
169 BCH_DATA_OP_REREPLICATE = 1,
170 BCH_DATA_OP_MIGRATE = 2,
175 * BCH_IOCTL_DATA: operations that walk and manipulate filesystem data (e.g.
176 * scrub, rereplicate, migrate).
178 * This ioctl kicks off a job in the background, and returns a file descriptor.
179 * Reading from the file descriptor returns a struct bch_ioctl_data_event,
180 * indicating current progress, and closing the file descriptor will stop the
181 * job. The file descriptor is O_CLOEXEC.
183 struct bch_ioctl_data {
199 } __attribute__((packed, aligned(8)));
201 enum bch_data_event {
202 BCH_DATA_EVENT_PROGRESS = 0,
203 /* XXX: add an event for reporting errors */
204 BCH_DATA_EVENT_NR = 1,
207 struct bch_ioctl_data_progress {
215 } __attribute__((packed, aligned(8)));
217 struct bch_ioctl_data_event {
221 struct bch_ioctl_data_progress p;
224 } __attribute__((packed, aligned(8)));
226 struct bch_ioctl_dev_usage {
235 __u64 buckets[BCH_DATA_NR];
236 __u64 sectors[BCH_DATA_NR];
239 struct bch_ioctl_fs_usage {
242 __u64 online_reserved;
243 __u64 persistent_reserved[BCH_REPLICAS_MAX];
244 __u64 sectors[BCH_DATA_NR][BCH_REPLICAS_MAX];
248 * BCH_IOCTL_USAGE: query filesystem disk space usage
250 * Returns disk space usage broken out by data type, number of replicas, and
251 * by component device
253 * @nr_devices - number of devices userspace allocated space for in @devs
255 * On success, @fs and @devs will be filled out appropriately and devs[i].alive
256 * will indicate if a device was present in that slot
258 * Returns -ERANGE if @nr_devices was too small
260 struct bch_ioctl_usage {
264 struct bch_ioctl_fs_usage fs;
265 struct bch_ioctl_dev_usage devs[0];
269 * BCH_IOCTL_READ_SUPER: read filesystem superblock
271 * Equivalent to reading the superblock directly from the block device, except
272 * avoids racing with the kernel writing the superblock or having to figure out
273 * which block device to read
275 * @sb - buffer to read into
276 * @size - size of userspace allocated buffer
277 * @dev - device to read superblock for, if BCH_READ_DEV flag is
280 * Returns -ERANGE if buffer provided is too small
282 struct bch_ioctl_read_super {
291 * BCH_IOCTL_DISK_GET_IDX: give a path to a block device, query filesystem to
292 * determine if disk is a (online) member - if so, returns device's index
294 * Returns -ENOENT if not found
296 struct bch_ioctl_disk_get_idx {
301 * BCH_IOCTL_DISK_RESIZE: resize filesystem on a device
303 * @dev - member to resize
304 * @nbuckets - new number of buckets
306 struct bch_ioctl_disk_resize {
313 #endif /* _BCACHEFS_IOCTL_H */