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