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>
33 #define BTRFS_IOCTL_MAGIC 0x94
34 #define BTRFS_VOL_NAME_MAX 255
35 #define BTRFS_LABEL_SIZE 256
37 /* this should be 4k */
38 #define BTRFS_PATH_NAME_MAX 4087
39 struct btrfs_ioctl_vol_args
{
41 char name
[BTRFS_PATH_NAME_MAX
+ 1];
44 #define BTRFS_DEVICE_PATH_NAME_MAX 1024
45 #define BTRFS_SUBVOL_NAME_MAX 4039
48 /* Deprecated since 5.7 */
49 # define BTRFS_SUBVOL_CREATE_ASYNC (1ULL << 0)
51 #define BTRFS_SUBVOL_RDONLY (1ULL << 1)
52 #define BTRFS_SUBVOL_QGROUP_INHERIT (1ULL << 2)
54 #define BTRFS_DEVICE_SPEC_BY_ID (1ULL << 3)
56 #define BTRFS_SUBVOL_SPEC_BY_ID (1ULL << 4)
58 #define BTRFS_VOL_ARG_V2_FLAGS_SUPPORTED \
59 (BTRFS_SUBVOL_RDONLY | \
60 BTRFS_SUBVOL_QGROUP_INHERIT | \
61 BTRFS_DEVICE_SPEC_BY_ID | \
62 BTRFS_SUBVOL_SPEC_BY_ID)
64 #define BTRFS_FSID_SIZE 16
65 #define BTRFS_UUID_SIZE 16
66 #define BTRFS_UUID_UNPARSED_SIZE 37
69 * flags definition for qgroup limits
72 * struct btrfs_qgroup_limit.flags
73 * struct btrfs_qgroup_limit_item.flags
75 #define BTRFS_QGROUP_LIMIT_MAX_RFER (1ULL << 0)
76 #define BTRFS_QGROUP_LIMIT_MAX_EXCL (1ULL << 1)
77 #define BTRFS_QGROUP_LIMIT_RSV_RFER (1ULL << 2)
78 #define BTRFS_QGROUP_LIMIT_RSV_EXCL (1ULL << 3)
79 #define BTRFS_QGROUP_LIMIT_RFER_CMPR (1ULL << 4)
80 #define BTRFS_QGROUP_LIMIT_EXCL_CMPR (1ULL << 5)
82 struct btrfs_qgroup_limit
{
91 * flags definition for qgroup inheritance
94 * struct btrfs_qgroup_inherit.flags
96 #define BTRFS_QGROUP_INHERIT_SET_LIMITS (1ULL << 0)
98 struct btrfs_qgroup_inherit
{
101 __u64 num_ref_copies
;
102 __u64 num_excl_copies
;
103 struct btrfs_qgroup_limit lim
;
107 struct btrfs_ioctl_qgroup_limit_args
{
109 struct btrfs_qgroup_limit lim
;
113 * Arguments for specification of subvolumes or devices, supporting by-name or
116 * The set of supported flags depends on the ioctl
118 * BTRFS_SUBVOL_RDONLY is also provided/consumed by the following ioctls:
119 * - BTRFS_IOC_SUBVOL_GETFLAGS
120 * - BTRFS_IOC_SUBVOL_SETFLAGS
123 /* Supported flags for BTRFS_IOC_RM_DEV_V2 */
124 #define BTRFS_DEVICE_REMOVE_ARGS_MASK \
125 (BTRFS_DEVICE_SPEC_BY_ID)
127 /* Supported flags for BTRFS_IOC_SNAP_CREATE_V2 and BTRFS_IOC_SUBVOL_CREATE_V2 */
128 #define BTRFS_SUBVOL_CREATE_ARGS_MASK \
129 (BTRFS_SUBVOL_RDONLY | \
130 BTRFS_SUBVOL_QGROUP_INHERIT)
132 /* Supported flags for BTRFS_IOC_SNAP_DESTROY_V2 */
133 #define BTRFS_SUBVOL_DELETE_ARGS_MASK \
134 (BTRFS_SUBVOL_SPEC_BY_ID)
136 struct btrfs_ioctl_vol_args_v2
{
143 struct btrfs_qgroup_inherit
*qgroup_inherit
;
148 char name
[BTRFS_SUBVOL_NAME_MAX
+ 1];
155 * structure to report errors and progress to userspace, either as a
156 * result of a finished scrub, a canceled scrub or a progress inquiry
158 struct btrfs_scrub_progress
{
159 __u64 data_extents_scrubbed
; /* # of data extents scrubbed */
160 __u64 tree_extents_scrubbed
; /* # of tree extents scrubbed */
161 __u64 data_bytes_scrubbed
; /* # of data bytes scrubbed */
162 __u64 tree_bytes_scrubbed
; /* # of tree bytes scrubbed */
163 __u64 read_errors
; /* # of read errors encountered (EIO) */
164 __u64 csum_errors
; /* # of failed csum checks */
165 __u64 verify_errors
; /* # of occurrences, where the metadata
166 * of a tree block did not match the
167 * expected values, like generation or
169 __u64 no_csum
; /* # of 4k data block for which no csum
170 * is present, probably the result of
171 * data written with nodatasum */
172 __u64 csum_discards
; /* # of csum for which no data was found
173 * in the extent tree. */
174 __u64 super_errors
; /* # of bad super blocks encountered */
175 __u64 malloc_errors
; /* # of internal kmalloc errors. These
176 * will likely cause an incomplete
178 __u64 uncorrectable_errors
; /* # of errors where either no intact
179 * copy was found or the writeback
181 __u64 corrected_errors
; /* # of errors corrected */
182 __u64 last_physical
; /* last physical address scrubbed. In
183 * case a scrub was aborted, this can
184 * be used to restart the scrub */
185 __u64 unverified_errors
; /* # of occurrences where a read for a
186 * full (64k) bio failed, but the re-
187 * check succeeded for each 4k piece.
188 * Intermittent error. */
191 #define BTRFS_SCRUB_READONLY 1
192 #define BTRFS_SCRUB_SUPPORTED_FLAGS (BTRFS_SCRUB_READONLY)
193 struct btrfs_ioctl_scrub_args
{
194 __u64 devid
; /* in */
195 __u64 start
; /* in */
197 __u64 flags
; /* in */
198 struct btrfs_scrub_progress progress
; /* out */
200 __u64 unused
[(1024-32-sizeof(struct btrfs_scrub_progress
))/8];
203 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_ALWAYS 0
204 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_AVOID 1
205 struct btrfs_ioctl_dev_replace_start_params
{
206 __u64 srcdevid
; /* in, if 0, use srcdev_name instead */
207 __u64 cont_reading_from_srcdev_mode
; /* in, see #define
209 __u8 srcdev_name
[BTRFS_DEVICE_PATH_NAME_MAX
+ 1]; /* in */
210 __u8 tgtdev_name
[BTRFS_DEVICE_PATH_NAME_MAX
+ 1]; /* in */
213 #define BTRFS_IOCTL_DEV_REPLACE_STATE_NEVER_STARTED 0
214 #define BTRFS_IOCTL_DEV_REPLACE_STATE_STARTED 1
215 #define BTRFS_IOCTL_DEV_REPLACE_STATE_FINISHED 2
216 #define BTRFS_IOCTL_DEV_REPLACE_STATE_CANCELED 3
217 #define BTRFS_IOCTL_DEV_REPLACE_STATE_SUSPENDED 4
218 struct btrfs_ioctl_dev_replace_status_params
{
219 __u64 replace_state
; /* out, see #define above */
220 __u64 progress_1000
; /* out, 0 <= x <= 1000 */
221 __u64 time_started
; /* out, seconds since 1-Jan-1970 */
222 __u64 time_stopped
; /* out, seconds since 1-Jan-1970 */
223 __u64 num_write_errors
; /* out */
224 __u64 num_uncorrectable_read_errors
; /* out */
227 #define BTRFS_IOCTL_DEV_REPLACE_CMD_START 0
228 #define BTRFS_IOCTL_DEV_REPLACE_CMD_STATUS 1
229 #define BTRFS_IOCTL_DEV_REPLACE_CMD_CANCEL 2
230 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NO_ERROR 0
231 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NOT_STARTED 1
232 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_ALREADY_STARTED 2
233 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_SCRUB_INPROGRESS 3
234 struct btrfs_ioctl_dev_replace_args
{
236 __u64 result
; /* out */
239 struct btrfs_ioctl_dev_replace_start_params start
;
240 struct btrfs_ioctl_dev_replace_status_params status
;
246 struct btrfs_ioctl_dev_info_args
{
247 __u64 devid
; /* in/out */
248 __u8 uuid
[BTRFS_UUID_SIZE
]; /* in/out */
249 __u64 bytes_used
; /* out */
250 __u64 total_bytes
; /* out */
254 * Showing the fsid of the device, allowing user space to check if this
255 * device is a seeding one.
257 * Introduced in v6.3, thus user space still needs to check if kernel
258 * changed this value. Older kernel will not touch the values here.
260 __u8 fsid
[BTRFS_UUID_SIZE
];
261 __u64 unused
[377]; /* pad to 4k */
262 __u8 path
[BTRFS_DEVICE_PATH_NAME_MAX
]; /* out */
266 * Retrieve information about the filesystem
269 /* Request information about checksum type and size */
270 #define BTRFS_FS_INFO_FLAG_CSUM_INFO (1 << 0)
272 /* Request information about filesystem generation */
273 #define BTRFS_FS_INFO_FLAG_GENERATION (1 << 1)
274 /* Request information about filesystem metadata UUID */
275 #define BTRFS_FS_INFO_FLAG_METADATA_UUID (1 << 2)
277 struct btrfs_ioctl_fs_info_args
{
278 __u64 max_id
; /* out */
279 __u64 num_devices
; /* out */
280 __u8 fsid
[BTRFS_FSID_SIZE
]; /* out */
281 __u32 nodesize
; /* out */
282 __u32 sectorsize
; /* out */
283 __u32 clone_alignment
; /* out */
284 /* See BTRFS_FS_INFO_FLAG_* */
285 __u16 csum_type
; /* out */
286 __u16 csum_size
; /* out */
287 __u64 flags
; /* in/out */
288 __u64 generation
; /* out */
289 __u8 metadata_uuid
[BTRFS_FSID_SIZE
]; /* out */
290 __u8 reserved
[944]; /* pad to 1k */
297 * struct btrfs_ioctl_feature_flags
299 #define BTRFS_FEATURE_COMPAT_RO_FREE_SPACE_TREE (1ULL << 0)
301 * Older kernels (< 4.9) on big-endian systems produced broken free space tree
302 * bitmaps, and btrfs-progs also used to corrupt the free space tree (versions
303 * < 4.7.3). If this bit is clear, then the free space tree cannot be trusted.
304 * btrfs-progs can also intentionally clear this bit to ask the kernel to
305 * rebuild the free space tree, however this might not work on older kernels
306 * that do not know about this bit. If not sure, clear the cache manually on
307 * first mount when booting older kernel versions.
309 #define BTRFS_FEATURE_COMPAT_RO_FREE_SPACE_TREE_VALID (1ULL << 1)
310 #define BTRFS_FEATURE_COMPAT_RO_VERITY (1ULL << 2)
313 * Put all block group items into a dedicated block group tree, greatly
314 * reducing mount time for large filesystem due to better locality.
316 #define BTRFS_FEATURE_COMPAT_RO_BLOCK_GROUP_TREE (1ULL << 3)
318 #define BTRFS_FEATURE_INCOMPAT_MIXED_BACKREF (1ULL << 0)
319 #define BTRFS_FEATURE_INCOMPAT_DEFAULT_SUBVOL (1ULL << 1)
320 #define BTRFS_FEATURE_INCOMPAT_MIXED_GROUPS (1ULL << 2)
321 #define BTRFS_FEATURE_INCOMPAT_COMPRESS_LZO (1ULL << 3)
322 #define BTRFS_FEATURE_INCOMPAT_COMPRESS_ZSTD (1ULL << 4)
325 * older kernels tried to do bigger metadata blocks, but the
326 * code was pretty buggy. Lets not let them try anymore.
328 #define BTRFS_FEATURE_INCOMPAT_BIG_METADATA (1ULL << 5)
330 #define BTRFS_FEATURE_INCOMPAT_EXTENDED_IREF (1ULL << 6)
331 #define BTRFS_FEATURE_INCOMPAT_RAID56 (1ULL << 7)
332 #define BTRFS_FEATURE_INCOMPAT_SKINNY_METADATA (1ULL << 8)
333 #define BTRFS_FEATURE_INCOMPAT_NO_HOLES (1ULL << 9)
334 #define BTRFS_FEATURE_INCOMPAT_METADATA_UUID (1ULL << 10)
335 #define BTRFS_FEATURE_INCOMPAT_RAID1C34 (1ULL << 11)
336 #define BTRFS_FEATURE_INCOMPAT_ZONED (1ULL << 12)
337 #define BTRFS_FEATURE_INCOMPAT_EXTENT_TREE_V2 (1ULL << 13)
338 #define BTRFS_FEATURE_INCOMPAT_RAID_STRIPE_TREE (1ULL << 14)
339 #define BTRFS_FEATURE_INCOMPAT_SIMPLE_QUOTA (1ULL << 16)
341 struct btrfs_ioctl_feature_flags
{
343 __u64 compat_ro_flags
;
344 __u64 incompat_flags
;
347 /* balance control ioctl modes */
348 #define BTRFS_BALANCE_CTL_PAUSE 1
349 #define BTRFS_BALANCE_CTL_CANCEL 2
352 * this is packed, because it should be exactly the same as its disk
353 * byte order counterpart (struct btrfs_disk_balance_args)
355 struct btrfs_balance_args
{
360 * BTRFS_BALANCE_ARGS_USAGE with a single value means '0..N'
361 * BTRFS_BALANCE_ARGS_USAGE_RANGE - range syntax, min..max
381 * BTRFS_BALANCE_ARGS_LIMIT with value 'limit'
382 * BTRFS_BALANCE_ARGS_LIMIT_RANGE - the extend version can use minimum
386 __u64 limit
; /* limit number of processed chunks */
394 * Process chunks that cross stripes_min..stripes_max devices,
395 * BTRFS_BALANCE_ARGS_STRIPES_RANGE
401 } __attribute__ ((__packed__
));
403 /* report balance progress to userspace */
404 struct btrfs_balance_progress
{
405 __u64 expected
; /* estimated # of chunks that will be
406 * relocated to fulfill the request */
407 __u64 considered
; /* # of chunks we have considered so far */
408 __u64 completed
; /* # of chunks relocated so far */
412 * flags definition for balance
414 * Restriper's general type filter
417 * btrfs_ioctl_balance_args.flags
418 * btrfs_balance_control.flags (internal)
420 #define BTRFS_BALANCE_DATA (1ULL << 0)
421 #define BTRFS_BALANCE_SYSTEM (1ULL << 1)
422 #define BTRFS_BALANCE_METADATA (1ULL << 2)
424 #define BTRFS_BALANCE_TYPE_MASK (BTRFS_BALANCE_DATA | \
425 BTRFS_BALANCE_SYSTEM | \
426 BTRFS_BALANCE_METADATA)
428 #define BTRFS_BALANCE_FORCE (1ULL << 3)
429 #define BTRFS_BALANCE_RESUME (1ULL << 4)
432 * flags definitions for per-type balance args
437 * struct btrfs_balance_args
439 #define BTRFS_BALANCE_ARGS_PROFILES (1ULL << 0)
440 #define BTRFS_BALANCE_ARGS_USAGE (1ULL << 1)
441 #define BTRFS_BALANCE_ARGS_DEVID (1ULL << 2)
442 #define BTRFS_BALANCE_ARGS_DRANGE (1ULL << 3)
443 #define BTRFS_BALANCE_ARGS_VRANGE (1ULL << 4)
444 #define BTRFS_BALANCE_ARGS_LIMIT (1ULL << 5)
445 #define BTRFS_BALANCE_ARGS_LIMIT_RANGE (1ULL << 6)
446 #define BTRFS_BALANCE_ARGS_STRIPES_RANGE (1ULL << 7)
447 #define BTRFS_BALANCE_ARGS_USAGE_RANGE (1ULL << 10)
449 #define BTRFS_BALANCE_ARGS_MASK \
450 (BTRFS_BALANCE_ARGS_PROFILES | \
451 BTRFS_BALANCE_ARGS_USAGE | \
452 BTRFS_BALANCE_ARGS_DEVID | \
453 BTRFS_BALANCE_ARGS_DRANGE | \
454 BTRFS_BALANCE_ARGS_VRANGE | \
455 BTRFS_BALANCE_ARGS_LIMIT | \
456 BTRFS_BALANCE_ARGS_LIMIT_RANGE | \
457 BTRFS_BALANCE_ARGS_STRIPES_RANGE | \
458 BTRFS_BALANCE_ARGS_USAGE_RANGE)
461 * Profile changing flags. When SOFT is set we won't relocate chunk if
462 * it already has the target profile (even though it may be
465 #define BTRFS_BALANCE_ARGS_CONVERT (1ULL << 8)
466 #define BTRFS_BALANCE_ARGS_SOFT (1ULL << 9)
470 * flags definition for balance state
473 * struct btrfs_ioctl_balance_args.state
475 #define BTRFS_BALANCE_STATE_RUNNING (1ULL << 0)
476 #define BTRFS_BALANCE_STATE_PAUSE_REQ (1ULL << 1)
477 #define BTRFS_BALANCE_STATE_CANCEL_REQ (1ULL << 2)
479 struct btrfs_ioctl_balance_args
{
480 __u64 flags
; /* in/out */
481 __u64 state
; /* out */
483 struct btrfs_balance_args data
; /* in/out */
484 struct btrfs_balance_args meta
; /* in/out */
485 struct btrfs_balance_args sys
; /* in/out */
487 struct btrfs_balance_progress stat
; /* out */
489 __u64 unused
[72]; /* pad to 1k */
492 #define BTRFS_INO_LOOKUP_PATH_MAX 4080
493 struct btrfs_ioctl_ino_lookup_args
{
496 char name
[BTRFS_INO_LOOKUP_PATH_MAX
];
499 #define BTRFS_INO_LOOKUP_USER_PATH_MAX (4080 - BTRFS_VOL_NAME_MAX - 1)
500 struct btrfs_ioctl_ino_lookup_user_args
{
501 /* in, inode number containing the subvolume of 'subvolid' */
505 /* out, name of the subvolume of 'treeid' */
506 char name
[BTRFS_VOL_NAME_MAX
+ 1];
508 * out, constructed path from the directory with which the ioctl is
511 char path
[BTRFS_INO_LOOKUP_USER_PATH_MAX
];
514 /* Search criteria for the btrfs SEARCH ioctl family. */
515 struct btrfs_ioctl_search_key
{
517 * The tree we're searching in. 1 is the tree of tree roots, 2 is the
518 * extent tree, etc...
520 * A special tree_id value of 0 will cause a search in the subvolume
521 * tree that the inode which is passed to the ioctl is part of.
523 __u64 tree_id
; /* in */
526 * When doing a tree search, we're actually taking a slice from a
527 * linear search space of 136-bit keys.
529 * A full 136-bit tree key is composed as:
530 * (objectid << 72) + (type << 64) + offset
532 * The individual min and max values for objectid, type and offset
533 * define the min_key and max_key values for the search range. All
534 * metadata items with a key in the interval [min_key, max_key] will be
537 * Additionally, we can filter the items returned on transaction id of
538 * the metadata block they're stored in by specifying a transid range.
539 * Be aware that this transaction id only denotes when the metadata
540 * page that currently contains the item got written the last time as
541 * result of a COW operation. The number does not have any meaning
542 * related to the transaction in which an individual item that is being
543 * returned was created or changed.
545 __u64 min_objectid
; /* in */
546 __u64 max_objectid
; /* in */
547 __u64 min_offset
; /* in */
548 __u64 max_offset
; /* in */
549 __u64 min_transid
; /* in */
550 __u64 max_transid
; /* in */
551 __u32 min_type
; /* in */
552 __u32 max_type
; /* in */
555 * input: The maximum amount of results desired.
556 * output: The actual amount of items returned, restricted by any of:
557 * - reaching the upper bound of the search range
558 * - reaching the input nr_items amount of items
559 * - completely filling the supplied memory buffer
561 __u32 nr_items
; /* in/out */
563 /* align to 64 bits */
566 /* some extra for later */
573 struct btrfs_ioctl_search_header
{
579 } __attribute__ ((__may_alias__
));
581 #define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
583 * the buf is an array of search headers where
584 * each header is followed by the actual item
585 * the type field is expanded to 32 bits for alignment
587 struct btrfs_ioctl_search_args
{
588 struct btrfs_ioctl_search_key key
;
589 char buf
[BTRFS_SEARCH_ARGS_BUFSIZE
];
593 * Extended version of TREE_SEARCH ioctl that can return more than 4k of bytes.
594 * The allocated size of the buffer is set in buf_size.
596 struct btrfs_ioctl_search_args_v2
{
597 struct btrfs_ioctl_search_key key
; /* in/out - search parameters */
598 __u64 buf_size
; /* in - size of buffer
599 * out - on EOVERFLOW: needed size
601 __u64 buf
[]; /* out - found items */
604 /* With a @src_length of zero, the range from @src_offset->EOF is cloned! */
605 struct btrfs_ioctl_clone_range_args
{
607 __u64 src_offset
, src_length
;
612 * flags definition for the defrag range ioctl
615 * struct btrfs_ioctl_defrag_range_args.flags
617 #define BTRFS_DEFRAG_RANGE_COMPRESS 1
618 #define BTRFS_DEFRAG_RANGE_START_IO 2
619 #define BTRFS_DEFRAG_RANGE_FLAGS_SUPP (BTRFS_DEFRAG_RANGE_COMPRESS | \
620 BTRFS_DEFRAG_RANGE_START_IO)
622 struct btrfs_ioctl_defrag_range_args
{
623 /* start of the defrag operation */
626 /* number of bytes to defrag, use (u64)-1 to say all */
630 * flags for the operation, which can include turning
631 * on compression for this one defrag
636 * any extent bigger than this will be considered
637 * already defragged. Use 0 to take the kernel default
638 * Use 1 to say every single extent must be rewritten
643 * which compression method to use if turning on compression
644 * for this defrag operation. If unspecified, zlib will
649 /* spare for later */
654 #define BTRFS_SAME_DATA_DIFFERS 1
655 /* For extent-same ioctl */
656 struct btrfs_ioctl_same_extent_info
{
657 __s64 fd
; /* in - destination file */
658 __u64 logical_offset
; /* in - start of extent in destination */
659 __u64 bytes_deduped
; /* out - total # of bytes we were able
660 * to dedupe from this file */
661 /* status of this dedupe operation:
662 * 0 if dedup succeeds
664 * == BTRFS_SAME_DATA_DIFFERS if data differs
666 __s32 status
; /* out - see above description */
670 struct btrfs_ioctl_same_args
{
671 __u64 logical_offset
; /* in - start of extent in source */
672 __u64 length
; /* in - length of extent */
673 __u16 dest_count
; /* in - total elements in info array */
676 struct btrfs_ioctl_same_extent_info info
[];
679 struct btrfs_ioctl_space_info
{
685 struct btrfs_ioctl_space_args
{
688 struct btrfs_ioctl_space_info spaces
[];
691 struct btrfs_data_container
{
692 __u32 bytes_left
; /* out -- bytes not needed to deliver output */
693 __u32 bytes_missing
; /* out -- additional bytes needed for result */
694 __u32 elem_cnt
; /* out */
695 __u32 elem_missed
; /* out */
696 __u64 val
[]; /* out */
699 struct btrfs_ioctl_ino_path_args
{
703 /* struct btrfs_data_container *fspath; out */
704 __u64 fspath
; /* out */
707 struct btrfs_ioctl_logical_ino_args
{
708 __u64 logical
; /* in */
710 __u64 reserved
[3]; /* must be 0 for now */
711 __u64 flags
; /* in, v2 only */
712 /* struct btrfs_data_container *inodes; out */
717 * Return every ref to the extent, not just those containing logical block.
718 * Requires logical == extent bytenr.
720 #define BTRFS_LOGICAL_INO_ARGS_IGNORE_OFFSET (1ULL << 0)
722 enum btrfs_dev_stat_values
{
723 /* disk I/O failure stats */
724 BTRFS_DEV_STAT_WRITE_ERRS
, /* EIO or EREMOTEIO from lower layers */
725 BTRFS_DEV_STAT_READ_ERRS
, /* EIO or EREMOTEIO from lower layers */
726 BTRFS_DEV_STAT_FLUSH_ERRS
, /* EIO or EREMOTEIO from lower layers */
728 /* stats for indirect indications for I/O failures */
729 BTRFS_DEV_STAT_CORRUPTION_ERRS
, /* checksum error, bytenr error or
730 * contents is illegal: this is an
731 * indication that the block was damaged
732 * during read or write, or written to
733 * wrong location or read from wrong
735 BTRFS_DEV_STAT_GENERATION_ERRS
, /* an indication that blocks have not
738 BTRFS_DEV_STAT_VALUES_MAX
741 /* Reset statistics after reading; needs SYS_ADMIN capability */
742 #define BTRFS_DEV_STATS_RESET (1ULL << 0)
744 struct btrfs_ioctl_get_dev_stats
{
745 __u64 devid
; /* in */
746 __u64 nr_items
; /* in/out */
747 __u64 flags
; /* in/out */
750 __u64 values
[BTRFS_DEV_STAT_VALUES_MAX
];
753 * This pads the struct to 1032 bytes. It was originally meant to pad to
754 * 1024 bytes, but when adding the flags field, the padding calculation
757 __u64 unused
[128 - 2 - BTRFS_DEV_STAT_VALUES_MAX
];
760 #define BTRFS_QUOTA_CTL_ENABLE 1
761 #define BTRFS_QUOTA_CTL_DISABLE 2
762 #define BTRFS_QUOTA_CTL_RESCAN__NOTUSED 3
763 #define BTRFS_QUOTA_CTL_ENABLE_SIMPLE_QUOTA 4
764 struct btrfs_ioctl_quota_ctl_args
{
769 struct btrfs_ioctl_quota_rescan_args
{
775 struct btrfs_ioctl_qgroup_assign_args
{
781 struct btrfs_ioctl_qgroup_create_args
{
785 struct btrfs_ioctl_timespec
{
790 struct btrfs_ioctl_received_subvol_args
{
791 char uuid
[BTRFS_UUID_SIZE
]; /* in */
792 __u64 stransid
; /* in */
793 __u64 rtransid
; /* out */
794 struct btrfs_ioctl_timespec stime
; /* in */
795 struct btrfs_ioctl_timespec rtime
; /* out */
796 __u64 flags
; /* in */
797 __u64 reserved
[16]; /* in */
801 * Caller doesn't want file data in the send stream, even if the
802 * search of clone sources doesn't find an extent. UPDATE_EXTENT
803 * commands will be sent instead of WRITE commands.
805 #define BTRFS_SEND_FLAG_NO_FILE_DATA 0x1
808 * Do not add the leading stream header. Used when multiple snapshots
809 * are sent back to back.
811 #define BTRFS_SEND_FLAG_OMIT_STREAM_HEADER 0x2
814 * Omit the command at the end of the stream that indicated the end
815 * of the stream. This option is used when multiple snapshots are
818 #define BTRFS_SEND_FLAG_OMIT_END_CMD 0x4
821 * Read the protocol version in the structure
823 #define BTRFS_SEND_FLAG_VERSION 0x8
826 * Send compressed data using the ENCODED_WRITE command instead of decompressing
827 * the data and sending it with the WRITE command. This requires protocol
830 #define BTRFS_SEND_FLAG_COMPRESSED 0x10
832 #define BTRFS_SEND_FLAG_MASK \
833 (BTRFS_SEND_FLAG_NO_FILE_DATA | \
834 BTRFS_SEND_FLAG_OMIT_STREAM_HEADER | \
835 BTRFS_SEND_FLAG_OMIT_END_CMD | \
836 BTRFS_SEND_FLAG_VERSION | \
837 BTRFS_SEND_FLAG_COMPRESSED)
839 struct btrfs_ioctl_send_args
{
840 __s64 send_fd
; /* in */
841 __u64 clone_sources_count
; /* in */
842 __u64
*clone_sources
; /* in */
843 __u64 parent_root
; /* in */
844 __u64 flags
; /* in */
845 __u32 version
; /* in */
846 __u8 reserved
[28]; /* in */
850 * Information about a fs tree root.
852 * All items are filled by the ioctl
854 struct btrfs_ioctl_get_subvol_info_args
{
855 /* Id of this subvolume */
858 /* Name of this subvolume, used to get the real name at mount point */
859 char name
[BTRFS_VOL_NAME_MAX
+ 1];
862 * Id of the subvolume which contains this subvolume.
863 * Zero for top-level subvolume or a deleted subvolume.
868 * Inode number of the directory which contains this subvolume.
869 * Zero for top-level subvolume or a deleted subvolume
873 /* Latest transaction id of this subvolume */
876 /* Flags of this subvolume */
879 /* UUID of this subvolume */
880 __u8 uuid
[BTRFS_UUID_SIZE
];
883 * UUID of the subvolume of which this subvolume is a snapshot.
884 * All zero for a non-snapshot subvolume.
886 __u8 parent_uuid
[BTRFS_UUID_SIZE
];
889 * UUID of the subvolume from which this subvolume was received.
890 * All zero for non-received subvolume.
892 __u8 received_uuid
[BTRFS_UUID_SIZE
];
894 /* Transaction id indicating when change/create/send/receive happened */
899 /* Time corresponding to c/o/s/rtransid */
900 struct btrfs_ioctl_timespec ctime
;
901 struct btrfs_ioctl_timespec otime
;
902 struct btrfs_ioctl_timespec stime
;
903 struct btrfs_ioctl_timespec rtime
;
909 #define BTRFS_MAX_ROOTREF_BUFFER_NUM 255
910 struct btrfs_ioctl_get_subvol_rootref_args
{
911 /* in/out, minimum id of rootref's treeid to be searched */
918 } rootref
[BTRFS_MAX_ROOTREF_BUFFER_NUM
];
920 /* out, number of found items */
926 * Data and metadata for an encoded read or write.
928 * Encoded I/O bypasses any encoding automatically done by the filesystem (e.g.,
929 * compression). This can be used to read the compressed contents of a file or
930 * write pre-compressed data directly to a file.
932 * BTRFS_IOC_ENCODED_READ and BTRFS_IOC_ENCODED_WRITE are essentially
933 * preadv/pwritev with additional metadata about how the data is encoded and the
934 * size of the unencoded data.
936 * BTRFS_IOC_ENCODED_READ fills the given iovecs with the encoded data, fills
937 * the metadata fields, and returns the size of the encoded data. It reads one
938 * extent per call. It can also read data which is not encoded.
940 * BTRFS_IOC_ENCODED_WRITE uses the metadata fields, writes the encoded data
941 * from the iovecs, and returns the size of the encoded data. Note that the
942 * encoded data is not validated when it is written; if it is not valid (e.g.,
943 * it cannot be decompressed), then a subsequent read may return an error.
945 * Since the filesystem page cache contains decoded data, encoded I/O bypasses
946 * the page cache. Encoded I/O requires CAP_SYS_ADMIN.
948 struct btrfs_ioctl_encoded_io_args
{
949 /* Input parameters for both reads and writes. */
952 * iovecs containing encoded data.
954 * For reads, if the size of the encoded data is larger than the sum of
955 * iov[n].iov_len for 0 <= n < iovcnt, then the ioctl fails with
958 * For writes, the size of the encoded data is the sum of iov[n].iov_len
959 * for 0 <= n < iovcnt. This must be less than 128 KiB (this limit may
960 * increase in the future). This must also be less than or equal to
963 const struct iovec
*iov
;
964 /* Number of iovecs. */
965 unsigned long iovcnt
;
969 * For writes, must be aligned to the sector size of the filesystem.
972 /* Currently must be zero. */
976 * For reads, the following members are output parameters that will
977 * contain the returned metadata for the encoded data.
978 * For writes, the following members must be set to the metadata for the
983 * Length of the data in the file.
985 * Must be less than or equal to unencoded_len - unencoded_offset. For
986 * writes, must be aligned to the sector size of the filesystem unless
987 * the data ends at or beyond the current end of the file.
991 * Length of the unencoded (i.e., decrypted and decompressed) data.
993 * For writes, must be no more than 128 KiB (this limit may increase in
994 * the future). If the unencoded data is actually longer than
995 * unencoded_len, then it is truncated; if it is shorter, then it is
996 * extended with zeroes.
1000 * Offset from the first byte of the unencoded data to the first byte of
1001 * logical data in the file.
1003 * Must be less than unencoded_len.
1005 __u64 unencoded_offset
;
1007 * BTRFS_ENCODED_IO_COMPRESSION_* type.
1009 * For writes, must not be BTRFS_ENCODED_IO_COMPRESSION_NONE.
1012 /* Currently always BTRFS_ENCODED_IO_ENCRYPTION_NONE. */
1015 * Reserved for future expansion.
1017 * For reads, always returned as zero. Users should check for non-zero
1018 * bytes. If there are any, then the kernel has a newer version of this
1019 * structure with additional information that the user definition is
1022 * For writes, must be zeroed.
1027 /* Data is not compressed. */
1028 #define BTRFS_ENCODED_IO_COMPRESSION_NONE 0
1029 /* Data is compressed as a single zlib stream. */
1030 #define BTRFS_ENCODED_IO_COMPRESSION_ZLIB 1
1032 * Data is compressed as a single zstd frame with the windowLog compression
1033 * parameter set to no more than 17.
1035 #define BTRFS_ENCODED_IO_COMPRESSION_ZSTD 2
1037 * Data is compressed sector by sector (using the sector size indicated by the
1038 * name of the constant) with LZO1X and wrapped in the format documented in
1039 * fs/btrfs/lzo.c. For writes, the compression sector size must match the
1040 * filesystem sector size.
1042 #define BTRFS_ENCODED_IO_COMPRESSION_LZO_4K 3
1043 #define BTRFS_ENCODED_IO_COMPRESSION_LZO_8K 4
1044 #define BTRFS_ENCODED_IO_COMPRESSION_LZO_16K 5
1045 #define BTRFS_ENCODED_IO_COMPRESSION_LZO_32K 6
1046 #define BTRFS_ENCODED_IO_COMPRESSION_LZO_64K 7
1047 #define BTRFS_ENCODED_IO_COMPRESSION_TYPES 8
1049 /* Data is not encrypted. */
1050 #define BTRFS_ENCODED_IO_ENCRYPTION_NONE 0
1051 #define BTRFS_ENCODED_IO_ENCRYPTION_TYPES 1
1053 /* Error codes as returned by the kernel */
1054 enum btrfs_err_code
{
1055 BTRFS_ERROR_DEV_RAID1_MIN_NOT_MET
= 1,
1056 BTRFS_ERROR_DEV_RAID10_MIN_NOT_MET
,
1057 BTRFS_ERROR_DEV_RAID5_MIN_NOT_MET
,
1058 BTRFS_ERROR_DEV_RAID6_MIN_NOT_MET
,
1059 BTRFS_ERROR_DEV_TGT_REPLACE
,
1060 BTRFS_ERROR_DEV_MISSING_NOT_FOUND
,
1061 BTRFS_ERROR_DEV_ONLY_WRITABLE
,
1062 BTRFS_ERROR_DEV_EXCL_RUN_IN_PROGRESS
,
1063 BTRFS_ERROR_DEV_RAID1C3_MIN_NOT_MET
,
1064 BTRFS_ERROR_DEV_RAID1C4_MIN_NOT_MET
,
1067 #define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
1068 struct btrfs_ioctl_vol_args)
1069 #define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
1070 struct btrfs_ioctl_vol_args)
1071 #define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
1072 struct btrfs_ioctl_vol_args)
1073 #define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
1074 struct btrfs_ioctl_vol_args)
1075 #define BTRFS_IOC_FORGET_DEV _IOW(BTRFS_IOCTL_MAGIC, 5, \
1076 struct btrfs_ioctl_vol_args)
1077 /* trans start and trans end are dangerous, and only for
1078 * use by applications that know how to avoid the
1079 * resulting deadlocks
1081 #define BTRFS_IOC_TRANS_START _IO(BTRFS_IOCTL_MAGIC, 6)
1082 #define BTRFS_IOC_TRANS_END _IO(BTRFS_IOCTL_MAGIC, 7)
1083 #define BTRFS_IOC_SYNC _IO(BTRFS_IOCTL_MAGIC, 8)
1085 #define BTRFS_IOC_CLONE _IOW(BTRFS_IOCTL_MAGIC, 9, int)
1086 #define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
1087 struct btrfs_ioctl_vol_args)
1088 #define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
1089 struct btrfs_ioctl_vol_args)
1090 #define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
1091 struct btrfs_ioctl_vol_args)
1093 #define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
1094 struct btrfs_ioctl_clone_range_args)
1096 #define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
1097 struct btrfs_ioctl_vol_args)
1098 #define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
1099 struct btrfs_ioctl_vol_args)
1100 #define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
1101 struct btrfs_ioctl_defrag_range_args)
1102 #define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
1103 struct btrfs_ioctl_search_args)
1104 #define BTRFS_IOC_TREE_SEARCH_V2 _IOWR(BTRFS_IOCTL_MAGIC, 17, \
1105 struct btrfs_ioctl_search_args_v2)
1106 #define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
1107 struct btrfs_ioctl_ino_lookup_args)
1108 #define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, __u64)
1109 #define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
1110 struct btrfs_ioctl_space_args)
1111 #define BTRFS_IOC_START_SYNC _IOR(BTRFS_IOCTL_MAGIC, 24, __u64)
1112 #define BTRFS_IOC_WAIT_SYNC _IOW(BTRFS_IOCTL_MAGIC, 22, __u64)
1113 #define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \
1114 struct btrfs_ioctl_vol_args_v2)
1115 #define BTRFS_IOC_SUBVOL_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 24, \
1116 struct btrfs_ioctl_vol_args_v2)
1117 #define BTRFS_IOC_SUBVOL_GETFLAGS _IOR(BTRFS_IOCTL_MAGIC, 25, __u64)
1118 #define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64)
1119 #define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \
1120 struct btrfs_ioctl_scrub_args)
1121 #define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28)
1122 #define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \
1123 struct btrfs_ioctl_scrub_args)
1124 #define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \
1125 struct btrfs_ioctl_dev_info_args)
1126 #define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \
1127 struct btrfs_ioctl_fs_info_args)
1128 #define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \
1129 struct btrfs_ioctl_balance_args)
1130 #define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int)
1131 #define BTRFS_IOC_BALANCE_PROGRESS _IOR(BTRFS_IOCTL_MAGIC, 34, \
1132 struct btrfs_ioctl_balance_args)
1133 #define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \
1134 struct btrfs_ioctl_ino_path_args)
1135 #define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \
1136 struct btrfs_ioctl_logical_ino_args)
1137 #define BTRFS_IOC_SET_RECEIVED_SUBVOL _IOWR(BTRFS_IOCTL_MAGIC, 37, \
1138 struct btrfs_ioctl_received_subvol_args)
1139 #define BTRFS_IOC_SEND _IOW(BTRFS_IOCTL_MAGIC, 38, struct btrfs_ioctl_send_args)
1140 #define BTRFS_IOC_DEVICES_READY _IOR(BTRFS_IOCTL_MAGIC, 39, \
1141 struct btrfs_ioctl_vol_args)
1142 #define BTRFS_IOC_QUOTA_CTL _IOWR(BTRFS_IOCTL_MAGIC, 40, \
1143 struct btrfs_ioctl_quota_ctl_args)
1144 #define BTRFS_IOC_QGROUP_ASSIGN _IOW(BTRFS_IOCTL_MAGIC, 41, \
1145 struct btrfs_ioctl_qgroup_assign_args)
1146 #define BTRFS_IOC_QGROUP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 42, \
1147 struct btrfs_ioctl_qgroup_create_args)
1148 #define BTRFS_IOC_QGROUP_LIMIT _IOR(BTRFS_IOCTL_MAGIC, 43, \
1149 struct btrfs_ioctl_qgroup_limit_args)
1150 #define BTRFS_IOC_QUOTA_RESCAN _IOW(BTRFS_IOCTL_MAGIC, 44, \
1151 struct btrfs_ioctl_quota_rescan_args)
1152 #define BTRFS_IOC_QUOTA_RESCAN_STATUS _IOR(BTRFS_IOCTL_MAGIC, 45, \
1153 struct btrfs_ioctl_quota_rescan_args)
1154 #define BTRFS_IOC_QUOTA_RESCAN_WAIT _IO(BTRFS_IOCTL_MAGIC, 46)
1155 #define BTRFS_IOC_GET_FSLABEL FS_IOC_GETFSLABEL
1156 #define BTRFS_IOC_SET_FSLABEL FS_IOC_SETFSLABEL
1157 #define BTRFS_IOC_GET_DEV_STATS _IOWR(BTRFS_IOCTL_MAGIC, 52, \
1158 struct btrfs_ioctl_get_dev_stats)
1159 #define BTRFS_IOC_DEV_REPLACE _IOWR(BTRFS_IOCTL_MAGIC, 53, \
1160 struct btrfs_ioctl_dev_replace_args)
1161 #define BTRFS_IOC_FILE_EXTENT_SAME _IOWR(BTRFS_IOCTL_MAGIC, 54, \
1162 struct btrfs_ioctl_same_args)
1163 #define BTRFS_IOC_GET_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
1164 struct btrfs_ioctl_feature_flags)
1165 #define BTRFS_IOC_SET_FEATURES _IOW(BTRFS_IOCTL_MAGIC, 57, \
1166 struct btrfs_ioctl_feature_flags[2])
1167 #define BTRFS_IOC_GET_SUPPORTED_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
1168 struct btrfs_ioctl_feature_flags[3])
1169 #define BTRFS_IOC_RM_DEV_V2 _IOW(BTRFS_IOCTL_MAGIC, 58, \
1170 struct btrfs_ioctl_vol_args_v2)
1171 #define BTRFS_IOC_LOGICAL_INO_V2 _IOWR(BTRFS_IOCTL_MAGIC, 59, \
1172 struct btrfs_ioctl_logical_ino_args)
1173 #define BTRFS_IOC_GET_SUBVOL_INFO _IOR(BTRFS_IOCTL_MAGIC, 60, \
1174 struct btrfs_ioctl_get_subvol_info_args)
1175 #define BTRFS_IOC_GET_SUBVOL_ROOTREF _IOWR(BTRFS_IOCTL_MAGIC, 61, \
1176 struct btrfs_ioctl_get_subvol_rootref_args)
1177 #define BTRFS_IOC_INO_LOOKUP_USER _IOWR(BTRFS_IOCTL_MAGIC, 62, \
1178 struct btrfs_ioctl_ino_lookup_user_args)
1179 #define BTRFS_IOC_SNAP_DESTROY_V2 _IOW(BTRFS_IOCTL_MAGIC, 63, \
1180 struct btrfs_ioctl_vol_args_v2)
1181 #define BTRFS_IOC_ENCODED_READ _IOR(BTRFS_IOCTL_MAGIC, 64, \
1182 struct btrfs_ioctl_encoded_io_args)
1183 #define BTRFS_IOC_ENCODED_WRITE _IOW(BTRFS_IOCTL_MAGIC, 64, \
1184 struct btrfs_ioctl_encoded_io_args)
1190 #endif /* _UAPI_LINUX_BTRFS_H */