xref: /linux/fs/btrfs/volumes.h (revision 2fcfe22ae791e1e4e0cc9d0fbad617405552ffc0)
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 __BTRFS_VOLUMES_
20 #define __BTRFS_VOLUMES_
21 
22 #include <linux/bio.h>
23 #include <linux/sort.h>
24 #include "async-thread.h"
25 #include "ioctl.h"
26 
27 #define BTRFS_STRIPE_LEN	(64 * 1024)
28 
29 struct buffer_head;
30 struct btrfs_pending_bios {
31 	struct bio *head;
32 	struct bio *tail;
33 };
34 
35 struct btrfs_device {
36 	struct list_head dev_list;
37 	struct list_head dev_alloc_list;
38 	struct btrfs_fs_devices *fs_devices;
39 	struct btrfs_root *dev_root;
40 
41 	/* regular prio bios */
42 	struct btrfs_pending_bios pending_bios;
43 	/* WRITE_SYNC bios */
44 	struct btrfs_pending_bios pending_sync_bios;
45 
46 	int running_pending;
47 	u64 generation;
48 
49 	int writeable;
50 	int in_fs_metadata;
51 	int missing;
52 	int can_discard;
53 
54 	spinlock_t io_lock;
55 
56 	struct block_device *bdev;
57 
58 	/* the mode sent to blkdev_get */
59 	fmode_t mode;
60 
61 	struct rcu_string *name;
62 
63 	/* the internal btrfs device id */
64 	u64 devid;
65 
66 	/* size of the device */
67 	u64 total_bytes;
68 
69 	/* size of the disk */
70 	u64 disk_total_bytes;
71 
72 	/* bytes used */
73 	u64 bytes_used;
74 
75 	/* optimal io alignment for this device */
76 	u32 io_align;
77 
78 	/* optimal io width for this device */
79 	u32 io_width;
80 
81 	/* minimal io size for this device */
82 	u32 sector_size;
83 
84 	/* type and info about this device */
85 	u64 type;
86 
87 	/* physical drive uuid (or lvm uuid) */
88 	u8 uuid[BTRFS_UUID_SIZE];
89 
90 	/* per-device scrub information */
91 	struct scrub_dev *scrub_device;
92 
93 	struct btrfs_work work;
94 	struct rcu_head rcu;
95 	struct work_struct rcu_work;
96 
97 	/* readahead state */
98 	spinlock_t reada_lock;
99 	atomic_t reada_in_flight;
100 	u64 reada_next;
101 	struct reada_zone *reada_curr_zone;
102 	struct radix_tree_root reada_zones;
103 	struct radix_tree_root reada_extents;
104 
105 	/* for sending down flush barriers */
106 	struct bio *flush_bio;
107 	struct completion flush_wait;
108 	int nobarriers;
109 
110 	/* disk I/O failure stats. For detailed description refer to
111 	 * enum btrfs_dev_stat_values in ioctl.h */
112 	int dev_stats_valid;
113 	int dev_stats_dirty; /* counters need to be written to disk */
114 	atomic_t dev_stat_values[BTRFS_DEV_STAT_VALUES_MAX];
115 };
116 
117 struct btrfs_fs_devices {
118 	u8 fsid[BTRFS_FSID_SIZE]; /* FS specific uuid */
119 
120 	/* the device with this id has the most recent copy of the super */
121 	u64 latest_devid;
122 	u64 latest_trans;
123 	u64 num_devices;
124 	u64 open_devices;
125 	u64 rw_devices;
126 	u64 missing_devices;
127 	u64 total_rw_bytes;
128 	u64 num_can_discard;
129 	struct block_device *latest_bdev;
130 
131 	/* all of the devices in the FS, protected by a mutex
132 	 * so we can safely walk it to write out the supers without
133 	 * worrying about add/remove by the multi-device code
134 	 */
135 	struct mutex device_list_mutex;
136 	struct list_head devices;
137 
138 	/* devices not currently being allocated */
139 	struct list_head alloc_list;
140 	struct list_head list;
141 
142 	struct btrfs_fs_devices *seed;
143 	int seeding;
144 
145 	int opened;
146 
147 	/* set when we find or add a device that doesn't have the
148 	 * nonrot flag set
149 	 */
150 	int rotating;
151 };
152 
153 struct btrfs_bio_stripe {
154 	struct btrfs_device *dev;
155 	u64 physical;
156 	u64 length; /* only used for discard mappings */
157 };
158 
159 struct btrfs_bio;
160 typedef void (btrfs_bio_end_io_t) (struct btrfs_bio *bio, int err);
161 
162 struct btrfs_bio {
163 	atomic_t stripes_pending;
164 	bio_end_io_t *end_io;
165 	struct bio *orig_bio;
166 	void *private;
167 	atomic_t error;
168 	int max_errors;
169 	int num_stripes;
170 	int mirror_num;
171 	struct btrfs_bio_stripe stripes[];
172 };
173 
174 struct btrfs_device_info {
175 	struct btrfs_device *dev;
176 	u64 dev_offset;
177 	u64 max_avail;
178 	u64 total_avail;
179 };
180 
181 struct map_lookup {
182 	u64 type;
183 	int io_align;
184 	int io_width;
185 	int stripe_len;
186 	int sector_size;
187 	int num_stripes;
188 	int sub_stripes;
189 	struct btrfs_bio_stripe stripes[];
190 };
191 
192 #define map_lookup_size(n) (sizeof(struct map_lookup) + \
193 			    (sizeof(struct btrfs_bio_stripe) * (n)))
194 
195 /*
196  * Restriper's general type filter
197  */
198 #define BTRFS_BALANCE_DATA		(1ULL << 0)
199 #define BTRFS_BALANCE_SYSTEM		(1ULL << 1)
200 #define BTRFS_BALANCE_METADATA		(1ULL << 2)
201 
202 #define BTRFS_BALANCE_TYPE_MASK		(BTRFS_BALANCE_DATA |	    \
203 					 BTRFS_BALANCE_SYSTEM |	    \
204 					 BTRFS_BALANCE_METADATA)
205 
206 #define BTRFS_BALANCE_FORCE		(1ULL << 3)
207 #define BTRFS_BALANCE_RESUME		(1ULL << 4)
208 
209 /*
210  * Balance filters
211  */
212 #define BTRFS_BALANCE_ARGS_PROFILES	(1ULL << 0)
213 #define BTRFS_BALANCE_ARGS_USAGE	(1ULL << 1)
214 #define BTRFS_BALANCE_ARGS_DEVID	(1ULL << 2)
215 #define BTRFS_BALANCE_ARGS_DRANGE	(1ULL << 3)
216 #define BTRFS_BALANCE_ARGS_VRANGE	(1ULL << 4)
217 
218 /*
219  * Profile changing flags.  When SOFT is set we won't relocate chunk if
220  * it already has the target profile (even though it may be
221  * half-filled).
222  */
223 #define BTRFS_BALANCE_ARGS_CONVERT	(1ULL << 8)
224 #define BTRFS_BALANCE_ARGS_SOFT		(1ULL << 9)
225 
226 struct btrfs_balance_args;
227 struct btrfs_balance_progress;
228 struct btrfs_balance_control {
229 	struct btrfs_fs_info *fs_info;
230 
231 	struct btrfs_balance_args data;
232 	struct btrfs_balance_args meta;
233 	struct btrfs_balance_args sys;
234 
235 	u64 flags;
236 
237 	struct btrfs_balance_progress stat;
238 };
239 
240 int btrfs_account_dev_extents_size(struct btrfs_device *device, u64 start,
241 				   u64 end, u64 *length);
242 
243 #define btrfs_bio_size(n) (sizeof(struct btrfs_bio) + \
244 			    (sizeof(struct btrfs_bio_stripe) * (n)))
245 
246 int btrfs_alloc_dev_extent(struct btrfs_trans_handle *trans,
247 			   struct btrfs_device *device,
248 			   u64 chunk_tree, u64 chunk_objectid,
249 			   u64 chunk_offset, u64 start, u64 num_bytes);
250 int btrfs_map_block(struct btrfs_mapping_tree *map_tree, int rw,
251 		    u64 logical, u64 *length,
252 		    struct btrfs_bio **bbio_ret, int mirror_num);
253 int btrfs_rmap_block(struct btrfs_mapping_tree *map_tree,
254 		     u64 chunk_start, u64 physical, u64 devid,
255 		     u64 **logical, int *naddrs, int *stripe_len);
256 int btrfs_read_sys_array(struct btrfs_root *root);
257 int btrfs_read_chunk_tree(struct btrfs_root *root);
258 int btrfs_alloc_chunk(struct btrfs_trans_handle *trans,
259 		      struct btrfs_root *extent_root, u64 type);
260 void btrfs_mapping_init(struct btrfs_mapping_tree *tree);
261 void btrfs_mapping_tree_free(struct btrfs_mapping_tree *tree);
262 int btrfs_map_bio(struct btrfs_root *root, int rw, struct bio *bio,
263 		  int mirror_num, int async_submit);
264 int btrfs_open_devices(struct btrfs_fs_devices *fs_devices,
265 		       fmode_t flags, void *holder);
266 int btrfs_scan_one_device(const char *path, fmode_t flags, void *holder,
267 			  struct btrfs_fs_devices **fs_devices_ret);
268 int btrfs_close_devices(struct btrfs_fs_devices *fs_devices);
269 void btrfs_close_extra_devices(struct btrfs_fs_devices *fs_devices);
270 int btrfs_add_device(struct btrfs_trans_handle *trans,
271 		     struct btrfs_root *root,
272 		     struct btrfs_device *device);
273 int btrfs_rm_device(struct btrfs_root *root, char *device_path);
274 void btrfs_cleanup_fs_uuids(void);
275 int btrfs_num_copies(struct btrfs_mapping_tree *map_tree, u64 logical, u64 len);
276 int btrfs_grow_device(struct btrfs_trans_handle *trans,
277 		      struct btrfs_device *device, u64 new_size);
278 struct btrfs_device *btrfs_find_device(struct btrfs_root *root, u64 devid,
279 				       u8 *uuid, u8 *fsid);
280 int btrfs_shrink_device(struct btrfs_device *device, u64 new_size);
281 int btrfs_init_new_device(struct btrfs_root *root, char *path);
282 int btrfs_balance(struct btrfs_balance_control *bctl,
283 		  struct btrfs_ioctl_balance_args *bargs);
284 int btrfs_recover_balance(struct btrfs_root *tree_root);
285 int btrfs_pause_balance(struct btrfs_fs_info *fs_info);
286 int btrfs_cancel_balance(struct btrfs_fs_info *fs_info);
287 int btrfs_chunk_readonly(struct btrfs_root *root, u64 chunk_offset);
288 int find_free_dev_extent(struct btrfs_device *device, u64 num_bytes,
289 			 u64 *start, u64 *max_avail);
290 struct btrfs_device *btrfs_find_device_for_logical(struct btrfs_root *root,
291 						   u64 logical, int mirror_num);
292 void btrfs_dev_stat_print_on_error(struct btrfs_device *device);
293 void btrfs_dev_stat_inc_and_print(struct btrfs_device *dev, int index);
294 int btrfs_get_dev_stats(struct btrfs_root *root,
295 			struct btrfs_ioctl_get_dev_stats *stats,
296 			int reset_after_read);
297 int btrfs_init_dev_stats(struct btrfs_fs_info *fs_info);
298 int btrfs_run_dev_stats(struct btrfs_trans_handle *trans,
299 			struct btrfs_fs_info *fs_info);
300 
301 static inline void btrfs_dev_stat_inc(struct btrfs_device *dev,
302 				      int index)
303 {
304 	atomic_inc(dev->dev_stat_values + index);
305 	dev->dev_stats_dirty = 1;
306 }
307 
308 static inline int btrfs_dev_stat_read(struct btrfs_device *dev,
309 				      int index)
310 {
311 	return atomic_read(dev->dev_stat_values + index);
312 }
313 
314 static inline int btrfs_dev_stat_read_and_reset(struct btrfs_device *dev,
315 						int index)
316 {
317 	int ret;
318 
319 	ret = atomic_xchg(dev->dev_stat_values + index, 0);
320 	dev->dev_stats_dirty = 1;
321 	return ret;
322 }
323 
324 static inline void btrfs_dev_stat_set(struct btrfs_device *dev,
325 				      int index, unsigned long val)
326 {
327 	atomic_set(dev->dev_stat_values + index, val);
328 	dev->dev_stats_dirty = 1;
329 }
330 
331 static inline void btrfs_dev_stat_reset(struct btrfs_device *dev,
332 					int index)
333 {
334 	btrfs_dev_stat_set(dev, index, 0);
335 }
336 #endif
337