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