xref: /openbmc/linux/fs/btrfs/volumes.h (revision 5bd8e16d)
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 <linux/btrfs.h>
25 #include "async-thread.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 	int is_tgtdev_for_dev_replace;
54 
55 	spinlock_t io_lock;
56 
57 	struct block_device *bdev;
58 
59 	/* the mode sent to blkdev_get */
60 	fmode_t mode;
61 
62 	struct rcu_string *name;
63 
64 	/* the internal btrfs device id */
65 	u64 devid;
66 
67 	/* size of the device */
68 	u64 total_bytes;
69 
70 	/* size of the disk */
71 	u64 disk_total_bytes;
72 
73 	/* bytes used */
74 	u64 bytes_used;
75 
76 	/* optimal io alignment for this device */
77 	u32 io_align;
78 
79 	/* optimal io width for this device */
80 	u32 io_width;
81 
82 	/* minimal io size for this device */
83 	u32 sector_size;
84 
85 	/* type and info about this device */
86 	u64 type;
87 
88 	/* physical drive uuid (or lvm uuid) */
89 	u8 uuid[BTRFS_UUID_SIZE];
90 
91 	/* per-device scrub information */
92 	struct scrub_ctx *scrub_device;
93 
94 	struct btrfs_work work;
95 	struct rcu_head rcu;
96 	struct work_struct rcu_work;
97 
98 	/* readahead state */
99 	spinlock_t reada_lock;
100 	atomic_t reada_in_flight;
101 	u64 reada_next;
102 	struct reada_zone *reada_curr_zone;
103 	struct radix_tree_root reada_zones;
104 	struct radix_tree_root reada_extents;
105 
106 	/* for sending down flush barriers */
107 	struct bio *flush_bio;
108 	struct completion flush_wait;
109 	int nobarriers;
110 
111 	/* disk I/O failure stats. For detailed description refer to
112 	 * enum btrfs_dev_stat_values in ioctl.h */
113 	int dev_stats_valid;
114 	int dev_stats_dirty; /* counters need to be written to disk */
115 	atomic_t dev_stat_values[BTRFS_DEV_STAT_VALUES_MAX];
116 };
117 
118 struct btrfs_fs_devices {
119 	u8 fsid[BTRFS_FSID_SIZE]; /* FS specific uuid */
120 
121 	/* the device with this id has the most recent copy of the super */
122 	u64 latest_devid;
123 	u64 latest_trans;
124 	u64 num_devices;
125 	u64 open_devices;
126 	u64 rw_devices;
127 	u64 missing_devices;
128 	u64 total_rw_bytes;
129 	u64 num_can_discard;
130 	u64 total_devices;
131 	struct block_device *latest_bdev;
132 
133 	/* all of the devices in the FS, protected by a mutex
134 	 * so we can safely walk it to write out the supers without
135 	 * worrying about add/remove by the multi-device code
136 	 */
137 	struct mutex device_list_mutex;
138 	struct list_head devices;
139 
140 	/* devices not currently being allocated */
141 	struct list_head alloc_list;
142 	struct list_head list;
143 
144 	struct btrfs_fs_devices *seed;
145 	int seeding;
146 
147 	int opened;
148 
149 	/* set when we find or add a device that doesn't have the
150 	 * nonrot flag set
151 	 */
152 	int rotating;
153 };
154 
155 #define BTRFS_BIO_INLINE_CSUM_SIZE	64
156 
157 /*
158  * we need the mirror number and stripe index to be passed around
159  * the call chain while we are processing end_io (especially errors).
160  * Really, what we need is a btrfs_bio structure that has this info
161  * and is properly sized with its stripe array, but we're not there
162  * quite yet.  We have our own btrfs bioset, and all of the bios
163  * we allocate are actually btrfs_io_bios.  We'll cram as much of
164  * struct btrfs_bio as we can into this over time.
165  */
166 typedef void (btrfs_io_bio_end_io_t) (struct btrfs_io_bio *bio, int err);
167 struct btrfs_io_bio {
168 	unsigned long mirror_num;
169 	unsigned long stripe_index;
170 	u8 *csum;
171 	u8 csum_inline[BTRFS_BIO_INLINE_CSUM_SIZE];
172 	u8 *csum_allocated;
173 	btrfs_io_bio_end_io_t *end_io;
174 	struct bio bio;
175 };
176 
177 static inline struct btrfs_io_bio *btrfs_io_bio(struct bio *bio)
178 {
179 	return container_of(bio, struct btrfs_io_bio, bio);
180 }
181 
182 struct btrfs_bio_stripe {
183 	struct btrfs_device *dev;
184 	u64 physical;
185 	u64 length; /* only used for discard mappings */
186 };
187 
188 struct btrfs_bio;
189 typedef void (btrfs_bio_end_io_t) (struct btrfs_bio *bio, int err);
190 
191 struct btrfs_bio {
192 	atomic_t stripes_pending;
193 	bio_end_io_t *end_io;
194 	struct bio *orig_bio;
195 	void *private;
196 	atomic_t error;
197 	int max_errors;
198 	int num_stripes;
199 	int mirror_num;
200 	struct btrfs_bio_stripe stripes[];
201 };
202 
203 struct btrfs_device_info {
204 	struct btrfs_device *dev;
205 	u64 dev_offset;
206 	u64 max_avail;
207 	u64 total_avail;
208 };
209 
210 struct btrfs_raid_attr {
211 	int sub_stripes;	/* sub_stripes info for map */
212 	int dev_stripes;	/* stripes per dev */
213 	int devs_max;		/* max devs to use */
214 	int devs_min;		/* min devs needed */
215 	int devs_increment;	/* ndevs has to be a multiple of this */
216 	int ncopies;		/* how many copies to data has */
217 };
218 
219 struct map_lookup {
220 	u64 type;
221 	int io_align;
222 	int io_width;
223 	int stripe_len;
224 	int sector_size;
225 	int num_stripes;
226 	int sub_stripes;
227 	struct btrfs_bio_stripe stripes[];
228 };
229 
230 #define map_lookup_size(n) (sizeof(struct map_lookup) + \
231 			    (sizeof(struct btrfs_bio_stripe) * (n)))
232 
233 /*
234  * Restriper's general type filter
235  */
236 #define BTRFS_BALANCE_DATA		(1ULL << 0)
237 #define BTRFS_BALANCE_SYSTEM		(1ULL << 1)
238 #define BTRFS_BALANCE_METADATA		(1ULL << 2)
239 
240 #define BTRFS_BALANCE_TYPE_MASK		(BTRFS_BALANCE_DATA |	    \
241 					 BTRFS_BALANCE_SYSTEM |	    \
242 					 BTRFS_BALANCE_METADATA)
243 
244 #define BTRFS_BALANCE_FORCE		(1ULL << 3)
245 #define BTRFS_BALANCE_RESUME		(1ULL << 4)
246 
247 /*
248  * Balance filters
249  */
250 #define BTRFS_BALANCE_ARGS_PROFILES	(1ULL << 0)
251 #define BTRFS_BALANCE_ARGS_USAGE	(1ULL << 1)
252 #define BTRFS_BALANCE_ARGS_DEVID	(1ULL << 2)
253 #define BTRFS_BALANCE_ARGS_DRANGE	(1ULL << 3)
254 #define BTRFS_BALANCE_ARGS_VRANGE	(1ULL << 4)
255 
256 /*
257  * Profile changing flags.  When SOFT is set we won't relocate chunk if
258  * it already has the target profile (even though it may be
259  * half-filled).
260  */
261 #define BTRFS_BALANCE_ARGS_CONVERT	(1ULL << 8)
262 #define BTRFS_BALANCE_ARGS_SOFT		(1ULL << 9)
263 
264 struct btrfs_balance_args;
265 struct btrfs_balance_progress;
266 struct btrfs_balance_control {
267 	struct btrfs_fs_info *fs_info;
268 
269 	struct btrfs_balance_args data;
270 	struct btrfs_balance_args meta;
271 	struct btrfs_balance_args sys;
272 
273 	u64 flags;
274 
275 	struct btrfs_balance_progress stat;
276 };
277 
278 int btrfs_account_dev_extents_size(struct btrfs_device *device, u64 start,
279 				   u64 end, u64 *length);
280 
281 #define btrfs_bio_size(n) (sizeof(struct btrfs_bio) + \
282 			    (sizeof(struct btrfs_bio_stripe) * (n)))
283 
284 int btrfs_map_block(struct btrfs_fs_info *fs_info, int rw,
285 		    u64 logical, u64 *length,
286 		    struct btrfs_bio **bbio_ret, int mirror_num);
287 int btrfs_rmap_block(struct btrfs_mapping_tree *map_tree,
288 		     u64 chunk_start, u64 physical, u64 devid,
289 		     u64 **logical, int *naddrs, int *stripe_len);
290 int btrfs_read_sys_array(struct btrfs_root *root);
291 int btrfs_read_chunk_tree(struct btrfs_root *root);
292 int btrfs_alloc_chunk(struct btrfs_trans_handle *trans,
293 		      struct btrfs_root *extent_root, u64 type);
294 void btrfs_mapping_init(struct btrfs_mapping_tree *tree);
295 void btrfs_mapping_tree_free(struct btrfs_mapping_tree *tree);
296 int btrfs_map_bio(struct btrfs_root *root, int rw, struct bio *bio,
297 		  int mirror_num, int async_submit);
298 int btrfs_open_devices(struct btrfs_fs_devices *fs_devices,
299 		       fmode_t flags, void *holder);
300 int btrfs_scan_one_device(const char *path, fmode_t flags, void *holder,
301 			  struct btrfs_fs_devices **fs_devices_ret);
302 int btrfs_close_devices(struct btrfs_fs_devices *fs_devices);
303 void btrfs_close_extra_devices(struct btrfs_fs_info *fs_info,
304 			       struct btrfs_fs_devices *fs_devices, int step);
305 int btrfs_find_device_missing_or_by_path(struct btrfs_root *root,
306 					 char *device_path,
307 					 struct btrfs_device **device);
308 struct btrfs_device *btrfs_alloc_device(struct btrfs_fs_info *fs_info,
309 					const u64 *devid,
310 					const u8 *uuid);
311 int btrfs_rm_device(struct btrfs_root *root, char *device_path);
312 void btrfs_cleanup_fs_uuids(void);
313 int btrfs_num_copies(struct btrfs_fs_info *fs_info, u64 logical, u64 len);
314 int btrfs_grow_device(struct btrfs_trans_handle *trans,
315 		      struct btrfs_device *device, u64 new_size);
316 struct btrfs_device *btrfs_find_device(struct btrfs_fs_info *fs_info, u64 devid,
317 				       u8 *uuid, u8 *fsid);
318 int btrfs_shrink_device(struct btrfs_device *device, u64 new_size);
319 int btrfs_init_new_device(struct btrfs_root *root, char *path);
320 int btrfs_init_dev_replace_tgtdev(struct btrfs_root *root, char *device_path,
321 				  struct btrfs_device **device_out);
322 int btrfs_balance(struct btrfs_balance_control *bctl,
323 		  struct btrfs_ioctl_balance_args *bargs);
324 int btrfs_resume_balance_async(struct btrfs_fs_info *fs_info);
325 int btrfs_recover_balance(struct btrfs_fs_info *fs_info);
326 int btrfs_pause_balance(struct btrfs_fs_info *fs_info);
327 int btrfs_cancel_balance(struct btrfs_fs_info *fs_info);
328 int btrfs_create_uuid_tree(struct btrfs_fs_info *fs_info);
329 int btrfs_check_uuid_tree(struct btrfs_fs_info *fs_info);
330 int btrfs_chunk_readonly(struct btrfs_root *root, u64 chunk_offset);
331 int find_free_dev_extent(struct btrfs_trans_handle *trans,
332 			 struct btrfs_device *device, u64 num_bytes,
333 			 u64 *start, u64 *max_avail);
334 void btrfs_dev_stat_inc_and_print(struct btrfs_device *dev, int index);
335 int btrfs_get_dev_stats(struct btrfs_root *root,
336 			struct btrfs_ioctl_get_dev_stats *stats);
337 void btrfs_init_devices_late(struct btrfs_fs_info *fs_info);
338 int btrfs_init_dev_stats(struct btrfs_fs_info *fs_info);
339 int btrfs_run_dev_stats(struct btrfs_trans_handle *trans,
340 			struct btrfs_fs_info *fs_info);
341 void btrfs_rm_dev_replace_srcdev(struct btrfs_fs_info *fs_info,
342 				 struct btrfs_device *srcdev);
343 void btrfs_destroy_dev_replace_tgtdev(struct btrfs_fs_info *fs_info,
344 				      struct btrfs_device *tgtdev);
345 void btrfs_init_dev_replace_tgtdev_for_resume(struct btrfs_fs_info *fs_info,
346 					      struct btrfs_device *tgtdev);
347 int btrfs_scratch_superblock(struct btrfs_device *device);
348 int btrfs_is_parity_mirror(struct btrfs_mapping_tree *map_tree,
349 			   u64 logical, u64 len, int mirror_num);
350 unsigned long btrfs_full_stripe_len(struct btrfs_root *root,
351 				    struct btrfs_mapping_tree *map_tree,
352 				    u64 logical);
353 int btrfs_finish_chunk_alloc(struct btrfs_trans_handle *trans,
354 				struct btrfs_root *extent_root,
355 				u64 chunk_offset, u64 chunk_size);
356 static inline void btrfs_dev_stat_inc(struct btrfs_device *dev,
357 				      int index)
358 {
359 	atomic_inc(dev->dev_stat_values + index);
360 	dev->dev_stats_dirty = 1;
361 }
362 
363 static inline int btrfs_dev_stat_read(struct btrfs_device *dev,
364 				      int index)
365 {
366 	return atomic_read(dev->dev_stat_values + index);
367 }
368 
369 static inline int btrfs_dev_stat_read_and_reset(struct btrfs_device *dev,
370 						int index)
371 {
372 	int ret;
373 
374 	ret = atomic_xchg(dev->dev_stat_values + index, 0);
375 	dev->dev_stats_dirty = 1;
376 	return ret;
377 }
378 
379 static inline void btrfs_dev_stat_set(struct btrfs_device *dev,
380 				      int index, unsigned long val)
381 {
382 	atomic_set(dev->dev_stat_values + index, val);
383 	dev->dev_stats_dirty = 1;
384 }
385 
386 static inline void btrfs_dev_stat_reset(struct btrfs_device *dev,
387 					int index)
388 {
389 	btrfs_dev_stat_set(dev, index, 0);
390 }
391 #endif
392