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