ioctl.h

   1 /*
   2  * Copyright (C) 2007 Oracle.  All rights reserved.
   3  *
   4  * This program is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU General Public
   6  * License v2 as published by the Free Software Foundation.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  11  * General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public
  14  * License along with this program; if not, write to the
  15  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  16  * Boston, MA 021110-1307, USA.
  17  */
  18
  19 #ifndef __BTRFS_IOCTL_H__
  20 #define __BTRFS_IOCTL_H__
  21
  22 #ifdef __cplusplus
  23 extern "C" {
  24 #endif
  25
  26 #include <asm/types.h>
  27 #include <linux/ioctl.h>
  28
  29 #ifndef __user
  30 #define __user
  31 #endif
  32
  33 /* We don't want to include entire kerncompat.h */
  34 #ifndef BUILD_ASSERT
  35 #define BUILD_ASSERT(x)
  36 #endif
  37
  38 #define BTRFS_IOCTL_MAGIC 0x94
  39 #define BTRFS_VOL_NAME_MAX 255
  40
  41 /* this should be 4k */
  42 #define BTRFS_PATH_NAME_MAX 4087
  43 struct btrfs_ioctl_vol_args {
  44         __s64 fd;
  45         char name[BTRFS_PATH_NAME_MAX + 1];
  46 };
  47 BUILD_ASSERT(sizeof(struct btrfs_ioctl_vol_args) == 4096);
  48
  49 #define BTRFS_DEVICE_PATH_NAME_MAX 1024
  50
  51 #define BTRFS_SUBVOL_CREATE_ASYNC       (1ULL << 0)
  52 #define BTRFS_SUBVOL_RDONLY             (1ULL << 1)
  53 #define BTRFS_SUBVOL_QGROUP_INHERIT     (1ULL << 2)
  54 #define BTRFS_DEVICE_SPEC_BY_ID         (1ULL << 3)
  55
  56 #define BTRFS_VOL_ARG_V2_FLAGS_SUPPORTED                \
  57                         (BTRFS_SUBVOL_CREATE_ASYNC |    \
  58                         BTRFS_SUBVOL_RDONLY |           \
  59                         BTRFS_SUBVOL_QGROUP_INHERIT |   \
  60                         BTRFS_DEVICE_SPEC_BY_ID)
  61
  62 #define BTRFS_FSID_SIZE 16
  63 #define BTRFS_UUID_SIZE 16
  64
  65 #define BTRFS_QGROUP_INHERIT_SET_LIMITS (1ULL << 0)
  66
  67 struct btrfs_qgroup_limit {
  68         __u64   flags;
  69         __u64   max_referenced;
  70         __u64   max_exclusive;
  71         __u64   rsv_referenced;
  72         __u64   rsv_exclusive;
  73 };
  74 BUILD_ASSERT(sizeof(struct btrfs_qgroup_limit) == 40);
  75
  76 struct btrfs_qgroup_inherit {
  77         __u64   flags;
  78         __u64   num_qgroups;
  79         __u64   num_ref_copies;
  80         __u64   num_excl_copies;
  81         struct btrfs_qgroup_limit lim;
  82         __u64   qgroups[0];
  83 };
  84 BUILD_ASSERT(sizeof(struct btrfs_qgroup_inherit) == 72);
  85
  86 struct btrfs_ioctl_qgroup_limit_args {
  87         __u64   qgroupid;
  88         struct btrfs_qgroup_limit lim;
  89 };
  90 BUILD_ASSERT(sizeof(struct btrfs_ioctl_qgroup_limit_args) == 48);
  91
  92 #define BTRFS_SUBVOL_NAME_MAX 4039
  93 struct btrfs_ioctl_vol_args_v2 {
  94         __s64 fd;
  95         __u64 transid;
  96         __u64 flags;
  97         union {
  98                 struct {
  99                         __u64 size;
 100                         struct btrfs_qgroup_inherit __user *qgroup_inherit;
 101                 };
 102                 __u64 unused[4];
 103         };
 104         union {
 105                 char name[BTRFS_SUBVOL_NAME_MAX + 1];
 106                 __u64 devid;
 107         };
 108 };
 109 BUILD_ASSERT(sizeof(struct btrfs_ioctl_vol_args_v2) == 4096);
 110
 111 /*
 112  * structure to report errors and progress to userspace, either as a
 113  * result of a finished scrub, a canceled scrub or a progress inquiry
 114  */
 115 struct btrfs_scrub_progress {
 116         __u64 data_extents_scrubbed;    /* # of data extents scrubbed */
 117         __u64 tree_extents_scrubbed;    /* # of tree extents scrubbed */
 118         __u64 data_bytes_scrubbed;      /* # of data bytes scrubbed */
 119         __u64 tree_bytes_scrubbed;      /* # of tree bytes scrubbed */
 120         __u64 read_errors;              /* # of read errors encountered (EIO) */
 121         __u64 csum_errors;              /* # of failed csum checks */
 122         __u64 verify_errors;            /* # of occurrences, where the metadata
 123                                          * of a tree block did not match the
 124                                          * expected values, like generation or
 125                                          * logical */
 126         __u64 no_csum;                  /* # of 4k data block for which no csum
 127                                          * is present, probably the result of
 128                                          * data written with nodatasum */
 129         __u64 csum_discards;            /* # of csum for which no data was found
 130                                          * in the extent tree. */
 131         __u64 super_errors;             /* # of bad super blocks encountered */
 132         __u64 malloc_errors;            /* # of internal kmalloc errors. These
 133                                          * will likely cause an incomplete
 134                                          * scrub */
 135         __u64 uncorrectable_errors;     /* # of errors where either no intact
 136                                          * copy was found or the writeback
 137                                          * failed */
 138         __u64 corrected_errors;         /* # of errors corrected */
 139         __u64 last_physical;            /* last physical address scrubbed. In
 140                                          * case a scrub was aborted, this can
 141                                          * be used to restart the scrub */
 142         __u64 unverified_errors;        /* # of occurrences where a read for a
 143                                          * full (64k) bio failed, but the re-
 144                                          * check succeeded for each 4k piece.
 145                                          * Intermittent error. */
 146 };
 147
 148 #define BTRFS_SCRUB_READONLY    1
 149 struct btrfs_ioctl_scrub_args {
 150         __u64 devid;                            /* in */
 151         __u64 start;                            /* in */
 152         __u64 end;                              /* in */
 153         __u64 flags;                            /* in */
 154         struct btrfs_scrub_progress progress;   /* out */
 155         /* pad to 1k */
 156         __u64 unused[(1024-32-sizeof(struct btrfs_scrub_progress))/8];
 157 };
 158 BUILD_ASSERT(sizeof(struct btrfs_ioctl_scrub_args) == 1024);
 159
 160 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_ALWAYS    0
 161 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_AVOID     1
 162 struct btrfs_ioctl_dev_replace_start_params {
 163         __u64 srcdevid; /* in, if 0, use srcdev_name instead */
 164         __u64 cont_reading_from_srcdev_mode;    /* in, see #define
 165                                                  * above */
 166         __u8 srcdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1];       /* in */
 167         __u8 tgtdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1];       /* in */
 168 };
 169 BUILD_ASSERT(sizeof(struct btrfs_ioctl_dev_replace_start_params) == 2072);
 170
 171 #define BTRFS_IOCTL_DEV_REPLACE_STATE_NEVER_STARTED     0
 172 #define BTRFS_IOCTL_DEV_REPLACE_STATE_STARTED           1
 173 #define BTRFS_IOCTL_DEV_REPLACE_STATE_FINISHED          2
 174 #define BTRFS_IOCTL_DEV_REPLACE_STATE_CANCELED          3
 175 #define BTRFS_IOCTL_DEV_REPLACE_STATE_SUSPENDED         4
 176 struct btrfs_ioctl_dev_replace_status_params {
 177         __u64 replace_state;    /* out, see #define above */
 178         __u64 progress_1000;    /* out, 0 <= x <= 1000 */
 179         __u64 time_started;     /* out, seconds since 1-Jan-1970 */
 180         __u64 time_stopped;     /* out, seconds since 1-Jan-1970 */
 181         __u64 num_write_errors; /* out */
 182         __u64 num_uncorrectable_read_errors;    /* out */
 183 };
 184 BUILD_ASSERT(sizeof(struct btrfs_ioctl_dev_replace_status_params) == 48);
 185
 186 #define BTRFS_IOCTL_DEV_REPLACE_CMD_START                       0
 187 #define BTRFS_IOCTL_DEV_REPLACE_CMD_STATUS                      1
 188 #define BTRFS_IOCTL_DEV_REPLACE_CMD_CANCEL                      2
 189 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NO_RESULT                -1
 190 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NO_ERROR                 0
 191 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NOT_STARTED              1
 192 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_ALREADY_STARTED          2
 193 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_SCRUB_INPROGRESS         3
 194 struct btrfs_ioctl_dev_replace_args {
 195         __u64 cmd;      /* in */
 196         __u64 result;   /* out */
 197
 198         union {
 199                 struct btrfs_ioctl_dev_replace_start_params start;
 200                 struct btrfs_ioctl_dev_replace_status_params status;
 201         };      /* in/out */
 202
 203         __u64 spare[64];
 204 };
 205 BUILD_ASSERT(sizeof(struct btrfs_ioctl_dev_replace_args) == 2600);
 206
 207 struct btrfs_ioctl_dev_info_args {
 208         __u64 devid;                            /* in/out */
 209         __u8 uuid[BTRFS_UUID_SIZE];             /* in/out */
 210         __u64 bytes_used;                       /* out */
 211         __u64 total_bytes;                      /* out */
 212         __u64 unused[379];                      /* pad to 4k */
 213         __u8 path[BTRFS_DEVICE_PATH_NAME_MAX];  /* out */
 214 };
 215 BUILD_ASSERT(sizeof(struct btrfs_ioctl_dev_info_args) == 4096);
 216
 217 struct btrfs_ioctl_fs_info_args {
 218         __u64 max_id;                           /* out */
 219         __u64 num_devices;                      /* out */
 220         __u8 fsid[BTRFS_FSID_SIZE];             /* out */
 221         __u32 nodesize;                         /* out */
 222         __u32 sectorsize;                       /* out */
 223         __u32 clone_alignment;                  /* out */
 224         __u32 reserved32;
 225         __u64 reserved[122];                    /* pad to 1k */
 226 };
 227 BUILD_ASSERT(sizeof(struct btrfs_ioctl_fs_info_args) == 1024);
 228
 229 struct btrfs_ioctl_feature_flags {
 230         __u64 compat_flags;
 231         __u64 compat_ro_flags;
 232         __u64 incompat_flags;
 233 };
 234 BUILD_ASSERT(sizeof(struct btrfs_ioctl_feature_flags) == 24);
 235
 236 /* balance control ioctl modes */
 237 #define BTRFS_BALANCE_CTL_PAUSE         1
 238 #define BTRFS_BALANCE_CTL_CANCEL        2
 239 #define BTRFS_BALANCE_CTL_RESUME        3
 240
 241 /*
 242  * this is packed, because it should be exactly the same as its disk
 243  * byte order counterpart (struct btrfs_disk_balance_args)
 244  */
 245 struct btrfs_balance_args {
 246         __u64 profiles;
 247
 248         /*
 249          * usage filter
 250          * BTRFS_BALANCE_ARGS_USAGE with a single value means '0..N'
 251          * BTRFS_BALANCE_ARGS_USAGE_RANGE - range syntax, min..max
 252          */
 253         union {
 254                 __u64 usage;
 255                 struct {
 256                         __u32 usage_min;
 257                         __u32 usage_max;
 258                 };
 259         };
 260
 261         __u64 devid;
 262         __u64 pstart;
 263         __u64 pend;
 264         __u64 vstart;
 265         __u64 vend;
 266
 267         __u64 target;
 268
 269         __u64 flags;
 270
 271         /*
 272          * BTRFS_BALANCE_ARGS_LIMIT with value 'limit'
 273          * BTRFS_BALANCE_ARGS_LIMIT_RANGE - the extend version can use minimum
 274          * and maximum
 275          */
 276         union {
 277                 __u64 limit;            /* limit number of processed chunks */
 278                 struct {
 279                         __u32 limit_min;
 280                         __u32 limit_max;
 281                 };
 282         };
 283         __u32 stripes_min;
 284         __u32 stripes_max;
 285         __u64 unused[6];
 286 } __attribute__ ((__packed__));
 287
 288 /* report balance progress to userspace */
 289 struct btrfs_balance_progress {
 290         __u64 expected;         /* estimated # of chunks that will be
 291                                  * relocated to fulfil the request */
 292         __u64 considered;       /* # of chunks we have considered so far */
 293         __u64 completed;        /* # of chunks relocated so far */
 294 };
 295
 296 #define BTRFS_BALANCE_STATE_RUNNING     (1ULL << 0)
 297 #define BTRFS_BALANCE_STATE_PAUSE_REQ   (1ULL << 1)
 298 #define BTRFS_BALANCE_STATE_CANCEL_REQ  (1ULL << 2)
 299
 300 struct btrfs_ioctl_balance_args {
 301         __u64 flags;                            /* in/out */
 302         __u64 state;                            /* out */
 303
 304         struct btrfs_balance_args data;         /* in/out */
 305         struct btrfs_balance_args meta;         /* in/out */
 306         struct btrfs_balance_args sys;          /* in/out */
 307
 308         struct btrfs_balance_progress stat;     /* out */
 309
 310         __u64 unused[72];                       /* pad to 1k */
 311 };
 312 BUILD_ASSERT(sizeof(struct btrfs_ioctl_balance_args) == 1024);
 313
 314 #define BTRFS_INO_LOOKUP_PATH_MAX 4080
 315 struct btrfs_ioctl_ino_lookup_args {
 316         __u64 treeid;
 317         __u64 objectid;
 318         char name[BTRFS_INO_LOOKUP_PATH_MAX];
 319 };
 320 BUILD_ASSERT(sizeof(struct btrfs_ioctl_ino_lookup_args) == 4096);
 321
 322 struct btrfs_ioctl_search_key {
 323         /* which root are we searching.  0 is the tree of tree roots */
 324         __u64 tree_id;
 325
 326         /* keys returned will be >= min and <= max */
 327         __u64 min_objectid;
 328         __u64 max_objectid;
 329
 330         /* keys returned will be >= min and <= max */
 331         __u64 min_offset;
 332         __u64 max_offset;
 333
 334         /* max and min transids to search for */
 335         __u64 min_transid;
 336         __u64 max_transid;
 337
 338         /* keys returned will be >= min and <= max */
 339         __u32 min_type;
 340         __u32 max_type;
 341
 342         /*
 343          * how many items did userland ask for, and how many are we
 344          * returning
 345          */
 346         __u32 nr_items;
 347
 348         /* align to 64 bits */
 349         __u32 unused;
 350
 351         /* some extra for later */
 352         __u64 unused1;
 353         __u64 unused2;
 354         __u64 unused3;
 355         __u64 unused4;
 356 };
 357
 358 struct btrfs_ioctl_search_header {
 359         __u64 transid;
 360         __u64 objectid;
 361         __u64 offset;
 362         __u32 type;
 363         __u32 len;
 364 } __attribute__((may_alias));
 365
 366 #define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
 367 /*
 368  * the buf is an array of search headers where
 369  * each header is followed by the actual item
 370  * the type field is expanded to 32 bits for alignment
 371  */
 372 struct btrfs_ioctl_search_args {
 373         struct btrfs_ioctl_search_key key;
 374         char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
 375 };
 376
 377 /*
 378  * Extended version of TREE_SEARCH ioctl that can return more than 4k of bytes.
 379  * The allocated size of the buffer is set in buf_size.
 380  */
 381 struct btrfs_ioctl_search_args_v2 {
 382         struct btrfs_ioctl_search_key key; /* in/out - search parameters */
 383         __u64 buf_size;                    /* in - size of buffer
 384                                             * out - on EOVERFLOW: needed size
 385                                             *       to store item */
 386         __u64 buf[0];                      /* out - found items */
 387 };
 388 BUILD_ASSERT(sizeof(struct btrfs_ioctl_search_args_v2) == 112);
 389
 390 /* With a @src_length of zero, the range from @src_offset->EOF is cloned! */
 391 struct btrfs_ioctl_clone_range_args {
 392         __s64 src_fd;
 393         __u64 src_offset, src_length;
 394         __u64 dest_offset;
 395 };
 396 BUILD_ASSERT(sizeof(struct btrfs_ioctl_clone_range_args) == 32);
 397
 398 /* flags for the defrag range ioctl */
 399 #define BTRFS_DEFRAG_RANGE_COMPRESS 1
 400 #define BTRFS_DEFRAG_RANGE_START_IO 2
 401
 402 #define BTRFS_SAME_DATA_DIFFERS 1
 403 /* For extent-same ioctl */
 404 struct btrfs_ioctl_same_extent_info {
 405         __s64 fd;               /* in - destination file */
 406         __u64 logical_offset;   /* in - start of extent in destination */
 407         __u64 bytes_deduped;    /* out - total # of bytes we were able
 408                                  * to dedupe from this file */
 409         /* status of this dedupe operation:
 410          * 0 if dedup succeeds
 411          * < 0 for error
 412          * == BTRFS_SAME_DATA_DIFFERS if data differs
 413          */
 414         __s32 status;           /* out - see above description */
 415         __u32 reserved;
 416 };
 417
 418 struct btrfs_ioctl_same_args {
 419         __u64 logical_offset;   /* in - start of extent in source */
 420         __u64 length;           /* in - length of extent */
 421         __u16 dest_count;       /* in - total elements in info array */
 422         __u16 reserved1;
 423         __u32 reserved2;
 424         struct btrfs_ioctl_same_extent_info info[0];
 425 };
 426 BUILD_ASSERT(sizeof(struct btrfs_ioctl_same_args) == 24);
 427
 428 struct btrfs_ioctl_defrag_range_args {
 429         /* start of the defrag operation */
 430         __u64 start;
 431
 432         /* number of bytes to defrag, use (u64)-1 to say all */
 433         __u64 len;
 434
 435         /*
 436          * flags for the operation, which can include turning
 437          * on compression for this one defrag
 438          */
 439         __u64 flags;
 440
 441         /*
 442          * any extent bigger than this will be considered
 443          * already defragged.  Use 0 to take the kernel default
 444          * Use 1 to say every single extent must be rewritten
 445          */
 446         __u32 extent_thresh;
 447
 448         /*
 449          * which compression method to use if turning on compression
 450          * for this defrag operation.  If unspecified, zlib will
 451          * be used
 452          */
 453         __u32 compress_type;
 454
 455         /* spare for later */
 456         __u32 unused[4];
 457 };
 458 BUILD_ASSERT(sizeof(struct btrfs_ioctl_defrag_range_args) == 48);
 459
 460 struct btrfs_ioctl_space_info {
 461         __u64 flags;
 462         __u64 total_bytes;
 463         __u64 used_bytes;
 464 };
 465
 466 struct btrfs_ioctl_space_args {
 467         __u64 space_slots;
 468         __u64 total_spaces;
 469         struct btrfs_ioctl_space_info spaces[0];
 470 };
 471 BUILD_ASSERT(sizeof(struct btrfs_ioctl_space_args) == 16);
 472
 473 struct btrfs_data_container {
 474         __u32   bytes_left;     /* out -- bytes not needed to deliver output */
 475         __u32   bytes_missing;  /* out -- additional bytes needed for result */
 476         __u32   elem_cnt;       /* out */
 477         __u32   elem_missed;    /* out */
 478         __u64   val[0];         /* out */
 479 };
 480
 481 struct btrfs_ioctl_ino_path_args {
 482         __u64                           inum;           /* in */
 483         __u64                           size;           /* in */
 484         __u64                           reserved[4];
 485         /* struct btrfs_data_container  *fspath;           out */
 486         __u64                           fspath;         /* out */
 487 };
 488 BUILD_ASSERT(sizeof(struct btrfs_ioctl_ino_path_args) == 56);
 489
 490 struct btrfs_ioctl_logical_ino_args {
 491         __u64                           logical;        /* in */
 492         __u64                           size;           /* in */
 493         __u64                           reserved[4];
 494         /* struct btrfs_data_container  *inodes;        out   */
 495         __u64                           inodes;
 496 };
 497
 498 enum btrfs_dev_stat_values {
 499         /* disk I/O failure stats */
 500         BTRFS_DEV_STAT_WRITE_ERRS, /* EIO or EREMOTEIO from lower layers */
 501         BTRFS_DEV_STAT_READ_ERRS, /* EIO or EREMOTEIO from lower layers */
 502         BTRFS_DEV_STAT_FLUSH_ERRS, /* EIO or EREMOTEIO from lower layers */
 503
 504         /* stats for indirect indications for I/O failures */
 505         BTRFS_DEV_STAT_CORRUPTION_ERRS, /* checksum error, bytenr error or
 506                                          * contents is illegal: this is an
 507                                          * indication that the block was damaged
 508                                          * during read or write, or written to
 509                                          * wrong location or read from wrong
 510                                          * location */
 511         BTRFS_DEV_STAT_GENERATION_ERRS, /* an indication that blocks have not
 512                                          * been written */
 513
 514         BTRFS_DEV_STAT_VALUES_MAX
 515 };
 516
 517 /* Reset statistics after reading; needs SYS_ADMIN capability */
 518 #define BTRFS_DEV_STATS_RESET           (1ULL << 0)
 519
 520 struct btrfs_ioctl_get_dev_stats {
 521         __u64 devid;                            /* in */
 522         __u64 nr_items;                         /* in/out */
 523         __u64 flags;                            /* in/out */
 524
 525         /* out values: */
 526         __u64 values[BTRFS_DEV_STAT_VALUES_MAX];
 527
 528         __u64 unused[128 - 2 - BTRFS_DEV_STAT_VALUES_MAX]; /* pad to 1k + 8B */
 529 };
 530 BUILD_ASSERT(sizeof(struct btrfs_ioctl_get_dev_stats) == 1032);
 531
 532 /* BTRFS_IOC_SNAP_CREATE is no longer used by the btrfs command */
 533 #define BTRFS_QUOTA_CTL_ENABLE  1
 534 #define BTRFS_QUOTA_CTL_DISABLE 2
 535 /* 3 has formerly been reserved for BTRFS_QUOTA_CTL_RESCAN */
 536 struct btrfs_ioctl_quota_ctl_args {
 537         __u64 cmd;
 538         __u64 status;
 539 };
 540 BUILD_ASSERT(sizeof(struct btrfs_ioctl_quota_ctl_args) == 16);
 541
 542 struct btrfs_ioctl_quota_rescan_args {
 543         __u64   flags;
 544         __u64   progress;
 545         __u64   reserved[6];
 546 };
 547 BUILD_ASSERT(sizeof(struct btrfs_ioctl_quota_rescan_args) == 64);
 548
 549 struct btrfs_ioctl_qgroup_assign_args {
 550         __u64 assign;
 551         __u64 src;
 552         __u64 dst;
 553 };
 554
 555 struct btrfs_ioctl_qgroup_create_args {
 556         __u64 create;
 557         __u64 qgroupid;
 558 };
 559 BUILD_ASSERT(sizeof(struct btrfs_ioctl_qgroup_create_args) == 16);
 560
 561 struct btrfs_ioctl_timespec {
 562         __u64 sec;
 563         __u32 nsec;
 564 };
 565
 566 struct btrfs_ioctl_received_subvol_args {
 567         char    uuid[BTRFS_UUID_SIZE];  /* in */
 568         __u64   stransid;               /* in */
 569         __u64   rtransid;               /* out */
 570         struct btrfs_ioctl_timespec stime; /* in */
 571         struct btrfs_ioctl_timespec rtime; /* out */
 572         __u64   flags;                  /* in */
 573         __u64   reserved[16];           /* in */
 574 };
 575 BUILD_ASSERT(sizeof(struct btrfs_ioctl_received_subvol_args) == 200);
 576
 577 /*
 578  * If we have a 32-bit userspace and 64-bit kernel, then the UAPI
 579  * structures are incorrect, as the timespec structure from userspace
 580  * is 4 bytes too small. We define these alternatives here for backward
 581  * compatibility, the kernel understands both values.
 582  */
 583
 584 /*
 585  * Structure size is different on 32bit and 64bit, has some padding if the
 586  * structure is embedded. Packing makes sure the size is same on both, but will
 587  * be misaligned on 64bit.
 588  *
 589  * NOTE: do not use in your code, this is for testing only
 590  */
 591 struct btrfs_ioctl_timespec_32 {
 592         __u64 sec;
 593         __u32 nsec;
 594 } __attribute__ ((__packed__));
 595
 596 struct btrfs_ioctl_received_subvol_args_32 {
 597         char    uuid[BTRFS_UUID_SIZE];  /* in */
 598         __u64   stransid;               /* in */
 599         __u64   rtransid;               /* out */
 600         struct btrfs_ioctl_timespec_32 stime; /* in */
 601         struct btrfs_ioctl_timespec_32 rtime; /* out */
 602         __u64   flags;                  /* in */
 603         __u64   reserved[16];           /* in */
 604 } __attribute__ ((__packed__));
 605 BUILD_ASSERT(sizeof(struct btrfs_ioctl_received_subvol_args_32) == 192);
 606
 607 #define BTRFS_IOC_SET_RECEIVED_SUBVOL_32_COMPAT_DEFINED 1
 608
 609 /*
 610  * Caller doesn't want file data in the send stream, even if the
 611  * search of clone sources doesn't find an extent. UPDATE_EXTENT
 612  * commands will be sent instead of WRITE commands.
 613  */
 614 #define BTRFS_SEND_FLAG_NO_FILE_DATA            0x1
 615
 616 /*
 617  * Do not add the leading stream header. Used when multiple snapshots
 618  * are sent back to back.
 619  */
 620 #define BTRFS_SEND_FLAG_OMIT_STREAM_HEADER      0x2
 621
 622 /*
 623  * Omit the command at the end of the stream that indicated the end
 624  * of the stream. This option is used when multiple snapshots are
 625  * sent back to back.
 626  */
 627 #define BTRFS_SEND_FLAG_OMIT_END_CMD            0x4
 628
 629 #define BTRFS_SEND_FLAG_MASK \
 630         (BTRFS_SEND_FLAG_NO_FILE_DATA | \
 631          BTRFS_SEND_FLAG_OMIT_STREAM_HEADER | \
 632          BTRFS_SEND_FLAG_OMIT_END_CMD)
 633
 634 struct btrfs_ioctl_send_args {
 635         __s64 send_fd;                  /* in */
 636         __u64 clone_sources_count;      /* in */
 637         __u64 __user *clone_sources;    /* in */
 638         __u64 parent_root;              /* in */
 639         __u64 flags;                    /* in */
 640         __u64 reserved[4];              /* in */
 641 };
 642 /*
 643  * Size of structure depends on pointer width, was not caught in the early
 644  * days.  Kernel handles pointer width differences transparently.
 645  */
 646 BUILD_ASSERT(sizeof(__u64 *) == 8
 647              ? sizeof(struct btrfs_ioctl_send_args) == 72
 648              : (sizeof(void *) == 4
 649                 ? sizeof(struct btrfs_ioctl_send_args) == 68
 650                 : 0));
 651
 652 /*
 653  * Different pointer width leads to structure size change. Kernel should accept
 654  * both ioctl values (derived from the structures) for backward compatibility.
 655  * Size of this structure is same on 32bit and 64bit though.
 656  *
 657  * NOTE: do not use in your code, this is for testing only
 658  */
 659 struct btrfs_ioctl_send_args_64 {
 660         __s64 send_fd;                  /* in */
 661         __u64 clone_sources_count;      /* in */
 662         union {
 663                 __u64 __user *clone_sources;    /* in */
 664                 __u64 __clone_sources_alignment;
 665         };
 666         __u64 parent_root;              /* in */
 667         __u64 flags;                    /* in */
 668         __u64 reserved[4];              /* in */
 669 } __attribute__((packed));
 670 BUILD_ASSERT(sizeof(struct btrfs_ioctl_send_args_64) == 72);
 671
 672 #define BTRFS_IOC_SEND_64_COMPAT_DEFINED 1
 673
 674 /* Error codes as returned by the kernel */
 675 enum btrfs_err_code {
 676         notused,
 677         BTRFS_ERROR_DEV_RAID1_MIN_NOT_MET,
 678         BTRFS_ERROR_DEV_RAID10_MIN_NOT_MET,
 679         BTRFS_ERROR_DEV_RAID5_MIN_NOT_MET,
 680         BTRFS_ERROR_DEV_RAID6_MIN_NOT_MET,
 681         BTRFS_ERROR_DEV_TGT_REPLACE,
 682         BTRFS_ERROR_DEV_MISSING_NOT_FOUND,
 683         BTRFS_ERROR_DEV_ONLY_WRITABLE,
 684         BTRFS_ERROR_DEV_EXCL_RUN_IN_PROGRESS
 685 };
 686
 687 /* An error code to error string mapping for the kernel
 688 *  error codes
 689 */
 690 static inline char *btrfs_err_str(enum btrfs_err_code err_code)
 691 {
 692         switch (err_code) {
 693                 case BTRFS_ERROR_DEV_RAID1_MIN_NOT_MET:
 694                         return "unable to go below two devices on raid1";
 695                 case BTRFS_ERROR_DEV_RAID10_MIN_NOT_MET:
 696                         return "unable to go below four devices on raid10";
 697                 case BTRFS_ERROR_DEV_RAID5_MIN_NOT_MET:
 698                         return "unable to go below two devices on raid5";
 699                 case BTRFS_ERROR_DEV_RAID6_MIN_NOT_MET:
 700                         return "unable to go below three devices on raid6";
 701                 case BTRFS_ERROR_DEV_TGT_REPLACE:
 702                         return "unable to remove the dev_replace target dev";
 703                 case BTRFS_ERROR_DEV_MISSING_NOT_FOUND:
 704                         return "no missing devices found to remove";
 705                 case BTRFS_ERROR_DEV_ONLY_WRITABLE:
 706                         return "unable to remove the only writeable device";
 707                 case BTRFS_ERROR_DEV_EXCL_RUN_IN_PROGRESS:
 708                         return "add/delete/balance/replace/resize operation "
 709                                 "in progress";
 710                 default:
 711                         return NULL;
 712         }
 713 }
 714
 715 #define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
 716                                    struct btrfs_ioctl_vol_args)
 717 #define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
 718                                    struct btrfs_ioctl_vol_args)
 719 #define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
 720                                    struct btrfs_ioctl_vol_args)
 721 #define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
 722                                    struct btrfs_ioctl_vol_args)
 723 /* trans start and trans end are dangerous, and only for
 724  * use by applications that know how to avoid the
 725  * resulting deadlocks
 726  */
 727 #define BTRFS_IOC_TRANS_START  _IO(BTRFS_IOCTL_MAGIC, 6)
 728 #define BTRFS_IOC_TRANS_END    _IO(BTRFS_IOCTL_MAGIC, 7)
 729 #define BTRFS_IOC_SYNC         _IO(BTRFS_IOCTL_MAGIC, 8)
 730
 731 #define BTRFS_IOC_CLONE        _IOW(BTRFS_IOCTL_MAGIC, 9, int)
 732 #define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
 733                                    struct btrfs_ioctl_vol_args)
 734 #define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
 735                                    struct btrfs_ioctl_vol_args)
 736 #define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
 737                                    struct btrfs_ioctl_vol_args)
 738
 739 #define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
 740                                    struct btrfs_ioctl_clone_range_args)
 741
 742 #define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
 743                                    struct btrfs_ioctl_vol_args)
 744 #define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
 745                                    struct btrfs_ioctl_vol_args)
 746 #define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
 747                                 struct btrfs_ioctl_defrag_range_args)
 748 #define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
 749                                    struct btrfs_ioctl_search_args)
 750 #define BTRFS_IOC_TREE_SEARCH_V2 _IOWR(BTRFS_IOCTL_MAGIC, 17, \
 751                                    struct btrfs_ioctl_search_args_v2)
 752 #define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
 753                                    struct btrfs_ioctl_ino_lookup_args)
 754 #define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, __u64)
 755 #define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
 756                                     struct btrfs_ioctl_space_args)
 757 #define BTRFS_IOC_START_SYNC _IOR(BTRFS_IOCTL_MAGIC, 24, __u64)
 758 #define BTRFS_IOC_WAIT_SYNC  _IOW(BTRFS_IOCTL_MAGIC, 22, __u64)
 759 #define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \
 760                                    struct btrfs_ioctl_vol_args_v2)
 761 #define BTRFS_IOC_SUBVOL_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 24, \
 762                                    struct btrfs_ioctl_vol_args_v2)
 763 #define BTRFS_IOC_SUBVOL_GETFLAGS _IOR(BTRFS_IOCTL_MAGIC, 25, __u64)
 764 #define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64)
 765 #define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \
 766                                 struct btrfs_ioctl_scrub_args)
 767 #define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28)
 768 #define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \
 769                                         struct btrfs_ioctl_scrub_args)
 770 #define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \
 771                                         struct btrfs_ioctl_dev_info_args)
 772 #define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \
 773                                  struct btrfs_ioctl_fs_info_args)
 774 #define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \
 775                                    struct btrfs_ioctl_balance_args)
 776 #define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int)
 777 #define BTRFS_IOC_BALANCE_PROGRESS _IOR(BTRFS_IOCTL_MAGIC, 34, \
 778                                         struct btrfs_ioctl_balance_args)
 779 #define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \
 780                                         struct btrfs_ioctl_ino_path_args)
 781 #define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \
 782                                         struct btrfs_ioctl_logical_ino_args)
 783 #define BTRFS_IOC_SET_RECEIVED_SUBVOL _IOWR(BTRFS_IOCTL_MAGIC, 37, \
 784                                 struct btrfs_ioctl_received_subvol_args)
 785
 786 #ifdef BTRFS_IOC_SET_RECEIVED_SUBVOL_32_COMPAT_DEFINED
 787 #define BTRFS_IOC_SET_RECEIVED_SUBVOL_32 _IOWR(BTRFS_IOCTL_MAGIC, 37, \
 788                                 struct btrfs_ioctl_received_subvol_args_32)
 789 #endif
 790
 791 #ifdef BTRFS_IOC_SEND_64_COMPAT_DEFINED
 792 #define BTRFS_IOC_SEND_64 _IOW(BTRFS_IOCTL_MAGIC, 38, \
 793                 struct btrfs_ioctl_send_args_64)
 794 #endif
 795
 796 #define BTRFS_IOC_SEND _IOW(BTRFS_IOCTL_MAGIC, 38, struct btrfs_ioctl_send_args)
 797 #define BTRFS_IOC_DEVICES_READY _IOR(BTRFS_IOCTL_MAGIC, 39, \
 798                                      struct btrfs_ioctl_vol_args)
 799 #define BTRFS_IOC_QUOTA_CTL _IOWR(BTRFS_IOCTL_MAGIC, 40, \
 800                                         struct btrfs_ioctl_quota_ctl_args)
 801 #define BTRFS_IOC_QGROUP_ASSIGN _IOW(BTRFS_IOCTL_MAGIC, 41, \
 802                                         struct btrfs_ioctl_qgroup_assign_args)
 803 #define BTRFS_IOC_QGROUP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 42, \
 804                                         struct btrfs_ioctl_qgroup_create_args)
 805 #define BTRFS_IOC_QGROUP_LIMIT _IOR(BTRFS_IOCTL_MAGIC, 43, \
 806                                         struct btrfs_ioctl_qgroup_limit_args)
 807 #define BTRFS_IOC_QUOTA_RESCAN _IOW(BTRFS_IOCTL_MAGIC, 44, \
 808                                struct btrfs_ioctl_quota_rescan_args)
 809 #define BTRFS_IOC_QUOTA_RESCAN_STATUS _IOR(BTRFS_IOCTL_MAGIC, 45, \
 810                                struct btrfs_ioctl_quota_rescan_args)
 811 #define BTRFS_IOC_QUOTA_RESCAN_WAIT _IO(BTRFS_IOCTL_MAGIC, 46)
 812 #define BTRFS_IOC_GET_FSLABEL _IOR(BTRFS_IOCTL_MAGIC, 49, \
 813                                    char[BTRFS_LABEL_SIZE])
 814 #define BTRFS_IOC_SET_FSLABEL _IOW(BTRFS_IOCTL_MAGIC, 50, \
 815                                    char[BTRFS_LABEL_SIZE])
 816 #define BTRFS_IOC_GET_DEV_STATS _IOWR(BTRFS_IOCTL_MAGIC, 52, \
 817                                       struct btrfs_ioctl_get_dev_stats)
 818 #define BTRFS_IOC_DEV_REPLACE _IOWR(BTRFS_IOCTL_MAGIC, 53, \
 819                                     struct btrfs_ioctl_dev_replace_args)
 820 #define BTRFS_IOC_FILE_EXTENT_SAME _IOWR(BTRFS_IOCTL_MAGIC, 54, \
 821                                          struct btrfs_ioctl_same_args)
 822 #define BTRFS_IOC_GET_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
 823                                   struct btrfs_ioctl_feature_flags)
 824 #define BTRFS_IOC_SET_FEATURES _IOW(BTRFS_IOCTL_MAGIC, 57, \
 825                                   struct btrfs_ioctl_feature_flags[2])
 826 #define BTRFS_IOC_GET_SUPPORTED_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
 827                                   struct btrfs_ioctl_feature_flags[3])
 828 #define BTRFS_IOC_RM_DEV_V2     _IOW(BTRFS_IOCTL_MAGIC, 58, \
 829                                    struct btrfs_ioctl_vol_args_v2)
 830 #ifdef __cplusplus
 831 }
 832 #endif
 833
 834 #endif