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