]> git.proxmox.com Git - mirror_ubuntu-hirsute-kernel.git/blame - fs/btrfs/ioctl.h
Btrfs: allow for pausing restriper
[mirror_ubuntu-hirsute-kernel.git] / fs / btrfs / ioctl.h
CommitLineData
6cbd5570
CM
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
c5739bba
CM
19#ifndef __IOCTL_
20#define __IOCTL_
21#include <linux/ioctl.h>
22
23#define BTRFS_IOCTL_MAGIC 0x94
24#define BTRFS_VOL_NAME_MAX 255
8a4b83cc 25
c071fcfd 26/* this should be 4k */
72fd032e 27#define BTRFS_PATH_NAME_MAX 4087
c5739bba 28struct btrfs_ioctl_vol_args {
3de4586c 29 __s64 fd;
8a4b83cc 30 char name[BTRFS_PATH_NAME_MAX + 1];
c5739bba
CM
31};
32
fdfb1e4f 33#define BTRFS_SUBVOL_CREATE_ASYNC (1ULL << 0)
b83cc969 34#define BTRFS_SUBVOL_RDONLY (1ULL << 1)
475f6387
JS
35#define BTRFS_FSID_SIZE 16
36#define BTRFS_UUID_SIZE 16
fdfb1e4f
LZ
37
38#define BTRFS_SUBVOL_NAME_MAX 4039
39struct btrfs_ioctl_vol_args_v2 {
72fd032e
SW
40 __s64 fd;
41 __u64 transid;
fdfb1e4f
LZ
42 __u64 flags;
43 __u64 unused[4];
44 char name[BTRFS_SUBVOL_NAME_MAX + 1];
72fd032e
SW
45};
46
a2de733c
AJ
47/*
48 * structure to report errors and progress to userspace, either as a
49 * result of a finished scrub, a canceled scrub or a progress inquiry
50 */
51struct btrfs_scrub_progress {
52 __u64 data_extents_scrubbed; /* # of data extents scrubbed */
53 __u64 tree_extents_scrubbed; /* # of tree extents scrubbed */
54 __u64 data_bytes_scrubbed; /* # of data bytes scrubbed */
55 __u64 tree_bytes_scrubbed; /* # of tree bytes scrubbed */
56 __u64 read_errors; /* # of read errors encountered (EIO) */
57 __u64 csum_errors; /* # of failed csum checks */
58 __u64 verify_errors; /* # of occurences, where the metadata
59 * of a tree block did not match the
60 * expected values, like generation or
61 * logical */
62 __u64 no_csum; /* # of 4k data block for which no csum
63 * is present, probably the result of
64 * data written with nodatasum */
65 __u64 csum_discards; /* # of csum for which no data was found
66 * in the extent tree. */
67 __u64 super_errors; /* # of bad super blocks encountered */
68 __u64 malloc_errors; /* # of internal kmalloc errors. These
69 * will likely cause an incomplete
70 * scrub */
71 __u64 uncorrectable_errors; /* # of errors where either no intact
72 * copy was found or the writeback
73 * failed */
74 __u64 corrected_errors; /* # of errors corrected */
75 __u64 last_physical; /* last physical address scrubbed. In
76 * case a scrub was aborted, this can
77 * be used to restart the scrub */
78 __u64 unverified_errors; /* # of occurences where a read for a
79 * full (64k) bio failed, but the re-
80 * check succeeded for each 4k piece.
81 * Intermittent error. */
82};
83
8628764e 84#define BTRFS_SCRUB_READONLY 1
475f6387
JS
85struct btrfs_ioctl_scrub_args {
86 __u64 devid; /* in */
87 __u64 start; /* in */
88 __u64 end; /* in */
89 __u64 flags; /* in */
90 struct btrfs_scrub_progress progress; /* out */
91 /* pad to 1k */
92 __u64 unused[(1024-32-sizeof(struct btrfs_scrub_progress))/8];
93};
94
95#define BTRFS_DEVICE_PATH_NAME_MAX 1024
96struct btrfs_ioctl_dev_info_args {
97 __u64 devid; /* in/out */
98 __u8 uuid[BTRFS_UUID_SIZE]; /* in/out */
99 __u64 bytes_used; /* out */
100 __u64 total_bytes; /* out */
101 __u64 unused[379]; /* pad to 4k */
102 __u8 path[BTRFS_DEVICE_PATH_NAME_MAX]; /* out */
103};
104
105struct btrfs_ioctl_fs_info_args {
106 __u64 max_id; /* out */
107 __u64 num_devices; /* out */
108 __u8 fsid[BTRFS_FSID_SIZE]; /* out */
109 __u64 reserved[124]; /* pad to 1k */
110};
111
837d5b6e
ID
112/* balance control ioctl modes */
113#define BTRFS_BALANCE_CTL_PAUSE 1
114
c9e9f97b
ID
115/*
116 * this is packed, because it should be exactly the same as its disk
117 * byte order counterpart (struct btrfs_disk_balance_args)
118 */
119struct btrfs_balance_args {
120 __u64 profiles;
121 __u64 usage;
122 __u64 devid;
123 __u64 pstart;
124 __u64 pend;
125 __u64 vstart;
126 __u64 vend;
127
128 __u64 target;
129
130 __u64 flags;
131
132 __u64 unused[8];
133} __attribute__ ((__packed__));
134
135/* report balance progress to userspace */
136struct btrfs_balance_progress {
137 __u64 expected; /* estimated # of chunks that will be
138 * relocated to fulfill the request */
139 __u64 considered; /* # of chunks we have considered so far */
140 __u64 completed; /* # of chunks relocated so far */
141};
142
837d5b6e
ID
143#define BTRFS_BALANCE_STATE_RUNNING (1ULL << 0)
144#define BTRFS_BALANCE_STATE_PAUSE_REQ (1ULL << 1)
145
c9e9f97b
ID
146struct btrfs_ioctl_balance_args {
147 __u64 flags; /* in/out */
148 __u64 state; /* out */
149
150 struct btrfs_balance_args data; /* in/out */
151 struct btrfs_balance_args meta; /* in/out */
152 struct btrfs_balance_args sys; /* in/out */
153
154 struct btrfs_balance_progress stat; /* out */
155
156 __u64 unused[72]; /* pad to 1k */
157};
158
ac8e9819
CM
159#define BTRFS_INO_LOOKUP_PATH_MAX 4080
160struct btrfs_ioctl_ino_lookup_args {
161 __u64 treeid;
162 __u64 objectid;
163 char name[BTRFS_INO_LOOKUP_PATH_MAX];
164};
165
166struct btrfs_ioctl_search_key {
167 /* which root are we searching. 0 is the tree of tree roots */
168 __u64 tree_id;
169
170 /* keys returned will be >= min and <= max */
171 __u64 min_objectid;
172 __u64 max_objectid;
173
174 /* keys returned will be >= min and <= max */
175 __u64 min_offset;
176 __u64 max_offset;
177
178 /* max and min transids to search for */
179 __u64 min_transid;
180 __u64 max_transid;
181
182 /* keys returned will be >= min and <= max */
183 __u32 min_type;
184 __u32 max_type;
185
186 /*
187 * how many items did userland ask for, and how many are we
188 * returning
189 */
190 __u32 nr_items;
191
192 /* align to 64 bits */
193 __u32 unused;
194
195 /* some extra for later */
196 __u64 unused1;
197 __u64 unused2;
198 __u64 unused3;
199 __u64 unused4;
200};
201
202struct btrfs_ioctl_search_header {
203 __u64 transid;
204 __u64 objectid;
205 __u64 offset;
206 __u32 type;
207 __u32 len;
208};
209
210#define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
211/*
212 * the buf is an array of search headers where
213 * each header is followed by the actual item
214 * the type field is expanded to 32 bits for alignment
215 */
216struct btrfs_ioctl_search_args {
217 struct btrfs_ioctl_search_key key;
218 char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
219};
220
c071fcfd
CM
221struct btrfs_ioctl_clone_range_args {
222 __s64 src_fd;
223 __u64 src_offset, src_length;
224 __u64 dest_offset;
225};
226
1e701a32
CM
227/* flags for the defrag range ioctl */
228#define BTRFS_DEFRAG_RANGE_COMPRESS 1
229#define BTRFS_DEFRAG_RANGE_START_IO 2
230
1406e432 231struct btrfs_ioctl_space_info {
ce769a29
SW
232 __u64 flags;
233 __u64 total_bytes;
234 __u64 used_bytes;
1406e432
JB
235};
236
237struct btrfs_ioctl_space_args {
ce769a29
SW
238 __u64 space_slots;
239 __u64 total_spaces;
1406e432
JB
240 struct btrfs_ioctl_space_info spaces[0];
241};
1e701a32 242
a542ad1b
JS
243struct btrfs_data_container {
244 __u32 bytes_left; /* out -- bytes not needed to deliver output */
245 __u32 bytes_missing; /* out -- additional bytes needed for result */
246 __u32 elem_cnt; /* out */
247 __u32 elem_missed; /* out */
740c3d22 248 __u64 val[0]; /* out */
a542ad1b
JS
249};
250
d7728c96
JS
251struct btrfs_ioctl_ino_path_args {
252 __u64 inum; /* in */
253 __u32 size; /* in */
254 __u64 reserved[4];
740c3d22
CM
255 /* struct btrfs_data_container *fspath; out */
256 __u64 fspath; /* out */
d7728c96
JS
257};
258
259struct btrfs_ioctl_logical_ino_args {
260 __u64 logical; /* in */
261 __u32 size; /* in */
262 __u64 reserved[4];
740c3d22
CM
263 /* struct btrfs_data_container *inodes; out */
264 __u64 inodes;
d7728c96
JS
265};
266
c5739bba
CM
267#define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
268 struct btrfs_ioctl_vol_args)
6702ed49 269#define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
8352d8a4 270 struct btrfs_ioctl_vol_args)
edbd8d4e
CM
271#define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
272 struct btrfs_ioctl_vol_args)
8a4b83cc
CM
273#define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
274 struct btrfs_ioctl_vol_args)
6bf13c0c
SW
275/* trans start and trans end are dangerous, and only for
276 * use by applications that know how to avoid the
277 * resulting deadlocks
278 */
279#define BTRFS_IOC_TRANS_START _IO(BTRFS_IOCTL_MAGIC, 6)
280#define BTRFS_IOC_TRANS_END _IO(BTRFS_IOCTL_MAGIC, 7)
281#define BTRFS_IOC_SYNC _IO(BTRFS_IOCTL_MAGIC, 8)
282
f2eb0a24 283#define BTRFS_IOC_CLONE _IOW(BTRFS_IOCTL_MAGIC, 9, int)
788f20eb
CM
284#define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
285 struct btrfs_ioctl_vol_args)
286#define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
287 struct btrfs_ioctl_vol_args)
288#define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
289 struct btrfs_ioctl_vol_args)
c5c9cd4d
SW
290
291#define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
292 struct btrfs_ioctl_clone_range_args)
293
3de4586c
CM
294#define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
295 struct btrfs_ioctl_vol_args)
76dda93c
YZ
296#define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
297 struct btrfs_ioctl_vol_args)
1e701a32
CM
298#define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
299 struct btrfs_ioctl_defrag_range_args)
ac8e9819
CM
300#define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
301 struct btrfs_ioctl_search_args)
302#define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
303 struct btrfs_ioctl_ino_lookup_args)
6ef5ed0d 304#define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, u64)
1406e432
JB
305#define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
306 struct btrfs_ioctl_space_args)
46204592
SW
307#define BTRFS_IOC_START_SYNC _IOR(BTRFS_IOCTL_MAGIC, 24, __u64)
308#define BTRFS_IOC_WAIT_SYNC _IOW(BTRFS_IOCTL_MAGIC, 22, __u64)
fdfb1e4f
LZ
309#define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \
310 struct btrfs_ioctl_vol_args_v2)
0caa102d
LZ
311#define BTRFS_IOC_SUBVOL_GETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 25, __u64)
312#define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64)
475f6387
JS
313#define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \
314 struct btrfs_ioctl_scrub_args)
315#define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28)
316#define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \
317 struct btrfs_ioctl_scrub_args)
318#define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \
319 struct btrfs_ioctl_dev_info_args)
320#define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \
321 struct btrfs_ioctl_fs_info_args)
c9e9f97b
ID
322#define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \
323 struct btrfs_ioctl_balance_args)
837d5b6e 324#define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int)
d7728c96
JS
325#define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \
326 struct btrfs_ioctl_ino_path_args)
327#define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \
328 struct btrfs_ioctl_ino_path_args)
329
c5739bba 330#endif