| 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 |
|
| 23 |
#ifdef __cplusplus |
| 24 |
extern "C" { |
| 25 |
#endif |
| 26 |
|
| 27 |
#include <linux/types.h> |
| 28 |
#include <linux/ioctl.h> |
| 29 |
#include <linux/fs.h> |
| 30 |
|
| 31 |
#define BTRFS_IOCTL_MAGIC 0x94 |
| 32 |
#define BTRFS_VOL_NAME_MAX 255 |
| 33 |
#define BTRFS_LABEL_SIZE 256 |
| 34 |
|
| 35 |
/* this should be 4k */ |
| 36 |
#define BTRFS_PATH_NAME_MAX 4087 |
| 37 |
struct btrfs_ioctl_vol_args { |
| 38 |
__s64 fd; |
| 39 |
char name[BTRFS_PATH_NAME_MAX + 1]; |
| 40 |
}; |
| 41 |
|
| 42 |
#define BTRFS_DEVICE_PATH_NAME_MAX 1024 |
| 43 |
#define BTRFS_SUBVOL_NAME_MAX 4039 |
| 44 |
|
| 45 |
/* Deprecated since 5.7 */ |
| 46 |
# define BTRFS_SUBVOL_CREATE_ASYNC (1ULL << 0) |
| 47 |
#define BTRFS_SUBVOL_RDONLY (1ULL << 1) |
| 48 |
#define BTRFS_SUBVOL_QGROUP_INHERIT (1ULL << 2) |
| 49 |
|
| 50 |
#define BTRFS_DEVICE_SPEC_BY_ID (1ULL << 3) |
| 51 |
|
| 52 |
#define BTRFS_SUBVOL_SPEC_BY_ID (1ULL << 4) |
| 53 |
|
| 54 |
#define BTRFS_VOL_ARG_V2_FLAGS_SUPPORTED \ |
| 55 |
(BTRFS_SUBVOL_RDONLY | \ |
| 56 |
BTRFS_SUBVOL_QGROUP_INHERIT | \ |
| 57 |
BTRFS_DEVICE_SPEC_BY_ID | \ |
| 58 |
BTRFS_SUBVOL_SPEC_BY_ID) |
| 59 |
|
| 60 |
#define BTRFS_FSID_SIZE 16 |
| 61 |
#define BTRFS_UUID_SIZE 16 |
| 62 |
#define BTRFS_UUID_UNPARSED_SIZE 37 |
| 63 |
|
| 64 |
/* |
| 65 |
* flags definition for qgroup limits |
| 66 |
* |
| 67 |
* Used by: |
| 68 |
* struct btrfs_qgroup_limit.flags |
| 69 |
* struct btrfs_qgroup_limit_item.flags |
| 70 |
*/ |
| 71 |
#define BTRFS_QGROUP_LIMIT_MAX_RFER (1ULL << 0) |
| 72 |
#define BTRFS_QGROUP_LIMIT_MAX_EXCL (1ULL << 1) |
| 73 |
#define BTRFS_QGROUP_LIMIT_RSV_RFER (1ULL << 2) |
| 74 |
#define BTRFS_QGROUP_LIMIT_RSV_EXCL (1ULL << 3) |
| 75 |
#define BTRFS_QGROUP_LIMIT_RFER_CMPR (1ULL << 4) |
| 76 |
#define BTRFS_QGROUP_LIMIT_EXCL_CMPR (1ULL << 5) |
| 77 |
|
| 78 |
struct btrfs_qgroup_limit { |
| 79 |
__u64 flags; |
| 80 |
__u64 max_rfer; |
| 81 |
__u64 max_excl; |
| 82 |
__u64 rsv_rfer; |
| 83 |
__u64 rsv_excl; |
| 84 |
}; |
| 85 |
|
| 86 |
/* |
| 87 |
* flags definition for qgroup inheritance |
| 88 |
* |
| 89 |
* Used by: |
| 90 |
* struct btrfs_qgroup_inherit.flags |
| 91 |
*/ |
| 92 |
#define BTRFS_QGROUP_INHERIT_SET_LIMITS (1ULL << 0) |
| 93 |
#define BTRFS_QGROUP_INHERIT_FLAGS_SUPP (BTRFS_QGROUP_INHERIT_SET_LIMITS) |
| 94 |
|
| 95 |
struct btrfs_qgroup_inherit { |
| 96 |
__u64 flags; |
| 97 |
__u64 num_qgroups; |
| 98 |
__u64 num_ref_copies; |
| 99 |
__u64 num_excl_copies; |
| 100 |
struct btrfs_qgroup_limit lim; |
| 101 |
__u64 qgroups[]; |
| 102 |
}; |
| 103 |
|
| 104 |
struct btrfs_ioctl_qgroup_limit_args { |
| 105 |
__u64 qgroupid; |
| 106 |
struct btrfs_qgroup_limit lim; |
| 107 |
}; |
| 108 |
|
| 109 |
/* |
| 110 |
* Arguments for specification of subvolumes or devices, supporting by-name or |
| 111 |
* by-id and flags |
| 112 |
* |
| 113 |
* The set of supported flags depends on the ioctl |
| 114 |
* |
| 115 |
* BTRFS_SUBVOL_RDONLY is also provided/consumed by the following ioctls: |
| 116 |
* - BTRFS_IOC_SUBVOL_GETFLAGS |
| 117 |
* - BTRFS_IOC_SUBVOL_SETFLAGS |
| 118 |
*/ |
| 119 |
|
| 120 |
/* Supported flags for BTRFS_IOC_RM_DEV_V2 */ |
| 121 |
#define BTRFS_DEVICE_REMOVE_ARGS_MASK \ |
| 122 |
(BTRFS_DEVICE_SPEC_BY_ID) |
| 123 |
|
| 124 |
/* Supported flags for BTRFS_IOC_SNAP_CREATE_V2 and BTRFS_IOC_SUBVOL_CREATE_V2 */ |
| 125 |
#define BTRFS_SUBVOL_CREATE_ARGS_MASK \ |
| 126 |
(BTRFS_SUBVOL_RDONLY | \ |
| 127 |
BTRFS_SUBVOL_QGROUP_INHERIT) |
| 128 |
|
| 129 |
/* Supported flags for BTRFS_IOC_SNAP_DESTROY_V2 */ |
| 130 |
#define BTRFS_SUBVOL_DELETE_ARGS_MASK \ |
| 131 |
(BTRFS_SUBVOL_SPEC_BY_ID) |
| 132 |
|
| 133 |
struct btrfs_ioctl_vol_args_v2 { |
| 134 |
__s64 fd; |
| 135 |
__u64 transid; |
| 136 |
__u64 flags; |
| 137 |
union { |
| 138 |
struct { |
| 139 |
__u64 size; |
| 140 |
struct btrfs_qgroup_inherit *qgroup_inherit; |
| 141 |
}; |
| 142 |
__u64 unused[4]; |
| 143 |
}; |
| 144 |
union { |
| 145 |
char name[BTRFS_SUBVOL_NAME_MAX + 1]; |
| 146 |
__u64 devid; |
| 147 |
__u64 subvolid; |
| 148 |
}; |
| 149 |
}; |
| 150 |
|
| 151 |
/* |
| 152 |
* structure to report errors and progress to userspace, either as a |
| 153 |
* result of a finished scrub, a canceled scrub or a progress inquiry |
| 154 |
*/ |
| 155 |
struct btrfs_scrub_progress { |
| 156 |
__u64 data_extents_scrubbed; /* # of data extents scrubbed */ |
| 157 |
__u64 tree_extents_scrubbed; /* # of tree extents scrubbed */ |
| 158 |
__u64 data_bytes_scrubbed; /* # of data bytes scrubbed */ |
| 159 |
__u64 tree_bytes_scrubbed; /* # of tree bytes scrubbed */ |
| 160 |
__u64 read_errors; /* # of read errors encountered (EIO) */ |
| 161 |
__u64 csum_errors; /* # of failed csum checks */ |
| 162 |
__u64 verify_errors; /* # of occurrences, where the metadata |
| 163 |
* of a tree block did not match the |
| 164 |
* expected values, like generation or |
| 165 |
* logical */ |
| 166 |
__u64 no_csum; /* # of 4k data block for which no csum |
| 167 |
* is present, probably the result of |
| 168 |
* data written with nodatasum */ |
| 169 |
__u64 csum_discards; /* # of csum for which no data was found |
| 170 |
* in the extent tree. */ |
| 171 |
__u64 super_errors; /* # of bad super blocks encountered */ |
| 172 |
__u64 malloc_errors; /* # of internal kmalloc errors. These |
| 173 |
* will likely cause an incomplete |
| 174 |
* scrub */ |
| 175 |
__u64 uncorrectable_errors; /* # of errors where either no intact |
| 176 |
* copy was found or the writeback |
| 177 |
* failed */ |
| 178 |
__u64 corrected_errors; /* # of errors corrected */ |
| 179 |
__u64 last_physical; /* last physical address scrubbed. In |
| 180 |
* case a scrub was aborted, this can |
| 181 |
* be used to restart the scrub */ |
| 182 |
__u64 unverified_errors; /* # of occurrences where a read for a |
| 183 |
* full (64k) bio failed, but the re- |
| 184 |
* check succeeded for each 4k piece. |
| 185 |
* Intermittent error. */ |
| 186 |
}; |
| 187 |
|
| 188 |
#define BTRFS_SCRUB_READONLY 1 |
| 189 |
#define BTRFS_SCRUB_SUPPORTED_FLAGS (BTRFS_SCRUB_READONLY) |
| 190 |
struct btrfs_ioctl_scrub_args { |
| 191 |
__u64 devid; /* in */ |
| 192 |
__u64 start; /* in */ |
| 193 |
__u64 end; /* in */ |
| 194 |
__u64 flags; /* in */ |
| 195 |
struct btrfs_scrub_progress progress; /* out */ |
| 196 |
/* pad to 1k */ |
| 197 |
__u64 unused[(1024-32-sizeof(struct btrfs_scrub_progress))/8]; |
| 198 |
}; |
| 199 |
|
| 200 |
#define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_ALWAYS 0 |
| 201 |
#define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_AVOID 1 |
| 202 |
struct btrfs_ioctl_dev_replace_start_params { |
| 203 |
__u64 srcdevid; /* in, if 0, use srcdev_name instead */ |
| 204 |
__u64 cont_reading_from_srcdev_mode; /* in, see #define |
| 205 |
* above */ |
| 206 |
__u8 srcdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1]; /* in */ |
| 207 |
__u8 tgtdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1]; /* in */ |
| 208 |
}; |
| 209 |
|
| 210 |
#define BTRFS_IOCTL_DEV_REPLACE_STATE_NEVER_STARTED 0 |
| 211 |
#define BTRFS_IOCTL_DEV_REPLACE_STATE_STARTED 1 |
| 212 |
#define BTRFS_IOCTL_DEV_REPLACE_STATE_FINISHED 2 |
| 213 |
#define BTRFS_IOCTL_DEV_REPLACE_STATE_CANCELED 3 |
| 214 |
#define BTRFS_IOCTL_DEV_REPLACE_STATE_SUSPENDED 4 |
| 215 |
struct btrfs_ioctl_dev_replace_status_params { |
| 216 |
__u64 replace_state; /* out, see #define above */ |
| 217 |
__u64 progress_1000; /* out, 0 <= x <= 1000 */ |
| 218 |
__u64 time_started; /* out, seconds since 1-Jan-1970 */ |
| 219 |
__u64 time_stopped; /* out, seconds since 1-Jan-1970 */ |
| 220 |
__u64 num_write_errors; /* out */ |
| 221 |
__u64 num_uncorrectable_read_errors; /* out */ |
| 222 |
}; |
| 223 |
|
| 224 |
#define BTRFS_IOCTL_DEV_REPLACE_CMD_START 0 |
| 225 |
#define BTRFS_IOCTL_DEV_REPLACE_CMD_STATUS 1 |
| 226 |
#define BTRFS_IOCTL_DEV_REPLACE_CMD_CANCEL 2 |
| 227 |
#define BTRFS_IOCTL_DEV_REPLACE_RESULT_NO_ERROR 0 |
| 228 |
#define BTRFS_IOCTL_DEV_REPLACE_RESULT_NOT_STARTED 1 |
| 229 |
#define BTRFS_IOCTL_DEV_REPLACE_RESULT_ALREADY_STARTED 2 |
| 230 |
#define BTRFS_IOCTL_DEV_REPLACE_RESULT_SCRUB_INPROGRESS 3 |
| 231 |
struct btrfs_ioctl_dev_replace_args { |
| 232 |
__u64 cmd; /* in */ |
| 233 |
__u64 result; /* out */ |
| 234 |
|
| 235 |
union { |
| 236 |
struct btrfs_ioctl_dev_replace_start_params start; |
| 237 |
struct btrfs_ioctl_dev_replace_status_params status; |
| 238 |
}; /* in/out */ |
| 239 |
|
| 240 |
__u64 spare[64]; |
| 241 |
}; |
| 242 |
|
| 243 |
struct btrfs_ioctl_dev_info_args { |
| 244 |
__u64 devid; /* in/out */ |
| 245 |
__u8 uuid[BTRFS_UUID_SIZE]; /* in/out */ |
| 246 |
__u64 bytes_used; /* out */ |
| 247 |
__u64 total_bytes; /* out */ |
| 248 |
/* |
| 249 |
* Optional, out. |
| 250 |
* |
| 251 |
* Showing the fsid of the device, allowing user space to check if this |
| 252 |
* device is a seeding one. |
| 253 |
* |
| 254 |
* Introduced in v6.3, thus user space still needs to check if kernel |
| 255 |
* changed this value. Older kernel will not touch the values here. |
| 256 |
*/ |
| 257 |
__u8 fsid[BTRFS_UUID_SIZE]; |
| 258 |
__u64 unused[377]; /* pad to 4k */ |
| 259 |
__u8 path[BTRFS_DEVICE_PATH_NAME_MAX]; /* out */ |
| 260 |
}; |
| 261 |
|
| 262 |
/* |
| 263 |
* Retrieve information about the filesystem |
| 264 |
*/ |
| 265 |
|
| 266 |
/* Request information about checksum type and size */ |
| 267 |
#define BTRFS_FS_INFO_FLAG_CSUM_INFO (1 << 0) |
| 268 |
|
| 269 |
/* Request information about filesystem generation */ |
| 270 |
#define BTRFS_FS_INFO_FLAG_GENERATION (1 << 1) |
| 271 |
/* Request information about filesystem metadata UUID */ |
| 272 |
#define BTRFS_FS_INFO_FLAG_METADATA_UUID (1 << 2) |
| 273 |
|
| 274 |
struct btrfs_ioctl_fs_info_args { |
| 275 |
__u64 max_id; /* out */ |
| 276 |
__u64 num_devices; /* out */ |
| 277 |
__u8 fsid[BTRFS_FSID_SIZE]; /* out */ |
| 278 |
__u32 nodesize; /* out */ |
| 279 |
__u32 sectorsize; /* out */ |
| 280 |
__u32 clone_alignment; /* out */ |
| 281 |
/* See BTRFS_FS_INFO_FLAG_* */ |
| 282 |
__u16 csum_type; /* out */ |
| 283 |
__u16 csum_size; /* out */ |
| 284 |
__u64 flags; /* in/out */ |
| 285 |
__u64 generation; /* out */ |
| 286 |
__u8 metadata_uuid[BTRFS_FSID_SIZE]; /* out */ |
| 287 |
__u8 reserved[944]; /* pad to 1k */ |
| 288 |
}; |
| 289 |
|
| 290 |
/* |
| 291 |
* feature flags |
| 292 |
* |
| 293 |
* Used by: |
| 294 |
* struct btrfs_ioctl_feature_flags |
| 295 |
*/ |
| 296 |
#define BTRFS_FEATURE_COMPAT_RO_FREE_SPACE_TREE (1ULL << 0) |
| 297 |
/* |
| 298 |
* Older kernels (< 4.9) on big-endian systems produced broken free space tree |
| 299 |
* bitmaps, and btrfs-progs also used to corrupt the free space tree (versions |
| 300 |
* < 4.7.3). If this bit is clear, then the free space tree cannot be trusted. |
| 301 |
* btrfs-progs can also intentionally clear this bit to ask the kernel to |
| 302 |
* rebuild the free space tree, however this might not work on older kernels |
| 303 |
* that do not know about this bit. If not sure, clear the cache manually on |
| 304 |
* first mount when booting older kernel versions. |
| 305 |
*/ |
| 306 |
#define BTRFS_FEATURE_COMPAT_RO_FREE_SPACE_TREE_VALID (1ULL << 1) |
| 307 |
#define BTRFS_FEATURE_COMPAT_RO_VERITY (1ULL << 2) |
| 308 |
|
| 309 |
/* |
| 310 |
* Put all block group items into a dedicated block group tree, greatly |
| 311 |
* reducing mount time for large filesystem due to better locality. |
| 312 |
*/ |
| 313 |
#define BTRFS_FEATURE_COMPAT_RO_BLOCK_GROUP_TREE (1ULL << 3) |
| 314 |
|
| 315 |
#define BTRFS_FEATURE_INCOMPAT_MIXED_BACKREF (1ULL << 0) |
| 316 |
#define BTRFS_FEATURE_INCOMPAT_DEFAULT_SUBVOL (1ULL << 1) |
| 317 |
#define BTRFS_FEATURE_INCOMPAT_MIXED_GROUPS (1ULL << 2) |
| 318 |
#define BTRFS_FEATURE_INCOMPAT_COMPRESS_LZO (1ULL << 3) |
| 319 |
#define BTRFS_FEATURE_INCOMPAT_COMPRESS_ZSTD (1ULL << 4) |
| 320 |
|
| 321 |
/* |
| 322 |
* older kernels tried to do bigger metadata blocks, but the |
| 323 |
* code was pretty buggy. Lets not let them try anymore. |
| 324 |
*/ |
| 325 |
#define BTRFS_FEATURE_INCOMPAT_BIG_METADATA (1ULL << 5) |
| 326 |
|
| 327 |
#define BTRFS_FEATURE_INCOMPAT_EXTENDED_IREF (1ULL << 6) |
| 328 |
#define BTRFS_FEATURE_INCOMPAT_RAID56 (1ULL << 7) |
| 329 |
#define BTRFS_FEATURE_INCOMPAT_SKINNY_METADATA (1ULL << 8) |
| 330 |
#define BTRFS_FEATURE_INCOMPAT_NO_HOLES (1ULL << 9) |
| 331 |
#define BTRFS_FEATURE_INCOMPAT_METADATA_UUID (1ULL << 10) |
| 332 |
#define BTRFS_FEATURE_INCOMPAT_RAID1C34 (1ULL << 11) |
| 333 |
#define BTRFS_FEATURE_INCOMPAT_ZONED (1ULL << 12) |
| 334 |
#define BTRFS_FEATURE_INCOMPAT_EXTENT_TREE_V2 (1ULL << 13) |
| 335 |
#define BTRFS_FEATURE_INCOMPAT_RAID_STRIPE_TREE (1ULL << 14) |
| 336 |
#define BTRFS_FEATURE_INCOMPAT_SIMPLE_QUOTA (1ULL << 16) |
| 337 |
#define BTRFS_FEATURE_INCOMPAT_REMAP_TREE (1ULL << 17) |
| 338 |
|
| 339 |
struct btrfs_ioctl_feature_flags { |
| 340 |
__u64 compat_flags; |
| 341 |
__u64 compat_ro_flags; |
| 342 |
__u64 incompat_flags; |
| 343 |
}; |
| 344 |
|
| 345 |
/* balance control ioctl modes */ |
| 346 |
#define BTRFS_BALANCE_CTL_PAUSE 1 |
| 347 |
#define BTRFS_BALANCE_CTL_CANCEL 2 |
| 348 |
|
| 349 |
/* |
| 350 |
* this is packed, because it should be exactly the same as its disk |
| 351 |
* byte order counterpart (struct btrfs_disk_balance_args) |
| 352 |
*/ |
| 353 |
struct btrfs_balance_args { |
| 354 |
__u64 profiles; |
| 355 |
|
| 356 |
/* |
| 357 |
* usage filter |
| 358 |
* BTRFS_BALANCE_ARGS_USAGE with a single value means '0..N' |
| 359 |
* BTRFS_BALANCE_ARGS_USAGE_RANGE - range syntax, min..max |
| 360 |
*/ |
| 361 |
union { |
| 362 |
__u64 usage; |
| 363 |
struct { |
| 364 |
__u32 usage_min; |
| 365 |
__u32 usage_max; |
| 366 |
}; |
| 367 |
}; |
| 368 |
__u64 devid; |
| 369 |
__u64 pstart; |
| 370 |
__u64 pend; |
| 371 |
__u64 vstart; |
| 372 |
__u64 vend; |
| 373 |
|
| 374 |
__u64 target; |
| 375 |
|
| 376 |
__u64 flags; |
| 377 |
|
| 378 |
/* |
| 379 |
* BTRFS_BALANCE_ARGS_LIMIT with value 'limit' |
| 380 |
* BTRFS_BALANCE_ARGS_LIMIT_RANGE - the extend version can use minimum |
| 381 |
* and maximum |
| 382 |
*/ |
| 383 |
union { |
| 384 |
__u64 limit; /* limit number of processed chunks */ |
| 385 |
struct { |
| 386 |
__u32 limit_min; |
| 387 |
__u32 limit_max; |
| 388 |
}; |
| 389 |
}; |
| 390 |
|
| 391 |
/* |
| 392 |
* Process chunks that cross stripes_min..stripes_max devices, |
| 393 |
* BTRFS_BALANCE_ARGS_STRIPES_RANGE |
| 394 |
*/ |
| 395 |
__u32 stripes_min; |
| 396 |
__u32 stripes_max; |
| 397 |
|
| 398 |
__u64 unused[6]; |
| 399 |
} __attribute__ ((__packed__)); |
| 400 |
|
| 401 |
/* report balance progress to userspace */ |
| 402 |
struct btrfs_balance_progress { |
| 403 |
__u64 expected; /* estimated # of chunks that will be |
| 404 |
* relocated to fulfill the request */ |
| 405 |
__u64 considered; /* # of chunks we have considered so far */ |
| 406 |
__u64 completed; /* # of chunks relocated so far */ |
| 407 |
}; |
| 408 |
|
| 409 |
/* |
| 410 |
* flags definition for balance |
| 411 |
* |
| 412 |
* Restriper's general type filter |
| 413 |
* |
| 414 |
* Used by: |
| 415 |
* btrfs_ioctl_balance_args.flags |
| 416 |
* btrfs_balance_control.flags (internal) |
| 417 |
*/ |
| 418 |
#define BTRFS_BALANCE_DATA (1ULL << 0) |
| 419 |
#define BTRFS_BALANCE_SYSTEM (1ULL << 1) |
| 420 |
#define BTRFS_BALANCE_METADATA (1ULL << 2) |
| 421 |
|
| 422 |
#define BTRFS_BALANCE_TYPE_MASK (BTRFS_BALANCE_DATA | \ |
| 423 |
BTRFS_BALANCE_SYSTEM | \ |
| 424 |
BTRFS_BALANCE_METADATA) |
| 425 |
|
| 426 |
#define BTRFS_BALANCE_FORCE (1ULL << 3) |
| 427 |
#define BTRFS_BALANCE_RESUME (1ULL << 4) |
| 428 |
|
| 429 |
/* |
| 430 |
* flags definitions for per-type balance args |
| 431 |
* |
| 432 |
* Balance filters |
| 433 |
* |
| 434 |
* Used by: |
| 435 |
* struct btrfs_balance_args |
| 436 |
*/ |
| 437 |
#define BTRFS_BALANCE_ARGS_PROFILES (1ULL << 0) |
| 438 |
#define BTRFS_BALANCE_ARGS_USAGE (1ULL << 1) |
| 439 |
#define BTRFS_BALANCE_ARGS_DEVID (1ULL << 2) |
| 440 |
#define BTRFS_BALANCE_ARGS_DRANGE (1ULL << 3) |
| 441 |
#define BTRFS_BALANCE_ARGS_VRANGE (1ULL << 4) |
| 442 |
#define BTRFS_BALANCE_ARGS_LIMIT (1ULL << 5) |
| 443 |
#define BTRFS_BALANCE_ARGS_LIMIT_RANGE (1ULL << 6) |
| 444 |
#define BTRFS_BALANCE_ARGS_STRIPES_RANGE (1ULL << 7) |
| 445 |
#define BTRFS_BALANCE_ARGS_USAGE_RANGE (1ULL << 10) |
| 446 |
|
| 447 |
#define BTRFS_BALANCE_ARGS_MASK \ |
| 448 |
(BTRFS_BALANCE_ARGS_PROFILES | \ |
| 449 |
BTRFS_BALANCE_ARGS_USAGE | \ |
| 450 |
BTRFS_BALANCE_ARGS_DEVID | \ |
| 451 |
BTRFS_BALANCE_ARGS_DRANGE | \ |
| 452 |
BTRFS_BALANCE_ARGS_VRANGE | \ |
| 453 |
BTRFS_BALANCE_ARGS_LIMIT | \ |
| 454 |
BTRFS_BALANCE_ARGS_LIMIT_RANGE | \ |
| 455 |
BTRFS_BALANCE_ARGS_STRIPES_RANGE | \ |
| 456 |
BTRFS_BALANCE_ARGS_USAGE_RANGE) |
| 457 |
|
| 458 |
/* |
| 459 |
* Profile changing flags. When SOFT is set we won't relocate chunk if |
| 460 |
* it already has the target profile (even though it may be |
| 461 |
* half-filled). |
| 462 |
*/ |
| 463 |
#define BTRFS_BALANCE_ARGS_CONVERT (1ULL << 8) |
| 464 |
#define BTRFS_BALANCE_ARGS_SOFT (1ULL << 9) |
| 465 |
|
| 466 |
|
| 467 |
/* |
| 468 |
* flags definition for balance state |
| 469 |
* |
| 470 |
* Used by: |
| 471 |
* struct btrfs_ioctl_balance_args.state |
| 472 |
*/ |
| 473 |
#define BTRFS_BALANCE_STATE_RUNNING (1ULL << 0) |
| 474 |
#define BTRFS_BALANCE_STATE_PAUSE_REQ (1ULL << 1) |
| 475 |
#define BTRFS_BALANCE_STATE_CANCEL_REQ (1ULL << 2) |
| 476 |
|
| 477 |
struct btrfs_ioctl_balance_args { |
| 478 |
__u64 flags; /* in/out */ |
| 479 |
__u64 state; /* out */ |
| 480 |
|
| 481 |
struct btrfs_balance_args data; /* in/out */ |
| 482 |
struct btrfs_balance_args meta; /* in/out */ |
| 483 |
struct btrfs_balance_args sys; /* in/out */ |
| 484 |
|
| 485 |
struct btrfs_balance_progress stat; /* out */ |
| 486 |
|
| 487 |
__u64 unused[72]; /* pad to 1k */ |
| 488 |
}; |
| 489 |
|
| 490 |
#define BTRFS_INO_LOOKUP_PATH_MAX 4080 |
| 491 |
struct btrfs_ioctl_ino_lookup_args { |
| 492 |
__u64 treeid; |
| 493 |
__u64 objectid; |
| 494 |
char name[BTRFS_INO_LOOKUP_PATH_MAX]; |
| 495 |
}; |
| 496 |
|
| 497 |
#define BTRFS_INO_LOOKUP_USER_PATH_MAX (4080 - BTRFS_VOL_NAME_MAX - 1) |
| 498 |
struct btrfs_ioctl_ino_lookup_user_args { |
| 499 |
/* in, inode number containing the subvolume of 'subvolid' */ |
| 500 |
__u64 dirid; |
| 501 |
/* in */ |
| 502 |
__u64 treeid; |
| 503 |
/* out, name of the subvolume of 'treeid' */ |
| 504 |
char name[BTRFS_VOL_NAME_MAX + 1]; |
| 505 |
/* |
| 506 |
* out, constructed path from the directory with which the ioctl is |
| 507 |
* called to dirid |
| 508 |
*/ |
| 509 |
char path[BTRFS_INO_LOOKUP_USER_PATH_MAX]; |
| 510 |
}; |
| 511 |
|
| 512 |
/* Search criteria for the btrfs SEARCH ioctl family. */ |
| 513 |
struct btrfs_ioctl_search_key { |
| 514 |
/* |
| 515 |
* The tree we're searching in. 1 is the tree of tree roots, 2 is the |
| 516 |
* extent tree, etc... |
| 517 |
* |
| 518 |
* A special tree_id value of 0 will cause a search in the subvolume |
| 519 |
* tree that the inode which is passed to the ioctl is part of. |
| 520 |
*/ |
| 521 |
__u64 tree_id; /* in */ |
| 522 |
|
| 523 |
/* |
| 524 |
* When doing a tree search, we're actually taking a slice from a |
| 525 |
* linear search space of 136-bit keys. |
| 526 |
* |
| 527 |
* A full 136-bit tree key is composed as: |
| 528 |
* (objectid << 72) + (type << 64) + offset |
| 529 |
* |
| 530 |
* The individual min and max values for objectid, type and offset |
| 531 |
* define the min_key and max_key values for the search range. All |
| 532 |
* metadata items with a key in the interval [min_key, max_key] will be |
| 533 |
* returned. |
| 534 |
* |
| 535 |
* Additionally, we can filter the items returned on transaction id of |
| 536 |
* the metadata block they're stored in by specifying a transid range. |
| 537 |
* Be aware that this transaction id only denotes when the metadata |
| 538 |
* page that currently contains the item got written the last time as |
| 539 |
* result of a COW operation. The number does not have any meaning |
| 540 |
* related to the transaction in which an individual item that is being |
| 541 |
* returned was created or changed. |
| 542 |
*/ |
| 543 |
__u64 min_objectid; /* in */ |
| 544 |
__u64 max_objectid; /* in */ |
| 545 |
__u64 min_offset; /* in */ |
| 546 |
__u64 max_offset; /* in */ |
| 547 |
__u64 min_transid; /* in */ |
| 548 |
__u64 max_transid; /* in */ |
| 549 |
__u32 min_type; /* in */ |
| 550 |
__u32 max_type; /* in */ |
| 551 |
|
| 552 |
/* |
| 553 |
* input: The maximum amount of results desired. |
| 554 |
* output: The actual amount of items returned, restricted by any of: |
| 555 |
* - reaching the upper bound of the search range |
| 556 |
* - reaching the input nr_items amount of items |
| 557 |
* - completely filling the supplied memory buffer |
| 558 |
*/ |
| 559 |
__u32 nr_items; /* in/out */ |
| 560 |
|
| 561 |
/* align to 64 bits */ |
| 562 |
__u32 unused; |
| 563 |
|
| 564 |
/* some extra for later */ |
| 565 |
__u64 unused1; |
| 566 |
__u64 unused2; |
| 567 |
__u64 unused3; |
| 568 |
__u64 unused4; |
| 569 |
}; |
| 570 |
|
| 571 |
struct btrfs_ioctl_search_header { |
| 572 |
__u64 transid; |
| 573 |
__u64 objectid; |
| 574 |
__u64 offset; |
| 575 |
__u32 type; |
| 576 |
__u32 len; |
| 577 |
} __attribute__ ((__may_alias__)); |
| 578 |
|
| 579 |
#define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key)) |
| 580 |
/* |
| 581 |
* the buf is an array of search headers where |
| 582 |
* each header is followed by the actual item |
| 583 |
* the type field is expanded to 32 bits for alignment |
| 584 |
*/ |
| 585 |
struct btrfs_ioctl_search_args { |
| 586 |
struct btrfs_ioctl_search_key key; |
| 587 |
char buf[BTRFS_SEARCH_ARGS_BUFSIZE]; |
| 588 |
}; |
| 589 |
|
| 590 |
/* |
| 591 |
* Extended version of TREE_SEARCH ioctl that can return more than 4k of bytes. |
| 592 |
* The allocated size of the buffer is set in buf_size. |
| 593 |
*/ |
| 594 |
struct btrfs_ioctl_search_args_v2 { |
| 595 |
struct btrfs_ioctl_search_key key; /* in/out - search parameters */ |
| 596 |
__u64 buf_size; /* in - size of buffer |
| 597 |
* out - on EOVERFLOW: needed size |
| 598 |
* to store item */ |
| 599 |
__u64 buf[]; /* out - found items */ |
| 600 |
}; |
| 601 |
|
| 602 |
/* With a @src_length of zero, the range from @src_offset->EOF is cloned! */ |
| 603 |
struct btrfs_ioctl_clone_range_args { |
| 604 |
__s64 src_fd; |
| 605 |
__u64 src_offset, src_length; |
| 606 |
__u64 dest_offset; |
| 607 |
}; |
| 608 |
|
| 609 |
/* |
| 610 |
* flags definition for the defrag range ioctl |
| 611 |
* |
| 612 |
* Used by: |
| 613 |
* struct btrfs_ioctl_defrag_range_args.flags |
| 614 |
*/ |
| 615 |
#define BTRFS_DEFRAG_RANGE_COMPRESS 1 |
| 616 |
#define BTRFS_DEFRAG_RANGE_START_IO 2 |
| 617 |
#define BTRFS_DEFRAG_RANGE_COMPRESS_LEVEL 4 |
| 618 |
/* Request no compression on the range (uncompress if necessary). */ |
| 619 |
#define BTRFS_DEFRAG_RANGE_NOCOMPRESS 8 |
| 620 |
#define BTRFS_DEFRAG_RANGE_FLAGS_SUPP (BTRFS_DEFRAG_RANGE_COMPRESS | \ |
| 621 |
BTRFS_DEFRAG_RANGE_COMPRESS_LEVEL | \ |
| 622 |
BTRFS_DEFRAG_RANGE_NOCOMPRESS | \ |
| 623 |
BTRFS_DEFRAG_RANGE_START_IO) |
| 624 |
|
| 625 |
struct btrfs_ioctl_defrag_range_args { |
| 626 |
/* start of the defrag operation */ |
| 627 |
__u64 start; |
| 628 |
|
| 629 |
/* number of bytes to defrag, use (u64)-1 to say all */ |
| 630 |
__u64 len; |
| 631 |
|
| 632 |
/* |
| 633 |
* flags for the operation, which can include turning |
| 634 |
* on compression for this one defrag |
| 635 |
*/ |
| 636 |
__u64 flags; |
| 637 |
|
| 638 |
/* |
| 639 |
* any extent bigger than this will be considered |
| 640 |
* already defragged. Use 0 to take the kernel default |
| 641 |
* Use 1 to say every single extent must be rewritten |
| 642 |
*/ |
| 643 |
__u32 extent_thresh; |
| 644 |
|
| 645 |
/* |
| 646 |
* which compression method to use if turning on compression |
| 647 |
* for this defrag operation. If unspecified, zlib will be |
| 648 |
* used. If compression level is also being specified, set the |
| 649 |
* BTRFS_DEFRAG_RANGE_COMPRESS_LEVEL flag and fill the compress |
| 650 |
* member structure instead of the compress_type field. |
| 651 |
*/ |
| 652 |
union { |
| 653 |
__u32 compress_type; |
| 654 |
struct { |
| 655 |
__u8 type; |
| 656 |
__s8 level; |
| 657 |
} compress; |
| 658 |
}; |
| 659 |
|
| 660 |
/* spare for later */ |
| 661 |
__u32 unused[4]; |
| 662 |
}; |
| 663 |
|
| 664 |
|
| 665 |
#define BTRFS_SAME_DATA_DIFFERS 1 |
| 666 |
/* For extent-same ioctl */ |
| 667 |
struct btrfs_ioctl_same_extent_info { |
| 668 |
__s64 fd; /* in - destination file */ |
| 669 |
__u64 logical_offset; /* in - start of extent in destination */ |
| 670 |
__u64 bytes_deduped; /* out - total # of bytes we were able |
| 671 |
* to dedupe from this file */ |
| 672 |
/* status of this dedupe operation: |
| 673 |
* 0 if dedup succeeds |
| 674 |
* < 0 for error |
| 675 |
* == BTRFS_SAME_DATA_DIFFERS if data differs |
| 676 |
*/ |
| 677 |
__s32 status; /* out - see above description */ |
| 678 |
__u32 reserved; |
| 679 |
}; |
| 680 |
|
| 681 |
struct btrfs_ioctl_same_args { |
| 682 |
__u64 logical_offset; /* in - start of extent in source */ |
| 683 |
__u64 length; /* in - length of extent */ |
| 684 |
__u16 dest_count; /* in - total elements in info array */ |
| 685 |
__u16 reserved1; |
| 686 |
__u32 reserved2; |
| 687 |
struct btrfs_ioctl_same_extent_info info[]; |
| 688 |
}; |
| 689 |
|
| 690 |
struct btrfs_ioctl_space_info { |
| 691 |
__u64 flags; |
| 692 |
__u64 total_bytes; |
| 693 |
__u64 used_bytes; |
| 694 |
}; |
| 695 |
|
| 696 |
struct btrfs_ioctl_space_args { |
| 697 |
__u64 space_slots; |
| 698 |
__u64 total_spaces; |
| 699 |
struct btrfs_ioctl_space_info spaces[]; |
| 700 |
}; |
| 701 |
|
| 702 |
struct btrfs_data_container { |
| 703 |
__u32 bytes_left; /* out -- bytes not needed to deliver output */ |
| 704 |
__u32 bytes_missing; /* out -- additional bytes needed for result */ |
| 705 |
__u32 elem_cnt; /* out */ |
| 706 |
__u32 elem_missed; /* out */ |
| 707 |
__u64 val[]; /* out */ |
| 708 |
}; |
| 709 |
|
| 710 |
struct btrfs_ioctl_ino_path_args { |
| 711 |
__u64 inum; /* in */ |
| 712 |
__u64 size; /* in */ |
| 713 |
__u64 reserved[4]; |
| 714 |
/* struct btrfs_data_container *fspath; out */ |
| 715 |
__u64 fspath; /* out */ |
| 716 |
}; |
| 717 |
|
| 718 |
struct btrfs_ioctl_logical_ino_args { |
| 719 |
__u64 logical; /* in */ |
| 720 |
__u64 size; /* in */ |
| 721 |
__u64 reserved[3]; /* must be 0 for now */ |
| 722 |
__u64 flags; /* in, v2 only */ |
| 723 |
/* struct btrfs_data_container *inodes; out */ |
| 724 |
__u64 inodes; |
| 725 |
}; |
| 726 |
|
| 727 |
/* |
| 728 |
* Return every ref to the extent, not just those containing logical block. |
| 729 |
* Requires logical == extent bytenr. |
| 730 |
*/ |
| 731 |
#define BTRFS_LOGICAL_INO_ARGS_IGNORE_OFFSET (1ULL << 0) |
| 732 |
|
| 733 |
enum btrfs_dev_stat_values { |
| 734 |
/* disk I/O failure stats */ |
| 735 |
BTRFS_DEV_STAT_WRITE_ERRS, /* EIO or EREMOTEIO from lower layers */ |
| 736 |
BTRFS_DEV_STAT_READ_ERRS, /* EIO or EREMOTEIO from lower layers */ |
| 737 |
BTRFS_DEV_STAT_FLUSH_ERRS, /* EIO or EREMOTEIO from lower layers */ |
| 738 |
|
| 739 |
/* stats for indirect indications for I/O failures */ |
| 740 |
BTRFS_DEV_STAT_CORRUPTION_ERRS, /* checksum error, bytenr error or |
| 741 |
* contents is illegal: this is an |
| 742 |
* indication that the block was damaged |
| 743 |
* during read or write, or written to |
| 744 |
* wrong location or read from wrong |
| 745 |
* location */ |
| 746 |
BTRFS_DEV_STAT_GENERATION_ERRS, /* an indication that blocks have not |
| 747 |
* been written */ |
| 748 |
|
| 749 |
BTRFS_DEV_STAT_VALUES_MAX |
| 750 |
}; |
| 751 |
|
| 752 |
/* Reset statistics after reading; needs SYS_ADMIN capability */ |
| 753 |
#define BTRFS_DEV_STATS_RESET (1ULL << 0) |
| 754 |
|
| 755 |
struct btrfs_ioctl_get_dev_stats { |
| 756 |
__u64 devid; /* in */ |
| 757 |
__u64 nr_items; /* in/out */ |
| 758 |
__u64 flags; /* in/out */ |
| 759 |
|
| 760 |
/* out values: */ |
| 761 |
__u64 values[BTRFS_DEV_STAT_VALUES_MAX]; |
| 762 |
|
| 763 |
/* |
| 764 |
* This pads the struct to 1032 bytes. It was originally meant to pad to |
| 765 |
* 1024 bytes, but when adding the flags field, the padding calculation |
| 766 |
* was not adjusted. |
| 767 |
*/ |
| 768 |
__u64 unused[128 - 2 - BTRFS_DEV_STAT_VALUES_MAX]; |
| 769 |
}; |
| 770 |
|
| 771 |
#define BTRFS_QUOTA_CTL_ENABLE 1 |
| 772 |
#define BTRFS_QUOTA_CTL_DISABLE 2 |
| 773 |
#define BTRFS_QUOTA_CTL_RESCAN__NOTUSED 3 |
| 774 |
#define BTRFS_QUOTA_CTL_ENABLE_SIMPLE_QUOTA 4 |
| 775 |
struct btrfs_ioctl_quota_ctl_args { |
| 776 |
__u64 cmd; |
| 777 |
__u64 status; |
| 778 |
}; |
| 779 |
|
| 780 |
struct btrfs_ioctl_quota_rescan_args { |
| 781 |
__u64 flags; |
| 782 |
__u64 progress; |
| 783 |
__u64 reserved[6]; |
| 784 |
}; |
| 785 |
|
| 786 |
struct btrfs_ioctl_qgroup_assign_args { |
| 787 |
__u64 assign; |
| 788 |
__u64 src; |
| 789 |
__u64 dst; |
| 790 |
}; |
| 791 |
|
| 792 |
struct btrfs_ioctl_qgroup_create_args { |
| 793 |
__u64 create; |
| 794 |
__u64 qgroupid; |
| 795 |
}; |
| 796 |
struct btrfs_ioctl_timespec { |
| 797 |
__u64 sec; |
| 798 |
__u32 nsec; |
| 799 |
}; |
| 800 |
|
| 801 |
struct btrfs_ioctl_received_subvol_args { |
| 802 |
char uuid[BTRFS_UUID_SIZE]; /* in */ |
| 803 |
__u64 stransid; /* in */ |
| 804 |
__u64 rtransid; /* out */ |
| 805 |
struct btrfs_ioctl_timespec stime; /* in */ |
| 806 |
struct btrfs_ioctl_timespec rtime; /* out */ |
| 807 |
__u64 flags; /* in */ |
| 808 |
__u64 reserved[16]; /* in */ |
| 809 |
}; |
| 810 |
|
| 811 |
/* |
| 812 |
* Caller doesn't want file data in the send stream, even if the |
| 813 |
* search of clone sources doesn't find an extent. UPDATE_EXTENT |
| 814 |
* commands will be sent instead of WRITE commands. |
| 815 |
*/ |
| 816 |
#define BTRFS_SEND_FLAG_NO_FILE_DATA 0x1 |
| 817 |
|
| 818 |
/* |
| 819 |
* Do not add the leading stream header. Used when multiple snapshots |
| 820 |
* are sent back to back. |
| 821 |
*/ |
| 822 |
#define BTRFS_SEND_FLAG_OMIT_STREAM_HEADER 0x2 |
| 823 |
|
| 824 |
/* |
| 825 |
* Omit the command at the end of the stream that indicated the end |
| 826 |
* of the stream. This option is used when multiple snapshots are |
| 827 |
* sent back to back. |
| 828 |
*/ |
| 829 |
#define BTRFS_SEND_FLAG_OMIT_END_CMD 0x4 |
| 830 |
|
| 831 |
/* |
| 832 |
* Read the protocol version in the structure |
| 833 |
*/ |
| 834 |
#define BTRFS_SEND_FLAG_VERSION 0x8 |
| 835 |
|
| 836 |
/* |
| 837 |
* Send compressed data using the ENCODED_WRITE command instead of decompressing |
| 838 |
* the data and sending it with the WRITE command. This requires protocol |
| 839 |
* version >= 2. |
| 840 |
*/ |
| 841 |
#define BTRFS_SEND_FLAG_COMPRESSED 0x10 |
| 842 |
|
| 843 |
#define BTRFS_SEND_FLAG_MASK \ |
| 844 |
(BTRFS_SEND_FLAG_NO_FILE_DATA | \ |
| 845 |
BTRFS_SEND_FLAG_OMIT_STREAM_HEADER | \ |
| 846 |
BTRFS_SEND_FLAG_OMIT_END_CMD | \ |
| 847 |
BTRFS_SEND_FLAG_VERSION | \ |
| 848 |
BTRFS_SEND_FLAG_COMPRESSED) |
| 849 |
|
| 850 |
struct btrfs_ioctl_send_args { |
| 851 |
__s64 send_fd; /* in */ |
| 852 |
__u64 clone_sources_count; /* in */ |
| 853 |
__u64 *clone_sources; /* in */ |
| 854 |
__u64 parent_root; /* in */ |
| 855 |
__u64 flags; /* in */ |
| 856 |
__u32 version; /* in */ |
| 857 |
__u8 reserved[28]; /* in */ |
| 858 |
}; |
| 859 |
|
| 860 |
/* |
| 861 |
* Information about a fs tree root. |
| 862 |
* |
| 863 |
* All items are filled by the ioctl |
| 864 |
*/ |
| 865 |
struct btrfs_ioctl_get_subvol_info_args { |
| 866 |
/* Id of this subvolume */ |
| 867 |
__u64 treeid; |
| 868 |
|
| 869 |
/* Name of this subvolume, used to get the real name at mount point */ |
| 870 |
char name[BTRFS_VOL_NAME_MAX + 1]; |
| 871 |
|
| 872 |
/* |
| 873 |
* Id of the subvolume which contains this subvolume. |
| 874 |
* Zero for top-level subvolume or a deleted subvolume. |
| 875 |
*/ |
| 876 |
__u64 parent_id; |
| 877 |
|
| 878 |
/* |
| 879 |
* Inode number of the directory which contains this subvolume. |
| 880 |
* Zero for top-level subvolume or a deleted subvolume |
| 881 |
*/ |
| 882 |
__u64 dirid; |
| 883 |
|
| 884 |
/* Latest transaction id of this subvolume */ |
| 885 |
__u64 generation; |
| 886 |
|
| 887 |
/* Flags of this subvolume */ |
| 888 |
__u64 flags; |
| 889 |
|
| 890 |
/* UUID of this subvolume */ |
| 891 |
__u8 uuid[BTRFS_UUID_SIZE]; |
| 892 |
|
| 893 |
/* |
| 894 |
* UUID of the subvolume of which this subvolume is a snapshot. |
| 895 |
* All zero for a non-snapshot subvolume. |
| 896 |
*/ |
| 897 |
__u8 parent_uuid[BTRFS_UUID_SIZE]; |
| 898 |
|
| 899 |
/* |
| 900 |
* UUID of the subvolume from which this subvolume was received. |
| 901 |
* All zero for non-received subvolume. |
| 902 |
*/ |
| 903 |
__u8 received_uuid[BTRFS_UUID_SIZE]; |
| 904 |
|
| 905 |
/* Transaction id indicating when change/create/send/receive happened */ |
| 906 |
__u64 ctransid; |
| 907 |
__u64 otransid; |
| 908 |
__u64 stransid; |
| 909 |
__u64 rtransid; |
| 910 |
/* Time corresponding to c/o/s/rtransid */ |
| 911 |
struct btrfs_ioctl_timespec ctime; |
| 912 |
struct btrfs_ioctl_timespec otime; |
| 913 |
struct btrfs_ioctl_timespec stime; |
| 914 |
struct btrfs_ioctl_timespec rtime; |
| 915 |
|
| 916 |
/* Must be zero */ |
| 917 |
__u64 reserved[8]; |
| 918 |
}; |
| 919 |
|
| 920 |
#define BTRFS_MAX_ROOTREF_BUFFER_NUM 255 |
| 921 |
struct btrfs_ioctl_get_subvol_rootref_args { |
| 922 |
/* in/out, minimum id of rootref's treeid to be searched */ |
| 923 |
__u64 min_treeid; |
| 924 |
|
| 925 |
/* out */ |
| 926 |
struct { |
| 927 |
__u64 treeid; |
| 928 |
__u64 dirid; |
| 929 |
} rootref[BTRFS_MAX_ROOTREF_BUFFER_NUM]; |
| 930 |
|
| 931 |
/* out, number of found items */ |
| 932 |
__u8 num_items; |
| 933 |
__u8 align[7]; |
| 934 |
}; |
| 935 |
|
| 936 |
/* |
| 937 |
* Data and metadata for an encoded read or write. |
| 938 |
* |
| 939 |
* Encoded I/O bypasses any encoding automatically done by the filesystem (e.g., |
| 940 |
* compression). This can be used to read the compressed contents of a file or |
| 941 |
* write pre-compressed data directly to a file. |
| 942 |
* |
| 943 |
* BTRFS_IOC_ENCODED_READ and BTRFS_IOC_ENCODED_WRITE are essentially |
| 944 |
* preadv/pwritev with additional metadata about how the data is encoded and the |
| 945 |
* size of the unencoded data. |
| 946 |
* |
| 947 |
* BTRFS_IOC_ENCODED_READ fills the given iovecs with the encoded data, fills |
| 948 |
* the metadata fields, and returns the size of the encoded data. It reads one |
| 949 |
* extent per call. It can also read data which is not encoded. |
| 950 |
* |
| 951 |
* BTRFS_IOC_ENCODED_WRITE uses the metadata fields, writes the encoded data |
| 952 |
* from the iovecs, and returns the size of the encoded data. Note that the |
| 953 |
* encoded data is not validated when it is written; if it is not valid (e.g., |
| 954 |
* it cannot be decompressed), then a subsequent read may return an error. |
| 955 |
* |
| 956 |
* Since the filesystem page cache contains decoded data, encoded I/O bypasses |
| 957 |
* the page cache. Encoded I/O requires CAP_SYS_ADMIN. |
| 958 |
*/ |
| 959 |
struct btrfs_ioctl_encoded_io_args { |
| 960 |
/* Input parameters for both reads and writes. */ |
| 961 |
|
| 962 |
/* |
| 963 |
* iovecs containing encoded data. |
| 964 |
* |
| 965 |
* For reads, if the size of the encoded data is larger than the sum of |
| 966 |
* iov[n].iov_len for 0 <= n < iovcnt, then the ioctl fails with |
| 967 |
* ENOBUFS. |
| 968 |
* |
| 969 |
* For writes, the size of the encoded data is the sum of iov[n].iov_len |
| 970 |
* for 0 <= n < iovcnt. This must be less than 128 KiB (this limit may |
| 971 |
* increase in the future). This must also be less than or equal to |
| 972 |
* unencoded_len. |
| 973 |
*/ |
| 974 |
const struct iovec *iov; |
| 975 |
/* Number of iovecs. */ |
| 976 |
unsigned long iovcnt; |
| 977 |
/* |
| 978 |
* Offset in file. |
| 979 |
* |
| 980 |
* For writes, must be aligned to the sector size of the filesystem. |
| 981 |
*/ |
| 982 |
__s64 offset; |
| 983 |
/* Currently must be zero. */ |
| 984 |
__u64 flags; |
| 985 |
|
| 986 |
/* |
| 987 |
* For reads, the following members are output parameters that will |
| 988 |
* contain the returned metadata for the encoded data. |
| 989 |
* For writes, the following members must be set to the metadata for the |
| 990 |
* encoded data. |
| 991 |
*/ |
| 992 |
|
| 993 |
/* |
| 994 |
* Length of the data in the file. |
| 995 |
* |
| 996 |
* Must be less than or equal to unencoded_len - unencoded_offset. For |
| 997 |
* writes, must be aligned to the sector size of the filesystem unless |
| 998 |
* the data ends at or beyond the current end of the file. |
| 999 |
*/ |
| 1000 |
__u64 len; |
| 1001 |
/* |
| 1002 |
* Length of the unencoded (i.e., decrypted and decompressed) data. |
| 1003 |
* |
| 1004 |
* For writes, must be no more than 128 KiB (this limit may increase in |
| 1005 |
* the future). If the unencoded data is actually longer than |
| 1006 |
* unencoded_len, then it is truncated; if it is shorter, then it is |
| 1007 |
* extended with zeroes. |
| 1008 |
*/ |
| 1009 |
__u64 unencoded_len; |
| 1010 |
/* |
| 1011 |
* Offset from the first byte of the unencoded data to the first byte of |
| 1012 |
* logical data in the file. |
| 1013 |
* |
| 1014 |
* Must be less than unencoded_len. |
| 1015 |
*/ |
| 1016 |
__u64 unencoded_offset; |
| 1017 |
/* |
| 1018 |
* BTRFS_ENCODED_IO_COMPRESSION_* type. |
| 1019 |
* |
| 1020 |
* For writes, must not be BTRFS_ENCODED_IO_COMPRESSION_NONE. |
| 1021 |
*/ |
| 1022 |
__u32 compression; |
| 1023 |
/* Currently always BTRFS_ENCODED_IO_ENCRYPTION_NONE. */ |
| 1024 |
__u32 encryption; |
| 1025 |
/* |
| 1026 |
* Reserved for future expansion. |
| 1027 |
* |
| 1028 |
* For reads, always returned as zero. Users should check for non-zero |
| 1029 |
* bytes. If there are any, then the kernel has a newer version of this |
| 1030 |
* structure with additional information that the user definition is |
| 1031 |
* missing. |
| 1032 |
* |
| 1033 |
* For writes, must be zeroed. |
| 1034 |
*/ |
| 1035 |
__u8 reserved[64]; |
| 1036 |
}; |
| 1037 |
|
| 1038 |
/* Data is not compressed. */ |
| 1039 |
#define BTRFS_ENCODED_IO_COMPRESSION_NONE 0 |
| 1040 |
/* Data is compressed as a single zlib stream. */ |
| 1041 |
#define BTRFS_ENCODED_IO_COMPRESSION_ZLIB 1 |
| 1042 |
/* |
| 1043 |
* Data is compressed as a single zstd frame with the windowLog compression |
| 1044 |
* parameter set to no more than 17. |
| 1045 |
*/ |
| 1046 |
#define BTRFS_ENCODED_IO_COMPRESSION_ZSTD 2 |
| 1047 |
/* |
| 1048 |
* Data is compressed sector by sector (using the sector size indicated by the |
| 1049 |
* name of the constant) with LZO1X and wrapped in the format documented in |
| 1050 |
* fs/btrfs/lzo.c. For writes, the compression sector size must match the |
| 1051 |
* filesystem sector size. |
| 1052 |
*/ |
| 1053 |
#define BTRFS_ENCODED_IO_COMPRESSION_LZO_4K 3 |
| 1054 |
#define BTRFS_ENCODED_IO_COMPRESSION_LZO_8K 4 |
| 1055 |
#define BTRFS_ENCODED_IO_COMPRESSION_LZO_16K 5 |
| 1056 |
#define BTRFS_ENCODED_IO_COMPRESSION_LZO_32K 6 |
| 1057 |
#define BTRFS_ENCODED_IO_COMPRESSION_LZO_64K 7 |
| 1058 |
#define BTRFS_ENCODED_IO_COMPRESSION_TYPES 8 |
| 1059 |
|
| 1060 |
/* Data is not encrypted. */ |
| 1061 |
#define BTRFS_ENCODED_IO_ENCRYPTION_NONE 0 |
| 1062 |
#define BTRFS_ENCODED_IO_ENCRYPTION_TYPES 1 |
| 1063 |
|
| 1064 |
/* |
| 1065 |
* Wait for subvolume cleaning process. This queries the kernel queue and it |
| 1066 |
* can change between the calls. |
| 1067 |
* |
| 1068 |
* - FOR_ONE - specify the subvolid |
| 1069 |
* - FOR_QUEUED - wait for all currently queued |
| 1070 |
* - COUNT - count number of queued |
| 1071 |
* - PEEK_FIRST - read which is the first in the queue (to be cleaned or being |
| 1072 |
* cleaned already), or 0 if the queue is empty |
| 1073 |
* - PEEK_LAST - read the last subvolid in the queue, or 0 if the queue is empty |
| 1074 |
*/ |
| 1075 |
struct btrfs_ioctl_subvol_wait { |
| 1076 |
__u64 subvolid; |
| 1077 |
__u32 mode; |
| 1078 |
__u32 count; |
| 1079 |
}; |
| 1080 |
|
| 1081 |
#define BTRFS_SUBVOL_SYNC_WAIT_FOR_ONE (0) |
| 1082 |
#define BTRFS_SUBVOL_SYNC_WAIT_FOR_QUEUED (1) |
| 1083 |
#define BTRFS_SUBVOL_SYNC_COUNT (2) |
| 1084 |
#define BTRFS_SUBVOL_SYNC_PEEK_FIRST (3) |
| 1085 |
#define BTRFS_SUBVOL_SYNC_PEEK_LAST (4) |
| 1086 |
|
| 1087 |
/* Error codes as returned by the kernel */ |
| 1088 |
enum btrfs_err_code { |
| 1089 |
BTRFS_ERROR_DEV_RAID1_MIN_NOT_MET = 1, |
| 1090 |
BTRFS_ERROR_DEV_RAID10_MIN_NOT_MET, |
| 1091 |
BTRFS_ERROR_DEV_RAID5_MIN_NOT_MET, |
| 1092 |
BTRFS_ERROR_DEV_RAID6_MIN_NOT_MET, |
| 1093 |
BTRFS_ERROR_DEV_TGT_REPLACE, |
| 1094 |
BTRFS_ERROR_DEV_MISSING_NOT_FOUND, |
| 1095 |
BTRFS_ERROR_DEV_ONLY_WRITABLE, |
| 1096 |
BTRFS_ERROR_DEV_EXCL_RUN_IN_PROGRESS, |
| 1097 |
BTRFS_ERROR_DEV_RAID1C3_MIN_NOT_MET, |
| 1098 |
BTRFS_ERROR_DEV_RAID1C4_MIN_NOT_MET, |
| 1099 |
}; |
| 1100 |
|
| 1101 |
/* Flags for IOC_SHUTDOWN, must match XFS_FSOP_GOING_FLAGS_* flags. */ |
| 1102 |
#define BTRFS_SHUTDOWN_FLAGS_DEFAULT 0x0 |
| 1103 |
#define BTRFS_SHUTDOWN_FLAGS_LOGFLUSH 0x1 |
| 1104 |
#define BTRFS_SHUTDOWN_FLAGS_NOLOGFLUSH 0x2 |
| 1105 |
#define BTRFS_SHUTDOWN_FLAGS_LAST 0x3 |
| 1106 |
|
| 1107 |
#define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \ |
| 1108 |
struct btrfs_ioctl_vol_args) |
| 1109 |
#define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \ |
| 1110 |
struct btrfs_ioctl_vol_args) |
| 1111 |
#define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \ |
| 1112 |
struct btrfs_ioctl_vol_args) |
| 1113 |
#define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \ |
| 1114 |
struct btrfs_ioctl_vol_args) |
| 1115 |
#define BTRFS_IOC_FORGET_DEV _IOW(BTRFS_IOCTL_MAGIC, 5, \ |
| 1116 |
struct btrfs_ioctl_vol_args) |
| 1117 |
/* trans start and trans end are dangerous, and only for |
| 1118 |
* use by applications that know how to avoid the |
| 1119 |
* resulting deadlocks |
| 1120 |
*/ |
| 1121 |
#define BTRFS_IOC_TRANS_START _IO(BTRFS_IOCTL_MAGIC, 6) |
| 1122 |
#define BTRFS_IOC_TRANS_END _IO(BTRFS_IOCTL_MAGIC, 7) |
| 1123 |
#define BTRFS_IOC_SYNC _IO(BTRFS_IOCTL_MAGIC, 8) |
| 1124 |
|
| 1125 |
#define BTRFS_IOC_CLONE _IOW(BTRFS_IOCTL_MAGIC, 9, int) |
| 1126 |
#define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \ |
| 1127 |
struct btrfs_ioctl_vol_args) |
| 1128 |
#define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \ |
| 1129 |
struct btrfs_ioctl_vol_args) |
| 1130 |
#define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \ |
| 1131 |
struct btrfs_ioctl_vol_args) |
| 1132 |
|
| 1133 |
#define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \ |
| 1134 |
struct btrfs_ioctl_clone_range_args) |
| 1135 |
|
| 1136 |
#define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \ |
| 1137 |
struct btrfs_ioctl_vol_args) |
| 1138 |
#define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \ |
| 1139 |
struct btrfs_ioctl_vol_args) |
| 1140 |
#define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \ |
| 1141 |
struct btrfs_ioctl_defrag_range_args) |
| 1142 |
#define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \ |
| 1143 |
struct btrfs_ioctl_search_args) |
| 1144 |
#define BTRFS_IOC_TREE_SEARCH_V2 _IOWR(BTRFS_IOCTL_MAGIC, 17, \ |
| 1145 |
struct btrfs_ioctl_search_args_v2) |
| 1146 |
#define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \ |
| 1147 |
struct btrfs_ioctl_ino_lookup_args) |
| 1148 |
#define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, __u64) |
| 1149 |
#define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \ |
| 1150 |
struct btrfs_ioctl_space_args) |
| 1151 |
#define BTRFS_IOC_START_SYNC _IOR(BTRFS_IOCTL_MAGIC, 24, __u64) |
| 1152 |
#define BTRFS_IOC_WAIT_SYNC _IOW(BTRFS_IOCTL_MAGIC, 22, __u64) |
| 1153 |
#define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \ |
| 1154 |
struct btrfs_ioctl_vol_args_v2) |
| 1155 |
#define BTRFS_IOC_SUBVOL_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 24, \ |
| 1156 |
struct btrfs_ioctl_vol_args_v2) |
| 1157 |
#define BTRFS_IOC_SUBVOL_GETFLAGS _IOR(BTRFS_IOCTL_MAGIC, 25, __u64) |
| 1158 |
#define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64) |
| 1159 |
#define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \ |
| 1160 |
struct btrfs_ioctl_scrub_args) |
| 1161 |
#define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28) |
| 1162 |
#define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \ |
| 1163 |
struct btrfs_ioctl_scrub_args) |
| 1164 |
#define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \ |
| 1165 |
struct btrfs_ioctl_dev_info_args) |
| 1166 |
#define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \ |
| 1167 |
struct btrfs_ioctl_fs_info_args) |
| 1168 |
#define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \ |
| 1169 |
struct btrfs_ioctl_balance_args) |
| 1170 |
#define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int) |
| 1171 |
#define BTRFS_IOC_BALANCE_PROGRESS _IOR(BTRFS_IOCTL_MAGIC, 34, \ |
| 1172 |
struct btrfs_ioctl_balance_args) |
| 1173 |
#define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \ |
| 1174 |
struct btrfs_ioctl_ino_path_args) |
| 1175 |
#define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \ |
| 1176 |
struct btrfs_ioctl_logical_ino_args) |
| 1177 |
#define BTRFS_IOC_SET_RECEIVED_SUBVOL _IOWR(BTRFS_IOCTL_MAGIC, 37, \ |
| 1178 |
struct btrfs_ioctl_received_subvol_args) |
| 1179 |
#define BTRFS_IOC_SEND _IOW(BTRFS_IOCTL_MAGIC, 38, struct btrfs_ioctl_send_args) |
| 1180 |
#define BTRFS_IOC_DEVICES_READY _IOR(BTRFS_IOCTL_MAGIC, 39, \ |
| 1181 |
struct btrfs_ioctl_vol_args) |
| 1182 |
#define BTRFS_IOC_QUOTA_CTL _IOWR(BTRFS_IOCTL_MAGIC, 40, \ |
| 1183 |
struct btrfs_ioctl_quota_ctl_args) |
| 1184 |
#define BTRFS_IOC_QGROUP_ASSIGN _IOW(BTRFS_IOCTL_MAGIC, 41, \ |
| 1185 |
struct btrfs_ioctl_qgroup_assign_args) |
| 1186 |
#define BTRFS_IOC_QGROUP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 42, \ |
| 1187 |
struct btrfs_ioctl_qgroup_create_args) |
| 1188 |
#define BTRFS_IOC_QGROUP_LIMIT _IOR(BTRFS_IOCTL_MAGIC, 43, \ |
| 1189 |
struct btrfs_ioctl_qgroup_limit_args) |
| 1190 |
#define BTRFS_IOC_QUOTA_RESCAN _IOW(BTRFS_IOCTL_MAGIC, 44, \ |
| 1191 |
struct btrfs_ioctl_quota_rescan_args) |
| 1192 |
#define BTRFS_IOC_QUOTA_RESCAN_STATUS _IOR(BTRFS_IOCTL_MAGIC, 45, \ |
| 1193 |
struct btrfs_ioctl_quota_rescan_args) |
| 1194 |
#define BTRFS_IOC_QUOTA_RESCAN_WAIT _IO(BTRFS_IOCTL_MAGIC, 46) |
| 1195 |
#define BTRFS_IOC_GET_FSLABEL FS_IOC_GETFSLABEL |
| 1196 |
#define BTRFS_IOC_SET_FSLABEL FS_IOC_SETFSLABEL |
| 1197 |
#define BTRFS_IOC_GET_DEV_STATS _IOWR(BTRFS_IOCTL_MAGIC, 52, \ |
| 1198 |
struct btrfs_ioctl_get_dev_stats) |
| 1199 |
#define BTRFS_IOC_DEV_REPLACE _IOWR(BTRFS_IOCTL_MAGIC, 53, \ |
| 1200 |
struct btrfs_ioctl_dev_replace_args) |
| 1201 |
#define BTRFS_IOC_FILE_EXTENT_SAME _IOWR(BTRFS_IOCTL_MAGIC, 54, \ |
| 1202 |
struct btrfs_ioctl_same_args) |
| 1203 |
#define BTRFS_IOC_GET_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \ |
| 1204 |
struct btrfs_ioctl_feature_flags) |
| 1205 |
#define BTRFS_IOC_SET_FEATURES _IOW(BTRFS_IOCTL_MAGIC, 57, \ |
| 1206 |
struct btrfs_ioctl_feature_flags[2]) |
| 1207 |
#define BTRFS_IOC_GET_SUPPORTED_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \ |
| 1208 |
struct btrfs_ioctl_feature_flags[3]) |
| 1209 |
#define BTRFS_IOC_RM_DEV_V2 _IOW(BTRFS_IOCTL_MAGIC, 58, \ |
| 1210 |
struct btrfs_ioctl_vol_args_v2) |
| 1211 |
#define BTRFS_IOC_LOGICAL_INO_V2 _IOWR(BTRFS_IOCTL_MAGIC, 59, \ |
| 1212 |
struct btrfs_ioctl_logical_ino_args) |
| 1213 |
#define BTRFS_IOC_GET_SUBVOL_INFO _IOR(BTRFS_IOCTL_MAGIC, 60, \ |
| 1214 |
struct btrfs_ioctl_get_subvol_info_args) |
| 1215 |
#define BTRFS_IOC_GET_SUBVOL_ROOTREF _IOWR(BTRFS_IOCTL_MAGIC, 61, \ |
| 1216 |
struct btrfs_ioctl_get_subvol_rootref_args) |
| 1217 |
#define BTRFS_IOC_INO_LOOKUP_USER _IOWR(BTRFS_IOCTL_MAGIC, 62, \ |
| 1218 |
struct btrfs_ioctl_ino_lookup_user_args) |
| 1219 |
#define BTRFS_IOC_SNAP_DESTROY_V2 _IOW(BTRFS_IOCTL_MAGIC, 63, \ |
| 1220 |
struct btrfs_ioctl_vol_args_v2) |
| 1221 |
#define BTRFS_IOC_ENCODED_READ _IOR(BTRFS_IOCTL_MAGIC, 64, \ |
| 1222 |
struct btrfs_ioctl_encoded_io_args) |
| 1223 |
#define BTRFS_IOC_ENCODED_WRITE _IOW(BTRFS_IOCTL_MAGIC, 64, \ |
| 1224 |
struct btrfs_ioctl_encoded_io_args) |
| 1225 |
#define BTRFS_IOC_SUBVOL_SYNC_WAIT _IOW(BTRFS_IOCTL_MAGIC, 65, \ |
| 1226 |
struct btrfs_ioctl_subvol_wait) |
| 1227 |
|
| 1228 |
/* Shutdown ioctl should follow XFS's interfaces, thus not using btrfs magic. */ |
| 1229 |
#define BTRFS_IOC_SHUTDOWN _IOR('X', 125, __u32) |
| 1230 |
|
| 1231 |
#ifdef __cplusplus |
| 1232 |
} |
| 1233 |
#endif |
| 1234 |
|
| 1235 |
#endif /* _LINUX_BTRFS_H */ |