1 /* SPDX-License-Identifier: GPL-2.0 */
3 * Copyright (C) 2007 Oracle. All rights reserved.
6 #ifndef BTRFS_VOLUMES_H
7 #define BTRFS_VOLUMES_H
10 #include <linux/sort.h>
11 #include <linux/btrfs.h>
12 #include "async-thread.h"
14 #define BTRFS_MAX_DATA_CHUNK_SIZE (10ULL * SZ_1G)
16 extern struct mutex uuid_mutex;
18 #define BTRFS_STRIPE_LEN SZ_64K
21 struct btrfs_pending_bios {
27 * Use sequence counter to get consistent device stat data on
30 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
31 #include <linux/seqlock.h>
32 #define __BTRFS_NEED_DEVICE_DATA_ORDERED
33 #define btrfs_device_data_ordered_init(device) \
34 seqcount_init(&device->data_seqcount)
36 #define btrfs_device_data_ordered_init(device) do { } while (0)
39 #define BTRFS_DEV_STATE_WRITEABLE (0)
40 #define BTRFS_DEV_STATE_IN_FS_METADATA (1)
41 #define BTRFS_DEV_STATE_MISSING (2)
42 #define BTRFS_DEV_STATE_REPLACE_TGT (3)
43 #define BTRFS_DEV_STATE_FLUSH_SENT (4)
46 struct list_head dev_list;
47 struct list_head dev_alloc_list;
48 struct btrfs_fs_devices *fs_devices;
49 struct btrfs_fs_info *fs_info;
51 struct rcu_string *name;
55 spinlock_t io_lock ____cacheline_aligned;
57 /* regular prio bios */
58 struct btrfs_pending_bios pending_bios;
60 struct btrfs_pending_bios pending_sync_bios;
62 struct block_device *bdev;
64 /* the mode sent to blkdev_get */
67 unsigned long dev_state;
68 blk_status_t last_flush_error;
71 #ifdef __BTRFS_NEED_DEVICE_DATA_ORDERED
72 seqcount_t data_seqcount;
75 /* the internal btrfs device id */
78 /* size of the device in memory */
81 /* size of the device on disk */
87 /* optimal io alignment for this device */
90 /* optimal io width for this device */
92 /* type and info about this device */
95 /* minimal io size for this device */
98 /* physical drive uuid (or lvm uuid) */
99 u8 uuid[BTRFS_UUID_SIZE];
102 * size of the device on the current transaction
104 * This variant is update when committing the transaction,
105 * and protected by device_list_mutex
107 u64 commit_total_bytes;
109 /* bytes used on the current transaction */
110 u64 commit_bytes_used;
112 * used to manage the device which is resized
114 * It is protected by chunk_lock.
116 struct list_head resized_list;
118 /* for sending down flush barriers */
119 struct bio *flush_bio;
120 struct completion flush_wait;
122 /* per-device scrub information */
123 struct scrub_ctx *scrub_ctx;
125 struct btrfs_work work;
128 /* readahead state */
129 atomic_t reada_in_flight;
131 struct reada_zone *reada_curr_zone;
132 struct radix_tree_root reada_zones;
133 struct radix_tree_root reada_extents;
135 /* disk I/O failure stats. For detailed description refer to
136 * enum btrfs_dev_stat_values in ioctl.h */
139 /* Counter to record the change of device stats */
140 atomic_t dev_stats_ccnt;
141 atomic_t dev_stat_values[BTRFS_DEV_STAT_VALUES_MAX];
145 * If we read those variants at the context of their own lock, we needn't
146 * use the following helpers, reading them directly is safe.
148 #if BITS_PER_LONG==32 && defined(CONFIG_SMP)
149 #define BTRFS_DEVICE_GETSET_FUNCS(name) \
151 btrfs_device_get_##name(const struct btrfs_device *dev) \
157 seq = read_seqcount_begin(&dev->data_seqcount); \
159 } while (read_seqcount_retry(&dev->data_seqcount, seq)); \
164 btrfs_device_set_##name(struct btrfs_device *dev, u64 size) \
167 write_seqcount_begin(&dev->data_seqcount); \
169 write_seqcount_end(&dev->data_seqcount); \
172 #elif BITS_PER_LONG==32 && defined(CONFIG_PREEMPT)
173 #define BTRFS_DEVICE_GETSET_FUNCS(name) \
175 btrfs_device_get_##name(const struct btrfs_device *dev) \
186 btrfs_device_set_##name(struct btrfs_device *dev, u64 size) \
193 #define BTRFS_DEVICE_GETSET_FUNCS(name) \
195 btrfs_device_get_##name(const struct btrfs_device *dev) \
201 btrfs_device_set_##name(struct btrfs_device *dev, u64 size) \
207 BTRFS_DEVICE_GETSET_FUNCS(total_bytes);
208 BTRFS_DEVICE_GETSET_FUNCS(disk_total_bytes);
209 BTRFS_DEVICE_GETSET_FUNCS(bytes_used);
211 struct btrfs_fs_devices {
212 u8 fsid[BTRFS_FSID_SIZE]; /* FS specific uuid */
213 u8 metadata_uuid[BTRFS_FSID_SIZE];
215 struct list_head fs_list;
224 /* Highest generation number of seen devices */
225 u64 latest_generation;
227 struct block_device *latest_bdev;
229 /* all of the devices in the FS, protected by a mutex
230 * so we can safely walk it to write out the supers without
231 * worrying about add/remove by the multi-device code.
232 * Scrubbing super can kick off supers writing by holding
235 struct mutex device_list_mutex;
236 struct list_head devices;
238 struct list_head resized_devices;
239 /* devices not currently being allocated */
240 struct list_head alloc_list;
242 struct btrfs_fs_devices *seed;
247 /* set when we find or add a device that doesn't have the
252 struct btrfs_fs_info *fs_info;
254 struct kobject fsid_kobj;
255 struct kobject *device_dir_kobj;
256 struct completion kobj_unregister;
259 #define BTRFS_BIO_INLINE_CSUM_SIZE 64
261 #define BTRFS_MAX_DEVS(info) ((BTRFS_MAX_ITEM_SIZE(info) \
262 - sizeof(struct btrfs_chunk)) \
263 / sizeof(struct btrfs_stripe) + 1)
265 #define BTRFS_MAX_DEVS_SYS_CHUNK ((BTRFS_SYSTEM_CHUNK_ARRAY_SIZE \
266 - 2 * sizeof(struct btrfs_disk_key) \
267 - 2 * sizeof(struct btrfs_chunk)) \
268 / sizeof(struct btrfs_stripe) + 1)
271 * we need the mirror number and stripe index to be passed around
272 * the call chain while we are processing end_io (especially errors).
273 * Really, what we need is a btrfs_bio structure that has this info
274 * and is properly sized with its stripe array, but we're not there
275 * quite yet. We have our own btrfs bioset, and all of the bios
276 * we allocate are actually btrfs_io_bios. We'll cram as much of
277 * struct btrfs_bio as we can into this over time.
279 struct btrfs_io_bio {
280 unsigned int mirror_num;
281 unsigned int stripe_index;
284 u8 csum_inline[BTRFS_BIO_INLINE_CSUM_SIZE];
285 struct bvec_iter iter;
287 * This member must come last, bio_alloc_bioset will allocate enough
288 * bytes for entire btrfs_io_bio but relies on bio being last.
293 static inline struct btrfs_io_bio *btrfs_io_bio(struct bio *bio)
295 return container_of(bio, struct btrfs_io_bio, bio);
298 static inline void btrfs_io_bio_free_csum(struct btrfs_io_bio *io_bio)
300 if (io_bio->csum != io_bio->csum_inline) {
306 struct btrfs_bio_stripe {
307 struct btrfs_device *dev;
309 u64 length; /* only used for discard mappings */
314 atomic_t stripes_pending;
315 struct btrfs_fs_info *fs_info;
316 u64 map_type; /* get from map_lookup->type */
317 bio_end_io_t *end_io;
318 struct bio *orig_bio;
328 * logical block numbers for the start of each stripe
329 * The last one or two are p/q. These are sorted,
330 * so raid_map[0] is the start of our full stripe
333 struct btrfs_bio_stripe stripes[];
336 struct btrfs_device_info {
337 struct btrfs_device *dev;
343 struct btrfs_raid_attr {
344 int sub_stripes; /* sub_stripes info for map */
345 int dev_stripes; /* stripes per dev */
346 int devs_max; /* max devs to use */
347 int devs_min; /* min devs needed */
348 int tolerated_failures; /* max tolerated fail devs */
349 int devs_increment; /* ndevs has to be a multiple of this */
350 int ncopies; /* how many copies to data has */
351 int nparity; /* number of stripes worth of bytes to store
352 * parity information */
353 int mindev_error; /* error code if min devs requisite is unmet */
354 const char raid_name[8]; /* name of the raid */
355 u64 bg_flag; /* block group flag of the raid */
358 extern const struct btrfs_raid_attr btrfs_raid_array[BTRFS_NR_RAID_TYPES];
367 int verified_stripes; /* For mount time dev extent verification */
368 struct btrfs_bio_stripe stripes[];
371 #define map_lookup_size(n) (sizeof(struct map_lookup) + \
372 (sizeof(struct btrfs_bio_stripe) * (n)))
374 struct btrfs_balance_args;
375 struct btrfs_balance_progress;
376 struct btrfs_balance_control {
377 struct btrfs_balance_args data;
378 struct btrfs_balance_args meta;
379 struct btrfs_balance_args sys;
383 struct btrfs_balance_progress stat;
390 BTRFS_MAP_GET_READ_MIRRORS,
393 static inline enum btrfs_map_op btrfs_op(struct bio *bio)
395 switch (bio_op(bio)) {
397 return BTRFS_MAP_DISCARD;
399 return BTRFS_MAP_WRITE;
403 return BTRFS_MAP_READ;
407 void btrfs_get_bbio(struct btrfs_bio *bbio);
408 void btrfs_put_bbio(struct btrfs_bio *bbio);
409 int btrfs_map_block(struct btrfs_fs_info *fs_info, enum btrfs_map_op op,
410 u64 logical, u64 *length,
411 struct btrfs_bio **bbio_ret, int mirror_num);
412 int btrfs_map_sblock(struct btrfs_fs_info *fs_info, enum btrfs_map_op op,
413 u64 logical, u64 *length,
414 struct btrfs_bio **bbio_ret);
415 int btrfs_rmap_block(struct btrfs_fs_info *fs_info, u64 chunk_start,
416 u64 physical, u64 **logical, int *naddrs, int *stripe_len);
417 int btrfs_read_sys_array(struct btrfs_fs_info *fs_info);
418 int btrfs_read_chunk_tree(struct btrfs_fs_info *fs_info);
419 int btrfs_alloc_chunk(struct btrfs_trans_handle *trans, u64 type);
420 void btrfs_mapping_init(struct btrfs_mapping_tree *tree);
421 void btrfs_mapping_tree_free(struct btrfs_mapping_tree *tree);
422 blk_status_t btrfs_map_bio(struct btrfs_fs_info *fs_info, struct bio *bio,
423 int mirror_num, int async_submit);
424 int btrfs_open_devices(struct btrfs_fs_devices *fs_devices,
425 fmode_t flags, void *holder);
426 struct btrfs_device *btrfs_scan_one_device(const char *path,
427 fmode_t flags, void *holder);
428 int btrfs_forget_devices(const char *path);
429 int btrfs_close_devices(struct btrfs_fs_devices *fs_devices);
430 void btrfs_free_extra_devids(struct btrfs_fs_devices *fs_devices, int step);
431 void btrfs_assign_next_active_device(struct btrfs_device *device,
432 struct btrfs_device *this_dev);
433 struct btrfs_device *btrfs_find_device_by_devspec(struct btrfs_fs_info *fs_info,
435 const char *devpath);
436 struct btrfs_device *btrfs_alloc_device(struct btrfs_fs_info *fs_info,
439 void btrfs_free_device(struct btrfs_device *device);
440 int btrfs_rm_device(struct btrfs_fs_info *fs_info,
441 const char *device_path, u64 devid);
442 void __exit btrfs_cleanup_fs_uuids(void);
443 int btrfs_num_copies(struct btrfs_fs_info *fs_info, u64 logical, u64 len);
444 int btrfs_grow_device(struct btrfs_trans_handle *trans,
445 struct btrfs_device *device, u64 new_size);
446 struct btrfs_device *btrfs_find_device(struct btrfs_fs_devices *fs_devices,
447 u64 devid, u8 *uuid, u8 *fsid, bool seed);
448 int btrfs_shrink_device(struct btrfs_device *device, u64 new_size);
449 int btrfs_init_new_device(struct btrfs_fs_info *fs_info, const char *path);
450 int btrfs_balance(struct btrfs_fs_info *fs_info,
451 struct btrfs_balance_control *bctl,
452 struct btrfs_ioctl_balance_args *bargs);
453 void btrfs_describe_block_groups(u64 flags, char *buf, u32 size_buf);
454 int btrfs_resume_balance_async(struct btrfs_fs_info *fs_info);
455 int btrfs_recover_balance(struct btrfs_fs_info *fs_info);
456 int btrfs_pause_balance(struct btrfs_fs_info *fs_info);
457 int btrfs_cancel_balance(struct btrfs_fs_info *fs_info);
458 int btrfs_create_uuid_tree(struct btrfs_fs_info *fs_info);
459 int btrfs_check_uuid_tree(struct btrfs_fs_info *fs_info);
460 int btrfs_chunk_readonly(struct btrfs_fs_info *fs_info, u64 chunk_offset);
461 int find_free_dev_extent_start(struct btrfs_transaction *transaction,
462 struct btrfs_device *device, u64 num_bytes,
463 u64 search_start, u64 *start, u64 *max_avail);
464 int find_free_dev_extent(struct btrfs_trans_handle *trans,
465 struct btrfs_device *device, u64 num_bytes,
466 u64 *start, u64 *max_avail);
467 void btrfs_dev_stat_inc_and_print(struct btrfs_device *dev, int index);
468 int btrfs_get_dev_stats(struct btrfs_fs_info *fs_info,
469 struct btrfs_ioctl_get_dev_stats *stats);
470 void btrfs_init_devices_late(struct btrfs_fs_info *fs_info);
471 int btrfs_init_dev_stats(struct btrfs_fs_info *fs_info);
472 int btrfs_run_dev_stats(struct btrfs_trans_handle *trans,
473 struct btrfs_fs_info *fs_info);
474 void btrfs_rm_dev_replace_remove_srcdev(struct btrfs_device *srcdev);
475 void btrfs_rm_dev_replace_free_srcdev(struct btrfs_fs_info *fs_info,
476 struct btrfs_device *srcdev);
477 void btrfs_destroy_dev_replace_tgtdev(struct btrfs_device *tgtdev);
478 void btrfs_scratch_superblocks(struct block_device *bdev, const char *device_path);
479 int btrfs_is_parity_mirror(struct btrfs_fs_info *fs_info,
480 u64 logical, u64 len);
481 unsigned long btrfs_full_stripe_len(struct btrfs_fs_info *fs_info,
483 int btrfs_finish_chunk_alloc(struct btrfs_trans_handle *trans,
484 u64 chunk_offset, u64 chunk_size);
485 int btrfs_remove_chunk(struct btrfs_trans_handle *trans, u64 chunk_offset);
486 struct extent_map *btrfs_get_chunk_map(struct btrfs_fs_info *fs_info,
487 u64 logical, u64 length);
489 static inline void btrfs_dev_stat_inc(struct btrfs_device *dev,
492 atomic_inc(dev->dev_stat_values + index);
494 * This memory barrier orders stores updating statistics before stores
495 * updating dev_stats_ccnt.
497 * It pairs with smp_rmb() in btrfs_run_dev_stats().
499 smp_mb__before_atomic();
500 atomic_inc(&dev->dev_stats_ccnt);
503 static inline int btrfs_dev_stat_read(struct btrfs_device *dev,
506 return atomic_read(dev->dev_stat_values + index);
509 static inline int btrfs_dev_stat_read_and_reset(struct btrfs_device *dev,
514 ret = atomic_xchg(dev->dev_stat_values + index, 0);
516 * atomic_xchg implies a full memory barriers as per atomic_t.txt:
517 * - RMW operations that have a return value are fully ordered;
519 * This implicit memory barriers is paired with the smp_rmb in
520 * btrfs_run_dev_stats
522 atomic_inc(&dev->dev_stats_ccnt);
526 static inline void btrfs_dev_stat_set(struct btrfs_device *dev,
527 int index, unsigned long val)
529 atomic_set(dev->dev_stat_values + index, val);
531 * This memory barrier orders stores updating statistics before stores
532 * updating dev_stats_ccnt.
534 * It pairs with smp_rmb() in btrfs_run_dev_stats().
536 smp_mb__before_atomic();
537 atomic_inc(&dev->dev_stats_ccnt);
540 static inline void btrfs_dev_stat_reset(struct btrfs_device *dev,
543 btrfs_dev_stat_set(dev, index, 0);
547 * Convert block group flags (BTRFS_BLOCK_GROUP_*) to btrfs_raid_types, which
548 * can be used as index to access btrfs_raid_array[].
550 static inline enum btrfs_raid_types btrfs_bg_flags_to_raid_index(u64 flags)
552 if (flags & BTRFS_BLOCK_GROUP_RAID10)
553 return BTRFS_RAID_RAID10;
554 else if (flags & BTRFS_BLOCK_GROUP_RAID1)
555 return BTRFS_RAID_RAID1;
556 else if (flags & BTRFS_BLOCK_GROUP_DUP)
557 return BTRFS_RAID_DUP;
558 else if (flags & BTRFS_BLOCK_GROUP_RAID0)
559 return BTRFS_RAID_RAID0;
560 else if (flags & BTRFS_BLOCK_GROUP_RAID5)
561 return BTRFS_RAID_RAID5;
562 else if (flags & BTRFS_BLOCK_GROUP_RAID6)
563 return BTRFS_RAID_RAID6;
565 return BTRFS_RAID_SINGLE; /* BTRFS_BLOCK_GROUP_SINGLE */
568 const char *get_raid_name(enum btrfs_raid_types type);
570 void btrfs_update_commit_device_size(struct btrfs_fs_info *fs_info);
571 void btrfs_update_commit_device_bytes_used(struct btrfs_transaction *trans);
573 struct list_head *btrfs_get_fs_uuids(void);
574 void btrfs_set_fs_info_ptr(struct btrfs_fs_info *fs_info);
575 void btrfs_reset_fs_info_ptr(struct btrfs_fs_info *fs_info);
576 bool btrfs_check_rw_degradable(struct btrfs_fs_info *fs_info,
577 struct btrfs_device *failing_dev);
579 int btrfs_bg_type_to_factor(u64 flags);
580 int btrfs_verify_dev_extents(struct btrfs_fs_info *fs_info);