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