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