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