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