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 <asm/types.h>
22 #include <linux/ioctl.h>
25 #define BTRFS_IOCTL_MAGIC 0x94
26 #define BTRFS_VOL_NAME_MAX 255
28 /* this should be 4k */
29 #define BTRFS_PATH_NAME_MAX 4087
30 struct btrfs_ioctl_vol_args {
32 char name[BTRFS_PATH_NAME_MAX + 1];
35 #define BTRFS_SUBVOL_CREATE_ASYNC (1ULL << 0)
36 #define BTRFS_SUBVOL_RDONLY (1ULL << 1)
37 #define BTRFS_SUBVOL_QGROUP_INHERIT (1ULL << 2)
39 #define BTRFS_QGROUP_INHERIT_SET_LIMITS (1ULL << 0)
41 struct btrfs_qgroup_limit {
49 struct btrfs_qgroup_inherit {
53 __u64 num_excl_copies;
54 struct btrfs_qgroup_limit lim;
58 struct btrfs_ioctl_qgroup_limit_args {
60 struct btrfs_qgroup_limit lim;
63 #define BTRFS_SUBVOL_NAME_MAX 4039
65 struct btrfs_ioctl_vol_args_v2 {
72 struct btrfs_qgroup_inherit *qgroup_inherit;
76 char name[BTRFS_SUBVOL_NAME_MAX + 1];
79 #define BTRFS_FSID_SIZE 16
80 #define BTRFS_UUID_SIZE 16
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;
94 __u64 uncorrectable_errors;
95 __u64 corrected_errors;
97 __u64 unverified_errors;
100 #define BTRFS_SCRUB_READONLY 1
101 struct btrfs_ioctl_scrub_args {
102 __u64 devid; /* in */
103 __u64 start; /* in */
105 __u64 flags; /* in */
106 struct btrfs_scrub_progress progress; /* out */
108 __u64 unused[(1024-32-sizeof(struct btrfs_scrub_progress))/8];
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 */
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 */
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
134 * this is packed, because it should be exactly the same as its disk
135 * byte order counterpart (struct btrfs_disk_balance_args)
137 struct btrfs_balance_args {
151 } __attribute__ ((__packed__));
153 struct btrfs_balance_progress {
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)
163 struct btrfs_ioctl_balance_args {
164 __u64 flags; /* in/out */
165 __u64 state; /* out */
167 struct btrfs_balance_args data; /* in/out */
168 struct btrfs_balance_args meta; /* in/out */
169 struct btrfs_balance_args sys; /* in/out */
171 struct btrfs_balance_progress stat; /* out */
173 __u64 unused[72]; /* pad to 1k */
176 struct btrfs_ioctl_search_key {
177 /* which root are we searching. 0 is the tree of tree roots */
180 /* keys returned will be >= min and <= max */
184 /* keys returned will be >= min and <= max */
188 /* max and min transids to search for */
192 /* keys returned will be >= min and <= max */
197 * how many items did userland ask for, and how many are we
202 /* align to 64 bits */
205 /* some extra for later */
212 struct btrfs_ioctl_search_header {
218 } __attribute__((may_alias));
220 #define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
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
226 struct btrfs_ioctl_search_args {
227 struct btrfs_ioctl_search_key key;
228 char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
231 #define BTRFS_INO_LOOKUP_PATH_MAX 4080
232 struct btrfs_ioctl_ino_lookup_args {
235 char name[BTRFS_INO_LOOKUP_PATH_MAX];
238 /* flags for the defrag range ioctl */
239 #define BTRFS_DEFRAG_RANGE_COMPRESS 1
240 #define BTRFS_DEFRAG_RANGE_START_IO 2
242 struct btrfs_ioctl_defrag_range_args {
243 /* start of the defrag operation */
246 /* number of bytes to defrag, use (u64)-1 to say all */
250 * flags for the operation, which can include turning
251 * on compression for this one defrag
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
263 * which compression method to use if turning on compression
264 * for this defrag operation. If unspecified, zlib will
269 /* spare for later */
273 struct btrfs_ioctl_space_info {
279 struct btrfs_ioctl_space_args {
282 struct btrfs_ioctl_space_info spaces[0];
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 */
293 struct btrfs_ioctl_ino_path_args {
297 /* struct btrfs_data_container *fspath; out */
298 __u64 fspath; /* out */
301 struct btrfs_ioctl_logical_ino_args {
302 __u64 logical; /* in */
305 /* struct btrfs_data_container *inodes; out */
309 struct btrfs_ioctl_timespec {
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 */
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 */
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 {
341 struct btrfs_ioctl_qgroup_assign_args {
347 struct btrfs_ioctl_qgroup_create_args {
352 enum btrfs_dev_stat_values {
353 /* disk I/O failure stats */
354 BTRFS_DEV_STAT_WRITE_ERRS, /* EIO or EREMOTEIO from lower layers */
355 BTRFS_DEV_STAT_READ_ERRS, /* EIO or EREMOTEIO from lower layers */
356 BTRFS_DEV_STAT_FLUSH_ERRS, /* EIO or EREMOTEIO from lower layers */
358 /* stats for indirect indications for I/O failures */
359 BTRFS_DEV_STAT_CORRUPTION_ERRS, /* checksum error, bytenr error or
360 * contents is illegal: this is an
361 * indication that the block was damaged
362 * during read or write, or written to
363 * wrong location or read from wrong
365 BTRFS_DEV_STAT_GENERATION_ERRS, /* an indication that blocks have not
368 BTRFS_DEV_STAT_VALUES_MAX
371 /* Reset statistics after reading; needs SYS_ADMIN capability */
372 #define BTRFS_DEV_STATS_RESET (1ULL << 0)
374 struct btrfs_ioctl_get_dev_stats {
375 __u64 devid; /* in */
376 __u64 nr_items; /* in/out */
377 __u64 flags; /* in/out */
380 __u64 values[BTRFS_DEV_STAT_VALUES_MAX];
382 __u64 unused[128 - 2 - BTRFS_DEV_STAT_VALUES_MAX]; /* pad to 1k */
385 /* BTRFS_IOC_SNAP_CREATE is no longer used by the btrfs command */
386 #define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
387 struct btrfs_ioctl_vol_args)
388 #define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
389 struct btrfs_ioctl_vol_args)
390 #define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
391 struct btrfs_ioctl_vol_args)
392 #define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
393 struct btrfs_ioctl_vol_args)
395 struct btrfs_ioctl_clone_range_args {
397 __u64 src_offset, src_length;
401 /* trans start and trans end are dangerous, and only for
402 * use by applications that know how to avoid the
403 * resulting deadlocks
405 #define BTRFS_IOC_TRANS_START _IO(BTRFS_IOCTL_MAGIC, 6)
406 #define BTRFS_IOC_TRANS_END _IO(BTRFS_IOCTL_MAGIC, 7)
407 #define BTRFS_IOC_SYNC _IO(BTRFS_IOCTL_MAGIC, 8)
409 #define BTRFS_IOC_CLONE _IOW(BTRFS_IOCTL_MAGIC, 9, int)
410 #define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
411 struct btrfs_ioctl_vol_args)
412 #define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
413 struct btrfs_ioctl_vol_args)
414 #define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
415 struct btrfs_ioctl_vol_args)
416 #define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
417 struct btrfs_ioctl_clone_range_args)
418 #define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
419 struct btrfs_ioctl_vol_args)
420 #define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
421 struct btrfs_ioctl_vol_args)
422 #define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
423 struct btrfs_ioctl_defrag_range_args)
424 #define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
425 struct btrfs_ioctl_search_args)
426 #define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
427 struct btrfs_ioctl_ino_lookup_args)
428 #define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, u64)
429 #define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
430 struct btrfs_ioctl_space_args)
431 #define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \
432 struct btrfs_ioctl_vol_args_v2)
433 #define BTRFS_IOC_SUBVOL_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 24, \
434 struct btrfs_ioctl_vol_args_v2)
435 #define BTRFS_IOC_SUBVOL_GETFLAGS _IOR(BTRFS_IOCTL_MAGIC, 25, __u64)
436 #define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64)
437 #define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \
438 struct btrfs_ioctl_scrub_args)
439 #define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28)
440 #define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \
441 struct btrfs_ioctl_scrub_args)
442 #define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \
443 struct btrfs_ioctl_dev_info_args)
444 #define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \
445 struct btrfs_ioctl_fs_info_args)
446 #define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \
447 struct btrfs_ioctl_balance_args)
448 #define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int)
449 #define BTRFS_IOC_BALANCE_PROGRESS _IOR(BTRFS_IOCTL_MAGIC, 34, \
450 struct btrfs_ioctl_balance_args)
451 #define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \
452 struct btrfs_ioctl_ino_path_args)
453 #define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \
454 struct btrfs_ioctl_ino_path_args)
455 #define BTRFS_IOC_DEVICES_READY _IOR(BTRFS_IOCTL_MAGIC, 39, \
456 struct btrfs_ioctl_vol_args)
457 #define BTRFS_IOC_SET_RECEIVED_SUBVOL _IOWR(BTRFS_IOCTL_MAGIC, 37, \
458 struct btrfs_ioctl_received_subvol_args)
459 #define BTRFS_IOC_SEND _IOW(BTRFS_IOCTL_MAGIC, 38, struct btrfs_ioctl_send_args)
461 #define BTRFS_IOC_QUOTA_CTL _IOWR(BTRFS_IOCTL_MAGIC, 40, \
462 struct btrfs_ioctl_quota_ctl_args)
463 #define BTRFS_IOC_QGROUP_ASSIGN _IOW(BTRFS_IOCTL_MAGIC, 41, \
464 struct btrfs_ioctl_qgroup_assign_args)
465 #define BTRFS_IOC_QGROUP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 42, \
466 struct btrfs_ioctl_qgroup_create_args)
467 #define BTRFS_IOC_QGROUP_LIMIT _IOR(BTRFS_IOCTL_MAGIC, 43, \
468 struct btrfs_ioctl_qgroup_limit_args)
469 #define BTRFS_IOC_GET_DEV_STATS _IOWR(BTRFS_IOCTL_MAGIC, 52, \
470 struct btrfs_ioctl_get_dev_stats)