2 * Copyright (C) 2007 Oracle. All rights reserved.
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.
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.
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.
21 #include <linux/ioctl.h>
23 #define BTRFS_IOCTL_MAGIC 0x94
24 #define BTRFS_VOL_NAME_MAX 255
26 /* this should be 4k */
27 #define BTRFS_PATH_NAME_MAX 4087
28 struct btrfs_ioctl_vol_args {
30 char name[BTRFS_PATH_NAME_MAX + 1];
33 #define BTRFS_SUBVOL_CREATE_ASYNC (1ULL << 0)
34 #define BTRFS_SUBVOL_RDONLY (1ULL << 1)
35 #define BTRFS_FSID_SIZE 16
36 #define BTRFS_UUID_SIZE 16
38 #define BTRFS_QGROUP_INHERIT_SET_LIMITS (1ULL << 0)
40 struct btrfs_qgroup_limit {
48 struct btrfs_qgroup_inherit {
52 __u64 num_excl_copies;
53 struct btrfs_qgroup_limit lim;
57 struct btrfs_ioctl_qgroup_limit_args {
59 struct btrfs_qgroup_limit lim;
62 #define BTRFS_SUBVOL_NAME_MAX 4039
63 struct btrfs_ioctl_vol_args_v2 {
68 char name[BTRFS_SUBVOL_NAME_MAX + 1];
72 * structure to report errors and progress to userspace, either as a
73 * result of a finished scrub, a canceled scrub or a progress inquiry
75 struct btrfs_scrub_progress {
76 __u64 data_extents_scrubbed; /* # of data extents scrubbed */
77 __u64 tree_extents_scrubbed; /* # of tree extents scrubbed */
78 __u64 data_bytes_scrubbed; /* # of data bytes scrubbed */
79 __u64 tree_bytes_scrubbed; /* # of tree bytes scrubbed */
80 __u64 read_errors; /* # of read errors encountered (EIO) */
81 __u64 csum_errors; /* # of failed csum checks */
82 __u64 verify_errors; /* # of occurences, where the metadata
83 * of a tree block did not match the
84 * expected values, like generation or
86 __u64 no_csum; /* # of 4k data block for which no csum
87 * is present, probably the result of
88 * data written with nodatasum */
89 __u64 csum_discards; /* # of csum for which no data was found
90 * in the extent tree. */
91 __u64 super_errors; /* # of bad super blocks encountered */
92 __u64 malloc_errors; /* # of internal kmalloc errors. These
93 * will likely cause an incomplete
95 __u64 uncorrectable_errors; /* # of errors where either no intact
96 * copy was found or the writeback
98 __u64 corrected_errors; /* # of errors corrected */
99 __u64 last_physical; /* last physical address scrubbed. In
100 * case a scrub was aborted, this can
101 * be used to restart the scrub */
102 __u64 unverified_errors; /* # of occurences where a read for a
103 * full (64k) bio failed, but the re-
104 * check succeeded for each 4k piece.
105 * Intermittent error. */
108 #define BTRFS_SCRUB_READONLY 1
109 struct btrfs_ioctl_scrub_args {
110 __u64 devid; /* in */
111 __u64 start; /* in */
113 __u64 flags; /* in */
114 struct btrfs_scrub_progress progress; /* out */
116 __u64 unused[(1024-32-sizeof(struct btrfs_scrub_progress))/8];
119 #define BTRFS_DEVICE_PATH_NAME_MAX 1024
120 struct btrfs_ioctl_dev_info_args {
121 __u64 devid; /* in/out */
122 __u8 uuid[BTRFS_UUID_SIZE]; /* in/out */
123 __u64 bytes_used; /* out */
124 __u64 total_bytes; /* out */
125 __u64 unused[379]; /* pad to 4k */
126 __u8 path[BTRFS_DEVICE_PATH_NAME_MAX]; /* out */
129 struct btrfs_ioctl_fs_info_args {
130 __u64 max_id; /* out */
131 __u64 num_devices; /* out */
132 __u8 fsid[BTRFS_FSID_SIZE]; /* out */
133 __u64 reserved[124]; /* pad to 1k */
136 /* balance control ioctl modes */
137 #define BTRFS_BALANCE_CTL_PAUSE 1
138 #define BTRFS_BALANCE_CTL_CANCEL 2
141 * this is packed, because it should be exactly the same as its disk
142 * byte order counterpart (struct btrfs_disk_balance_args)
144 struct btrfs_balance_args {
158 } __attribute__ ((__packed__));
160 /* report balance progress to userspace */
161 struct btrfs_balance_progress {
162 __u64 expected; /* estimated # of chunks that will be
163 * relocated to fulfill the request */
164 __u64 considered; /* # of chunks we have considered so far */
165 __u64 completed; /* # of chunks relocated so far */
168 #define BTRFS_BALANCE_STATE_RUNNING (1ULL << 0)
169 #define BTRFS_BALANCE_STATE_PAUSE_REQ (1ULL << 1)
170 #define BTRFS_BALANCE_STATE_CANCEL_REQ (1ULL << 2)
172 struct btrfs_ioctl_balance_args {
173 __u64 flags; /* in/out */
174 __u64 state; /* out */
176 struct btrfs_balance_args data; /* in/out */
177 struct btrfs_balance_args meta; /* in/out */
178 struct btrfs_balance_args sys; /* in/out */
180 struct btrfs_balance_progress stat; /* out */
182 __u64 unused[72]; /* pad to 1k */
185 #define BTRFS_INO_LOOKUP_PATH_MAX 4080
186 struct btrfs_ioctl_ino_lookup_args {
189 char name[BTRFS_INO_LOOKUP_PATH_MAX];
192 struct btrfs_ioctl_search_key {
193 /* which root are we searching. 0 is the tree of tree roots */
196 /* keys returned will be >= min and <= max */
200 /* keys returned will be >= min and <= max */
204 /* max and min transids to search for */
208 /* keys returned will be >= min and <= max */
213 * how many items did userland ask for, and how many are we
218 /* align to 64 bits */
221 /* some extra for later */
228 struct btrfs_ioctl_search_header {
236 #define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
238 * the buf is an array of search headers where
239 * each header is followed by the actual item
240 * the type field is expanded to 32 bits for alignment
242 struct btrfs_ioctl_search_args {
243 struct btrfs_ioctl_search_key key;
244 char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
247 struct btrfs_ioctl_clone_range_args {
249 __u64 src_offset, src_length;
253 /* flags for the defrag range ioctl */
254 #define BTRFS_DEFRAG_RANGE_COMPRESS 1
255 #define BTRFS_DEFRAG_RANGE_START_IO 2
257 struct btrfs_ioctl_space_info {
263 struct btrfs_ioctl_space_args {
266 struct btrfs_ioctl_space_info spaces[0];
269 struct btrfs_data_container {
270 __u32 bytes_left; /* out -- bytes not needed to deliver output */
271 __u32 bytes_missing; /* out -- additional bytes needed for result */
272 __u32 elem_cnt; /* out */
273 __u32 elem_missed; /* out */
274 __u64 val[0]; /* out */
277 struct btrfs_ioctl_ino_path_args {
281 /* struct btrfs_data_container *fspath; out */
282 __u64 fspath; /* out */
285 struct btrfs_ioctl_logical_ino_args {
286 __u64 logical; /* in */
289 /* struct btrfs_data_container *inodes; out */
293 enum btrfs_dev_stat_values {
294 /* disk I/O failure stats */
295 BTRFS_DEV_STAT_WRITE_ERRS, /* EIO or EREMOTEIO from lower layers */
296 BTRFS_DEV_STAT_READ_ERRS, /* EIO or EREMOTEIO from lower layers */
297 BTRFS_DEV_STAT_FLUSH_ERRS, /* EIO or EREMOTEIO from lower layers */
299 /* stats for indirect indications for I/O failures */
300 BTRFS_DEV_STAT_CORRUPTION_ERRS, /* checksum error, bytenr error or
301 * contents is illegal: this is an
302 * indication that the block was damaged
303 * during read or write, or written to
304 * wrong location or read from wrong
306 BTRFS_DEV_STAT_GENERATION_ERRS, /* an indication that blocks have not
309 BTRFS_DEV_STAT_VALUES_MAX
312 struct btrfs_ioctl_get_dev_stats {
313 __u64 devid; /* in */
314 __u64 nr_items; /* in/out */
317 __u64 values[BTRFS_DEV_STAT_VALUES_MAX];
319 __u64 unused[128 - 2 - BTRFS_DEV_STAT_VALUES_MAX]; /* pad to 1k */
322 #define BTRFS_QUOTA_CTL_ENABLE 1
323 #define BTRFS_QUOTA_CTL_DISABLE 2
324 #define BTRFS_QUOTA_CTL_RESCAN 3
325 struct btrfs_ioctl_quota_ctl_args {
330 struct btrfs_ioctl_qgroup_assign_args {
336 struct btrfs_ioctl_qgroup_create_args {
341 #define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
342 struct btrfs_ioctl_vol_args)
343 #define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
344 struct btrfs_ioctl_vol_args)
345 #define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
346 struct btrfs_ioctl_vol_args)
347 #define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
348 struct btrfs_ioctl_vol_args)
349 /* trans start and trans end are dangerous, and only for
350 * use by applications that know how to avoid the
351 * resulting deadlocks
353 #define BTRFS_IOC_TRANS_START _IO(BTRFS_IOCTL_MAGIC, 6)
354 #define BTRFS_IOC_TRANS_END _IO(BTRFS_IOCTL_MAGIC, 7)
355 #define BTRFS_IOC_SYNC _IO(BTRFS_IOCTL_MAGIC, 8)
357 #define BTRFS_IOC_CLONE _IOW(BTRFS_IOCTL_MAGIC, 9, int)
358 #define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
359 struct btrfs_ioctl_vol_args)
360 #define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
361 struct btrfs_ioctl_vol_args)
362 #define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
363 struct btrfs_ioctl_vol_args)
365 #define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
366 struct btrfs_ioctl_clone_range_args)
368 #define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
369 struct btrfs_ioctl_vol_args)
370 #define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
371 struct btrfs_ioctl_vol_args)
372 #define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
373 struct btrfs_ioctl_defrag_range_args)
374 #define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
375 struct btrfs_ioctl_search_args)
376 #define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
377 struct btrfs_ioctl_ino_lookup_args)
378 #define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, u64)
379 #define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
380 struct btrfs_ioctl_space_args)
381 #define BTRFS_IOC_START_SYNC _IOR(BTRFS_IOCTL_MAGIC, 24, __u64)
382 #define BTRFS_IOC_WAIT_SYNC _IOW(BTRFS_IOCTL_MAGIC, 22, __u64)
383 #define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \
384 struct btrfs_ioctl_vol_args_v2)
385 #define BTRFS_IOC_SUBVOL_GETFLAGS _IOR(BTRFS_IOCTL_MAGIC, 25, __u64)
386 #define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64)
387 #define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \
388 struct btrfs_ioctl_scrub_args)
389 #define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28)
390 #define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \
391 struct btrfs_ioctl_scrub_args)
392 #define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \
393 struct btrfs_ioctl_dev_info_args)
394 #define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \
395 struct btrfs_ioctl_fs_info_args)
396 #define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \
397 struct btrfs_ioctl_balance_args)
398 #define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int)
399 #define BTRFS_IOC_BALANCE_PROGRESS _IOR(BTRFS_IOCTL_MAGIC, 34, \
400 struct btrfs_ioctl_balance_args)
401 #define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \
402 struct btrfs_ioctl_ino_path_args)
403 #define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \
404 struct btrfs_ioctl_ino_path_args)
405 #define BTRFS_IOC_GET_DEV_STATS _IOWR(BTRFS_IOCTL_MAGIC, 52, \
406 struct btrfs_ioctl_get_dev_stats)
407 #define BTRFS_IOC_GET_AND_RESET_DEV_STATS _IOWR(BTRFS_IOCTL_MAGIC, 53, \
408 struct btrfs_ioctl_get_dev_stats)
410 #define BTRFS_IOC_QUOTA_CTL _IOWR(BTRFS_IOCTL_MAGIC, 40, \
411 struct btrfs_ioctl_quota_ctl_args)
412 #define BTRFS_IOC_QGROUP_ASSIGN _IOW(BTRFS_IOCTL_MAGIC, 41, \
413 struct btrfs_ioctl_qgroup_assign_args)
414 #define BTRFS_IOC_QGROUP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 42, \
415 struct btrfs_ioctl_qgroup_create_args)
416 #define BTRFS_IOC_QGROUP_LIMIT _IOR(BTRFS_IOCTL_MAGIC, 43, \
417 struct btrfs_ioctl_qgroup_limit_args)