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>
29 #define BTRFS_IOCTL_MAGIC 0x94
30 #define BTRFS_VOL_NAME_MAX 255
32 /* this should be 4k */
33 #define BTRFS_PATH_NAME_MAX 4087
34 struct btrfs_ioctl_vol_args {
36 char name[BTRFS_PATH_NAME_MAX + 1];
39 #define BTRFS_DEVICE_PATH_NAME_MAX 1024
41 #define BTRFS_SUBVOL_CREATE_ASYNC (1ULL << 0)
42 #define BTRFS_SUBVOL_RDONLY (1ULL << 1)
43 #define BTRFS_SUBVOL_QGROUP_INHERIT (1ULL << 2)
45 #define BTRFS_QGROUP_INHERIT_SET_LIMITS (1ULL << 0)
47 struct btrfs_qgroup_limit {
55 struct btrfs_qgroup_inherit {
59 __u64 num_excl_copies;
60 struct btrfs_qgroup_limit lim;
64 struct btrfs_ioctl_qgroup_limit_args {
66 struct btrfs_qgroup_limit lim;
69 #define BTRFS_SUBVOL_NAME_MAX 4039
71 struct btrfs_ioctl_vol_args_v2 {
78 struct btrfs_qgroup_inherit *qgroup_inherit;
82 char name[BTRFS_SUBVOL_NAME_MAX + 1];
85 #define BTRFS_FSID_SIZE 16
86 #define BTRFS_UUID_SIZE 16
88 struct btrfs_scrub_progress {
89 __u64 data_extents_scrubbed;
90 __u64 tree_extents_scrubbed;
91 __u64 data_bytes_scrubbed;
92 __u64 tree_bytes_scrubbed;
100 __u64 uncorrectable_errors;
101 __u64 corrected_errors;
103 __u64 unverified_errors;
106 #define BTRFS_SCRUB_READONLY 1
107 struct btrfs_ioctl_scrub_args {
108 __u64 devid; /* in */
109 __u64 start; /* in */
111 __u64 flags; /* in */
112 struct btrfs_scrub_progress progress; /* out */
114 __u64 unused[(1024-32-sizeof(struct btrfs_scrub_progress))/8];
117 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_ALWAYS 0
118 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_AVOID 1
119 struct btrfs_ioctl_dev_replace_start_params {
120 __u64 srcdevid; /* in, if 0, use srcdev_name instead */
121 __u64 cont_reading_from_srcdev_mode; /* in, see #define
123 __u8 srcdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1]; /* in */
124 __u8 tgtdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1]; /* in */
127 #define BTRFS_IOCTL_DEV_REPLACE_STATE_NEVER_STARTED 0
128 #define BTRFS_IOCTL_DEV_REPLACE_STATE_STARTED 1
129 #define BTRFS_IOCTL_DEV_REPLACE_STATE_FINISHED 2
130 #define BTRFS_IOCTL_DEV_REPLACE_STATE_CANCELED 3
131 #define BTRFS_IOCTL_DEV_REPLACE_STATE_SUSPENDED 4
132 struct btrfs_ioctl_dev_replace_status_params {
133 __u64 replace_state; /* out, see #define above */
134 __u64 progress_1000; /* out, 0 <= x <= 1000 */
135 __u64 time_started; /* out, seconds since 1-Jan-1970 */
136 __u64 time_stopped; /* out, seconds since 1-Jan-1970 */
137 __u64 num_write_errors; /* out */
138 __u64 num_uncorrectable_read_errors; /* out */
141 #define BTRFS_IOCTL_DEV_REPLACE_CMD_START 0
142 #define BTRFS_IOCTL_DEV_REPLACE_CMD_STATUS 1
143 #define BTRFS_IOCTL_DEV_REPLACE_CMD_CANCEL 2
144 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NO_ERROR 0
145 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NOT_STARTED 1
146 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_ALREADY_STARTED 2
147 struct btrfs_ioctl_dev_replace_args {
149 __u64 result; /* out */
152 struct btrfs_ioctl_dev_replace_start_params start;
153 struct btrfs_ioctl_dev_replace_status_params status;
159 struct btrfs_ioctl_dev_info_args {
160 __u64 devid; /* in/out */
161 __u8 uuid[BTRFS_UUID_SIZE]; /* in/out */
162 __u64 bytes_used; /* out */
163 __u64 total_bytes; /* out */
164 __u64 unused[379]; /* pad to 4k */
165 __u8 path[BTRFS_DEVICE_PATH_NAME_MAX]; /* out */
168 struct btrfs_ioctl_fs_info_args {
169 __u64 max_id; /* out */
170 __u64 num_devices; /* out */
171 __u8 fsid[BTRFS_FSID_SIZE]; /* out */
172 __u64 reserved[124]; /* pad to 1k */
175 /* balance control ioctl modes */
176 #define BTRFS_BALANCE_CTL_PAUSE 1
177 #define BTRFS_BALANCE_CTL_CANCEL 2
178 #define BTRFS_BALANCE_CTL_RESUME 3
181 * this is packed, because it should be exactly the same as its disk
182 * byte order counterpart (struct btrfs_disk_balance_args)
184 struct btrfs_balance_args {
198 } __attribute__ ((__packed__));
200 struct btrfs_balance_progress {
206 #define BTRFS_BALANCE_STATE_RUNNING (1ULL << 0)
207 #define BTRFS_BALANCE_STATE_PAUSE_REQ (1ULL << 1)
208 #define BTRFS_BALANCE_STATE_CANCEL_REQ (1ULL << 2)
210 struct btrfs_ioctl_balance_args {
211 __u64 flags; /* in/out */
212 __u64 state; /* out */
214 struct btrfs_balance_args data; /* in/out */
215 struct btrfs_balance_args meta; /* in/out */
216 struct btrfs_balance_args sys; /* in/out */
218 struct btrfs_balance_progress stat; /* out */
220 __u64 unused[72]; /* pad to 1k */
223 struct btrfs_ioctl_search_key {
224 /* which root are we searching. 0 is the tree of tree roots */
227 /* keys returned will be >= min and <= max */
231 /* keys returned will be >= min and <= max */
235 /* max and min transids to search for */
239 /* keys returned will be >= min and <= max */
244 * how many items did userland ask for, and how many are we
249 /* align to 64 bits */
252 /* some extra for later */
259 struct btrfs_ioctl_search_header {
265 } __attribute__((may_alias));
267 #define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
269 * the buf is an array of search headers where
270 * each header is followed by the actual item
271 * the type field is expanded to 32 bits for alignment
273 struct btrfs_ioctl_search_args {
274 struct btrfs_ioctl_search_key key;
275 char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
278 #define BTRFS_INO_LOOKUP_PATH_MAX 4080
279 struct btrfs_ioctl_ino_lookup_args {
282 char name[BTRFS_INO_LOOKUP_PATH_MAX];
285 /* flags for the defrag range ioctl */
286 #define BTRFS_DEFRAG_RANGE_COMPRESS 1
287 #define BTRFS_DEFRAG_RANGE_START_IO 2
289 struct btrfs_ioctl_defrag_range_args {
290 /* start of the defrag operation */
293 /* number of bytes to defrag, use (u64)-1 to say all */
297 * flags for the operation, which can include turning
298 * on compression for this one defrag
303 * any extent bigger than this will be considered
304 * already defragged. Use 0 to take the kernel default
305 * Use 1 to say every single extent must be rewritten
310 * which compression method to use if turning on compression
311 * for this defrag operation. If unspecified, zlib will
316 /* spare for later */
320 struct btrfs_ioctl_space_info {
326 struct btrfs_ioctl_space_args {
329 struct btrfs_ioctl_space_info spaces[0];
332 struct btrfs_data_container {
333 __u32 bytes_left; /* out -- bytes not needed to deliver output */
334 __u32 bytes_missing; /* out -- additional bytes needed for result */
335 __u32 elem_cnt; /* out */
336 __u32 elem_missed; /* out */
337 __u64 val[0]; /* out */
340 struct btrfs_ioctl_ino_path_args {
344 /* struct btrfs_data_container *fspath; out */
345 __u64 fspath; /* out */
348 struct btrfs_ioctl_logical_ino_args {
349 __u64 logical; /* in */
352 /* struct btrfs_data_container *inodes; out */
356 struct btrfs_ioctl_timespec {
361 struct btrfs_ioctl_received_subvol_args {
362 char uuid[BTRFS_UUID_SIZE]; /* in */
363 __u64 stransid; /* in */
364 __u64 rtransid; /* out */
365 struct btrfs_ioctl_timespec stime; /* in */
366 struct btrfs_ioctl_timespec rtime; /* out */
367 __u64 flags; /* in */
368 __u64 reserved[16]; /* in */
372 * Caller doesn't want file data in the send stream, even if the
373 * search of clone sources doesn't find an extent. UPDATE_EXTENT
374 * commands will be sent instead of WRITE commands.
376 #define BTRFS_SEND_FLAG_NO_FILE_DATA 0x1
379 * Do not add the leading stream header. Used when multiple snapshots
380 * are sent back to back.
382 #define BTRFS_SEND_FLAG_OMIT_STREAM_HEADER 0x2
385 * Omit the command at the end of the stream that indicated the end
386 * of the stream. This option is used when multiple snapshots are
389 #define BTRFS_SEND_FLAG_OMIT_END_CMD 0x4
391 struct btrfs_ioctl_send_args {
392 __s64 send_fd; /* in */
393 __u64 clone_sources_count; /* in */
394 __u64 *clone_sources; /* in */
395 __u64 parent_root; /* in */
396 __u64 flags; /* in */
397 __u64 reserved[4]; /* in */
400 enum btrfs_dev_stat_values {
401 /* disk I/O failure stats */
402 BTRFS_DEV_STAT_WRITE_ERRS, /* EIO or EREMOTEIO from lower layers */
403 BTRFS_DEV_STAT_READ_ERRS, /* EIO or EREMOTEIO from lower layers */
404 BTRFS_DEV_STAT_FLUSH_ERRS, /* EIO or EREMOTEIO from lower layers */
406 /* stats for indirect indications for I/O failures */
407 BTRFS_DEV_STAT_CORRUPTION_ERRS, /* checksum error, bytenr error or
408 * contents is illegal: this is an
409 * indication that the block was damaged
410 * during read or write, or written to
411 * wrong location or read from wrong
413 BTRFS_DEV_STAT_GENERATION_ERRS, /* an indication that blocks have not
416 BTRFS_DEV_STAT_VALUES_MAX
419 /* Reset statistics after reading; needs SYS_ADMIN capability */
420 #define BTRFS_DEV_STATS_RESET (1ULL << 0)
422 struct btrfs_ioctl_get_dev_stats {
423 __u64 devid; /* in */
424 __u64 nr_items; /* in/out */
425 __u64 flags; /* in/out */
428 __u64 values[BTRFS_DEV_STAT_VALUES_MAX];
430 __u64 unused[128 - 2 - BTRFS_DEV_STAT_VALUES_MAX]; /* pad to 1k */
433 /* BTRFS_IOC_SNAP_CREATE is no longer used by the btrfs command */
434 #define BTRFS_QUOTA_CTL_ENABLE 1
435 #define BTRFS_QUOTA_CTL_DISABLE 2
436 /* 3 has formerly been reserved for BTRFS_QUOTA_CTL_RESCAN */
437 struct btrfs_ioctl_quota_ctl_args {
442 struct btrfs_ioctl_quota_rescan_args {
448 struct btrfs_ioctl_qgroup_assign_args {
454 struct btrfs_ioctl_qgroup_create_args {
459 /* Error codes as returned by the kernel */
460 enum btrfs_err_code {
462 BTRFS_ERROR_DEV_RAID1_MIN_NOT_MET,
463 BTRFS_ERROR_DEV_RAID10_MIN_NOT_MET,
464 BTRFS_ERROR_DEV_RAID5_MIN_NOT_MET,
465 BTRFS_ERROR_DEV_RAID6_MIN_NOT_MET,
466 BTRFS_ERROR_DEV_TGT_REPLACE,
467 BTRFS_ERROR_DEV_MISSING_NOT_FOUND,
468 BTRFS_ERROR_DEV_ONLY_WRITABLE,
469 BTRFS_ERROR_DEV_EXCL_RUN_IN_PROGRESS
472 /* An error code to error string mapping for the kernel
475 static inline char *btrfs_err_str(enum btrfs_err_code err_code)
478 case BTRFS_ERROR_DEV_RAID1_MIN_NOT_MET:
479 return "unable to go below two devices on raid1";
480 case BTRFS_ERROR_DEV_RAID10_MIN_NOT_MET:
481 return "unable to go below four devices on raid10";
482 case BTRFS_ERROR_DEV_RAID5_MIN_NOT_MET:
483 return "unable to go below three devices on raid5";
484 case BTRFS_ERROR_DEV_RAID6_MIN_NOT_MET:
485 return "unable to go below four devices on raid6";
486 case BTRFS_ERROR_DEV_TGT_REPLACE:
487 return "unable to remove the dev_replace target dev";
488 case BTRFS_ERROR_DEV_MISSING_NOT_FOUND:
489 return "no missing devices found to remove";
490 case BTRFS_ERROR_DEV_ONLY_WRITABLE:
491 return "unable to remove the only writeable device";
492 case BTRFS_ERROR_DEV_EXCL_RUN_IN_PROGRESS:
493 return "add/delete/balance/replace/resize operation "
500 #define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
501 struct btrfs_ioctl_vol_args)
502 #define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
503 struct btrfs_ioctl_vol_args)
504 #define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
505 struct btrfs_ioctl_vol_args)
506 #define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
507 struct btrfs_ioctl_vol_args)
509 struct btrfs_ioctl_clone_range_args {
511 __u64 src_offset, src_length;
515 /* trans start and trans end are dangerous, and only for
516 * use by applications that know how to avoid the
517 * resulting deadlocks
519 #define BTRFS_IOC_TRANS_START _IO(BTRFS_IOCTL_MAGIC, 6)
520 #define BTRFS_IOC_TRANS_END _IO(BTRFS_IOCTL_MAGIC, 7)
521 #define BTRFS_IOC_SYNC _IO(BTRFS_IOCTL_MAGIC, 8)
523 #define BTRFS_IOC_CLONE _IOW(BTRFS_IOCTL_MAGIC, 9, int)
524 #define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
525 struct btrfs_ioctl_vol_args)
526 #define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
527 struct btrfs_ioctl_vol_args)
528 #define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
529 struct btrfs_ioctl_vol_args)
530 #define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
531 struct btrfs_ioctl_clone_range_args)
532 #define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
533 struct btrfs_ioctl_vol_args)
534 #define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
535 struct btrfs_ioctl_vol_args)
536 #define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
537 struct btrfs_ioctl_defrag_range_args)
538 #define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
539 struct btrfs_ioctl_search_args)
540 #define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
541 struct btrfs_ioctl_ino_lookup_args)
542 #define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, u64)
543 #define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
544 struct btrfs_ioctl_space_args)
545 #define BTRFS_IOC_START_SYNC _IOR(BTRFS_IOCTL_MAGIC, 24, __u64)
546 #define BTRFS_IOC_WAIT_SYNC _IOW(BTRFS_IOCTL_MAGIC, 22, __u64)
547 #define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \
548 struct btrfs_ioctl_vol_args_v2)
549 #define BTRFS_IOC_SUBVOL_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 24, \
550 struct btrfs_ioctl_vol_args_v2)
551 #define BTRFS_IOC_SUBVOL_GETFLAGS _IOR(BTRFS_IOCTL_MAGIC, 25, __u64)
552 #define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64)
553 #define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \
554 struct btrfs_ioctl_scrub_args)
555 #define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28)
556 #define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \
557 struct btrfs_ioctl_scrub_args)
558 #define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \
559 struct btrfs_ioctl_dev_info_args)
560 #define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \
561 struct btrfs_ioctl_fs_info_args)
562 #define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \
563 struct btrfs_ioctl_balance_args)
564 #define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int)
565 #define BTRFS_IOC_BALANCE_PROGRESS _IOR(BTRFS_IOCTL_MAGIC, 34, \
566 struct btrfs_ioctl_balance_args)
567 #define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \
568 struct btrfs_ioctl_ino_path_args)
569 #define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \
570 struct btrfs_ioctl_ino_path_args)
571 #define BTRFS_IOC_DEVICES_READY _IOR(BTRFS_IOCTL_MAGIC, 39, \
572 struct btrfs_ioctl_vol_args)
573 #define BTRFS_IOC_SET_RECEIVED_SUBVOL _IOWR(BTRFS_IOCTL_MAGIC, 37, \
574 struct btrfs_ioctl_received_subvol_args)
575 #define BTRFS_IOC_SEND _IOW(BTRFS_IOCTL_MAGIC, 38, struct btrfs_ioctl_send_args)
577 #define BTRFS_IOC_QUOTA_CTL _IOWR(BTRFS_IOCTL_MAGIC, 40, \
578 struct btrfs_ioctl_quota_ctl_args)
579 #define BTRFS_IOC_QGROUP_ASSIGN _IOW(BTRFS_IOCTL_MAGIC, 41, \
580 struct btrfs_ioctl_qgroup_assign_args)
581 #define BTRFS_IOC_QGROUP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 42, \
582 struct btrfs_ioctl_qgroup_create_args)
583 #define BTRFS_IOC_QGROUP_LIMIT _IOR(BTRFS_IOCTL_MAGIC, 43, \
584 struct btrfs_ioctl_qgroup_limit_args)
585 #define BTRFS_IOC_QUOTA_RESCAN _IOW(BTRFS_IOCTL_MAGIC, 44, \
586 struct btrfs_ioctl_quota_rescan_args)
587 #define BTRFS_IOC_QUOTA_RESCAN_STATUS _IOR(BTRFS_IOCTL_MAGIC, 45, \
588 struct btrfs_ioctl_quota_rescan_args)
589 #define BTRFS_IOC_QUOTA_RESCAN_WAIT _IO(BTRFS_IOCTL_MAGIC, 46)
590 #define BTRFS_IOC_GET_FSLABEL _IOR(BTRFS_IOCTL_MAGIC, 49, \
591 char[BTRFS_LABEL_SIZE])
592 #define BTRFS_IOC_SET_FSLABEL _IOW(BTRFS_IOCTL_MAGIC, 50, \
593 char[BTRFS_LABEL_SIZE])
594 #define BTRFS_IOC_GET_DEV_STATS _IOWR(BTRFS_IOCTL_MAGIC, 52, \
595 struct btrfs_ioctl_get_dev_stats)
596 #define BTRFS_IOC_DEV_REPLACE _IOWR(BTRFS_IOCTL_MAGIC, 53, \
597 struct btrfs_ioctl_dev_replace_args)
598 #define BTRFS_IOC_GET_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
599 struct btrfs_ioctl_feature_flags)
600 #define BTRFS_IOC_SET_FEATURES _IOW(BTRFS_IOCTL_MAGIC, 57, \
601 struct btrfs_ioctl_feature_flags[2])
602 #define BTRFS_IOC_GET_SUPPORTED_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
603 struct btrfs_ioctl_feature_flags[3])