]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - fs/btrfs/ioctl.h
Btrfs: add new sources for device replace code
[mirror_ubuntu-artful-kernel.git] / fs / btrfs / ioctl.h
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 __IOCTL_
20 #define __IOCTL_
21 #include <linux/ioctl.h>
22
23 #define BTRFS_IOCTL_MAGIC 0x94
24 #define BTRFS_VOL_NAME_MAX 255
25
26 /* this should be 4k */
27 #define BTRFS_PATH_NAME_MAX 4087
28 struct btrfs_ioctl_vol_args {
29 __s64 fd;
30 char name[BTRFS_PATH_NAME_MAX + 1];
31 };
32
33 #define BTRFS_SUBVOL_CREATE_ASYNC (1ULL << 0)
34 #define BTRFS_SUBVOL_RDONLY (1ULL << 1)
35 #define BTRFS_SUBVOL_QGROUP_INHERIT (1ULL << 2)
36 #define BTRFS_FSID_SIZE 16
37 #define BTRFS_UUID_SIZE 16
38
39 #define BTRFS_QGROUP_INHERIT_SET_LIMITS (1ULL << 0)
40
41 struct btrfs_qgroup_limit {
42 __u64 flags;
43 __u64 max_rfer;
44 __u64 max_excl;
45 __u64 rsv_rfer;
46 __u64 rsv_excl;
47 };
48
49 struct btrfs_qgroup_inherit {
50 __u64 flags;
51 __u64 num_qgroups;
52 __u64 num_ref_copies;
53 __u64 num_excl_copies;
54 struct btrfs_qgroup_limit lim;
55 __u64 qgroups[0];
56 };
57
58 struct btrfs_ioctl_qgroup_limit_args {
59 __u64 qgroupid;
60 struct btrfs_qgroup_limit lim;
61 };
62
63 #define BTRFS_SUBVOL_NAME_MAX 4039
64 struct btrfs_ioctl_vol_args_v2 {
65 __s64 fd;
66 __u64 transid;
67 __u64 flags;
68 union {
69 struct {
70 __u64 size;
71 struct btrfs_qgroup_inherit __user *qgroup_inherit;
72 };
73 __u64 unused[4];
74 };
75 char name[BTRFS_SUBVOL_NAME_MAX + 1];
76 };
77
78 /*
79 * structure to report errors and progress to userspace, either as a
80 * result of a finished scrub, a canceled scrub or a progress inquiry
81 */
82 struct btrfs_scrub_progress {
83 __u64 data_extents_scrubbed; /* # of data extents scrubbed */
84 __u64 tree_extents_scrubbed; /* # of tree extents scrubbed */
85 __u64 data_bytes_scrubbed; /* # of data bytes scrubbed */
86 __u64 tree_bytes_scrubbed; /* # of tree bytes scrubbed */
87 __u64 read_errors; /* # of read errors encountered (EIO) */
88 __u64 csum_errors; /* # of failed csum checks */
89 __u64 verify_errors; /* # of occurences, where the metadata
90 * of a tree block did not match the
91 * expected values, like generation or
92 * logical */
93 __u64 no_csum; /* # of 4k data block for which no csum
94 * is present, probably the result of
95 * data written with nodatasum */
96 __u64 csum_discards; /* # of csum for which no data was found
97 * in the extent tree. */
98 __u64 super_errors; /* # of bad super blocks encountered */
99 __u64 malloc_errors; /* # of internal kmalloc errors. These
100 * will likely cause an incomplete
101 * scrub */
102 __u64 uncorrectable_errors; /* # of errors where either no intact
103 * copy was found or the writeback
104 * failed */
105 __u64 corrected_errors; /* # of errors corrected */
106 __u64 last_physical; /* last physical address scrubbed. In
107 * case a scrub was aborted, this can
108 * be used to restart the scrub */
109 __u64 unverified_errors; /* # of occurences where a read for a
110 * full (64k) bio failed, but the re-
111 * check succeeded for each 4k piece.
112 * Intermittent error. */
113 };
114
115 #define BTRFS_SCRUB_READONLY 1
116 struct btrfs_ioctl_scrub_args {
117 __u64 devid; /* in */
118 __u64 start; /* in */
119 __u64 end; /* in */
120 __u64 flags; /* in */
121 struct btrfs_scrub_progress progress; /* out */
122 /* pad to 1k */
123 __u64 unused[(1024-32-sizeof(struct btrfs_scrub_progress))/8];
124 };
125
126 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_ALWAYS 0
127 #define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_AVOID 1
128 struct btrfs_ioctl_dev_replace_start_params {
129 __u64 srcdevid; /* in, if 0, use srcdev_name instead */
130 __u8 srcdev_name[BTRFS_PATH_NAME_MAX + 1]; /* in */
131 __u8 tgtdev_name[BTRFS_PATH_NAME_MAX + 1]; /* in */
132 __u64 cont_reading_from_srcdev_mode; /* in, see #define
133 * above */
134 };
135
136 #define BTRFS_IOCTL_DEV_REPLACE_STATE_NEVER_STARTED 0
137 #define BTRFS_IOCTL_DEV_REPLACE_STATE_STARTED 1
138 #define BTRFS_IOCTL_DEV_REPLACE_STATE_FINISHED 2
139 #define BTRFS_IOCTL_DEV_REPLACE_STATE_CANCELED 3
140 #define BTRFS_IOCTL_DEV_REPLACE_STATE_SUSPENDED 4
141 struct btrfs_ioctl_dev_replace_status_params {
142 __u64 replace_state; /* out, see #define above */
143 __u64 progress_1000; /* out, 0 <= x <= 1000 */
144 __u64 time_started; /* out, seconds since 1-Jan-1970 */
145 __u64 time_stopped; /* out, seconds since 1-Jan-1970 */
146 __u64 num_write_errors; /* out */
147 __u64 num_uncorrectable_read_errors; /* out */
148 };
149
150 #define BTRFS_IOCTL_DEV_REPLACE_CMD_START 0
151 #define BTRFS_IOCTL_DEV_REPLACE_CMD_STATUS 1
152 #define BTRFS_IOCTL_DEV_REPLACE_CMD_CANCEL 2
153 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NO_ERROR 0
154 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_NOT_STARTED 1
155 #define BTRFS_IOCTL_DEV_REPLACE_RESULT_ALREADY_STARTED 2
156 struct btrfs_ioctl_dev_replace_args {
157 __u64 cmd; /* in */
158 __u64 result; /* out */
159
160 union {
161 struct btrfs_ioctl_dev_replace_start_params start;
162 struct btrfs_ioctl_dev_replace_status_params status;
163 }; /* in/out */
164
165 __u64 spare[64];
166 };
167
168 #define BTRFS_DEVICE_PATH_NAME_MAX 1024
169 struct btrfs_ioctl_dev_info_args {
170 __u64 devid; /* in/out */
171 __u8 uuid[BTRFS_UUID_SIZE]; /* in/out */
172 __u64 bytes_used; /* out */
173 __u64 total_bytes; /* out */
174 __u64 unused[379]; /* pad to 4k */
175 __u8 path[BTRFS_DEVICE_PATH_NAME_MAX]; /* out */
176 };
177
178 struct btrfs_ioctl_fs_info_args {
179 __u64 max_id; /* out */
180 __u64 num_devices; /* out */
181 __u8 fsid[BTRFS_FSID_SIZE]; /* out */
182 __u64 reserved[124]; /* pad to 1k */
183 };
184
185 /* balance control ioctl modes */
186 #define BTRFS_BALANCE_CTL_PAUSE 1
187 #define BTRFS_BALANCE_CTL_CANCEL 2
188
189 /*
190 * this is packed, because it should be exactly the same as its disk
191 * byte order counterpart (struct btrfs_disk_balance_args)
192 */
193 struct btrfs_balance_args {
194 __u64 profiles;
195 __u64 usage;
196 __u64 devid;
197 __u64 pstart;
198 __u64 pend;
199 __u64 vstart;
200 __u64 vend;
201
202 __u64 target;
203
204 __u64 flags;
205
206 __u64 unused[8];
207 } __attribute__ ((__packed__));
208
209 /* report balance progress to userspace */
210 struct btrfs_balance_progress {
211 __u64 expected; /* estimated # of chunks that will be
212 * relocated to fulfill the request */
213 __u64 considered; /* # of chunks we have considered so far */
214 __u64 completed; /* # of chunks relocated so far */
215 };
216
217 #define BTRFS_BALANCE_STATE_RUNNING (1ULL << 0)
218 #define BTRFS_BALANCE_STATE_PAUSE_REQ (1ULL << 1)
219 #define BTRFS_BALANCE_STATE_CANCEL_REQ (1ULL << 2)
220
221 struct btrfs_ioctl_balance_args {
222 __u64 flags; /* in/out */
223 __u64 state; /* out */
224
225 struct btrfs_balance_args data; /* in/out */
226 struct btrfs_balance_args meta; /* in/out */
227 struct btrfs_balance_args sys; /* in/out */
228
229 struct btrfs_balance_progress stat; /* out */
230
231 __u64 unused[72]; /* pad to 1k */
232 };
233
234 #define BTRFS_INO_LOOKUP_PATH_MAX 4080
235 struct btrfs_ioctl_ino_lookup_args {
236 __u64 treeid;
237 __u64 objectid;
238 char name[BTRFS_INO_LOOKUP_PATH_MAX];
239 };
240
241 struct btrfs_ioctl_search_key {
242 /* which root are we searching. 0 is the tree of tree roots */
243 __u64 tree_id;
244
245 /* keys returned will be >= min and <= max */
246 __u64 min_objectid;
247 __u64 max_objectid;
248
249 /* keys returned will be >= min and <= max */
250 __u64 min_offset;
251 __u64 max_offset;
252
253 /* max and min transids to search for */
254 __u64 min_transid;
255 __u64 max_transid;
256
257 /* keys returned will be >= min and <= max */
258 __u32 min_type;
259 __u32 max_type;
260
261 /*
262 * how many items did userland ask for, and how many are we
263 * returning
264 */
265 __u32 nr_items;
266
267 /* align to 64 bits */
268 __u32 unused;
269
270 /* some extra for later */
271 __u64 unused1;
272 __u64 unused2;
273 __u64 unused3;
274 __u64 unused4;
275 };
276
277 struct btrfs_ioctl_search_header {
278 __u64 transid;
279 __u64 objectid;
280 __u64 offset;
281 __u32 type;
282 __u32 len;
283 };
284
285 #define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
286 /*
287 * the buf is an array of search headers where
288 * each header is followed by the actual item
289 * the type field is expanded to 32 bits for alignment
290 */
291 struct btrfs_ioctl_search_args {
292 struct btrfs_ioctl_search_key key;
293 char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
294 };
295
296 struct btrfs_ioctl_clone_range_args {
297 __s64 src_fd;
298 __u64 src_offset, src_length;
299 __u64 dest_offset;
300 };
301
302 /* flags for the defrag range ioctl */
303 #define BTRFS_DEFRAG_RANGE_COMPRESS 1
304 #define BTRFS_DEFRAG_RANGE_START_IO 2
305
306 struct btrfs_ioctl_space_info {
307 __u64 flags;
308 __u64 total_bytes;
309 __u64 used_bytes;
310 };
311
312 struct btrfs_ioctl_space_args {
313 __u64 space_slots;
314 __u64 total_spaces;
315 struct btrfs_ioctl_space_info spaces[0];
316 };
317
318 struct btrfs_data_container {
319 __u32 bytes_left; /* out -- bytes not needed to deliver output */
320 __u32 bytes_missing; /* out -- additional bytes needed for result */
321 __u32 elem_cnt; /* out */
322 __u32 elem_missed; /* out */
323 __u64 val[0]; /* out */
324 };
325
326 struct btrfs_ioctl_ino_path_args {
327 __u64 inum; /* in */
328 __u64 size; /* in */
329 __u64 reserved[4];
330 /* struct btrfs_data_container *fspath; out */
331 __u64 fspath; /* out */
332 };
333
334 struct btrfs_ioctl_logical_ino_args {
335 __u64 logical; /* in */
336 __u64 size; /* in */
337 __u64 reserved[4];
338 /* struct btrfs_data_container *inodes; out */
339 __u64 inodes;
340 };
341
342 enum btrfs_dev_stat_values {
343 /* disk I/O failure stats */
344 BTRFS_DEV_STAT_WRITE_ERRS, /* EIO or EREMOTEIO from lower layers */
345 BTRFS_DEV_STAT_READ_ERRS, /* EIO or EREMOTEIO from lower layers */
346 BTRFS_DEV_STAT_FLUSH_ERRS, /* EIO or EREMOTEIO from lower layers */
347
348 /* stats for indirect indications for I/O failures */
349 BTRFS_DEV_STAT_CORRUPTION_ERRS, /* checksum error, bytenr error or
350 * contents is illegal: this is an
351 * indication that the block was damaged
352 * during read or write, or written to
353 * wrong location or read from wrong
354 * location */
355 BTRFS_DEV_STAT_GENERATION_ERRS, /* an indication that blocks have not
356 * been written */
357
358 BTRFS_DEV_STAT_VALUES_MAX
359 };
360
361 /* Reset statistics after reading; needs SYS_ADMIN capability */
362 #define BTRFS_DEV_STATS_RESET (1ULL << 0)
363
364 struct btrfs_ioctl_get_dev_stats {
365 __u64 devid; /* in */
366 __u64 nr_items; /* in/out */
367 __u64 flags; /* in/out */
368
369 /* out values: */
370 __u64 values[BTRFS_DEV_STAT_VALUES_MAX];
371
372 __u64 unused[128 - 2 - BTRFS_DEV_STAT_VALUES_MAX]; /* pad to 1k */
373 };
374
375 #define BTRFS_QUOTA_CTL_ENABLE 1
376 #define BTRFS_QUOTA_CTL_DISABLE 2
377 #define BTRFS_QUOTA_CTL_RESCAN 3
378 struct btrfs_ioctl_quota_ctl_args {
379 __u64 cmd;
380 __u64 status;
381 };
382
383 struct btrfs_ioctl_qgroup_assign_args {
384 __u64 assign;
385 __u64 src;
386 __u64 dst;
387 };
388
389 struct btrfs_ioctl_qgroup_create_args {
390 __u64 create;
391 __u64 qgroupid;
392 };
393 struct btrfs_ioctl_timespec {
394 __u64 sec;
395 __u32 nsec;
396 };
397
398 struct btrfs_ioctl_received_subvol_args {
399 char uuid[BTRFS_UUID_SIZE]; /* in */
400 __u64 stransid; /* in */
401 __u64 rtransid; /* out */
402 struct btrfs_ioctl_timespec stime; /* in */
403 struct btrfs_ioctl_timespec rtime; /* out */
404 __u64 flags; /* in */
405 __u64 reserved[16]; /* in */
406 };
407
408 struct btrfs_ioctl_send_args {
409 __s64 send_fd; /* in */
410 __u64 clone_sources_count; /* in */
411 __u64 __user *clone_sources; /* in */
412 __u64 parent_root; /* in */
413 __u64 flags; /* in */
414 __u64 reserved[4]; /* in */
415 };
416
417 #define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
418 struct btrfs_ioctl_vol_args)
419 #define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
420 struct btrfs_ioctl_vol_args)
421 #define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
422 struct btrfs_ioctl_vol_args)
423 #define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
424 struct btrfs_ioctl_vol_args)
425 /* trans start and trans end are dangerous, and only for
426 * use by applications that know how to avoid the
427 * resulting deadlocks
428 */
429 #define BTRFS_IOC_TRANS_START _IO(BTRFS_IOCTL_MAGIC, 6)
430 #define BTRFS_IOC_TRANS_END _IO(BTRFS_IOCTL_MAGIC, 7)
431 #define BTRFS_IOC_SYNC _IO(BTRFS_IOCTL_MAGIC, 8)
432
433 #define BTRFS_IOC_CLONE _IOW(BTRFS_IOCTL_MAGIC, 9, int)
434 #define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
435 struct btrfs_ioctl_vol_args)
436 #define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
437 struct btrfs_ioctl_vol_args)
438 #define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
439 struct btrfs_ioctl_vol_args)
440
441 #define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
442 struct btrfs_ioctl_clone_range_args)
443
444 #define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
445 struct btrfs_ioctl_vol_args)
446 #define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
447 struct btrfs_ioctl_vol_args)
448 #define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
449 struct btrfs_ioctl_defrag_range_args)
450 #define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
451 struct btrfs_ioctl_search_args)
452 #define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
453 struct btrfs_ioctl_ino_lookup_args)
454 #define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, u64)
455 #define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
456 struct btrfs_ioctl_space_args)
457 #define BTRFS_IOC_START_SYNC _IOR(BTRFS_IOCTL_MAGIC, 24, __u64)
458 #define BTRFS_IOC_WAIT_SYNC _IOW(BTRFS_IOCTL_MAGIC, 22, __u64)
459 #define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \
460 struct btrfs_ioctl_vol_args_v2)
461 #define BTRFS_IOC_SUBVOL_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 24, \
462 struct btrfs_ioctl_vol_args_v2)
463 #define BTRFS_IOC_SUBVOL_GETFLAGS _IOR(BTRFS_IOCTL_MAGIC, 25, __u64)
464 #define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64)
465 #define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \
466 struct btrfs_ioctl_scrub_args)
467 #define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28)
468 #define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \
469 struct btrfs_ioctl_scrub_args)
470 #define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \
471 struct btrfs_ioctl_dev_info_args)
472 #define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \
473 struct btrfs_ioctl_fs_info_args)
474 #define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \
475 struct btrfs_ioctl_balance_args)
476 #define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int)
477 #define BTRFS_IOC_BALANCE_PROGRESS _IOR(BTRFS_IOCTL_MAGIC, 34, \
478 struct btrfs_ioctl_balance_args)
479 #define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \
480 struct btrfs_ioctl_ino_path_args)
481 #define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \
482 struct btrfs_ioctl_ino_path_args)
483 #define BTRFS_IOC_SET_RECEIVED_SUBVOL _IOWR(BTRFS_IOCTL_MAGIC, 37, \
484 struct btrfs_ioctl_received_subvol_args)
485 #define BTRFS_IOC_SEND _IOW(BTRFS_IOCTL_MAGIC, 38, struct btrfs_ioctl_send_args)
486 #define BTRFS_IOC_DEVICES_READY _IOR(BTRFS_IOCTL_MAGIC, 39, \
487 struct btrfs_ioctl_vol_args)
488 #define BTRFS_IOC_QUOTA_CTL _IOWR(BTRFS_IOCTL_MAGIC, 40, \
489 struct btrfs_ioctl_quota_ctl_args)
490 #define BTRFS_IOC_QGROUP_ASSIGN _IOW(BTRFS_IOCTL_MAGIC, 41, \
491 struct btrfs_ioctl_qgroup_assign_args)
492 #define BTRFS_IOC_QGROUP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 42, \
493 struct btrfs_ioctl_qgroup_create_args)
494 #define BTRFS_IOC_QGROUP_LIMIT _IOR(BTRFS_IOCTL_MAGIC, 43, \
495 struct btrfs_ioctl_qgroup_limit_args)
496 #define BTRFS_IOC_GET_DEV_STATS _IOWR(BTRFS_IOCTL_MAGIC, 52, \
497 struct btrfs_ioctl_get_dev_stats)
498 #define BTRFS_IOC_DEV_REPLACE _IOWR(BTRFS_IOCTL_MAGIC, 53, \
499 struct btrfs_ioctl_dev_replace_args)
500
501 #endif