git.sesse.net Git - bcachefs-tools-debian/blob - libbcachefs/bcachefs_ioctl.h

   1 /* SPDX-License-Identifier: GPL-2.0 */
   2 #ifndef _BCACHEFS_IOCTL_H
   3 #define _BCACHEFS_IOCTL_H
   4
   5 #include <linux/uuid.h>
   6 #include <asm/ioctl.h>
   7 #include "bcachefs_format.h"
   8
   9 /*
  10  * Flags common to multiple ioctls:
  11  */
  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)
  16
  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)
  23
  24 /*
  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
  27  * filesystem:
  28  */
  29 #define BCH_BY_INDEX                    (1 << 4)
  30
  31 /*
  32  * For BCH_IOCTL_READ_SUPER: get superblock of a specific device, not filesystem
  33  * wide superblock:
  34  */
  35 #define BCH_READ_DEV                    (1 << 5)
  36
  37 /* global control dev: */
  38
  39 /* These are currently broken, and probably unnecessary: */
  40 #if 0
  41 #define BCH_IOCTL_ASSEMBLE      _IOW(0xbc, 1, struct bch_ioctl_assemble)
  42 #define BCH_IOCTL_INCREMENTAL   _IOW(0xbc, 2, struct bch_ioctl_incremental)
  43
  44 struct bch_ioctl_assemble {
  45         __u32                   flags;
  46         __u32                   nr_devs;
  47         __u64                   pad;
  48         __u64                   devs[];
  49 };
  50
  51 struct bch_ioctl_incremental {
  52         __u32                   flags;
  53         __u64                   pad;
  54         __u64                   dev;
  55 };
  56 #endif
  57
  58 /* filesystem ioctls: */
  59
  60 #define BCH_IOCTL_QUERY_UUID    _IOR(0xbc,      1,  struct bch_ioctl_query_uuid)
  61
  62 /* These only make sense when we also have incremental assembly */
  63 #if 0
  64 #define BCH_IOCTL_START         _IOW(0xbc,      2,  struct bch_ioctl_start)
  65 #define BCH_IOCTL_STOP          _IO(0xbc,       3)
  66 #endif
  67
  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)
  80
  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)
  83
  84 #define BCH_IOCTL_DEV_USAGE_V2  _IOWR(0xbc,     18, struct bch_ioctl_dev_usage_v2)
  85
  86 #define BCH_IOCTL_FSCK_OFFLINE          _IOW(0xbc,      19,  struct bch_ioctl_fsck_offline)
  87
  88 #define BCH_IOCTL_FSCK_ONLINE           _IOW(0xbc,      20,  struct bch_ioctl_fsck_online)
  89
  90 /* ioctl below act on a particular file, not the filesystem as a whole: */
  91
  92 #define BCHFS_IOC_REINHERIT_ATTRS       _IOR(0xbc, 64, const char __user *)
  93
  94 /*
  95  * BCH_IOCTL_QUERY_UUID: get filesystem UUID
  96  *
  97  * Returns user visible UUID, not internal UUID (which may not ever be changed);
  98  * the filesystem's sysfs directory may be found under /sys/fs/bcachefs with
  99  * this UUID.
 100  */
 101 struct bch_ioctl_query_uuid {
 102         __uuid_t                uuid;
 103 };
 104
 105 #if 0
 106 struct bch_ioctl_start {
 107         __u32                   flags;
 108         __u32                   pad;
 109 };
 110 #endif
 111
 112 /*
 113  * BCH_IOCTL_DISK_ADD: add a new device to an existing filesystem
 114  *
 115  * The specified device must not be open or in use. On success, the new device
 116  * will be an online member of the filesystem just like any other member.
 117  *
 118  * The device must first be prepared by userspace by formatting with a bcachefs
 119  * superblock, which is only used for passing in superblock options/parameters
 120  * for that device (in struct bch_member). The new device's superblock should
 121  * not claim to be a member of any existing filesystem - UUIDs on it will be
 122  * ignored.
 123  */
 124
 125 /*
 126  * BCH_IOCTL_DISK_REMOVE: permanently remove a member device from a filesystem
 127  *
 128  * Any data present on @dev will be permanently deleted, and @dev will be
 129  * removed from its slot in the filesystem's list of member devices. The device
 130  * may be either offline or offline.
 131  *
 132  * Will fail removing @dev would leave us with insufficient read write devices
 133  * or degraded/unavailable data, unless the approprate BCH_FORCE_IF_* flags are
 134  * set.
 135  */
 136
 137 /*
 138  * BCH_IOCTL_DISK_ONLINE: given a disk that is already a member of a filesystem
 139  * but is not open (e.g. because we started in degraded mode), bring it online
 140  *
 141  * all existing data on @dev will be available once the device is online,
 142  * exactly as if @dev was present when the filesystem was first mounted
 143  */
 144
 145 /*
 146  * BCH_IOCTL_DISK_OFFLINE: offline a disk, causing the kernel to close that
 147  * block device, without removing it from the filesystem (so it can be brought
 148  * back online later)
 149  *
 150  * Data present on @dev will be unavailable while @dev is offline (unless
 151  * replicated), but will still be intact and untouched if @dev is brought back
 152  * online
 153  *
 154  * Will fail (similarly to BCH_IOCTL_DISK_SET_STATE) if offlining @dev would
 155  * leave us with insufficient read write devices or degraded/unavailable data,
 156  * unless the approprate BCH_FORCE_IF_* flags are set.
 157  */
 158
 159 struct bch_ioctl_disk {
 160         __u32                   flags;
 161         __u32                   pad;
 162         __u64                   dev;
 163 };
 164
 165 /*
 166  * BCH_IOCTL_DISK_SET_STATE: modify state of a member device of a filesystem
 167  *
 168  * @new_state           - one of the bch_member_state states (rw, ro, failed,
 169  *                        spare)
 170  *
 171  * Will refuse to change member state if we would then have insufficient devices
 172  * to write to, or if it would result in degraded data (when @new_state is
 173  * failed or spare) unless the appropriate BCH_FORCE_IF_* flags are set.
 174  */
 175 struct bch_ioctl_disk_set_state {
 176         __u32                   flags;
 177         __u8                    new_state;
 178         __u8                    pad[3];
 179         __u64                   dev;
 180 };
 181
 182 #define BCH_DATA_OPS()                  \
 183         x(scrub,                0)      \
 184         x(rereplicate,          1)      \
 185         x(migrate,              2)      \
 186         x(rewrite_old_nodes,    3)      \
 187         x(drop_extra_replicas,  4)
 188
 189 enum bch_data_ops {
 190 #define x(t, n) BCH_DATA_OP_##t = n,
 191         BCH_DATA_OPS()
 192 #undef x
 193         BCH_DATA_OP_NR
 194 };
 195
 196 /*
 197  * BCH_IOCTL_DATA: operations that walk and manipulate filesystem data (e.g.
 198  * scrub, rereplicate, migrate).
 199  *
 200  * This ioctl kicks off a job in the background, and returns a file descriptor.
 201  * Reading from the file descriptor returns a struct bch_ioctl_data_event,
 202  * indicating current progress, and closing the file descriptor will stop the
 203  * job. The file descriptor is O_CLOEXEC.
 204  */
 205 struct bch_ioctl_data {
 206         __u16                   op;
 207         __u8                    start_btree;
 208         __u8                    end_btree;
 209         __u32                   flags;
 210
 211         struct bpos             start_pos;
 212         struct bpos             end_pos;
 213
 214         union {
 215         struct {
 216                 __u32           dev;
 217                 __u32           pad;
 218         }                       migrate;
 219         struct {
 220                 __u64           pad[8];
 221         };
 222         };
 223 } __packed __aligned(8);
 224
 225 enum bch_data_event {
 226         BCH_DATA_EVENT_PROGRESS = 0,
 227         /* XXX: add an event for reporting errors */
 228         BCH_DATA_EVENT_NR       = 1,
 229 };
 230
 231 struct bch_ioctl_data_progress {
 232         __u8                    data_type;
 233         __u8                    btree_id;
 234         __u8                    pad[2];
 235         struct bpos             pos;
 236
 237         __u64                   sectors_done;
 238         __u64                   sectors_total;
 239 } __packed __aligned(8);
 240
 241 struct bch_ioctl_data_event {
 242         __u8                    type;
 243         __u8                    pad[7];
 244         union {
 245         struct bch_ioctl_data_progress p;
 246         __u64                   pad2[15];
 247         };
 248 } __packed __aligned(8);
 249
 250 struct bch_replicas_usage {
 251         __u64                   sectors;
 252         struct bch_replicas_entry_v1 r;
 253 } __packed;
 254
 255 static inline struct bch_replicas_usage *
 256 replicas_usage_next(struct bch_replicas_usage *u)
 257 {
 258         return (void *) u + replicas_entry_bytes(&u->r) + 8;
 259 }
 260
 261 /*
 262  * BCH_IOCTL_FS_USAGE: query filesystem disk space usage
 263  *
 264  * Returns disk space usage broken out by data type, number of replicas, and
 265  * by component device
 266  *
 267  * @replica_entries_bytes - size, in bytes, allocated for replica usage entries
 268  *
 269  * On success, @replica_entries_bytes will be changed to indicate the number of
 270  * bytes actually used.
 271  *
 272  * Returns -ERANGE if @replica_entries_bytes was too small
 273  */
 274 struct bch_ioctl_fs_usage {
 275         __u64                   capacity;
 276         __u64                   used;
 277         __u64                   online_reserved;
 278         __u64                   persistent_reserved[BCH_REPLICAS_MAX];
 279
 280         __u32                   replica_entries_bytes;
 281         __u32                   pad;
 282
 283         struct bch_replicas_usage replicas[];
 284 };
 285
 286 /*
 287  * BCH_IOCTL_DEV_USAGE: query device disk space usage
 288  *
 289  * Returns disk space usage broken out by data type - both by buckets and
 290  * sectors.
 291  */
 292 struct bch_ioctl_dev_usage {
 293         __u64                   dev;
 294         __u32                   flags;
 295         __u8                    state;
 296         __u8                    pad[7];
 297
 298         __u32                   bucket_size;
 299         __u64                   nr_buckets;
 300
 301         __u64                   buckets_ec;
 302
 303         struct bch_ioctl_dev_usage_type {
 304                 __u64           buckets;
 305                 __u64           sectors;
 306                 __u64           fragmented;
 307         }                       d[10];
 308 };
 309
 310 struct bch_ioctl_dev_usage_v2 {
 311         __u64                   dev;
 312         __u32                   flags;
 313         __u8                    state;
 314         __u8                    nr_data_types;
 315         __u8                    pad[6];
 316
 317         __u32                   bucket_size;
 318         __u64                   nr_buckets;
 319
 320         struct bch_ioctl_dev_usage_type d[];
 321 };
 322
 323 /*
 324  * BCH_IOCTL_READ_SUPER: read filesystem superblock
 325  *
 326  * Equivalent to reading the superblock directly from the block device, except
 327  * avoids racing with the kernel writing the superblock or having to figure out
 328  * which block device to read
 329  *
 330  * @sb          - buffer to read into
 331  * @size        - size of userspace allocated buffer
 332  * @dev         - device to read superblock for, if BCH_READ_DEV flag is
 333  *                specified
 334  *
 335  * Returns -ERANGE if buffer provided is too small
 336  */
 337 struct bch_ioctl_read_super {
 338         __u32                   flags;
 339         __u32                   pad;
 340         __u64                   dev;
 341         __u64                   size;
 342         __u64                   sb;
 343 };
 344
 345 /*
 346  * BCH_IOCTL_DISK_GET_IDX: give a path to a block device, query filesystem to
 347  * determine if disk is a (online) member - if so, returns device's index
 348  *
 349  * Returns -ENOENT if not found
 350  */
 351 struct bch_ioctl_disk_get_idx {
 352         __u64                   dev;
 353 };
 354
 355 /*
 356  * BCH_IOCTL_DISK_RESIZE: resize filesystem on a device
 357  *
 358  * @dev         - member to resize
 359  * @nbuckets    - new number of buckets
 360  */
 361 struct bch_ioctl_disk_resize {
 362         __u32                   flags;
 363         __u32                   pad;
 364         __u64                   dev;
 365         __u64                   nbuckets;
 366 };
 367
 368 /*
 369  * BCH_IOCTL_DISK_RESIZE_JOURNAL: resize journal on a device
 370  *
 371  * @dev         - member to resize
 372  * @nbuckets    - new number of buckets
 373  */
 374 struct bch_ioctl_disk_resize_journal {
 375         __u32                   flags;
 376         __u32                   pad;
 377         __u64                   dev;
 378         __u64                   nbuckets;
 379 };
 380
 381 struct bch_ioctl_subvolume {
 382         __u32                   flags;
 383         __u32                   dirfd;
 384         __u16                   mode;
 385         __u16                   pad[3];
 386         __u64                   dst_ptr;
 387         __u64                   src_ptr;
 388 };
 389
 390 #define BCH_SUBVOL_SNAPSHOT_CREATE      (1U << 0)
 391 #define BCH_SUBVOL_SNAPSHOT_RO          (1U << 1)
 392
 393 /*
 394  * BCH_IOCTL_FSCK_OFFLINE: run fsck from the 'bcachefs fsck' userspace command,
 395  * but with the kernel's implementation of fsck:
 396  */
 397 struct bch_ioctl_fsck_offline {
 398         __u64                   flags;
 399         __u64                   opts;           /* string */
 400         __u64                   nr_devs;
 401         __u64                   devs[0];
 402 };
 403
 404 /*
 405  * BCH_IOCTL_FSCK_ONLINE: run fsck from the 'bcachefs fsck' userspace command,
 406  * but with the kernel's implementation of fsck:
 407  */
 408 struct bch_ioctl_fsck_online {
 409         __u64                   flags;
 410         __u64                   opts;           /* string */
 411 };
 412
 413 #endif /* _BCACHEFS_IOCTL_H */