fs/btrfs/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 <linux/ioctl.h>
  22
  23 #define BTRFS_IOCTL_MAGIC 0x94
  24 #define BTRFS_VOL_NAME_MAX 255
  25
  26 /* this should be 4k */
  27 #define BTRFS_PATH_NAME_MAX 4087
  28 struct btrfs_ioctl_vol_args {
  29         __s64 fd;
  30         char name[BTRFS_PATH_NAME_MAX + 1];
  31 };
  32
  33 #define BTRFS_SUBVOL_CREATE_ASYNC       (1ULL << 0)
  34 #define BTRFS_SUBVOL_RDONLY             (1ULL << 1)
  35
  36 #define BTRFS_SUBVOL_NAME_MAX 4039
  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 /*
  46  * structure to report errors and progress to userspace, either as a
  47  * result of a finished scrub, a canceled scrub or a progress inquiry
  48  */
  49 struct btrfs_scrub_progress {
  50         __u64 data_extents_scrubbed;    /* # of data extents scrubbed */
  51         __u64 tree_extents_scrubbed;    /* # of tree extents scrubbed */
  52         __u64 data_bytes_scrubbed;      /* # of data bytes scrubbed */
  53         __u64 tree_bytes_scrubbed;      /* # of tree bytes scrubbed */
  54         __u64 read_errors;              /* # of read errors encountered (EIO) */
  55         __u64 csum_errors;              /* # of failed csum checks */
  56         __u64 verify_errors;            /* # of occurences, where the metadata
  57                                          * of a tree block did not match the
  58                                          * expected values, like generation or
  59                                          * logical */
  60         __u64 no_csum;                  /* # of 4k data block for which no csum
  61                                          * is present, probably the result of
  62                                          * data written with nodatasum */
  63         __u64 csum_discards;            /* # of csum for which no data was found
  64                                          * in the extent tree. */
  65         __u64 super_errors;             /* # of bad super blocks encountered */
  66         __u64 malloc_errors;            /* # of internal kmalloc errors. These
  67                                          * will likely cause an incomplete
  68                                          * scrub */
  69         __u64 uncorrectable_errors;     /* # of errors where either no intact
  70                                          * copy was found or the writeback
  71                                          * failed */
  72         __u64 corrected_errors;         /* # of errors corrected */
  73         __u64 last_physical;            /* last physical address scrubbed. In
  74                                          * case a scrub was aborted, this can
  75                                          * be used to restart the scrub */
  76         __u64 unverified_errors;        /* # of occurences where a read for a
  77                                          * full (64k) bio failed, but the re-
  78                                          * check succeeded for each 4k piece.
  79                                          * Intermittent error. */
  80 };
  81
  82 #define BTRFS_INO_LOOKUP_PATH_MAX 4080
  83 struct btrfs_ioctl_ino_lookup_args {
  84         __u64 treeid;
  85         __u64 objectid;
  86         char name[BTRFS_INO_LOOKUP_PATH_MAX];
  87 };
  88
  89 struct btrfs_ioctl_search_key {
  90         /* which root are we searching.  0 is the tree of tree roots */
  91         __u64 tree_id;
  92
  93         /* keys returned will be >= min and <= max */
  94         __u64 min_objectid;
  95         __u64 max_objectid;
  96
  97         /* keys returned will be >= min and <= max */
  98         __u64 min_offset;
  99         __u64 max_offset;
 100
 101         /* max and min transids to search for */
 102         __u64 min_transid;
 103         __u64 max_transid;
 104
 105         /* keys returned will be >= min and <= max */
 106         __u32 min_type;
 107         __u32 max_type;
 108
 109         /*
 110          * how many items did userland ask for, and how many are we
 111          * returning
 112          */
 113         __u32 nr_items;
 114
 115         /* align to 64 bits */
 116         __u32 unused;
 117
 118         /* some extra for later */
 119         __u64 unused1;
 120         __u64 unused2;
 121         __u64 unused3;
 122         __u64 unused4;
 123 };
 124
 125 struct btrfs_ioctl_search_header {
 126         __u64 transid;
 127         __u64 objectid;
 128         __u64 offset;
 129         __u32 type;
 130         __u32 len;
 131 };
 132
 133 #define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
 134 /*
 135  * the buf is an array of search headers where
 136  * each header is followed by the actual item
 137  * the type field is expanded to 32 bits for alignment
 138  */
 139 struct btrfs_ioctl_search_args {
 140         struct btrfs_ioctl_search_key key;
 141         char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
 142 };
 143
 144 struct btrfs_ioctl_clone_range_args {
 145   __s64 src_fd;
 146   __u64 src_offset, src_length;
 147   __u64 dest_offset;
 148 };
 149
 150 /* flags for the defrag range ioctl */
 151 #define BTRFS_DEFRAG_RANGE_COMPRESS 1
 152 #define BTRFS_DEFRAG_RANGE_START_IO 2
 153
 154 struct btrfs_ioctl_defrag_range_args {
 155         /* start of the defrag operation */
 156         __u64 start;
 157
 158         /* number of bytes to defrag, use (u64)-1 to say all */
 159         __u64 len;
 160
 161         /*
 162          * flags for the operation, which can include turning
 163          * on compression for this one defrag
 164          */
 165         __u64 flags;
 166
 167         /*
 168          * any extent bigger than this will be considered
 169          * already defragged.  Use 0 to take the kernel default
 170          * Use 1 to say every single extent must be rewritten
 171          */
 172         __u32 extent_thresh;
 173
 174         /*
 175          * which compression method to use if turning on compression
 176          * for this defrag operation.  If unspecified, zlib will
 177          * be used
 178          */
 179         __u32 compress_type;
 180
 181         /* spare for later */
 182         __u32 unused[4];
 183 };
 184
 185 struct btrfs_ioctl_space_info {
 186         __u64 flags;
 187         __u64 total_bytes;
 188         __u64 used_bytes;
 189 };
 190
 191 struct btrfs_ioctl_space_args {
 192         __u64 space_slots;
 193         __u64 total_spaces;
 194         struct btrfs_ioctl_space_info spaces[0];
 195 };
 196
 197 #define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
 198                                    struct btrfs_ioctl_vol_args)
 199 #define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
 200                                    struct btrfs_ioctl_vol_args)
 201 #define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
 202                                    struct btrfs_ioctl_vol_args)
 203 #define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
 204                                    struct btrfs_ioctl_vol_args)
 205 /* trans start and trans end are dangerous, and only for
 206  * use by applications that know how to avoid the
 207  * resulting deadlocks
 208  */
 209 #define BTRFS_IOC_TRANS_START  _IO(BTRFS_IOCTL_MAGIC, 6)
 210 #define BTRFS_IOC_TRANS_END    _IO(BTRFS_IOCTL_MAGIC, 7)
 211 #define BTRFS_IOC_SYNC         _IO(BTRFS_IOCTL_MAGIC, 8)
 212
 213 #define BTRFS_IOC_CLONE        _IOW(BTRFS_IOCTL_MAGIC, 9, int)
 214 #define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
 215                                    struct btrfs_ioctl_vol_args)
 216 #define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
 217                                    struct btrfs_ioctl_vol_args)
 218 #define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
 219                                    struct btrfs_ioctl_vol_args)
 220
 221 #define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
 222                                   struct btrfs_ioctl_clone_range_args)
 223
 224 #define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
 225                                    struct btrfs_ioctl_vol_args)
 226 #define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
 227                                 struct btrfs_ioctl_vol_args)
 228 #define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
 229                                 struct btrfs_ioctl_defrag_range_args)
 230 #define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
 231                                    struct btrfs_ioctl_search_args)
 232 #define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
 233                                    struct btrfs_ioctl_ino_lookup_args)
 234 #define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, u64)
 235 #define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
 236                                     struct btrfs_ioctl_space_args)
 237 #define BTRFS_IOC_START_SYNC _IOR(BTRFS_IOCTL_MAGIC, 24, __u64)
 238 #define BTRFS_IOC_WAIT_SYNC  _IOW(BTRFS_IOCTL_MAGIC, 22, __u64)
 239 #define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \
 240                                    struct btrfs_ioctl_vol_args_v2)
 241 #define BTRFS_IOC_SUBVOL_GETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 25, __u64)
 242 #define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64)
 243 #endif