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