blob: 252ae9915de8fcfa4b6b7a3a502735c28d1819f6 [file] [log] [blame]
Chris Mason6cbd5572007-06-12 09:07:21 -04001/*
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
Chris Masonc5739bb2007-04-10 09:27:04 -040019#ifndef __IOCTL_
20#define __IOCTL_
21#include <linux/ioctl.h>
22
23#define BTRFS_IOCTL_MAGIC 0x94
24#define BTRFS_VOL_NAME_MAX 255
Chris Mason8a4b83c2008-03-24 15:02:07 -040025
Chris Masonc071fcf2009-01-16 11:59:08 -050026/* this should be 4k */
Sage Weil72fd0322010-10-29 15:41:32 -040027#define BTRFS_PATH_NAME_MAX 4087
Chris Masonc5739bb2007-04-10 09:27:04 -040028struct btrfs_ioctl_vol_args {
Chris Mason3de45862008-11-17 21:02:50 -050029 __s64 fd;
Chris Mason8a4b83c2008-03-24 15:02:07 -040030 char name[BTRFS_PATH_NAME_MAX + 1];
Chris Masonc5739bb2007-04-10 09:27:04 -040031};
32
Li Zefanfdfb1e42010-12-10 06:41:56 +000033#define BTRFS_SUBVOL_CREATE_ASYNC (1ULL << 0)
Li Zefanb83cc962010-12-20 16:04:08 +080034#define BTRFS_SUBVOL_RDONLY (1ULL << 1)
Jan Schmidt475f6382011-03-11 15:41:01 +010035#define BTRFS_FSID_SIZE 16
36#define BTRFS_UUID_SIZE 16
Li Zefanfdfb1e42010-12-10 06:41:56 +000037
38#define BTRFS_SUBVOL_NAME_MAX 4039
39struct btrfs_ioctl_vol_args_v2 {
Sage Weil72fd0322010-10-29 15:41:32 -040040 __s64 fd;
41 __u64 transid;
Li Zefanfdfb1e42010-12-10 06:41:56 +000042 __u64 flags;
43 __u64 unused[4];
44 char name[BTRFS_SUBVOL_NAME_MAX + 1];
Sage Weil72fd0322010-10-29 15:41:32 -040045};
46
Arne Jansena2de7332011-03-08 14:14:00 +010047/*
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
Arne Jansen86287642011-03-23 16:34:19 +010084#define BTRFS_SCRUB_READONLY 1
Jan Schmidt475f6382011-03-11 15:41:01 +010085struct 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
Chris Masonac8e9812010-02-28 15:39:26 -0500112#define BTRFS_INO_LOOKUP_PATH_MAX 4080
113struct btrfs_ioctl_ino_lookup_args {
114 __u64 treeid;
115 __u64 objectid;
116 char name[BTRFS_INO_LOOKUP_PATH_MAX];
117};
118
119struct btrfs_ioctl_search_key {
120 /* which root are we searching. 0 is the tree of tree roots */
121 __u64 tree_id;
122
123 /* keys returned will be >= min and <= max */
124 __u64 min_objectid;
125 __u64 max_objectid;
126
127 /* keys returned will be >= min and <= max */
128 __u64 min_offset;
129 __u64 max_offset;
130
131 /* max and min transids to search for */
132 __u64 min_transid;
133 __u64 max_transid;
134
135 /* keys returned will be >= min and <= max */
136 __u32 min_type;
137 __u32 max_type;
138
139 /*
140 * how many items did userland ask for, and how many are we
141 * returning
142 */
143 __u32 nr_items;
144
145 /* align to 64 bits */
146 __u32 unused;
147
148 /* some extra for later */
149 __u64 unused1;
150 __u64 unused2;
151 __u64 unused3;
152 __u64 unused4;
153};
154
155struct btrfs_ioctl_search_header {
156 __u64 transid;
157 __u64 objectid;
158 __u64 offset;
159 __u32 type;
160 __u32 len;
161};
162
163#define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
164/*
165 * the buf is an array of search headers where
166 * each header is followed by the actual item
167 * the type field is expanded to 32 bits for alignment
168 */
169struct btrfs_ioctl_search_args {
170 struct btrfs_ioctl_search_key key;
171 char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
172};
173
Chris Masonc071fcf2009-01-16 11:59:08 -0500174struct btrfs_ioctl_clone_range_args {
175 __s64 src_fd;
176 __u64 src_offset, src_length;
177 __u64 dest_offset;
178};
179
Chris Mason1e701a32010-03-11 09:42:04 -0500180/* flags for the defrag range ioctl */
181#define BTRFS_DEFRAG_RANGE_COMPRESS 1
182#define BTRFS_DEFRAG_RANGE_START_IO 2
183
Josef Bacik1406e432010-01-13 18:19:06 +0000184struct btrfs_ioctl_space_info {
Sage Weilce769a22010-03-16 00:02:26 +0000185 __u64 flags;
186 __u64 total_bytes;
187 __u64 used_bytes;
Josef Bacik1406e432010-01-13 18:19:06 +0000188};
189
190struct btrfs_ioctl_space_args {
Sage Weilce769a22010-03-16 00:02:26 +0000191 __u64 space_slots;
192 __u64 total_spaces;
Josef Bacik1406e432010-01-13 18:19:06 +0000193 struct btrfs_ioctl_space_info spaces[0];
194};
Chris Mason1e701a32010-03-11 09:42:04 -0500195
Jan Schmidta542ad12011-06-13 19:52:59 +0200196struct btrfs_data_container {
197 __u32 bytes_left; /* out -- bytes not needed to deliver output */
198 __u32 bytes_missing; /* out -- additional bytes needed for result */
199 __u32 elem_cnt; /* out */
200 __u32 elem_missed; /* out */
Chris Mason740c3d22011-11-02 15:48:34 -0400201 __u64 val[0]; /* out */
Jan Schmidta542ad12011-06-13 19:52:59 +0200202};
203
Jan Schmidtd7728c92011-07-07 16:48:38 +0200204struct btrfs_ioctl_ino_path_args {
205 __u64 inum; /* in */
206 __u32 size; /* in */
207 __u64 reserved[4];
Chris Mason740c3d22011-11-02 15:48:34 -0400208 /* struct btrfs_data_container *fspath; out */
209 __u64 fspath; /* out */
Jan Schmidtd7728c92011-07-07 16:48:38 +0200210};
211
212struct btrfs_ioctl_logical_ino_args {
213 __u64 logical; /* in */
214 __u32 size; /* in */
215 __u64 reserved[4];
Chris Mason740c3d22011-11-02 15:48:34 -0400216 /* struct btrfs_data_container *inodes; out */
217 __u64 inodes;
Jan Schmidtd7728c92011-07-07 16:48:38 +0200218};
219
Chris Masonc5739bb2007-04-10 09:27:04 -0400220#define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
221 struct btrfs_ioctl_vol_args)
Chris Mason6702ed42007-08-07 16:15:09 -0400222#define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
Chris Mason8352d8a2007-04-12 10:43:05 -0400223 struct btrfs_ioctl_vol_args)
Chris Masonedbd8d42007-12-21 16:27:24 -0500224#define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
225 struct btrfs_ioctl_vol_args)
Chris Mason8a4b83c2008-03-24 15:02:07 -0400226#define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
227 struct btrfs_ioctl_vol_args)
Sage Weil6bf13c02008-06-10 10:07:39 -0400228/* trans start and trans end are dangerous, and only for
229 * use by applications that know how to avoid the
230 * resulting deadlocks
231 */
232#define BTRFS_IOC_TRANS_START _IO(BTRFS_IOCTL_MAGIC, 6)
233#define BTRFS_IOC_TRANS_END _IO(BTRFS_IOCTL_MAGIC, 7)
234#define BTRFS_IOC_SYNC _IO(BTRFS_IOCTL_MAGIC, 8)
235
Sage Weilf2eb0a22008-05-02 14:43:14 -0400236#define BTRFS_IOC_CLONE _IOW(BTRFS_IOCTL_MAGIC, 9, int)
Chris Mason788f20e2008-04-28 15:29:42 -0400237#define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
238 struct btrfs_ioctl_vol_args)
239#define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
240 struct btrfs_ioctl_vol_args)
241#define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
242 struct btrfs_ioctl_vol_args)
Sage Weilc5c9cd42008-11-12 14:32:25 -0500243
244#define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
245 struct btrfs_ioctl_clone_range_args)
246
Chris Mason3de45862008-11-17 21:02:50 -0500247#define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
248 struct btrfs_ioctl_vol_args)
Yan, Zheng76dda932009-09-21 16:00:26 -0400249#define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
250 struct btrfs_ioctl_vol_args)
Chris Mason1e701a32010-03-11 09:42:04 -0500251#define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
252 struct btrfs_ioctl_defrag_range_args)
Chris Masonac8e9812010-02-28 15:39:26 -0500253#define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
254 struct btrfs_ioctl_search_args)
255#define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
256 struct btrfs_ioctl_ino_lookup_args)
Josef Bacik6ef5ed02009-12-11 21:11:29 +0000257#define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, u64)
Josef Bacik1406e432010-01-13 18:19:06 +0000258#define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
259 struct btrfs_ioctl_space_args)
Sage Weil46204592010-10-29 15:41:32 -0400260#define BTRFS_IOC_START_SYNC _IOR(BTRFS_IOCTL_MAGIC, 24, __u64)
261#define BTRFS_IOC_WAIT_SYNC _IOW(BTRFS_IOCTL_MAGIC, 22, __u64)
Li Zefanfdfb1e42010-12-10 06:41:56 +0000262#define BTRFS_IOC_SNAP_CREATE_V2 _IOW(BTRFS_IOCTL_MAGIC, 23, \
263 struct btrfs_ioctl_vol_args_v2)
Li Zefan0caa1022010-12-20 16:30:25 +0800264#define BTRFS_IOC_SUBVOL_GETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 25, __u64)
265#define BTRFS_IOC_SUBVOL_SETFLAGS _IOW(BTRFS_IOCTL_MAGIC, 26, __u64)
Jan Schmidt475f6382011-03-11 15:41:01 +0100266#define BTRFS_IOC_SCRUB _IOWR(BTRFS_IOCTL_MAGIC, 27, \
267 struct btrfs_ioctl_scrub_args)
268#define BTRFS_IOC_SCRUB_CANCEL _IO(BTRFS_IOCTL_MAGIC, 28)
269#define BTRFS_IOC_SCRUB_PROGRESS _IOWR(BTRFS_IOCTL_MAGIC, 29, \
270 struct btrfs_ioctl_scrub_args)
271#define BTRFS_IOC_DEV_INFO _IOWR(BTRFS_IOCTL_MAGIC, 30, \
272 struct btrfs_ioctl_dev_info_args)
273#define BTRFS_IOC_FS_INFO _IOR(BTRFS_IOCTL_MAGIC, 31, \
274 struct btrfs_ioctl_fs_info_args)
Jan Schmidtd7728c92011-07-07 16:48:38 +0200275#define BTRFS_IOC_INO_PATHS _IOWR(BTRFS_IOCTL_MAGIC, 35, \
276 struct btrfs_ioctl_ino_path_args)
277#define BTRFS_IOC_LOGICAL_INO _IOWR(BTRFS_IOCTL_MAGIC, 36, \
278 struct btrfs_ioctl_ino_path_args)
279
Chris Masonc5739bb2007-04-10 09:27:04 -0400280#endif