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