xref: /linux-6.15/include/uapi/linux/btrfs.h (revision bb970707)
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 #define BTRFS_FEATURE_INCOMPAT_MIXED_BACKREF	(1ULL << 0)
245 #define BTRFS_FEATURE_INCOMPAT_DEFAULT_SUBVOL	(1ULL << 1)
246 #define BTRFS_FEATURE_INCOMPAT_MIXED_GROUPS	(1ULL << 2)
247 #define BTRFS_FEATURE_INCOMPAT_COMPRESS_LZO	(1ULL << 3)
248 /*
249  * some patches floated around with a second compression method
250  * lets save that incompat here for when they do get in
251  * Note we don't actually support it, we're just reserving the
252  * number
253  */
254 #define BTRFS_FEATURE_INCOMPAT_COMPRESS_LZOv2	(1ULL << 4)
255 
256 /*
257  * older kernels tried to do bigger metadata blocks, but the
258  * code was pretty buggy.  Lets not let them try anymore.
259  */
260 #define BTRFS_FEATURE_INCOMPAT_BIG_METADATA	(1ULL << 5)
261 
262 #define BTRFS_FEATURE_INCOMPAT_EXTENDED_IREF	(1ULL << 6)
263 #define BTRFS_FEATURE_INCOMPAT_RAID56		(1ULL << 7)
264 #define BTRFS_FEATURE_INCOMPAT_SKINNY_METADATA	(1ULL << 8)
265 #define BTRFS_FEATURE_INCOMPAT_NO_HOLES		(1ULL << 9)
266 
267 struct btrfs_ioctl_feature_flags {
268 	__u64 compat_flags;
269 	__u64 compat_ro_flags;
270 	__u64 incompat_flags;
271 };
272 
273 /* balance control ioctl modes */
274 #define BTRFS_BALANCE_CTL_PAUSE		1
275 #define BTRFS_BALANCE_CTL_CANCEL	2
276 
277 /*
278  * this is packed, because it should be exactly the same as its disk
279  * byte order counterpart (struct btrfs_disk_balance_args)
280  */
281 struct btrfs_balance_args {
282 	__u64 profiles;
283 	union {
284 		__le64 usage;
285 		struct {
286 			__le32 usage_min;
287 			__le32 usage_max;
288 		};
289 	};
290 	__u64 devid;
291 	__u64 pstart;
292 	__u64 pend;
293 	__u64 vstart;
294 	__u64 vend;
295 
296 	__u64 target;
297 
298 	__u64 flags;
299 
300 	/*
301 	 * BTRFS_BALANCE_ARGS_LIMIT with value 'limit'
302 	 * BTRFS_BALANCE_ARGS_LIMIT_RANGE - the extend version can use minimum
303 	 * and maximum
304 	 */
305 	union {
306 		__u64 limit;		/* limit number of processed chunks */
307 		struct {
308 			__u32 limit_min;
309 			__u32 limit_max;
310 		};
311 	};
312 
313 	/*
314 	 * Process chunks that cross stripes_min..stripes_max devices,
315 	 * BTRFS_BALANCE_ARGS_STRIPES_RANGE
316 	 */
317 	__le32 stripes_min;
318 	__le32 stripes_max;
319 
320 	__u64 unused[6];
321 } __attribute__ ((__packed__));
322 
323 /* report balance progress to userspace */
324 struct btrfs_balance_progress {
325 	__u64 expected;		/* estimated # of chunks that will be
326 				 * relocated to fulfill the request */
327 	__u64 considered;	/* # of chunks we have considered so far */
328 	__u64 completed;	/* # of chunks relocated so far */
329 };
330 
331 /*
332  * flags definition for balance
333  *
334  * Restriper's general type filter
335  *
336  * Used by:
337  * btrfs_ioctl_balance_args.flags
338  * btrfs_balance_control.flags (internal)
339  */
340 #define BTRFS_BALANCE_DATA		(1ULL << 0)
341 #define BTRFS_BALANCE_SYSTEM		(1ULL << 1)
342 #define BTRFS_BALANCE_METADATA		(1ULL << 2)
343 
344 #define BTRFS_BALANCE_TYPE_MASK		(BTRFS_BALANCE_DATA |	    \
345 					 BTRFS_BALANCE_SYSTEM |	    \
346 					 BTRFS_BALANCE_METADATA)
347 
348 #define BTRFS_BALANCE_FORCE		(1ULL << 3)
349 #define BTRFS_BALANCE_RESUME		(1ULL << 4)
350 
351 /*
352  * flags definitions for per-type balance args
353  *
354  * Balance filters
355  *
356  * Used by:
357  * struct btrfs_balance_args
358  */
359 #define BTRFS_BALANCE_ARGS_PROFILES	(1ULL << 0)
360 #define BTRFS_BALANCE_ARGS_USAGE	(1ULL << 1)
361 #define BTRFS_BALANCE_ARGS_DEVID	(1ULL << 2)
362 #define BTRFS_BALANCE_ARGS_DRANGE	(1ULL << 3)
363 #define BTRFS_BALANCE_ARGS_VRANGE	(1ULL << 4)
364 #define BTRFS_BALANCE_ARGS_LIMIT	(1ULL << 5)
365 #define BTRFS_BALANCE_ARGS_LIMIT_RANGE	(1ULL << 6)
366 #define BTRFS_BALANCE_ARGS_STRIPES_RANGE (1ULL << 7)
367 #define BTRFS_BALANCE_ARGS_USAGE_RANGE	(1ULL << 10)
368 
369 #define BTRFS_BALANCE_ARGS_MASK			\
370 	(BTRFS_BALANCE_ARGS_PROFILES |		\
371 	 BTRFS_BALANCE_ARGS_USAGE |		\
372 	 BTRFS_BALANCE_ARGS_DEVID | 		\
373 	 BTRFS_BALANCE_ARGS_DRANGE |		\
374 	 BTRFS_BALANCE_ARGS_VRANGE |		\
375 	 BTRFS_BALANCE_ARGS_LIMIT |		\
376 	 BTRFS_BALANCE_ARGS_LIMIT_RANGE |	\
377 	 BTRFS_BALANCE_ARGS_STRIPES_RANGE |	\
378 	 BTRFS_BALANCE_ARGS_USAGE_RANGE)
379 
380 /*
381  * Profile changing flags.  When SOFT is set we won't relocate chunk if
382  * it already has the target profile (even though it may be
383  * half-filled).
384  */
385 #define BTRFS_BALANCE_ARGS_CONVERT	(1ULL << 8)
386 #define BTRFS_BALANCE_ARGS_SOFT		(1ULL << 9)
387 
388 
389 /*
390  * flags definition for balance state
391  *
392  * Used by:
393  * struct btrfs_ioctl_balance_args.state
394  */
395 #define BTRFS_BALANCE_STATE_RUNNING	(1ULL << 0)
396 #define BTRFS_BALANCE_STATE_PAUSE_REQ	(1ULL << 1)
397 #define BTRFS_BALANCE_STATE_CANCEL_REQ	(1ULL << 2)
398 
399 struct btrfs_ioctl_balance_args {
400 	__u64 flags;				/* in/out */
401 	__u64 state;				/* out */
402 
403 	struct btrfs_balance_args data;		/* in/out */
404 	struct btrfs_balance_args meta;		/* in/out */
405 	struct btrfs_balance_args sys;		/* in/out */
406 
407 	struct btrfs_balance_progress stat;	/* out */
408 
409 	__u64 unused[72];			/* pad to 1k */
410 };
411 
412 #define BTRFS_INO_LOOKUP_PATH_MAX 4080
413 struct btrfs_ioctl_ino_lookup_args {
414 	__u64 treeid;
415 	__u64 objectid;
416 	char name[BTRFS_INO_LOOKUP_PATH_MAX];
417 };
418 
419 struct btrfs_ioctl_search_key {
420 	/* which root are we searching.  0 is the tree of tree roots */
421 	__u64 tree_id;
422 
423 	/* keys returned will be >= min and <= max */
424 	__u64 min_objectid;
425 	__u64 max_objectid;
426 
427 	/* keys returned will be >= min and <= max */
428 	__u64 min_offset;
429 	__u64 max_offset;
430 
431 	/* max and min transids to search for */
432 	__u64 min_transid;
433 	__u64 max_transid;
434 
435 	/* keys returned will be >= min and <= max */
436 	__u32 min_type;
437 	__u32 max_type;
438 
439 	/*
440 	 * how many items did userland ask for, and how many are we
441 	 * returning
442 	 */
443 	__u32 nr_items;
444 
445 	/* align to 64 bits */
446 	__u32 unused;
447 
448 	/* some extra for later */
449 	__u64 unused1;
450 	__u64 unused2;
451 	__u64 unused3;
452 	__u64 unused4;
453 };
454 
455 struct btrfs_ioctl_search_header {
456 	__u64 transid;
457 	__u64 objectid;
458 	__u64 offset;
459 	__u32 type;
460 	__u32 len;
461 };
462 
463 #define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
464 /*
465  * the buf is an array of search headers where
466  * each header is followed by the actual item
467  * the type field is expanded to 32 bits for alignment
468  */
469 struct btrfs_ioctl_search_args {
470 	struct btrfs_ioctl_search_key key;
471 	char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
472 };
473 
474 struct btrfs_ioctl_search_args_v2 {
475 	struct btrfs_ioctl_search_key key; /* in/out - search parameters */
476 	__u64 buf_size;		   /* in - size of buffer
477 					    * out - on EOVERFLOW: needed size
478 					    *       to store item */
479 	__u64 buf[0];                       /* out - found items */
480 };
481 
482 struct btrfs_ioctl_clone_range_args {
483   __s64 src_fd;
484   __u64 src_offset, src_length;
485   __u64 dest_offset;
486 };
487 
488 /*
489  * flags definition for the defrag range ioctl
490  *
491  * Used by:
492  * struct btrfs_ioctl_defrag_range_args.flags
493  */
494 #define BTRFS_DEFRAG_RANGE_COMPRESS 1
495 #define BTRFS_DEFRAG_RANGE_START_IO 2
496 struct btrfs_ioctl_defrag_range_args {
497 	/* start of the defrag operation */
498 	__u64 start;
499 
500 	/* number of bytes to defrag, use (u64)-1 to say all */
501 	__u64 len;
502 
503 	/*
504 	 * flags for the operation, which can include turning
505 	 * on compression for this one defrag
506 	 */
507 	__u64 flags;
508 
509 	/*
510 	 * any extent bigger than this will be considered
511 	 * already defragged.  Use 0 to take the kernel default
512 	 * Use 1 to say every single extent must be rewritten
513 	 */
514 	__u32 extent_thresh;
515 
516 	/*
517 	 * which compression method to use if turning on compression
518 	 * for this defrag operation.  If unspecified, zlib will
519 	 * be used
520 	 */
521 	__u32 compress_type;
522 
523 	/* spare for later */
524 	__u32 unused[4];
525 };
526 
527 
528 #define BTRFS_SAME_DATA_DIFFERS	1
529 /* For extent-same ioctl */
530 struct btrfs_ioctl_same_extent_info {
531 	__s64 fd;		/* in - destination file */
532 	__u64 logical_offset;	/* in - start of extent in destination */
533 	__u64 bytes_deduped;	/* out - total # of bytes we were able
534 				 * to dedupe from this file */
535 	/* status of this dedupe operation:
536 	 * 0 if dedup succeeds
537 	 * < 0 for error
538 	 * == BTRFS_SAME_DATA_DIFFERS if data differs
539 	 */
540 	__s32 status;		/* out - see above description */
541 	__u32 reserved;
542 };
543 
544 struct btrfs_ioctl_same_args {
545 	__u64 logical_offset;	/* in - start of extent in source */
546 	__u64 length;		/* in - length of extent */
547 	__u16 dest_count;	/* in - total elements in info array */
548 	__u16 reserved1;
549 	__u32 reserved2;
550 	struct btrfs_ioctl_same_extent_info info[0];
551 };
552 
553 struct btrfs_ioctl_space_info {
554 	__u64 flags;
555 	__u64 total_bytes;
556 	__u64 used_bytes;
557 };
558 
559 struct btrfs_ioctl_space_args {
560 	__u64 space_slots;
561 	__u64 total_spaces;
562 	struct btrfs_ioctl_space_info spaces[0];
563 };
564 
565 struct btrfs_data_container {
566 	__u32	bytes_left;	/* out -- bytes not needed to deliver output */
567 	__u32	bytes_missing;	/* out -- additional bytes needed for result */
568 	__u32	elem_cnt;	/* out */
569 	__u32	elem_missed;	/* out */
570 	__u64	val[0];		/* out */
571 };
572 
573 struct btrfs_ioctl_ino_path_args {
574 	__u64				inum;		/* in */
575 	__u64				size;		/* in */
576 	__u64				reserved[4];
577 	/* struct btrfs_data_container	*fspath;	   out */
578 	__u64				fspath;		/* out */
579 };
580 
581 struct btrfs_ioctl_logical_ino_args {
582 	__u64				logical;	/* in */
583 	__u64				size;		/* in */
584 	__u64				reserved[4];
585 	/* struct btrfs_data_container	*inodes;	out   */
586 	__u64				inodes;
587 };
588 
589 enum btrfs_dev_stat_values {
590 	/* disk I/O failure stats */
591 	BTRFS_DEV_STAT_WRITE_ERRS, /* EIO or EREMOTEIO from lower layers */
592 	BTRFS_DEV_STAT_READ_ERRS, /* EIO or EREMOTEIO from lower layers */
593 	BTRFS_DEV_STAT_FLUSH_ERRS, /* EIO or EREMOTEIO from lower layers */
594 
595 	/* stats for indirect indications for I/O failures */
596 	BTRFS_DEV_STAT_CORRUPTION_ERRS, /* checksum error, bytenr error or
597 					 * contents is illegal: this is an
598 					 * indication that the block was damaged
599 					 * during read or write, or written to
600 					 * wrong location or read from wrong
601 					 * location */
602 	BTRFS_DEV_STAT_GENERATION_ERRS, /* an indication that blocks have not
603 					 * been written */
604 
605 	BTRFS_DEV_STAT_VALUES_MAX
606 };
607 
608 /* Reset statistics after reading; needs SYS_ADMIN capability */
609 #define	BTRFS_DEV_STATS_RESET		(1ULL << 0)
610 
611 struct btrfs_ioctl_get_dev_stats {
612 	__u64 devid;				/* in */
613 	__u64 nr_items;				/* in/out */
614 	__u64 flags;				/* in/out */
615 
616 	/* out values: */
617 	__u64 values[BTRFS_DEV_STAT_VALUES_MAX];
618 
619 	__u64 unused[128 - 2 - BTRFS_DEV_STAT_VALUES_MAX]; /* pad to 1k */
620 };
621 
622 #define BTRFS_QUOTA_CTL_ENABLE	1
623 #define BTRFS_QUOTA_CTL_DISABLE	2
624 #define BTRFS_QUOTA_CTL_RESCAN__NOTUSED	3
625 struct btrfs_ioctl_quota_ctl_args {
626 	__u64 cmd;
627 	__u64 status;
628 };
629 
630 struct btrfs_ioctl_quota_rescan_args {
631 	__u64	flags;
632 	__u64   progress;
633 	__u64   reserved[6];
634 };
635 
636 struct btrfs_ioctl_qgroup_assign_args {
637 	__u64 assign;
638 	__u64 src;
639 	__u64 dst;
640 };
641 
642 struct btrfs_ioctl_qgroup_create_args {
643 	__u64 create;
644 	__u64 qgroupid;
645 };
646 struct btrfs_ioctl_timespec {
647 	__u64 sec;
648 	__u32 nsec;
649 };
650 
651 struct btrfs_ioctl_received_subvol_args {
652 	char	uuid[BTRFS_UUID_SIZE];	/* in */
653 	__u64	stransid;		/* in */
654 	__u64	rtransid;		/* out */
655 	struct btrfs_ioctl_timespec stime; /* in */
656 	struct btrfs_ioctl_timespec rtime; /* out */
657 	__u64	flags;			/* in */
658 	__u64	reserved[16];		/* in */
659 };
660 
661 /*
662  * Caller doesn't want file data in the send stream, even if the
663  * search of clone sources doesn't find an extent. UPDATE_EXTENT
664  * commands will be sent instead of WRITE commands.
665  */
666 #define BTRFS_SEND_FLAG_NO_FILE_DATA		0x1
667 
668 /*
669  * Do not add the leading stream header. Used when multiple snapshots
670  * are sent back to back.
671  */
672 #define BTRFS_SEND_FLAG_OMIT_STREAM_HEADER	0x2
673 
674 /*
675  * Omit the command at the end of the stream that indicated the end
676  * of the stream. This option is used when multiple snapshots are
677  * sent back to back.
678  */
679 #define BTRFS_SEND_FLAG_OMIT_END_CMD		0x4
680 
681 #define BTRFS_SEND_FLAG_MASK \
682 	(BTRFS_SEND_FLAG_NO_FILE_DATA | \
683 	 BTRFS_SEND_FLAG_OMIT_STREAM_HEADER | \
684 	 BTRFS_SEND_FLAG_OMIT_END_CMD)
685 
686 struct btrfs_ioctl_send_args {
687 	__s64 send_fd;			/* in */
688 	__u64 clone_sources_count;	/* in */
689 	__u64 __user *clone_sources;	/* in */
690 	__u64 parent_root;		/* in */
691 	__u64 flags;			/* in */
692 	__u64 reserved[4];		/* in */
693 };
694 
695 /* Error codes as returned by the kernel */
696 enum btrfs_err_code {
697 	BTRFS_ERROR_DEV_RAID1_MIN_NOT_MET = 1,
698 	BTRFS_ERROR_DEV_RAID10_MIN_NOT_MET,
699 	BTRFS_ERROR_DEV_RAID5_MIN_NOT_MET,
700 	BTRFS_ERROR_DEV_RAID6_MIN_NOT_MET,
701 	BTRFS_ERROR_DEV_TGT_REPLACE,
702 	BTRFS_ERROR_DEV_MISSING_NOT_FOUND,
703 	BTRFS_ERROR_DEV_ONLY_WRITABLE,
704 	BTRFS_ERROR_DEV_EXCL_RUN_IN_PROGRESS
705 };
706 /* An error code to error string mapping for the kernel
707 *  error codes
708 */
709 static inline char *btrfs_err_str(enum btrfs_err_code err_code)
710 {
711 	switch (err_code) {
712 		case BTRFS_ERROR_DEV_RAID1_MIN_NOT_MET:
713 			return "unable to go below two devices on raid1";
714 		case BTRFS_ERROR_DEV_RAID10_MIN_NOT_MET:
715 			return "unable to go below four devices on raid10";
716 		case BTRFS_ERROR_DEV_RAID5_MIN_NOT_MET:
717 			return "unable to go below two devices on raid5";
718 		case BTRFS_ERROR_DEV_RAID6_MIN_NOT_MET:
719 			return "unable to go below three devices on raid6";
720 		case BTRFS_ERROR_DEV_TGT_REPLACE:
721 			return "unable to remove the dev_replace target dev";
722 		case BTRFS_ERROR_DEV_MISSING_NOT_FOUND:
723 			return "no missing devices found to remove";
724 		case BTRFS_ERROR_DEV_ONLY_WRITABLE:
725 			return "unable to remove the only writeable device";
726 		case BTRFS_ERROR_DEV_EXCL_RUN_IN_PROGRESS:
727 			return "add/delete/balance/replace/resize operation "\
728 				"in progress";
729 		default:
730 			return NULL;
731 	}
732 }
733 
734 #define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
735 				   struct btrfs_ioctl_vol_args)
736 #define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
737 				   struct btrfs_ioctl_vol_args)
738 #define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
739 				   struct btrfs_ioctl_vol_args)
740 #define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
741 				   struct btrfs_ioctl_vol_args)
742 /* trans start and trans end are dangerous, and only for
743  * use by applications that know how to avoid the
744  * resulting deadlocks
745  */
746 #define BTRFS_IOC_TRANS_START  _IO(BTRFS_IOCTL_MAGIC, 6)
747 #define BTRFS_IOC_TRANS_END    _IO(BTRFS_IOCTL_MAGIC, 7)
748 #define BTRFS_IOC_SYNC         _IO(BTRFS_IOCTL_MAGIC, 8)
749 
750 #define BTRFS_IOC_CLONE        _IOW(BTRFS_IOCTL_MAGIC, 9, int)
751 #define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
752 				   struct btrfs_ioctl_vol_args)
753 #define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
754 				   struct btrfs_ioctl_vol_args)
755 #define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
756 				   struct btrfs_ioctl_vol_args)
757 
758 #define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
759 				  struct btrfs_ioctl_clone_range_args)
760 
761 #define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
762 				   struct btrfs_ioctl_vol_args)
763 #define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
764 				struct btrfs_ioctl_vol_args)
765 #define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
766 				struct btrfs_ioctl_defrag_range_args)
767 #define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
768 				   struct btrfs_ioctl_search_args)
769 #define BTRFS_IOC_TREE_SEARCH_V2 _IOWR(BTRFS_IOCTL_MAGIC, 17, \
770 					   struct btrfs_ioctl_search_args_v2)
771 #define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
772 				   struct btrfs_ioctl_ino_lookup_args)
773 #define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, __u64)
774 #define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
775 				    struct btrfs_ioctl_space_args)
776 #define BTRFS_IOC_START_SYNC _IOR(BTRFS_IOCTL_MAGIC, 24, __u64)
777 #define BTRFS_IOC_WAIT_SYNC  _IOW(BTRFS_IOCTL_MAGIC, 22, __u64)
778 #define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \
779 				   struct btrfs_ioctl_vol_args_v2)
780 #define BTRFS_IOC_SUBVOL_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 24, \
781 				   struct btrfs_ioctl_vol_args_v2)
782 #define BTRFS_IOC_SUBVOL_GETFLAGS _IOR(BTRFS_IOCTL_MAGIC, 25, __u64)
783 #define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64)
784 #define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \
785 			      struct btrfs_ioctl_scrub_args)
786 #define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28)
787 #define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \
788 				       struct btrfs_ioctl_scrub_args)
789 #define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \
790 				 struct btrfs_ioctl_dev_info_args)
791 #define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \
792 			       struct btrfs_ioctl_fs_info_args)
793 #define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \
794 				   struct btrfs_ioctl_balance_args)
795 #define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int)
796 #define BTRFS_IOC_BALANCE_PROGRESS _IOR(BTRFS_IOCTL_MAGIC, 34, \
797 					struct btrfs_ioctl_balance_args)
798 #define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \
799 					struct btrfs_ioctl_ino_path_args)
800 #define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \
801 					struct btrfs_ioctl_ino_path_args)
802 #define BTRFS_IOC_SET_RECEIVED_SUBVOL _IOWR(BTRFS_IOCTL_MAGIC, 37, \
803 				struct btrfs_ioctl_received_subvol_args)
804 #define BTRFS_IOC_SEND _IOW(BTRFS_IOCTL_MAGIC, 38, struct btrfs_ioctl_send_args)
805 #define BTRFS_IOC_DEVICES_READY _IOR(BTRFS_IOCTL_MAGIC, 39, \
806 				     struct btrfs_ioctl_vol_args)
807 #define BTRFS_IOC_QUOTA_CTL _IOWR(BTRFS_IOCTL_MAGIC, 40, \
808 			       struct btrfs_ioctl_quota_ctl_args)
809 #define BTRFS_IOC_QGROUP_ASSIGN _IOW(BTRFS_IOCTL_MAGIC, 41, \
810 			       struct btrfs_ioctl_qgroup_assign_args)
811 #define BTRFS_IOC_QGROUP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 42, \
812 			       struct btrfs_ioctl_qgroup_create_args)
813 #define BTRFS_IOC_QGROUP_LIMIT _IOR(BTRFS_IOCTL_MAGIC, 43, \
814 			       struct btrfs_ioctl_qgroup_limit_args)
815 #define BTRFS_IOC_QUOTA_RESCAN _IOW(BTRFS_IOCTL_MAGIC, 44, \
816 			       struct btrfs_ioctl_quota_rescan_args)
817 #define BTRFS_IOC_QUOTA_RESCAN_STATUS _IOR(BTRFS_IOCTL_MAGIC, 45, \
818 			       struct btrfs_ioctl_quota_rescan_args)
819 #define BTRFS_IOC_QUOTA_RESCAN_WAIT _IO(BTRFS_IOCTL_MAGIC, 46)
820 #define BTRFS_IOC_GET_FSLABEL _IOR(BTRFS_IOCTL_MAGIC, 49, \
821 				   char[BTRFS_LABEL_SIZE])
822 #define BTRFS_IOC_SET_FSLABEL _IOW(BTRFS_IOCTL_MAGIC, 50, \
823 				   char[BTRFS_LABEL_SIZE])
824 #define BTRFS_IOC_GET_DEV_STATS _IOWR(BTRFS_IOCTL_MAGIC, 52, \
825 				      struct btrfs_ioctl_get_dev_stats)
826 #define BTRFS_IOC_DEV_REPLACE _IOWR(BTRFS_IOCTL_MAGIC, 53, \
827 				    struct btrfs_ioctl_dev_replace_args)
828 #define BTRFS_IOC_FILE_EXTENT_SAME _IOWR(BTRFS_IOCTL_MAGIC, 54, \
829 					 struct btrfs_ioctl_same_args)
830 #define BTRFS_IOC_GET_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
831 				   struct btrfs_ioctl_feature_flags)
832 #define BTRFS_IOC_SET_FEATURES _IOW(BTRFS_IOCTL_MAGIC, 57, \
833 				   struct btrfs_ioctl_feature_flags[2])
834 #define BTRFS_IOC_GET_SUPPORTED_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
835 				   struct btrfs_ioctl_feature_flags[3])
836 #define BTRFS_IOC_RM_DEV_V2 _IOW(BTRFS_IOCTL_MAGIC, 58, \
837 				   struct btrfs_ioctl_vol_args_v2)
838 
839 #endif /* _UAPI_LINUX_BTRFS_H */
840