1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19#ifndef _UAPI_LINUX_BTRFS_H
20#define _UAPI_LINUX_BTRFS_H
21#include <linux/types.h>
22#include <linux/ioctl.h>
23
24#define BTRFS_IOCTL_MAGIC 0x94
25#define BTRFS_VOL_NAME_MAX 255
26
27
28#define BTRFS_PATH_NAME_MAX 4087
29struct btrfs_ioctl_vol_args {
30 __s64 fd;
31 char name[BTRFS_PATH_NAME_MAX + 1];
32};
33
34#define BTRFS_DEVICE_PATH_NAME_MAX 1024
35
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
41#define BTRFS_UUID_UNPARSED_SIZE 37
42
43#define BTRFS_QGROUP_INHERIT_SET_LIMITS (1ULL << 0)
44
45struct btrfs_qgroup_limit {
46 __u64 flags;
47 __u64 max_rfer;
48 __u64 max_excl;
49 __u64 rsv_rfer;
50 __u64 rsv_excl;
51};
52
53struct btrfs_qgroup_inherit {
54 __u64 flags;
55 __u64 num_qgroups;
56 __u64 num_ref_copies;
57 __u64 num_excl_copies;
58 struct btrfs_qgroup_limit lim;
59 __u64 qgroups[0];
60};
61
62struct btrfs_ioctl_qgroup_limit_args {
63 __u64 qgroupid;
64 struct btrfs_qgroup_limit lim;
65};
66
67#define BTRFS_SUBVOL_NAME_MAX 4039
68struct btrfs_ioctl_vol_args_v2 {
69 __s64 fd;
70 __u64 transid;
71 __u64 flags;
72 union {
73 struct {
74 __u64 size;
75 struct btrfs_qgroup_inherit __user *qgroup_inherit;
76 };
77 __u64 unused[4];
78 };
79 char name[BTRFS_SUBVOL_NAME_MAX + 1];
80};
81
82
83
84
85
86struct btrfs_scrub_progress {
87 __u64 data_extents_scrubbed;
88 __u64 tree_extents_scrubbed;
89 __u64 data_bytes_scrubbed;
90 __u64 tree_bytes_scrubbed;
91 __u64 read_errors;
92 __u64 csum_errors;
93 __u64 verify_errors;
94
95
96
97 __u64 no_csum;
98
99
100 __u64 csum_discards;
101
102 __u64 super_errors;
103 __u64 malloc_errors;
104
105
106 __u64 uncorrectable_errors;
107
108
109 __u64 corrected_errors;
110 __u64 last_physical;
111
112
113 __u64 unverified_errors;
114
115
116
117};
118
119#define BTRFS_SCRUB_READONLY 1
120struct btrfs_ioctl_scrub_args {
121 __u64 devid;
122 __u64 start;
123 __u64 end;
124 __u64 flags;
125 struct btrfs_scrub_progress progress;
126
127 __u64 unused[(1024-32-sizeof(struct btrfs_scrub_progress))/8];
128};
129
130#define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_ALWAYS 0
131#define BTRFS_IOCTL_DEV_REPLACE_CONT_READING_FROM_SRCDEV_MODE_AVOID 1
132struct btrfs_ioctl_dev_replace_start_params {
133 __u64 srcdevid;
134 __u64 cont_reading_from_srcdev_mode;
135
136 __u8 srcdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1];
137 __u8 tgtdev_name[BTRFS_DEVICE_PATH_NAME_MAX + 1];
138};
139
140#define BTRFS_IOCTL_DEV_REPLACE_STATE_NEVER_STARTED 0
141#define BTRFS_IOCTL_DEV_REPLACE_STATE_STARTED 1
142#define BTRFS_IOCTL_DEV_REPLACE_STATE_FINISHED 2
143#define BTRFS_IOCTL_DEV_REPLACE_STATE_CANCELED 3
144#define BTRFS_IOCTL_DEV_REPLACE_STATE_SUSPENDED 4
145struct btrfs_ioctl_dev_replace_status_params {
146 __u64 replace_state;
147 __u64 progress_1000;
148 __u64 time_started;
149 __u64 time_stopped;
150 __u64 num_write_errors;
151 __u64 num_uncorrectable_read_errors;
152};
153
154#define BTRFS_IOCTL_DEV_REPLACE_CMD_START 0
155#define BTRFS_IOCTL_DEV_REPLACE_CMD_STATUS 1
156#define BTRFS_IOCTL_DEV_REPLACE_CMD_CANCEL 2
157#define BTRFS_IOCTL_DEV_REPLACE_RESULT_NO_ERROR 0
158#define BTRFS_IOCTL_DEV_REPLACE_RESULT_NOT_STARTED 1
159#define BTRFS_IOCTL_DEV_REPLACE_RESULT_ALREADY_STARTED 2
160struct btrfs_ioctl_dev_replace_args {
161 __u64 cmd;
162 __u64 result;
163
164 union {
165 struct btrfs_ioctl_dev_replace_start_params start;
166 struct btrfs_ioctl_dev_replace_status_params status;
167 };
168
169 __u64 spare[64];
170};
171
172struct btrfs_ioctl_dev_info_args {
173 __u64 devid;
174 __u8 uuid[BTRFS_UUID_SIZE];
175 __u64 bytes_used;
176 __u64 total_bytes;
177 __u64 unused[379];
178 __u8 path[BTRFS_DEVICE_PATH_NAME_MAX];
179};
180
181struct btrfs_ioctl_fs_info_args {
182 __u64 max_id;
183 __u64 num_devices;
184 __u8 fsid[BTRFS_FSID_SIZE];
185 __u32 nodesize;
186 __u32 sectorsize;
187 __u32 clone_alignment;
188 __u32 reserved32;
189 __u64 reserved[122];
190};
191
192struct btrfs_ioctl_feature_flags {
193 __u64 compat_flags;
194 __u64 compat_ro_flags;
195 __u64 incompat_flags;
196};
197
198
199#define BTRFS_BALANCE_CTL_PAUSE 1
200#define BTRFS_BALANCE_CTL_CANCEL 2
201
202
203
204
205
206struct btrfs_balance_args {
207 __u64 profiles;
208 __u64 usage;
209 __u64 devid;
210 __u64 pstart;
211 __u64 pend;
212 __u64 vstart;
213 __u64 vend;
214
215 __u64 target;
216
217 __u64 flags;
218
219 __u64 limit;
220 __u64 unused[7];
221} __attribute__ ((__packed__));
222
223
224struct btrfs_balance_progress {
225 __u64 expected;
226
227 __u64 considered;
228 __u64 completed;
229};
230
231#define BTRFS_BALANCE_STATE_RUNNING (1ULL << 0)
232#define BTRFS_BALANCE_STATE_PAUSE_REQ (1ULL << 1)
233#define BTRFS_BALANCE_STATE_CANCEL_REQ (1ULL << 2)
234
235struct btrfs_ioctl_balance_args {
236 __u64 flags;
237 __u64 state;
238
239 struct btrfs_balance_args data;
240 struct btrfs_balance_args meta;
241 struct btrfs_balance_args sys;
242
243 struct btrfs_balance_progress stat;
244
245 __u64 unused[72];
246};
247
248#define BTRFS_INO_LOOKUP_PATH_MAX 4080
249struct btrfs_ioctl_ino_lookup_args {
250 __u64 treeid;
251 __u64 objectid;
252 char name[BTRFS_INO_LOOKUP_PATH_MAX];
253};
254
255struct btrfs_ioctl_search_key {
256
257 __u64 tree_id;
258
259
260 __u64 min_objectid;
261 __u64 max_objectid;
262
263
264 __u64 min_offset;
265 __u64 max_offset;
266
267
268 __u64 min_transid;
269 __u64 max_transid;
270
271
272 __u32 min_type;
273 __u32 max_type;
274
275
276
277
278
279 __u32 nr_items;
280
281
282 __u32 unused;
283
284
285 __u64 unused1;
286 __u64 unused2;
287 __u64 unused3;
288 __u64 unused4;
289};
290
291struct btrfs_ioctl_search_header {
292 __u64 transid;
293 __u64 objectid;
294 __u64 offset;
295 __u32 type;
296 __u32 len;
297};
298
299#define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
300
301
302
303
304
305struct btrfs_ioctl_search_args {
306 struct btrfs_ioctl_search_key key;
307 char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
308};
309
310struct btrfs_ioctl_search_args_v2 {
311 struct btrfs_ioctl_search_key key;
312 __u64 buf_size;
313
314
315 __u64 buf[0];
316};
317
318struct btrfs_ioctl_clone_range_args {
319 __s64 src_fd;
320 __u64 src_offset, src_length;
321 __u64 dest_offset;
322};
323
324
325#define BTRFS_DEFRAG_RANGE_COMPRESS 1
326#define BTRFS_DEFRAG_RANGE_START_IO 2
327
328#define BTRFS_SAME_DATA_DIFFERS 1
329
330struct btrfs_ioctl_same_extent_info {
331 __s64 fd;
332 __u64 logical_offset;
333 __u64 bytes_deduped;
334
335
336
337
338
339
340 __s32 status;
341 __u32 reserved;
342};
343
344struct btrfs_ioctl_same_args {
345 __u64 logical_offset;
346 __u64 length;
347 __u16 dest_count;
348 __u16 reserved1;
349 __u32 reserved2;
350 struct btrfs_ioctl_same_extent_info info[0];
351};
352
353struct btrfs_ioctl_space_info {
354 __u64 flags;
355 __u64 total_bytes;
356 __u64 used_bytes;
357};
358
359struct btrfs_ioctl_space_args {
360 __u64 space_slots;
361 __u64 total_spaces;
362 struct btrfs_ioctl_space_info spaces[0];
363};
364
365struct btrfs_data_container {
366 __u32 bytes_left;
367 __u32 bytes_missing;
368 __u32 elem_cnt;
369 __u32 elem_missed;
370 __u64 val[0];
371};
372
373struct btrfs_ioctl_ino_path_args {
374 __u64 inum;
375 __u64 size;
376 __u64 reserved[4];
377
378 __u64 fspath;
379};
380
381struct btrfs_ioctl_logical_ino_args {
382 __u64 logical;
383 __u64 size;
384 __u64 reserved[4];
385
386 __u64 inodes;
387};
388
389enum btrfs_dev_stat_values {
390
391 BTRFS_DEV_STAT_WRITE_ERRS,
392 BTRFS_DEV_STAT_READ_ERRS,
393 BTRFS_DEV_STAT_FLUSH_ERRS,
394
395
396 BTRFS_DEV_STAT_CORRUPTION_ERRS,
397
398
399
400
401
402 BTRFS_DEV_STAT_GENERATION_ERRS,
403
404
405 BTRFS_DEV_STAT_VALUES_MAX
406};
407
408
409#define BTRFS_DEV_STATS_RESET (1ULL << 0)
410
411struct btrfs_ioctl_get_dev_stats {
412 __u64 devid;
413 __u64 nr_items;
414 __u64 flags;
415
416
417 __u64 values[BTRFS_DEV_STAT_VALUES_MAX];
418
419 __u64 unused[128 - 2 - BTRFS_DEV_STAT_VALUES_MAX];
420};
421
422#define BTRFS_QUOTA_CTL_ENABLE 1
423#define BTRFS_QUOTA_CTL_DISABLE 2
424#define BTRFS_QUOTA_CTL_RESCAN__NOTUSED 3
425struct btrfs_ioctl_quota_ctl_args {
426 __u64 cmd;
427 __u64 status;
428};
429
430struct btrfs_ioctl_quota_rescan_args {
431 __u64 flags;
432 __u64 progress;
433 __u64 reserved[6];
434};
435
436struct btrfs_ioctl_qgroup_assign_args {
437 __u64 assign;
438 __u64 src;
439 __u64 dst;
440};
441
442struct btrfs_ioctl_qgroup_create_args {
443 __u64 create;
444 __u64 qgroupid;
445};
446struct btrfs_ioctl_timespec {
447 __u64 sec;
448 __u32 nsec;
449};
450
451struct btrfs_ioctl_received_subvol_args {
452 char uuid[BTRFS_UUID_SIZE];
453 __u64 stransid;
454 __u64 rtransid;
455 struct btrfs_ioctl_timespec stime;
456 struct btrfs_ioctl_timespec rtime;
457 __u64 flags;
458 __u64 reserved[16];
459};
460
461
462
463
464
465
466#define BTRFS_SEND_FLAG_NO_FILE_DATA 0x1
467
468
469
470
471
472#define BTRFS_SEND_FLAG_OMIT_STREAM_HEADER 0x2
473
474
475
476
477
478
479#define BTRFS_SEND_FLAG_OMIT_END_CMD 0x4
480
481#define BTRFS_SEND_FLAG_MASK \
482 (BTRFS_SEND_FLAG_NO_FILE_DATA | \
483 BTRFS_SEND_FLAG_OMIT_STREAM_HEADER | \
484 BTRFS_SEND_FLAG_OMIT_END_CMD)
485
486struct btrfs_ioctl_send_args {
487 __s64 send_fd;
488 __u64 clone_sources_count;
489 __u64 __user *clone_sources;
490 __u64 parent_root;
491 __u64 flags;
492 __u64 reserved[4];
493};
494
495
496enum btrfs_err_code {
497 notused,
498 BTRFS_ERROR_DEV_RAID1_MIN_NOT_MET,
499 BTRFS_ERROR_DEV_RAID10_MIN_NOT_MET,
500 BTRFS_ERROR_DEV_RAID5_MIN_NOT_MET,
501 BTRFS_ERROR_DEV_RAID6_MIN_NOT_MET,
502 BTRFS_ERROR_DEV_TGT_REPLACE,
503 BTRFS_ERROR_DEV_MISSING_NOT_FOUND,
504 BTRFS_ERROR_DEV_ONLY_WRITABLE,
505 BTRFS_ERROR_DEV_EXCL_RUN_IN_PROGRESS
506};
507
508
509
510static inline char *btrfs_err_str(enum btrfs_err_code err_code)
511{
512 switch (err_code) {
513 case BTRFS_ERROR_DEV_RAID1_MIN_NOT_MET:
514 return "unable to go below two devices on raid1";
515 case BTRFS_ERROR_DEV_RAID10_MIN_NOT_MET:
516 return "unable to go below four devices on raid10";
517 case BTRFS_ERROR_DEV_RAID5_MIN_NOT_MET:
518 return "unable to go below two devices on raid5";
519 case BTRFS_ERROR_DEV_RAID6_MIN_NOT_MET:
520 return "unable to go below three devices on raid6";
521 case BTRFS_ERROR_DEV_TGT_REPLACE:
522 return "unable to remove the dev_replace target dev";
523 case BTRFS_ERROR_DEV_MISSING_NOT_FOUND:
524 return "no missing devices found to remove";
525 case BTRFS_ERROR_DEV_ONLY_WRITABLE:
526 return "unable to remove the only writeable device";
527 case BTRFS_ERROR_DEV_EXCL_RUN_IN_PROGRESS:
528 return "add/delete/balance/replace/resize operation "\
529 "in progress";
530 default:
531 return NULL;
532 }
533}
534
535#define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
536 struct btrfs_ioctl_vol_args)
537#define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
538 struct btrfs_ioctl_vol_args)
539#define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
540 struct btrfs_ioctl_vol_args)
541#define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
542 struct btrfs_ioctl_vol_args)
543
544
545
546
547#define BTRFS_IOC_TRANS_START _IO(BTRFS_IOCTL_MAGIC, 6)
548#define BTRFS_IOC_TRANS_END _IO(BTRFS_IOCTL_MAGIC, 7)
549#define BTRFS_IOC_SYNC _IO(BTRFS_IOCTL_MAGIC, 8)
550
551#define BTRFS_IOC_CLONE _IOW(BTRFS_IOCTL_MAGIC, 9, int)
552#define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
553 struct btrfs_ioctl_vol_args)
554#define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
555 struct btrfs_ioctl_vol_args)
556#define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
557 struct btrfs_ioctl_vol_args)
558
559#define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
560 struct btrfs_ioctl_clone_range_args)
561
562#define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
563 struct btrfs_ioctl_vol_args)
564#define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
565 struct btrfs_ioctl_vol_args)
566#define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
567 struct btrfs_ioctl_defrag_range_args)
568#define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
569 struct btrfs_ioctl_search_args)
570#define BTRFS_IOC_TREE_SEARCH_V2 _IOWR(BTRFS_IOCTL_MAGIC, 17, \
571 struct btrfs_ioctl_search_args_v2)
572#define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
573 struct btrfs_ioctl_ino_lookup_args)
574#define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, __u64)
575#define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
576 struct btrfs_ioctl_space_args)
577#define BTRFS_IOC_START_SYNC _IOR(BTRFS_IOCTL_MAGIC, 24, __u64)
578#define BTRFS_IOC_WAIT_SYNC _IOW(BTRFS_IOCTL_MAGIC, 22, __u64)
579#define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \
580 struct btrfs_ioctl_vol_args_v2)
581#define BTRFS_IOC_SUBVOL_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 24, \
582 struct btrfs_ioctl_vol_args_v2)
583#define BTRFS_IOC_SUBVOL_GETFLAGS _IOR(BTRFS_IOCTL_MAGIC, 25, __u64)
584#define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64)
585#define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \
586 struct btrfs_ioctl_scrub_args)
587#define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28)
588#define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \
589 struct btrfs_ioctl_scrub_args)
590#define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \
591 struct btrfs_ioctl_dev_info_args)
592#define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \
593 struct btrfs_ioctl_fs_info_args)
594#define BTRFS_IOC_BALANCE_V2 _IOWR(BTRFS_IOCTL_MAGIC, 32, \
595 struct btrfs_ioctl_balance_args)
596#define BTRFS_IOC_BALANCE_CTL _IOW(BTRFS_IOCTL_MAGIC, 33, int)
597#define BTRFS_IOC_BALANCE_PROGRESS _IOR(BTRFS_IOCTL_MAGIC, 34, \
598 struct btrfs_ioctl_balance_args)
599#define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \
600 struct btrfs_ioctl_ino_path_args)
601#define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \
602 struct btrfs_ioctl_ino_path_args)
603#define BTRFS_IOC_SET_RECEIVED_SUBVOL _IOWR(BTRFS_IOCTL_MAGIC, 37, \
604 struct btrfs_ioctl_received_subvol_args)
605#define BTRFS_IOC_SEND _IOW(BTRFS_IOCTL_MAGIC, 38, struct btrfs_ioctl_send_args)
606#define BTRFS_IOC_DEVICES_READY _IOR(BTRFS_IOCTL_MAGIC, 39, \
607 struct btrfs_ioctl_vol_args)
608#define BTRFS_IOC_QUOTA_CTL _IOWR(BTRFS_IOCTL_MAGIC, 40, \
609 struct btrfs_ioctl_quota_ctl_args)
610#define BTRFS_IOC_QGROUP_ASSIGN _IOW(BTRFS_IOCTL_MAGIC, 41, \
611 struct btrfs_ioctl_qgroup_assign_args)
612#define BTRFS_IOC_QGROUP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 42, \
613 struct btrfs_ioctl_qgroup_create_args)
614#define BTRFS_IOC_QGROUP_LIMIT _IOR(BTRFS_IOCTL_MAGIC, 43, \
615 struct btrfs_ioctl_qgroup_limit_args)
616#define BTRFS_IOC_QUOTA_RESCAN _IOW(BTRFS_IOCTL_MAGIC, 44, \
617 struct btrfs_ioctl_quota_rescan_args)
618#define BTRFS_IOC_QUOTA_RESCAN_STATUS _IOR(BTRFS_IOCTL_MAGIC, 45, \
619 struct btrfs_ioctl_quota_rescan_args)
620#define BTRFS_IOC_QUOTA_RESCAN_WAIT _IO(BTRFS_IOCTL_MAGIC, 46)
621#define BTRFS_IOC_GET_FSLABEL _IOR(BTRFS_IOCTL_MAGIC, 49, \
622 char[BTRFS_LABEL_SIZE])
623#define BTRFS_IOC_SET_FSLABEL _IOW(BTRFS_IOCTL_MAGIC, 50, \
624 char[BTRFS_LABEL_SIZE])
625#define BTRFS_IOC_GET_DEV_STATS _IOWR(BTRFS_IOCTL_MAGIC, 52, \
626 struct btrfs_ioctl_get_dev_stats)
627#define BTRFS_IOC_DEV_REPLACE _IOWR(BTRFS_IOCTL_MAGIC, 53, \
628 struct btrfs_ioctl_dev_replace_args)
629#define BTRFS_IOC_FILE_EXTENT_SAME _IOWR(BTRFS_IOCTL_MAGIC, 54, \
630 struct btrfs_ioctl_same_args)
631#define BTRFS_IOC_GET_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
632 struct btrfs_ioctl_feature_flags)
633#define BTRFS_IOC_SET_FEATURES _IOW(BTRFS_IOCTL_MAGIC, 57, \
634 struct btrfs_ioctl_feature_flags[2])
635#define BTRFS_IOC_GET_SUPPORTED_FEATURES _IOR(BTRFS_IOCTL_MAGIC, 57, \
636 struct btrfs_ioctl_feature_flags[3])
637
638#endif
639