2 * Copyright (C) 2007 Oracle. All rights reserved.
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.
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.
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.
19 #ifndef _UAPI_LINUX_BTRFS_H
20 #define _UAPI_LINUX_BTRFS_H
21 #include <linux/types.h>
22 #include <linux/ioctl.h>
24 #define BTRFS_IOCTL_MAGIC 0x94
25 #define BTRFS_VOL_NAME_MAX 255
27 /* this should be 4k */
28 #define BTRFS_PATH_NAME_MAX 4087
29 struct btrfs_ioctl_vol_args
{
31 char name
[BTRFS_PATH_NAME_MAX
+ 1];
34 #define BTRFS_DEVICE_PATH_NAME_MAX 1024
36 #define BTRFS_SUBVOL_CREATE_ASYNC (1ULL << 0)
37 #define BTRFS_SUBVOL_RDONLY (1ULL << 1)
38 #define BTRFS_SUBVOL_QGROUP_INHERIT (1ULL << 2)
39 #define BTRFS_FSID_SIZE 16
40 #define BTRFS_UUID_SIZE 16
42 #define BTRFS_QGROUP_INHERIT_SET_LIMITS (1ULL << 0)
44 struct btrfs_qgroup_limit
{
52 struct btrfs_qgroup_inherit
{
56 __u64 num_excl_copies
;
57 struct btrfs_qgroup_limit lim
;
61 struct btrfs_ioctl_qgroup_limit_args
{
63 struct btrfs_qgroup_limit lim
;
66 #define BTRFS_SUBVOL_NAME_MAX 4039
67 struct btrfs_ioctl_vol_args_v2
{
74 struct btrfs_qgroup_inherit __user
*qgroup_inherit
;
78 char name
[BTRFS_SUBVOL_NAME_MAX
+ 1];
82 * structure to report errors and progress to userspace, either as a
83 * result of a finished scrub, a canceled scrub or a progress inquiry
85 struct btrfs_scrub_progress
{
86 __u64 data_extents_scrubbed
; /* # of data extents scrubbed */
87 __u64 tree_extents_scrubbed
; /* # of tree extents scrubbed */
88 __u64 data_bytes_scrubbed
; /* # of data bytes scrubbed */
89 __u64 tree_bytes_scrubbed
; /* # of tree bytes scrubbed */
90 __u64 read_errors
; /* # of read errors encountered (EIO) */
91 __u64 csum_errors
; /* # of failed csum checks */
92 __u64 verify_errors
; /* # of occurences, where the metadata
93 * of a tree block did not match the
94 * expected values, like generation or
96 __u64 no_csum
; /* # of 4k data block for which no csum
97 * is present, probably the result of
98 * data written with nodatasum */
99 __u64 csum_discards
; /* # of csum for which no data was found
100 * in the extent tree. */
101 __u64 super_errors
; /* # of bad super blocks encountered */
102 __u64 malloc_errors
; /* # of internal kmalloc errors. These
103 * will likely cause an incomplete
105 __u64 uncorrectable_errors
; /* # of errors where either no intact
106 * copy was found or the writeback
108 __u64 corrected_errors
; /* # of errors corrected */
109 __u64 last_physical
; /* last physical address scrubbed. In
110 * case a scrub was aborted, this can
111 * be used to restart the scrub */
112 __u64 unverified_errors
; /* # of occurences where a read for a
113 * full (64k) bio failed, but the re-
114 * check succeeded for each 4k piece.
115 * Intermittent error. */
118 #define BTRFS_SCRUB_READONLY 1
119 struct btrfs_ioctl_scrub_args
{
120 __u64 devid
; /* in */
121 __u64 start
; /* in */
123 __u64 flags
; /* in */
124 struct btrfs_scrub_progress progress
; /* out */
126 __u64 unused
[(1024-32-sizeof(struct btrfs_scrub_progress
))/8];
129 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_ALWAYS 0
130 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_AVOID 1
131 struct btrfs_ioctl_dev_replace_start_params
{
132 __u64 srcdevid
; /* in, if 0, use srcdev_name instead */
133 __u64 cont_reading_from_srcdev_mode
; /* in, see #define
135 __u8 srcdev_name
[BTRFS_DEVICE_PATH_NAME_MAX
+ 1]; /* in */
136 __u8 tgtdev_name
[BTRFS_DEVICE_PATH_NAME_MAX
+ 1]; /* in */
139 #define BTRFS_IOCTL_DEV_REPLACE_STATE_NEVER_STARTED 0
140 #define BTRFS_IOCTL_DEV_REPLACE_STATE_STARTED 1
141 #define BTRFS_IOCTL_DEV_REPLACE_STATE_FINISHED 2
142 #define BTRFS_IOCTL_DEV_REPLACE_STATE_CANCELED 3
143 #define BTRFS_IOCTL_DEV_REPLACE_STATE_SUSPENDED 4
144 struct btrfs_ioctl_dev_replace_status_params
{
145 __u64 replace_state
; /* out, see #define above */
146 __u64 progress_1000
; /* out, 0 <= x <= 1000 */
147 __u64 time_started
; /* out, seconds since 1-Jan-1970 */
148 __u64 time_stopped
; /* out, seconds since 1-Jan-1970 */
149 __u64 num_write_errors
; /* out */
150 __u64 num_uncorrectable_read_errors
; /* out */
153 #define BTRFS_IOCTL_DEV_REPLACE_CMD_START 0
154 #define BTRFS_IOCTL_DEV_REPLACE_CMD_STATUS 1
155 #define BTRFS_IOCTL_DEV_REPLACE_CMD_CANCEL 2
156 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NO_ERROR 0
157 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NOT_STARTED 1
158 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_ALREADY_STARTED 2
159 struct btrfs_ioctl_dev_replace_args
{
161 __u64 result
; /* out */
164 struct btrfs_ioctl_dev_replace_start_params start
;
165 struct btrfs_ioctl_dev_replace_status_params status
;
171 struct btrfs_ioctl_dev_info_args
{
172 __u64 devid
; /* in/out */
173 __u8 uuid
[BTRFS_UUID_SIZE
]; /* in/out */
174 __u64 bytes_used
; /* out */
175 __u64 total_bytes
; /* out */
176 __u64 unused
[379]; /* pad to 4k */
177 __u8 path
[BTRFS_DEVICE_PATH_NAME_MAX
]; /* out */
180 struct btrfs_ioctl_fs_info_args
{
181 __u64 max_id
; /* out */
182 __u64 num_devices
; /* out */
183 __u8 fsid
[BTRFS_FSID_SIZE
]; /* out */
184 __u64 reserved
[124]; /* pad to 1k */
187 /* balance control ioctl modes */
188 #define BTRFS_BALANCE_CTL_PAUSE 1
189 #define BTRFS_BALANCE_CTL_CANCEL 2
192 * this is packed, because it should be exactly the same as its disk
193 * byte order counterpart (struct btrfs_disk_balance_args)
195 struct btrfs_balance_args
{
209 } __attribute__ ((__packed__
));
211 /* report balance progress to userspace */
212 struct btrfs_balance_progress
{
213 __u64 expected
; /* estimated # of chunks that will be
214 * relocated to fulfill the request */
215 __u64 considered
; /* # of chunks we have considered so far */
216 __u64 completed
; /* # of chunks relocated so far */
219 #define BTRFS_BALANCE_STATE_RUNNING (1ULL << 0)
220 #define BTRFS_BALANCE_STATE_PAUSE_REQ (1ULL << 1)
221 #define BTRFS_BALANCE_STATE_CANCEL_REQ (1ULL << 2)
223 struct btrfs_ioctl_balance_args
{
224 __u64 flags
; /* in/out */
225 __u64 state
; /* out */
227 struct btrfs_balance_args data
; /* in/out */
228 struct btrfs_balance_args meta
; /* in/out */
229 struct btrfs_balance_args sys
; /* in/out */
231 struct btrfs_balance_progress stat
; /* out */
233 __u64 unused
[72]; /* pad to 1k */
236 #define BTRFS_INO_LOOKUP_PATH_MAX 4080
237 struct btrfs_ioctl_ino_lookup_args
{
240 char name
[BTRFS_INO_LOOKUP_PATH_MAX
];
243 struct btrfs_ioctl_search_key
{
244 /* which root are we searching. 0 is the tree of tree roots */
247 /* keys returned will be >= min and <= max */
251 /* keys returned will be >= min and <= max */
255 /* max and min transids to search for */
259 /* keys returned will be >= min and <= max */
264 * how many items did userland ask for, and how many are we
269 /* align to 64 bits */
272 /* some extra for later */
279 struct btrfs_ioctl_search_header
{
287 #define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
289 * the buf is an array of search headers where
290 * each header is followed by the actual item
291 * the type field is expanded to 32 bits for alignment
293 struct btrfs_ioctl_search_args
{
294 struct btrfs_ioctl_search_key key
;
295 char buf
[BTRFS_SEARCH_ARGS_BUFSIZE
];
298 struct btrfs_ioctl_clone_range_args
{
300 __u64 src_offset
, src_length
;
304 /* flags for the defrag range ioctl */
305 #define BTRFS_DEFRAG_RANGE_COMPRESS 1
306 #define BTRFS_DEFRAG_RANGE_START_IO 2
308 struct btrfs_ioctl_space_info
{
314 struct btrfs_ioctl_space_args
{
317 struct btrfs_ioctl_space_info spaces
[0];
320 struct btrfs_data_container
{
321 __u32 bytes_left
; /* out -- bytes not needed to deliver output */
322 __u32 bytes_missing
; /* out -- additional bytes needed for result */
323 __u32 elem_cnt
; /* out */
324 __u32 elem_missed
; /* out */
325 __u64 val
[0]; /* out */
328 struct btrfs_ioctl_ino_path_args
{
332 /* struct btrfs_data_container *fspath; out */
333 __u64 fspath
; /* out */
336 struct btrfs_ioctl_logical_ino_args
{
337 __u64 logical
; /* in */
340 /* struct btrfs_data_container *inodes; out */
344 enum btrfs_dev_stat_values
{
345 /* disk I/O failure stats */
346 BTRFS_DEV_STAT_WRITE_ERRS
, /* EIO or EREMOTEIO from lower layers */
347 BTRFS_DEV_STAT_READ_ERRS
, /* EIO or EREMOTEIO from lower layers */
348 BTRFS_DEV_STAT_FLUSH_ERRS
, /* EIO or EREMOTEIO from lower layers */
350 /* stats for indirect indications for I/O failures */
351 BTRFS_DEV_STAT_CORRUPTION_ERRS
, /* checksum error, bytenr error or
352 * contents is illegal: this is an
353 * indication that the block was damaged
354 * during read or write, or written to
355 * wrong location or read from wrong
357 BTRFS_DEV_STAT_GENERATION_ERRS
, /* an indication that blocks have not
360 BTRFS_DEV_STAT_VALUES_MAX
363 /* Reset statistics after reading; needs SYS_ADMIN capability */
364 #define BTRFS_DEV_STATS_RESET (1ULL << 0)
366 struct btrfs_ioctl_get_dev_stats
{
367 __u64 devid
; /* in */
368 __u64 nr_items
; /* in/out */
369 __u64 flags
; /* in/out */
372 __u64 values
[BTRFS_DEV_STAT_VALUES_MAX
];
374 __u64 unused
[128 - 2 - BTRFS_DEV_STAT_VALUES_MAX
]; /* pad to 1k */
377 #define BTRFS_QUOTA_CTL_ENABLE 1
378 #define BTRFS_QUOTA_CTL_DISABLE 2
379 #define BTRFS_QUOTA_CTL_RESCAN 3
380 struct btrfs_ioctl_quota_ctl_args
{
385 struct btrfs_ioctl_qgroup_assign_args
{
391 struct btrfs_ioctl_qgroup_create_args
{
395 struct btrfs_ioctl_timespec
{
400 struct btrfs_ioctl_received_subvol_args
{
401 char uuid
[BTRFS_UUID_SIZE
]; /* in */
402 __u64 stransid
; /* in */
403 __u64 rtransid
; /* out */
404 struct btrfs_ioctl_timespec stime
; /* in */
405 struct btrfs_ioctl_timespec rtime
; /* out */
406 __u64 flags
; /* in */
407 __u64 reserved
[16]; /* in */
411 * Caller doesn't want file data in the send stream, even if the
412 * search of clone sources doesn't find an extent. UPDATE_EXTENT
413 * commands will be sent instead of WRITE commands.
415 #define BTRFS_SEND_FLAG_NO_FILE_DATA 0x1
417 struct btrfs_ioctl_send_args
{
418 __s64 send_fd
; /* in */
419 __u64 clone_sources_count
; /* in */
420 __u64 __user
*clone_sources
; /* in */
421 __u64 parent_root
; /* in */
422 __u64 flags
; /* in */
423 __u64 reserved
[4]; /* in */
426 #define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
427 struct btrfs_ioctl_vol_args)
428 #define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
429 struct btrfs_ioctl_vol_args)
430 #define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
431 struct btrfs_ioctl_vol_args)
432 #define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
433 struct btrfs_ioctl_vol_args)
434 /* trans start and trans end are dangerous, and only for
435 * use by applications that know how to avoid the
436 * resulting deadlocks
438 #define BTRFS_IOC_TRANS_START _IO(BTRFS_IOCTL_MAGIC, 6)
439 #define BTRFS_IOC_TRANS_END _IO(BTRFS_IOCTL_MAGIC, 7)
440 #define BTRFS_IOC_SYNC _IO(BTRFS_IOCTL_MAGIC, 8)
442 #define BTRFS_IOC_CLONE _IOW(BTRFS_IOCTL_MAGIC, 9, int)
443 #define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
444 struct btrfs_ioctl_vol_args)
445 #define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
446 struct btrfs_ioctl_vol_args)
447 #define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
448 struct btrfs_ioctl_vol_args)
450 #define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
451 struct btrfs_ioctl_clone_range_args)
453 #define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
454 struct btrfs_ioctl_vol_args)
455 #define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
456 struct btrfs_ioctl_vol_args)
457 #define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
458 struct btrfs_ioctl_defrag_range_args)
459 #define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
460 struct btrfs_ioctl_search_args)
461 #define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
462 struct btrfs_ioctl_ino_lookup_args)
463 #define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, u64)
464 #define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
465 struct btrfs_ioctl_space_args)
466 #define BTRFS_IOC_START_SYNC _IOR(BTRFS_IOCTL_MAGIC, 24, __u64)
467 #define BTRFS_IOC_WAIT_SYNC _IOW(BTRFS_IOCTL_MAGIC, 22, __u64)
468 #define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \
469 struct btrfs_ioctl_vol_args_v2)
470 #define BTRFS_IOC_SUBVOL_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 24, \
471 struct btrfs_ioctl_vol_args_v2)
472 #define BTRFS_IOC_SUBVOL_GETFLAGS _IOR(BTRFS_IOCTL_MAGIC, 25, __u64)
473 #define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64)
474 #define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \
475 struct btrfs_ioctl_scrub_args)
476 #define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28)
477 #define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \
478 struct btrfs_ioctl_scrub_args)
479 #define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \
480 struct btrfs_ioctl_dev_info_args)
481 #define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \
482 struct btrfs_ioctl_fs_info_args)
483 #define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \
484 struct btrfs_ioctl_balance_args)
485 #define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int)
486 #define BTRFS_IOC_BALANCE_PROGRESS _IOR(BTRFS_IOCTL_MAGIC, 34, \
487 struct btrfs_ioctl_balance_args)
488 #define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \
489 struct btrfs_ioctl_ino_path_args)
490 #define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \
491 struct btrfs_ioctl_ino_path_args)
492 #define BTRFS_IOC_SET_RECEIVED_SUBVOL _IOWR(BTRFS_IOCTL_MAGIC, 37, \
493 struct btrfs_ioctl_received_subvol_args)
494 #define BTRFS_IOC_SEND _IOW(BTRFS_IOCTL_MAGIC, 38, struct btrfs_ioctl_send_args)
495 #define BTRFS_IOC_DEVICES_READY _IOR(BTRFS_IOCTL_MAGIC, 39, \
496 struct btrfs_ioctl_vol_args)
497 #define BTRFS_IOC_QUOTA_CTL _IOWR(BTRFS_IOCTL_MAGIC, 40, \
498 struct btrfs_ioctl_quota_ctl_args)
499 #define BTRFS_IOC_QGROUP_ASSIGN _IOW(BTRFS_IOCTL_MAGIC, 41, \
500 struct btrfs_ioctl_qgroup_assign_args)
501 #define BTRFS_IOC_QGROUP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 42, \
502 struct btrfs_ioctl_qgroup_create_args)
503 #define BTRFS_IOC_QGROUP_LIMIT _IOR(BTRFS_IOCTL_MAGIC, 43, \
504 struct btrfs_ioctl_qgroup_limit_args)
505 #define BTRFS_IOC_GET_FSLABEL _IOR(BTRFS_IOCTL_MAGIC, 49, \
506 char[BTRFS_LABEL_SIZE])
507 #define BTRFS_IOC_GET_DEV_STATS _IOWR(BTRFS_IOCTL_MAGIC, 52, \
508 struct btrfs_ioctl_get_dev_stats)
509 #define BTRFS_IOC_DEV_REPLACE _IOWR(BTRFS_IOCTL_MAGIC, 53, \
510 struct btrfs_ioctl_dev_replace_args)
512 #endif /* _UAPI_LINUX_BTRFS_H */