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_DEVICE_PATH_NAME_MAX 1024
37 #define BTRFS_SUBVOL_CREATE_ASYNC (1ULL << 0)
38 #define BTRFS_SUBVOL_RDONLY (1ULL << 1)
39 #define BTRFS_SUBVOL_QGROUP_INHERIT (1ULL << 2)
41 #define BTRFS_QGROUP_INHERIT_SET_LIMITS (1ULL << 0)
43 struct btrfs_qgroup_limit {
51 struct btrfs_qgroup_inherit {
55 __u64 num_excl_copies;
56 struct btrfs_qgroup_limit lim;
60 struct btrfs_ioctl_qgroup_limit_args {
62 struct btrfs_qgroup_limit lim;
65 #define BTRFS_SUBVOL_NAME_MAX 4039
67 struct btrfs_ioctl_vol_args_v2 {
74 struct btrfs_qgroup_inherit *qgroup_inherit;
78 char name[BTRFS_SUBVOL_NAME_MAX + 1];
81 #define BTRFS_FSID_SIZE 16
82 #define BTRFS_UUID_SIZE 16
84 struct btrfs_scrub_progress {
85 __u64 data_extents_scrubbed;
86 __u64 tree_extents_scrubbed;
87 __u64 data_bytes_scrubbed;
88 __u64 tree_bytes_scrubbed;
96 __u64 uncorrectable_errors;
97 __u64 corrected_errors;
99 __u64 unverified_errors;
102 #define BTRFS_SCRUB_READONLY 1
103 struct btrfs_ioctl_scrub_args {
104 __u64 devid; /* in */
105 __u64 start; /* in */
107 __u64 flags; /* in */
108 struct btrfs_scrub_progress progress; /* out */
110 __u64 unused[(1024-32-sizeof(struct btrfs_scrub_progress))/8];
113 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_ALWAYS 0
114 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_AVOID 1
115 struct btrfs_ioctl_dev_replace_start_params {
116 __u64 srcdevid; /* in, if 0, use srcdev_name instead */
117 __u64 cont_reading_from_srcdev_mode; /* in, see #define
119 __u8 srcdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1]; /* in */
120 __u8 tgtdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1]; /* in */
123 #define BTRFS_IOCTL_DEV_REPLACE_STATE_NEVER_STARTED 0
124 #define BTRFS_IOCTL_DEV_REPLACE_STATE_STARTED 1
125 #define BTRFS_IOCTL_DEV_REPLACE_STATE_FINISHED 2
126 #define BTRFS_IOCTL_DEV_REPLACE_STATE_CANCELED 3
127 #define BTRFS_IOCTL_DEV_REPLACE_STATE_SUSPENDED 4
128 struct btrfs_ioctl_dev_replace_status_params {
129 __u64 replace_state; /* out, see #define above */
130 __u64 progress_1000; /* out, 0 <= x <= 1000 */
131 __u64 time_started; /* out, seconds since 1-Jan-1970 */
132 __u64 time_stopped; /* out, seconds since 1-Jan-1970 */
133 __u64 num_write_errors; /* out */
134 __u64 num_uncorrectable_read_errors; /* out */
137 #define BTRFS_IOCTL_DEV_REPLACE_CMD_START 0
138 #define BTRFS_IOCTL_DEV_REPLACE_CMD_STATUS 1
139 #define BTRFS_IOCTL_DEV_REPLACE_CMD_CANCEL 2
140 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NO_ERROR 0
141 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NOT_STARTED 1
142 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_ALREADY_STARTED 2
143 struct btrfs_ioctl_dev_replace_args {
145 __u64 result; /* out */
148 struct btrfs_ioctl_dev_replace_start_params start;
149 struct btrfs_ioctl_dev_replace_status_params status;
155 struct btrfs_ioctl_dev_info_args {
156 __u64 devid; /* in/out */
157 __u8 uuid[BTRFS_UUID_SIZE]; /* in/out */
158 __u64 bytes_used; /* out */
159 __u64 total_bytes; /* out */
160 __u64 unused[379]; /* pad to 4k */
161 __u8 path[BTRFS_DEVICE_PATH_NAME_MAX]; /* out */
164 struct btrfs_ioctl_fs_info_args {
165 __u64 max_id; /* out */
166 __u64 num_devices; /* out */
167 __u8 fsid[BTRFS_FSID_SIZE]; /* out */
168 __u64 reserved[124]; /* pad to 1k */
171 /* balance control ioctl modes */
172 #define BTRFS_BALANCE_CTL_PAUSE 1
173 #define BTRFS_BALANCE_CTL_CANCEL 2
174 #define BTRFS_BALANCE_CTL_RESUME 3
177 * this is packed, because it should be exactly the same as its disk
178 * byte order counterpart (struct btrfs_disk_balance_args)
180 struct btrfs_balance_args {
194 } __attribute__ ((__packed__));
196 struct btrfs_balance_progress {
202 #define BTRFS_BALANCE_STATE_RUNNING (1ULL << 0)
203 #define BTRFS_BALANCE_STATE_PAUSE_REQ (1ULL << 1)
204 #define BTRFS_BALANCE_STATE_CANCEL_REQ (1ULL << 2)
206 struct btrfs_ioctl_balance_args {
207 __u64 flags; /* in/out */
208 __u64 state; /* out */
210 struct btrfs_balance_args data; /* in/out */
211 struct btrfs_balance_args meta; /* in/out */
212 struct btrfs_balance_args sys; /* in/out */
214 struct btrfs_balance_progress stat; /* out */
216 __u64 unused[72]; /* pad to 1k */
219 struct btrfs_ioctl_search_key {
220 /* which root are we searching. 0 is the tree of tree roots */
223 /* keys returned will be >= min and <= max */
227 /* keys returned will be >= min and <= max */
231 /* max and min transids to search for */
235 /* keys returned will be >= min and <= max */
240 * how many items did userland ask for, and how many are we
245 /* align to 64 bits */
248 /* some extra for later */
255 struct btrfs_ioctl_search_header {
261 } __attribute__((may_alias));
263 #define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
265 * the buf is an array of search headers where
266 * each header is followed by the actual item
267 * the type field is expanded to 32 bits for alignment
269 struct btrfs_ioctl_search_args {
270 struct btrfs_ioctl_search_key key;
271 char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
274 #define BTRFS_INO_LOOKUP_PATH_MAX 4080
275 struct btrfs_ioctl_ino_lookup_args {
278 char name[BTRFS_INO_LOOKUP_PATH_MAX];
281 /* flags for the defrag range ioctl */
282 #define BTRFS_DEFRAG_RANGE_COMPRESS 1
283 #define BTRFS_DEFRAG_RANGE_START_IO 2
285 struct btrfs_ioctl_defrag_range_args {
286 /* start of the defrag operation */
289 /* number of bytes to defrag, use (u64)-1 to say all */
293 * flags for the operation, which can include turning
294 * on compression for this one defrag
299 * any extent bigger than this will be considered
300 * already defragged. Use 0 to take the kernel default
301 * Use 1 to say every single extent must be rewritten
306 * which compression method to use if turning on compression
307 * for this defrag operation. If unspecified, zlib will
312 /* spare for later */
316 struct btrfs_ioctl_space_info {
322 struct btrfs_ioctl_space_args {
325 struct btrfs_ioctl_space_info spaces[0];
328 struct btrfs_data_container {
329 __u32 bytes_left; /* out -- bytes not needed to deliver output */
330 __u32 bytes_missing; /* out -- additional bytes needed for result */
331 __u32 elem_cnt; /* out */
332 __u32 elem_missed; /* out */
333 __u64 val[0]; /* out */
336 struct btrfs_ioctl_ino_path_args {
340 /* struct btrfs_data_container *fspath; out */
341 __u64 fspath; /* out */
344 struct btrfs_ioctl_logical_ino_args {
345 __u64 logical; /* in */
348 /* struct btrfs_data_container *inodes; out */
352 struct btrfs_ioctl_timespec {
357 struct btrfs_ioctl_received_subvol_args {
358 char uuid[BTRFS_UUID_SIZE]; /* in */
359 __u64 stransid; /* in */
360 __u64 rtransid; /* out */
361 struct btrfs_ioctl_timespec stime; /* in */
362 struct btrfs_ioctl_timespec rtime; /* out */
363 __u64 flags; /* in */
364 __u64 reserved[16]; /* in */
368 * Caller doesn't want file data in the send stream, even if the
369 * search of clone sources doesn't find an extent. UPDATE_EXTENT
370 * commands will be sent instead of WRITE commands.
372 #define BTRFS_SEND_FLAG_NO_FILE_DATA 0x1
374 struct btrfs_ioctl_send_args {
375 __s64 send_fd; /* in */
376 __u64 clone_sources_count; /* in */
377 __u64 *clone_sources; /* in */
378 __u64 parent_root; /* in */
379 __u64 flags; /* in */
380 __u64 reserved[4]; /* in */
383 #define BTRFS_QUOTA_CTL_ENABLE 1
384 #define BTRFS_QUOTA_CTL_DISABLE 2
385 #define BTRFS_QUOTA_CTL_RESCAN 3
386 struct btrfs_ioctl_quota_ctl_args {
391 struct btrfs_ioctl_qgroup_assign_args {
397 struct btrfs_ioctl_qgroup_create_args {
402 enum btrfs_dev_stat_values {
403 /* disk I/O failure stats */
404 BTRFS_DEV_STAT_WRITE_ERRS, /* EIO or EREMOTEIO from lower layers */
405 BTRFS_DEV_STAT_READ_ERRS, /* EIO or EREMOTEIO from lower layers */
406 BTRFS_DEV_STAT_FLUSH_ERRS, /* EIO or EREMOTEIO from lower layers */
408 /* stats for indirect indications for I/O failures */
409 BTRFS_DEV_STAT_CORRUPTION_ERRS, /* checksum error, bytenr error or
410 * contents is illegal: this is an
411 * indication that the block was damaged
412 * during read or write, or written to
413 * wrong location or read from wrong
415 BTRFS_DEV_STAT_GENERATION_ERRS, /* an indication that blocks have not
418 BTRFS_DEV_STAT_VALUES_MAX
421 /* Reset statistics after reading; needs SYS_ADMIN capability */
422 #define BTRFS_DEV_STATS_RESET (1ULL << 0)
424 struct btrfs_ioctl_get_dev_stats {
425 __u64 devid; /* in */
426 __u64 nr_items; /* in/out */
427 __u64 flags; /* in/out */
430 __u64 values[BTRFS_DEV_STAT_VALUES_MAX];
432 __u64 unused[128 - 2 - BTRFS_DEV_STAT_VALUES_MAX]; /* pad to 1k */
435 /* BTRFS_IOC_SNAP_CREATE is no longer used by the btrfs command */
436 #define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
437 struct btrfs_ioctl_vol_args)
438 #define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
439 struct btrfs_ioctl_vol_args)
440 #define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
441 struct btrfs_ioctl_vol_args)
442 #define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
443 struct btrfs_ioctl_vol_args)
445 struct btrfs_ioctl_clone_range_args {
447 __u64 src_offset, src_length;
451 /* trans start and trans end are dangerous, and only for
452 * use by applications that know how to avoid the
453 * resulting deadlocks
455 #define BTRFS_IOC_TRANS_START _IO(BTRFS_IOCTL_MAGIC, 6)
456 #define BTRFS_IOC_TRANS_END _IO(BTRFS_IOCTL_MAGIC, 7)
457 #define BTRFS_IOC_SYNC _IO(BTRFS_IOCTL_MAGIC, 8)
459 #define BTRFS_IOC_CLONE _IOW(BTRFS_IOCTL_MAGIC, 9, int)
460 #define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
461 struct btrfs_ioctl_vol_args)
462 #define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
463 struct btrfs_ioctl_vol_args)
464 #define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
465 struct btrfs_ioctl_vol_args)
466 #define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
467 struct btrfs_ioctl_clone_range_args)
468 #define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
469 struct btrfs_ioctl_vol_args)
470 #define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
471 struct btrfs_ioctl_vol_args)
472 #define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
473 struct btrfs_ioctl_defrag_range_args)
474 #define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
475 struct btrfs_ioctl_search_args)
476 #define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
477 struct btrfs_ioctl_ino_lookup_args)
478 #define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, u64)
479 #define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
480 struct btrfs_ioctl_space_args)
481 #define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \
482 struct btrfs_ioctl_vol_args_v2)
483 #define BTRFS_IOC_SUBVOL_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 24, \
484 struct btrfs_ioctl_vol_args_v2)
485 #define BTRFS_IOC_SUBVOL_GETFLAGS _IOR(BTRFS_IOCTL_MAGIC, 25, __u64)
486 #define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64)
487 #define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \
488 struct btrfs_ioctl_scrub_args)
489 #define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28)
490 #define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \
491 struct btrfs_ioctl_scrub_args)
492 #define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \
493 struct btrfs_ioctl_dev_info_args)
494 #define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \
495 struct btrfs_ioctl_fs_info_args)
496 #define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \
497 struct btrfs_ioctl_balance_args)
498 #define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int)
499 #define BTRFS_IOC_BALANCE_PROGRESS _IOR(BTRFS_IOCTL_MAGIC, 34, \
500 struct btrfs_ioctl_balance_args)
501 #define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \
502 struct btrfs_ioctl_ino_path_args)
503 #define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \
504 struct btrfs_ioctl_ino_path_args)
505 #define BTRFS_IOC_DEVICES_READY _IOR(BTRFS_IOCTL_MAGIC, 39, \
506 struct btrfs_ioctl_vol_args)
507 #define BTRFS_IOC_SET_RECEIVED_SUBVOL _IOWR(BTRFS_IOCTL_MAGIC, 37, \
508 struct btrfs_ioctl_received_subvol_args)
509 #define BTRFS_IOC_SEND _IOW(BTRFS_IOCTL_MAGIC, 38, struct btrfs_ioctl_send_args)
511 #define BTRFS_IOC_QUOTA_CTL _IOWR(BTRFS_IOCTL_MAGIC, 40, \
512 struct btrfs_ioctl_quota_ctl_args)
513 #define BTRFS_IOC_QGROUP_ASSIGN _IOW(BTRFS_IOCTL_MAGIC, 41, \
514 struct btrfs_ioctl_qgroup_assign_args)
515 #define BTRFS_IOC_QGROUP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 42, \
516 struct btrfs_ioctl_qgroup_create_args)
517 #define BTRFS_IOC_QGROUP_LIMIT _IOR(BTRFS_IOCTL_MAGIC, 43, \
518 struct btrfs_ioctl_qgroup_limit_args)
519 #define BTRFS_IOC_GET_DEV_STATS _IOWR(BTRFS_IOCTL_MAGIC, 52, \
520 struct btrfs_ioctl_get_dev_stats)
521 #define BTRFS_IOC_DEV_REPLACE _IOWR(BTRFS_IOCTL_MAGIC, 53, \
522 struct btrfs_ioctl_dev_replace_args)