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
22 #include <linux/types.h>
23 #include <linux/ioctl.h>
25 #define BTRFS_IOCTL_MAGIC 0x94
26 #define BTRFS_VOL_NAME_MAX 255
27 #define BTRFS_LABEL_SIZE 256
29 /* this should be 4k */
30 #define BTRFS_PATH_NAME_MAX 4087
31 struct btrfs_ioctl_vol_args {
33 char name[BTRFS_PATH_NAME_MAX + 1];
36 #define BTRFS_DEVICE_PATH_NAME_MAX 1024
37 #define BTRFS_SUBVOL_NAME_MAX 4039
40 /* Deprecated since 5.7 */
41 # 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_DEVICE_SPEC_BY_ID (1ULL << 3)
48 #define BTRFS_SUBVOL_SPEC_BY_ID (1ULL << 4)
50 #define BTRFS_VOL_ARG_V2_FLAGS_SUPPORTED \
51 (BTRFS_SUBVOL_RDONLY | \
52 BTRFS_SUBVOL_QGROUP_INHERIT | \
53 BTRFS_DEVICE_SPEC_BY_ID | \
54 BTRFS_SUBVOL_SPEC_BY_ID)
56 #define BTRFS_FSID_SIZE 16
57 #define BTRFS_UUID_SIZE 16
58 #define BTRFS_UUID_UNPARSED_SIZE 37
61 * flags definition for qgroup limits
64 * struct btrfs_qgroup_limit.flags
65 * struct btrfs_qgroup_limit_item.flags
67 #define BTRFS_QGROUP_LIMIT_MAX_RFER (1ULL << 0)
68 #define BTRFS_QGROUP_LIMIT_MAX_EXCL (1ULL << 1)
69 #define BTRFS_QGROUP_LIMIT_RSV_RFER (1ULL << 2)
70 #define BTRFS_QGROUP_LIMIT_RSV_EXCL (1ULL << 3)
71 #define BTRFS_QGROUP_LIMIT_RFER_CMPR (1ULL << 4)
72 #define BTRFS_QGROUP_LIMIT_EXCL_CMPR (1ULL << 5)
74 struct btrfs_qgroup_limit {
83 * flags definition for qgroup inheritance
86 * struct btrfs_qgroup_inherit.flags
88 #define BTRFS_QGROUP_INHERIT_SET_LIMITS (1ULL << 0)
90 struct btrfs_qgroup_inherit {
94 __u64 num_excl_copies;
95 struct btrfs_qgroup_limit lim;
99 struct btrfs_ioctl_qgroup_limit_args {
101 struct btrfs_qgroup_limit lim;
105 * Arguments for specification of subvolumes or devices, supporting by-name or
108 * The set of supported flags depends on the ioctl
110 * BTRFS_SUBVOL_RDONLY is also provided/consumed by the following ioctls:
111 * - BTRFS_IOC_SUBVOL_GETFLAGS
112 * - BTRFS_IOC_SUBVOL_SETFLAGS
115 /* Supported flags for BTRFS_IOC_RM_DEV_V2 */
116 #define BTRFS_DEVICE_REMOVE_ARGS_MASK \
117 (BTRFS_DEVICE_SPEC_BY_ID)
119 /* Supported flags for BTRFS_IOC_SNAP_CREATE_V2 and BTRFS_IOC_SUBVOL_CREATE_V2 */
120 #define BTRFS_SUBVOL_CREATE_ARGS_MASK \
121 (BTRFS_SUBVOL_RDONLY | \
122 BTRFS_SUBVOL_QGROUP_INHERIT)
124 /* Supported flags for BTRFS_IOC_SNAP_DESTROY_V2 */
125 #define BTRFS_SUBVOL_DELETE_ARGS_MASK \
126 (BTRFS_SUBVOL_SPEC_BY_ID)
128 struct btrfs_ioctl_vol_args_v2 {
135 struct btrfs_qgroup_inherit __user *qgroup_inherit;
140 char name[BTRFS_SUBVOL_NAME_MAX + 1];
147 * structure to report errors and progress to userspace, either as a
148 * result of a finished scrub, a canceled scrub or a progress inquiry
150 struct btrfs_scrub_progress {
151 __u64 data_extents_scrubbed; /* # of data extents scrubbed */
152 __u64 tree_extents_scrubbed; /* # of tree extents scrubbed */
153 __u64 data_bytes_scrubbed; /* # of data bytes scrubbed */
154 __u64 tree_bytes_scrubbed; /* # of tree bytes scrubbed */
155 __u64 read_errors; /* # of read errors encountered (EIO) */
156 __u64 csum_errors; /* # of failed csum checks */
157 __u64 verify_errors; /* # of occurrences, where the metadata
158 * of a tree block did not match the
159 * expected values, like generation or
161 __u64 no_csum; /* # of 4k data block for which no csum
162 * is present, probably the result of
163 * data written with nodatasum */
164 __u64 csum_discards; /* # of csum for which no data was found
165 * in the extent tree. */
166 __u64 super_errors; /* # of bad super blocks encountered */
167 __u64 malloc_errors; /* # of internal kmalloc errors. These
168 * will likely cause an incomplete
170 __u64 uncorrectable_errors; /* # of errors where either no intact
171 * copy was found or the writeback
173 __u64 corrected_errors; /* # of errors corrected */
174 __u64 last_physical; /* last physical address scrubbed. In
175 * case a scrub was aborted, this can
176 * be used to restart the scrub */
177 __u64 unverified_errors; /* # of occurrences where a read for a
178 * full (64k) bio failed, but the re-
179 * check succeeded for each 4k piece.
180 * Intermittent error. */
183 #define BTRFS_SCRUB_READONLY 1
184 #define BTRFS_SCRUB_SUPPORTED_FLAGS (BTRFS_SCRUB_READONLY)
185 struct btrfs_ioctl_scrub_args {
186 __u64 devid; /* in */
187 __u64 start; /* in */
189 __u64 flags; /* in */
190 struct btrfs_scrub_progress progress; /* out */
192 __u64 unused[(1024-32-sizeof(struct btrfs_scrub_progress))/8];
195 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_ALWAYS 0
196 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_AVOID 1
197 struct btrfs_ioctl_dev_replace_start_params {
198 __u64 srcdevid; /* in, if 0, use srcdev_name instead */
199 __u64 cont_reading_from_srcdev_mode; /* in, see #define
201 __u8 srcdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1]; /* in */
202 __u8 tgtdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1]; /* in */
205 #define BTRFS_IOCTL_DEV_REPLACE_STATE_NEVER_STARTED 0
206 #define BTRFS_IOCTL_DEV_REPLACE_STATE_STARTED 1
207 #define BTRFS_IOCTL_DEV_REPLACE_STATE_FINISHED 2
208 #define BTRFS_IOCTL_DEV_REPLACE_STATE_CANCELED 3
209 #define BTRFS_IOCTL_DEV_REPLACE_STATE_SUSPENDED 4
210 struct btrfs_ioctl_dev_replace_status_params {
211 __u64 replace_state; /* out, see #define above */
212 __u64 progress_1000; /* out, 0 <= x <= 1000 */
213 __u64 time_started; /* out, seconds since 1-Jan-1970 */
214 __u64 time_stopped; /* out, seconds since 1-Jan-1970 */
215 __u64 num_write_errors; /* out */
216 __u64 num_uncorrectable_read_errors; /* out */
219 #define BTRFS_IOCTL_DEV_REPLACE_CMD_START 0
220 #define BTRFS_IOCTL_DEV_REPLACE_CMD_STATUS 1
221 #define BTRFS_IOCTL_DEV_REPLACE_CMD_CANCEL 2
222 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NO_ERROR 0
223 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NOT_STARTED 1
224 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_ALREADY_STARTED 2
225 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_SCRUB_INPROGRESS 3
226 struct btrfs_ioctl_dev_replace_args {
228 __u64 result; /* out */
231 struct btrfs_ioctl_dev_replace_start_params start;
232 struct btrfs_ioctl_dev_replace_status_params status;
238 struct btrfs_ioctl_dev_info_args {
239 __u64 devid; /* in/out */
240 __u8 uuid[BTRFS_UUID_SIZE]; /* in/out */
241 __u64 bytes_used; /* out */
242 __u64 total_bytes; /* out */
243 __u64 unused[379]; /* pad to 4k */
244 __u8 path[BTRFS_DEVICE_PATH_NAME_MAX]; /* out */
248 * Retrieve information about the filesystem
251 /* Request information about checksum type and size */
252 #define BTRFS_FS_INFO_FLAG_CSUM_INFO (1 << 0)
254 /* Request information about filesystem generation */
255 #define BTRFS_FS_INFO_FLAG_GENERATION (1 << 1)
256 /* Request information about filesystem metadata UUID */
257 #define BTRFS_FS_INFO_FLAG_METADATA_UUID (1 << 2)
259 struct btrfs_ioctl_fs_info_args {
260 __u64 max_id; /* out */
261 __u64 num_devices; /* out */
262 __u8 fsid[BTRFS_FSID_SIZE]; /* out */
263 __u32 nodesize; /* out */
264 __u32 sectorsize; /* out */
265 __u32 clone_alignment; /* out */
266 /* See BTRFS_FS_INFO_FLAG_* */
267 __u16 csum_type; /* out */
268 __u16 csum_size; /* out */
269 __u64 flags; /* in/out */
270 __u64 generation; /* out */
271 __u8 metadata_uuid[BTRFS_FSID_SIZE]; /* out */
272 __u8 reserved[944]; /* pad to 1k */
279 * struct btrfs_ioctl_feature_flags
281 #define BTRFS_FEATURE_COMPAT_RO_FREE_SPACE_TREE (1ULL << 0)
283 * Older kernels (< 4.9) on big-endian systems produced broken free space tree
284 * bitmaps, and btrfs-progs also used to corrupt the free space tree (versions
285 * < 4.7.3). If this bit is clear, then the free space tree cannot be trusted.
286 * btrfs-progs can also intentionally clear this bit to ask the kernel to
287 * rebuild the free space tree, however this might not work on older kernels
288 * that do not know about this bit. If not sure, clear the cache manually on
289 * first mount when booting older kernel versions.
291 #define BTRFS_FEATURE_COMPAT_RO_FREE_SPACE_TREE_VALID (1ULL << 1)
292 #define BTRFS_FEATURE_COMPAT_RO_VERITY (1ULL << 2)
295 * Put all block group items into a dedicated block group tree, greatly
296 * reducing mount time for large filesystem due to better locality.
298 #define BTRFS_FEATURE_COMPAT_RO_BLOCK_GROUP_TREE (1ULL << 3)
300 #define BTRFS_FEATURE_INCOMPAT_MIXED_BACKREF (1ULL << 0)
301 #define BTRFS_FEATURE_INCOMPAT_DEFAULT_SUBVOL (1ULL << 1)
302 #define BTRFS_FEATURE_INCOMPAT_MIXED_GROUPS (1ULL << 2)
303 #define BTRFS_FEATURE_INCOMPAT_COMPRESS_LZO (1ULL << 3)
304 #define BTRFS_FEATURE_INCOMPAT_COMPRESS_ZSTD (1ULL << 4)
307 * older kernels tried to do bigger metadata blocks, but the
308 * code was pretty buggy. Lets not let them try anymore.
310 #define BTRFS_FEATURE_INCOMPAT_BIG_METADATA (1ULL << 5)
312 #define BTRFS_FEATURE_INCOMPAT_EXTENDED_IREF (1ULL << 6)
313 #define BTRFS_FEATURE_INCOMPAT_RAID56 (1ULL << 7)
314 #define BTRFS_FEATURE_INCOMPAT_SKINNY_METADATA (1ULL << 8)
315 #define BTRFS_FEATURE_INCOMPAT_NO_HOLES (1ULL << 9)
316 #define BTRFS_FEATURE_INCOMPAT_METADATA_UUID (1ULL << 10)
317 #define BTRFS_FEATURE_INCOMPAT_RAID1C34 (1ULL << 11)
318 #define BTRFS_FEATURE_INCOMPAT_ZONED (1ULL << 12)
319 #define BTRFS_FEATURE_INCOMPAT_EXTENT_TREE_V2 (1ULL << 13)
321 struct btrfs_ioctl_feature_flags {
323 __u64 compat_ro_flags;
324 __u64 incompat_flags;
327 /* balance control ioctl modes */
328 #define BTRFS_BALANCE_CTL_PAUSE 1
329 #define BTRFS_BALANCE_CTL_CANCEL 2
332 * this is packed, because it should be exactly the same as its disk
333 * byte order counterpart (struct btrfs_disk_balance_args)
335 struct btrfs_balance_args {
355 * BTRFS_BALANCE_ARGS_LIMIT with value 'limit'
356 * BTRFS_BALANCE_ARGS_LIMIT_RANGE - the extend version can use minimum
360 __u64 limit; /* limit number of processed chunks */
368 * Process chunks that cross stripes_min..stripes_max devices,
369 * BTRFS_BALANCE_ARGS_STRIPES_RANGE
375 } __attribute__ ((__packed__));
377 /* report balance progress to userspace */
378 struct btrfs_balance_progress {
379 __u64 expected; /* estimated # of chunks that will be
380 * relocated to fulfill the request */
381 __u64 considered; /* # of chunks we have considered so far */
382 __u64 completed; /* # of chunks relocated so far */
386 * flags definition for balance
388 * Restriper's general type filter
391 * btrfs_ioctl_balance_args.flags
392 * btrfs_balance_control.flags (internal)
394 #define BTRFS_BALANCE_DATA (1ULL << 0)
395 #define BTRFS_BALANCE_SYSTEM (1ULL << 1)
396 #define BTRFS_BALANCE_METADATA (1ULL << 2)
398 #define BTRFS_BALANCE_TYPE_MASK (BTRFS_BALANCE_DATA | \
399 BTRFS_BALANCE_SYSTEM | \
400 BTRFS_BALANCE_METADATA)
402 #define BTRFS_BALANCE_FORCE (1ULL << 3)
403 #define BTRFS_BALANCE_RESUME (1ULL << 4)
406 * flags definitions for per-type balance args
411 * struct btrfs_balance_args
413 #define BTRFS_BALANCE_ARGS_PROFILES (1ULL << 0)
414 #define BTRFS_BALANCE_ARGS_USAGE (1ULL << 1)
415 #define BTRFS_BALANCE_ARGS_DEVID (1ULL << 2)
416 #define BTRFS_BALANCE_ARGS_DRANGE (1ULL << 3)
417 #define BTRFS_BALANCE_ARGS_VRANGE (1ULL << 4)
418 #define BTRFS_BALANCE_ARGS_LIMIT (1ULL << 5)
419 #define BTRFS_BALANCE_ARGS_LIMIT_RANGE (1ULL << 6)
420 #define BTRFS_BALANCE_ARGS_STRIPES_RANGE (1ULL << 7)
421 #define BTRFS_BALANCE_ARGS_USAGE_RANGE (1ULL << 10)
423 #define BTRFS_BALANCE_ARGS_MASK \
424 (BTRFS_BALANCE_ARGS_PROFILES | \
425 BTRFS_BALANCE_ARGS_USAGE | \
426 BTRFS_BALANCE_ARGS_DEVID | \
427 BTRFS_BALANCE_ARGS_DRANGE | \
428 BTRFS_BALANCE_ARGS_VRANGE | \
429 BTRFS_BALANCE_ARGS_LIMIT | \
430 BTRFS_BALANCE_ARGS_LIMIT_RANGE | \
431 BTRFS_BALANCE_ARGS_STRIPES_RANGE | \
432 BTRFS_BALANCE_ARGS_USAGE_RANGE)
435 * Profile changing flags. When SOFT is set we won't relocate chunk if
436 * it already has the target profile (even though it may be
439 #define BTRFS_BALANCE_ARGS_CONVERT (1ULL << 8)
440 #define BTRFS_BALANCE_ARGS_SOFT (1ULL << 9)
444 * flags definition for balance state
447 * struct btrfs_ioctl_balance_args.state
449 #define BTRFS_BALANCE_STATE_RUNNING (1ULL << 0)
450 #define BTRFS_BALANCE_STATE_PAUSE_REQ (1ULL << 1)
451 #define BTRFS_BALANCE_STATE_CANCEL_REQ (1ULL << 2)
453 struct btrfs_ioctl_balance_args {
454 __u64 flags; /* in/out */
455 __u64 state; /* out */
457 struct btrfs_balance_args data; /* in/out */
458 struct btrfs_balance_args meta; /* in/out */
459 struct btrfs_balance_args sys; /* in/out */
461 struct btrfs_balance_progress stat; /* out */
463 __u64 unused[72]; /* pad to 1k */
466 #define BTRFS_INO_LOOKUP_PATH_MAX 4080
467 struct btrfs_ioctl_ino_lookup_args {
470 char name[BTRFS_INO_LOOKUP_PATH_MAX];
473 #define BTRFS_INO_LOOKUP_USER_PATH_MAX (4080 - BTRFS_VOL_NAME_MAX - 1)
474 struct btrfs_ioctl_ino_lookup_user_args {
475 /* in, inode number containing the subvolume of 'subvolid' */
479 /* out, name of the subvolume of 'treeid' */
480 char name[BTRFS_VOL_NAME_MAX + 1];
482 * out, constructed path from the directory with which the ioctl is
485 char path[BTRFS_INO_LOOKUP_USER_PATH_MAX];
488 /* Search criteria for the btrfs SEARCH ioctl family. */
489 struct btrfs_ioctl_search_key {
491 * The tree we're searching in. 1 is the tree of tree roots, 2 is the
492 * extent tree, etc...
494 * A special tree_id value of 0 will cause a search in the subvolume
495 * tree that the inode which is passed to the ioctl is part of.
497 __u64 tree_id; /* in */
500 * When doing a tree search, we're actually taking a slice from a
501 * linear search space of 136-bit keys.
503 * A full 136-bit tree key is composed as:
504 * (objectid << 72) + (type << 64) + offset
506 * The individual min and max values for objectid, type and offset
507 * define the min_key and max_key values for the search range. All
508 * metadata items with a key in the interval [min_key, max_key] will be
511 * Additionally, we can filter the items returned on transaction id of
512 * the metadata block they're stored in by specifying a transid range.
513 * Be aware that this transaction id only denotes when the metadata
514 * page that currently contains the item got written the last time as
515 * result of a COW operation. The number does not have any meaning
516 * related to the transaction in which an individual item that is being
517 * returned was created or changed.
519 __u64 min_objectid; /* in */
520 __u64 max_objectid; /* in */
521 __u64 min_offset; /* in */
522 __u64 max_offset; /* in */
523 __u64 min_transid; /* in */
524 __u64 max_transid; /* in */
525 __u32 min_type; /* in */
526 __u32 max_type; /* in */
529 * input: The maximum amount of results desired.
530 * output: The actual amount of items returned, restricted by any of:
531 * - reaching the upper bound of the search range
532 * - reaching the input nr_items amount of items
533 * - completely filling the supplied memory buffer
535 __u32 nr_items; /* in/out */
537 /* align to 64 bits */
540 /* some extra for later */
547 struct btrfs_ioctl_search_header {
555 #define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
557 * the buf is an array of search headers where
558 * each header is followed by the actual item
559 * the type field is expanded to 32 bits for alignment
561 struct btrfs_ioctl_search_args {
562 struct btrfs_ioctl_search_key key;
563 char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
566 struct btrfs_ioctl_search_args_v2 {
567 struct btrfs_ioctl_search_key key; /* in/out - search parameters */
568 __u64 buf_size; /* in - size of buffer
569 * out - on EOVERFLOW: needed size
571 __u64 buf[]; /* out - found items */
574 struct btrfs_ioctl_clone_range_args {
576 __u64 src_offset, src_length;
581 * flags definition for the defrag range ioctl
584 * struct btrfs_ioctl_defrag_range_args.flags
586 #define BTRFS_DEFRAG_RANGE_COMPRESS 1
587 #define BTRFS_DEFRAG_RANGE_START_IO 2
588 #define BTRFS_DEFRAG_RANGE_FLAGS_SUPP (BTRFS_DEFRAG_RANGE_COMPRESS | \
589 BTRFS_DEFRAG_RANGE_START_IO)
591 struct btrfs_ioctl_defrag_range_args {
592 /* start of the defrag operation */
595 /* number of bytes to defrag, use (u64)-1 to say all */
599 * flags for the operation, which can include turning
600 * on compression for this one defrag
605 * any extent bigger than this will be considered
606 * already defragged. Use 0 to take the kernel default
607 * Use 1 to say every single extent must be rewritten
612 * which compression method to use if turning on compression
613 * for this defrag operation. If unspecified, zlib will
618 /* spare for later */
623 #define BTRFS_SAME_DATA_DIFFERS 1
624 /* For extent-same ioctl */
625 struct btrfs_ioctl_same_extent_info {
626 __s64 fd; /* in - destination file */
627 __u64 logical_offset; /* in - start of extent in destination */
628 __u64 bytes_deduped; /* out - total # of bytes we were able
629 * to dedupe from this file */
630 /* status of this dedupe operation:
631 * 0 if dedup succeeds
633 * == BTRFS_SAME_DATA_DIFFERS if data differs
635 __s32 status; /* out - see above description */
639 struct btrfs_ioctl_same_args {
640 __u64 logical_offset; /* in - start of extent in source */
641 __u64 length; /* in - length of extent */
642 __u16 dest_count; /* in - total elements in info array */
645 struct btrfs_ioctl_same_extent_info info[];
648 struct btrfs_ioctl_space_info {
654 struct btrfs_ioctl_space_args {
657 struct btrfs_ioctl_space_info spaces[];
660 struct btrfs_data_container {
661 __u32 bytes_left; /* out -- bytes not needed to deliver output */
662 __u32 bytes_missing; /* out -- additional bytes needed for result */
663 __u32 elem_cnt; /* out */
664 __u32 elem_missed; /* out */
665 __u64 val[]; /* out */
668 struct btrfs_ioctl_ino_path_args {
672 /* struct btrfs_data_container *fspath; out */
673 __u64 fspath; /* out */
676 struct btrfs_ioctl_logical_ino_args {
677 __u64 logical; /* in */
679 __u64 reserved[3]; /* must be 0 for now */
680 __u64 flags; /* in, v2 only */
681 /* struct btrfs_data_container *inodes; out */
684 /* Return every ref to the extent, not just those containing logical block.
685 * Requires logical == extent bytenr. */
686 #define BTRFS_LOGICAL_INO_ARGS_IGNORE_OFFSET (1ULL << 0)
688 enum btrfs_dev_stat_values {
689 /* disk I/O failure stats */
690 BTRFS_DEV_STAT_WRITE_ERRS, /* EIO or EREMOTEIO from lower layers */
691 BTRFS_DEV_STAT_READ_ERRS, /* EIO or EREMOTEIO from lower layers */
692 BTRFS_DEV_STAT_FLUSH_ERRS, /* EIO or EREMOTEIO from lower layers */
694 /* stats for indirect indications for I/O failures */
695 BTRFS_DEV_STAT_CORRUPTION_ERRS, /* checksum error, bytenr error or
696 * contents is illegal: this is an
697 * indication that the block was damaged
698 * during read or write, or written to
699 * wrong location or read from wrong
701 BTRFS_DEV_STAT_GENERATION_ERRS, /* an indication that blocks have not
704 BTRFS_DEV_STAT_VALUES_MAX
707 /* Reset statistics after reading; needs SYS_ADMIN capability */
708 #define BTRFS_DEV_STATS_RESET (1ULL << 0)
710 struct btrfs_ioctl_get_dev_stats {
711 __u64 devid; /* in */
712 __u64 nr_items; /* in/out */
713 __u64 flags; /* in/out */
716 __u64 values[BTRFS_DEV_STAT_VALUES_MAX];
719 * This pads the struct to 1032 bytes. It was originally meant to pad to
720 * 1024 bytes, but when adding the flags field, the padding calculation
723 __u64 unused[128 - 2 - BTRFS_DEV_STAT_VALUES_MAX];
726 #define BTRFS_QUOTA_CTL_ENABLE 1
727 #define BTRFS_QUOTA_CTL_DISABLE 2
728 #define BTRFS_QUOTA_CTL_RESCAN__NOTUSED 3
729 struct btrfs_ioctl_quota_ctl_args {
734 struct btrfs_ioctl_quota_rescan_args {
740 struct btrfs_ioctl_qgroup_assign_args {
746 struct btrfs_ioctl_qgroup_create_args {
750 struct btrfs_ioctl_timespec {
755 struct btrfs_ioctl_received_subvol_args {
756 char uuid[BTRFS_UUID_SIZE]; /* in */
757 __u64 stransid; /* in */
758 __u64 rtransid; /* out */
759 struct btrfs_ioctl_timespec stime; /* in */
760 struct btrfs_ioctl_timespec rtime; /* out */
761 __u64 flags; /* in */
762 __u64 reserved[16]; /* in */
766 * Caller doesn't want file data in the send stream, even if the
767 * search of clone sources doesn't find an extent. UPDATE_EXTENT
768 * commands will be sent instead of WRITE commands.
770 #define BTRFS_SEND_FLAG_NO_FILE_DATA 0x1
773 * Do not add the leading stream header. Used when multiple snapshots
774 * are sent back to back.
776 #define BTRFS_SEND_FLAG_OMIT_STREAM_HEADER 0x2
779 * Omit the command at the end of the stream that indicated the end
780 * of the stream. This option is used when multiple snapshots are
783 #define BTRFS_SEND_FLAG_OMIT_END_CMD 0x4
786 * Read the protocol version in the structure
788 #define BTRFS_SEND_FLAG_VERSION 0x8
791 * Send compressed data using the ENCODED_WRITE command instead of decompressing
792 * the data and sending it with the WRITE command. This requires protocol
795 #define BTRFS_SEND_FLAG_COMPRESSED 0x10
797 #define BTRFS_SEND_FLAG_MASK \
798 (BTRFS_SEND_FLAG_NO_FILE_DATA | \
799 BTRFS_SEND_FLAG_OMIT_STREAM_HEADER | \
800 BTRFS_SEND_FLAG_OMIT_END_CMD | \
801 BTRFS_SEND_FLAG_VERSION | \
802 BTRFS_SEND_FLAG_COMPRESSED)
804 struct btrfs_ioctl_send_args {
805 __s64 send_fd; /* in */
806 __u64 clone_sources_count; /* in */
807 __u64 __user *clone_sources; /* in */
808 __u64 parent_root; /* in */
809 __u64 flags; /* in */
810 __u32 version; /* in */
811 __u8 reserved[28]; /* in */
815 * Information about a fs tree root.
817 * All items are filled by the ioctl
819 struct btrfs_ioctl_get_subvol_info_args {
820 /* Id of this subvolume */
823 /* Name of this subvolume, used to get the real name at mount point */
824 char name[BTRFS_VOL_NAME_MAX + 1];
827 * Id of the subvolume which contains this subvolume.
828 * Zero for top-level subvolume or a deleted subvolume.
833 * Inode number of the directory which contains this subvolume.
834 * Zero for top-level subvolume or a deleted subvolume
838 /* Latest transaction id of this subvolume */
841 /* Flags of this subvolume */
844 /* UUID of this subvolume */
845 __u8 uuid[BTRFS_UUID_SIZE];
848 * UUID of the subvolume of which this subvolume is a snapshot.
849 * All zero for a non-snapshot subvolume.
851 __u8 parent_uuid[BTRFS_UUID_SIZE];
854 * UUID of the subvolume from which this subvolume was received.
855 * All zero for non-received subvolume.
857 __u8 received_uuid[BTRFS_UUID_SIZE];
859 /* Transaction id indicating when change/create/send/receive happened */
864 /* Time corresponding to c/o/s/rtransid */
865 struct btrfs_ioctl_timespec ctime;
866 struct btrfs_ioctl_timespec otime;
867 struct btrfs_ioctl_timespec stime;
868 struct btrfs_ioctl_timespec rtime;
874 #define BTRFS_MAX_ROOTREF_BUFFER_NUM 255
875 struct btrfs_ioctl_get_subvol_rootref_args {
876 /* in/out, minimum id of rootref's treeid to be searched */
883 } rootref[BTRFS_MAX_ROOTREF_BUFFER_NUM];
885 /* out, number of found items */
891 * Data and metadata for an encoded read or write.
893 * Encoded I/O bypasses any encoding automatically done by the filesystem (e.g.,
894 * compression). This can be used to read the compressed contents of a file or
895 * write pre-compressed data directly to a file.
897 * BTRFS_IOC_ENCODED_READ and BTRFS_IOC_ENCODED_WRITE are essentially
898 * preadv/pwritev with additional metadata about how the data is encoded and the
899 * size of the unencoded data.
901 * BTRFS_IOC_ENCODED_READ fills the given iovecs with the encoded data, fills
902 * the metadata fields, and returns the size of the encoded data. It reads one
903 * extent per call. It can also read data which is not encoded.
905 * BTRFS_IOC_ENCODED_WRITE uses the metadata fields, writes the encoded data
906 * from the iovecs, and returns the size of the encoded data. Note that the
907 * encoded data is not validated when it is written; if it is not valid (e.g.,
908 * it cannot be decompressed), then a subsequent read may return an error.
910 * Since the filesystem page cache contains decoded data, encoded I/O bypasses
911 * the page cache. Encoded I/O requires CAP_SYS_ADMIN.
913 struct btrfs_ioctl_encoded_io_args {
914 /* Input parameters for both reads and writes. */
917 * iovecs containing encoded data.
919 * For reads, if the size of the encoded data is larger than the sum of
920 * iov[n].iov_len for 0 <= n < iovcnt, then the ioctl fails with
923 * For writes, the size of the encoded data is the sum of iov[n].iov_len
924 * for 0 <= n < iovcnt. This must be less than 128 KiB (this limit may
925 * increase in the future). This must also be less than or equal to
928 const struct iovec __user *iov;
929 /* Number of iovecs. */
930 unsigned long iovcnt;
934 * For writes, must be aligned to the sector size of the filesystem.
937 /* Currently must be zero. */
941 * For reads, the following members are output parameters that will
942 * contain the returned metadata for the encoded data.
943 * For writes, the following members must be set to the metadata for the
948 * Length of the data in the file.
950 * Must be less than or equal to unencoded_len - unencoded_offset. For
951 * writes, must be aligned to the sector size of the filesystem unless
952 * the data ends at or beyond the current end of the file.
956 * Length of the unencoded (i.e., decrypted and decompressed) data.
958 * For writes, must be no more than 128 KiB (this limit may increase in
959 * the future). If the unencoded data is actually longer than
960 * unencoded_len, then it is truncated; if it is shorter, then it is
961 * extended with zeroes.
965 * Offset from the first byte of the unencoded data to the first byte of
966 * logical data in the file.
968 * Must be less than unencoded_len.
970 __u64 unencoded_offset;
972 * BTRFS_ENCODED_IO_COMPRESSION_* type.
974 * For writes, must not be BTRFS_ENCODED_IO_COMPRESSION_NONE.
977 /* Currently always BTRFS_ENCODED_IO_ENCRYPTION_NONE. */
980 * Reserved for future expansion.
982 * For reads, always returned as zero. Users should check for non-zero
983 * bytes. If there are any, then the kernel has a newer version of this
984 * structure with additional information that the user definition is
987 * For writes, must be zeroed.
992 /* Data is not compressed. */
993 #define BTRFS_ENCODED_IO_COMPRESSION_NONE 0
994 /* Data is compressed as a single zlib stream. */
995 #define BTRFS_ENCODED_IO_COMPRESSION_ZLIB 1
997 * Data is compressed as a single zstd frame with the windowLog compression
998 * parameter set to no more than 17.
1000 #define BTRFS_ENCODED_IO_COMPRESSION_ZSTD 2
1002 * Data is compressed sector by sector (using the sector size indicated by the
1003 * name of the constant) with LZO1X and wrapped in the format documented in
1004 * fs/btrfs/lzo.c. For writes, the compression sector size must match the
1005 * filesystem sector size.
1007 #define BTRFS_ENCODED_IO_COMPRESSION_LZO_4K 3
1008 #define BTRFS_ENCODED_IO_COMPRESSION_LZO_8K 4
1009 #define BTRFS_ENCODED_IO_COMPRESSION_LZO_16K 5
1010 #define BTRFS_ENCODED_IO_COMPRESSION_LZO_32K 6
1011 #define BTRFS_ENCODED_IO_COMPRESSION_LZO_64K 7
1012 #define BTRFS_ENCODED_IO_COMPRESSION_TYPES 8
1014 /* Data is not encrypted. */
1015 #define BTRFS_ENCODED_IO_ENCRYPTION_NONE 0
1016 #define BTRFS_ENCODED_IO_ENCRYPTION_TYPES 1
1018 /* Error codes as returned by the kernel */
1019 enum btrfs_err_code {
1020 BTRFS_ERROR_DEV_RAID1_MIN_NOT_MET = 1,
1021 BTRFS_ERROR_DEV_RAID10_MIN_NOT_MET,
1022 BTRFS_ERROR_DEV_RAID5_MIN_NOT_MET,
1023 BTRFS_ERROR_DEV_RAID6_MIN_NOT_MET,
1024 BTRFS_ERROR_DEV_TGT_REPLACE,
1025 BTRFS_ERROR_DEV_MISSING_NOT_FOUND,
1026 BTRFS_ERROR_DEV_ONLY_WRITABLE,
1027 BTRFS_ERROR_DEV_EXCL_RUN_IN_PROGRESS,
1028 BTRFS_ERROR_DEV_RAID1C3_MIN_NOT_MET,
1029 BTRFS_ERROR_DEV_RAID1C4_MIN_NOT_MET,
1032 #define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
1033 struct btrfs_ioctl_vol_args)
1034 #define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
1035 struct btrfs_ioctl_vol_args)
1036 #define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
1037 struct btrfs_ioctl_vol_args)
1038 #define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
1039 struct btrfs_ioctl_vol_args)
1040 #define BTRFS_IOC_FORGET_DEV _IOW(BTRFS_IOCTL_MAGIC, 5, \
1041 struct btrfs_ioctl_vol_args)
1042 /* trans start and trans end are dangerous, and only for
1043 * use by applications that know how to avoid the
1044 * resulting deadlocks
1046 #define BTRFS_IOC_TRANS_START _IO(BTRFS_IOCTL_MAGIC, 6)
1047 #define BTRFS_IOC_TRANS_END _IO(BTRFS_IOCTL_MAGIC, 7)
1048 #define BTRFS_IOC_SYNC _IO(BTRFS_IOCTL_MAGIC, 8)
1050 #define BTRFS_IOC_CLONE _IOW(BTRFS_IOCTL_MAGIC, 9, int)
1051 #define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
1052 struct btrfs_ioctl_vol_args)
1053 #define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
1054 struct btrfs_ioctl_vol_args)
1055 #define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
1056 struct btrfs_ioctl_vol_args)
1058 #define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
1059 struct btrfs_ioctl_clone_range_args)
1061 #define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
1062 struct btrfs_ioctl_vol_args)
1063 #define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
1064 struct btrfs_ioctl_vol_args)
1065 #define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
1066 struct btrfs_ioctl_defrag_range_args)
1067 #define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
1068 struct btrfs_ioctl_search_args)
1069 #define BTRFS_IOC_TREE_SEARCH_V2 _IOWR(BTRFS_IOCTL_MAGIC, 17, \
1070 struct btrfs_ioctl_search_args_v2)
1071 #define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
1072 struct btrfs_ioctl_ino_lookup_args)
1073 #define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, __u64)
1074 #define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
1075 struct btrfs_ioctl_space_args)
1076 #define BTRFS_IOC_START_SYNC _IOR(BTRFS_IOCTL_MAGIC, 24, __u64)
1077 #define BTRFS_IOC_WAIT_SYNC _IOW(BTRFS_IOCTL_MAGIC, 22, __u64)
1078 #define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \
1079 struct btrfs_ioctl_vol_args_v2)
1080 #define BTRFS_IOC_SUBVOL_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 24, \
1081 struct btrfs_ioctl_vol_args_v2)
1082 #define BTRFS_IOC_SUBVOL_GETFLAGS _IOR(BTRFS_IOCTL_MAGIC, 25, __u64)
1083 #define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64)
1084 #define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \
1085 struct btrfs_ioctl_scrub_args)
1086 #define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28)
1087 #define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \
1088 struct btrfs_ioctl_scrub_args)
1089 #define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \
1090 struct btrfs_ioctl_dev_info_args)
1091 #define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \
1092 struct btrfs_ioctl_fs_info_args)
1093 #define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \
1094 struct btrfs_ioctl_balance_args)
1095 #define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int)
1096 #define BTRFS_IOC_BALANCE_PROGRESS _IOR(BTRFS_IOCTL_MAGIC, 34, \
1097 struct btrfs_ioctl_balance_args)
1098 #define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \
1099 struct btrfs_ioctl_ino_path_args)
1100 #define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \
1101 struct btrfs_ioctl_logical_ino_args)
1102 #define BTRFS_IOC_SET_RECEIVED_SUBVOL _IOWR(BTRFS_IOCTL_MAGIC, 37, \
1103 struct btrfs_ioctl_received_subvol_args)
1104 #define BTRFS_IOC_SEND _IOW(BTRFS_IOCTL_MAGIC, 38, struct btrfs_ioctl_send_args)
1105 #define BTRFS_IOC_DEVICES_READY _IOR(BTRFS_IOCTL_MAGIC, 39, \
1106 struct btrfs_ioctl_vol_args)
1107 #define BTRFS_IOC_QUOTA_CTL _IOWR(BTRFS_IOCTL_MAGIC, 40, \
1108 struct btrfs_ioctl_quota_ctl_args)
1109 #define BTRFS_IOC_QGROUP_ASSIGN _IOW(BTRFS_IOCTL_MAGIC, 41, \
1110 struct btrfs_ioctl_qgroup_assign_args)
1111 #define BTRFS_IOC_QGROUP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 42, \
1112 struct btrfs_ioctl_qgroup_create_args)
1113 #define BTRFS_IOC_QGROUP_LIMIT _IOR(BTRFS_IOCTL_MAGIC, 43, \
1114 struct btrfs_ioctl_qgroup_limit_args)
1115 #define BTRFS_IOC_QUOTA_RESCAN _IOW(BTRFS_IOCTL_MAGIC, 44, \
1116 struct btrfs_ioctl_quota_rescan_args)
1117 #define BTRFS_IOC_QUOTA_RESCAN_STATUS _IOR(BTRFS_IOCTL_MAGIC, 45, \
1118 struct btrfs_ioctl_quota_rescan_args)
1119 #define BTRFS_IOC_QUOTA_RESCAN_WAIT _IO(BTRFS_IOCTL_MAGIC, 46)
1120 #define BTRFS_IOC_GET_FSLABEL FS_IOC_GETFSLABEL
1121 #define BTRFS_IOC_SET_FSLABEL FS_IOC_SETFSLABEL
1122 #define BTRFS_IOC_GET_DEV_STATS _IOWR(BTRFS_IOCTL_MAGIC, 52, \
1123 struct btrfs_ioctl_get_dev_stats)
1124 #define BTRFS_IOC_DEV_REPLACE _IOWR(BTRFS_IOCTL_MAGIC, 53, \
1125 struct btrfs_ioctl_dev_replace_args)
1126 #define BTRFS_IOC_FILE_EXTENT_SAME _IOWR(BTRFS_IOCTL_MAGIC, 54, \
1127 struct btrfs_ioctl_same_args)
1128 #define BTRFS_IOC_GET_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
1129 struct btrfs_ioctl_feature_flags)
1130 #define BTRFS_IOC_SET_FEATURES _IOW(BTRFS_IOCTL_MAGIC, 57, \
1131 struct btrfs_ioctl_feature_flags[2])
1132 #define BTRFS_IOC_GET_SUPPORTED_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
1133 struct btrfs_ioctl_feature_flags[3])
1134 #define BTRFS_IOC_RM_DEV_V2 _IOW(BTRFS_IOCTL_MAGIC, 58, \
1135 struct btrfs_ioctl_vol_args_v2)
1136 #define BTRFS_IOC_LOGICAL_INO_V2 _IOWR(BTRFS_IOCTL_MAGIC, 59, \
1137 struct btrfs_ioctl_logical_ino_args)
1138 #define BTRFS_IOC_GET_SUBVOL_INFO _IOR(BTRFS_IOCTL_MAGIC, 60, \
1139 struct btrfs_ioctl_get_subvol_info_args)
1140 #define BTRFS_IOC_GET_SUBVOL_ROOTREF _IOWR(BTRFS_IOCTL_MAGIC, 61, \
1141 struct btrfs_ioctl_get_subvol_rootref_args)
1142 #define BTRFS_IOC_INO_LOOKUP_USER _IOWR(BTRFS_IOCTL_MAGIC, 62, \
1143 struct btrfs_ioctl_ino_lookup_user_args)
1144 #define BTRFS_IOC_SNAP_DESTROY_V2 _IOW(BTRFS_IOCTL_MAGIC, 63, \
1145 struct btrfs_ioctl_vol_args_v2)
1146 #define BTRFS_IOC_ENCODED_READ _IOR(BTRFS_IOCTL_MAGIC, 64, \
1147 struct btrfs_ioctl_encoded_io_args)
1148 #define BTRFS_IOC_ENCODED_WRITE _IOW(BTRFS_IOCTL_MAGIC, 64, \
1149 struct btrfs_ioctl_encoded_io_args)
1151 #endif /* _UAPI_LINUX_BTRFS_H */