Loading...
1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * Copyright (C) 2007 Oracle. All rights reserved.
4 */
5
6#ifndef BTRFS_VOLUMES_H
7#define BTRFS_VOLUMES_H
8
9#include <linux/bio.h>
10#include <linux/sort.h>
11#include <linux/btrfs.h>
12#include "async-thread.h"
13
14#define BTRFS_MAX_DATA_CHUNK_SIZE (10ULL * SZ_1G)
15
16extern struct mutex uuid_mutex;
17
18#define BTRFS_STRIPE_LEN SZ_64K
19
20struct buffer_head;
21struct btrfs_pending_bios {
22 struct bio *head;
23 struct bio *tail;
24};
25
26struct btrfs_io_geometry {
27 /* remaining bytes before crossing a stripe */
28 u64 len;
29 /* offset of logical address in chunk */
30 u64 offset;
31 /* length of single IO stripe */
32 u64 stripe_len;
33 /* number of stripe where address falls */
34 u64 stripe_nr;
35 /* offset of address in stripe */
36 u64 stripe_offset;
37 /* offset of raid56 stripe into the chunk */
38 u64 raid56_stripe_offset;
39};
40
41/*
42 * Use sequence counter to get consistent device stat data on
43 * 32-bit processors.
44 */
45#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
46#include <linux/seqlock.h>
47#define __BTRFS_NEED_DEVICE_DATA_ORDERED
48#define btrfs_device_data_ordered_init(device) \
49 seqcount_init(&device->data_seqcount)
50#else
51#define btrfs_device_data_ordered_init(device) do { } while (0)
52#endif
53
54#define BTRFS_DEV_STATE_WRITEABLE (0)
55#define BTRFS_DEV_STATE_IN_FS_METADATA (1)
56#define BTRFS_DEV_STATE_MISSING (2)
57#define BTRFS_DEV_STATE_REPLACE_TGT (3)
58#define BTRFS_DEV_STATE_FLUSH_SENT (4)
59
60struct btrfs_device {
61 struct list_head dev_list; /* device_list_mutex */
62 struct list_head dev_alloc_list; /* chunk mutex */
63 struct list_head post_commit_list; /* chunk mutex */
64 struct btrfs_fs_devices *fs_devices;
65 struct btrfs_fs_info *fs_info;
66
67 struct rcu_string *name;
68
69 u64 generation;
70
71 spinlock_t io_lock ____cacheline_aligned;
72 int running_pending;
73 /* regular prio bios */
74 struct btrfs_pending_bios pending_bios;
75 /* sync bios */
76 struct btrfs_pending_bios pending_sync_bios;
77
78 struct block_device *bdev;
79
80 /* the mode sent to blkdev_get */
81 fmode_t mode;
82
83 unsigned long dev_state;
84 blk_status_t last_flush_error;
85
86#ifdef __BTRFS_NEED_DEVICE_DATA_ORDERED
87 seqcount_t data_seqcount;
88#endif
89
90 /* the internal btrfs device id */
91 u64 devid;
92
93 /* size of the device in memory */
94 u64 total_bytes;
95
96 /* size of the device on disk */
97 u64 disk_total_bytes;
98
99 /* bytes used */
100 u64 bytes_used;
101
102 /* optimal io alignment for this device */
103 u32 io_align;
104
105 /* optimal io width for this device */
106 u32 io_width;
107 /* type and info about this device */
108 u64 type;
109
110 /* minimal io size for this device */
111 u32 sector_size;
112
113 /* physical drive uuid (or lvm uuid) */
114 u8 uuid[BTRFS_UUID_SIZE];
115
116 /*
117 * size of the device on the current transaction
118 *
119 * This variant is update when committing the transaction,
120 * and protected by chunk mutex
121 */
122 u64 commit_total_bytes;
123
124 /* bytes used on the current transaction */
125 u64 commit_bytes_used;
126
127 /* for sending down flush barriers */
128 struct bio *flush_bio;
129 struct completion flush_wait;
130
131 /* per-device scrub information */
132 struct scrub_ctx *scrub_ctx;
133
134 struct btrfs_work work;
135
136 /* readahead state */
137 atomic_t reada_in_flight;
138 u64 reada_next;
139 struct reada_zone *reada_curr_zone;
140 struct radix_tree_root reada_zones;
141 struct radix_tree_root reada_extents;
142
143 /* disk I/O failure stats. For detailed description refer to
144 * enum btrfs_dev_stat_values in ioctl.h */
145 int dev_stats_valid;
146
147 /* Counter to record the change of device stats */
148 atomic_t dev_stats_ccnt;
149 atomic_t dev_stat_values[BTRFS_DEV_STAT_VALUES_MAX];
150
151 struct extent_io_tree alloc_state;
152};
153
154/*
155 * If we read those variants at the context of their own lock, we needn't
156 * use the following helpers, reading them directly is safe.
157 */
158#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
159#define BTRFS_DEVICE_GETSET_FUNCS(name) \
160static inline u64 \
161btrfs_device_get_##name(const struct btrfs_device *dev) \
162{ \
163 u64 size; \
164 unsigned int seq; \
165 \
166 do { \
167 seq = read_seqcount_begin(&dev->data_seqcount); \
168 size = dev->name; \
169 } while (read_seqcount_retry(&dev->data_seqcount, seq)); \
170 return size; \
171} \
172 \
173static inline void \
174btrfs_device_set_##name(struct btrfs_device *dev, u64 size) \
175{ \
176 preempt_disable(); \
177 write_seqcount_begin(&dev->data_seqcount); \
178 dev->name = size; \
179 write_seqcount_end(&dev->data_seqcount); \
180 preempt_enable(); \
181}
182#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
183#define BTRFS_DEVICE_GETSET_FUNCS(name) \
184static inline u64 \
185btrfs_device_get_##name(const struct btrfs_device *dev) \
186{ \
187 u64 size; \
188 \
189 preempt_disable(); \
190 size = dev->name; \
191 preempt_enable(); \
192 return size; \
193} \
194 \
195static inline void \
196btrfs_device_set_##name(struct btrfs_device *dev, u64 size) \
197{ \
198 preempt_disable(); \
199 dev->name = size; \
200 preempt_enable(); \
201}
202#else
203#define BTRFS_DEVICE_GETSET_FUNCS(name) \
204static inline u64 \
205btrfs_device_get_##name(const struct btrfs_device *dev) \
206{ \
207 return dev->name; \
208} \
209 \
210static inline void \
211btrfs_device_set_##name(struct btrfs_device *dev, u64 size) \
212{ \
213 dev->name = size; \
214}
215#endif
216
217BTRFS_DEVICE_GETSET_FUNCS(total_bytes);
218BTRFS_DEVICE_GETSET_FUNCS(disk_total_bytes);
219BTRFS_DEVICE_GETSET_FUNCS(bytes_used);
220
221struct btrfs_fs_devices {
222 u8 fsid[BTRFS_FSID_SIZE]; /* FS specific uuid */
223 u8 metadata_uuid[BTRFS_FSID_SIZE];
224 bool fsid_change;
225 struct list_head fs_list;
226
227 u64 num_devices;
228 u64 open_devices;
229 u64 rw_devices;
230 u64 missing_devices;
231 u64 total_rw_bytes;
232 u64 total_devices;
233
234 /* Highest generation number of seen devices */
235 u64 latest_generation;
236
237 struct block_device *latest_bdev;
238
239 /* all of the devices in the FS, protected by a mutex
240 * so we can safely walk it to write out the supers without
241 * worrying about add/remove by the multi-device code.
242 * Scrubbing super can kick off supers writing by holding
243 * this mutex lock.
244 */
245 struct mutex device_list_mutex;
246
247 /* List of all devices, protected by device_list_mutex */
248 struct list_head devices;
249
250 /*
251 * Devices which can satisfy space allocation. Protected by
252 * chunk_mutex
253 */
254 struct list_head alloc_list;
255
256 struct btrfs_fs_devices *seed;
257 int seeding;
258
259 int opened;
260
261 /* set when we find or add a device that doesn't have the
262 * nonrot flag set
263 */
264 int rotating;
265
266 struct btrfs_fs_info *fs_info;
267 /* sysfs kobjects */
268 struct kobject fsid_kobj;
269 struct kobject *device_dir_kobj;
270 struct completion kobj_unregister;
271};
272
273#define BTRFS_BIO_INLINE_CSUM_SIZE 64
274
275#define BTRFS_MAX_DEVS(info) ((BTRFS_MAX_ITEM_SIZE(info) \
276 - sizeof(struct btrfs_chunk)) \
277 / sizeof(struct btrfs_stripe) + 1)
278
279#define BTRFS_MAX_DEVS_SYS_CHUNK ((BTRFS_SYSTEM_CHUNK_ARRAY_SIZE \
280 - 2 * sizeof(struct btrfs_disk_key) \
281 - 2 * sizeof(struct btrfs_chunk)) \
282 / sizeof(struct btrfs_stripe) + 1)
283
284/*
285 * we need the mirror number and stripe index to be passed around
286 * the call chain while we are processing end_io (especially errors).
287 * Really, what we need is a btrfs_bio structure that has this info
288 * and is properly sized with its stripe array, but we're not there
289 * quite yet. We have our own btrfs bioset, and all of the bios
290 * we allocate are actually btrfs_io_bios. We'll cram as much of
291 * struct btrfs_bio as we can into this over time.
292 */
293struct btrfs_io_bio {
294 unsigned int mirror_num;
295 unsigned int stripe_index;
296 u64 logical;
297 u8 *csum;
298 u8 csum_inline[BTRFS_BIO_INLINE_CSUM_SIZE];
299 struct bvec_iter iter;
300 /*
301 * This member must come last, bio_alloc_bioset will allocate enough
302 * bytes for entire btrfs_io_bio but relies on bio being last.
303 */
304 struct bio bio;
305};
306
307static inline struct btrfs_io_bio *btrfs_io_bio(struct bio *bio)
308{
309 return container_of(bio, struct btrfs_io_bio, bio);
310}
311
312static inline void btrfs_io_bio_free_csum(struct btrfs_io_bio *io_bio)
313{
314 if (io_bio->csum != io_bio->csum_inline) {
315 kfree(io_bio->csum);
316 io_bio->csum = NULL;
317 }
318}
319
320struct btrfs_bio_stripe {
321 struct btrfs_device *dev;
322 u64 physical;
323 u64 length; /* only used for discard mappings */
324};
325
326struct btrfs_bio {
327 refcount_t refs;
328 atomic_t stripes_pending;
329 struct btrfs_fs_info *fs_info;
330 u64 map_type; /* get from map_lookup->type */
331 bio_end_io_t *end_io;
332 struct bio *orig_bio;
333 unsigned long flags;
334 void *private;
335 atomic_t error;
336 int max_errors;
337 int num_stripes;
338 int mirror_num;
339 int num_tgtdevs;
340 int *tgtdev_map;
341 /*
342 * logical block numbers for the start of each stripe
343 * The last one or two are p/q. These are sorted,
344 * so raid_map[0] is the start of our full stripe
345 */
346 u64 *raid_map;
347 struct btrfs_bio_stripe stripes[];
348};
349
350struct btrfs_device_info {
351 struct btrfs_device *dev;
352 u64 dev_offset;
353 u64 max_avail;
354 u64 total_avail;
355};
356
357struct btrfs_raid_attr {
358 u8 sub_stripes; /* sub_stripes info for map */
359 u8 dev_stripes; /* stripes per dev */
360 u8 devs_max; /* max devs to use */
361 u8 devs_min; /* min devs needed */
362 u8 tolerated_failures; /* max tolerated fail devs */
363 u8 devs_increment; /* ndevs has to be a multiple of this */
364 u8 ncopies; /* how many copies to data has */
365 u8 nparity; /* number of stripes worth of bytes to store
366 * parity information */
367 u8 mindev_error; /* error code if min devs requisite is unmet */
368 const char raid_name[8]; /* name of the raid */
369 u64 bg_flag; /* block group flag of the raid */
370};
371
372extern const struct btrfs_raid_attr btrfs_raid_array[BTRFS_NR_RAID_TYPES];
373
374struct map_lookup {
375 u64 type;
376 int io_align;
377 int io_width;
378 u64 stripe_len;
379 int num_stripes;
380 int sub_stripes;
381 int verified_stripes; /* For mount time dev extent verification */
382 struct btrfs_bio_stripe stripes[];
383};
384
385#define map_lookup_size(n) (sizeof(struct map_lookup) + \
386 (sizeof(struct btrfs_bio_stripe) * (n)))
387
388struct btrfs_balance_args;
389struct btrfs_balance_progress;
390struct btrfs_balance_control {
391 struct btrfs_balance_args data;
392 struct btrfs_balance_args meta;
393 struct btrfs_balance_args sys;
394
395 u64 flags;
396
397 struct btrfs_balance_progress stat;
398};
399
400enum btrfs_map_op {
401 BTRFS_MAP_READ,
402 BTRFS_MAP_WRITE,
403 BTRFS_MAP_DISCARD,
404 BTRFS_MAP_GET_READ_MIRRORS,
405};
406
407static inline enum btrfs_map_op btrfs_op(struct bio *bio)
408{
409 switch (bio_op(bio)) {
410 case REQ_OP_DISCARD:
411 return BTRFS_MAP_DISCARD;
412 case REQ_OP_WRITE:
413 return BTRFS_MAP_WRITE;
414 default:
415 WARN_ON_ONCE(1);
416 /* fall through */
417 case REQ_OP_READ:
418 return BTRFS_MAP_READ;
419 }
420}
421
422void btrfs_get_bbio(struct btrfs_bio *bbio);
423void btrfs_put_bbio(struct btrfs_bio *bbio);
424int btrfs_map_block(struct btrfs_fs_info *fs_info, enum btrfs_map_op op,
425 u64 logical, u64 *length,
426 struct btrfs_bio **bbio_ret, int mirror_num);
427int btrfs_map_sblock(struct btrfs_fs_info *fs_info, enum btrfs_map_op op,
428 u64 logical, u64 *length,
429 struct btrfs_bio **bbio_ret);
430int btrfs_get_io_geometry(struct btrfs_fs_info *fs_info, enum btrfs_map_op op,
431 u64 logical, u64 len, struct btrfs_io_geometry *io_geom);
432int btrfs_rmap_block(struct btrfs_fs_info *fs_info, u64 chunk_start,
433 u64 physical, u64 **logical, int *naddrs, int *stripe_len);
434int btrfs_read_sys_array(struct btrfs_fs_info *fs_info);
435int btrfs_read_chunk_tree(struct btrfs_fs_info *fs_info);
436int btrfs_alloc_chunk(struct btrfs_trans_handle *trans, u64 type);
437void btrfs_mapping_tree_free(struct extent_map_tree *tree);
438blk_status_t btrfs_map_bio(struct btrfs_fs_info *fs_info, struct bio *bio,
439 int mirror_num, int async_submit);
440int btrfs_open_devices(struct btrfs_fs_devices *fs_devices,
441 fmode_t flags, void *holder);
442struct btrfs_device *btrfs_scan_one_device(const char *path,
443 fmode_t flags, void *holder);
444int btrfs_forget_devices(const char *path);
445int btrfs_close_devices(struct btrfs_fs_devices *fs_devices);
446void btrfs_free_extra_devids(struct btrfs_fs_devices *fs_devices, int step);
447void btrfs_assign_next_active_device(struct btrfs_device *device,
448 struct btrfs_device *this_dev);
449struct btrfs_device *btrfs_find_device_by_devspec(struct btrfs_fs_info *fs_info,
450 u64 devid,
451 const char *devpath);
452struct btrfs_device *btrfs_alloc_device(struct btrfs_fs_info *fs_info,
453 const u64 *devid,
454 const u8 *uuid);
455void btrfs_free_device(struct btrfs_device *device);
456int btrfs_rm_device(struct btrfs_fs_info *fs_info,
457 const char *device_path, u64 devid);
458void __exit btrfs_cleanup_fs_uuids(void);
459int btrfs_num_copies(struct btrfs_fs_info *fs_info, u64 logical, u64 len);
460int btrfs_grow_device(struct btrfs_trans_handle *trans,
461 struct btrfs_device *device, u64 new_size);
462struct btrfs_device *btrfs_find_device(struct btrfs_fs_devices *fs_devices,
463 u64 devid, u8 *uuid, u8 *fsid, bool seed);
464int btrfs_shrink_device(struct btrfs_device *device, u64 new_size);
465int btrfs_init_new_device(struct btrfs_fs_info *fs_info, const char *path);
466int btrfs_balance(struct btrfs_fs_info *fs_info,
467 struct btrfs_balance_control *bctl,
468 struct btrfs_ioctl_balance_args *bargs);
469void btrfs_describe_block_groups(u64 flags, char *buf, u32 size_buf);
470int btrfs_resume_balance_async(struct btrfs_fs_info *fs_info);
471int btrfs_recover_balance(struct btrfs_fs_info *fs_info);
472int btrfs_pause_balance(struct btrfs_fs_info *fs_info);
473int btrfs_cancel_balance(struct btrfs_fs_info *fs_info);
474int btrfs_create_uuid_tree(struct btrfs_fs_info *fs_info);
475int btrfs_check_uuid_tree(struct btrfs_fs_info *fs_info);
476int btrfs_chunk_readonly(struct btrfs_fs_info *fs_info, u64 chunk_offset);
477int find_free_dev_extent(struct btrfs_device *device, u64 num_bytes,
478 u64 *start, u64 *max_avail);
479void btrfs_dev_stat_inc_and_print(struct btrfs_device *dev, int index);
480int btrfs_get_dev_stats(struct btrfs_fs_info *fs_info,
481 struct btrfs_ioctl_get_dev_stats *stats);
482void btrfs_init_devices_late(struct btrfs_fs_info *fs_info);
483int btrfs_init_dev_stats(struct btrfs_fs_info *fs_info);
484int btrfs_run_dev_stats(struct btrfs_trans_handle *trans);
485void btrfs_rm_dev_replace_remove_srcdev(struct btrfs_device *srcdev);
486void btrfs_rm_dev_replace_free_srcdev(struct btrfs_device *srcdev);
487void btrfs_destroy_dev_replace_tgtdev(struct btrfs_device *tgtdev);
488void btrfs_scratch_superblocks(struct block_device *bdev, const char *device_path);
489int btrfs_is_parity_mirror(struct btrfs_fs_info *fs_info,
490 u64 logical, u64 len);
491unsigned long btrfs_full_stripe_len(struct btrfs_fs_info *fs_info,
492 u64 logical);
493int btrfs_finish_chunk_alloc(struct btrfs_trans_handle *trans,
494 u64 chunk_offset, u64 chunk_size);
495int btrfs_remove_chunk(struct btrfs_trans_handle *trans, u64 chunk_offset);
496struct extent_map *btrfs_get_chunk_map(struct btrfs_fs_info *fs_info,
497 u64 logical, u64 length);
498
499static inline void btrfs_dev_stat_inc(struct btrfs_device *dev,
500 int index)
501{
502 atomic_inc(dev->dev_stat_values + index);
503 /*
504 * This memory barrier orders stores updating statistics before stores
505 * updating dev_stats_ccnt.
506 *
507 * It pairs with smp_rmb() in btrfs_run_dev_stats().
508 */
509 smp_mb__before_atomic();
510 atomic_inc(&dev->dev_stats_ccnt);
511}
512
513static inline int btrfs_dev_stat_read(struct btrfs_device *dev,
514 int index)
515{
516 return atomic_read(dev->dev_stat_values + index);
517}
518
519static inline int btrfs_dev_stat_read_and_reset(struct btrfs_device *dev,
520 int index)
521{
522 int ret;
523
524 ret = atomic_xchg(dev->dev_stat_values + index, 0);
525 /*
526 * atomic_xchg implies a full memory barriers as per atomic_t.txt:
527 * - RMW operations that have a return value are fully ordered;
528 *
529 * This implicit memory barriers is paired with the smp_rmb in
530 * btrfs_run_dev_stats
531 */
532 atomic_inc(&dev->dev_stats_ccnt);
533 return ret;
534}
535
536static inline void btrfs_dev_stat_set(struct btrfs_device *dev,
537 int index, unsigned long val)
538{
539 atomic_set(dev->dev_stat_values + index, val);
540 /*
541 * This memory barrier orders stores updating statistics before stores
542 * updating dev_stats_ccnt.
543 *
544 * It pairs with smp_rmb() in btrfs_run_dev_stats().
545 */
546 smp_mb__before_atomic();
547 atomic_inc(&dev->dev_stats_ccnt);
548}
549
550/*
551 * Convert block group flags (BTRFS_BLOCK_GROUP_*) to btrfs_raid_types, which
552 * can be used as index to access btrfs_raid_array[].
553 */
554static inline enum btrfs_raid_types btrfs_bg_flags_to_raid_index(u64 flags)
555{
556 if (flags & BTRFS_BLOCK_GROUP_RAID10)
557 return BTRFS_RAID_RAID10;
558 else if (flags & BTRFS_BLOCK_GROUP_RAID1)
559 return BTRFS_RAID_RAID1;
560 else if (flags & BTRFS_BLOCK_GROUP_DUP)
561 return BTRFS_RAID_DUP;
562 else if (flags & BTRFS_BLOCK_GROUP_RAID0)
563 return BTRFS_RAID_RAID0;
564 else if (flags & BTRFS_BLOCK_GROUP_RAID5)
565 return BTRFS_RAID_RAID5;
566 else if (flags & BTRFS_BLOCK_GROUP_RAID6)
567 return BTRFS_RAID_RAID6;
568
569 return BTRFS_RAID_SINGLE; /* BTRFS_BLOCK_GROUP_SINGLE */
570}
571
572void btrfs_commit_device_sizes(struct btrfs_transaction *trans);
573
574struct list_head *btrfs_get_fs_uuids(void);
575void btrfs_set_fs_info_ptr(struct btrfs_fs_info *fs_info);
576void btrfs_reset_fs_info_ptr(struct btrfs_fs_info *fs_info);
577bool btrfs_check_rw_degradable(struct btrfs_fs_info *fs_info,
578 struct btrfs_device *failing_dev);
579
580int btrfs_bg_type_to_factor(u64 flags);
581const char *btrfs_bg_type_to_raid_name(u64 flags);
582int btrfs_verify_dev_extents(struct btrfs_fs_info *fs_info);
583
584#endif
1/* SPDX-License-Identifier: GPL-2.0 */
2/*
3 * Copyright (C) 2007 Oracle. All rights reserved.
4 */
5
6#ifndef BTRFS_VOLUMES_H
7#define BTRFS_VOLUMES_H
8
9#include <linux/bio.h>
10#include <linux/sort.h>
11#include <linux/btrfs.h>
12#include "async-thread.h"
13
14#define BTRFS_MAX_DATA_CHUNK_SIZE (10ULL * SZ_1G)
15
16extern struct mutex uuid_mutex;
17
18#define BTRFS_STRIPE_LEN SZ_64K
19
20struct btrfs_io_geometry {
21 /* remaining bytes before crossing a stripe */
22 u64 len;
23 /* offset of logical address in chunk */
24 u64 offset;
25 /* length of single IO stripe */
26 u64 stripe_len;
27 /* number of stripe where address falls */
28 u64 stripe_nr;
29 /* offset of address in stripe */
30 u64 stripe_offset;
31 /* offset of raid56 stripe into the chunk */
32 u64 raid56_stripe_offset;
33};
34
35/*
36 * Use sequence counter to get consistent device stat data on
37 * 32-bit processors.
38 */
39#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
40#include <linux/seqlock.h>
41#define __BTRFS_NEED_DEVICE_DATA_ORDERED
42#define btrfs_device_data_ordered_init(device) \
43 seqcount_init(&device->data_seqcount)
44#else
45#define btrfs_device_data_ordered_init(device) do { } while (0)
46#endif
47
48#define BTRFS_DEV_STATE_WRITEABLE (0)
49#define BTRFS_DEV_STATE_IN_FS_METADATA (1)
50#define BTRFS_DEV_STATE_MISSING (2)
51#define BTRFS_DEV_STATE_REPLACE_TGT (3)
52#define BTRFS_DEV_STATE_FLUSH_SENT (4)
53#define BTRFS_DEV_STATE_NO_READA (5)
54
55struct btrfs_zoned_device_info;
56
57struct btrfs_device {
58 struct list_head dev_list; /* device_list_mutex */
59 struct list_head dev_alloc_list; /* chunk mutex */
60 struct list_head post_commit_list; /* chunk mutex */
61 struct btrfs_fs_devices *fs_devices;
62 struct btrfs_fs_info *fs_info;
63
64 struct rcu_string __rcu *name;
65
66 u64 generation;
67
68 struct block_device *bdev;
69
70 struct btrfs_zoned_device_info *zone_info;
71
72 /* the mode sent to blkdev_get */
73 fmode_t mode;
74
75 unsigned long dev_state;
76 blk_status_t last_flush_error;
77
78#ifdef __BTRFS_NEED_DEVICE_DATA_ORDERED
79 seqcount_t data_seqcount;
80#endif
81
82 /* the internal btrfs device id */
83 u64 devid;
84
85 /* size of the device in memory */
86 u64 total_bytes;
87
88 /* size of the device on disk */
89 u64 disk_total_bytes;
90
91 /* bytes used */
92 u64 bytes_used;
93
94 /* optimal io alignment for this device */
95 u32 io_align;
96
97 /* optimal io width for this device */
98 u32 io_width;
99 /* type and info about this device */
100 u64 type;
101
102 /* minimal io size for this device */
103 u32 sector_size;
104
105 /* physical drive uuid (or lvm uuid) */
106 u8 uuid[BTRFS_UUID_SIZE];
107
108 /*
109 * size of the device on the current transaction
110 *
111 * This variant is update when committing the transaction,
112 * and protected by chunk mutex
113 */
114 u64 commit_total_bytes;
115
116 /* bytes used on the current transaction */
117 u64 commit_bytes_used;
118
119 /* for sending down flush barriers */
120 struct bio *flush_bio;
121 struct completion flush_wait;
122
123 /* per-device scrub information */
124 struct scrub_ctx *scrub_ctx;
125
126 /* readahead state */
127 atomic_t reada_in_flight;
128 u64 reada_next;
129 struct reada_zone *reada_curr_zone;
130 struct radix_tree_root reada_zones;
131 struct radix_tree_root reada_extents;
132
133 /* disk I/O failure stats. For detailed description refer to
134 * enum btrfs_dev_stat_values in ioctl.h */
135 int dev_stats_valid;
136
137 /* Counter to record the change of device stats */
138 atomic_t dev_stats_ccnt;
139 atomic_t dev_stat_values[BTRFS_DEV_STAT_VALUES_MAX];
140
141 struct extent_io_tree alloc_state;
142
143 struct completion kobj_unregister;
144 /* For sysfs/FSID/devinfo/devid/ */
145 struct kobject devid_kobj;
146
147 /* Bandwidth limit for scrub, in bytes */
148 u64 scrub_speed_max;
149};
150
151/*
152 * If we read those variants at the context of their own lock, we needn't
153 * use the following helpers, reading them directly is safe.
154 */
155#if BITS_PER_LONG==32 && defined(CONFIG_SMP)
156#define BTRFS_DEVICE_GETSET_FUNCS(name) \
157static inline u64 \
158btrfs_device_get_##name(const struct btrfs_device *dev) \
159{ \
160 u64 size; \
161 unsigned int seq; \
162 \
163 do { \
164 seq = read_seqcount_begin(&dev->data_seqcount); \
165 size = dev->name; \
166 } while (read_seqcount_retry(&dev->data_seqcount, seq)); \
167 return size; \
168} \
169 \
170static inline void \
171btrfs_device_set_##name(struct btrfs_device *dev, u64 size) \
172{ \
173 preempt_disable(); \
174 write_seqcount_begin(&dev->data_seqcount); \
175 dev->name = size; \
176 write_seqcount_end(&dev->data_seqcount); \
177 preempt_enable(); \
178}
179#elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPTION)
180#define BTRFS_DEVICE_GETSET_FUNCS(name) \
181static inline u64 \
182btrfs_device_get_##name(const struct btrfs_device *dev) \
183{ \
184 u64 size; \
185 \
186 preempt_disable(); \
187 size = dev->name; \
188 preempt_enable(); \
189 return size; \
190} \
191 \
192static inline void \
193btrfs_device_set_##name(struct btrfs_device *dev, u64 size) \
194{ \
195 preempt_disable(); \
196 dev->name = size; \
197 preempt_enable(); \
198}
199#else
200#define BTRFS_DEVICE_GETSET_FUNCS(name) \
201static inline u64 \
202btrfs_device_get_##name(const struct btrfs_device *dev) \
203{ \
204 return dev->name; \
205} \
206 \
207static inline void \
208btrfs_device_set_##name(struct btrfs_device *dev, u64 size) \
209{ \
210 dev->name = size; \
211}
212#endif
213
214BTRFS_DEVICE_GETSET_FUNCS(total_bytes);
215BTRFS_DEVICE_GETSET_FUNCS(disk_total_bytes);
216BTRFS_DEVICE_GETSET_FUNCS(bytes_used);
217
218enum btrfs_chunk_allocation_policy {
219 BTRFS_CHUNK_ALLOC_REGULAR,
220 BTRFS_CHUNK_ALLOC_ZONED,
221};
222
223/*
224 * Read policies for mirrored block group profiles, read picks the stripe based
225 * on these policies.
226 */
227enum btrfs_read_policy {
228 /* Use process PID to choose the stripe */
229 BTRFS_READ_POLICY_PID,
230 BTRFS_NR_READ_POLICY,
231};
232
233struct btrfs_fs_devices {
234 u8 fsid[BTRFS_FSID_SIZE]; /* FS specific uuid */
235 u8 metadata_uuid[BTRFS_FSID_SIZE];
236 bool fsid_change;
237 struct list_head fs_list;
238
239 u64 num_devices;
240 u64 open_devices;
241 u64 rw_devices;
242 u64 missing_devices;
243 u64 total_rw_bytes;
244 u64 total_devices;
245
246 /* Highest generation number of seen devices */
247 u64 latest_generation;
248
249 struct block_device *latest_bdev;
250
251 /* all of the devices in the FS, protected by a mutex
252 * so we can safely walk it to write out the supers without
253 * worrying about add/remove by the multi-device code.
254 * Scrubbing super can kick off supers writing by holding
255 * this mutex lock.
256 */
257 struct mutex device_list_mutex;
258
259 /* List of all devices, protected by device_list_mutex */
260 struct list_head devices;
261
262 /*
263 * Devices which can satisfy space allocation. Protected by
264 * chunk_mutex
265 */
266 struct list_head alloc_list;
267
268 struct list_head seed_list;
269 bool seeding;
270
271 int opened;
272
273 /* set when we find or add a device that doesn't have the
274 * nonrot flag set
275 */
276 bool rotating;
277
278 struct btrfs_fs_info *fs_info;
279 /* sysfs kobjects */
280 struct kobject fsid_kobj;
281 struct kobject *devices_kobj;
282 struct kobject *devinfo_kobj;
283 struct completion kobj_unregister;
284
285 enum btrfs_chunk_allocation_policy chunk_alloc_policy;
286
287 /* Policy used to read the mirrored stripes */
288 enum btrfs_read_policy read_policy;
289};
290
291#define BTRFS_BIO_INLINE_CSUM_SIZE 64
292
293#define BTRFS_MAX_DEVS(info) ((BTRFS_MAX_ITEM_SIZE(info) \
294 - sizeof(struct btrfs_chunk)) \
295 / sizeof(struct btrfs_stripe) + 1)
296
297#define BTRFS_MAX_DEVS_SYS_CHUNK ((BTRFS_SYSTEM_CHUNK_ARRAY_SIZE \
298 - 2 * sizeof(struct btrfs_disk_key) \
299 - 2 * sizeof(struct btrfs_chunk)) \
300 / sizeof(struct btrfs_stripe) + 1)
301
302/*
303 * we need the mirror number and stripe index to be passed around
304 * the call chain while we are processing end_io (especially errors).
305 * Really, what we need is a btrfs_bio structure that has this info
306 * and is properly sized with its stripe array, but we're not there
307 * quite yet. We have our own btrfs bioset, and all of the bios
308 * we allocate are actually btrfs_io_bios. We'll cram as much of
309 * struct btrfs_bio as we can into this over time.
310 */
311struct btrfs_io_bio {
312 unsigned int mirror_num;
313 struct btrfs_device *device;
314 u64 logical;
315 u8 *csum;
316 u8 csum_inline[BTRFS_BIO_INLINE_CSUM_SIZE];
317 struct bvec_iter iter;
318 /*
319 * This member must come last, bio_alloc_bioset will allocate enough
320 * bytes for entire btrfs_io_bio but relies on bio being last.
321 */
322 struct bio bio;
323};
324
325static inline struct btrfs_io_bio *btrfs_io_bio(struct bio *bio)
326{
327 return container_of(bio, struct btrfs_io_bio, bio);
328}
329
330static inline void btrfs_io_bio_free_csum(struct btrfs_io_bio *io_bio)
331{
332 if (io_bio->csum != io_bio->csum_inline) {
333 kfree(io_bio->csum);
334 io_bio->csum = NULL;
335 }
336}
337
338struct btrfs_bio_stripe {
339 struct btrfs_device *dev;
340 u64 physical;
341 u64 length; /* only used for discard mappings */
342};
343
344struct btrfs_bio {
345 refcount_t refs;
346 atomic_t stripes_pending;
347 struct btrfs_fs_info *fs_info;
348 u64 map_type; /* get from map_lookup->type */
349 bio_end_io_t *end_io;
350 struct bio *orig_bio;
351 void *private;
352 atomic_t error;
353 int max_errors;
354 int num_stripes;
355 int mirror_num;
356 int num_tgtdevs;
357 int *tgtdev_map;
358 /*
359 * logical block numbers for the start of each stripe
360 * The last one or two are p/q. These are sorted,
361 * so raid_map[0] is the start of our full stripe
362 */
363 u64 *raid_map;
364 struct btrfs_bio_stripe stripes[];
365};
366
367struct btrfs_device_info {
368 struct btrfs_device *dev;
369 u64 dev_offset;
370 u64 max_avail;
371 u64 total_avail;
372};
373
374struct btrfs_raid_attr {
375 u8 sub_stripes; /* sub_stripes info for map */
376 u8 dev_stripes; /* stripes per dev */
377 u8 devs_max; /* max devs to use */
378 u8 devs_min; /* min devs needed */
379 u8 tolerated_failures; /* max tolerated fail devs */
380 u8 devs_increment; /* ndevs has to be a multiple of this */
381 u8 ncopies; /* how many copies to data has */
382 u8 nparity; /* number of stripes worth of bytes to store
383 * parity information */
384 u8 mindev_error; /* error code if min devs requisite is unmet */
385 const char raid_name[8]; /* name of the raid */
386 u64 bg_flag; /* block group flag of the raid */
387};
388
389extern const struct btrfs_raid_attr btrfs_raid_array[BTRFS_NR_RAID_TYPES];
390
391struct map_lookup {
392 u64 type;
393 int io_align;
394 int io_width;
395 u64 stripe_len;
396 int num_stripes;
397 int sub_stripes;
398 int verified_stripes; /* For mount time dev extent verification */
399 struct btrfs_bio_stripe stripes[];
400};
401
402#define map_lookup_size(n) (sizeof(struct map_lookup) + \
403 (sizeof(struct btrfs_bio_stripe) * (n)))
404
405struct btrfs_balance_args;
406struct btrfs_balance_progress;
407struct btrfs_balance_control {
408 struct btrfs_balance_args data;
409 struct btrfs_balance_args meta;
410 struct btrfs_balance_args sys;
411
412 u64 flags;
413
414 struct btrfs_balance_progress stat;
415};
416
417enum btrfs_map_op {
418 BTRFS_MAP_READ,
419 BTRFS_MAP_WRITE,
420 BTRFS_MAP_DISCARD,
421 BTRFS_MAP_GET_READ_MIRRORS,
422};
423
424static inline enum btrfs_map_op btrfs_op(struct bio *bio)
425{
426 switch (bio_op(bio)) {
427 case REQ_OP_DISCARD:
428 return BTRFS_MAP_DISCARD;
429 case REQ_OP_WRITE:
430 case REQ_OP_ZONE_APPEND:
431 return BTRFS_MAP_WRITE;
432 default:
433 WARN_ON_ONCE(1);
434 fallthrough;
435 case REQ_OP_READ:
436 return BTRFS_MAP_READ;
437 }
438}
439
440void btrfs_get_bbio(struct btrfs_bio *bbio);
441void btrfs_put_bbio(struct btrfs_bio *bbio);
442int btrfs_map_block(struct btrfs_fs_info *fs_info, enum btrfs_map_op op,
443 u64 logical, u64 *length,
444 struct btrfs_bio **bbio_ret, int mirror_num);
445int btrfs_map_sblock(struct btrfs_fs_info *fs_info, enum btrfs_map_op op,
446 u64 logical, u64 *length,
447 struct btrfs_bio **bbio_ret);
448int btrfs_get_io_geometry(struct btrfs_fs_info *fs_info, struct extent_map *map,
449 enum btrfs_map_op op, u64 logical,
450 struct btrfs_io_geometry *io_geom);
451int btrfs_read_sys_array(struct btrfs_fs_info *fs_info);
452int btrfs_read_chunk_tree(struct btrfs_fs_info *fs_info);
453struct btrfs_block_group *btrfs_alloc_chunk(struct btrfs_trans_handle *trans,
454 u64 type);
455void btrfs_mapping_tree_free(struct extent_map_tree *tree);
456blk_status_t btrfs_map_bio(struct btrfs_fs_info *fs_info, struct bio *bio,
457 int mirror_num);
458int btrfs_open_devices(struct btrfs_fs_devices *fs_devices,
459 fmode_t flags, void *holder);
460struct btrfs_device *btrfs_scan_one_device(const char *path,
461 fmode_t flags, void *holder);
462int btrfs_forget_devices(const char *path);
463void btrfs_close_devices(struct btrfs_fs_devices *fs_devices);
464void btrfs_free_extra_devids(struct btrfs_fs_devices *fs_devices);
465void btrfs_assign_next_active_device(struct btrfs_device *device,
466 struct btrfs_device *this_dev);
467struct btrfs_device *btrfs_find_device_by_devspec(struct btrfs_fs_info *fs_info,
468 u64 devid,
469 const char *devpath);
470struct btrfs_device *btrfs_alloc_device(struct btrfs_fs_info *fs_info,
471 const u64 *devid,
472 const u8 *uuid);
473void btrfs_free_device(struct btrfs_device *device);
474int btrfs_rm_device(struct btrfs_fs_info *fs_info,
475 const char *device_path, u64 devid,
476 struct block_device **bdev, fmode_t *mode);
477void __exit btrfs_cleanup_fs_uuids(void);
478int btrfs_num_copies(struct btrfs_fs_info *fs_info, u64 logical, u64 len);
479int btrfs_grow_device(struct btrfs_trans_handle *trans,
480 struct btrfs_device *device, u64 new_size);
481struct btrfs_device *btrfs_find_device(struct btrfs_fs_devices *fs_devices,
482 u64 devid, u8 *uuid, u8 *fsid);
483int btrfs_shrink_device(struct btrfs_device *device, u64 new_size);
484int btrfs_init_new_device(struct btrfs_fs_info *fs_info, const char *path);
485int btrfs_balance(struct btrfs_fs_info *fs_info,
486 struct btrfs_balance_control *bctl,
487 struct btrfs_ioctl_balance_args *bargs);
488void btrfs_describe_block_groups(u64 flags, char *buf, u32 size_buf);
489int btrfs_resume_balance_async(struct btrfs_fs_info *fs_info);
490int btrfs_recover_balance(struct btrfs_fs_info *fs_info);
491int btrfs_pause_balance(struct btrfs_fs_info *fs_info);
492int btrfs_relocate_chunk(struct btrfs_fs_info *fs_info, u64 chunk_offset);
493int btrfs_cancel_balance(struct btrfs_fs_info *fs_info);
494int btrfs_create_uuid_tree(struct btrfs_fs_info *fs_info);
495int btrfs_uuid_scan_kthread(void *data);
496int btrfs_chunk_readonly(struct btrfs_fs_info *fs_info, u64 chunk_offset);
497int find_free_dev_extent(struct btrfs_device *device, u64 num_bytes,
498 u64 *start, u64 *max_avail);
499void btrfs_dev_stat_inc_and_print(struct btrfs_device *dev, int index);
500int btrfs_get_dev_stats(struct btrfs_fs_info *fs_info,
501 struct btrfs_ioctl_get_dev_stats *stats);
502void btrfs_init_devices_late(struct btrfs_fs_info *fs_info);
503int btrfs_init_dev_stats(struct btrfs_fs_info *fs_info);
504int btrfs_run_dev_stats(struct btrfs_trans_handle *trans);
505void btrfs_rm_dev_replace_remove_srcdev(struct btrfs_device *srcdev);
506void btrfs_rm_dev_replace_free_srcdev(struct btrfs_device *srcdev);
507void btrfs_destroy_dev_replace_tgtdev(struct btrfs_device *tgtdev);
508int btrfs_is_parity_mirror(struct btrfs_fs_info *fs_info,
509 u64 logical, u64 len);
510unsigned long btrfs_full_stripe_len(struct btrfs_fs_info *fs_info,
511 u64 logical);
512int btrfs_finish_chunk_alloc(struct btrfs_trans_handle *trans,
513 u64 chunk_offset, u64 chunk_size);
514int btrfs_chunk_alloc_add_chunk_item(struct btrfs_trans_handle *trans,
515 struct btrfs_block_group *bg);
516int btrfs_remove_chunk(struct btrfs_trans_handle *trans, u64 chunk_offset);
517struct extent_map *btrfs_get_chunk_map(struct btrfs_fs_info *fs_info,
518 u64 logical, u64 length);
519void btrfs_release_disk_super(struct btrfs_super_block *super);
520
521static inline void btrfs_dev_stat_inc(struct btrfs_device *dev,
522 int index)
523{
524 atomic_inc(dev->dev_stat_values + index);
525 /*
526 * This memory barrier orders stores updating statistics before stores
527 * updating dev_stats_ccnt.
528 *
529 * It pairs with smp_rmb() in btrfs_run_dev_stats().
530 */
531 smp_mb__before_atomic();
532 atomic_inc(&dev->dev_stats_ccnt);
533}
534
535static inline int btrfs_dev_stat_read(struct btrfs_device *dev,
536 int index)
537{
538 return atomic_read(dev->dev_stat_values + index);
539}
540
541static inline int btrfs_dev_stat_read_and_reset(struct btrfs_device *dev,
542 int index)
543{
544 int ret;
545
546 ret = atomic_xchg(dev->dev_stat_values + index, 0);
547 /*
548 * atomic_xchg implies a full memory barriers as per atomic_t.txt:
549 * - RMW operations that have a return value are fully ordered;
550 *
551 * This implicit memory barriers is paired with the smp_rmb in
552 * btrfs_run_dev_stats
553 */
554 atomic_inc(&dev->dev_stats_ccnt);
555 return ret;
556}
557
558static inline void btrfs_dev_stat_set(struct btrfs_device *dev,
559 int index, unsigned long val)
560{
561 atomic_set(dev->dev_stat_values + index, val);
562 /*
563 * This memory barrier orders stores updating statistics before stores
564 * updating dev_stats_ccnt.
565 *
566 * It pairs with smp_rmb() in btrfs_run_dev_stats().
567 */
568 smp_mb__before_atomic();
569 atomic_inc(&dev->dev_stats_ccnt);
570}
571
572/*
573 * Convert block group flags (BTRFS_BLOCK_GROUP_*) to btrfs_raid_types, which
574 * can be used as index to access btrfs_raid_array[].
575 */
576static inline enum btrfs_raid_types btrfs_bg_flags_to_raid_index(u64 flags)
577{
578 if (flags & BTRFS_BLOCK_GROUP_RAID10)
579 return BTRFS_RAID_RAID10;
580 else if (flags & BTRFS_BLOCK_GROUP_RAID1)
581 return BTRFS_RAID_RAID1;
582 else if (flags & BTRFS_BLOCK_GROUP_RAID1C3)
583 return BTRFS_RAID_RAID1C3;
584 else if (flags & BTRFS_BLOCK_GROUP_RAID1C4)
585 return BTRFS_RAID_RAID1C4;
586 else if (flags & BTRFS_BLOCK_GROUP_DUP)
587 return BTRFS_RAID_DUP;
588 else if (flags & BTRFS_BLOCK_GROUP_RAID0)
589 return BTRFS_RAID_RAID0;
590 else if (flags & BTRFS_BLOCK_GROUP_RAID5)
591 return BTRFS_RAID_RAID5;
592 else if (flags & BTRFS_BLOCK_GROUP_RAID6)
593 return BTRFS_RAID_RAID6;
594
595 return BTRFS_RAID_SINGLE; /* BTRFS_BLOCK_GROUP_SINGLE */
596}
597
598void btrfs_commit_device_sizes(struct btrfs_transaction *trans);
599
600struct list_head * __attribute_const__ btrfs_get_fs_uuids(void);
601bool btrfs_check_rw_degradable(struct btrfs_fs_info *fs_info,
602 struct btrfs_device *failing_dev);
603void btrfs_scratch_superblocks(struct btrfs_fs_info *fs_info,
604 struct block_device *bdev,
605 const char *device_path);
606
607int btrfs_bg_type_to_factor(u64 flags);
608const char *btrfs_bg_type_to_raid_name(u64 flags);
609int btrfs_verify_dev_extents(struct btrfs_fs_info *fs_info);
610int btrfs_repair_one_zone(struct btrfs_fs_info *fs_info, u64 logical);
611
612#endif