1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
3 * Copyright (C) 2007 Oracle. All rights reserved.
5 * This program is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU General Public
7 * License v2 as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * General Public License for more details.
14 * You should have received a copy of the GNU General Public
15 * License along with this program; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 021110-1307, USA.
20 #ifndef _UAPI_LINUX_BTRFS_H
21 #define _UAPI_LINUX_BTRFS_H
27 #include <linux/types.h>
28 #include <linux/ioctl.h>
31 #define BTRFS_IOCTL_MAGIC 0x94
32 #define BTRFS_VOL_NAME_MAX 255
33 #define BTRFS_LABEL_SIZE 256
35 /* this should be 4k */
36 #define BTRFS_PATH_NAME_MAX 4087
37 struct btrfs_ioctl_vol_args {
39 char name[BTRFS_PATH_NAME_MAX + 1];
42 #define BTRFS_DEVICE_PATH_NAME_MAX 1024
43 #define BTRFS_SUBVOL_NAME_MAX 4039
46 /* Deprecated since 5.7 */
47 # define BTRFS_SUBVOL_CREATE_ASYNC (1ULL << 0)
49 #define BTRFS_SUBVOL_RDONLY (1ULL << 1)
50 #define BTRFS_SUBVOL_QGROUP_INHERIT (1ULL << 2)
52 #define BTRFS_DEVICE_SPEC_BY_ID (1ULL << 3)
54 #define BTRFS_SUBVOL_SPEC_BY_ID (1ULL << 4)
56 #define BTRFS_VOL_ARG_V2_FLAGS_SUPPORTED \
57 (BTRFS_SUBVOL_RDONLY | \
58 BTRFS_SUBVOL_QGROUP_INHERIT | \
59 BTRFS_DEVICE_SPEC_BY_ID | \
60 BTRFS_SUBVOL_SPEC_BY_ID)
62 #define BTRFS_FSID_SIZE 16
63 #define BTRFS_UUID_SIZE 16
64 #define BTRFS_UUID_UNPARSED_SIZE 37
67 * flags definition for qgroup limits
70 * struct btrfs_qgroup_limit.flags
71 * struct btrfs_qgroup_limit_item.flags
73 #define BTRFS_QGROUP_LIMIT_MAX_RFER (1ULL << 0)
74 #define BTRFS_QGROUP_LIMIT_MAX_EXCL (1ULL << 1)
75 #define BTRFS_QGROUP_LIMIT_RSV_RFER (1ULL << 2)
76 #define BTRFS_QGROUP_LIMIT_RSV_EXCL (1ULL << 3)
77 #define BTRFS_QGROUP_LIMIT_RFER_CMPR (1ULL << 4)
78 #define BTRFS_QGROUP_LIMIT_EXCL_CMPR (1ULL << 5)
80 struct btrfs_qgroup_limit {
89 * flags definition for qgroup inheritance
92 * struct btrfs_qgroup_inherit.flags
94 #define BTRFS_QGROUP_INHERIT_SET_LIMITS (1ULL << 0)
96 struct btrfs_qgroup_inherit {
100 __u64 num_excl_copies;
101 struct btrfs_qgroup_limit lim;
105 struct btrfs_ioctl_qgroup_limit_args {
107 struct btrfs_qgroup_limit lim;
111 * Arguments for specification of subvolumes or devices, supporting by-name or
114 * The set of supported flags depends on the ioctl
116 * BTRFS_SUBVOL_RDONLY is also provided/consumed by the following ioctls:
117 * - BTRFS_IOC_SUBVOL_GETFLAGS
118 * - BTRFS_IOC_SUBVOL_SETFLAGS
121 /* Supported flags for BTRFS_IOC_RM_DEV_V2 */
122 #define BTRFS_DEVICE_REMOVE_ARGS_MASK \
123 (BTRFS_DEVICE_SPEC_BY_ID)
125 /* Supported flags for BTRFS_IOC_SNAP_CREATE_V2 and BTRFS_IOC_SUBVOL_CREATE_V2 */
126 #define BTRFS_SUBVOL_CREATE_ARGS_MASK \
127 (BTRFS_SUBVOL_RDONLY | \
128 BTRFS_SUBVOL_QGROUP_INHERIT)
130 /* Supported flags for BTRFS_IOC_SNAP_DESTROY_V2 */
131 #define BTRFS_SUBVOL_DELETE_ARGS_MASK \
132 (BTRFS_SUBVOL_SPEC_BY_ID)
134 struct btrfs_ioctl_vol_args_v2 {
141 struct btrfs_qgroup_inherit __user *qgroup_inherit;
146 char name[BTRFS_SUBVOL_NAME_MAX + 1];
153 * structure to report errors and progress to userspace, either as a
154 * result of a finished scrub, a canceled scrub or a progress inquiry
156 struct btrfs_scrub_progress {
157 __u64 data_extents_scrubbed; /* # of data extents scrubbed */
158 __u64 tree_extents_scrubbed; /* # of tree extents scrubbed */
159 __u64 data_bytes_scrubbed; /* # of data bytes scrubbed */
160 __u64 tree_bytes_scrubbed; /* # of tree bytes scrubbed */
161 __u64 read_errors; /* # of read errors encountered (EIO) */
162 __u64 csum_errors; /* # of failed csum checks */
163 __u64 verify_errors; /* # of occurrences, where the metadata
164 * of a tree block did not match the
165 * expected values, like generation or
167 __u64 no_csum; /* # of 4k data block for which no csum
168 * is present, probably the result of
169 * data written with nodatasum */
170 __u64 csum_discards; /* # of csum for which no data was found
171 * in the extent tree. */
172 __u64 super_errors; /* # of bad super blocks encountered */
173 __u64 malloc_errors; /* # of internal kmalloc errors. These
174 * will likely cause an incomplete
176 __u64 uncorrectable_errors; /* # of errors where either no intact
177 * copy was found or the writeback
179 __u64 corrected_errors; /* # of errors corrected */
180 __u64 last_physical; /* last physical address scrubbed. In
181 * case a scrub was aborted, this can
182 * be used to restart the scrub */
183 __u64 unverified_errors; /* # of occurrences where a read for a
184 * full (64k) bio failed, but the re-
185 * check succeeded for each 4k piece.
186 * Intermittent error. */
189 #define BTRFS_SCRUB_READONLY 1
190 #define BTRFS_SCRUB_SUPPORTED_FLAGS (BTRFS_SCRUB_READONLY)
191 struct btrfs_ioctl_scrub_args {
192 __u64 devid; /* in */
193 __u64 start; /* in */
195 __u64 flags; /* in */
196 struct btrfs_scrub_progress progress; /* out */
198 __u64 unused[(1024-32-sizeof(struct btrfs_scrub_progress))/8];
201 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_ALWAYS 0
202 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_AVOID 1
203 struct btrfs_ioctl_dev_replace_start_params {
204 __u64 srcdevid; /* in, if 0, use srcdev_name instead */
205 __u64 cont_reading_from_srcdev_mode; /* in, see #define
207 __u8 srcdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1]; /* in */
208 __u8 tgtdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1]; /* in */
211 #define BTRFS_IOCTL_DEV_REPLACE_STATE_NEVER_STARTED 0
212 #define BTRFS_IOCTL_DEV_REPLACE_STATE_STARTED 1
213 #define BTRFS_IOCTL_DEV_REPLACE_STATE_FINISHED 2
214 #define BTRFS_IOCTL_DEV_REPLACE_STATE_CANCELED 3
215 #define BTRFS_IOCTL_DEV_REPLACE_STATE_SUSPENDED 4
216 struct btrfs_ioctl_dev_replace_status_params {
217 __u64 replace_state; /* out, see #define above */
218 __u64 progress_1000; /* out, 0 <= x <= 1000 */
219 __u64 time_started; /* out, seconds since 1-Jan-1970 */
220 __u64 time_stopped; /* out, seconds since 1-Jan-1970 */
221 __u64 num_write_errors; /* out */
222 __u64 num_uncorrectable_read_errors; /* out */
225 #define BTRFS_IOCTL_DEV_REPLACE_CMD_START 0
226 #define BTRFS_IOCTL_DEV_REPLACE_CMD_STATUS 1
227 #define BTRFS_IOCTL_DEV_REPLACE_CMD_CANCEL 2
228 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NO_ERROR 0
229 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NOT_STARTED 1
230 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_ALREADY_STARTED 2
231 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_SCRUB_INPROGRESS 3
232 struct btrfs_ioctl_dev_replace_args {
234 __u64 result; /* out */
237 struct btrfs_ioctl_dev_replace_start_params start;
238 struct btrfs_ioctl_dev_replace_status_params status;
244 struct btrfs_ioctl_dev_info_args {
245 __u64 devid; /* in/out */
246 __u8 uuid[BTRFS_UUID_SIZE]; /* in/out */
247 __u64 bytes_used; /* out */
248 __u64 total_bytes; /* out */
252 * Showing the fsid of the device, allowing user space to check if this
253 * device is a seeding one.
255 * Introduced in v6.3, thus user space still needs to check if kernel
256 * changed this value. Older kernel will not touch the values here.
258 __u8 fsid[BTRFS_UUID_SIZE];
259 __u64 unused[377]; /* pad to 4k */
260 __u8 path[BTRFS_DEVICE_PATH_NAME_MAX]; /* out */
264 * Retrieve information about the filesystem
267 /* Request information about checksum type and size */
268 #define BTRFS_FS_INFO_FLAG_CSUM_INFO (1 << 0)
270 /* Request information about filesystem generation */
271 #define BTRFS_FS_INFO_FLAG_GENERATION (1 << 1)
272 /* Request information about filesystem metadata UUID */
273 #define BTRFS_FS_INFO_FLAG_METADATA_UUID (1 << 2)
275 struct btrfs_ioctl_fs_info_args {
276 __u64 max_id; /* out */
277 __u64 num_devices; /* out */
278 __u8 fsid[BTRFS_FSID_SIZE]; /* out */
279 __u32 nodesize; /* out */
280 __u32 sectorsize; /* out */
281 __u32 clone_alignment; /* out */
282 /* See BTRFS_FS_INFO_FLAG_* */
283 __u16 csum_type; /* out */
284 __u16 csum_size; /* out */
285 __u64 flags; /* in/out */
286 __u64 generation; /* out */
287 __u8 metadata_uuid[BTRFS_FSID_SIZE]; /* out */
288 __u8 reserved[944]; /* pad to 1k */
295 * struct btrfs_ioctl_feature_flags
297 #define BTRFS_FEATURE_COMPAT_RO_FREE_SPACE_TREE (1ULL << 0)
299 * Older kernels (< 4.9) on big-endian systems produced broken free space tree
300 * bitmaps, and btrfs-progs also used to corrupt the free space tree (versions
301 * < 4.7.3). If this bit is clear, then the free space tree cannot be trusted.
302 * btrfs-progs can also intentionally clear this bit to ask the kernel to
303 * rebuild the free space tree, however this might not work on older kernels
304 * that do not know about this bit. If not sure, clear the cache manually on
305 * first mount when booting older kernel versions.
307 #define BTRFS_FEATURE_COMPAT_RO_FREE_SPACE_TREE_VALID (1ULL << 1)
308 #define BTRFS_FEATURE_COMPAT_RO_VERITY (1ULL << 2)
311 * Put all block group items into a dedicated block group tree, greatly
312 * reducing mount time for large filesystem due to better locality.
314 #define BTRFS_FEATURE_COMPAT_RO_BLOCK_GROUP_TREE (1ULL << 3)
316 #define BTRFS_FEATURE_INCOMPAT_MIXED_BACKREF (1ULL << 0)
317 #define BTRFS_FEATURE_INCOMPAT_DEFAULT_SUBVOL (1ULL << 1)
318 #define BTRFS_FEATURE_INCOMPAT_MIXED_GROUPS (1ULL << 2)
319 #define BTRFS_FEATURE_INCOMPAT_COMPRESS_LZO (1ULL << 3)
320 #define BTRFS_FEATURE_INCOMPAT_COMPRESS_ZSTD (1ULL << 4)
323 * older kernels tried to do bigger metadata blocks, but the
324 * code was pretty buggy. Lets not let them try anymore.
326 #define BTRFS_FEATURE_INCOMPAT_BIG_METADATA (1ULL << 5)
328 #define BTRFS_FEATURE_INCOMPAT_EXTENDED_IREF (1ULL << 6)
329 #define BTRFS_FEATURE_INCOMPAT_RAID56 (1ULL << 7)
330 #define BTRFS_FEATURE_INCOMPAT_SKINNY_METADATA (1ULL << 8)
331 #define BTRFS_FEATURE_INCOMPAT_NO_HOLES (1ULL << 9)
332 #define BTRFS_FEATURE_INCOMPAT_METADATA_UUID (1ULL << 10)
333 #define BTRFS_FEATURE_INCOMPAT_RAID1C34 (1ULL << 11)
334 #define BTRFS_FEATURE_INCOMPAT_ZONED (1ULL << 12)
335 #define BTRFS_FEATURE_INCOMPAT_EXTENT_TREE_V2 (1ULL << 13)
337 struct btrfs_ioctl_feature_flags {
339 __u64 compat_ro_flags;
340 __u64 incompat_flags;
343 /* balance control ioctl modes */
344 #define BTRFS_BALANCE_CTL_PAUSE 1
345 #define BTRFS_BALANCE_CTL_CANCEL 2
348 * this is packed, because it should be exactly the same as its disk
349 * byte order counterpart (struct btrfs_disk_balance_args)
351 struct btrfs_balance_args {
356 * BTRFS_BALANCE_ARGS_USAGE with a single value means '0..N'
357 * BTRFS_BALANCE_ARGS_USAGE_RANGE - range syntax, min..max
377 * BTRFS_BALANCE_ARGS_LIMIT with value 'limit'
378 * BTRFS_BALANCE_ARGS_LIMIT_RANGE - the extend version can use minimum
382 __u64 limit; /* limit number of processed chunks */
390 * Process chunks that cross stripes_min..stripes_max devices,
391 * BTRFS_BALANCE_ARGS_STRIPES_RANGE
397 } __attribute__ ((__packed__));
399 /* report balance progress to userspace */
400 struct btrfs_balance_progress {
401 __u64 expected; /* estimated # of chunks that will be
402 * relocated to fulfill the request */
403 __u64 considered; /* # of chunks we have considered so far */
404 __u64 completed; /* # of chunks relocated so far */
408 * flags definition for balance
410 * Restriper's general type filter
413 * btrfs_ioctl_balance_args.flags
414 * btrfs_balance_control.flags (internal)
416 #define BTRFS_BALANCE_DATA (1ULL << 0)
417 #define BTRFS_BALANCE_SYSTEM (1ULL << 1)
418 #define BTRFS_BALANCE_METADATA (1ULL << 2)
420 #define BTRFS_BALANCE_TYPE_MASK (BTRFS_BALANCE_DATA | \
421 BTRFS_BALANCE_SYSTEM | \
422 BTRFS_BALANCE_METADATA)
424 #define BTRFS_BALANCE_FORCE (1ULL << 3)
425 #define BTRFS_BALANCE_RESUME (1ULL << 4)
428 * flags definitions for per-type balance args
433 * struct btrfs_balance_args
435 #define BTRFS_BALANCE_ARGS_PROFILES (1ULL << 0)
436 #define BTRFS_BALANCE_ARGS_USAGE (1ULL << 1)
437 #define BTRFS_BALANCE_ARGS_DEVID (1ULL << 2)
438 #define BTRFS_BALANCE_ARGS_DRANGE (1ULL << 3)
439 #define BTRFS_BALANCE_ARGS_VRANGE (1ULL << 4)
440 #define BTRFS_BALANCE_ARGS_LIMIT (1ULL << 5)
441 #define BTRFS_BALANCE_ARGS_LIMIT_RANGE (1ULL << 6)
442 #define BTRFS_BALANCE_ARGS_STRIPES_RANGE (1ULL << 7)
443 #define BTRFS_BALANCE_ARGS_USAGE_RANGE (1ULL << 10)
445 #define BTRFS_BALANCE_ARGS_MASK \
446 (BTRFS_BALANCE_ARGS_PROFILES | \
447 BTRFS_BALANCE_ARGS_USAGE | \
448 BTRFS_BALANCE_ARGS_DEVID | \
449 BTRFS_BALANCE_ARGS_DRANGE | \
450 BTRFS_BALANCE_ARGS_VRANGE | \
451 BTRFS_BALANCE_ARGS_LIMIT | \
452 BTRFS_BALANCE_ARGS_LIMIT_RANGE | \
453 BTRFS_BALANCE_ARGS_STRIPES_RANGE | \
454 BTRFS_BALANCE_ARGS_USAGE_RANGE)
457 * Profile changing flags. When SOFT is set we won't relocate chunk if
458 * it already has the target profile (even though it may be
461 #define BTRFS_BALANCE_ARGS_CONVERT (1ULL << 8)
462 #define BTRFS_BALANCE_ARGS_SOFT (1ULL << 9)
466 * flags definition for balance state
469 * struct btrfs_ioctl_balance_args.state
471 #define BTRFS_BALANCE_STATE_RUNNING (1ULL << 0)
472 #define BTRFS_BALANCE_STATE_PAUSE_REQ (1ULL << 1)
473 #define BTRFS_BALANCE_STATE_CANCEL_REQ (1ULL << 2)
475 struct btrfs_ioctl_balance_args {
476 __u64 flags; /* in/out */
477 __u64 state; /* out */
479 struct btrfs_balance_args data; /* in/out */
480 struct btrfs_balance_args meta; /* in/out */
481 struct btrfs_balance_args sys; /* in/out */
483 struct btrfs_balance_progress stat; /* out */
485 __u64 unused[72]; /* pad to 1k */
488 #define BTRFS_INO_LOOKUP_PATH_MAX 4080
489 struct btrfs_ioctl_ino_lookup_args {
492 char name[BTRFS_INO_LOOKUP_PATH_MAX];
495 #define BTRFS_INO_LOOKUP_USER_PATH_MAX (4080 - BTRFS_VOL_NAME_MAX - 1)
496 struct btrfs_ioctl_ino_lookup_user_args {
497 /* in, inode number containing the subvolume of 'subvolid' */
501 /* out, name of the subvolume of 'treeid' */
502 char name[BTRFS_VOL_NAME_MAX + 1];
504 * out, constructed path from the directory with which the ioctl is
507 char path[BTRFS_INO_LOOKUP_USER_PATH_MAX];
510 /* Search criteria for the btrfs SEARCH ioctl family. */
511 struct btrfs_ioctl_search_key {
513 * The tree we're searching in. 1 is the tree of tree roots, 2 is the
514 * extent tree, etc...
516 * A special tree_id value of 0 will cause a search in the subvolume
517 * tree that the inode which is passed to the ioctl is part of.
519 __u64 tree_id; /* in */
522 * When doing a tree search, we're actually taking a slice from a
523 * linear search space of 136-bit keys.
525 * A full 136-bit tree key is composed as:
526 * (objectid << 72) + (type << 64) + offset
528 * The individual min and max values for objectid, type and offset
529 * define the min_key and max_key values for the search range. All
530 * metadata items with a key in the interval [min_key, max_key] will be
533 * Additionally, we can filter the items returned on transaction id of
534 * the metadata block they're stored in by specifying a transid range.
535 * Be aware that this transaction id only denotes when the metadata
536 * page that currently contains the item got written the last time as
537 * result of a COW operation. The number does not have any meaning
538 * related to the transaction in which an individual item that is being
539 * returned was created or changed.
541 __u64 min_objectid; /* in */
542 __u64 max_objectid; /* in */
543 __u64 min_offset; /* in */
544 __u64 max_offset; /* in */
545 __u64 min_transid; /* in */
546 __u64 max_transid; /* in */
547 __u32 min_type; /* in */
548 __u32 max_type; /* in */
551 * input: The maximum amount of results desired.
552 * output: The actual amount of items returned, restricted by any of:
553 * - reaching the upper bound of the search range
554 * - reaching the input nr_items amount of items
555 * - completely filling the supplied memory buffer
557 __u32 nr_items; /* in/out */
559 /* align to 64 bits */
562 /* some extra for later */
569 struct btrfs_ioctl_search_header {
575 } __attribute__ ((__may_alias__));
577 #define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
579 * the buf is an array of search headers where
580 * each header is followed by the actual item
581 * the type field is expanded to 32 bits for alignment
583 struct btrfs_ioctl_search_args {
584 struct btrfs_ioctl_search_key key;
585 char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
589 * Extended version of TREE_SEARCH ioctl that can return more than 4k of bytes.
590 * The allocated size of the buffer is set in buf_size.
592 struct btrfs_ioctl_search_args_v2 {
593 struct btrfs_ioctl_search_key key; /* in/out - search parameters */
594 __u64 buf_size; /* in - size of buffer
595 * out - on EOVERFLOW: needed size
597 __u64 buf[]; /* out - found items */
600 /* With a @src_length of zero, the range from @src_offset->EOF is cloned! */
601 struct btrfs_ioctl_clone_range_args {
603 __u64 src_offset, src_length;
608 * flags definition for the defrag range ioctl
611 * struct btrfs_ioctl_defrag_range_args.flags
613 #define BTRFS_DEFRAG_RANGE_COMPRESS 1
614 #define BTRFS_DEFRAG_RANGE_START_IO 2
615 struct btrfs_ioctl_defrag_range_args {
616 /* start of the defrag operation */
619 /* number of bytes to defrag, use (u64)-1 to say all */
623 * flags for the operation, which can include turning
624 * on compression for this one defrag
629 * any extent bigger than this will be considered
630 * already defragged. Use 0 to take the kernel default
631 * Use 1 to say every single extent must be rewritten
636 * which compression method to use if turning on compression
637 * for this defrag operation. If unspecified, zlib will
642 /* spare for later */
647 #define BTRFS_SAME_DATA_DIFFERS 1
648 /* For extent-same ioctl */
649 struct btrfs_ioctl_same_extent_info {
650 __s64 fd; /* in - destination file */
651 __u64 logical_offset; /* in - start of extent in destination */
652 __u64 bytes_deduped; /* out - total # of bytes we were able
653 * to dedupe from this file */
654 /* status of this dedupe operation:
655 * 0 if dedup succeeds
657 * == BTRFS_SAME_DATA_DIFFERS if data differs
659 __s32 status; /* out - see above description */
663 struct btrfs_ioctl_same_args {
664 __u64 logical_offset; /* in - start of extent in source */
665 __u64 length; /* in - length of extent */
666 __u16 dest_count; /* in - total elements in info array */
669 struct btrfs_ioctl_same_extent_info info[];
672 struct btrfs_ioctl_space_info {
678 struct btrfs_ioctl_space_args {
681 struct btrfs_ioctl_space_info spaces[];
684 struct btrfs_data_container {
685 __u32 bytes_left; /* out -- bytes not needed to deliver output */
686 __u32 bytes_missing; /* out -- additional bytes needed for result */
687 __u32 elem_cnt; /* out */
688 __u32 elem_missed; /* out */
689 __u64 val[]; /* out */
692 struct btrfs_ioctl_ino_path_args {
696 /* struct btrfs_data_container *fspath; out */
697 __u64 fspath; /* out */
700 struct btrfs_ioctl_logical_ino_args {
701 __u64 logical; /* in */
703 __u64 reserved[3]; /* must be 0 for now */
704 __u64 flags; /* in, v2 only */
705 /* struct btrfs_data_container *inodes; out */
710 * Return every ref to the extent, not just those containing logical block.
711 * Requires logical == extent bytenr.
713 #define BTRFS_LOGICAL_INO_ARGS_IGNORE_OFFSET (1ULL << 0)
715 enum btrfs_dev_stat_values {
716 /* disk I/O failure stats */
717 BTRFS_DEV_STAT_WRITE_ERRS, /* EIO or EREMOTEIO from lower layers */
718 BTRFS_DEV_STAT_READ_ERRS, /* EIO or EREMOTEIO from lower layers */
719 BTRFS_DEV_STAT_FLUSH_ERRS, /* EIO or EREMOTEIO from lower layers */
721 /* stats for indirect indications for I/O failures */
722 BTRFS_DEV_STAT_CORRUPTION_ERRS, /* checksum error, bytenr error or
723 * contents is illegal: this is an
724 * indication that the block was damaged
725 * during read or write, or written to
726 * wrong location or read from wrong
728 BTRFS_DEV_STAT_GENERATION_ERRS, /* an indication that blocks have not
731 BTRFS_DEV_STAT_VALUES_MAX
734 /* Reset statistics after reading; needs SYS_ADMIN capability */
735 #define BTRFS_DEV_STATS_RESET (1ULL << 0)
737 struct btrfs_ioctl_get_dev_stats {
738 __u64 devid; /* in */
739 __u64 nr_items; /* in/out */
740 __u64 flags; /* in/out */
743 __u64 values[BTRFS_DEV_STAT_VALUES_MAX];
746 * This pads the struct to 1032 bytes. It was originally meant to pad to
747 * 1024 bytes, but when adding the flags field, the padding calculation
750 __u64 unused[128 - 2 - BTRFS_DEV_STAT_VALUES_MAX];
753 #define BTRFS_QUOTA_CTL_ENABLE 1
754 #define BTRFS_QUOTA_CTL_DISABLE 2
755 #define BTRFS_QUOTA_CTL_RESCAN__NOTUSED 3
756 struct btrfs_ioctl_quota_ctl_args {
761 struct btrfs_ioctl_quota_rescan_args {
767 struct btrfs_ioctl_qgroup_assign_args {
773 struct btrfs_ioctl_qgroup_create_args {
777 struct btrfs_ioctl_timespec {
782 struct btrfs_ioctl_received_subvol_args {
783 char uuid[BTRFS_UUID_SIZE]; /* in */
784 __u64 stransid; /* in */
785 __u64 rtransid; /* out */
786 struct btrfs_ioctl_timespec stime; /* in */
787 struct btrfs_ioctl_timespec rtime; /* out */
788 __u64 flags; /* in */
789 __u64 reserved[16]; /* in */
793 * Caller doesn't want file data in the send stream, even if the
794 * search of clone sources doesn't find an extent. UPDATE_EXTENT
795 * commands will be sent instead of WRITE commands.
797 #define BTRFS_SEND_FLAG_NO_FILE_DATA 0x1
800 * Do not add the leading stream header. Used when multiple snapshots
801 * are sent back to back.
803 #define BTRFS_SEND_FLAG_OMIT_STREAM_HEADER 0x2
806 * Omit the command at the end of the stream that indicated the end
807 * of the stream. This option is used when multiple snapshots are
810 #define BTRFS_SEND_FLAG_OMIT_END_CMD 0x4
813 * Read the protocol version in the structure
815 #define BTRFS_SEND_FLAG_VERSION 0x8
818 * Send compressed data using the ENCODED_WRITE command instead of decompressing
819 * the data and sending it with the WRITE command. This requires protocol
822 #define BTRFS_SEND_FLAG_COMPRESSED 0x10
824 #define BTRFS_SEND_FLAG_MASK \
825 (BTRFS_SEND_FLAG_NO_FILE_DATA | \
826 BTRFS_SEND_FLAG_OMIT_STREAM_HEADER | \
827 BTRFS_SEND_FLAG_OMIT_END_CMD | \
828 BTRFS_SEND_FLAG_VERSION | \
829 BTRFS_SEND_FLAG_COMPRESSED)
831 struct btrfs_ioctl_send_args {
832 __s64 send_fd; /* in */
833 __u64 clone_sources_count; /* in */
834 __u64 __user *clone_sources; /* in */
835 __u64 parent_root; /* in */
836 __u64 flags; /* in */
837 __u32 version; /* in */
838 __u8 reserved[28]; /* in */
842 * Information about a fs tree root.
844 * All items are filled by the ioctl
846 struct btrfs_ioctl_get_subvol_info_args {
847 /* Id of this subvolume */
850 /* Name of this subvolume, used to get the real name at mount point */
851 char name[BTRFS_VOL_NAME_MAX + 1];
854 * Id of the subvolume which contains this subvolume.
855 * Zero for top-level subvolume or a deleted subvolume.
860 * Inode number of the directory which contains this subvolume.
861 * Zero for top-level subvolume or a deleted subvolume
865 /* Latest transaction id of this subvolume */
868 /* Flags of this subvolume */
871 /* UUID of this subvolume */
872 __u8 uuid[BTRFS_UUID_SIZE];
875 * UUID of the subvolume of which this subvolume is a snapshot.
876 * All zero for a non-snapshot subvolume.
878 __u8 parent_uuid[BTRFS_UUID_SIZE];
881 * UUID of the subvolume from which this subvolume was received.
882 * All zero for non-received subvolume.
884 __u8 received_uuid[BTRFS_UUID_SIZE];
886 /* Transaction id indicating when change/create/send/receive happened */
891 /* Time corresponding to c/o/s/rtransid */
892 struct btrfs_ioctl_timespec ctime;
893 struct btrfs_ioctl_timespec otime;
894 struct btrfs_ioctl_timespec stime;
895 struct btrfs_ioctl_timespec rtime;
901 #define BTRFS_MAX_ROOTREF_BUFFER_NUM 255
902 struct btrfs_ioctl_get_subvol_rootref_args {
903 /* in/out, minimum id of rootref's treeid to be searched */
910 } rootref[BTRFS_MAX_ROOTREF_BUFFER_NUM];
912 /* out, number of found items */
918 * Data and metadata for an encoded read or write.
920 * Encoded I/O bypasses any encoding automatically done by the filesystem (e.g.,
921 * compression). This can be used to read the compressed contents of a file or
922 * write pre-compressed data directly to a file.
924 * BTRFS_IOC_ENCODED_READ and BTRFS_IOC_ENCODED_WRITE are essentially
925 * preadv/pwritev with additional metadata about how the data is encoded and the
926 * size of the unencoded data.
928 * BTRFS_IOC_ENCODED_READ fills the given iovecs with the encoded data, fills
929 * the metadata fields, and returns the size of the encoded data. It reads one
930 * extent per call. It can also read data which is not encoded.
932 * BTRFS_IOC_ENCODED_WRITE uses the metadata fields, writes the encoded data
933 * from the iovecs, and returns the size of the encoded data. Note that the
934 * encoded data is not validated when it is written; if it is not valid (e.g.,
935 * it cannot be decompressed), then a subsequent read may return an error.
937 * Since the filesystem page cache contains decoded data, encoded I/O bypasses
938 * the page cache. Encoded I/O requires CAP_SYS_ADMIN.
940 struct btrfs_ioctl_encoded_io_args {
941 /* Input parameters for both reads and writes. */
944 * iovecs containing encoded data.
946 * For reads, if the size of the encoded data is larger than the sum of
947 * iov[n].iov_len for 0 <= n < iovcnt, then the ioctl fails with
950 * For writes, the size of the encoded data is the sum of iov[n].iov_len
951 * for 0 <= n < iovcnt. This must be less than 128 KiB (this limit may
952 * increase in the future). This must also be less than or equal to
955 const struct iovec __user *iov;
956 /* Number of iovecs. */
957 unsigned long iovcnt;
961 * For writes, must be aligned to the sector size of the filesystem.
964 /* Currently must be zero. */
968 * For reads, the following members are output parameters that will
969 * contain the returned metadata for the encoded data.
970 * For writes, the following members must be set to the metadata for the
975 * Length of the data in the file.
977 * Must be less than or equal to unencoded_len - unencoded_offset. For
978 * writes, must be aligned to the sector size of the filesystem unless
979 * the data ends at or beyond the current end of the file.
983 * Length of the unencoded (i.e., decrypted and decompressed) data.
985 * For writes, must be no more than 128 KiB (this limit may increase in
986 * the future). If the unencoded data is actually longer than
987 * unencoded_len, then it is truncated; if it is shorter, then it is
988 * extended with zeroes.
992 * Offset from the first byte of the unencoded data to the first byte of
993 * logical data in the file.
995 * Must be less than unencoded_len.
997 __u64 unencoded_offset;
999 * BTRFS_ENCODED_IO_COMPRESSION_* type.
1001 * For writes, must not be BTRFS_ENCODED_IO_COMPRESSION_NONE.
1004 /* Currently always BTRFS_ENCODED_IO_ENCRYPTION_NONE. */
1007 * Reserved for future expansion.
1009 * For reads, always returned as zero. Users should check for non-zero
1010 * bytes. If there are any, then the kernel has a newer version of this
1011 * structure with additional information that the user definition is
1014 * For writes, must be zeroed.
1019 /* Data is not compressed. */
1020 #define BTRFS_ENCODED_IO_COMPRESSION_NONE 0
1021 /* Data is compressed as a single zlib stream. */
1022 #define BTRFS_ENCODED_IO_COMPRESSION_ZLIB 1
1024 * Data is compressed as a single zstd frame with the windowLog compression
1025 * parameter set to no more than 17.
1027 #define BTRFS_ENCODED_IO_COMPRESSION_ZSTD 2
1029 * Data is compressed sector by sector (using the sector size indicated by the
1030 * name of the constant) with LZO1X and wrapped in the format documented in
1031 * fs/btrfs/lzo.c. For writes, the compression sector size must match the
1032 * filesystem sector size.
1034 #define BTRFS_ENCODED_IO_COMPRESSION_LZO_4K 3
1035 #define BTRFS_ENCODED_IO_COMPRESSION_LZO_8K 4
1036 #define BTRFS_ENCODED_IO_COMPRESSION_LZO_16K 5
1037 #define BTRFS_ENCODED_IO_COMPRESSION_LZO_32K 6
1038 #define BTRFS_ENCODED_IO_COMPRESSION_LZO_64K 7
1039 #define BTRFS_ENCODED_IO_COMPRESSION_TYPES 8
1041 /* Data is not encrypted. */
1042 #define BTRFS_ENCODED_IO_ENCRYPTION_NONE 0
1043 #define BTRFS_ENCODED_IO_ENCRYPTION_TYPES 1
1045 /* Error codes as returned by the kernel */
1046 enum btrfs_err_code {
1047 BTRFS_ERROR_DEV_RAID1_MIN_NOT_MET = 1,
1048 BTRFS_ERROR_DEV_RAID10_MIN_NOT_MET,
1049 BTRFS_ERROR_DEV_RAID5_MIN_NOT_MET,
1050 BTRFS_ERROR_DEV_RAID6_MIN_NOT_MET,
1051 BTRFS_ERROR_DEV_TGT_REPLACE,
1052 BTRFS_ERROR_DEV_MISSING_NOT_FOUND,
1053 BTRFS_ERROR_DEV_ONLY_WRITABLE,
1054 BTRFS_ERROR_DEV_EXCL_RUN_IN_PROGRESS,
1055 BTRFS_ERROR_DEV_RAID1C3_MIN_NOT_MET,
1056 BTRFS_ERROR_DEV_RAID1C4_MIN_NOT_MET,
1059 #define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
1060 struct btrfs_ioctl_vol_args)
1061 #define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
1062 struct btrfs_ioctl_vol_args)
1063 #define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
1064 struct btrfs_ioctl_vol_args)
1065 #define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
1066 struct btrfs_ioctl_vol_args)
1067 #define BTRFS_IOC_FORGET_DEV _IOW(BTRFS_IOCTL_MAGIC, 5, \
1068 struct btrfs_ioctl_vol_args)
1069 /* trans start and trans end are dangerous, and only for
1070 * use by applications that know how to avoid the
1071 * resulting deadlocks
1073 #define BTRFS_IOC_TRANS_START _IO(BTRFS_IOCTL_MAGIC, 6)
1074 #define BTRFS_IOC_TRANS_END _IO(BTRFS_IOCTL_MAGIC, 7)
1075 #define BTRFS_IOC_SYNC _IO(BTRFS_IOCTL_MAGIC, 8)
1077 #define BTRFS_IOC_CLONE _IOW(BTRFS_IOCTL_MAGIC, 9, int)
1078 #define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
1079 struct btrfs_ioctl_vol_args)
1080 #define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
1081 struct btrfs_ioctl_vol_args)
1082 #define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
1083 struct btrfs_ioctl_vol_args)
1085 #define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
1086 struct btrfs_ioctl_clone_range_args)
1088 #define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
1089 struct btrfs_ioctl_vol_args)
1090 #define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
1091 struct btrfs_ioctl_vol_args)
1092 #define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
1093 struct btrfs_ioctl_defrag_range_args)
1094 #define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
1095 struct btrfs_ioctl_search_args)
1096 #define BTRFS_IOC_TREE_SEARCH_V2 _IOWR(BTRFS_IOCTL_MAGIC, 17, \
1097 struct btrfs_ioctl_search_args_v2)
1098 #define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
1099 struct btrfs_ioctl_ino_lookup_args)
1100 #define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, __u64)
1101 #define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
1102 struct btrfs_ioctl_space_args)
1103 #define BTRFS_IOC_START_SYNC _IOR(BTRFS_IOCTL_MAGIC, 24, __u64)
1104 #define BTRFS_IOC_WAIT_SYNC _IOW(BTRFS_IOCTL_MAGIC, 22, __u64)
1105 #define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \
1106 struct btrfs_ioctl_vol_args_v2)
1107 #define BTRFS_IOC_SUBVOL_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 24, \
1108 struct btrfs_ioctl_vol_args_v2)
1109 #define BTRFS_IOC_SUBVOL_GETFLAGS _IOR(BTRFS_IOCTL_MAGIC, 25, __u64)
1110 #define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64)
1111 #define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \
1112 struct btrfs_ioctl_scrub_args)
1113 #define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28)
1114 #define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \
1115 struct btrfs_ioctl_scrub_args)
1116 #define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \
1117 struct btrfs_ioctl_dev_info_args)
1118 #define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \
1119 struct btrfs_ioctl_fs_info_args)
1120 #define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \
1121 struct btrfs_ioctl_balance_args)
1122 #define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int)
1123 #define BTRFS_IOC_BALANCE_PROGRESS _IOR(BTRFS_IOCTL_MAGIC, 34, \
1124 struct btrfs_ioctl_balance_args)
1125 #define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \
1126 struct btrfs_ioctl_ino_path_args)
1127 #define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \
1128 struct btrfs_ioctl_logical_ino_args)
1129 #define BTRFS_IOC_SET_RECEIVED_SUBVOL _IOWR(BTRFS_IOCTL_MAGIC, 37, \
1130 struct btrfs_ioctl_received_subvol_args)
1131 #define BTRFS_IOC_SEND _IOW(BTRFS_IOCTL_MAGIC, 38, struct btrfs_ioctl_send_args)
1132 #define BTRFS_IOC_DEVICES_READY _IOR(BTRFS_IOCTL_MAGIC, 39, \
1133 struct btrfs_ioctl_vol_args)
1134 #define BTRFS_IOC_QUOTA_CTL _IOWR(BTRFS_IOCTL_MAGIC, 40, \
1135 struct btrfs_ioctl_quota_ctl_args)
1136 #define BTRFS_IOC_QGROUP_ASSIGN _IOW(BTRFS_IOCTL_MAGIC, 41, \
1137 struct btrfs_ioctl_qgroup_assign_args)
1138 #define BTRFS_IOC_QGROUP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 42, \
1139 struct btrfs_ioctl_qgroup_create_args)
1140 #define BTRFS_IOC_QGROUP_LIMIT _IOR(BTRFS_IOCTL_MAGIC, 43, \
1141 struct btrfs_ioctl_qgroup_limit_args)
1142 #define BTRFS_IOC_QUOTA_RESCAN _IOW(BTRFS_IOCTL_MAGIC, 44, \
1143 struct btrfs_ioctl_quota_rescan_args)
1144 #define BTRFS_IOC_QUOTA_RESCAN_STATUS _IOR(BTRFS_IOCTL_MAGIC, 45, \
1145 struct btrfs_ioctl_quota_rescan_args)
1146 #define BTRFS_IOC_QUOTA_RESCAN_WAIT _IO(BTRFS_IOCTL_MAGIC, 46)
1147 #define BTRFS_IOC_GET_FSLABEL FS_IOC_GETFSLABEL
1148 #define BTRFS_IOC_SET_FSLABEL FS_IOC_SETFSLABEL
1149 #define BTRFS_IOC_GET_DEV_STATS _IOWR(BTRFS_IOCTL_MAGIC, 52, \
1150 struct btrfs_ioctl_get_dev_stats)
1151 #define BTRFS_IOC_DEV_REPLACE _IOWR(BTRFS_IOCTL_MAGIC, 53, \
1152 struct btrfs_ioctl_dev_replace_args)
1153 #define BTRFS_IOC_FILE_EXTENT_SAME _IOWR(BTRFS_IOCTL_MAGIC, 54, \
1154 struct btrfs_ioctl_same_args)
1155 #define BTRFS_IOC_GET_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
1156 struct btrfs_ioctl_feature_flags)
1157 #define BTRFS_IOC_SET_FEATURES _IOW(BTRFS_IOCTL_MAGIC, 57, \
1158 struct btrfs_ioctl_feature_flags[2])
1159 #define BTRFS_IOC_GET_SUPPORTED_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
1160 struct btrfs_ioctl_feature_flags[3])
1161 #define BTRFS_IOC_RM_DEV_V2 _IOW(BTRFS_IOCTL_MAGIC, 58, \
1162 struct btrfs_ioctl_vol_args_v2)
1163 #define BTRFS_IOC_LOGICAL_INO_V2 _IOWR(BTRFS_IOCTL_MAGIC, 59, \
1164 struct btrfs_ioctl_logical_ino_args)
1165 #define BTRFS_IOC_GET_SUBVOL_INFO _IOR(BTRFS_IOCTL_MAGIC, 60, \
1166 struct btrfs_ioctl_get_subvol_info_args)
1167 #define BTRFS_IOC_GET_SUBVOL_ROOTREF _IOWR(BTRFS_IOCTL_MAGIC, 61, \
1168 struct btrfs_ioctl_get_subvol_rootref_args)
1169 #define BTRFS_IOC_INO_LOOKUP_USER _IOWR(BTRFS_IOCTL_MAGIC, 62, \
1170 struct btrfs_ioctl_ino_lookup_user_args)
1171 #define BTRFS_IOC_SNAP_DESTROY_V2 _IOW(BTRFS_IOCTL_MAGIC, 63, \
1172 struct btrfs_ioctl_vol_args_v2)
1173 #define BTRFS_IOC_ENCODED_READ _IOR(BTRFS_IOCTL_MAGIC, 64, \
1174 struct btrfs_ioctl_encoded_io_args)
1175 #define BTRFS_IOC_ENCODED_WRITE _IOW(BTRFS_IOCTL_MAGIC, 64, \
1176 struct btrfs_ioctl_encoded_io_args)
1182 #endif /* _UAPI_LINUX_BTRFS_H */