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