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