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
  24 #define BTRFS_IOCTL_MAGIC 0x94
  25 #define BTRFS_VOL_NAME_MAX 255
  26
  27 /* this should be 4k */
  28 #define BTRFS_PATH_NAME_MAX 4087
  29 struct btrfs_ioctl_vol_args {
  30         __s64 fd;
  31         char name[BTRFS_PATH_NAME_MAX + 1];
  32 };
  33
  34 #define BTRFS_SUBVOL_RDONLY             (1ULL << 1)
  35 #define BTRFS_SUBVOL_NAME_MAX 4039
  36
  37 struct btrfs_ioctl_vol_args_v2 {
  38         __s64 fd;
  39         __u64 transid;
  40         __u64 flags;
  41         __u64 unused[4];
  42         char name[BTRFS_SUBVOL_NAME_MAX + 1];
  43 };
  44
  45 #define BTRFS_FSID_SIZE 16
  46 #define BTRFS_UUID_SIZE 16
  47
  48 struct btrfs_scrub_progress {
  49         __u64 data_extents_scrubbed;
  50         __u64 tree_extents_scrubbed;
  51         __u64 data_bytes_scrubbed;
  52         __u64 tree_bytes_scrubbed;
  53         __u64 read_errors;
  54         __u64 csum_errors;
  55         __u64 verify_errors;
  56         __u64 no_csum;
  57         __u64 csum_discards;
  58         __u64 super_errors;
  59         __u64 malloc_errors;
  60         __u64 uncorrectable_errors;
  61         __u64 corrected_errors;
  62         __u64 last_physical;
  63         __u64 unverified_errors;
  64 };
  65
  66 #define BTRFS_SCRUB_READONLY    1
  67 struct btrfs_ioctl_scrub_args {
  68         __u64 devid;                            /* in */
  69         __u64 start;                            /* in */
  70         __u64 end;                              /* in */
  71         __u64 flags;                            /* in */
  72         struct btrfs_scrub_progress progress;   /* out */
  73         /* pad to 1k */
  74         __u64 unused[(1024-32-sizeof(struct btrfs_scrub_progress))/8];
  75 };
  76
  77 #define BTRFS_DEVICE_PATH_NAME_MAX 1024
  78 struct btrfs_ioctl_dev_info_args {
  79         __u64 devid;                            /* in/out */
  80         __u8 uuid[BTRFS_UUID_SIZE];             /* in/out */
  81         __u64 bytes_used;                       /* out */
  82         __u64 total_bytes;                      /* out */
  83         __u64 unused[379];                      /* pad to 4k */
  84         __u8 path[BTRFS_DEVICE_PATH_NAME_MAX];  /* out */
  85 };
  86
  87 struct btrfs_ioctl_fs_info_args {
  88         __u64 max_id;                           /* out */
  89         __u64 num_devices;                      /* out */
  90         __u8 fsid[BTRFS_FSID_SIZE];             /* out */
  91         __u64 reserved[124];                    /* pad to 1k */
  92 };
  93
  94 /* balance control ioctl modes */
  95 #define BTRFS_BALANCE_CTL_PAUSE         1
  96 #define BTRFS_BALANCE_CTL_CANCEL        2
  97 #define BTRFS_BALANCE_CTL_RESUME        3
  98
  99 /*
 100  * this is packed, because it should be exactly the same as its disk
 101  * byte order counterpart (struct btrfs_disk_balance_args)
 102  */
 103 struct btrfs_balance_args {
 104         __u64 profiles;
 105         __u64 usage;
 106         __u64 devid;
 107         __u64 pstart;
 108         __u64 pend;
 109         __u64 vstart;
 110         __u64 vend;
 111
 112         __u64 target;
 113
 114         __u64 flags;
 115
 116         __u64 unused[8];
 117 } __attribute__ ((__packed__));
 118
 119 struct btrfs_balance_progress {
 120         __u64 expected;
 121         __u64 considered;
 122         __u64 completed;
 123 };
 124
 125 #define BTRFS_BALANCE_STATE_RUNNING     (1ULL << 0)
 126 #define BTRFS_BALANCE_STATE_PAUSE_REQ   (1ULL << 1)
 127 #define BTRFS_BALANCE_STATE_CANCEL_REQ  (1ULL << 2)
 128
 129 struct btrfs_ioctl_balance_args {
 130         __u64 flags;                            /* in/out */
 131         __u64 state;                            /* out */
 132
 133         struct btrfs_balance_args data;         /* in/out */
 134         struct btrfs_balance_args meta;         /* in/out */
 135         struct btrfs_balance_args sys;          /* in/out */
 136
 137         struct btrfs_balance_progress stat;     /* out */
 138
 139         __u64 unused[72];                       /* pad to 1k */
 140 };
 141
 142 struct btrfs_ioctl_search_key {
 143         /* which root are we searching.  0 is the tree of tree roots */
 144         __u64 tree_id;
 145
 146         /* keys returned will be >= min and <= max */
 147         __u64 min_objectid;
 148         __u64 max_objectid;
 149
 150         /* keys returned will be >= min and <= max */
 151         __u64 min_offset;
 152         __u64 max_offset;
 153
 154         /* max and min transids to search for */
 155         __u64 min_transid;
 156         __u64 max_transid;
 157
 158         /* keys returned will be >= min and <= max */
 159         __u32 min_type;
 160         __u32 max_type;
 161
 162         /*
 163          * how many items did userland ask for, and how many are we
 164          * returning
 165          */
 166         __u32 nr_items;
 167
 168         /* align to 64 bits */
 169         __u32 unused;
 170
 171         /* some extra for later */
 172         __u64 unused1;
 173         __u64 unused2;
 174         __u64 unused3;
 175         __u64 unused4;
 176 };
 177
 178 struct btrfs_ioctl_search_header {
 179         __u64 transid;
 180         __u64 objectid;
 181         __u64 offset;
 182         __u32 type;
 183         __u32 len;
 184 } __attribute__((may_alias));
 185
 186 #define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
 187 /*
 188  * the buf is an array of search headers where
 189  * each header is followed by the actual item
 190  * the type field is expanded to 32 bits for alignment
 191  */
 192 struct btrfs_ioctl_search_args {
 193         struct btrfs_ioctl_search_key key;
 194         char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
 195 };
 196
 197 #define BTRFS_INO_LOOKUP_PATH_MAX 4080
 198 struct btrfs_ioctl_ino_lookup_args {
 199         __u64 treeid;
 200         __u64 objectid;
 201         char name[BTRFS_INO_LOOKUP_PATH_MAX];
 202 };
 203
 204 /* flags for the defrag range ioctl */
 205 #define BTRFS_DEFRAG_RANGE_COMPRESS 1
 206 #define BTRFS_DEFRAG_RANGE_START_IO 2
 207
 208 struct btrfs_ioctl_defrag_range_args {
 209         /* start of the defrag operation */
 210         __u64 start;
 211
 212         /* number of bytes to defrag, use (u64)-1 to say all */
 213         __u64 len;
 214
 215         /*
 216          * flags for the operation, which can include turning
 217          * on compression for this one defrag
 218          */
 219         __u64 flags;
 220
 221         /*
 222          * any extent bigger than this will be considered
 223          * already defragged.  Use 0 to take the kernel default
 224          * Use 1 to say every single extent must be rewritten
 225          */
 226         __u32 extent_thresh;
 227
 228         /*
 229          * which compression method to use if turning on compression
 230          * for this defrag operation.  If unspecified, zlib will
 231          * be used
 232          */
 233         __u32 compress_type;
 234
 235         /* spare for later */
 236         __u32 unused[4];
 237 };
 238
 239 struct btrfs_ioctl_space_info {
 240         __u64 flags;
 241         __u64 total_bytes;
 242         __u64 used_bytes;
 243 };
 244
 245 struct btrfs_ioctl_space_args {
 246         __u64 space_slots;
 247         __u64 total_spaces;
 248         struct btrfs_ioctl_space_info spaces[0];
 249 };
 250
 251 struct btrfs_data_container {
 252         __u32   bytes_left;     /* out -- bytes not needed to deliver output */
 253         __u32   bytes_missing;  /* out -- additional bytes needed for result */
 254         __u32   elem_cnt;       /* out */
 255         __u32   elem_missed;    /* out */
 256         __u64   val[0];         /* out */
 257 };
 258
 259 struct btrfs_ioctl_ino_path_args {
 260         __u64                           inum;           /* in */
 261         __u64                           size;           /* in */
 262         __u64                           reserved[4];
 263         /* struct btrfs_data_container  *fspath;           out */
 264         __u64                           fspath;         /* out */
 265 };
 266
 267 struct btrfs_ioctl_logical_ino_args {
 268         __u64                           logical;        /* in */
 269         __u64                           size;           /* in */
 270         __u64                           reserved[4];
 271         /* struct btrfs_data_container  *inodes;        out   */
 272         __u64                           inodes;
 273 };
 274
 275 /* BTRFS_IOC_SNAP_CREATE is no longer used by the btrfs command */
 276 #define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
 277                                    struct btrfs_ioctl_vol_args)
 278 #define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
 279                                    struct btrfs_ioctl_vol_args)
 280 #define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
 281                                    struct btrfs_ioctl_vol_args)
 282 #define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
 283                                    struct btrfs_ioctl_vol_args)
 284 /* trans start and trans end are dangerous, and only for
 285  * use by applications that know how to avoid the
 286  * resulting deadlocks
 287  */
 288 #define BTRFS_IOC_TRANS_START  _IO(BTRFS_IOCTL_MAGIC, 6)
 289 #define BTRFS_IOC_TRANS_END    _IO(BTRFS_IOCTL_MAGIC, 7)
 290 #define BTRFS_IOC_SYNC         _IO(BTRFS_IOCTL_MAGIC, 8)
 291
 292 #define BTRFS_IOC_CLONE        _IOW(BTRFS_IOCTL_MAGIC, 9, int)
 293 #define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
 294                                    struct btrfs_ioctl_vol_args)
 295 #define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
 296                                    struct btrfs_ioctl_vol_args)
 297 #define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
 298                                    struct btrfs_ioctl_vol_args)
 299 /* 13 is for CLONE_RANGE */
 300 #define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
 301                                    struct btrfs_ioctl_vol_args)
 302 #define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
 303                                    struct btrfs_ioctl_vol_args)
 304 #define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
 305                                 struct btrfs_ioctl_defrag_range_args)
 306 #define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
 307                                    struct btrfs_ioctl_search_args)
 308 #define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
 309                                    struct btrfs_ioctl_ino_lookup_args)
 310 #define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, u64)
 311 #define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
 312                                     struct btrfs_ioctl_space_args)
 313 #define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \
 314                                    struct btrfs_ioctl_vol_args_v2)
 315 #define BTRFS_IOC_SUBVOL_GETFLAGS _IOR(BTRFS_IOCTL_MAGIC, 25, __u64)
 316 #define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64)
 317 #define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \
 318                                 struct btrfs_ioctl_scrub_args)
 319 #define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28)
 320 #define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \
 321                                         struct btrfs_ioctl_scrub_args)
 322 #define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \
 323                                         struct btrfs_ioctl_dev_info_args)
 324 #define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \
 325                                  struct btrfs_ioctl_fs_info_args)
 326 #define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \
 327                                    struct btrfs_ioctl_balance_args)
 328 #define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int)
 329 #define BTRFS_IOC_BALANCE_PROGRESS _IOR(BTRFS_IOCTL_MAGIC, 34, \
 330                                         struct btrfs_ioctl_balance_args)
 331 #define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \
 332                                         struct btrfs_ioctl_ino_path_args)
 333 #define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \
 334                                         struct btrfs_ioctl_ino_path_args)
 335
 336 #endif