1 /* 2 * Copyright (C) 2007 Oracle. All rights reserved. 3 * 4 * This program is free software; you can redistribute it and/or 5 * modify it under the terms of the GNU General Public 6 * License v2 as published by the Free Software Foundation. 7 * 8 * This program is distributed in the hope that it will be useful, 9 * but WITHOUT ANY WARRANTY; without even the implied warranty of 10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 11 * General Public License for more details. 12 * 13 * You should have received a copy of the GNU General Public 14 * License along with this program; if not, write to the 15 * Free Software Foundation, Inc., 59 Temple Place - Suite 330, 16 * Boston, MA 021110-1307, USA. 17 */ 18 19 #ifndef __IOCTL_ 20 #define __IOCTL_ 21 #include <linux/ioctl.h> 22 23 #define BTRFS_IOCTL_MAGIC 0x94 24 #define BTRFS_VOL_NAME_MAX 255 25 26 /* this should be 4k */ 27 #define BTRFS_PATH_NAME_MAX 4087 28 struct btrfs_ioctl_vol_args { 29 __s64 fd; 30 char name[BTRFS_PATH_NAME_MAX + 1]; 31 }; 32 33 #define BTRFS_DEVICE_PATH_NAME_MAX 1024 34 35 #define BTRFS_SUBVOL_CREATE_ASYNC (1ULL << 0) 36 #define BTRFS_SUBVOL_RDONLY (1ULL << 1) 37 #define BTRFS_SUBVOL_QGROUP_INHERIT (1ULL << 2) 38 #define BTRFS_FSID_SIZE 16 39 #define BTRFS_UUID_SIZE 16 40 41 #define BTRFS_QGROUP_INHERIT_SET_LIMITS (1ULL << 0) 42 43 struct btrfs_qgroup_limit { 44 __u64 flags; 45 __u64 max_rfer; 46 __u64 max_excl; 47 __u64 rsv_rfer; 48 __u64 rsv_excl; 49 }; 50 51 struct btrfs_qgroup_inherit { 52 __u64 flags; 53 __u64 num_qgroups; 54 __u64 num_ref_copies; 55 __u64 num_excl_copies; 56 struct btrfs_qgroup_limit lim; 57 __u64 qgroups[0]; 58 }; 59 60 struct btrfs_ioctl_qgroup_limit_args { 61 __u64 qgroupid; 62 struct btrfs_qgroup_limit lim; 63 }; 64 65 #define BTRFS_SUBVOL_NAME_MAX 4039 66 struct btrfs_ioctl_vol_args_v2 { 67 __s64 fd; 68 __u64 transid; 69 __u64 flags; 70 union { 71 struct { 72 __u64 size; 73 struct btrfs_qgroup_inherit __user *qgroup_inherit; 74 }; 75 __u64 unused[4]; 76 }; 77 char name[BTRFS_SUBVOL_NAME_MAX + 1]; 78 }; 79 80 /* 81 * structure to report errors and progress to userspace, either as a 82 * result of a finished scrub, a canceled scrub or a progress inquiry 83 */ 84 struct btrfs_scrub_progress { 85 __u64 data_extents_scrubbed; /* # of data extents scrubbed */ 86 __u64 tree_extents_scrubbed; /* # of tree extents scrubbed */ 87 __u64 data_bytes_scrubbed; /* # of data bytes scrubbed */ 88 __u64 tree_bytes_scrubbed; /* # of tree bytes scrubbed */ 89 __u64 read_errors; /* # of read errors encountered (EIO) */ 90 __u64 csum_errors; /* # of failed csum checks */ 91 __u64 verify_errors; /* # of occurences, where the metadata 92 * of a tree block did not match the 93 * expected values, like generation or 94 * logical */ 95 __u64 no_csum; /* # of 4k data block for which no csum 96 * is present, probably the result of 97 * data written with nodatasum */ 98 __u64 csum_discards; /* # of csum for which no data was found 99 * in the extent tree. */ 100 __u64 super_errors; /* # of bad super blocks encountered */ 101 __u64 malloc_errors; /* # of internal kmalloc errors. These 102 * will likely cause an incomplete 103 * scrub */ 104 __u64 uncorrectable_errors; /* # of errors where either no intact 105 * copy was found or the writeback 106 * failed */ 107 __u64 corrected_errors; /* # of errors corrected */ 108 __u64 last_physical; /* last physical address scrubbed. In 109 * case a scrub was aborted, this can 110 * be used to restart the scrub */ 111 __u64 unverified_errors; /* # of occurences where a read for a 112 * full (64k) bio failed, but the re- 113 * check succeeded for each 4k piece. 114 * Intermittent error. */ 115 }; 116 117 #define BTRFS_SCRUB_READONLY 1 118 struct btrfs_ioctl_scrub_args { 119 __u64 devid; /* in */ 120 __u64 start; /* in */ 121 __u64 end; /* in */ 122 __u64 flags; /* in */ 123 struct btrfs_scrub_progress progress; /* out */ 124 /* pad to 1k */ 125 __u64 unused[(1024-32-sizeof(struct btrfs_scrub_progress))/8]; 126 }; 127 128 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_ALWAYS 0 129 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_AVOID 1 130 struct btrfs_ioctl_dev_replace_start_params { 131 __u64 srcdevid; /* in, if 0, use srcdev_name instead */ 132 __u64 cont_reading_from_srcdev_mode; /* in, see #define 133 * above */ 134 __u8 srcdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1]; /* in */ 135 __u8 tgtdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1]; /* in */ 136 }; 137 138 #define BTRFS_IOCTL_DEV_REPLACE_STATE_NEVER_STARTED 0 139 #define BTRFS_IOCTL_DEV_REPLACE_STATE_STARTED 1 140 #define BTRFS_IOCTL_DEV_REPLACE_STATE_FINISHED 2 141 #define BTRFS_IOCTL_DEV_REPLACE_STATE_CANCELED 3 142 #define BTRFS_IOCTL_DEV_REPLACE_STATE_SUSPENDED 4 143 struct btrfs_ioctl_dev_replace_status_params { 144 __u64 replace_state; /* out, see #define above */ 145 __u64 progress_1000; /* out, 0 <= x <= 1000 */ 146 __u64 time_started; /* out, seconds since 1-Jan-1970 */ 147 __u64 time_stopped; /* out, seconds since 1-Jan-1970 */ 148 __u64 num_write_errors; /* out */ 149 __u64 num_uncorrectable_read_errors; /* out */ 150 }; 151 152 #define BTRFS_IOCTL_DEV_REPLACE_CMD_START 0 153 #define BTRFS_IOCTL_DEV_REPLACE_CMD_STATUS 1 154 #define BTRFS_IOCTL_DEV_REPLACE_CMD_CANCEL 2 155 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NO_ERROR 0 156 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NOT_STARTED 1 157 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_ALREADY_STARTED 2 158 struct btrfs_ioctl_dev_replace_args { 159 __u64 cmd; /* in */ 160 __u64 result; /* out */ 161 162 union { 163 struct btrfs_ioctl_dev_replace_start_params start; 164 struct btrfs_ioctl_dev_replace_status_params status; 165 }; /* in/out */ 166 167 __u64 spare[64]; 168 }; 169 170 struct btrfs_ioctl_dev_info_args { 171 __u64 devid; /* in/out */ 172 __u8 uuid[BTRFS_UUID_SIZE]; /* in/out */ 173 __u64 bytes_used; /* out */ 174 __u64 total_bytes; /* out */ 175 __u64 unused[379]; /* pad to 4k */ 176 __u8 path[BTRFS_DEVICE_PATH_NAME_MAX]; /* out */ 177 }; 178 179 struct btrfs_ioctl_fs_info_args { 180 __u64 max_id; /* out */ 181 __u64 num_devices; /* out */ 182 __u8 fsid[BTRFS_FSID_SIZE]; /* out */ 183 __u64 reserved[124]; /* pad to 1k */ 184 }; 185 186 /* balance control ioctl modes */ 187 #define BTRFS_BALANCE_CTL_PAUSE 1 188 #define BTRFS_BALANCE_CTL_CANCEL 2 189 190 /* 191 * this is packed, because it should be exactly the same as its disk 192 * byte order counterpart (struct btrfs_disk_balance_args) 193 */ 194 struct btrfs_balance_args { 195 __u64 profiles; 196 __u64 usage; 197 __u64 devid; 198 __u64 pstart; 199 __u64 pend; 200 __u64 vstart; 201 __u64 vend; 202 203 __u64 target; 204 205 __u64 flags; 206 207 __u64 unused[8]; 208 } __attribute__ ((__packed__)); 209 210 /* report balance progress to userspace */ 211 struct btrfs_balance_progress { 212 __u64 expected; /* estimated # of chunks that will be 213 * relocated to fulfill the request */ 214 __u64 considered; /* # of chunks we have considered so far */ 215 __u64 completed; /* # of chunks relocated so far */ 216 }; 217 218 #define BTRFS_BALANCE_STATE_RUNNING (1ULL << 0) 219 #define BTRFS_BALANCE_STATE_PAUSE_REQ (1ULL << 1) 220 #define BTRFS_BALANCE_STATE_CANCEL_REQ (1ULL << 2) 221 222 struct btrfs_ioctl_balance_args { 223 __u64 flags; /* in/out */ 224 __u64 state; /* out */ 225 226 struct btrfs_balance_args data; /* in/out */ 227 struct btrfs_balance_args meta; /* in/out */ 228 struct btrfs_balance_args sys; /* in/out */ 229 230 struct btrfs_balance_progress stat; /* out */ 231 232 __u64 unused[72]; /* pad to 1k */ 233 }; 234 235 #define BTRFS_INO_LOOKUP_PATH_MAX 4080 236 struct btrfs_ioctl_ino_lookup_args { 237 __u64 treeid; 238 __u64 objectid; 239 char name[BTRFS_INO_LOOKUP_PATH_MAX]; 240 }; 241 242 struct btrfs_ioctl_search_key { 243 /* which root are we searching. 0 is the tree of tree roots */ 244 __u64 tree_id; 245 246 /* keys returned will be >= min and <= max */ 247 __u64 min_objectid; 248 __u64 max_objectid; 249 250 /* keys returned will be >= min and <= max */ 251 __u64 min_offset; 252 __u64 max_offset; 253 254 /* max and min transids to search for */ 255 __u64 min_transid; 256 __u64 max_transid; 257 258 /* keys returned will be >= min and <= max */ 259 __u32 min_type; 260 __u32 max_type; 261 262 /* 263 * how many items did userland ask for, and how many are we 264 * returning 265 */ 266 __u32 nr_items; 267 268 /* align to 64 bits */ 269 __u32 unused; 270 271 /* some extra for later */ 272 __u64 unused1; 273 __u64 unused2; 274 __u64 unused3; 275 __u64 unused4; 276 }; 277 278 struct btrfs_ioctl_search_header { 279 __u64 transid; 280 __u64 objectid; 281 __u64 offset; 282 __u32 type; 283 __u32 len; 284 }; 285 286 #define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key)) 287 /* 288 * the buf is an array of search headers where 289 * each header is followed by the actual item 290 * the type field is expanded to 32 bits for alignment 291 */ 292 struct btrfs_ioctl_search_args { 293 struct btrfs_ioctl_search_key key; 294 char buf[BTRFS_SEARCH_ARGS_BUFSIZE]; 295 }; 296 297 struct btrfs_ioctl_clone_range_args { 298 __s64 src_fd; 299 __u64 src_offset, src_length; 300 __u64 dest_offset; 301 }; 302 303 /* flags for the defrag range ioctl */ 304 #define BTRFS_DEFRAG_RANGE_COMPRESS 1 305 #define BTRFS_DEFRAG_RANGE_START_IO 2 306 307 struct btrfs_ioctl_space_info { 308 __u64 flags; 309 __u64 total_bytes; 310 __u64 used_bytes; 311 }; 312 313 struct btrfs_ioctl_space_args { 314 __u64 space_slots; 315 __u64 total_spaces; 316 struct btrfs_ioctl_space_info spaces[0]; 317 }; 318 319 struct btrfs_data_container { 320 __u32 bytes_left; /* out -- bytes not needed to deliver output */ 321 __u32 bytes_missing; /* out -- additional bytes needed for result */ 322 __u32 elem_cnt; /* out */ 323 __u32 elem_missed; /* out */ 324 __u64 val[0]; /* out */ 325 }; 326 327 struct btrfs_ioctl_ino_path_args { 328 __u64 inum; /* in */ 329 __u64 size; /* in */ 330 __u64 reserved[4]; 331 /* struct btrfs_data_container *fspath; out */ 332 __u64 fspath; /* out */ 333 }; 334 335 struct btrfs_ioctl_logical_ino_args { 336 __u64 logical; /* in */ 337 __u64 size; /* in */ 338 __u64 reserved[4]; 339 /* struct btrfs_data_container *inodes; out */ 340 __u64 inodes; 341 }; 342 343 enum btrfs_dev_stat_values { 344 /* disk I/O failure stats */ 345 BTRFS_DEV_STAT_WRITE_ERRS, /* EIO or EREMOTEIO from lower layers */ 346 BTRFS_DEV_STAT_READ_ERRS, /* EIO or EREMOTEIO from lower layers */ 347 BTRFS_DEV_STAT_FLUSH_ERRS, /* EIO or EREMOTEIO from lower layers */ 348 349 /* stats for indirect indications for I/O failures */ 350 BTRFS_DEV_STAT_CORRUPTION_ERRS, /* checksum error, bytenr error or 351 * contents is illegal: this is an 352 * indication that the block was damaged 353 * during read or write, or written to 354 * wrong location or read from wrong 355 * location */ 356 BTRFS_DEV_STAT_GENERATION_ERRS, /* an indication that blocks have not 357 * been written */ 358 359 BTRFS_DEV_STAT_VALUES_MAX 360 }; 361 362 /* Reset statistics after reading; needs SYS_ADMIN capability */ 363 #define BTRFS_DEV_STATS_RESET (1ULL << 0) 364 365 struct btrfs_ioctl_get_dev_stats { 366 __u64 devid; /* in */ 367 __u64 nr_items; /* in/out */ 368 __u64 flags; /* in/out */ 369 370 /* out values: */ 371 __u64 values[BTRFS_DEV_STAT_VALUES_MAX]; 372 373 __u64 unused[128 - 2 - BTRFS_DEV_STAT_VALUES_MAX]; /* pad to 1k */ 374 }; 375 376 #define BTRFS_QUOTA_CTL_ENABLE 1 377 #define BTRFS_QUOTA_CTL_DISABLE 2 378 #define BTRFS_QUOTA_CTL_RESCAN 3 379 struct btrfs_ioctl_quota_ctl_args { 380 __u64 cmd; 381 __u64 status; 382 }; 383 384 struct btrfs_ioctl_qgroup_assign_args { 385 __u64 assign; 386 __u64 src; 387 __u64 dst; 388 }; 389 390 struct btrfs_ioctl_qgroup_create_args { 391 __u64 create; 392 __u64 qgroupid; 393 }; 394 struct btrfs_ioctl_timespec { 395 __u64 sec; 396 __u32 nsec; 397 }; 398 399 struct btrfs_ioctl_received_subvol_args { 400 char uuid[BTRFS_UUID_SIZE]; /* in */ 401 __u64 stransid; /* in */ 402 __u64 rtransid; /* out */ 403 struct btrfs_ioctl_timespec stime; /* in */ 404 struct btrfs_ioctl_timespec rtime; /* out */ 405 __u64 flags; /* in */ 406 __u64 reserved[16]; /* in */ 407 }; 408 409 struct btrfs_ioctl_send_args { 410 __s64 send_fd; /* in */ 411 __u64 clone_sources_count; /* in */ 412 __u64 __user *clone_sources; /* in */ 413 __u64 parent_root; /* in */ 414 __u64 flags; /* in */ 415 __u64 reserved[4]; /* in */ 416 }; 417 418 #define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \ 419 struct btrfs_ioctl_vol_args) 420 #define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \ 421 struct btrfs_ioctl_vol_args) 422 #define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \ 423 struct btrfs_ioctl_vol_args) 424 #define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \ 425 struct btrfs_ioctl_vol_args) 426 /* trans start and trans end are dangerous, and only for 427 * use by applications that know how to avoid the 428 * resulting deadlocks 429 */ 430 #define BTRFS_IOC_TRANS_START _IO(BTRFS_IOCTL_MAGIC, 6) 431 #define BTRFS_IOC_TRANS_END _IO(BTRFS_IOCTL_MAGIC, 7) 432 #define BTRFS_IOC_SYNC _IO(BTRFS_IOCTL_MAGIC, 8) 433 434 #define BTRFS_IOC_CLONE _IOW(BTRFS_IOCTL_MAGIC, 9, int) 435 #define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \ 436 struct btrfs_ioctl_vol_args) 437 #define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \ 438 struct btrfs_ioctl_vol_args) 439 #define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \ 440 struct btrfs_ioctl_vol_args) 441 442 #define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \ 443 struct btrfs_ioctl_clone_range_args) 444 445 #define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \ 446 struct btrfs_ioctl_vol_args) 447 #define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \ 448 struct btrfs_ioctl_vol_args) 449 #define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \ 450 struct btrfs_ioctl_defrag_range_args) 451 #define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \ 452 struct btrfs_ioctl_search_args) 453 #define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \ 454 struct btrfs_ioctl_ino_lookup_args) 455 #define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, u64) 456 #define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \ 457 struct btrfs_ioctl_space_args) 458 #define BTRFS_IOC_START_SYNC _IOR(BTRFS_IOCTL_MAGIC, 24, __u64) 459 #define BTRFS_IOC_WAIT_SYNC _IOW(BTRFS_IOCTL_MAGIC, 22, __u64) 460 #define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \ 461 struct btrfs_ioctl_vol_args_v2) 462 #define BTRFS_IOC_SUBVOL_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 24, \ 463 struct btrfs_ioctl_vol_args_v2) 464 #define BTRFS_IOC_SUBVOL_GETFLAGS _IOR(BTRFS_IOCTL_MAGIC, 25, __u64) 465 #define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64) 466 #define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \ 467 struct btrfs_ioctl_scrub_args) 468 #define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28) 469 #define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \ 470 struct btrfs_ioctl_scrub_args) 471 #define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \ 472 struct btrfs_ioctl_dev_info_args) 473 #define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \ 474 struct btrfs_ioctl_fs_info_args) 475 #define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \ 476 struct btrfs_ioctl_balance_args) 477 #define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int) 478 #define BTRFS_IOC_BALANCE_PROGRESS _IOR(BTRFS_IOCTL_MAGIC, 34, \ 479 struct btrfs_ioctl_balance_args) 480 #define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \ 481 struct btrfs_ioctl_ino_path_args) 482 #define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \ 483 struct btrfs_ioctl_ino_path_args) 484 #define BTRFS_IOC_SET_RECEIVED_SUBVOL _IOWR(BTRFS_IOCTL_MAGIC, 37, \ 485 struct btrfs_ioctl_received_subvol_args) 486 #define BTRFS_IOC_SEND _IOW(BTRFS_IOCTL_MAGIC, 38, struct btrfs_ioctl_send_args) 487 #define BTRFS_IOC_DEVICES_READY _IOR(BTRFS_IOCTL_MAGIC, 39, \ 488 struct btrfs_ioctl_vol_args) 489 #define BTRFS_IOC_QUOTA_CTL _IOWR(BTRFS_IOCTL_MAGIC, 40, \ 490 struct btrfs_ioctl_quota_ctl_args) 491 #define BTRFS_IOC_QGROUP_ASSIGN _IOW(BTRFS_IOCTL_MAGIC, 41, \ 492 struct btrfs_ioctl_qgroup_assign_args) 493 #define BTRFS_IOC_QGROUP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 42, \ 494 struct btrfs_ioctl_qgroup_create_args) 495 #define BTRFS_IOC_QGROUP_LIMIT _IOR(BTRFS_IOCTL_MAGIC, 43, \ 496 struct btrfs_ioctl_qgroup_limit_args) 497 #define BTRFS_IOC_GET_DEV_STATS _IOWR(BTRFS_IOCTL_MAGIC, 52, \ 498 struct btrfs_ioctl_get_dev_stats) 499 #define BTRFS_IOC_DEV_REPLACE _IOWR(BTRFS_IOCTL_MAGIC, 53, \ 500 struct btrfs_ioctl_dev_replace_args) 501 502 #endif 503