include/uapi/linux/btrfs.h

   1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
   2 /*
   3  * Copyright (C) 2007 Oracle.  All rights reserved.
   4  *
   5  * This program is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU General Public
   7  * License v2 as published by the Free Software Foundation.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public
  15  * License along with this program; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 021110-1307, USA.
  18  */
  19
  20 #ifndef _UAPI_LINUX_BTRFS_H
  21 #define _UAPI_LINUX_BTRFS_H
  22 #include <linux/types.h>
  23 #include <linux/ioctl.h>
  24
  25 #define BTRFS_IOCTL_MAGIC 0x94
  26 #define BTRFS_VOL_NAME_MAX 255
  27 #define BTRFS_LABEL_SIZE 256
  28
  29 /* this should be 4k */
  30 #define BTRFS_PATH_NAME_MAX 4087
  31 struct btrfs_ioctl_vol_args {
  32         __s64 fd;
  33         char name[BTRFS_PATH_NAME_MAX + 1];
  34 };
  35
  36 #define BTRFS_DEVICE_PATH_NAME_MAX      1024
  37 #define BTRFS_SUBVOL_NAME_MAX           4039
  38
  39 /*
  40  * Deprecated since 5.7:
  41  *
  42  * BTRFS_SUBVOL_CREATE_ASYNC    (1ULL << 0)
  43  */
  44
  45 #define BTRFS_SUBVOL_RDONLY             (1ULL << 1)
  46 #define BTRFS_SUBVOL_QGROUP_INHERIT     (1ULL << 2)
  47
  48 #define BTRFS_DEVICE_SPEC_BY_ID         (1ULL << 3)
  49
  50 #define BTRFS_SUBVOL_SPEC_BY_ID (1ULL << 4)
  51
  52 #define BTRFS_VOL_ARG_V2_FLAGS_SUPPORTED                \
  53                         (BTRFS_SUBVOL_RDONLY |          \
  54                         BTRFS_SUBVOL_QGROUP_INHERIT |   \
  55                         BTRFS_DEVICE_SPEC_BY_ID |       \
  56                         BTRFS_SUBVOL_SPEC_BY_ID)
  57
  58 #define BTRFS_FSID_SIZE 16
  59 #define BTRFS_UUID_SIZE 16
  60 #define BTRFS_UUID_UNPARSED_SIZE        37
  61
  62 /*
  63  * flags definition for qgroup limits
  64  *
  65  * Used by:
  66  * struct btrfs_qgroup_limit.flags
  67  * struct btrfs_qgroup_limit_item.flags
  68  */
  69 #define BTRFS_QGROUP_LIMIT_MAX_RFER     (1ULL << 0)
  70 #define BTRFS_QGROUP_LIMIT_MAX_EXCL     (1ULL << 1)
  71 #define BTRFS_QGROUP_LIMIT_RSV_RFER     (1ULL << 2)
  72 #define BTRFS_QGROUP_LIMIT_RSV_EXCL     (1ULL << 3)
  73 #define BTRFS_QGROUP_LIMIT_RFER_CMPR    (1ULL << 4)
  74 #define BTRFS_QGROUP_LIMIT_EXCL_CMPR    (1ULL << 5)
  75
  76 struct btrfs_qgroup_limit {
  77         __u64   flags;
  78         __u64   max_rfer;
  79         __u64   max_excl;
  80         __u64   rsv_rfer;
  81         __u64   rsv_excl;
  82 };
  83
  84 /*
  85  * flags definition for qgroup inheritance
  86  *
  87  * Used by:
  88  * struct btrfs_qgroup_inherit.flags
  89  */
  90 #define BTRFS_QGROUP_INHERIT_SET_LIMITS (1ULL << 0)
  91
  92 struct btrfs_qgroup_inherit {
  93         __u64   flags;
  94         __u64   num_qgroups;
  95         __u64   num_ref_copies;
  96         __u64   num_excl_copies;
  97         struct btrfs_qgroup_limit lim;
  98         __u64   qgroups[0];
  99 };
 100
 101 struct btrfs_ioctl_qgroup_limit_args {
 102         __u64   qgroupid;
 103         struct btrfs_qgroup_limit lim;
 104 };
 105
 106 /*
 107  * Arguments for specification of subvolumes or devices, supporting by-name or
 108  * by-id and flags
 109  *
 110  * The set of supported flags depends on the ioctl
 111  *
 112  * BTRFS_SUBVOL_RDONLY is also provided/consumed by the following ioctls:
 113  * - BTRFS_IOC_SUBVOL_GETFLAGS
 114  * - BTRFS_IOC_SUBVOL_SETFLAGS
 115  */
 116
 117 /* Supported flags for BTRFS_IOC_RM_DEV_V2 */
 118 #define BTRFS_DEVICE_REMOVE_ARGS_MASK                                   \
 119         (BTRFS_DEVICE_SPEC_BY_ID)
 120
 121 /* Supported flags for BTRFS_IOC_SNAP_CREATE_V2 and BTRFS_IOC_SUBVOL_CREATE_V2 */
 122 #define BTRFS_SUBVOL_CREATE_ARGS_MASK                                   \
 123          (BTRFS_SUBVOL_RDONLY |                                         \
 124          BTRFS_SUBVOL_QGROUP_INHERIT)
 125
 126 /* Supported flags for BTRFS_IOC_SNAP_DESTROY_V2 */
 127 #define BTRFS_SUBVOL_DELETE_ARGS_MASK                                   \
 128         (BTRFS_SUBVOL_SPEC_BY_ID)
 129
 130 struct btrfs_ioctl_vol_args_v2 {
 131         __s64 fd;
 132         __u64 transid;
 133         __u64 flags;
 134         union {
 135                 struct {
 136                         __u64 size;
 137                         struct btrfs_qgroup_inherit __user *qgroup_inherit;
 138                 };
 139                 __u64 unused[4];
 140         };
 141         union {
 142                 char name[BTRFS_SUBVOL_NAME_MAX + 1];
 143                 __u64 devid;
 144                 __u64 subvolid;
 145         };
 146 };
 147
 148 /*
 149  * structure to report errors and progress to userspace, either as a
 150  * result of a finished scrub, a canceled scrub or a progress inquiry
 151  */
 152 struct btrfs_scrub_progress {
 153         __u64 data_extents_scrubbed;    /* # of data extents scrubbed */
 154         __u64 tree_extents_scrubbed;    /* # of tree extents scrubbed */
 155         __u64 data_bytes_scrubbed;      /* # of data bytes scrubbed */
 156         __u64 tree_bytes_scrubbed;      /* # of tree bytes scrubbed */
 157         __u64 read_errors;              /* # of read errors encountered (EIO) */
 158         __u64 csum_errors;              /* # of failed csum checks */
 159         __u64 verify_errors;            /* # of occurences, where the metadata
 160                                          * of a tree block did not match the
 161                                          * expected values, like generation or
 162                                          * logical */
 163         __u64 no_csum;                  /* # of 4k data block for which no csum
 164                                          * is present, probably the result of
 165                                          * data written with nodatasum */
 166         __u64 csum_discards;            /* # of csum for which no data was found
 167                                          * in the extent tree. */
 168         __u64 super_errors;             /* # of bad super blocks encountered */
 169         __u64 malloc_errors;            /* # of internal kmalloc errors. These
 170                                          * will likely cause an incomplete
 171                                          * scrub */
 172         __u64 uncorrectable_errors;     /* # of errors where either no intact
 173                                          * copy was found or the writeback
 174                                          * failed */
 175         __u64 corrected_errors;         /* # of errors corrected */
 176         __u64 last_physical;            /* last physical address scrubbed. In
 177                                          * case a scrub was aborted, this can
 178                                          * be used to restart the scrub */
 179         __u64 unverified_errors;        /* # of occurences where a read for a
 180                                          * full (64k) bio failed, but the re-
 181                                          * check succeeded for each 4k piece.
 182                                          * Intermittent error. */
 183 };
 184
 185 #define BTRFS_SCRUB_READONLY    1
 186 struct btrfs_ioctl_scrub_args {
 187         __u64 devid;                            /* in */
 188         __u64 start;                            /* in */
 189         __u64 end;                              /* in */
 190         __u64 flags;                            /* in */
 191         struct btrfs_scrub_progress progress;   /* out */
 192         /* pad to 1k */
 193         __u64 unused[(1024-32-sizeof(struct btrfs_scrub_progress))/8];
 194 };
 195
 196 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_ALWAYS    0
 197 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_AVOID     1
 198 struct btrfs_ioctl_dev_replace_start_params {
 199         __u64 srcdevid; /* in, if 0, use srcdev_name instead */
 200         __u64 cont_reading_from_srcdev_mode;    /* in, see #define
 201                                                  * above */
 202         __u8 srcdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1];       /* in */
 203         __u8 tgtdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1];       /* in */
 204 };
 205
 206 #define BTRFS_IOCTL_DEV_REPLACE_STATE_NEVER_STARTED     0
 207 #define BTRFS_IOCTL_DEV_REPLACE_STATE_STARTED           1
 208 #define BTRFS_IOCTL_DEV_REPLACE_STATE_FINISHED          2
 209 #define BTRFS_IOCTL_DEV_REPLACE_STATE_CANCELED          3
 210 #define BTRFS_IOCTL_DEV_REPLACE_STATE_SUSPENDED         4
 211 struct btrfs_ioctl_dev_replace_status_params {
 212         __u64 replace_state;    /* out, see #define above */
 213         __u64 progress_1000;    /* out, 0 <= x <= 1000 */
 214         __u64 time_started;     /* out, seconds since 1-Jan-1970 */
 215         __u64 time_stopped;     /* out, seconds since 1-Jan-1970 */
 216         __u64 num_write_errors; /* out */
 217         __u64 num_uncorrectable_read_errors;    /* out */
 218 };
 219
 220 #define BTRFS_IOCTL_DEV_REPLACE_CMD_START                       0
 221 #define BTRFS_IOCTL_DEV_REPLACE_CMD_STATUS                      1
 222 #define BTRFS_IOCTL_DEV_REPLACE_CMD_CANCEL                      2
 223 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NO_ERROR                 0
 224 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NOT_STARTED              1
 225 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_ALREADY_STARTED          2
 226 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_SCRUB_INPROGRESS         3
 227 struct btrfs_ioctl_dev_replace_args {
 228         __u64 cmd;      /* in */
 229         __u64 result;   /* out */
 230
 231         union {
 232                 struct btrfs_ioctl_dev_replace_start_params start;
 233                 struct btrfs_ioctl_dev_replace_status_params status;
 234         };      /* in/out */
 235
 236         __u64 spare[64];
 237 };
 238
 239 struct btrfs_ioctl_dev_info_args {
 240         __u64 devid;                            /* in/out */
 241         __u8 uuid[BTRFS_UUID_SIZE];             /* in/out */
 242         __u64 bytes_used;                       /* out */
 243         __u64 total_bytes;                      /* out */
 244         __u64 unused[379];                      /* pad to 4k */
 245         __u8 path[BTRFS_DEVICE_PATH_NAME_MAX];  /* out */
 246 };
 247
 248 struct btrfs_ioctl_fs_info_args {
 249         __u64 max_id;                           /* out */
 250         __u64 num_devices;                      /* out */
 251         __u8 fsid[BTRFS_FSID_SIZE];             /* out */
 252         __u32 nodesize;                         /* out */
 253         __u32 sectorsize;                       /* out */
 254         __u32 clone_alignment;                  /* out */
 255         __u32 reserved32;
 256         __u64 reserved[122];                    /* pad to 1k */
 257 };
 258
 259 /*
 260  * feature flags
 261  *
 262  * Used by:
 263  * struct btrfs_ioctl_feature_flags
 264  */
 265 #define BTRFS_FEATURE_COMPAT_RO_FREE_SPACE_TREE         (1ULL << 0)
 266 /*
 267  * Older kernels (< 4.9) on big-endian systems produced broken free space tree
 268  * bitmaps, and btrfs-progs also used to corrupt the free space tree (versions
 269  * < 4.7.3).  If this bit is clear, then the free space tree cannot be trusted.
 270  * btrfs-progs can also intentionally clear this bit to ask the kernel to
 271  * rebuild the free space tree, however this might not work on older kernels
 272  * that do not know about this bit. If not sure, clear the cache manually on
 273  * first mount when booting older kernel versions.
 274  */
 275 #define BTRFS_FEATURE_COMPAT_RO_FREE_SPACE_TREE_VALID   (1ULL << 1)
 276
 277 #define BTRFS_FEATURE_INCOMPAT_MIXED_BACKREF    (1ULL << 0)
 278 #define BTRFS_FEATURE_INCOMPAT_DEFAULT_SUBVOL   (1ULL << 1)
 279 #define BTRFS_FEATURE_INCOMPAT_MIXED_GROUPS     (1ULL << 2)
 280 #define BTRFS_FEATURE_INCOMPAT_COMPRESS_LZO     (1ULL << 3)
 281 #define BTRFS_FEATURE_INCOMPAT_COMPRESS_ZSTD    (1ULL << 4)
 282
 283 /*
 284  * older kernels tried to do bigger metadata blocks, but the
 285  * code was pretty buggy.  Lets not let them try anymore.
 286  */
 287 #define BTRFS_FEATURE_INCOMPAT_BIG_METADATA     (1ULL << 5)
 288
 289 #define BTRFS_FEATURE_INCOMPAT_EXTENDED_IREF    (1ULL << 6)
 290 #define BTRFS_FEATURE_INCOMPAT_RAID56           (1ULL << 7)
 291 #define BTRFS_FEATURE_INCOMPAT_SKINNY_METADATA  (1ULL << 8)
 292 #define BTRFS_FEATURE_INCOMPAT_NO_HOLES         (1ULL << 9)
 293 #define BTRFS_FEATURE_INCOMPAT_METADATA_UUID    (1ULL << 10)
 294 #define BTRFS_FEATURE_INCOMPAT_RAID1C34         (1ULL << 11)
 295
 296 struct btrfs_ioctl_feature_flags {
 297         __u64 compat_flags;
 298         __u64 compat_ro_flags;
 299         __u64 incompat_flags;
 300 };
 301
 302 /* balance control ioctl modes */
 303 #define BTRFS_BALANCE_CTL_PAUSE         1
 304 #define BTRFS_BALANCE_CTL_CANCEL        2
 305
 306 /*
 307  * this is packed, because it should be exactly the same as its disk
 308  * byte order counterpart (struct btrfs_disk_balance_args)
 309  */
 310 struct btrfs_balance_args {
 311         __u64 profiles;
 312         union {
 313                 __u64 usage;
 314                 struct {
 315                         __u32 usage_min;
 316                         __u32 usage_max;
 317                 };
 318         };
 319         __u64 devid;
 320         __u64 pstart;
 321         __u64 pend;
 322         __u64 vstart;
 323         __u64 vend;
 324
 325         __u64 target;
 326
 327         __u64 flags;
 328
 329         /*
 330          * BTRFS_BALANCE_ARGS_LIMIT with value 'limit'
 331          * BTRFS_BALANCE_ARGS_LIMIT_RANGE - the extend version can use minimum
 332          * and maximum
 333          */
 334         union {
 335                 __u64 limit;            /* limit number of processed chunks */
 336                 struct {
 337                         __u32 limit_min;
 338                         __u32 limit_max;
 339                 };
 340         };
 341
 342         /*
 343          * Process chunks that cross stripes_min..stripes_max devices,
 344          * BTRFS_BALANCE_ARGS_STRIPES_RANGE
 345          */
 346         __u32 stripes_min;
 347         __u32 stripes_max;
 348
 349         __u64 unused[6];
 350 } __attribute__ ((__packed__));
 351
 352 /* report balance progress to userspace */
 353 struct btrfs_balance_progress {
 354         __u64 expected;         /* estimated # of chunks that will be
 355                                  * relocated to fulfill the request */
 356         __u64 considered;       /* # of chunks we have considered so far */
 357         __u64 completed;        /* # of chunks relocated so far */
 358 };
 359
 360 /*
 361  * flags definition for balance
 362  *
 363  * Restriper's general type filter
 364  *
 365  * Used by:
 366  * btrfs_ioctl_balance_args.flags
 367  * btrfs_balance_control.flags (internal)
 368  */
 369 #define BTRFS_BALANCE_DATA              (1ULL << 0)
 370 #define BTRFS_BALANCE_SYSTEM            (1ULL << 1)
 371 #define BTRFS_BALANCE_METADATA          (1ULL << 2)
 372
 373 #define BTRFS_BALANCE_TYPE_MASK         (BTRFS_BALANCE_DATA |       \
 374                                          BTRFS_BALANCE_SYSTEM |     \
 375                                          BTRFS_BALANCE_METADATA)
 376
 377 #define BTRFS_BALANCE_FORCE             (1ULL << 3)
 378 #define BTRFS_BALANCE_RESUME            (1ULL << 4)
 379
 380 /*
 381  * flags definitions for per-type balance args
 382  *
 383  * Balance filters
 384  *
 385  * Used by:
 386  * struct btrfs_balance_args
 387  */
 388 #define BTRFS_BALANCE_ARGS_PROFILES     (1ULL << 0)
 389 #define BTRFS_BALANCE_ARGS_USAGE        (1ULL << 1)
 390 #define BTRFS_BALANCE_ARGS_DEVID        (1ULL << 2)
 391 #define BTRFS_BALANCE_ARGS_DRANGE       (1ULL << 3)
 392 #define BTRFS_BALANCE_ARGS_VRANGE       (1ULL << 4)
 393 #define BTRFS_BALANCE_ARGS_LIMIT        (1ULL << 5)
 394 #define BTRFS_BALANCE_ARGS_LIMIT_RANGE  (1ULL << 6)
 395 #define BTRFS_BALANCE_ARGS_STRIPES_RANGE (1ULL << 7)
 396 #define BTRFS_BALANCE_ARGS_USAGE_RANGE  (1ULL << 10)
 397
 398 #define BTRFS_BALANCE_ARGS_MASK                 \
 399         (BTRFS_BALANCE_ARGS_PROFILES |          \
 400          BTRFS_BALANCE_ARGS_USAGE |             \
 401          BTRFS_BALANCE_ARGS_DEVID |             \
 402          BTRFS_BALANCE_ARGS_DRANGE |            \
 403          BTRFS_BALANCE_ARGS_VRANGE |            \
 404          BTRFS_BALANCE_ARGS_LIMIT |             \
 405          BTRFS_BALANCE_ARGS_LIMIT_RANGE |       \
 406          BTRFS_BALANCE_ARGS_STRIPES_RANGE |     \
 407          BTRFS_BALANCE_ARGS_USAGE_RANGE)
 408
 409 /*
 410  * Profile changing flags.  When SOFT is set we won't relocate chunk if
 411  * it already has the target profile (even though it may be
 412  * half-filled).
 413  */
 414 #define BTRFS_BALANCE_ARGS_CONVERT      (1ULL << 8)
 415 #define BTRFS_BALANCE_ARGS_SOFT         (1ULL << 9)
 416
 417
 418 /*
 419  * flags definition for balance state
 420  *
 421  * Used by:
 422  * struct btrfs_ioctl_balance_args.state
 423  */
 424 #define BTRFS_BALANCE_STATE_RUNNING     (1ULL << 0)
 425 #define BTRFS_BALANCE_STATE_PAUSE_REQ   (1ULL << 1)
 426 #define BTRFS_BALANCE_STATE_CANCEL_REQ  (1ULL << 2)
 427
 428 struct btrfs_ioctl_balance_args {
 429         __u64 flags;                            /* in/out */
 430         __u64 state;                            /* out */
 431
 432         struct btrfs_balance_args data;         /* in/out */
 433         struct btrfs_balance_args meta;         /* in/out */
 434         struct btrfs_balance_args sys;          /* in/out */
 435
 436         struct btrfs_balance_progress stat;     /* out */
 437
 438         __u64 unused[72];                       /* pad to 1k */
 439 };
 440
 441 #define BTRFS_INO_LOOKUP_PATH_MAX 4080
 442 struct btrfs_ioctl_ino_lookup_args {
 443         __u64 treeid;
 444         __u64 objectid;
 445         char name[BTRFS_INO_LOOKUP_PATH_MAX];
 446 };
 447
 448 #define BTRFS_INO_LOOKUP_USER_PATH_MAX (4080 - BTRFS_VOL_NAME_MAX - 1)
 449 struct btrfs_ioctl_ino_lookup_user_args {
 450         /* in, inode number containing the subvolume of 'subvolid' */
 451         __u64 dirid;
 452         /* in */
 453         __u64 treeid;
 454         /* out, name of the subvolume of 'treeid' */
 455         char name[BTRFS_VOL_NAME_MAX + 1];
 456         /*
 457          * out, constructed path from the directory with which the ioctl is
 458          * called to dirid
 459          */
 460         char path[BTRFS_INO_LOOKUP_USER_PATH_MAX];
 461 };
 462
 463 /* Search criteria for the btrfs SEARCH ioctl family. */
 464 struct btrfs_ioctl_search_key {
 465         /*
 466          * The tree we're searching in. 1 is the tree of tree roots, 2 is the
 467          * extent tree, etc...
 468          *
 469          * A special tree_id value of 0 will cause a search in the subvolume
 470          * tree that the inode which is passed to the ioctl is part of.
 471          */
 472         __u64 tree_id;          /* in */
 473
 474         /*
 475          * When doing a tree search, we're actually taking a slice from a
 476          * linear search space of 136-bit keys.
 477          *
 478          * A full 136-bit tree key is composed as:
 479          *   (objectid << 72) + (type << 64) + offset
 480          *
 481          * The individual min and max values for objectid, type and offset
 482          * define the min_key and max_key values for the search range. All
 483          * metadata items with a key in the interval [min_key, max_key] will be
 484          * returned.
 485          *
 486          * Additionally, we can filter the items returned on transaction id of
 487          * the metadata block they're stored in by specifying a transid range.
 488          * Be aware that this transaction id only denotes when the metadata
 489          * page that currently contains the item got written the last time as
 490          * result of a COW operation.  The number does not have any meaning
 491          * related to the transaction in which an individual item that is being
 492          * returned was created or changed.
 493          */
 494         __u64 min_objectid;     /* in */
 495         __u64 max_objectid;     /* in */
 496         __u64 min_offset;       /* in */
 497         __u64 max_offset;       /* in */
 498         __u64 min_transid;      /* in */
 499         __u64 max_transid;      /* in */
 500         __u32 min_type;         /* in */
 501         __u32 max_type;         /* in */
 502
 503         /*
 504          * input: The maximum amount of results desired.
 505          * output: The actual amount of items returned, restricted by any of:
 506          *  - reaching the upper bound of the search range
 507          *  - reaching the input nr_items amount of items
 508          *  - completely filling the supplied memory buffer
 509          */
 510         __u32 nr_items;         /* in/out */
 511
 512         /* align to 64 bits */
 513         __u32 unused;
 514
 515         /* some extra for later */
 516         __u64 unused1;
 517         __u64 unused2;
 518         __u64 unused3;
 519         __u64 unused4;
 520 };
 521
 522 struct btrfs_ioctl_search_header {
 523         __u64 transid;
 524         __u64 objectid;
 525         __u64 offset;
 526         __u32 type;
 527         __u32 len;
 528 };
 529
 530 #define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
 531 /*
 532  * the buf is an array of search headers where
 533  * each header is followed by the actual item
 534  * the type field is expanded to 32 bits for alignment
 535  */
 536 struct btrfs_ioctl_search_args {
 537         struct btrfs_ioctl_search_key key;
 538         char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
 539 };
 540
 541 struct btrfs_ioctl_search_args_v2 {
 542         struct btrfs_ioctl_search_key key; /* in/out - search parameters */
 543         __u64 buf_size;            /* in - size of buffer
 544                                             * out - on EOVERFLOW: needed size
 545                                             *       to store item */
 546         __u64 buf[0];                       /* out - found items */
 547 };
 548
 549 struct btrfs_ioctl_clone_range_args {
 550   __s64 src_fd;
 551   __u64 src_offset, src_length;
 552   __u64 dest_offset;
 553 };
 554
 555 /*
 556  * flags definition for the defrag range ioctl
 557  *
 558  * Used by:
 559  * struct btrfs_ioctl_defrag_range_args.flags
 560  */
 561 #define BTRFS_DEFRAG_RANGE_COMPRESS 1
 562 #define BTRFS_DEFRAG_RANGE_START_IO 2
 563 struct btrfs_ioctl_defrag_range_args {
 564         /* start of the defrag operation */
 565         __u64 start;
 566
 567         /* number of bytes to defrag, use (u64)-1 to say all */
 568         __u64 len;
 569
 570         /*
 571          * flags for the operation, which can include turning
 572          * on compression for this one defrag
 573          */
 574         __u64 flags;
 575
 576         /*
 577          * any extent bigger than this will be considered
 578          * already defragged.  Use 0 to take the kernel default
 579          * Use 1 to say every single extent must be rewritten
 580          */
 581         __u32 extent_thresh;
 582
 583         /*
 584          * which compression method to use if turning on compression
 585          * for this defrag operation.  If unspecified, zlib will
 586          * be used
 587          */
 588         __u32 compress_type;
 589
 590         /* spare for later */
 591         __u32 unused[4];
 592 };
 593
 594
 595 #define BTRFS_SAME_DATA_DIFFERS 1
 596 /* For extent-same ioctl */
 597 struct btrfs_ioctl_same_extent_info {
 598         __s64 fd;               /* in - destination file */
 599         __u64 logical_offset;   /* in - start of extent in destination */
 600         __u64 bytes_deduped;    /* out - total # of bytes we were able
 601                                  * to dedupe from this file */
 602         /* status of this dedupe operation:
 603          * 0 if dedup succeeds
 604          * < 0 for error
 605          * == BTRFS_SAME_DATA_DIFFERS if data differs
 606          */
 607         __s32 status;           /* out - see above description */
 608         __u32 reserved;
 609 };
 610
 611 struct btrfs_ioctl_same_args {
 612         __u64 logical_offset;   /* in - start of extent in source */
 613         __u64 length;           /* in - length of extent */
 614         __u16 dest_count;       /* in - total elements in info array */
 615         __u16 reserved1;
 616         __u32 reserved2;
 617         struct btrfs_ioctl_same_extent_info info[0];
 618 };
 619
 620 struct btrfs_ioctl_space_info {
 621         __u64 flags;
 622         __u64 total_bytes;
 623         __u64 used_bytes;
 624 };
 625
 626 struct btrfs_ioctl_space_args {
 627         __u64 space_slots;
 628         __u64 total_spaces;
 629         struct btrfs_ioctl_space_info spaces[0];
 630 };
 631
 632 struct btrfs_data_container {
 633         __u32   bytes_left;     /* out -- bytes not needed to deliver output */
 634         __u32   bytes_missing;  /* out -- additional bytes needed for result */
 635         __u32   elem_cnt;       /* out */
 636         __u32   elem_missed;    /* out */
 637         __u64   val[0];         /* out */
 638 };
 639
 640 struct btrfs_ioctl_ino_path_args {
 641         __u64                           inum;           /* in */
 642         __u64                           size;           /* in */
 643         __u64                           reserved[4];
 644         /* struct btrfs_data_container  *fspath;           out */
 645         __u64                           fspath;         /* out */
 646 };
 647
 648 struct btrfs_ioctl_logical_ino_args {
 649         __u64                           logical;        /* in */
 650         __u64                           size;           /* in */
 651         __u64                           reserved[3];    /* must be 0 for now */
 652         __u64                           flags;          /* in, v2 only */
 653         /* struct btrfs_data_container  *inodes;        out   */
 654         __u64                           inodes;
 655 };
 656 /* Return every ref to the extent, not just those containing logical block.
 657  * Requires logical == extent bytenr. */
 658 #define BTRFS_LOGICAL_INO_ARGS_IGNORE_OFFSET    (1ULL << 0)
 659
 660 enum btrfs_dev_stat_values {
 661         /* disk I/O failure stats */
 662         BTRFS_DEV_STAT_WRITE_ERRS, /* EIO or EREMOTEIO from lower layers */
 663         BTRFS_DEV_STAT_READ_ERRS, /* EIO or EREMOTEIO from lower layers */
 664         BTRFS_DEV_STAT_FLUSH_ERRS, /* EIO or EREMOTEIO from lower layers */
 665
 666         /* stats for indirect indications for I/O failures */
 667         BTRFS_DEV_STAT_CORRUPTION_ERRS, /* checksum error, bytenr error or
 668                                          * contents is illegal: this is an
 669                                          * indication that the block was damaged
 670                                          * during read or write, or written to
 671                                          * wrong location or read from wrong
 672                                          * location */
 673         BTRFS_DEV_STAT_GENERATION_ERRS, /* an indication that blocks have not
 674                                          * been written */
 675
 676         BTRFS_DEV_STAT_VALUES_MAX
 677 };
 678
 679 /* Reset statistics after reading; needs SYS_ADMIN capability */
 680 #define BTRFS_DEV_STATS_RESET           (1ULL << 0)
 681
 682 struct btrfs_ioctl_get_dev_stats {
 683         __u64 devid;                            /* in */
 684         __u64 nr_items;                         /* in/out */
 685         __u64 flags;                            /* in/out */
 686
 687         /* out values: */
 688         __u64 values[BTRFS_DEV_STAT_VALUES_MAX];
 689
 690         /*
 691          * This pads the struct to 1032 bytes. It was originally meant to pad to
 692          * 1024 bytes, but when adding the flags field, the padding calculation
 693          * was not adjusted.
 694          */
 695         __u64 unused[128 - 2 - BTRFS_DEV_STAT_VALUES_MAX];
 696 };
 697
 698 #define BTRFS_QUOTA_CTL_ENABLE  1
 699 #define BTRFS_QUOTA_CTL_DISABLE 2
 700 #define BTRFS_QUOTA_CTL_RESCAN__NOTUSED 3
 701 struct btrfs_ioctl_quota_ctl_args {
 702         __u64 cmd;
 703         __u64 status;
 704 };
 705
 706 struct btrfs_ioctl_quota_rescan_args {
 707         __u64   flags;
 708         __u64   progress;
 709         __u64   reserved[6];
 710 };
 711
 712 struct btrfs_ioctl_qgroup_assign_args {
 713         __u64 assign;
 714         __u64 src;
 715         __u64 dst;
 716 };
 717
 718 struct btrfs_ioctl_qgroup_create_args {
 719         __u64 create;
 720         __u64 qgroupid;
 721 };
 722 struct btrfs_ioctl_timespec {
 723         __u64 sec;
 724         __u32 nsec;
 725 };
 726
 727 struct btrfs_ioctl_received_subvol_args {
 728         char    uuid[BTRFS_UUID_SIZE];  /* in */
 729         __u64   stransid;               /* in */
 730         __u64   rtransid;               /* out */
 731         struct btrfs_ioctl_timespec stime; /* in */
 732         struct btrfs_ioctl_timespec rtime; /* out */
 733         __u64   flags;                  /* in */
 734         __u64   reserved[16];           /* in */
 735 };
 736
 737 /*
 738  * Caller doesn't want file data in the send stream, even if the
 739  * search of clone sources doesn't find an extent. UPDATE_EXTENT
 740  * commands will be sent instead of WRITE commands.
 741  */
 742 #define BTRFS_SEND_FLAG_NO_FILE_DATA            0x1
 743
 744 /*
 745  * Do not add the leading stream header. Used when multiple snapshots
 746  * are sent back to back.
 747  */
 748 #define BTRFS_SEND_FLAG_OMIT_STREAM_HEADER      0x2
 749
 750 /*
 751  * Omit the command at the end of the stream that indicated the end
 752  * of the stream. This option is used when multiple snapshots are
 753  * sent back to back.
 754  */
 755 #define BTRFS_SEND_FLAG_OMIT_END_CMD            0x4
 756
 757 #define BTRFS_SEND_FLAG_MASK \
 758         (BTRFS_SEND_FLAG_NO_FILE_DATA | \
 759          BTRFS_SEND_FLAG_OMIT_STREAM_HEADER | \
 760          BTRFS_SEND_FLAG_OMIT_END_CMD)
 761
 762 struct btrfs_ioctl_send_args {
 763         __s64 send_fd;                  /* in */
 764         __u64 clone_sources_count;      /* in */
 765         __u64 __user *clone_sources;    /* in */
 766         __u64 parent_root;              /* in */
 767         __u64 flags;                    /* in */
 768         __u64 reserved[4];              /* in */
 769 };
 770
 771 /*
 772  * Information about a fs tree root.
 773  *
 774  * All items are filled by the ioctl
 775  */
 776 struct btrfs_ioctl_get_subvol_info_args {
 777         /* Id of this subvolume */
 778         __u64 treeid;
 779
 780         /* Name of this subvolume, used to get the real name at mount point */
 781         char name[BTRFS_VOL_NAME_MAX + 1];
 782
 783         /*
 784          * Id of the subvolume which contains this subvolume.
 785          * Zero for top-level subvolume or a deleted subvolume.
 786          */
 787         __u64 parent_id;
 788
 789         /*
 790          * Inode number of the directory which contains this subvolume.
 791          * Zero for top-level subvolume or a deleted subvolume
 792          */
 793         __u64 dirid;
 794
 795         /* Latest transaction id of this subvolume */
 796         __u64 generation;
 797
 798         /* Flags of this subvolume */
 799         __u64 flags;
 800
 801         /* UUID of this subvolume */
 802         __u8 uuid[BTRFS_UUID_SIZE];
 803
 804         /*
 805          * UUID of the subvolume of which this subvolume is a snapshot.
 806          * All zero for a non-snapshot subvolume.
 807          */
 808         __u8 parent_uuid[BTRFS_UUID_SIZE];
 809
 810         /*
 811          * UUID of the subvolume from which this subvolume was received.
 812          * All zero for non-received subvolume.
 813          */
 814         __u8 received_uuid[BTRFS_UUID_SIZE];
 815
 816         /* Transaction id indicating when change/create/send/receive happened */
 817         __u64 ctransid;
 818         __u64 otransid;
 819         __u64 stransid;
 820         __u64 rtransid;
 821         /* Time corresponding to c/o/s/rtransid */
 822         struct btrfs_ioctl_timespec ctime;
 823         struct btrfs_ioctl_timespec otime;
 824         struct btrfs_ioctl_timespec stime;
 825         struct btrfs_ioctl_timespec rtime;
 826
 827         /* Must be zero */
 828         __u64 reserved[8];
 829 };
 830
 831 #define BTRFS_MAX_ROOTREF_BUFFER_NUM 255
 832 struct btrfs_ioctl_get_subvol_rootref_args {
 833                 /* in/out, minimum id of rootref's treeid to be searched */
 834                 __u64 min_treeid;
 835
 836                 /* out */
 837                 struct {
 838                         __u64 treeid;
 839                         __u64 dirid;
 840                 } rootref[BTRFS_MAX_ROOTREF_BUFFER_NUM];
 841
 842                 /* out, number of found items */
 843                 __u8 num_items;
 844                 __u8 align[7];
 845 };
 846
 847 /* Error codes as returned by the kernel */
 848 enum btrfs_err_code {
 849         BTRFS_ERROR_DEV_RAID1_MIN_NOT_MET = 1,
 850         BTRFS_ERROR_DEV_RAID10_MIN_NOT_MET,
 851         BTRFS_ERROR_DEV_RAID5_MIN_NOT_MET,
 852         BTRFS_ERROR_DEV_RAID6_MIN_NOT_MET,
 853         BTRFS_ERROR_DEV_TGT_REPLACE,
 854         BTRFS_ERROR_DEV_MISSING_NOT_FOUND,
 855         BTRFS_ERROR_DEV_ONLY_WRITABLE,
 856         BTRFS_ERROR_DEV_EXCL_RUN_IN_PROGRESS,
 857         BTRFS_ERROR_DEV_RAID1C3_MIN_NOT_MET,
 858         BTRFS_ERROR_DEV_RAID1C4_MIN_NOT_MET,
 859 };
 860
 861 #define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
 862                                    struct btrfs_ioctl_vol_args)
 863 #define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
 864                                    struct btrfs_ioctl_vol_args)
 865 #define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
 866                                    struct btrfs_ioctl_vol_args)
 867 #define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
 868                                    struct btrfs_ioctl_vol_args)
 869 #define BTRFS_IOC_FORGET_DEV _IOW(BTRFS_IOCTL_MAGIC, 5, \
 870                                    struct btrfs_ioctl_vol_args)
 871 /* trans start and trans end are dangerous, and only for
 872  * use by applications that know how to avoid the
 873  * resulting deadlocks
 874  */
 875 #define BTRFS_IOC_TRANS_START  _IO(BTRFS_IOCTL_MAGIC, 6)
 876 #define BTRFS_IOC_TRANS_END    _IO(BTRFS_IOCTL_MAGIC, 7)
 877 #define BTRFS_IOC_SYNC         _IO(BTRFS_IOCTL_MAGIC, 8)
 878
 879 #define BTRFS_IOC_CLONE        _IOW(BTRFS_IOCTL_MAGIC, 9, int)
 880 #define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
 881                                    struct btrfs_ioctl_vol_args)
 882 #define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
 883                                    struct btrfs_ioctl_vol_args)
 884 #define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
 885                                    struct btrfs_ioctl_vol_args)
 886
 887 #define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
 888                                   struct btrfs_ioctl_clone_range_args)
 889
 890 #define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
 891                                    struct btrfs_ioctl_vol_args)
 892 #define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
 893                                 struct btrfs_ioctl_vol_args)
 894 #define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
 895                                 struct btrfs_ioctl_defrag_range_args)
 896 #define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
 897                                    struct btrfs_ioctl_search_args)
 898 #define BTRFS_IOC_TREE_SEARCH_V2 _IOWR(BTRFS_IOCTL_MAGIC, 17, \
 899                                            struct btrfs_ioctl_search_args_v2)
 900 #define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
 901                                    struct btrfs_ioctl_ino_lookup_args)
 902 #define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, __u64)
 903 #define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
 904                                     struct btrfs_ioctl_space_args)
 905 #define BTRFS_IOC_START_SYNC _IOR(BTRFS_IOCTL_MAGIC, 24, __u64)
 906 #define BTRFS_IOC_WAIT_SYNC  _IOW(BTRFS_IOCTL_MAGIC, 22, __u64)
 907 #define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \
 908                                    struct btrfs_ioctl_vol_args_v2)
 909 #define BTRFS_IOC_SUBVOL_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 24, \
 910                                    struct btrfs_ioctl_vol_args_v2)
 911 #define BTRFS_IOC_SUBVOL_GETFLAGS _IOR(BTRFS_IOCTL_MAGIC, 25, __u64)
 912 #define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64)
 913 #define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \
 914                               struct btrfs_ioctl_scrub_args)
 915 #define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28)
 916 #define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \
 917                                        struct btrfs_ioctl_scrub_args)
 918 #define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \
 919                                  struct btrfs_ioctl_dev_info_args)
 920 #define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \
 921                                struct btrfs_ioctl_fs_info_args)
 922 #define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \
 923                                    struct btrfs_ioctl_balance_args)
 924 #define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int)
 925 #define BTRFS_IOC_BALANCE_PROGRESS _IOR(BTRFS_IOCTL_MAGIC, 34, \
 926                                         struct btrfs_ioctl_balance_args)
 927 #define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \
 928                                         struct btrfs_ioctl_ino_path_args)
 929 #define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \
 930                                         struct btrfs_ioctl_logical_ino_args)
 931 #define BTRFS_IOC_SET_RECEIVED_SUBVOL _IOWR(BTRFS_IOCTL_MAGIC, 37, \
 932                                 struct btrfs_ioctl_received_subvol_args)
 933 #define BTRFS_IOC_SEND _IOW(BTRFS_IOCTL_MAGIC, 38, struct btrfs_ioctl_send_args)
 934 #define BTRFS_IOC_DEVICES_READY _IOR(BTRFS_IOCTL_MAGIC, 39, \
 935                                      struct btrfs_ioctl_vol_args)
 936 #define BTRFS_IOC_QUOTA_CTL _IOWR(BTRFS_IOCTL_MAGIC, 40, \
 937                                struct btrfs_ioctl_quota_ctl_args)
 938 #define BTRFS_IOC_QGROUP_ASSIGN _IOW(BTRFS_IOCTL_MAGIC, 41, \
 939                                struct btrfs_ioctl_qgroup_assign_args)
 940 #define BTRFS_IOC_QGROUP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 42, \
 941                                struct btrfs_ioctl_qgroup_create_args)
 942 #define BTRFS_IOC_QGROUP_LIMIT _IOR(BTRFS_IOCTL_MAGIC, 43, \
 943                                struct btrfs_ioctl_qgroup_limit_args)
 944 #define BTRFS_IOC_QUOTA_RESCAN _IOW(BTRFS_IOCTL_MAGIC, 44, \
 945                                struct btrfs_ioctl_quota_rescan_args)
 946 #define BTRFS_IOC_QUOTA_RESCAN_STATUS _IOR(BTRFS_IOCTL_MAGIC, 45, \
 947                                struct btrfs_ioctl_quota_rescan_args)
 948 #define BTRFS_IOC_QUOTA_RESCAN_WAIT _IO(BTRFS_IOCTL_MAGIC, 46)
 949 #define BTRFS_IOC_GET_FSLABEL   FS_IOC_GETFSLABEL
 950 #define BTRFS_IOC_SET_FSLABEL   FS_IOC_SETFSLABEL
 951 #define BTRFS_IOC_GET_DEV_STATS _IOWR(BTRFS_IOCTL_MAGIC, 52, \
 952                                       struct btrfs_ioctl_get_dev_stats)
 953 #define BTRFS_IOC_DEV_REPLACE _IOWR(BTRFS_IOCTL_MAGIC, 53, \
 954                                     struct btrfs_ioctl_dev_replace_args)
 955 #define BTRFS_IOC_FILE_EXTENT_SAME _IOWR(BTRFS_IOCTL_MAGIC, 54, \
 956                                          struct btrfs_ioctl_same_args)
 957 #define BTRFS_IOC_GET_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
 958                                    struct btrfs_ioctl_feature_flags)
 959 #define BTRFS_IOC_SET_FEATURES _IOW(BTRFS_IOCTL_MAGIC, 57, \
 960                                    struct btrfs_ioctl_feature_flags[2])
 961 #define BTRFS_IOC_GET_SUPPORTED_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
 962                                    struct btrfs_ioctl_feature_flags[3])
 963 #define BTRFS_IOC_RM_DEV_V2 _IOW(BTRFS_IOCTL_MAGIC, 58, \
 964                                    struct btrfs_ioctl_vol_args_v2)
 965 #define BTRFS_IOC_LOGICAL_INO_V2 _IOWR(BTRFS_IOCTL_MAGIC, 59, \
 966                                         struct btrfs_ioctl_logical_ino_args)
 967 #define BTRFS_IOC_GET_SUBVOL_INFO _IOR(BTRFS_IOCTL_MAGIC, 60, \
 968                                 struct btrfs_ioctl_get_subvol_info_args)
 969 #define BTRFS_IOC_GET_SUBVOL_ROOTREF _IOWR(BTRFS_IOCTL_MAGIC, 61, \
 970                                 struct btrfs_ioctl_get_subvol_rootref_args)
 971 #define BTRFS_IOC_INO_LOOKUP_USER _IOWR(BTRFS_IOCTL_MAGIC, 62, \
 972                                 struct btrfs_ioctl_ino_lookup_user_args)
 973 #define BTRFS_IOC_SNAP_DESTROY_V2 _IOW(BTRFS_IOCTL_MAGIC, 63, \
 974                                 struct btrfs_ioctl_vol_args_v2)
 975
 976 #endif /* _UAPI_LINUX_BTRFS_H */