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.
19 #ifndef __BTRFS_IOCTL_H__
20 #define __BTRFS_IOCTL_H__
22 #include <asm/types.h>
23 #include <linux/ioctl.h>
30 #define BTRFS_IOCTL_MAGIC 0x94
31 #define BTRFS_VOL_NAME_MAX 255
33 /* this should be 4k */
34 #define BTRFS_PATH_NAME_MAX 4087
35 struct btrfs_ioctl_vol_args {
37 char name[BTRFS_PATH_NAME_MAX + 1];
40 #define BTRFS_DEVICE_PATH_NAME_MAX 1024
42 #define BTRFS_SUBVOL_CREATE_ASYNC (1ULL << 0)
43 #define BTRFS_SUBVOL_RDONLY (1ULL << 1)
44 #define BTRFS_SUBVOL_QGROUP_INHERIT (1ULL << 2)
46 #define BTRFS_QGROUP_INHERIT_SET_LIMITS (1ULL << 0)
48 struct btrfs_qgroup_limit {
56 struct btrfs_qgroup_inherit {
60 __u64 num_excl_copies;
61 struct btrfs_qgroup_limit lim;
65 struct btrfs_ioctl_qgroup_limit_args {
67 struct btrfs_qgroup_limit lim;
70 #define BTRFS_SUBVOL_NAME_MAX 4039
72 struct btrfs_ioctl_vol_args_v2 {
79 struct btrfs_qgroup_inherit *qgroup_inherit;
83 char name[BTRFS_SUBVOL_NAME_MAX + 1];
86 #define BTRFS_FSID_SIZE 16
87 #define BTRFS_UUID_SIZE 16
89 struct btrfs_scrub_progress {
90 __u64 data_extents_scrubbed;
91 __u64 tree_extents_scrubbed;
92 __u64 data_bytes_scrubbed;
93 __u64 tree_bytes_scrubbed;
101 __u64 uncorrectable_errors;
102 __u64 corrected_errors;
104 __u64 unverified_errors;
107 #define BTRFS_SCRUB_READONLY 1
108 struct btrfs_ioctl_scrub_args {
109 __u64 devid; /* in */
110 __u64 start; /* in */
112 __u64 flags; /* in */
113 struct btrfs_scrub_progress progress; /* out */
115 __u64 unused[(1024-32-sizeof(struct btrfs_scrub_progress))/8];
118 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_ALWAYS 0
119 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_AVOID 1
120 struct btrfs_ioctl_dev_replace_start_params {
121 __u64 srcdevid; /* in, if 0, use srcdev_name instead */
122 __u64 cont_reading_from_srcdev_mode; /* in, see #define
124 __u8 srcdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1]; /* in */
125 __u8 tgtdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1]; /* in */
128 #define BTRFS_IOCTL_DEV_REPLACE_STATE_NEVER_STARTED 0
129 #define BTRFS_IOCTL_DEV_REPLACE_STATE_STARTED 1
130 #define BTRFS_IOCTL_DEV_REPLACE_STATE_FINISHED 2
131 #define BTRFS_IOCTL_DEV_REPLACE_STATE_CANCELED 3
132 #define BTRFS_IOCTL_DEV_REPLACE_STATE_SUSPENDED 4
133 struct btrfs_ioctl_dev_replace_status_params {
134 __u64 replace_state; /* out, see #define above */
135 __u64 progress_1000; /* out, 0 <= x <= 1000 */
136 __u64 time_started; /* out, seconds since 1-Jan-1970 */
137 __u64 time_stopped; /* out, seconds since 1-Jan-1970 */
138 __u64 num_write_errors; /* out */
139 __u64 num_uncorrectable_read_errors; /* out */
142 #define BTRFS_IOCTL_DEV_REPLACE_CMD_START 0
143 #define BTRFS_IOCTL_DEV_REPLACE_CMD_STATUS 1
144 #define BTRFS_IOCTL_DEV_REPLACE_CMD_CANCEL 2
145 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NO_RESULT -1
146 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NO_ERROR 0
147 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NOT_STARTED 1
148 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_ALREADY_STARTED 2
149 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_SCRUB_INPROGRESS 3
150 struct btrfs_ioctl_dev_replace_args {
152 __u64 result; /* out */
155 struct btrfs_ioctl_dev_replace_start_params start;
156 struct btrfs_ioctl_dev_replace_status_params status;
162 struct btrfs_ioctl_dev_info_args {
163 __u64 devid; /* in/out */
164 __u8 uuid[BTRFS_UUID_SIZE]; /* in/out */
165 __u64 bytes_used; /* out */
166 __u64 total_bytes; /* out */
167 __u64 unused[379]; /* pad to 4k */
168 __u8 path[BTRFS_DEVICE_PATH_NAME_MAX]; /* out */
171 struct btrfs_ioctl_fs_info_args {
172 __u64 max_id; /* out */
173 __u64 num_devices; /* out */
174 __u8 fsid[BTRFS_FSID_SIZE]; /* out */
175 __u64 reserved[124]; /* pad to 1k */
178 /* balance control ioctl modes */
179 #define BTRFS_BALANCE_CTL_PAUSE 1
180 #define BTRFS_BALANCE_CTL_CANCEL 2
181 #define BTRFS_BALANCE_CTL_RESUME 3
184 * this is packed, because it should be exactly the same as its disk
185 * byte order counterpart (struct btrfs_disk_balance_args)
187 struct btrfs_balance_args {
203 } __attribute__ ((__packed__));
205 struct btrfs_balance_progress {
211 #define BTRFS_BALANCE_STATE_RUNNING (1ULL << 0)
212 #define BTRFS_BALANCE_STATE_PAUSE_REQ (1ULL << 1)
213 #define BTRFS_BALANCE_STATE_CANCEL_REQ (1ULL << 2)
215 struct btrfs_ioctl_balance_args {
216 __u64 flags; /* in/out */
217 __u64 state; /* out */
219 struct btrfs_balance_args data; /* in/out */
220 struct btrfs_balance_args meta; /* in/out */
221 struct btrfs_balance_args sys; /* in/out */
223 struct btrfs_balance_progress stat; /* out */
225 __u64 unused[72]; /* pad to 1k */
228 struct btrfs_ioctl_search_key {
229 /* which root are we searching. 0 is the tree of tree roots */
232 /* keys returned will be >= min and <= max */
236 /* keys returned will be >= min and <= max */
240 /* max and min transids to search for */
244 /* keys returned will be >= min and <= max */
249 * how many items did userland ask for, and how many are we
254 /* align to 64 bits */
257 /* some extra for later */
264 struct btrfs_ioctl_search_header {
270 } __attribute__((may_alias));
272 #define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
274 * the buf is an array of search headers where
275 * each header is followed by the actual item
276 * the type field is expanded to 32 bits for alignment
278 struct btrfs_ioctl_search_args {
279 struct btrfs_ioctl_search_key key;
280 char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
284 * Extended version of TREE_SEARCH ioctl that can return more than 4k of bytes.
285 * The allocated size of the buffer is set in buf_size.
287 struct btrfs_ioctl_search_args_v2 {
288 struct btrfs_ioctl_search_key key; /* in/out - search parameters */
289 __u64 buf_size; /* in - size of buffer
290 * out - on EOVERFLOW: needed size
292 __u64 buf[0]; /* out - found items */
295 #define BTRFS_INO_LOOKUP_PATH_MAX 4080
296 struct btrfs_ioctl_ino_lookup_args {
299 char name[BTRFS_INO_LOOKUP_PATH_MAX];
302 /* flags for the defrag range ioctl */
303 #define BTRFS_DEFRAG_RANGE_COMPRESS 1
304 #define BTRFS_DEFRAG_RANGE_START_IO 2
306 struct btrfs_ioctl_defrag_range_args {
307 /* start of the defrag operation */
310 /* number of bytes to defrag, use (u64)-1 to say all */
314 * flags for the operation, which can include turning
315 * on compression for this one defrag
320 * any extent bigger than this will be considered
321 * already defragged. Use 0 to take the kernel default
322 * Use 1 to say every single extent must be rewritten
327 * which compression method to use if turning on compression
328 * for this defrag operation. If unspecified, zlib will
333 /* spare for later */
337 struct btrfs_ioctl_space_info {
343 struct btrfs_ioctl_space_args {
346 struct btrfs_ioctl_space_info spaces[0];
349 struct btrfs_data_container {
350 __u32 bytes_left; /* out -- bytes not needed to deliver output */
351 __u32 bytes_missing; /* out -- additional bytes needed for result */
352 __u32 elem_cnt; /* out */
353 __u32 elem_missed; /* out */
354 __u64 val[0]; /* out */
357 struct btrfs_ioctl_ino_path_args {
361 /* struct btrfs_data_container *fspath; out */
362 __u64 fspath; /* out */
365 struct btrfs_ioctl_logical_ino_args {
366 __u64 logical; /* in */
369 /* struct btrfs_data_container *inodes; out */
373 struct btrfs_ioctl_timespec {
378 struct btrfs_ioctl_received_subvol_args {
379 char uuid[BTRFS_UUID_SIZE]; /* in */
380 __u64 stransid; /* in */
381 __u64 rtransid; /* out */
382 struct btrfs_ioctl_timespec stime; /* in */
383 struct btrfs_ioctl_timespec rtime; /* out */
384 __u64 flags; /* in */
385 __u64 reserved[16]; /* in */
389 * Caller doesn't want file data in the send stream, even if the
390 * search of clone sources doesn't find an extent. UPDATE_EXTENT
391 * commands will be sent instead of WRITE commands.
393 #define BTRFS_SEND_FLAG_NO_FILE_DATA 0x1
396 * Do not add the leading stream header. Used when multiple snapshots
397 * are sent back to back.
399 #define BTRFS_SEND_FLAG_OMIT_STREAM_HEADER 0x2
402 * Omit the command at the end of the stream that indicated the end
403 * of the stream. This option is used when multiple snapshots are
406 #define BTRFS_SEND_FLAG_OMIT_END_CMD 0x4
408 struct btrfs_ioctl_send_args {
409 __s64 send_fd; /* in */
410 __u64 clone_sources_count; /* in */
411 __u64 *clone_sources; /* in */
412 __u64 parent_root; /* in */
413 __u64 flags; /* in */
414 __u64 reserved[4]; /* in */
417 enum btrfs_dev_stat_values {
418 /* disk I/O failure stats */
419 BTRFS_DEV_STAT_WRITE_ERRS, /* EIO or EREMOTEIO from lower layers */
420 BTRFS_DEV_STAT_READ_ERRS, /* EIO or EREMOTEIO from lower layers */
421 BTRFS_DEV_STAT_FLUSH_ERRS, /* EIO or EREMOTEIO from lower layers */
423 /* stats for indirect indications for I/O failures */
424 BTRFS_DEV_STAT_CORRUPTION_ERRS, /* checksum error, bytenr error or
425 * contents is illegal: this is an
426 * indication that the block was damaged
427 * during read or write, or written to
428 * wrong location or read from wrong
430 BTRFS_DEV_STAT_GENERATION_ERRS, /* an indication that blocks have not
433 BTRFS_DEV_STAT_VALUES_MAX
436 /* Reset statistics after reading; needs SYS_ADMIN capability */
437 #define BTRFS_DEV_STATS_RESET (1ULL << 0)
439 struct btrfs_ioctl_get_dev_stats {
440 __u64 devid; /* in */
441 __u64 nr_items; /* in/out */
442 __u64 flags; /* in/out */
445 __u64 values[BTRFS_DEV_STAT_VALUES_MAX];
447 __u64 unused[128 - 2 - BTRFS_DEV_STAT_VALUES_MAX]; /* pad to 1k */
450 /* BTRFS_IOC_SNAP_CREATE is no longer used by the btrfs command */
451 #define BTRFS_QUOTA_CTL_ENABLE 1
452 #define BTRFS_QUOTA_CTL_DISABLE 2
453 /* 3 has formerly been reserved for BTRFS_QUOTA_CTL_RESCAN */
454 struct btrfs_ioctl_quota_ctl_args {
459 struct btrfs_ioctl_quota_rescan_args {
465 struct btrfs_ioctl_qgroup_assign_args {
471 struct btrfs_ioctl_qgroup_create_args {
476 /* Error codes as returned by the kernel */
477 enum btrfs_err_code {
479 BTRFS_ERROR_DEV_RAID1_MIN_NOT_MET,
480 BTRFS_ERROR_DEV_RAID10_MIN_NOT_MET,
481 BTRFS_ERROR_DEV_RAID5_MIN_NOT_MET,
482 BTRFS_ERROR_DEV_RAID6_MIN_NOT_MET,
483 BTRFS_ERROR_DEV_TGT_REPLACE,
484 BTRFS_ERROR_DEV_MISSING_NOT_FOUND,
485 BTRFS_ERROR_DEV_ONLY_WRITABLE,
486 BTRFS_ERROR_DEV_EXCL_RUN_IN_PROGRESS
489 /* An error code to error string mapping for the kernel
492 static inline char *btrfs_err_str(enum btrfs_err_code err_code)
495 case BTRFS_ERROR_DEV_RAID1_MIN_NOT_MET:
496 return "unable to go below two devices on raid1";
497 case BTRFS_ERROR_DEV_RAID10_MIN_NOT_MET:
498 return "unable to go below four devices on raid10";
499 case BTRFS_ERROR_DEV_RAID5_MIN_NOT_MET:
500 return "unable to go below two devices on raid5";
501 case BTRFS_ERROR_DEV_RAID6_MIN_NOT_MET:
502 return "unable to go below three devices on raid6";
503 case BTRFS_ERROR_DEV_TGT_REPLACE:
504 return "unable to remove the dev_replace target dev";
505 case BTRFS_ERROR_DEV_MISSING_NOT_FOUND:
506 return "no missing devices found to remove";
507 case BTRFS_ERROR_DEV_ONLY_WRITABLE:
508 return "unable to remove the only writeable device";
509 case BTRFS_ERROR_DEV_EXCL_RUN_IN_PROGRESS:
510 return "add/delete/balance/replace/resize operation "
517 #define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
518 struct btrfs_ioctl_vol_args)
519 #define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
520 struct btrfs_ioctl_vol_args)
521 #define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
522 struct btrfs_ioctl_vol_args)
523 #define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
524 struct btrfs_ioctl_vol_args)
526 /* With a @src_length of zero, the range from @src_offset->EOF is cloned! */
527 struct btrfs_ioctl_clone_range_args {
529 __u64 src_offset, src_length;
533 /* trans start and trans end are dangerous, and only for
534 * use by applications that know how to avoid the
535 * resulting deadlocks
537 #define BTRFS_IOC_TRANS_START _IO(BTRFS_IOCTL_MAGIC, 6)
538 #define BTRFS_IOC_TRANS_END _IO(BTRFS_IOCTL_MAGIC, 7)
539 #define BTRFS_IOC_SYNC _IO(BTRFS_IOCTL_MAGIC, 8)
541 #define BTRFS_IOC_CLONE _IOW(BTRFS_IOCTL_MAGIC, 9, int)
542 #define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
543 struct btrfs_ioctl_vol_args)
544 #define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
545 struct btrfs_ioctl_vol_args)
546 #define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
547 struct btrfs_ioctl_vol_args)
548 #define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
549 struct btrfs_ioctl_clone_range_args)
550 #define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
551 struct btrfs_ioctl_vol_args)
552 #define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
553 struct btrfs_ioctl_vol_args)
554 #define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
555 struct btrfs_ioctl_defrag_range_args)
556 #define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
557 struct btrfs_ioctl_search_args)
558 #define BTRFS_IOC_TREE_SEARCH_V2 _IOWR(BTRFS_IOCTL_MAGIC, 17, \
559 struct btrfs_ioctl_search_args_v2)
560 #define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
561 struct btrfs_ioctl_ino_lookup_args)
562 #define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, __u64)
563 #define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
564 struct btrfs_ioctl_space_args)
565 #define BTRFS_IOC_START_SYNC _IOR(BTRFS_IOCTL_MAGIC, 24, __u64)
566 #define BTRFS_IOC_WAIT_SYNC _IOW(BTRFS_IOCTL_MAGIC, 22, __u64)
567 #define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \
568 struct btrfs_ioctl_vol_args_v2)
569 #define BTRFS_IOC_SUBVOL_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 24, \
570 struct btrfs_ioctl_vol_args_v2)
571 #define BTRFS_IOC_SUBVOL_GETFLAGS _IOR(BTRFS_IOCTL_MAGIC, 25, __u64)
572 #define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64)
573 #define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \
574 struct btrfs_ioctl_scrub_args)
575 #define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28)
576 #define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \
577 struct btrfs_ioctl_scrub_args)
578 #define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \
579 struct btrfs_ioctl_dev_info_args)
580 #define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \
581 struct btrfs_ioctl_fs_info_args)
582 #define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \
583 struct btrfs_ioctl_balance_args)
584 #define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int)
585 #define BTRFS_IOC_BALANCE_PROGRESS _IOR(BTRFS_IOCTL_MAGIC, 34, \
586 struct btrfs_ioctl_balance_args)
587 #define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \
588 struct btrfs_ioctl_ino_path_args)
589 #define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \
590 struct btrfs_ioctl_ino_path_args)
591 #define BTRFS_IOC_DEVICES_READY _IOR(BTRFS_IOCTL_MAGIC, 39, \
592 struct btrfs_ioctl_vol_args)
593 #define BTRFS_IOC_SET_RECEIVED_SUBVOL _IOWR(BTRFS_IOCTL_MAGIC, 37, \
594 struct btrfs_ioctl_received_subvol_args)
595 #define BTRFS_IOC_SEND _IOW(BTRFS_IOCTL_MAGIC, 38, struct btrfs_ioctl_send_args)
597 #define BTRFS_IOC_QUOTA_CTL _IOWR(BTRFS_IOCTL_MAGIC, 40, \
598 struct btrfs_ioctl_quota_ctl_args)
599 #define BTRFS_IOC_QGROUP_ASSIGN _IOW(BTRFS_IOCTL_MAGIC, 41, \
600 struct btrfs_ioctl_qgroup_assign_args)
601 #define BTRFS_IOC_QGROUP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 42, \
602 struct btrfs_ioctl_qgroup_create_args)
603 #define BTRFS_IOC_QGROUP_LIMIT _IOR(BTRFS_IOCTL_MAGIC, 43, \
604 struct btrfs_ioctl_qgroup_limit_args)
605 #define BTRFS_IOC_QUOTA_RESCAN _IOW(BTRFS_IOCTL_MAGIC, 44, \
606 struct btrfs_ioctl_quota_rescan_args)
607 #define BTRFS_IOC_QUOTA_RESCAN_STATUS _IOR(BTRFS_IOCTL_MAGIC, 45, \
608 struct btrfs_ioctl_quota_rescan_args)
609 #define BTRFS_IOC_QUOTA_RESCAN_WAIT _IO(BTRFS_IOCTL_MAGIC, 46)
610 #define BTRFS_IOC_GET_FSLABEL _IOR(BTRFS_IOCTL_MAGIC, 49, \
611 char[BTRFS_LABEL_SIZE])
612 #define BTRFS_IOC_SET_FSLABEL _IOW(BTRFS_IOCTL_MAGIC, 50, \
613 char[BTRFS_LABEL_SIZE])
614 #define BTRFS_IOC_GET_DEV_STATS _IOWR(BTRFS_IOCTL_MAGIC, 52, \
615 struct btrfs_ioctl_get_dev_stats)
616 #define BTRFS_IOC_DEV_REPLACE _IOWR(BTRFS_IOCTL_MAGIC, 53, \
617 struct btrfs_ioctl_dev_replace_args)
618 #define BTRFS_IOC_GET_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
619 struct btrfs_ioctl_feature_flags)
620 #define BTRFS_IOC_SET_FEATURES _IOW(BTRFS_IOCTL_MAGIC, 57, \
621 struct btrfs_ioctl_feature_flags[2])
622 #define BTRFS_IOC_GET_SUPPORTED_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
623 struct btrfs_ioctl_feature_flags[3])