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