blob: dcfc3a5a9cb1d20f29bbac00c6ef315006e9d208 [file] [log] [blame]
Chris Mason6cbd5572007-06-12 09:07:21 -04001/*
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
Filipe Brandenburger55e301f2013-01-29 06:04:50 +000019#ifndef _UAPI_LINUX_BTRFS_H
20#define _UAPI_LINUX_BTRFS_H
21#include <linux/types.h>
Chris Masonc5739bb2007-04-10 09:27:04 -040022#include <linux/ioctl.h>
23
24#define BTRFS_IOCTL_MAGIC 0x94
25#define BTRFS_VOL_NAME_MAX 255
Jeff Mahoneyd4ae1332016-04-01 16:14:23 -040026#define BTRFS_LABEL_SIZE 256
Chris Mason8a4b83c2008-03-24 15:02:07 -040027
Chris Masonc071fcf2009-01-16 11:59:08 -050028/* this should be 4k */
Sage Weil72fd0322010-10-29 15:41:32 -040029#define BTRFS_PATH_NAME_MAX 4087
Chris Masonc5739bb2007-04-10 09:27:04 -040030struct btrfs_ioctl_vol_args {
Chris Mason3de45862008-11-17 21:02:50 -050031 __s64 fd;
Chris Mason8a4b83c2008-03-24 15:02:07 -040032 char name[BTRFS_PATH_NAME_MAX + 1];
Chris Masonc5739bb2007-04-10 09:27:04 -040033};
34
Stefan Behrens3f6bcfb2012-11-06 15:08:53 +010035#define BTRFS_DEVICE_PATH_NAME_MAX 1024
36
David Sterba735654e2016-02-15 18:15:21 +010037#define BTRFS_DEVICE_SPEC_BY_ID (1ULL << 3)
38
39#define BTRFS_VOL_ARG_V2_FLAGS_SUPPORTED \
Anand Jain6b526ed2016-02-13 10:01:39 +080040 (BTRFS_SUBVOL_CREATE_ASYNC | \
41 BTRFS_SUBVOL_RDONLY | \
42 BTRFS_SUBVOL_QGROUP_INHERIT | \
David Sterba735654e2016-02-15 18:15:21 +010043 BTRFS_DEVICE_SPEC_BY_ID)
Anand Jain6b526ed2016-02-13 10:01:39 +080044
Jan Schmidt475f6382011-03-11 15:41:01 +010045#define BTRFS_FSID_SIZE 16
46#define BTRFS_UUID_SIZE 16
Anand Jainb2373f22014-06-03 11:36:03 +080047#define BTRFS_UUID_UNPARSED_SIZE 37
Li Zefanfdfb1e42010-12-10 06:41:56 +000048
Jeff Mahoney83288b62016-04-01 16:14:24 -040049/*
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)
Arne Jansenbed92ea2012-06-28 18:03:02 +020062
63struct btrfs_qgroup_limit {
64 __u64 flags;
65 __u64 max_rfer;
66 __u64 max_excl;
67 __u64 rsv_rfer;
68 __u64 rsv_excl;
69};
70
Jeff Mahoney83288b62016-04-01 16:14:24 -040071/*
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
Arne Jansenbed92ea2012-06-28 18:03:02 +020079struct 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
88struct btrfs_ioctl_qgroup_limit_args {
89 __u64 qgroupid;
90 struct btrfs_qgroup_limit lim;
91};
92
Jeff Mahoney884f6ec2016-04-01 16:14:25 -040093/*
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
Li Zefanfdfb1e42010-12-10 06:41:56 +0000107#define BTRFS_SUBVOL_NAME_MAX 4039
108struct btrfs_ioctl_vol_args_v2 {
Sage Weil72fd0322010-10-29 15:41:32 -0400109 __s64 fd;
110 __u64 transid;
Li Zefanfdfb1e42010-12-10 06:41:56 +0000111 __u64 flags;
Arne Jansen6f72c7e2011-09-14 15:58:21 +0200112 union {
113 struct {
114 __u64 size;
115 struct btrfs_qgroup_inherit __user *qgroup_inherit;
116 };
117 __u64 unused[4];
118 };
Anand Jain6b526ed2016-02-13 10:01:39 +0800119 union {
120 char name[BTRFS_SUBVOL_NAME_MAX + 1];
Vinson Lee1691cf12016-05-28 07:04:38 +0000121 __u64 devid;
Anand Jain6b526ed2016-02-13 10:01:39 +0800122 };
Sage Weil72fd0322010-10-29 15:41:32 -0400123};
124
Arne Jansena2de7332011-03-08 14:14:00 +0100125/*
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 */
129struct 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
Arne Jansen86287642011-03-23 16:34:19 +0100162#define BTRFS_SCRUB_READONLY 1
Jan Schmidt475f6382011-03-11 15:41:01 +0100163struct 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
Stefan Behrense93c89c2012-11-05 17:33:06 +0100173#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
175struct btrfs_ioctl_dev_replace_start_params {
176 __u64 srcdevid; /* in, if 0, use srcdev_name instead */
Stefan Behrense93c89c2012-11-05 17:33:06 +0100177 __u64 cont_reading_from_srcdev_mode; /* in, see #define
178 * above */
Stefan Behrens3f6bcfb2012-11-06 15:08:53 +0100179 __u8 srcdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1]; /* in */
180 __u8 tgtdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1]; /* in */
Stefan Behrense93c89c2012-11-05 17:33:06 +0100181};
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
188struct 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
Eryu Guan2fc9f6b2014-10-13 12:42:12 +0800203#define BTRFS_IOCTL_DEV_REPLACE_RESULT_SCRUB_INPROGRESS 3
Stefan Behrense93c89c2012-11-05 17:33:06 +0100204struct 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
Jan Schmidt475f6382011-03-11 15:41:01 +0100216struct 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
225struct btrfs_ioctl_fs_info_args {
226 __u64 max_id; /* out */
227 __u64 num_devices; /* out */
228 __u8 fsid[BTRFS_FSID_SIZE]; /* out */
David Sterba80a773f2014-05-07 18:17:06 +0200229 __u32 nodesize; /* out */
230 __u32 sectorsize; /* out */
231 __u32 clone_alignment; /* out */
232 __u32 reserved32;
233 __u64 reserved[122]; /* pad to 1k */
Jan Schmidt475f6382011-03-11 15:41:01 +0100234};
235
Jeff Mahoney18db9ac2016-04-01 16:14:26 -0400236/*
237 * feature flags
238 *
239 * Used by:
240 * struct btrfs_ioctl_feature_flags
241 */
Omar Sandoval6675df32016-09-22 17:24:22 -0700242#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)
Jeff Mahoney18db9ac2016-04-01 16:14:26 -0400253
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
Jeff Mahoney2eaa0552013-11-15 15:33:55 -0500277struct btrfs_ioctl_feature_flags {
278 __u64 compat_flags;
279 __u64 compat_ro_flags;
280 __u64 incompat_flags;
281};
282
Ilya Dryomov837d5b62012-01-16 22:04:49 +0200283/* balance control ioctl modes */
284#define BTRFS_BALANCE_CTL_PAUSE 1
Ilya Dryomova7e99c62012-01-16 22:04:49 +0200285#define BTRFS_BALANCE_CTL_CANCEL 2
Ilya Dryomov837d5b62012-01-16 22:04:49 +0200286
Ilya Dryomovc9e9f972012-01-16 22:04:47 +0200287/*
288 * this is packed, because it should be exactly the same as its disk
289 * byte order counterpart (struct btrfs_disk_balance_args)
290 */
291struct btrfs_balance_args {
292 __u64 profiles;
David Sterbabc309462015-10-20 18:22:13 +0200293 union {
294 __le64 usage;
295 struct {
296 __le32 usage_min;
297 __le32 usage_max;
298 };
299 };
Ilya Dryomovc9e9f972012-01-16 22:04:47 +0200300 __u64 devid;
301 __u64 pstart;
302 __u64 pend;
303 __u64 vstart;
304 __u64 vend;
305
306 __u64 target;
307
308 __u64 flags;
309
David Sterba12907fc2015-10-10 17:16:50 +0200310 /*
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 };
Gabríel Arthúr Péturssondee32d02015-09-28 22:32:41 +0000322
323 /*
324 * Process chunks that cross stripes_min..stripes_max devices,
325 * BTRFS_BALANCE_ARGS_STRIPES_RANGE
326 */
327 __le32 stripes_min;
328 __le32 stripes_max;
329
330 __u64 unused[6];
Ilya Dryomovc9e9f972012-01-16 22:04:47 +0200331} __attribute__ ((__packed__));
332
333/* report balance progress to userspace */
334struct 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
Jeff Mahoney04cd01d2016-04-01 16:14:27 -0400341/*
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 */
Ilya Dryomov837d5b62012-01-16 22:04:49 +0200405#define BTRFS_BALANCE_STATE_RUNNING (1ULL << 0)
406#define BTRFS_BALANCE_STATE_PAUSE_REQ (1ULL << 1)
Ilya Dryomova7e99c62012-01-16 22:04:49 +0200407#define BTRFS_BALANCE_STATE_CANCEL_REQ (1ULL << 2)
Ilya Dryomov837d5b62012-01-16 22:04:49 +0200408
Ilya Dryomovc9e9f972012-01-16 22:04:47 +0200409struct 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
Chris Masonac8e9812010-02-28 15:39:26 -0500422#define BTRFS_INO_LOOKUP_PATH_MAX 4080
423struct btrfs_ioctl_ino_lookup_args {
424 __u64 treeid;
425 __u64 objectid;
426 char name[BTRFS_INO_LOOKUP_PATH_MAX];
427};
428
429struct btrfs_ioctl_search_key {
430 /* which root are we searching. 0 is the tree of tree roots */
431 __u64 tree_id;
432
433 /* keys returned will be >= min and <= max */
434 __u64 min_objectid;
435 __u64 max_objectid;
436
437 /* keys returned will be >= min and <= max */
438 __u64 min_offset;
439 __u64 max_offset;
440
441 /* max and min transids to search for */
442 __u64 min_transid;
443 __u64 max_transid;
444
445 /* keys returned will be >= min and <= max */
446 __u32 min_type;
447 __u32 max_type;
448
449 /*
450 * how many items did userland ask for, and how many are we
451 * returning
452 */
453 __u32 nr_items;
454
455 /* align to 64 bits */
456 __u32 unused;
457
458 /* some extra for later */
459 __u64 unused1;
460 __u64 unused2;
461 __u64 unused3;
462 __u64 unused4;
463};
464
465struct btrfs_ioctl_search_header {
466 __u64 transid;
467 __u64 objectid;
468 __u64 offset;
469 __u32 type;
470 __u32 len;
471};
472
473#define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
474/*
475 * the buf is an array of search headers where
476 * each header is followed by the actual item
477 * the type field is expanded to 32 bits for alignment
478 */
479struct btrfs_ioctl_search_args {
480 struct btrfs_ioctl_search_key key;
481 char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
482};
483
Gerhard Heiftcc68a8a2014-01-30 16:24:03 +0100484struct btrfs_ioctl_search_args_v2 {
485 struct btrfs_ioctl_search_key key; /* in/out - search parameters */
486 __u64 buf_size; /* in - size of buffer
487 * out - on EOVERFLOW: needed size
488 * to store item */
489 __u64 buf[0]; /* out - found items */
490};
491
Chris Masonc071fcf2009-01-16 11:59:08 -0500492struct btrfs_ioctl_clone_range_args {
493 __s64 src_fd;
494 __u64 src_offset, src_length;
495 __u64 dest_offset;
496};
497
Jeff Mahoney33ca9132016-04-01 16:14:28 -0400498/*
499 * flags definition for the defrag range ioctl
500 *
501 * Used by:
502 * struct btrfs_ioctl_defrag_range_args.flags
503 */
Chris Mason1e701a32010-03-11 09:42:04 -0500504#define BTRFS_DEFRAG_RANGE_COMPRESS 1
505#define BTRFS_DEFRAG_RANGE_START_IO 2
Jeff Mahoney33ca9132016-04-01 16:14:28 -0400506struct btrfs_ioctl_defrag_range_args {
507 /* start of the defrag operation */
508 __u64 start;
509
510 /* number of bytes to defrag, use (u64)-1 to say all */
511 __u64 len;
512
513 /*
514 * flags for the operation, which can include turning
515 * on compression for this one defrag
516 */
517 __u64 flags;
518
519 /*
520 * any extent bigger than this will be considered
521 * already defragged. Use 0 to take the kernel default
522 * Use 1 to say every single extent must be rewritten
523 */
524 __u32 extent_thresh;
525
526 /*
527 * which compression method to use if turning on compression
528 * for this defrag operation. If unspecified, zlib will
529 * be used
530 */
531 __u32 compress_type;
532
533 /* spare for later */
534 __u32 unused[4];
535};
536
Chris Mason1e701a32010-03-11 09:42:04 -0500537
Mark Fasheh416161d2013-08-06 11:42:51 -0700538#define BTRFS_SAME_DATA_DIFFERS 1
539/* For extent-same ioctl */
540struct btrfs_ioctl_same_extent_info {
541 __s64 fd; /* in - destination file */
542 __u64 logical_offset; /* in - start of extent in destination */
543 __u64 bytes_deduped; /* out - total # of bytes we were able
544 * to dedupe from this file */
545 /* status of this dedupe operation:
546 * 0 if dedup succeeds
547 * < 0 for error
548 * == BTRFS_SAME_DATA_DIFFERS if data differs
549 */
550 __s32 status; /* out - see above description */
551 __u32 reserved;
552};
553
554struct btrfs_ioctl_same_args {
555 __u64 logical_offset; /* in - start of extent in source */
556 __u64 length; /* in - length of extent */
557 __u16 dest_count; /* in - total elements in info array */
558 __u16 reserved1;
559 __u32 reserved2;
560 struct btrfs_ioctl_same_extent_info info[0];
561};
562
Josef Bacik1406e432010-01-13 18:19:06 +0000563struct btrfs_ioctl_space_info {
Sage Weilce769a22010-03-16 00:02:26 +0000564 __u64 flags;
565 __u64 total_bytes;
566 __u64 used_bytes;
Josef Bacik1406e432010-01-13 18:19:06 +0000567};
568
569struct btrfs_ioctl_space_args {
Sage Weilce769a22010-03-16 00:02:26 +0000570 __u64 space_slots;
571 __u64 total_spaces;
Josef Bacik1406e432010-01-13 18:19:06 +0000572 struct btrfs_ioctl_space_info spaces[0];
573};
Chris Mason1e701a32010-03-11 09:42:04 -0500574
Jan Schmidta542ad12011-06-13 19:52:59 +0200575struct btrfs_data_container {
576 __u32 bytes_left; /* out -- bytes not needed to deliver output */
577 __u32 bytes_missing; /* out -- additional bytes needed for result */
578 __u32 elem_cnt; /* out */
579 __u32 elem_missed; /* out */
Chris Mason740c3d22011-11-02 15:48:34 -0400580 __u64 val[0]; /* out */
Jan Schmidta542ad12011-06-13 19:52:59 +0200581};
582
Jan Schmidtd7728c92011-07-07 16:48:38 +0200583struct btrfs_ioctl_ino_path_args {
584 __u64 inum; /* in */
Alexander Blockd04b1de2012-05-04 15:16:06 -0400585 __u64 size; /* in */
Jan Schmidtd7728c92011-07-07 16:48:38 +0200586 __u64 reserved[4];
Chris Mason740c3d22011-11-02 15:48:34 -0400587 /* struct btrfs_data_container *fspath; out */
588 __u64 fspath; /* out */
Jan Schmidtd7728c92011-07-07 16:48:38 +0200589};
590
591struct btrfs_ioctl_logical_ino_args {
592 __u64 logical; /* in */
Alexander Blockd04b1de2012-05-04 15:16:06 -0400593 __u64 size; /* in */
Jan Schmidtd7728c92011-07-07 16:48:38 +0200594 __u64 reserved[4];
Chris Mason740c3d22011-11-02 15:48:34 -0400595 /* struct btrfs_data_container *inodes; out */
596 __u64 inodes;
Jan Schmidtd7728c92011-07-07 16:48:38 +0200597};
598
Stefan Behrens442a4f62012-05-25 16:06:08 +0200599enum btrfs_dev_stat_values {
600 /* disk I/O failure stats */
601 BTRFS_DEV_STAT_WRITE_ERRS, /* EIO or EREMOTEIO from lower layers */
602 BTRFS_DEV_STAT_READ_ERRS, /* EIO or EREMOTEIO from lower layers */
603 BTRFS_DEV_STAT_FLUSH_ERRS, /* EIO or EREMOTEIO from lower layers */
604
605 /* stats for indirect indications for I/O failures */
606 BTRFS_DEV_STAT_CORRUPTION_ERRS, /* checksum error, bytenr error or
607 * contents is illegal: this is an
608 * indication that the block was damaged
609 * during read or write, or written to
610 * wrong location or read from wrong
611 * location */
612 BTRFS_DEV_STAT_GENERATION_ERRS, /* an indication that blocks have not
613 * been written */
614
615 BTRFS_DEV_STAT_VALUES_MAX
616};
617
David Sterbab27f7c02012-06-22 06:30:39 -0600618/* Reset statistics after reading; needs SYS_ADMIN capability */
619#define BTRFS_DEV_STATS_RESET (1ULL << 0)
620
Stefan Behrensc11d2c22012-05-25 16:06:09 +0200621struct btrfs_ioctl_get_dev_stats {
622 __u64 devid; /* in */
623 __u64 nr_items; /* in/out */
David Sterbab27f7c02012-06-22 06:30:39 -0600624 __u64 flags; /* in/out */
Stefan Behrensc11d2c22012-05-25 16:06:09 +0200625
626 /* out values: */
627 __u64 values[BTRFS_DEV_STAT_VALUES_MAX];
628
629 __u64 unused[128 - 2 - BTRFS_DEV_STAT_VALUES_MAX]; /* pad to 1k */
630};
631
Arne Jansen5d13a372011-09-14 15:53:51 +0200632#define BTRFS_QUOTA_CTL_ENABLE 1
633#define BTRFS_QUOTA_CTL_DISABLE 2
Jan Schmidt2f232032013-04-25 16:04:51 +0000634#define BTRFS_QUOTA_CTL_RESCAN__NOTUSED 3
Arne Jansen5d13a372011-09-14 15:53:51 +0200635struct btrfs_ioctl_quota_ctl_args {
636 __u64 cmd;
637 __u64 status;
638};
639
Jan Schmidt2f232032013-04-25 16:04:51 +0000640struct btrfs_ioctl_quota_rescan_args {
641 __u64 flags;
642 __u64 progress;
643 __u64 reserved[6];
644};
645
Arne Jansen5d13a372011-09-14 15:53:51 +0200646struct btrfs_ioctl_qgroup_assign_args {
647 __u64 assign;
648 __u64 src;
649 __u64 dst;
650};
651
652struct btrfs_ioctl_qgroup_create_args {
653 __u64 create;
654 __u64 qgroupid;
655};
Alexander Block8ea05e32012-07-25 17:35:53 +0200656struct btrfs_ioctl_timespec {
657 __u64 sec;
658 __u32 nsec;
659};
660
661struct btrfs_ioctl_received_subvol_args {
662 char uuid[BTRFS_UUID_SIZE]; /* in */
663 __u64 stransid; /* in */
664 __u64 rtransid; /* out */
665 struct btrfs_ioctl_timespec stime; /* in */
666 struct btrfs_ioctl_timespec rtime; /* out */
667 __u64 flags; /* in */
668 __u64 reserved[16]; /* in */
669};
670
Mark Fashehcb95e7b2013-02-04 20:54:57 +0000671/*
672 * Caller doesn't want file data in the send stream, even if the
673 * search of clone sources doesn't find an extent. UPDATE_EXTENT
674 * commands will be sent instead of WRITE commands.
675 */
Stefan Behrensc2c71322013-04-10 17:10:52 +0000676#define BTRFS_SEND_FLAG_NO_FILE_DATA 0x1
677
678/*
679 * Do not add the leading stream header. Used when multiple snapshots
680 * are sent back to back.
681 */
682#define BTRFS_SEND_FLAG_OMIT_STREAM_HEADER 0x2
683
684/*
685 * Omit the command at the end of the stream that indicated the end
686 * of the stream. This option is used when multiple snapshots are
687 * sent back to back.
688 */
689#define BTRFS_SEND_FLAG_OMIT_END_CMD 0x4
690
691#define BTRFS_SEND_FLAG_MASK \
692 (BTRFS_SEND_FLAG_NO_FILE_DATA | \
693 BTRFS_SEND_FLAG_OMIT_STREAM_HEADER | \
694 BTRFS_SEND_FLAG_OMIT_END_CMD)
Mark Fashehcb95e7b2013-02-04 20:54:57 +0000695
Alexander Block31db9f72012-07-25 23:19:24 +0200696struct btrfs_ioctl_send_args {
697 __s64 send_fd; /* in */
698 __u64 clone_sources_count; /* in */
699 __u64 __user *clone_sources; /* in */
700 __u64 parent_root; /* in */
701 __u64 flags; /* in */
702 __u64 reserved[4]; /* in */
703};
Arne Jansen5d13a372011-09-14 15:53:51 +0200704
Anand Jain183860f2013-05-17 10:52:45 +0000705/* Error codes as returned by the kernel */
706enum btrfs_err_code {
Satoru Takeuchieb710b12014-12-24 14:52:04 +0900707 BTRFS_ERROR_DEV_RAID1_MIN_NOT_MET = 1,
Anand Jain183860f2013-05-17 10:52:45 +0000708 BTRFS_ERROR_DEV_RAID10_MIN_NOT_MET,
709 BTRFS_ERROR_DEV_RAID5_MIN_NOT_MET,
710 BTRFS_ERROR_DEV_RAID6_MIN_NOT_MET,
711 BTRFS_ERROR_DEV_TGT_REPLACE,
712 BTRFS_ERROR_DEV_MISSING_NOT_FOUND,
713 BTRFS_ERROR_DEV_ONLY_WRITABLE,
714 BTRFS_ERROR_DEV_EXCL_RUN_IN_PROGRESS
715};
Anand Jain183860f2013-05-17 10:52:45 +0000716
Chris Masonc5739bb2007-04-10 09:27:04 -0400717#define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
718 struct btrfs_ioctl_vol_args)
Chris Mason6702ed42007-08-07 16:15:09 -0400719#define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
Chris Mason8352d8a2007-04-12 10:43:05 -0400720 struct btrfs_ioctl_vol_args)
Chris Masonedbd8d42007-12-21 16:27:24 -0500721#define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
722 struct btrfs_ioctl_vol_args)
Chris Mason8a4b83c2008-03-24 15:02:07 -0400723#define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
724 struct btrfs_ioctl_vol_args)
Sage Weil6bf13c02008-06-10 10:07:39 -0400725/* trans start and trans end are dangerous, and only for
726 * use by applications that know how to avoid the
727 * resulting deadlocks
728 */
729#define BTRFS_IOC_TRANS_START _IO(BTRFS_IOCTL_MAGIC, 6)
730#define BTRFS_IOC_TRANS_END _IO(BTRFS_IOCTL_MAGIC, 7)
731#define BTRFS_IOC_SYNC _IO(BTRFS_IOCTL_MAGIC, 8)
732
Sage Weilf2eb0a22008-05-02 14:43:14 -0400733#define BTRFS_IOC_CLONE _IOW(BTRFS_IOCTL_MAGIC, 9, int)
Chris Mason788f20e2008-04-28 15:29:42 -0400734#define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
735 struct btrfs_ioctl_vol_args)
736#define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
737 struct btrfs_ioctl_vol_args)
738#define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
739 struct btrfs_ioctl_vol_args)
Sage Weilc5c9cd42008-11-12 14:32:25 -0500740
741#define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
742 struct btrfs_ioctl_clone_range_args)
743
Chris Mason3de45862008-11-17 21:02:50 -0500744#define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
745 struct btrfs_ioctl_vol_args)
Yan, Zheng76dda932009-09-21 16:00:26 -0400746#define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
747 struct btrfs_ioctl_vol_args)
Chris Mason1e701a32010-03-11 09:42:04 -0500748#define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
749 struct btrfs_ioctl_defrag_range_args)
Chris Masonac8e9812010-02-28 15:39:26 -0500750#define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
751 struct btrfs_ioctl_search_args)
Gerhard Heiftcc68a8a2014-01-30 16:24:03 +0100752#define BTRFS_IOC_TREE_SEARCH_V2 _IOWR(BTRFS_IOCTL_MAGIC, 17, \
753 struct btrfs_ioctl_search_args_v2)
Chris Masonac8e9812010-02-28 15:39:26 -0500754#define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
755 struct btrfs_ioctl_ino_lookup_args)
Mike Frysinger68b823e2013-08-16 14:02:33 -0400756#define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, __u64)
Josef Bacik1406e432010-01-13 18:19:06 +0000757#define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
758 struct btrfs_ioctl_space_args)
Sage Weil46204592010-10-29 15:41:32 -0400759#define BTRFS_IOC_START_SYNC _IOR(BTRFS_IOCTL_MAGIC, 24, __u64)
760#define BTRFS_IOC_WAIT_SYNC _IOW(BTRFS_IOCTL_MAGIC, 22, __u64)
Li Zefanfdfb1e42010-12-10 06:41:56 +0000761#define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \
762 struct btrfs_ioctl_vol_args_v2)
Arne Jansen6f72c7e2011-09-14 15:58:21 +0200763#define BTRFS_IOC_SUBVOL_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 24, \
764 struct btrfs_ioctl_vol_args_v2)
Alexander Blockd3a94042012-06-25 15:36:12 -0600765#define BTRFS_IOC_SUBVOL_GETFLAGS _IOR(BTRFS_IOCTL_MAGIC, 25, __u64)
Li Zefan0caa1022010-12-20 16:30:25 +0800766#define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64)
Jan Schmidt475f6382011-03-11 15:41:01 +0100767#define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \
768 struct btrfs_ioctl_scrub_args)
769#define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28)
770#define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \
771 struct btrfs_ioctl_scrub_args)
772#define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \
773 struct btrfs_ioctl_dev_info_args)
774#define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \
775 struct btrfs_ioctl_fs_info_args)
Ilya Dryomovc9e9f972012-01-16 22:04:47 +0200776#define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \
777 struct btrfs_ioctl_balance_args)
Ilya Dryomov837d5b62012-01-16 22:04:49 +0200778#define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int)
Ilya Dryomov19a39dc2012-01-16 22:04:49 +0200779#define BTRFS_IOC_BALANCE_PROGRESS _IOR(BTRFS_IOCTL_MAGIC, 34, \
780 struct btrfs_ioctl_balance_args)
Jan Schmidtd7728c92011-07-07 16:48:38 +0200781#define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \
782 struct btrfs_ioctl_ino_path_args)
783#define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \
Hans van Kranenburg7af7c612016-07-03 23:23:06 +0200784 struct btrfs_ioctl_logical_ino_args)
Alexander Block8ea05e32012-07-25 17:35:53 +0200785#define BTRFS_IOC_SET_RECEIVED_SUBVOL _IOWR(BTRFS_IOCTL_MAGIC, 37, \
786 struct btrfs_ioctl_received_subvol_args)
Alexander Block31db9f72012-07-25 23:19:24 +0200787#define BTRFS_IOC_SEND _IOW(BTRFS_IOCTL_MAGIC, 38, struct btrfs_ioctl_send_args)
Josef Bacik02db0842012-06-21 16:03:58 -0400788#define BTRFS_IOC_DEVICES_READY _IOR(BTRFS_IOCTL_MAGIC, 39, \
789 struct btrfs_ioctl_vol_args)
Arne Jansen5d13a372011-09-14 15:53:51 +0200790#define BTRFS_IOC_QUOTA_CTL _IOWR(BTRFS_IOCTL_MAGIC, 40, \
791 struct btrfs_ioctl_quota_ctl_args)
792#define BTRFS_IOC_QGROUP_ASSIGN _IOW(BTRFS_IOCTL_MAGIC, 41, \
793 struct btrfs_ioctl_qgroup_assign_args)
794#define BTRFS_IOC_QGROUP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 42, \
795 struct btrfs_ioctl_qgroup_create_args)
796#define BTRFS_IOC_QGROUP_LIMIT _IOR(BTRFS_IOCTL_MAGIC, 43, \
797 struct btrfs_ioctl_qgroup_limit_args)
Jan Schmidt2f232032013-04-25 16:04:51 +0000798#define BTRFS_IOC_QUOTA_RESCAN _IOW(BTRFS_IOCTL_MAGIC, 44, \
799 struct btrfs_ioctl_quota_rescan_args)
800#define BTRFS_IOC_QUOTA_RESCAN_STATUS _IOR(BTRFS_IOCTL_MAGIC, 45, \
801 struct btrfs_ioctl_quota_rescan_args)
Jan Schmidt57254b6e2013-05-06 19:14:17 +0000802#define BTRFS_IOC_QUOTA_RESCAN_WAIT _IO(BTRFS_IOCTL_MAGIC, 46)
jeff.liu867ab662013-01-05 02:48:01 +0000803#define BTRFS_IOC_GET_FSLABEL _IOR(BTRFS_IOCTL_MAGIC, 49, \
804 char[BTRFS_LABEL_SIZE])
jeff.liua8bfd4a2013-01-05 02:48:08 +0000805#define BTRFS_IOC_SET_FSLABEL _IOW(BTRFS_IOCTL_MAGIC, 50, \
806 char[BTRFS_LABEL_SIZE])
Stefan Behrensc11d2c22012-05-25 16:06:09 +0200807#define BTRFS_IOC_GET_DEV_STATS _IOWR(BTRFS_IOCTL_MAGIC, 52, \
808 struct btrfs_ioctl_get_dev_stats)
Stefan Behrense93c89c2012-11-05 17:33:06 +0100809#define BTRFS_IOC_DEV_REPLACE _IOWR(BTRFS_IOCTL_MAGIC, 53, \
810 struct btrfs_ioctl_dev_replace_args)
Mark Fasheh416161d2013-08-06 11:42:51 -0700811#define BTRFS_IOC_FILE_EXTENT_SAME _IOWR(BTRFS_IOCTL_MAGIC, 54, \
812 struct btrfs_ioctl_same_args)
Jeff Mahoney2eaa0552013-11-15 15:33:55 -0500813#define BTRFS_IOC_GET_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
814 struct btrfs_ioctl_feature_flags)
815#define BTRFS_IOC_SET_FEATURES _IOW(BTRFS_IOCTL_MAGIC, 57, \
816 struct btrfs_ioctl_feature_flags[2])
817#define BTRFS_IOC_GET_SUPPORTED_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
818 struct btrfs_ioctl_feature_flags[3])
Anand Jain6b526ed2016-02-13 10:01:39 +0800819#define BTRFS_IOC_RM_DEV_V2 _IOW(BTRFS_IOCTL_MAGIC, 58, \
820 struct btrfs_ioctl_vol_args_v2)
Mark Fasheh416161d2013-08-06 11:42:51 -0700821
Filipe Brandenburger55e301f2013-01-29 06:04:50 +0000822#endif /* _UAPI_LINUX_BTRFS_H */