xref: /linux-6.15/include/uapi/linux/btrfs.h (revision bbb03029)
1 /*
2  * Copyright (C) 2007 Oracle.  All rights reserved.
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public
6  * License v2 as published by the Free Software Foundation.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
11  * General Public License for more details.
12  *
13  * You should have received a copy of the GNU General Public
14  * License along with this program; if not, write to the
15  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
16  * Boston, MA 021110-1307, USA.
17  */
18 
19 #ifndef _UAPI_LINUX_BTRFS_H
20 #define _UAPI_LINUX_BTRFS_H
21 #include <linux/types.h>
22 #include <linux/ioctl.h>
23 
24 #define BTRFS_IOCTL_MAGIC 0x94
25 #define BTRFS_VOL_NAME_MAX 255
26 #define BTRFS_LABEL_SIZE 256
27 
28 /* this should be 4k */
29 #define BTRFS_PATH_NAME_MAX 4087
30 struct btrfs_ioctl_vol_args {
31 	__s64 fd;
32 	char name[BTRFS_PATH_NAME_MAX + 1];
33 };
34 
35 #define BTRFS_DEVICE_PATH_NAME_MAX 1024
36 
37 #define BTRFS_DEVICE_SPEC_BY_ID		(1ULL << 3)
38 
39 #define BTRFS_VOL_ARG_V2_FLAGS_SUPPORTED		\
40 			(BTRFS_SUBVOL_CREATE_ASYNC |	\
41 			BTRFS_SUBVOL_RDONLY |		\
42 			BTRFS_SUBVOL_QGROUP_INHERIT |	\
43 			BTRFS_DEVICE_SPEC_BY_ID)
44 
45 #define BTRFS_FSID_SIZE 16
46 #define BTRFS_UUID_SIZE 16
47 #define BTRFS_UUID_UNPARSED_SIZE	37
48 
49 /*
50  * flags definition for qgroup limits
51  *
52  * Used by:
53  * struct btrfs_qgroup_limit.flags
54  * struct btrfs_qgroup_limit_item.flags
55  */
56 #define BTRFS_QGROUP_LIMIT_MAX_RFER	(1ULL << 0)
57 #define BTRFS_QGROUP_LIMIT_MAX_EXCL	(1ULL << 1)
58 #define BTRFS_QGROUP_LIMIT_RSV_RFER	(1ULL << 2)
59 #define BTRFS_QGROUP_LIMIT_RSV_EXCL	(1ULL << 3)
60 #define BTRFS_QGROUP_LIMIT_RFER_CMPR	(1ULL << 4)
61 #define BTRFS_QGROUP_LIMIT_EXCL_CMPR	(1ULL << 5)
62 
63 struct btrfs_qgroup_limit {
64 	__u64	flags;
65 	__u64	max_rfer;
66 	__u64	max_excl;
67 	__u64	rsv_rfer;
68 	__u64	rsv_excl;
69 };
70 
71 /*
72  * flags definition for qgroup inheritance
73  *
74  * Used by:
75  * struct btrfs_qgroup_inherit.flags
76  */
77 #define BTRFS_QGROUP_INHERIT_SET_LIMITS	(1ULL << 0)
78 
79 struct btrfs_qgroup_inherit {
80 	__u64	flags;
81 	__u64	num_qgroups;
82 	__u64	num_ref_copies;
83 	__u64	num_excl_copies;
84 	struct btrfs_qgroup_limit lim;
85 	__u64	qgroups[0];
86 };
87 
88 struct btrfs_ioctl_qgroup_limit_args {
89 	__u64	qgroupid;
90 	struct btrfs_qgroup_limit lim;
91 };
92 
93 /*
94  * flags for subvolumes
95  *
96  * Used by:
97  * struct btrfs_ioctl_vol_args_v2.flags
98  *
99  * BTRFS_SUBVOL_RDONLY is also provided/consumed by the following ioctls:
100  * - BTRFS_IOC_SUBVOL_GETFLAGS
101  * - BTRFS_IOC_SUBVOL_SETFLAGS
102  */
103 #define BTRFS_SUBVOL_CREATE_ASYNC	(1ULL << 0)
104 #define BTRFS_SUBVOL_RDONLY		(1ULL << 1)
105 #define BTRFS_SUBVOL_QGROUP_INHERIT	(1ULL << 2)
106 
107 #define BTRFS_SUBVOL_NAME_MAX 4039
108 struct btrfs_ioctl_vol_args_v2 {
109 	__s64 fd;
110 	__u64 transid;
111 	__u64 flags;
112 	union {
113 		struct {
114 			__u64 size;
115 			struct btrfs_qgroup_inherit __user *qgroup_inherit;
116 		};
117 		__u64 unused[4];
118 	};
119 	union {
120 		char name[BTRFS_SUBVOL_NAME_MAX + 1];
121 		__u64 devid;
122 	};
123 };
124 
125 /*
126  * structure to report errors and progress to userspace, either as a
127  * result of a finished scrub, a canceled scrub or a progress inquiry
128  */
129 struct btrfs_scrub_progress {
130 	__u64 data_extents_scrubbed;	/* # of data extents scrubbed */
131 	__u64 tree_extents_scrubbed;	/* # of tree extents scrubbed */
132 	__u64 data_bytes_scrubbed;	/* # of data bytes scrubbed */
133 	__u64 tree_bytes_scrubbed;	/* # of tree bytes scrubbed */
134 	__u64 read_errors;		/* # of read errors encountered (EIO) */
135 	__u64 csum_errors;		/* # of failed csum checks */
136 	__u64 verify_errors;		/* # of occurences, where the metadata
137 					 * of a tree block did not match the
138 					 * expected values, like generation or
139 					 * logical */
140 	__u64 no_csum;			/* # of 4k data block for which no csum
141 					 * is present, probably the result of
142 					 * data written with nodatasum */
143 	__u64 csum_discards;		/* # of csum for which no data was found
144 					 * in the extent tree. */
145 	__u64 super_errors;		/* # of bad super blocks encountered */
146 	__u64 malloc_errors;		/* # of internal kmalloc errors. These
147 					 * will likely cause an incomplete
148 					 * scrub */
149 	__u64 uncorrectable_errors;	/* # of errors where either no intact
150 					 * copy was found or the writeback
151 					 * failed */
152 	__u64 corrected_errors;		/* # of errors corrected */
153 	__u64 last_physical;		/* last physical address scrubbed. In
154 					 * case a scrub was aborted, this can
155 					 * be used to restart the scrub */
156 	__u64 unverified_errors;	/* # of occurences where a read for a
157 					 * full (64k) bio failed, but the re-
158 					 * check succeeded for each 4k piece.
159 					 * Intermittent error. */
160 };
161 
162 #define BTRFS_SCRUB_READONLY	1
163 struct btrfs_ioctl_scrub_args {
164 	__u64 devid;				/* in */
165 	__u64 start;				/* in */
166 	__u64 end;				/* in */
167 	__u64 flags;				/* in */
168 	struct btrfs_scrub_progress progress;	/* out */
169 	/* pad to 1k */
170 	__u64 unused[(1024-32-sizeof(struct btrfs_scrub_progress))/8];
171 };
172 
173 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_ALWAYS	0
174 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_AVOID	1
175 struct btrfs_ioctl_dev_replace_start_params {
176 	__u64 srcdevid;	/* in, if 0, use srcdev_name instead */
177 	__u64 cont_reading_from_srcdev_mode;	/* in, see #define
178 						 * above */
179 	__u8 srcdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1];	/* in */
180 	__u8 tgtdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1];	/* in */
181 };
182 
183 #define BTRFS_IOCTL_DEV_REPLACE_STATE_NEVER_STARTED	0
184 #define BTRFS_IOCTL_DEV_REPLACE_STATE_STARTED		1
185 #define BTRFS_IOCTL_DEV_REPLACE_STATE_FINISHED		2
186 #define BTRFS_IOCTL_DEV_REPLACE_STATE_CANCELED		3
187 #define BTRFS_IOCTL_DEV_REPLACE_STATE_SUSPENDED		4
188 struct btrfs_ioctl_dev_replace_status_params {
189 	__u64 replace_state;	/* out, see #define above */
190 	__u64 progress_1000;	/* out, 0 <= x <= 1000 */
191 	__u64 time_started;	/* out, seconds since 1-Jan-1970 */
192 	__u64 time_stopped;	/* out, seconds since 1-Jan-1970 */
193 	__u64 num_write_errors;	/* out */
194 	__u64 num_uncorrectable_read_errors;	/* out */
195 };
196 
197 #define BTRFS_IOCTL_DEV_REPLACE_CMD_START			0
198 #define BTRFS_IOCTL_DEV_REPLACE_CMD_STATUS			1
199 #define BTRFS_IOCTL_DEV_REPLACE_CMD_CANCEL			2
200 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NO_ERROR			0
201 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NOT_STARTED		1
202 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_ALREADY_STARTED		2
203 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_SCRUB_INPROGRESS		3
204 struct btrfs_ioctl_dev_replace_args {
205 	__u64 cmd;	/* in */
206 	__u64 result;	/* out */
207 
208 	union {
209 		struct btrfs_ioctl_dev_replace_start_params start;
210 		struct btrfs_ioctl_dev_replace_status_params status;
211 	};	/* in/out */
212 
213 	__u64 spare[64];
214 };
215 
216 struct btrfs_ioctl_dev_info_args {
217 	__u64 devid;				/* in/out */
218 	__u8 uuid[BTRFS_UUID_SIZE];		/* in/out */
219 	__u64 bytes_used;			/* out */
220 	__u64 total_bytes;			/* out */
221 	__u64 unused[379];			/* pad to 4k */
222 	__u8 path[BTRFS_DEVICE_PATH_NAME_MAX];	/* out */
223 };
224 
225 struct btrfs_ioctl_fs_info_args {
226 	__u64 max_id;				/* out */
227 	__u64 num_devices;			/* out */
228 	__u8 fsid[BTRFS_FSID_SIZE];		/* out */
229 	__u32 nodesize;				/* out */
230 	__u32 sectorsize;			/* out */
231 	__u32 clone_alignment;			/* out */
232 	__u32 reserved32;
233 	__u64 reserved[122];			/* pad to 1k */
234 };
235 
236 /*
237  * feature flags
238  *
239  * Used by:
240  * struct btrfs_ioctl_feature_flags
241  */
242 #define BTRFS_FEATURE_COMPAT_RO_FREE_SPACE_TREE		(1ULL << 0)
243 /*
244  * Older kernels (< 4.9) on big-endian systems produced broken free space tree
245  * bitmaps, and btrfs-progs also used to corrupt the free space tree (versions
246  * < 4.7.3).  If this bit is clear, then the free space tree cannot be trusted.
247  * btrfs-progs can also intentionally clear this bit to ask the kernel to
248  * rebuild the free space tree, however this might not work on older kernels
249  * that do not know about this bit. If not sure, clear the cache manually on
250  * first mount when booting older kernel versions.
251  */
252 #define BTRFS_FEATURE_COMPAT_RO_FREE_SPACE_TREE_VALID	(1ULL << 1)
253 
254 #define BTRFS_FEATURE_INCOMPAT_MIXED_BACKREF	(1ULL << 0)
255 #define BTRFS_FEATURE_INCOMPAT_DEFAULT_SUBVOL	(1ULL << 1)
256 #define BTRFS_FEATURE_INCOMPAT_MIXED_GROUPS	(1ULL << 2)
257 #define BTRFS_FEATURE_INCOMPAT_COMPRESS_LZO	(1ULL << 3)
258 /*
259  * some patches floated around with a second compression method
260  * lets save that incompat here for when they do get in
261  * Note we don't actually support it, we're just reserving the
262  * number
263  */
264 #define BTRFS_FEATURE_INCOMPAT_COMPRESS_LZOv2	(1ULL << 4)
265 
266 /*
267  * older kernels tried to do bigger metadata blocks, but the
268  * code was pretty buggy.  Lets not let them try anymore.
269  */
270 #define BTRFS_FEATURE_INCOMPAT_BIG_METADATA	(1ULL << 5)
271 
272 #define BTRFS_FEATURE_INCOMPAT_EXTENDED_IREF	(1ULL << 6)
273 #define BTRFS_FEATURE_INCOMPAT_RAID56		(1ULL << 7)
274 #define BTRFS_FEATURE_INCOMPAT_SKINNY_METADATA	(1ULL << 8)
275 #define BTRFS_FEATURE_INCOMPAT_NO_HOLES		(1ULL << 9)
276 
277 struct btrfs_ioctl_feature_flags {
278 	__u64 compat_flags;
279 	__u64 compat_ro_flags;
280 	__u64 incompat_flags;
281 };
282 
283 /* balance control ioctl modes */
284 #define BTRFS_BALANCE_CTL_PAUSE		1
285 #define BTRFS_BALANCE_CTL_CANCEL	2
286 
287 /*
288  * this is packed, because it should be exactly the same as its disk
289  * byte order counterpart (struct btrfs_disk_balance_args)
290  */
291 struct btrfs_balance_args {
292 	__u64 profiles;
293 	union {
294 		__u64 usage;
295 		struct {
296 			__u32 usage_min;
297 			__u32 usage_max;
298 		};
299 	};
300 	__u64 devid;
301 	__u64 pstart;
302 	__u64 pend;
303 	__u64 vstart;
304 	__u64 vend;
305 
306 	__u64 target;
307 
308 	__u64 flags;
309 
310 	/*
311 	 * BTRFS_BALANCE_ARGS_LIMIT with value 'limit'
312 	 * BTRFS_BALANCE_ARGS_LIMIT_RANGE - the extend version can use minimum
313 	 * and maximum
314 	 */
315 	union {
316 		__u64 limit;		/* limit number of processed chunks */
317 		struct {
318 			__u32 limit_min;
319 			__u32 limit_max;
320 		};
321 	};
322 
323 	/*
324 	 * Process chunks that cross stripes_min..stripes_max devices,
325 	 * BTRFS_BALANCE_ARGS_STRIPES_RANGE
326 	 */
327 	__u32 stripes_min;
328 	__u32 stripes_max;
329 
330 	__u64 unused[6];
331 } __attribute__ ((__packed__));
332 
333 /* report balance progress to userspace */
334 struct btrfs_balance_progress {
335 	__u64 expected;		/* estimated # of chunks that will be
336 				 * relocated to fulfill the request */
337 	__u64 considered;	/* # of chunks we have considered so far */
338 	__u64 completed;	/* # of chunks relocated so far */
339 };
340 
341 /*
342  * flags definition for balance
343  *
344  * Restriper's general type filter
345  *
346  * Used by:
347  * btrfs_ioctl_balance_args.flags
348  * btrfs_balance_control.flags (internal)
349  */
350 #define BTRFS_BALANCE_DATA		(1ULL << 0)
351 #define BTRFS_BALANCE_SYSTEM		(1ULL << 1)
352 #define BTRFS_BALANCE_METADATA		(1ULL << 2)
353 
354 #define BTRFS_BALANCE_TYPE_MASK		(BTRFS_BALANCE_DATA |	    \
355 					 BTRFS_BALANCE_SYSTEM |	    \
356 					 BTRFS_BALANCE_METADATA)
357 
358 #define BTRFS_BALANCE_FORCE		(1ULL << 3)
359 #define BTRFS_BALANCE_RESUME		(1ULL << 4)
360 
361 /*
362  * flags definitions for per-type balance args
363  *
364  * Balance filters
365  *
366  * Used by:
367  * struct btrfs_balance_args
368  */
369 #define BTRFS_BALANCE_ARGS_PROFILES	(1ULL << 0)
370 #define BTRFS_BALANCE_ARGS_USAGE	(1ULL << 1)
371 #define BTRFS_BALANCE_ARGS_DEVID	(1ULL << 2)
372 #define BTRFS_BALANCE_ARGS_DRANGE	(1ULL << 3)
373 #define BTRFS_BALANCE_ARGS_VRANGE	(1ULL << 4)
374 #define BTRFS_BALANCE_ARGS_LIMIT	(1ULL << 5)
375 #define BTRFS_BALANCE_ARGS_LIMIT_RANGE	(1ULL << 6)
376 #define BTRFS_BALANCE_ARGS_STRIPES_RANGE (1ULL << 7)
377 #define BTRFS_BALANCE_ARGS_USAGE_RANGE	(1ULL << 10)
378 
379 #define BTRFS_BALANCE_ARGS_MASK			\
380 	(BTRFS_BALANCE_ARGS_PROFILES |		\
381 	 BTRFS_BALANCE_ARGS_USAGE |		\
382 	 BTRFS_BALANCE_ARGS_DEVID | 		\
383 	 BTRFS_BALANCE_ARGS_DRANGE |		\
384 	 BTRFS_BALANCE_ARGS_VRANGE |		\
385 	 BTRFS_BALANCE_ARGS_LIMIT |		\
386 	 BTRFS_BALANCE_ARGS_LIMIT_RANGE |	\
387 	 BTRFS_BALANCE_ARGS_STRIPES_RANGE |	\
388 	 BTRFS_BALANCE_ARGS_USAGE_RANGE)
389 
390 /*
391  * Profile changing flags.  When SOFT is set we won't relocate chunk if
392  * it already has the target profile (even though it may be
393  * half-filled).
394  */
395 #define BTRFS_BALANCE_ARGS_CONVERT	(1ULL << 8)
396 #define BTRFS_BALANCE_ARGS_SOFT		(1ULL << 9)
397 
398 
399 /*
400  * flags definition for balance state
401  *
402  * Used by:
403  * struct btrfs_ioctl_balance_args.state
404  */
405 #define BTRFS_BALANCE_STATE_RUNNING	(1ULL << 0)
406 #define BTRFS_BALANCE_STATE_PAUSE_REQ	(1ULL << 1)
407 #define BTRFS_BALANCE_STATE_CANCEL_REQ	(1ULL << 2)
408 
409 struct btrfs_ioctl_balance_args {
410 	__u64 flags;				/* in/out */
411 	__u64 state;				/* out */
412 
413 	struct btrfs_balance_args data;		/* in/out */
414 	struct btrfs_balance_args meta;		/* in/out */
415 	struct btrfs_balance_args sys;		/* in/out */
416 
417 	struct btrfs_balance_progress stat;	/* out */
418 
419 	__u64 unused[72];			/* pad to 1k */
420 };
421 
422 #define BTRFS_INO_LOOKUP_PATH_MAX 4080
423 struct btrfs_ioctl_ino_lookup_args {
424 	__u64 treeid;
425 	__u64 objectid;
426 	char name[BTRFS_INO_LOOKUP_PATH_MAX];
427 };
428 
429 /* Search criteria for the btrfs SEARCH ioctl family. */
430 struct btrfs_ioctl_search_key {
431 	/*
432 	 * The tree we're searching in. 1 is the tree of tree roots, 2 is the
433 	 * extent tree, etc...
434 	 *
435 	 * A special tree_id value of 0 will cause a search in the subvolume
436 	 * tree that the inode which is passed to the ioctl is part of.
437 	 */
438 	__u64 tree_id;		/* in */
439 
440 	/*
441 	 * When doing a tree search, we're actually taking a slice from a
442 	 * linear search space of 136-bit keys.
443 	 *
444 	 * A full 136-bit tree key is composed as:
445 	 *   (objectid << 72) + (type << 64) + offset
446 	 *
447 	 * The individual min and max values for objectid, type and offset
448 	 * define the min_key and max_key values for the search range. All
449 	 * metadata items with a key in the interval [min_key, max_key] will be
450 	 * returned.
451 	 *
452 	 * Additionally, we can filter the items returned on transaction id of
453 	 * the metadata block they're stored in by specifying a transid range.
454 	 * Be aware that this transaction id only denotes when the metadata
455 	 * page that currently contains the item got written the last time as
456 	 * result of a COW operation.  The number does not have any meaning
457 	 * related to the transaction in which an individual item that is being
458 	 * returned was created or changed.
459 	 */
460 	__u64 min_objectid;	/* in */
461 	__u64 max_objectid;	/* in */
462 	__u64 min_offset;	/* in */
463 	__u64 max_offset;	/* in */
464 	__u64 min_transid;	/* in */
465 	__u64 max_transid;	/* in */
466 	__u32 min_type;		/* in */
467 	__u32 max_type;		/* in */
468 
469 	/*
470 	 * input: The maximum amount of results desired.
471 	 * output: The actual amount of items returned, restricted by any of:
472 	 *  - reaching the upper bound of the search range
473 	 *  - reaching the input nr_items amount of items
474 	 *  - completely filling the supplied memory buffer
475 	 */
476 	__u32 nr_items;		/* in/out */
477 
478 	/* align to 64 bits */
479 	__u32 unused;
480 
481 	/* some extra for later */
482 	__u64 unused1;
483 	__u64 unused2;
484 	__u64 unused3;
485 	__u64 unused4;
486 };
487 
488 struct btrfs_ioctl_search_header {
489 	__u64 transid;
490 	__u64 objectid;
491 	__u64 offset;
492 	__u32 type;
493 	__u32 len;
494 };
495 
496 #define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
497 /*
498  * the buf is an array of search headers where
499  * each header is followed by the actual item
500  * the type field is expanded to 32 bits for alignment
501  */
502 struct btrfs_ioctl_search_args {
503 	struct btrfs_ioctl_search_key key;
504 	char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
505 };
506 
507 struct btrfs_ioctl_search_args_v2 {
508 	struct btrfs_ioctl_search_key key; /* in/out - search parameters */
509 	__u64 buf_size;		   /* in - size of buffer
510 					    * out - on EOVERFLOW: needed size
511 					    *       to store item */
512 	__u64 buf[0];                       /* out - found items */
513 };
514 
515 struct btrfs_ioctl_clone_range_args {
516   __s64 src_fd;
517   __u64 src_offset, src_length;
518   __u64 dest_offset;
519 };
520 
521 /*
522  * flags definition for the defrag range ioctl
523  *
524  * Used by:
525  * struct btrfs_ioctl_defrag_range_args.flags
526  */
527 #define BTRFS_DEFRAG_RANGE_COMPRESS 1
528 #define BTRFS_DEFRAG_RANGE_START_IO 2
529 struct btrfs_ioctl_defrag_range_args {
530 	/* start of the defrag operation */
531 	__u64 start;
532 
533 	/* number of bytes to defrag, use (u64)-1 to say all */
534 	__u64 len;
535 
536 	/*
537 	 * flags for the operation, which can include turning
538 	 * on compression for this one defrag
539 	 */
540 	__u64 flags;
541 
542 	/*
543 	 * any extent bigger than this will be considered
544 	 * already defragged.  Use 0 to take the kernel default
545 	 * Use 1 to say every single extent must be rewritten
546 	 */
547 	__u32 extent_thresh;
548 
549 	/*
550 	 * which compression method to use if turning on compression
551 	 * for this defrag operation.  If unspecified, zlib will
552 	 * be used
553 	 */
554 	__u32 compress_type;
555 
556 	/* spare for later */
557 	__u32 unused[4];
558 };
559 
560 
561 #define BTRFS_SAME_DATA_DIFFERS	1
562 /* For extent-same ioctl */
563 struct btrfs_ioctl_same_extent_info {
564 	__s64 fd;		/* in - destination file */
565 	__u64 logical_offset;	/* in - start of extent in destination */
566 	__u64 bytes_deduped;	/* out - total # of bytes we were able
567 				 * to dedupe from this file */
568 	/* status of this dedupe operation:
569 	 * 0 if dedup succeeds
570 	 * < 0 for error
571 	 * == BTRFS_SAME_DATA_DIFFERS if data differs
572 	 */
573 	__s32 status;		/* out - see above description */
574 	__u32 reserved;
575 };
576 
577 struct btrfs_ioctl_same_args {
578 	__u64 logical_offset;	/* in - start of extent in source */
579 	__u64 length;		/* in - length of extent */
580 	__u16 dest_count;	/* in - total elements in info array */
581 	__u16 reserved1;
582 	__u32 reserved2;
583 	struct btrfs_ioctl_same_extent_info info[0];
584 };
585 
586 struct btrfs_ioctl_space_info {
587 	__u64 flags;
588 	__u64 total_bytes;
589 	__u64 used_bytes;
590 };
591 
592 struct btrfs_ioctl_space_args {
593 	__u64 space_slots;
594 	__u64 total_spaces;
595 	struct btrfs_ioctl_space_info spaces[0];
596 };
597 
598 struct btrfs_data_container {
599 	__u32	bytes_left;	/* out -- bytes not needed to deliver output */
600 	__u32	bytes_missing;	/* out -- additional bytes needed for result */
601 	__u32	elem_cnt;	/* out */
602 	__u32	elem_missed;	/* out */
603 	__u64	val[0];		/* out */
604 };
605 
606 struct btrfs_ioctl_ino_path_args {
607 	__u64				inum;		/* in */
608 	__u64				size;		/* in */
609 	__u64				reserved[4];
610 	/* struct btrfs_data_container	*fspath;	   out */
611 	__u64				fspath;		/* out */
612 };
613 
614 struct btrfs_ioctl_logical_ino_args {
615 	__u64				logical;	/* in */
616 	__u64				size;		/* in */
617 	__u64				reserved[4];
618 	/* struct btrfs_data_container	*inodes;	out   */
619 	__u64				inodes;
620 };
621 
622 enum btrfs_dev_stat_values {
623 	/* disk I/O failure stats */
624 	BTRFS_DEV_STAT_WRITE_ERRS, /* EIO or EREMOTEIO from lower layers */
625 	BTRFS_DEV_STAT_READ_ERRS, /* EIO or EREMOTEIO from lower layers */
626 	BTRFS_DEV_STAT_FLUSH_ERRS, /* EIO or EREMOTEIO from lower layers */
627 
628 	/* stats for indirect indications for I/O failures */
629 	BTRFS_DEV_STAT_CORRUPTION_ERRS, /* checksum error, bytenr error or
630 					 * contents is illegal: this is an
631 					 * indication that the block was damaged
632 					 * during read or write, or written to
633 					 * wrong location or read from wrong
634 					 * location */
635 	BTRFS_DEV_STAT_GENERATION_ERRS, /* an indication that blocks have not
636 					 * been written */
637 
638 	BTRFS_DEV_STAT_VALUES_MAX
639 };
640 
641 /* Reset statistics after reading; needs SYS_ADMIN capability */
642 #define	BTRFS_DEV_STATS_RESET		(1ULL << 0)
643 
644 struct btrfs_ioctl_get_dev_stats {
645 	__u64 devid;				/* in */
646 	__u64 nr_items;				/* in/out */
647 	__u64 flags;				/* in/out */
648 
649 	/* out values: */
650 	__u64 values[BTRFS_DEV_STAT_VALUES_MAX];
651 
652 	__u64 unused[128 - 2 - BTRFS_DEV_STAT_VALUES_MAX]; /* pad to 1k */
653 };
654 
655 #define BTRFS_QUOTA_CTL_ENABLE	1
656 #define BTRFS_QUOTA_CTL_DISABLE	2
657 #define BTRFS_QUOTA_CTL_RESCAN__NOTUSED	3
658 struct btrfs_ioctl_quota_ctl_args {
659 	__u64 cmd;
660 	__u64 status;
661 };
662 
663 struct btrfs_ioctl_quota_rescan_args {
664 	__u64	flags;
665 	__u64   progress;
666 	__u64   reserved[6];
667 };
668 
669 struct btrfs_ioctl_qgroup_assign_args {
670 	__u64 assign;
671 	__u64 src;
672 	__u64 dst;
673 };
674 
675 struct btrfs_ioctl_qgroup_create_args {
676 	__u64 create;
677 	__u64 qgroupid;
678 };
679 struct btrfs_ioctl_timespec {
680 	__u64 sec;
681 	__u32 nsec;
682 };
683 
684 struct btrfs_ioctl_received_subvol_args {
685 	char	uuid[BTRFS_UUID_SIZE];	/* in */
686 	__u64	stransid;		/* in */
687 	__u64	rtransid;		/* out */
688 	struct btrfs_ioctl_timespec stime; /* in */
689 	struct btrfs_ioctl_timespec rtime; /* out */
690 	__u64	flags;			/* in */
691 	__u64	reserved[16];		/* in */
692 };
693 
694 /*
695  * Caller doesn't want file data in the send stream, even if the
696  * search of clone sources doesn't find an extent. UPDATE_EXTENT
697  * commands will be sent instead of WRITE commands.
698  */
699 #define BTRFS_SEND_FLAG_NO_FILE_DATA		0x1
700 
701 /*
702  * Do not add the leading stream header. Used when multiple snapshots
703  * are sent back to back.
704  */
705 #define BTRFS_SEND_FLAG_OMIT_STREAM_HEADER	0x2
706 
707 /*
708  * Omit the command at the end of the stream that indicated the end
709  * of the stream. This option is used when multiple snapshots are
710  * sent back to back.
711  */
712 #define BTRFS_SEND_FLAG_OMIT_END_CMD		0x4
713 
714 #define BTRFS_SEND_FLAG_MASK \
715 	(BTRFS_SEND_FLAG_NO_FILE_DATA | \
716 	 BTRFS_SEND_FLAG_OMIT_STREAM_HEADER | \
717 	 BTRFS_SEND_FLAG_OMIT_END_CMD)
718 
719 struct btrfs_ioctl_send_args {
720 	__s64 send_fd;			/* in */
721 	__u64 clone_sources_count;	/* in */
722 	__u64 __user *clone_sources;	/* in */
723 	__u64 parent_root;		/* in */
724 	__u64 flags;			/* in */
725 	__u64 reserved[4];		/* in */
726 };
727 
728 /* Error codes as returned by the kernel */
729 enum btrfs_err_code {
730 	BTRFS_ERROR_DEV_RAID1_MIN_NOT_MET = 1,
731 	BTRFS_ERROR_DEV_RAID10_MIN_NOT_MET,
732 	BTRFS_ERROR_DEV_RAID5_MIN_NOT_MET,
733 	BTRFS_ERROR_DEV_RAID6_MIN_NOT_MET,
734 	BTRFS_ERROR_DEV_TGT_REPLACE,
735 	BTRFS_ERROR_DEV_MISSING_NOT_FOUND,
736 	BTRFS_ERROR_DEV_ONLY_WRITABLE,
737 	BTRFS_ERROR_DEV_EXCL_RUN_IN_PROGRESS
738 };
739 
740 #define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
741 				   struct btrfs_ioctl_vol_args)
742 #define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
743 				   struct btrfs_ioctl_vol_args)
744 #define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
745 				   struct btrfs_ioctl_vol_args)
746 #define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
747 				   struct btrfs_ioctl_vol_args)
748 /* trans start and trans end are dangerous, and only for
749  * use by applications that know how to avoid the
750  * resulting deadlocks
751  */
752 #define BTRFS_IOC_TRANS_START  _IO(BTRFS_IOCTL_MAGIC, 6)
753 #define BTRFS_IOC_TRANS_END    _IO(BTRFS_IOCTL_MAGIC, 7)
754 #define BTRFS_IOC_SYNC         _IO(BTRFS_IOCTL_MAGIC, 8)
755 
756 #define BTRFS_IOC_CLONE        _IOW(BTRFS_IOCTL_MAGIC, 9, int)
757 #define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
758 				   struct btrfs_ioctl_vol_args)
759 #define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
760 				   struct btrfs_ioctl_vol_args)
761 #define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
762 				   struct btrfs_ioctl_vol_args)
763 
764 #define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
765 				  struct btrfs_ioctl_clone_range_args)
766 
767 #define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
768 				   struct btrfs_ioctl_vol_args)
769 #define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
770 				struct btrfs_ioctl_vol_args)
771 #define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
772 				struct btrfs_ioctl_defrag_range_args)
773 #define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
774 				   struct btrfs_ioctl_search_args)
775 #define BTRFS_IOC_TREE_SEARCH_V2 _IOWR(BTRFS_IOCTL_MAGIC, 17, \
776 					   struct btrfs_ioctl_search_args_v2)
777 #define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
778 				   struct btrfs_ioctl_ino_lookup_args)
779 #define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, __u64)
780 #define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
781 				    struct btrfs_ioctl_space_args)
782 #define BTRFS_IOC_START_SYNC _IOR(BTRFS_IOCTL_MAGIC, 24, __u64)
783 #define BTRFS_IOC_WAIT_SYNC  _IOW(BTRFS_IOCTL_MAGIC, 22, __u64)
784 #define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \
785 				   struct btrfs_ioctl_vol_args_v2)
786 #define BTRFS_IOC_SUBVOL_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 24, \
787 				   struct btrfs_ioctl_vol_args_v2)
788 #define BTRFS_IOC_SUBVOL_GETFLAGS _IOR(BTRFS_IOCTL_MAGIC, 25, __u64)
789 #define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64)
790 #define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \
791 			      struct btrfs_ioctl_scrub_args)
792 #define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28)
793 #define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \
794 				       struct btrfs_ioctl_scrub_args)
795 #define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \
796 				 struct btrfs_ioctl_dev_info_args)
797 #define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \
798 			       struct btrfs_ioctl_fs_info_args)
799 #define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \
800 				   struct btrfs_ioctl_balance_args)
801 #define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int)
802 #define BTRFS_IOC_BALANCE_PROGRESS _IOR(BTRFS_IOCTL_MAGIC, 34, \
803 					struct btrfs_ioctl_balance_args)
804 #define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \
805 					struct btrfs_ioctl_ino_path_args)
806 #define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \
807 					struct btrfs_ioctl_logical_ino_args)
808 #define BTRFS_IOC_SET_RECEIVED_SUBVOL _IOWR(BTRFS_IOCTL_MAGIC, 37, \
809 				struct btrfs_ioctl_received_subvol_args)
810 #define BTRFS_IOC_SEND _IOW(BTRFS_IOCTL_MAGIC, 38, struct btrfs_ioctl_send_args)
811 #define BTRFS_IOC_DEVICES_READY _IOR(BTRFS_IOCTL_MAGIC, 39, \
812 				     struct btrfs_ioctl_vol_args)
813 #define BTRFS_IOC_QUOTA_CTL _IOWR(BTRFS_IOCTL_MAGIC, 40, \
814 			       struct btrfs_ioctl_quota_ctl_args)
815 #define BTRFS_IOC_QGROUP_ASSIGN _IOW(BTRFS_IOCTL_MAGIC, 41, \
816 			       struct btrfs_ioctl_qgroup_assign_args)
817 #define BTRFS_IOC_QGROUP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 42, \
818 			       struct btrfs_ioctl_qgroup_create_args)
819 #define BTRFS_IOC_QGROUP_LIMIT _IOR(BTRFS_IOCTL_MAGIC, 43, \
820 			       struct btrfs_ioctl_qgroup_limit_args)
821 #define BTRFS_IOC_QUOTA_RESCAN _IOW(BTRFS_IOCTL_MAGIC, 44, \
822 			       struct btrfs_ioctl_quota_rescan_args)
823 #define BTRFS_IOC_QUOTA_RESCAN_STATUS _IOR(BTRFS_IOCTL_MAGIC, 45, \
824 			       struct btrfs_ioctl_quota_rescan_args)
825 #define BTRFS_IOC_QUOTA_RESCAN_WAIT _IO(BTRFS_IOCTL_MAGIC, 46)
826 #define BTRFS_IOC_GET_FSLABEL _IOR(BTRFS_IOCTL_MAGIC, 49, \
827 				   char[BTRFS_LABEL_SIZE])
828 #define BTRFS_IOC_SET_FSLABEL _IOW(BTRFS_IOCTL_MAGIC, 50, \
829 				   char[BTRFS_LABEL_SIZE])
830 #define BTRFS_IOC_GET_DEV_STATS _IOWR(BTRFS_IOCTL_MAGIC, 52, \
831 				      struct btrfs_ioctl_get_dev_stats)
832 #define BTRFS_IOC_DEV_REPLACE _IOWR(BTRFS_IOCTL_MAGIC, 53, \
833 				    struct btrfs_ioctl_dev_replace_args)
834 #define BTRFS_IOC_FILE_EXTENT_SAME _IOWR(BTRFS_IOCTL_MAGIC, 54, \
835 					 struct btrfs_ioctl_same_args)
836 #define BTRFS_IOC_GET_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
837 				   struct btrfs_ioctl_feature_flags)
838 #define BTRFS_IOC_SET_FEATURES _IOW(BTRFS_IOCTL_MAGIC, 57, \
839 				   struct btrfs_ioctl_feature_flags[2])
840 #define BTRFS_IOC_GET_SUPPORTED_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
841 				   struct btrfs_ioctl_feature_flags[3])
842 #define BTRFS_IOC_RM_DEV_V2 _IOW(BTRFS_IOCTL_MAGIC, 58, \
843 				   struct btrfs_ioctl_vol_args_v2)
844 
845 #endif /* _UAPI_LINUX_BTRFS_H */
846