xref: /linux/fs/btrfs/ioctl.h (revision a1087ef6abedf0bfd60e5e3fddf33192cb2c1325)
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_SNAPSHOT_NAME_MAX 4079
34 struct btrfs_ioctl_async_vol_args {
35 	__s64 fd;
36 	__u64 transid;
37 	char name[BTRFS_SNAPSHOT_NAME_MAX + 1];
38 };
39 
40 #define BTRFS_INO_LOOKUP_PATH_MAX 4080
41 struct btrfs_ioctl_ino_lookup_args {
42 	__u64 treeid;
43 	__u64 objectid;
44 	char name[BTRFS_INO_LOOKUP_PATH_MAX];
45 };
46 
47 struct btrfs_ioctl_search_key {
48 	/* which root are we searching.  0 is the tree of tree roots */
49 	__u64 tree_id;
50 
51 	/* keys returned will be >= min and <= max */
52 	__u64 min_objectid;
53 	__u64 max_objectid;
54 
55 	/* keys returned will be >= min and <= max */
56 	__u64 min_offset;
57 	__u64 max_offset;
58 
59 	/* max and min transids to search for */
60 	__u64 min_transid;
61 	__u64 max_transid;
62 
63 	/* keys returned will be >= min and <= max */
64 	__u32 min_type;
65 	__u32 max_type;
66 
67 	/*
68 	 * how many items did userland ask for, and how many are we
69 	 * returning
70 	 */
71 	__u32 nr_items;
72 
73 	/* align to 64 bits */
74 	__u32 unused;
75 
76 	/* some extra for later */
77 	__u64 unused1;
78 	__u64 unused2;
79 	__u64 unused3;
80 	__u64 unused4;
81 };
82 
83 struct btrfs_ioctl_search_header {
84 	__u64 transid;
85 	__u64 objectid;
86 	__u64 offset;
87 	__u32 type;
88 	__u32 len;
89 };
90 
91 #define BTRFS_SEARCH_ARGS_BUFSIZE (4096 - sizeof(struct btrfs_ioctl_search_key))
92 /*
93  * the buf is an array of search headers where
94  * each header is followed by the actual item
95  * the type field is expanded to 32 bits for alignment
96  */
97 struct btrfs_ioctl_search_args {
98 	struct btrfs_ioctl_search_key key;
99 	char buf[BTRFS_SEARCH_ARGS_BUFSIZE];
100 };
101 
102 struct btrfs_ioctl_clone_range_args {
103   __s64 src_fd;
104   __u64 src_offset, src_length;
105   __u64 dest_offset;
106 };
107 
108 /* flags for the defrag range ioctl */
109 #define BTRFS_DEFRAG_RANGE_COMPRESS 1
110 #define BTRFS_DEFRAG_RANGE_START_IO 2
111 
112 struct btrfs_ioctl_defrag_range_args {
113 	/* start of the defrag operation */
114 	__u64 start;
115 
116 	/* number of bytes to defrag, use (u64)-1 to say all */
117 	__u64 len;
118 
119 	/*
120 	 * flags for the operation, which can include turning
121 	 * on compression for this one defrag
122 	 */
123 	__u64 flags;
124 
125 	/*
126 	 * any extent bigger than this will be considered
127 	 * already defragged.  Use 0 to take the kernel default
128 	 * Use 1 to say every single extent must be rewritten
129 	 */
130 	__u32 extent_thresh;
131 
132 	/* spare for later */
133 	__u32 unused[5];
134 };
135 
136 struct btrfs_ioctl_space_info {
137 	__u64 flags;
138 	__u64 total_bytes;
139 	__u64 used_bytes;
140 };
141 
142 struct btrfs_ioctl_space_args {
143 	__u64 space_slots;
144 	__u64 total_spaces;
145 	struct btrfs_ioctl_space_info spaces[0];
146 };
147 
148 #define BTRFS_IOC_SNAP_CREATE _IOW(BTRFS_IOCTL_MAGIC, 1, \
149 				   struct btrfs_ioctl_vol_args)
150 #define BTRFS_IOC_DEFRAG _IOW(BTRFS_IOCTL_MAGIC, 2, \
151 				   struct btrfs_ioctl_vol_args)
152 #define BTRFS_IOC_RESIZE _IOW(BTRFS_IOCTL_MAGIC, 3, \
153 				   struct btrfs_ioctl_vol_args)
154 #define BTRFS_IOC_SCAN_DEV _IOW(BTRFS_IOCTL_MAGIC, 4, \
155 				   struct btrfs_ioctl_vol_args)
156 /* trans start and trans end are dangerous, and only for
157  * use by applications that know how to avoid the
158  * resulting deadlocks
159  */
160 #define BTRFS_IOC_TRANS_START  _IO(BTRFS_IOCTL_MAGIC, 6)
161 #define BTRFS_IOC_TRANS_END    _IO(BTRFS_IOCTL_MAGIC, 7)
162 #define BTRFS_IOC_SYNC         _IO(BTRFS_IOCTL_MAGIC, 8)
163 
164 #define BTRFS_IOC_CLONE        _IOW(BTRFS_IOCTL_MAGIC, 9, int)
165 #define BTRFS_IOC_ADD_DEV _IOW(BTRFS_IOCTL_MAGIC, 10, \
166 				   struct btrfs_ioctl_vol_args)
167 #define BTRFS_IOC_RM_DEV _IOW(BTRFS_IOCTL_MAGIC, 11, \
168 				   struct btrfs_ioctl_vol_args)
169 #define BTRFS_IOC_BALANCE _IOW(BTRFS_IOCTL_MAGIC, 12, \
170 				   struct btrfs_ioctl_vol_args)
171 
172 #define BTRFS_IOC_CLONE_RANGE _IOW(BTRFS_IOCTL_MAGIC, 13, \
173 				  struct btrfs_ioctl_clone_range_args)
174 
175 #define BTRFS_IOC_SUBVOL_CREATE _IOW(BTRFS_IOCTL_MAGIC, 14, \
176 				   struct btrfs_ioctl_vol_args)
177 #define BTRFS_IOC_SNAP_DESTROY _IOW(BTRFS_IOCTL_MAGIC, 15, \
178 				struct btrfs_ioctl_vol_args)
179 #define BTRFS_IOC_DEFRAG_RANGE _IOW(BTRFS_IOCTL_MAGIC, 16, \
180 				struct btrfs_ioctl_defrag_range_args)
181 #define BTRFS_IOC_TREE_SEARCH _IOWR(BTRFS_IOCTL_MAGIC, 17, \
182 				   struct btrfs_ioctl_search_args)
183 #define BTRFS_IOC_INO_LOOKUP _IOWR(BTRFS_IOCTL_MAGIC, 18, \
184 				   struct btrfs_ioctl_ino_lookup_args)
185 #define BTRFS_IOC_DEFAULT_SUBVOL _IOW(BTRFS_IOCTL_MAGIC, 19, u64)
186 #define BTRFS_IOC_SPACE_INFO _IOWR(BTRFS_IOCTL_MAGIC, 20, \
187 				    struct btrfs_ioctl_space_args)
188 #define BTRFS_IOC_START_SYNC _IOR(BTRFS_IOCTL_MAGIC, 24, __u64)
189 #define BTRFS_IOC_WAIT_SYNC  _IOW(BTRFS_IOCTL_MAGIC, 22, __u64)
190 #define BTRFS_IOC_SNAP_CREATE_ASYNC _IOW(BTRFS_IOCTL_MAGIC, 23, \
191 				   struct btrfs_ioctl_async_vol_args)
192 #endif
193