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 __IOCTL_
  20 #define __IOCTL_
  21 #include <asm/types.h>
  22 #include <linux/ioctl.h>
  23 #include <time.h>
  24
  25 #define BTRFS_IOCTL_MAGIC 0x94
  26 #define BTRFS_VOL_NAME_MAX 255
  27
  28 /* this should be 4k */
  29 #define BTRFS_PATH_NAME_MAX 4087
  30 struct btrfs_ioctl_vol_args {
  31         __s64 fd;
  32         char name[BTRFS_PATH_NAME_MAX + 1];
  33 };
  34
  35 #define BTRFS_SUBVOL_CREATE_ASYNC       (1ULL << 0)
  36 #define BTRFS_SUBVOL_RDONLY             (1ULL << 1)
  37 #define BTRFS_SUBVOL_QGROUP_INHERIT     (1ULL << 2)
  38
  39 #define BTRFS_QGROUP_INHERIT_SET_LIMITS (1ULL << 0)
  40
  41 struct btrfs_qgroup_limit {
  42         __u64   flags;
  43         __u64   max_referenced;
  44         __u64   max_exclusive;
  45         __u64   rsv_referenced;
  46         __u64   rsv_exclusive;
  47 };
  48
  49 struct btrfs_qgroup_inherit {
  50         __u64   flags;
  51         __u64   num_qgroups;
  52         __u64   num_ref_copies;
  53         __u64   num_excl_copies;
  54         struct btrfs_qgroup_limit lim;
  55         __u64   qgroups[0];
  56 };
  57
  58 struct btrfs_ioctl_qgroup_limit_args {
  59         __u64   qgroupid;
  60         struct btrfs_qgroup_limit lim;
  61 };
  62
  63 #define BTRFS_SUBVOL_NAME_MAX 4039
  64
  65 struct btrfs_ioctl_vol_args_v2 {
  66         __s64 fd;
  67         __u64 transid;
  68         __u64 flags;
  69         union {
  70                 struct {
  71                         __u64 size;
  72                         struct btrfs_qgroup_inherit *qgroup_inherit;
  73                 };
  74                 __u64 unused[4];
  75         };
  76         char name[BTRFS_SUBVOL_NAME_MAX + 1];
  77 };
  78
  79 #define BTRFS_FSID_SIZE 16
  80 #define BTRFS_UUID_SIZE 16
  81
  82 struct btrfs_scrub_progress {
  83         __u64 data_extents_scrubbed;
  84         __u64 tree_extents_scrubbed;
  85         __u64 data_bytes_scrubbed;
  86         __u64 tree_bytes_scrubbed;
  87         __u64 read_errors;
  88         __u64 csum_errors;
  89         __u64 verify_errors;
  90         __u64 no_csum;
  91         __u64 csum_discards;
  92         __u64 super_errors;
  93         __u64 malloc_errors;
  94         __u64 uncorrectable_errors;
  95         __u64 corrected_errors;
  96         __u64 last_physical;
  97         __u64 unverified_errors;
  98 };
  99
 100 #define BTRFS_SCRUB_READONLY    1
 101 struct btrfs_ioctl_scrub_args {
 102         __u64 devid;                            /* in */
 103         __u64 start;                            /* in */
 104         __u64 end;                              /* in */
 105         __u64 flags;                            /* in */
 106         struct btrfs_scrub_progress progress;   /* out */
 107         /* pad to 1k */
 108         __u64 unused[(1024-32-sizeof(struct btrfs_scrub_progress))/8];
 109 };
 110
 111 #define BTRFS_DEVICE_PATH_NAME_MAX 1024
 112 struct btrfs_ioctl_dev_info_args {
 113         __u64 devid;                            /* in/out */
 114         __u8 uuid[BTRFS_UUID_SIZE];             /* in/out */
 115         __u64 bytes_used;                       /* out */
 116         __u64 total_bytes;                      /* out */
 117         __u64 unused[379];                      /* pad to 4k */
 118         __u8 path[BTRFS_DEVICE_PATH_NAME_MAX];  /* out */
 119 };
 120
 121 struct btrfs_ioctl_fs_info_args {
 122         __u64 max_id;                           /* out */
 123         __u64 num_devices;                      /* out */
 124         __u8 fsid[BTRFS_FSID_SIZE];             /* out */
 125         __u64 reserved[124];                    /* pad to 1k */
 126 };
 127
 128 /* balance control ioctl modes */
 129 #define BTRFS_BALANCE_CTL_PAUSE         1
 130 #define BTRFS_BALANCE_CTL_CANCEL        2
 131 #define BTRFS_BALANCE_CTL_RESUME        3
 132
 133 /*
 134  * this is packed, because it should be exactly the same as its disk
 135  * byte order counterpart (struct btrfs_disk_balance_args)
 136  */
 137 struct btrfs_balance_args {
 138         __u64 profiles;
 139         __u64 usage;
 140         __u64 devid;
 141         __u64 pstart;
 142         __u64 pend;
 143         __u64 vstart;
 144         __u64 vend;
 145
 146         __u64 target;
 147
 148         __u64 flags;
 149
 150         __u64 unused[8];
 151 } __attribute__ ((__packed__));
 152
 153 struct btrfs_balance_progress {
 154         __u64 expected;
 155         __u64 considered;
 156         __u64 completed;
 157 };
 158
 159 #define BTRFS_BALANCE_STATE_RUNNING     (1ULL << 0)
 160 #define BTRFS_BALANCE_STATE_PAUSE_REQ   (1ULL << 1)
 161 #define BTRFS_BALANCE_STATE_CANCEL_REQ  (1ULL << 2)
 162
 163 struct btrfs_ioctl_balance_args {
 164         __u64 flags;                            /* in/out */
 165         __u64 state;                            /* out */
 166
 167         struct btrfs_balance_args data;         /* in/out */
 168         struct btrfs_balance_args meta;         /* in/out */
 169         struct btrfs_balance_args sys;          /* in/out */
 170
 171         struct btrfs_balance_progress stat;     /* out */
 172
 173         __u64 unused[72];                       /* pad to 1k */
 174 };
 175
 176 struct btrfs_ioctl_search_key {
 177         /* which root are we searching.  0 is the tree of tree roots */
 178         __u64 tree_id;
 179
 180         /* keys returned will be >= min and <= max */
 181         __u64 min_objectid;
 182         __u64 max_objectid;
 183
 184         /* keys returned will be >= min and <= max */
 185         __u64 min_offset;
 186         __u64 max_offset;
 187
 188         /* max and min transids to search for */
 189         __u64 min_transid;
 190         __u64 max_transid;
 191
 192         /* keys returned will be >= min and <= max */
 193         __u32 min_type;
 194         __u32 max_type;
 195
 196         /*
 197          * how many items did userland ask for, and how many are we
 198          * returning
 199          */
 200         __u32 nr_items;
 201
 202         /* align to 64 bits */
 203         __u32 unused;
 204
 205         /* some extra for later */
 206         __u64 unused1;
 207         __u64 unused2;
 208         __u64 unused3;
 209         __u64 unused4;
 210 };
 211
 212 struct btrfs_ioctl_search_header {
 213         __u64 transid;
 214         __u64 objectid;
 215         __u64 offset;
 216         __u32 type;
 217         __u32 len;
 218 } __attribute__((may_alias));
 219
 220 #define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
 221 /*
 222  * the buf is an array of search headers where
 223  * each header is followed by the actual item
 224  * the type field is expanded to 32 bits for alignment
 225  */
 226 struct btrfs_ioctl_search_args {
 227         struct btrfs_ioctl_search_key key;
 228         char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
 229 };
 230
 231 #define BTRFS_INO_LOOKUP_PATH_MAX 4080
 232 struct btrfs_ioctl_ino_lookup_args {
 233         __u64 treeid;
 234         __u64 objectid;
 235         char name[BTRFS_INO_LOOKUP_PATH_MAX];
 236 };
 237
 238 /* flags for the defrag range ioctl */
 239 #define BTRFS_DEFRAG_RANGE_COMPRESS 1
 240 #define BTRFS_DEFRAG_RANGE_START_IO 2
 241
 242 struct btrfs_ioctl_defrag_range_args {
 243         /* start of the defrag operation */
 244         __u64 start;
 245
 246         /* number of bytes to defrag, use (u64)-1 to say all */
 247         __u64 len;
 248
 249         /*
 250          * flags for the operation, which can include turning
 251          * on compression for this one defrag
 252          */
 253         __u64 flags;
 254
 255         /*
 256          * any extent bigger than this will be considered
 257          * already defragged.  Use 0 to take the kernel default
 258          * Use 1 to say every single extent must be rewritten
 259          */
 260         __u32 extent_thresh;
 261
 262         /*
 263          * which compression method to use if turning on compression
 264          * for this defrag operation.  If unspecified, zlib will
 265          * be used
 266          */
 267         __u32 compress_type;
 268
 269         /* spare for later */
 270         __u32 unused[4];
 271 };
 272
 273 struct btrfs_ioctl_space_info {
 274         __u64 flags;
 275         __u64 total_bytes;
 276         __u64 used_bytes;
 277 };
 278
 279 struct btrfs_ioctl_space_args {
 280         __u64 space_slots;
 281         __u64 total_spaces;
 282         struct btrfs_ioctl_space_info spaces[0];
 283 };
 284
 285 struct btrfs_data_container {
 286         __u32   bytes_left;     /* out -- bytes not needed to deliver output */
 287         __u32   bytes_missing;  /* out -- additional bytes needed for result */
 288         __u32   elem_cnt;       /* out */
 289         __u32   elem_missed;    /* out */
 290         __u64   val[0];         /* out */
 291 };
 292
 293 struct btrfs_ioctl_ino_path_args {
 294         __u64                           inum;           /* in */
 295         __u64                           size;           /* in */
 296         __u64                           reserved[4];
 297         /* struct btrfs_data_container  *fspath;           out */
 298         __u64                           fspath;         /* out */
 299 };
 300
 301 struct btrfs_ioctl_logical_ino_args {
 302         __u64                           logical;        /* in */
 303         __u64                           size;           /* in */
 304         __u64                           reserved[4];
 305         /* struct btrfs_data_container  *inodes;        out   */
 306         __u64                           inodes;
 307 };
 308
 309 struct btrfs_ioctl_timespec {
 310         __u64 sec;
 311         __u32 nsec;
 312 };
 313
 314 struct btrfs_ioctl_received_subvol_args {
 315         char    uuid[BTRFS_UUID_SIZE];  /* in */
 316         __u64   stransid;               /* in */
 317         __u64   rtransid;               /* out */
 318         struct btrfs_ioctl_timespec stime; /* in */
 319         struct btrfs_ioctl_timespec rtime; /* out */
 320         __u64   flags;                  /* in */
 321         __u64   reserved[16];           /* in */
 322 };
 323
 324 struct btrfs_ioctl_send_args {
 325         __s64 send_fd;                  /* in */
 326         __u64 clone_sources_count;      /* in */
 327         __u64 *clone_sources;           /* in */
 328         __u64 parent_root;              /* in */
 329         __u64 flags;                    /* in */
 330         __u64 reserved[4];              /* in */
 331 };
 332
 333 #define BTRFS_QUOTA_CTL_ENABLE  1
 334 #define BTRFS_QUOTA_CTL_DISABLE 2
 335 #define BTRFS_QUOTA_CTL_RESCAN  3
 336 struct btrfs_ioctl_quota_ctl_args {
 337         __u64 cmd;
 338         __u64 status;
 339 };
 340
 341 struct btrfs_ioctl_qgroup_assign_args {
 342         __u64 assign;
 343         __u64 src;
 344         __u64 dst;
 345 };
 346
 347 struct btrfs_ioctl_qgroup_create_args {
 348         __u64 create;
 349         __u64 qgroupid;
 350 };
 351
 352 /* BTRFS_IOC_SNAP_CREATE is no longer used by the btrfs command */
 353 #define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
 354                                    struct btrfs_ioctl_vol_args)
 355 #define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
 356                                    struct btrfs_ioctl_vol_args)
 357 #define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
 358                                    struct btrfs_ioctl_vol_args)
 359 #define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
 360                                    struct btrfs_ioctl_vol_args)
 361
 362 struct btrfs_ioctl_clone_range_args {
 363         __s64 src_fd;
 364         __u64 src_offset, src_length;
 365         __u64 dest_offset;
 366 };
 367
 368 /* trans start and trans end are dangerous, and only for
 369  * use by applications that know how to avoid the
 370  * resulting deadlocks
 371  */
 372 #define BTRFS_IOC_TRANS_START  _IO(BTRFS_IOCTL_MAGIC, 6)
 373 #define BTRFS_IOC_TRANS_END    _IO(BTRFS_IOCTL_MAGIC, 7)
 374 #define BTRFS_IOC_SYNC         _IO(BTRFS_IOCTL_MAGIC, 8)
 375
 376 #define BTRFS_IOC_CLONE        _IOW(BTRFS_IOCTL_MAGIC, 9, int)
 377 #define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
 378                                    struct btrfs_ioctl_vol_args)
 379 #define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
 380                                    struct btrfs_ioctl_vol_args)
 381 #define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
 382                                    struct btrfs_ioctl_vol_args)
 383 #define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
 384                                    struct btrfs_ioctl_clone_range_args)
 385 #define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
 386                                    struct btrfs_ioctl_vol_args)
 387 #define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
 388                                    struct btrfs_ioctl_vol_args)
 389 #define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
 390                                 struct btrfs_ioctl_defrag_range_args)
 391 #define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
 392                                    struct btrfs_ioctl_search_args)
 393 #define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
 394                                    struct btrfs_ioctl_ino_lookup_args)
 395 #define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, u64)
 396 #define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
 397                                     struct btrfs_ioctl_space_args)
 398 #define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \
 399                                    struct btrfs_ioctl_vol_args_v2)
 400 #define BTRFS_IOC_SUBVOL_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 24, \
 401                                    struct btrfs_ioctl_vol_args_v2)
 402 #define BTRFS_IOC_SUBVOL_GETFLAGS _IOR(BTRFS_IOCTL_MAGIC, 25, __u64)
 403 #define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64)
 404 #define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \
 405                                 struct btrfs_ioctl_scrub_args)
 406 #define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28)
 407 #define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \
 408                                         struct btrfs_ioctl_scrub_args)
 409 #define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \
 410                                         struct btrfs_ioctl_dev_info_args)
 411 #define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \
 412                                  struct btrfs_ioctl_fs_info_args)
 413 #define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \
 414                                    struct btrfs_ioctl_balance_args)
 415 #define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int)
 416 #define BTRFS_IOC_BALANCE_PROGRESS _IOR(BTRFS_IOCTL_MAGIC, 34, \
 417                                         struct btrfs_ioctl_balance_args)
 418 #define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \
 419                                         struct btrfs_ioctl_ino_path_args)
 420 #define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \
 421                                         struct btrfs_ioctl_ino_path_args)
 422 #define BTRFS_IOC_DEVICES_READY _IOR(BTRFS_IOCTL_MAGIC, 39, \
 423                                      struct btrfs_ioctl_vol_args)
 424
 425 #define BTRFS_IOC_SET_RECEIVED_SUBVOL _IOWR(BTRFS_IOCTL_MAGIC, 37, \
 426                                 struct btrfs_ioctl_received_subvol_args)
 427 #define BTRFS_IOC_SEND _IOW(BTRFS_IOCTL_MAGIC, 38, struct btrfs_ioctl_send_args)
 428
 429 #define BTRFS_IOC_QUOTA_CTL _IOWR(BTRFS_IOCTL_MAGIC, 40, \
 430                                         struct btrfs_ioctl_quota_ctl_args)
 431 #define BTRFS_IOC_QGROUP_ASSIGN _IOW(BTRFS_IOCTL_MAGIC, 41, \
 432                                         struct btrfs_ioctl_qgroup_assign_args)
 433 #define BTRFS_IOC_QGROUP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 42, \
 434                                         struct btrfs_ioctl_qgroup_create_args)
 435 #define BTRFS_IOC_QGROUP_LIMIT _IOR(BTRFS_IOCTL_MAGIC, 43, \
 436                                         struct btrfs_ioctl_qgroup_limit_args)
 437 #endif