1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */ 2 /* 3 * Copyright (C) 2007 Oracle. All rights reserved. 4 * 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. 8 * 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. 13 * 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. 18 */ 19 20 #ifndef _UAPI_LINUX_BTRFS_H 21 #define _UAPI_LINUX_BTRFS_H 22 #include <linux/types.h> 23 #include <linux/ioctl.h> 24 25 #define BTRFS_IOCTL_MAGIC 0x94 26 #define BTRFS_VOL_NAME_MAX 255 27 #define BTRFS_LABEL_SIZE 256 28 29 /* this should be 4k */ 30 #define BTRFS_PATH_NAME_MAX 4087 31 struct btrfs_ioctl_vol_args { 32 __s64 fd; 33 char name[BTRFS_PATH_NAME_MAX + 1]; 34 }; 35 36 #define BTRFS_DEVICE_PATH_NAME_MAX 1024 37 #define BTRFS_SUBVOL_NAME_MAX 4039 38 39 #ifndef __KERNEL__ 40 /* Deprecated since 5.7 */ 41 # define BTRFS_SUBVOL_CREATE_ASYNC (1ULL << 0) 42 #endif 43 #define BTRFS_SUBVOL_RDONLY (1ULL << 1) 44 #define BTRFS_SUBVOL_QGROUP_INHERIT (1ULL << 2) 45 46 #define BTRFS_DEVICE_SPEC_BY_ID (1ULL << 3) 47 48 #define BTRFS_SUBVOL_SPEC_BY_ID (1ULL << 4) 49 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) 55 56 #define BTRFS_FSID_SIZE 16 57 #define BTRFS_UUID_SIZE 16 58 #define BTRFS_UUID_UNPARSED_SIZE 37 59 60 /* 61 * flags definition for qgroup limits 62 * 63 * Used by: 64 * struct btrfs_qgroup_limit.flags 65 * struct btrfs_qgroup_limit_item.flags 66 */ 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) 73 74 struct btrfs_qgroup_limit { 75 __u64 flags; 76 __u64 max_rfer; 77 __u64 max_excl; 78 __u64 rsv_rfer; 79 __u64 rsv_excl; 80 }; 81 82 /* 83 * flags definition for qgroup inheritance 84 * 85 * Used by: 86 * struct btrfs_qgroup_inherit.flags 87 */ 88 #define BTRFS_QGROUP_INHERIT_SET_LIMITS (1ULL << 0) 89 90 struct btrfs_qgroup_inherit { 91 __u64 flags; 92 __u64 num_qgroups; 93 __u64 num_ref_copies; 94 __u64 num_excl_copies; 95 struct btrfs_qgroup_limit lim; 96 __u64 qgroups[0]; 97 }; 98 99 struct btrfs_ioctl_qgroup_limit_args { 100 __u64 qgroupid; 101 struct btrfs_qgroup_limit lim; 102 }; 103 104 /* 105 * Arguments for specification of subvolumes or devices, supporting by-name or 106 * by-id and flags 107 * 108 * The set of supported flags depends on the ioctl 109 * 110 * BTRFS_SUBVOL_RDONLY is also provided/consumed by the following ioctls: 111 * - BTRFS_IOC_SUBVOL_GETFLAGS 112 * - BTRFS_IOC_SUBVOL_SETFLAGS 113 */ 114 115 /* Supported flags for BTRFS_IOC_RM_DEV_V2 */ 116 #define BTRFS_DEVICE_REMOVE_ARGS_MASK \ 117 (BTRFS_DEVICE_SPEC_BY_ID) 118 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) 123 124 /* Supported flags for BTRFS_IOC_SNAP_DESTROY_V2 */ 125 #define BTRFS_SUBVOL_DELETE_ARGS_MASK \ 126 (BTRFS_SUBVOL_SPEC_BY_ID) 127 128 struct btrfs_ioctl_vol_args_v2 { 129 __s64 fd; 130 __u64 transid; 131 __u64 flags; 132 union { 133 struct { 134 __u64 size; 135 struct btrfs_qgroup_inherit __user *qgroup_inherit; 136 }; 137 __u64 unused[4]; 138 }; 139 union { 140 char name[BTRFS_SUBVOL_NAME_MAX + 1]; 141 __u64 devid; 142 __u64 subvolid; 143 }; 144 }; 145 146 /* 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 149 */ 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 160 * logical */ 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 169 * scrub */ 170 __u64 uncorrectable_errors; /* # of errors where either no intact 171 * copy was found or the writeback 172 * failed */ 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. */ 181 }; 182 183 #define BTRFS_SCRUB_READONLY 1 184 struct btrfs_ioctl_scrub_args { 185 __u64 devid; /* in */ 186 __u64 start; /* in */ 187 __u64 end; /* in */ 188 __u64 flags; /* in */ 189 struct btrfs_scrub_progress progress; /* out */ 190 /* pad to 1k */ 191 __u64 unused[(1024-32-sizeof(struct btrfs_scrub_progress))/8]; 192 }; 193 194 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_ALWAYS 0 195 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_AVOID 1 196 struct btrfs_ioctl_dev_replace_start_params { 197 __u64 srcdevid; /* in, if 0, use srcdev_name instead */ 198 __u64 cont_reading_from_srcdev_mode; /* in, see #define 199 * above */ 200 __u8 srcdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1]; /* in */ 201 __u8 tgtdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1]; /* in */ 202 }; 203 204 #define BTRFS_IOCTL_DEV_REPLACE_STATE_NEVER_STARTED 0 205 #define BTRFS_IOCTL_DEV_REPLACE_STATE_STARTED 1 206 #define BTRFS_IOCTL_DEV_REPLACE_STATE_FINISHED 2 207 #define BTRFS_IOCTL_DEV_REPLACE_STATE_CANCELED 3 208 #define BTRFS_IOCTL_DEV_REPLACE_STATE_SUSPENDED 4 209 struct btrfs_ioctl_dev_replace_status_params { 210 __u64 replace_state; /* out, see #define above */ 211 __u64 progress_1000; /* out, 0 <= x <= 1000 */ 212 __u64 time_started; /* out, seconds since 1-Jan-1970 */ 213 __u64 time_stopped; /* out, seconds since 1-Jan-1970 */ 214 __u64 num_write_errors; /* out */ 215 __u64 num_uncorrectable_read_errors; /* out */ 216 }; 217 218 #define BTRFS_IOCTL_DEV_REPLACE_CMD_START 0 219 #define BTRFS_IOCTL_DEV_REPLACE_CMD_STATUS 1 220 #define BTRFS_IOCTL_DEV_REPLACE_CMD_CANCEL 2 221 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NO_ERROR 0 222 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NOT_STARTED 1 223 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_ALREADY_STARTED 2 224 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_SCRUB_INPROGRESS 3 225 struct btrfs_ioctl_dev_replace_args { 226 __u64 cmd; /* in */ 227 __u64 result; /* out */ 228 229 union { 230 struct btrfs_ioctl_dev_replace_start_params start; 231 struct btrfs_ioctl_dev_replace_status_params status; 232 }; /* in/out */ 233 234 __u64 spare[64]; 235 }; 236 237 struct btrfs_ioctl_dev_info_args { 238 __u64 devid; /* in/out */ 239 __u8 uuid[BTRFS_UUID_SIZE]; /* in/out */ 240 __u64 bytes_used; /* out */ 241 __u64 total_bytes; /* out */ 242 __u64 unused[379]; /* pad to 4k */ 243 __u8 path[BTRFS_DEVICE_PATH_NAME_MAX]; /* out */ 244 }; 245 246 /* 247 * Retrieve information about the filesystem 248 */ 249 250 /* Request information about checksum type and size */ 251 #define BTRFS_FS_INFO_FLAG_CSUM_INFO (1 << 0) 252 253 /* Request information about filesystem generation */ 254 #define BTRFS_FS_INFO_FLAG_GENERATION (1 << 1) 255 /* Request information about filesystem metadata UUID */ 256 #define BTRFS_FS_INFO_FLAG_METADATA_UUID (1 << 2) 257 258 struct btrfs_ioctl_fs_info_args { 259 __u64 max_id; /* out */ 260 __u64 num_devices; /* out */ 261 __u8 fsid[BTRFS_FSID_SIZE]; /* out */ 262 __u32 nodesize; /* out */ 263 __u32 sectorsize; /* out */ 264 __u32 clone_alignment; /* out */ 265 /* See BTRFS_FS_INFO_FLAG_* */ 266 __u16 csum_type; /* out */ 267 __u16 csum_size; /* out */ 268 __u64 flags; /* in/out */ 269 __u64 generation; /* out */ 270 __u8 metadata_uuid[BTRFS_FSID_SIZE]; /* out */ 271 __u8 reserved[944]; /* pad to 1k */ 272 }; 273 274 /* 275 * feature flags 276 * 277 * Used by: 278 * struct btrfs_ioctl_feature_flags 279 */ 280 #define BTRFS_FEATURE_COMPAT_RO_FREE_SPACE_TREE (1ULL << 0) 281 /* 282 * Older kernels (< 4.9) on big-endian systems produced broken free space tree 283 * bitmaps, and btrfs-progs also used to corrupt the free space tree (versions 284 * < 4.7.3). If this bit is clear, then the free space tree cannot be trusted. 285 * btrfs-progs can also intentionally clear this bit to ask the kernel to 286 * rebuild the free space tree, however this might not work on older kernels 287 * that do not know about this bit. If not sure, clear the cache manually on 288 * first mount when booting older kernel versions. 289 */ 290 #define BTRFS_FEATURE_COMPAT_RO_FREE_SPACE_TREE_VALID (1ULL << 1) 291 #define BTRFS_FEATURE_COMPAT_RO_VERITY (1ULL << 2) 292 293 #define BTRFS_FEATURE_INCOMPAT_MIXED_BACKREF (1ULL << 0) 294 #define BTRFS_FEATURE_INCOMPAT_DEFAULT_SUBVOL (1ULL << 1) 295 #define BTRFS_FEATURE_INCOMPAT_MIXED_GROUPS (1ULL << 2) 296 #define BTRFS_FEATURE_INCOMPAT_COMPRESS_LZO (1ULL << 3) 297 #define BTRFS_FEATURE_INCOMPAT_COMPRESS_ZSTD (1ULL << 4) 298 299 /* 300 * older kernels tried to do bigger metadata blocks, but the 301 * code was pretty buggy. Lets not let them try anymore. 302 */ 303 #define BTRFS_FEATURE_INCOMPAT_BIG_METADATA (1ULL << 5) 304 305 #define BTRFS_FEATURE_INCOMPAT_EXTENDED_IREF (1ULL << 6) 306 #define BTRFS_FEATURE_INCOMPAT_RAID56 (1ULL << 7) 307 #define BTRFS_FEATURE_INCOMPAT_SKINNY_METADATA (1ULL << 8) 308 #define BTRFS_FEATURE_INCOMPAT_NO_HOLES (1ULL << 9) 309 #define BTRFS_FEATURE_INCOMPAT_METADATA_UUID (1ULL << 10) 310 #define BTRFS_FEATURE_INCOMPAT_RAID1C34 (1ULL << 11) 311 #define BTRFS_FEATURE_INCOMPAT_ZONED (1ULL << 12) 312 #define BTRFS_FEATURE_INCOMPAT_EXTENT_TREE_V2 (1ULL << 13) 313 314 struct btrfs_ioctl_feature_flags { 315 __u64 compat_flags; 316 __u64 compat_ro_flags; 317 __u64 incompat_flags; 318 }; 319 320 /* balance control ioctl modes */ 321 #define BTRFS_BALANCE_CTL_PAUSE 1 322 #define BTRFS_BALANCE_CTL_CANCEL 2 323 324 /* 325 * this is packed, because it should be exactly the same as its disk 326 * byte order counterpart (struct btrfs_disk_balance_args) 327 */ 328 struct btrfs_balance_args { 329 __u64 profiles; 330 union { 331 __u64 usage; 332 struct { 333 __u32 usage_min; 334 __u32 usage_max; 335 }; 336 }; 337 __u64 devid; 338 __u64 pstart; 339 __u64 pend; 340 __u64 vstart; 341 __u64 vend; 342 343 __u64 target; 344 345 __u64 flags; 346 347 /* 348 * BTRFS_BALANCE_ARGS_LIMIT with value 'limit' 349 * BTRFS_BALANCE_ARGS_LIMIT_RANGE - the extend version can use minimum 350 * and maximum 351 */ 352 union { 353 __u64 limit; /* limit number of processed chunks */ 354 struct { 355 __u32 limit_min; 356 __u32 limit_max; 357 }; 358 }; 359 360 /* 361 * Process chunks that cross stripes_min..stripes_max devices, 362 * BTRFS_BALANCE_ARGS_STRIPES_RANGE 363 */ 364 __u32 stripes_min; 365 __u32 stripes_max; 366 367 __u64 unused[6]; 368 } __attribute__ ((__packed__)); 369 370 /* report balance progress to userspace */ 371 struct btrfs_balance_progress { 372 __u64 expected; /* estimated # of chunks that will be 373 * relocated to fulfill the request */ 374 __u64 considered; /* # of chunks we have considered so far */ 375 __u64 completed; /* # of chunks relocated so far */ 376 }; 377 378 /* 379 * flags definition for balance 380 * 381 * Restriper's general type filter 382 * 383 * Used by: 384 * btrfs_ioctl_balance_args.flags 385 * btrfs_balance_control.flags (internal) 386 */ 387 #define BTRFS_BALANCE_DATA (1ULL << 0) 388 #define BTRFS_BALANCE_SYSTEM (1ULL << 1) 389 #define BTRFS_BALANCE_METADATA (1ULL << 2) 390 391 #define BTRFS_BALANCE_TYPE_MASK (BTRFS_BALANCE_DATA | \ 392 BTRFS_BALANCE_SYSTEM | \ 393 BTRFS_BALANCE_METADATA) 394 395 #define BTRFS_BALANCE_FORCE (1ULL << 3) 396 #define BTRFS_BALANCE_RESUME (1ULL << 4) 397 398 /* 399 * flags definitions for per-type balance args 400 * 401 * Balance filters 402 * 403 * Used by: 404 * struct btrfs_balance_args 405 */ 406 #define BTRFS_BALANCE_ARGS_PROFILES (1ULL << 0) 407 #define BTRFS_BALANCE_ARGS_USAGE (1ULL << 1) 408 #define BTRFS_BALANCE_ARGS_DEVID (1ULL << 2) 409 #define BTRFS_BALANCE_ARGS_DRANGE (1ULL << 3) 410 #define BTRFS_BALANCE_ARGS_VRANGE (1ULL << 4) 411 #define BTRFS_BALANCE_ARGS_LIMIT (1ULL << 5) 412 #define BTRFS_BALANCE_ARGS_LIMIT_RANGE (1ULL << 6) 413 #define BTRFS_BALANCE_ARGS_STRIPES_RANGE (1ULL << 7) 414 #define BTRFS_BALANCE_ARGS_USAGE_RANGE (1ULL << 10) 415 416 #define BTRFS_BALANCE_ARGS_MASK \ 417 (BTRFS_BALANCE_ARGS_PROFILES | \ 418 BTRFS_BALANCE_ARGS_USAGE | \ 419 BTRFS_BALANCE_ARGS_DEVID | \ 420 BTRFS_BALANCE_ARGS_DRANGE | \ 421 BTRFS_BALANCE_ARGS_VRANGE | \ 422 BTRFS_BALANCE_ARGS_LIMIT | \ 423 BTRFS_BALANCE_ARGS_LIMIT_RANGE | \ 424 BTRFS_BALANCE_ARGS_STRIPES_RANGE | \ 425 BTRFS_BALANCE_ARGS_USAGE_RANGE) 426 427 /* 428 * Profile changing flags. When SOFT is set we won't relocate chunk if 429 * it already has the target profile (even though it may be 430 * half-filled). 431 */ 432 #define BTRFS_BALANCE_ARGS_CONVERT (1ULL << 8) 433 #define BTRFS_BALANCE_ARGS_SOFT (1ULL << 9) 434 435 436 /* 437 * flags definition for balance state 438 * 439 * Used by: 440 * struct btrfs_ioctl_balance_args.state 441 */ 442 #define BTRFS_BALANCE_STATE_RUNNING (1ULL << 0) 443 #define BTRFS_BALANCE_STATE_PAUSE_REQ (1ULL << 1) 444 #define BTRFS_BALANCE_STATE_CANCEL_REQ (1ULL << 2) 445 446 struct btrfs_ioctl_balance_args { 447 __u64 flags; /* in/out */ 448 __u64 state; /* out */ 449 450 struct btrfs_balance_args data; /* in/out */ 451 struct btrfs_balance_args meta; /* in/out */ 452 struct btrfs_balance_args sys; /* in/out */ 453 454 struct btrfs_balance_progress stat; /* out */ 455 456 __u64 unused[72]; /* pad to 1k */ 457 }; 458 459 #define BTRFS_INO_LOOKUP_PATH_MAX 4080 460 struct btrfs_ioctl_ino_lookup_args { 461 __u64 treeid; 462 __u64 objectid; 463 char name[BTRFS_INO_LOOKUP_PATH_MAX]; 464 }; 465 466 #define BTRFS_INO_LOOKUP_USER_PATH_MAX (4080 - BTRFS_VOL_NAME_MAX - 1) 467 struct btrfs_ioctl_ino_lookup_user_args { 468 /* in, inode number containing the subvolume of 'subvolid' */ 469 __u64 dirid; 470 /* in */ 471 __u64 treeid; 472 /* out, name of the subvolume of 'treeid' */ 473 char name[BTRFS_VOL_NAME_MAX + 1]; 474 /* 475 * out, constructed path from the directory with which the ioctl is 476 * called to dirid 477 */ 478 char path[BTRFS_INO_LOOKUP_USER_PATH_MAX]; 479 }; 480 481 /* Search criteria for the btrfs SEARCH ioctl family. */ 482 struct btrfs_ioctl_search_key { 483 /* 484 * The tree we're searching in. 1 is the tree of tree roots, 2 is the 485 * extent tree, etc... 486 * 487 * A special tree_id value of 0 will cause a search in the subvolume 488 * tree that the inode which is passed to the ioctl is part of. 489 */ 490 __u64 tree_id; /* in */ 491 492 /* 493 * When doing a tree search, we're actually taking a slice from a 494 * linear search space of 136-bit keys. 495 * 496 * A full 136-bit tree key is composed as: 497 * (objectid << 72) + (type << 64) + offset 498 * 499 * The individual min and max values for objectid, type and offset 500 * define the min_key and max_key values for the search range. All 501 * metadata items with a key in the interval [min_key, max_key] will be 502 * returned. 503 * 504 * Additionally, we can filter the items returned on transaction id of 505 * the metadata block they're stored in by specifying a transid range. 506 * Be aware that this transaction id only denotes when the metadata 507 * page that currently contains the item got written the last time as 508 * result of a COW operation. The number does not have any meaning 509 * related to the transaction in which an individual item that is being 510 * returned was created or changed. 511 */ 512 __u64 min_objectid; /* in */ 513 __u64 max_objectid; /* in */ 514 __u64 min_offset; /* in */ 515 __u64 max_offset; /* in */ 516 __u64 min_transid; /* in */ 517 __u64 max_transid; /* in */ 518 __u32 min_type; /* in */ 519 __u32 max_type; /* in */ 520 521 /* 522 * input: The maximum amount of results desired. 523 * output: The actual amount of items returned, restricted by any of: 524 * - reaching the upper bound of the search range 525 * - reaching the input nr_items amount of items 526 * - completely filling the supplied memory buffer 527 */ 528 __u32 nr_items; /* in/out */ 529 530 /* align to 64 bits */ 531 __u32 unused; 532 533 /* some extra for later */ 534 __u64 unused1; 535 __u64 unused2; 536 __u64 unused3; 537 __u64 unused4; 538 }; 539 540 struct btrfs_ioctl_search_header { 541 __u64 transid; 542 __u64 objectid; 543 __u64 offset; 544 __u32 type; 545 __u32 len; 546 }; 547 548 #define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key)) 549 /* 550 * the buf is an array of search headers where 551 * each header is followed by the actual item 552 * the type field is expanded to 32 bits for alignment 553 */ 554 struct btrfs_ioctl_search_args { 555 struct btrfs_ioctl_search_key key; 556 char buf[BTRFS_SEARCH_ARGS_BUFSIZE]; 557 }; 558 559 struct btrfs_ioctl_search_args_v2 { 560 struct btrfs_ioctl_search_key key; /* in/out - search parameters */ 561 __u64 buf_size; /* in - size of buffer 562 * out - on EOVERFLOW: needed size 563 * to store item */ 564 __u64 buf[0]; /* out - found items */ 565 }; 566 567 struct btrfs_ioctl_clone_range_args { 568 __s64 src_fd; 569 __u64 src_offset, src_length; 570 __u64 dest_offset; 571 }; 572 573 /* 574 * flags definition for the defrag range ioctl 575 * 576 * Used by: 577 * struct btrfs_ioctl_defrag_range_args.flags 578 */ 579 #define BTRFS_DEFRAG_RANGE_COMPRESS 1 580 #define BTRFS_DEFRAG_RANGE_START_IO 2 581 struct btrfs_ioctl_defrag_range_args { 582 /* start of the defrag operation */ 583 __u64 start; 584 585 /* number of bytes to defrag, use (u64)-1 to say all */ 586 __u64 len; 587 588 /* 589 * flags for the operation, which can include turning 590 * on compression for this one defrag 591 */ 592 __u64 flags; 593 594 /* 595 * any extent bigger than this will be considered 596 * already defragged. Use 0 to take the kernel default 597 * Use 1 to say every single extent must be rewritten 598 */ 599 __u32 extent_thresh; 600 601 /* 602 * which compression method to use if turning on compression 603 * for this defrag operation. If unspecified, zlib will 604 * be used 605 */ 606 __u32 compress_type; 607 608 /* spare for later */ 609 __u32 unused[4]; 610 }; 611 612 613 #define BTRFS_SAME_DATA_DIFFERS 1 614 /* For extent-same ioctl */ 615 struct btrfs_ioctl_same_extent_info { 616 __s64 fd; /* in - destination file */ 617 __u64 logical_offset; /* in - start of extent in destination */ 618 __u64 bytes_deduped; /* out - total # of bytes we were able 619 * to dedupe from this file */ 620 /* status of this dedupe operation: 621 * 0 if dedup succeeds 622 * < 0 for error 623 * == BTRFS_SAME_DATA_DIFFERS if data differs 624 */ 625 __s32 status; /* out - see above description */ 626 __u32 reserved; 627 }; 628 629 struct btrfs_ioctl_same_args { 630 __u64 logical_offset; /* in - start of extent in source */ 631 __u64 length; /* in - length of extent */ 632 __u16 dest_count; /* in - total elements in info array */ 633 __u16 reserved1; 634 __u32 reserved2; 635 struct btrfs_ioctl_same_extent_info info[0]; 636 }; 637 638 struct btrfs_ioctl_space_info { 639 __u64 flags; 640 __u64 total_bytes; 641 __u64 used_bytes; 642 }; 643 644 struct btrfs_ioctl_space_args { 645 __u64 space_slots; 646 __u64 total_spaces; 647 struct btrfs_ioctl_space_info spaces[0]; 648 }; 649 650 struct btrfs_data_container { 651 __u32 bytes_left; /* out -- bytes not needed to deliver output */ 652 __u32 bytes_missing; /* out -- additional bytes needed for result */ 653 __u32 elem_cnt; /* out */ 654 __u32 elem_missed; /* out */ 655 __u64 val[0]; /* out */ 656 }; 657 658 struct btrfs_ioctl_ino_path_args { 659 __u64 inum; /* in */ 660 __u64 size; /* in */ 661 __u64 reserved[4]; 662 /* struct btrfs_data_container *fspath; out */ 663 __u64 fspath; /* out */ 664 }; 665 666 struct btrfs_ioctl_logical_ino_args { 667 __u64 logical; /* in */ 668 __u64 size; /* in */ 669 __u64 reserved[3]; /* must be 0 for now */ 670 __u64 flags; /* in, v2 only */ 671 /* struct btrfs_data_container *inodes; out */ 672 __u64 inodes; 673 }; 674 /* Return every ref to the extent, not just those containing logical block. 675 * Requires logical == extent bytenr. */ 676 #define BTRFS_LOGICAL_INO_ARGS_IGNORE_OFFSET (1ULL << 0) 677 678 enum btrfs_dev_stat_values { 679 /* disk I/O failure stats */ 680 BTRFS_DEV_STAT_WRITE_ERRS, /* EIO or EREMOTEIO from lower layers */ 681 BTRFS_DEV_STAT_READ_ERRS, /* EIO or EREMOTEIO from lower layers */ 682 BTRFS_DEV_STAT_FLUSH_ERRS, /* EIO or EREMOTEIO from lower layers */ 683 684 /* stats for indirect indications for I/O failures */ 685 BTRFS_DEV_STAT_CORRUPTION_ERRS, /* checksum error, bytenr error or 686 * contents is illegal: this is an 687 * indication that the block was damaged 688 * during read or write, or written to 689 * wrong location or read from wrong 690 * location */ 691 BTRFS_DEV_STAT_GENERATION_ERRS, /* an indication that blocks have not 692 * been written */ 693 694 BTRFS_DEV_STAT_VALUES_MAX 695 }; 696 697 /* Reset statistics after reading; needs SYS_ADMIN capability */ 698 #define BTRFS_DEV_STATS_RESET (1ULL << 0) 699 700 struct btrfs_ioctl_get_dev_stats { 701 __u64 devid; /* in */ 702 __u64 nr_items; /* in/out */ 703 __u64 flags; /* in/out */ 704 705 /* out values: */ 706 __u64 values[BTRFS_DEV_STAT_VALUES_MAX]; 707 708 /* 709 * This pads the struct to 1032 bytes. It was originally meant to pad to 710 * 1024 bytes, but when adding the flags field, the padding calculation 711 * was not adjusted. 712 */ 713 __u64 unused[128 - 2 - BTRFS_DEV_STAT_VALUES_MAX]; 714 }; 715 716 #define BTRFS_QUOTA_CTL_ENABLE 1 717 #define BTRFS_QUOTA_CTL_DISABLE 2 718 #define BTRFS_QUOTA_CTL_RESCAN__NOTUSED 3 719 struct btrfs_ioctl_quota_ctl_args { 720 __u64 cmd; 721 __u64 status; 722 }; 723 724 struct btrfs_ioctl_quota_rescan_args { 725 __u64 flags; 726 __u64 progress; 727 __u64 reserved[6]; 728 }; 729 730 struct btrfs_ioctl_qgroup_assign_args { 731 __u64 assign; 732 __u64 src; 733 __u64 dst; 734 }; 735 736 struct btrfs_ioctl_qgroup_create_args { 737 __u64 create; 738 __u64 qgroupid; 739 }; 740 struct btrfs_ioctl_timespec { 741 __u64 sec; 742 __u32 nsec; 743 }; 744 745 struct btrfs_ioctl_received_subvol_args { 746 char uuid[BTRFS_UUID_SIZE]; /* in */ 747 __u64 stransid; /* in */ 748 __u64 rtransid; /* out */ 749 struct btrfs_ioctl_timespec stime; /* in */ 750 struct btrfs_ioctl_timespec rtime; /* out */ 751 __u64 flags; /* in */ 752 __u64 reserved[16]; /* in */ 753 }; 754 755 /* 756 * Caller doesn't want file data in the send stream, even if the 757 * search of clone sources doesn't find an extent. UPDATE_EXTENT 758 * commands will be sent instead of WRITE commands. 759 */ 760 #define BTRFS_SEND_FLAG_NO_FILE_DATA 0x1 761 762 /* 763 * Do not add the leading stream header. Used when multiple snapshots 764 * are sent back to back. 765 */ 766 #define BTRFS_SEND_FLAG_OMIT_STREAM_HEADER 0x2 767 768 /* 769 * Omit the command at the end of the stream that indicated the end 770 * of the stream. This option is used when multiple snapshots are 771 * sent back to back. 772 */ 773 #define BTRFS_SEND_FLAG_OMIT_END_CMD 0x4 774 775 /* 776 * Read the protocol version in the structure 777 */ 778 #define BTRFS_SEND_FLAG_VERSION 0x8 779 780 #define BTRFS_SEND_FLAG_MASK \ 781 (BTRFS_SEND_FLAG_NO_FILE_DATA | \ 782 BTRFS_SEND_FLAG_OMIT_STREAM_HEADER | \ 783 BTRFS_SEND_FLAG_OMIT_END_CMD | \ 784 BTRFS_SEND_FLAG_VERSION) 785 786 struct btrfs_ioctl_send_args { 787 __s64 send_fd; /* in */ 788 __u64 clone_sources_count; /* in */ 789 __u64 __user *clone_sources; /* in */ 790 __u64 parent_root; /* in */ 791 __u64 flags; /* in */ 792 __u32 version; /* in */ 793 __u8 reserved[28]; /* in */ 794 }; 795 796 /* 797 * Information about a fs tree root. 798 * 799 * All items are filled by the ioctl 800 */ 801 struct btrfs_ioctl_get_subvol_info_args { 802 /* Id of this subvolume */ 803 __u64 treeid; 804 805 /* Name of this subvolume, used to get the real name at mount point */ 806 char name[BTRFS_VOL_NAME_MAX + 1]; 807 808 /* 809 * Id of the subvolume which contains this subvolume. 810 * Zero for top-level subvolume or a deleted subvolume. 811 */ 812 __u64 parent_id; 813 814 /* 815 * Inode number of the directory which contains this subvolume. 816 * Zero for top-level subvolume or a deleted subvolume 817 */ 818 __u64 dirid; 819 820 /* Latest transaction id of this subvolume */ 821 __u64 generation; 822 823 /* Flags of this subvolume */ 824 __u64 flags; 825 826 /* UUID of this subvolume */ 827 __u8 uuid[BTRFS_UUID_SIZE]; 828 829 /* 830 * UUID of the subvolume of which this subvolume is a snapshot. 831 * All zero for a non-snapshot subvolume. 832 */ 833 __u8 parent_uuid[BTRFS_UUID_SIZE]; 834 835 /* 836 * UUID of the subvolume from which this subvolume was received. 837 * All zero for non-received subvolume. 838 */ 839 __u8 received_uuid[BTRFS_UUID_SIZE]; 840 841 /* Transaction id indicating when change/create/send/receive happened */ 842 __u64 ctransid; 843 __u64 otransid; 844 __u64 stransid; 845 __u64 rtransid; 846 /* Time corresponding to c/o/s/rtransid */ 847 struct btrfs_ioctl_timespec ctime; 848 struct btrfs_ioctl_timespec otime; 849 struct btrfs_ioctl_timespec stime; 850 struct btrfs_ioctl_timespec rtime; 851 852 /* Must be zero */ 853 __u64 reserved[8]; 854 }; 855 856 #define BTRFS_MAX_ROOTREF_BUFFER_NUM 255 857 struct btrfs_ioctl_get_subvol_rootref_args { 858 /* in/out, minimum id of rootref's treeid to be searched */ 859 __u64 min_treeid; 860 861 /* out */ 862 struct { 863 __u64 treeid; 864 __u64 dirid; 865 } rootref[BTRFS_MAX_ROOTREF_BUFFER_NUM]; 866 867 /* out, number of found items */ 868 __u8 num_items; 869 __u8 align[7]; 870 }; 871 872 /* Error codes as returned by the kernel */ 873 enum btrfs_err_code { 874 BTRFS_ERROR_DEV_RAID1_MIN_NOT_MET = 1, 875 BTRFS_ERROR_DEV_RAID10_MIN_NOT_MET, 876 BTRFS_ERROR_DEV_RAID5_MIN_NOT_MET, 877 BTRFS_ERROR_DEV_RAID6_MIN_NOT_MET, 878 BTRFS_ERROR_DEV_TGT_REPLACE, 879 BTRFS_ERROR_DEV_MISSING_NOT_FOUND, 880 BTRFS_ERROR_DEV_ONLY_WRITABLE, 881 BTRFS_ERROR_DEV_EXCL_RUN_IN_PROGRESS, 882 BTRFS_ERROR_DEV_RAID1C3_MIN_NOT_MET, 883 BTRFS_ERROR_DEV_RAID1C4_MIN_NOT_MET, 884 }; 885 886 #define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \ 887 struct btrfs_ioctl_vol_args) 888 #define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \ 889 struct btrfs_ioctl_vol_args) 890 #define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \ 891 struct btrfs_ioctl_vol_args) 892 #define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \ 893 struct btrfs_ioctl_vol_args) 894 #define BTRFS_IOC_FORGET_DEV _IOW(BTRFS_IOCTL_MAGIC, 5, \ 895 struct btrfs_ioctl_vol_args) 896 /* trans start and trans end are dangerous, and only for 897 * use by applications that know how to avoid the 898 * resulting deadlocks 899 */ 900 #define BTRFS_IOC_TRANS_START _IO(BTRFS_IOCTL_MAGIC, 6) 901 #define BTRFS_IOC_TRANS_END _IO(BTRFS_IOCTL_MAGIC, 7) 902 #define BTRFS_IOC_SYNC _IO(BTRFS_IOCTL_MAGIC, 8) 903 904 #define BTRFS_IOC_CLONE _IOW(BTRFS_IOCTL_MAGIC, 9, int) 905 #define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \ 906 struct btrfs_ioctl_vol_args) 907 #define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \ 908 struct btrfs_ioctl_vol_args) 909 #define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \ 910 struct btrfs_ioctl_vol_args) 911 912 #define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \ 913 struct btrfs_ioctl_clone_range_args) 914 915 #define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \ 916 struct btrfs_ioctl_vol_args) 917 #define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \ 918 struct btrfs_ioctl_vol_args) 919 #define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \ 920 struct btrfs_ioctl_defrag_range_args) 921 #define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \ 922 struct btrfs_ioctl_search_args) 923 #define BTRFS_IOC_TREE_SEARCH_V2 _IOWR(BTRFS_IOCTL_MAGIC, 17, \ 924 struct btrfs_ioctl_search_args_v2) 925 #define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \ 926 struct btrfs_ioctl_ino_lookup_args) 927 #define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, __u64) 928 #define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \ 929 struct btrfs_ioctl_space_args) 930 #define BTRFS_IOC_START_SYNC _IOR(BTRFS_IOCTL_MAGIC, 24, __u64) 931 #define BTRFS_IOC_WAIT_SYNC _IOW(BTRFS_IOCTL_MAGIC, 22, __u64) 932 #define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \ 933 struct btrfs_ioctl_vol_args_v2) 934 #define BTRFS_IOC_SUBVOL_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 24, \ 935 struct btrfs_ioctl_vol_args_v2) 936 #define BTRFS_IOC_SUBVOL_GETFLAGS _IOR(BTRFS_IOCTL_MAGIC, 25, __u64) 937 #define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64) 938 #define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \ 939 struct btrfs_ioctl_scrub_args) 940 #define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28) 941 #define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \ 942 struct btrfs_ioctl_scrub_args) 943 #define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \ 944 struct btrfs_ioctl_dev_info_args) 945 #define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \ 946 struct btrfs_ioctl_fs_info_args) 947 #define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \ 948 struct btrfs_ioctl_balance_args) 949 #define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int) 950 #define BTRFS_IOC_BALANCE_PROGRESS _IOR(BTRFS_IOCTL_MAGIC, 34, \ 951 struct btrfs_ioctl_balance_args) 952 #define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \ 953 struct btrfs_ioctl_ino_path_args) 954 #define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \ 955 struct btrfs_ioctl_logical_ino_args) 956 #define BTRFS_IOC_SET_RECEIVED_SUBVOL _IOWR(BTRFS_IOCTL_MAGIC, 37, \ 957 struct btrfs_ioctl_received_subvol_args) 958 #define BTRFS_IOC_SEND _IOW(BTRFS_IOCTL_MAGIC, 38, struct btrfs_ioctl_send_args) 959 #define BTRFS_IOC_DEVICES_READY _IOR(BTRFS_IOCTL_MAGIC, 39, \ 960 struct btrfs_ioctl_vol_args) 961 #define BTRFS_IOC_QUOTA_CTL _IOWR(BTRFS_IOCTL_MAGIC, 40, \ 962 struct btrfs_ioctl_quota_ctl_args) 963 #define BTRFS_IOC_QGROUP_ASSIGN _IOW(BTRFS_IOCTL_MAGIC, 41, \ 964 struct btrfs_ioctl_qgroup_assign_args) 965 #define BTRFS_IOC_QGROUP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 42, \ 966 struct btrfs_ioctl_qgroup_create_args) 967 #define BTRFS_IOC_QGROUP_LIMIT _IOR(BTRFS_IOCTL_MAGIC, 43, \ 968 struct btrfs_ioctl_qgroup_limit_args) 969 #define BTRFS_IOC_QUOTA_RESCAN _IOW(BTRFS_IOCTL_MAGIC, 44, \ 970 struct btrfs_ioctl_quota_rescan_args) 971 #define BTRFS_IOC_QUOTA_RESCAN_STATUS _IOR(BTRFS_IOCTL_MAGIC, 45, \ 972 struct btrfs_ioctl_quota_rescan_args) 973 #define BTRFS_IOC_QUOTA_RESCAN_WAIT _IO(BTRFS_IOCTL_MAGIC, 46) 974 #define BTRFS_IOC_GET_FSLABEL FS_IOC_GETFSLABEL 975 #define BTRFS_IOC_SET_FSLABEL FS_IOC_SETFSLABEL 976 #define BTRFS_IOC_GET_DEV_STATS _IOWR(BTRFS_IOCTL_MAGIC, 52, \ 977 struct btrfs_ioctl_get_dev_stats) 978 #define BTRFS_IOC_DEV_REPLACE _IOWR(BTRFS_IOCTL_MAGIC, 53, \ 979 struct btrfs_ioctl_dev_replace_args) 980 #define BTRFS_IOC_FILE_EXTENT_SAME _IOWR(BTRFS_IOCTL_MAGIC, 54, \ 981 struct btrfs_ioctl_same_args) 982 #define BTRFS_IOC_GET_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \ 983 struct btrfs_ioctl_feature_flags) 984 #define BTRFS_IOC_SET_FEATURES _IOW(BTRFS_IOCTL_MAGIC, 57, \ 985 struct btrfs_ioctl_feature_flags[2]) 986 #define BTRFS_IOC_GET_SUPPORTED_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \ 987 struct btrfs_ioctl_feature_flags[3]) 988 #define BTRFS_IOC_RM_DEV_V2 _IOW(BTRFS_IOCTL_MAGIC, 58, \ 989 struct btrfs_ioctl_vol_args_v2) 990 #define BTRFS_IOC_LOGICAL_INO_V2 _IOWR(BTRFS_IOCTL_MAGIC, 59, \ 991 struct btrfs_ioctl_logical_ino_args) 992 #define BTRFS_IOC_GET_SUBVOL_INFO _IOR(BTRFS_IOCTL_MAGIC, 60, \ 993 struct btrfs_ioctl_get_subvol_info_args) 994 #define BTRFS_IOC_GET_SUBVOL_ROOTREF _IOWR(BTRFS_IOCTL_MAGIC, 61, \ 995 struct btrfs_ioctl_get_subvol_rootref_args) 996 #define BTRFS_IOC_INO_LOOKUP_USER _IOWR(BTRFS_IOCTL_MAGIC, 62, \ 997 struct btrfs_ioctl_ino_lookup_user_args) 998 #define BTRFS_IOC_SNAP_DESTROY_V2 _IOW(BTRFS_IOCTL_MAGIC, 63, \ 999 struct btrfs_ioctl_vol_args_v2) 1000 1001 #endif /* _UAPI_LINUX_BTRFS_H */ 1002