b235283a88460ddeef447f2305a71d918f399a29
[linux-2.6-microblaze.git] / drivers / md / dm-zoned-metadata.c
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Copyright (C) 2017 Western Digital Corporation or its affiliates.
4  *
5  * This file is released under the GPL.
6  */
7
8 #include "dm-zoned.h"
9
10 #include <linux/module.h>
11 #include <linux/crc32.h>
12 #include <linux/sched/mm.h>
13
14 #define DM_MSG_PREFIX           "zoned metadata"
15
16 /*
17  * Metadata version.
18  */
19 #define DMZ_META_VER    2
20
21 /*
22  * On-disk super block magic.
23  */
24 #define DMZ_MAGIC       ((((unsigned int)('D')) << 24) | \
25                          (((unsigned int)('Z')) << 16) | \
26                          (((unsigned int)('B')) <<  8) | \
27                          ((unsigned int)('D')))
28
29 /*
30  * On disk super block.
31  * This uses only 512 B but uses on disk a full 4KB block. This block is
32  * followed on disk by the mapping table of chunks to zones and the bitmap
33  * blocks indicating zone block validity.
34  * The overall resulting metadata format is:
35  *    (1) Super block (1 block)
36  *    (2) Chunk mapping table (nr_map_blocks)
37  *    (3) Bitmap blocks (nr_bitmap_blocks)
38  * All metadata blocks are stored in conventional zones, starting from
39  * the first conventional zone found on disk.
40  */
41 struct dmz_super {
42         /* Magic number */
43         __le32          magic;                  /*   4 */
44
45         /* Metadata version number */
46         __le32          version;                /*   8 */
47
48         /* Generation number */
49         __le64          gen;                    /*  16 */
50
51         /* This block number */
52         __le64          sb_block;               /*  24 */
53
54         /* The number of metadata blocks, including this super block */
55         __le32          nr_meta_blocks;         /*  28 */
56
57         /* The number of sequential zones reserved for reclaim */
58         __le32          nr_reserved_seq;        /*  32 */
59
60         /* The number of entries in the mapping table */
61         __le32          nr_chunks;              /*  36 */
62
63         /* The number of blocks used for the chunk mapping table */
64         __le32          nr_map_blocks;          /*  40 */
65
66         /* The number of blocks used for the block bitmaps */
67         __le32          nr_bitmap_blocks;       /*  44 */
68
69         /* Checksum */
70         __le32          crc;                    /*  48 */
71
72         /* DM-Zoned label */
73         u8              dmz_label[32];          /*  80 */
74
75         /* DM-Zoned UUID */
76         u8              dmz_uuid[16];           /*  96 */
77
78         /* Device UUID */
79         u8              dev_uuid[16];           /* 112 */
80
81         /* Padding to full 512B sector */
82         u8              reserved[400];          /* 512 */
83 };
84
85 /*
86  * Chunk mapping entry: entries are indexed by chunk number
87  * and give the zone ID (dzone_id) mapping the chunk on disk.
88  * This zone may be sequential or random. If it is a sequential
89  * zone, a second zone (bzone_id) used as a write buffer may
90  * also be specified. This second zone will always be a randomly
91  * writeable zone.
92  */
93 struct dmz_map {
94         __le32                  dzone_id;
95         __le32                  bzone_id;
96 };
97
98 /*
99  * Chunk mapping table metadata: 512 8-bytes entries per 4KB block.
100  */
101 #define DMZ_MAP_ENTRIES         (DMZ_BLOCK_SIZE / sizeof(struct dmz_map))
102 #define DMZ_MAP_ENTRIES_SHIFT   (ilog2(DMZ_MAP_ENTRIES))
103 #define DMZ_MAP_ENTRIES_MASK    (DMZ_MAP_ENTRIES - 1)
104 #define DMZ_MAP_UNMAPPED        UINT_MAX
105
106 /*
107  * Meta data block descriptor (for cached metadata blocks).
108  */
109 struct dmz_mblock {
110         struct rb_node          node;
111         struct list_head        link;
112         sector_t                no;
113         unsigned int            ref;
114         unsigned long           state;
115         struct page             *page;
116         void                    *data;
117 };
118
119 /*
120  * Metadata block state flags.
121  */
122 enum {
123         DMZ_META_DIRTY,
124         DMZ_META_READING,
125         DMZ_META_WRITING,
126         DMZ_META_ERROR,
127 };
128
129 /*
130  * Super block information (one per metadata set).
131  */
132 struct dmz_sb {
133         sector_t                block;
134         struct dmz_dev          *dev;
135         struct dmz_mblock       *mblk;
136         struct dmz_super        *sb;
137         struct dm_zone          *zone;
138 };
139
140 /*
141  * In-memory metadata.
142  */
143 struct dmz_metadata {
144         struct dmz_dev          *dev;
145         unsigned int            nr_devs;
146
147         char                    devname[BDEVNAME_SIZE];
148         char                    label[BDEVNAME_SIZE];
149         uuid_t                  uuid;
150
151         sector_t                zone_bitmap_size;
152         unsigned int            zone_nr_bitmap_blocks;
153         unsigned int            zone_bits_per_mblk;
154
155         sector_t                zone_nr_blocks;
156         sector_t                zone_nr_blocks_shift;
157
158         sector_t                zone_nr_sectors;
159         sector_t                zone_nr_sectors_shift;
160
161         unsigned int            nr_bitmap_blocks;
162         unsigned int            nr_map_blocks;
163
164         unsigned int            nr_zones;
165         unsigned int            nr_useable_zones;
166         unsigned int            nr_meta_blocks;
167         unsigned int            nr_meta_zones;
168         unsigned int            nr_data_zones;
169         unsigned int            nr_cache_zones;
170         unsigned int            nr_rnd_zones;
171         unsigned int            nr_reserved_seq;
172         unsigned int            nr_chunks;
173
174         /* Zone information array */
175         struct xarray           zones;
176
177         struct dmz_sb           sb[3];
178         unsigned int            mblk_primary;
179         unsigned int            sb_version;
180         u64                     sb_gen;
181         unsigned int            min_nr_mblks;
182         unsigned int            max_nr_mblks;
183         atomic_t                nr_mblks;
184         struct rw_semaphore     mblk_sem;
185         struct mutex            mblk_flush_lock;
186         spinlock_t              mblk_lock;
187         struct rb_root          mblk_rbtree;
188         struct list_head        mblk_lru_list;
189         struct list_head        mblk_dirty_list;
190         struct shrinker         mblk_shrinker;
191
192         /* Zone allocation management */
193         struct mutex            map_lock;
194         struct dmz_mblock       **map_mblk;
195         unsigned int            nr_rnd;
196         atomic_t                unmap_nr_rnd;
197         struct list_head        unmap_rnd_list;
198         struct list_head        map_rnd_list;
199
200         unsigned int            nr_cache;
201         atomic_t                unmap_nr_cache;
202         struct list_head        unmap_cache_list;
203         struct list_head        map_cache_list;
204
205         unsigned int            nr_seq;
206         atomic_t                unmap_nr_seq;
207         struct list_head        unmap_seq_list;
208         struct list_head        map_seq_list;
209
210         atomic_t                nr_reserved_seq_zones;
211         struct list_head        reserved_seq_zones_list;
212
213         wait_queue_head_t       free_wq;
214 };
215
216 #define dmz_zmd_info(zmd, format, args...)      \
217         DMINFO("(%s): " format, (zmd)->label, ## args)
218
219 #define dmz_zmd_err(zmd, format, args...)       \
220         DMERR("(%s): " format, (zmd)->label, ## args)
221
222 #define dmz_zmd_warn(zmd, format, args...)      \
223         DMWARN("(%s): " format, (zmd)->label, ## args)
224
225 #define dmz_zmd_debug(zmd, format, args...)     \
226         DMDEBUG("(%s): " format, (zmd)->label, ## args)
227 /*
228  * Various accessors
229  */
230 static unsigned int dmz_dev_zone_id(struct dmz_metadata *zmd, struct dm_zone *zone)
231 {
232         unsigned int zone_id;
233
234         if (WARN_ON(!zone))
235                 return 0;
236
237         zone_id = zone->id;
238         if (zmd->nr_devs > 1 &&
239             (zone_id >= zmd->dev[1].zone_offset))
240                 zone_id -= zmd->dev[1].zone_offset;
241         return zone_id;
242 }
243
244 sector_t dmz_start_sect(struct dmz_metadata *zmd, struct dm_zone *zone)
245 {
246         unsigned int zone_id = dmz_dev_zone_id(zmd, zone);
247
248         return (sector_t)zone_id << zmd->zone_nr_sectors_shift;
249 }
250
251 sector_t dmz_start_block(struct dmz_metadata *zmd, struct dm_zone *zone)
252 {
253         unsigned int zone_id = dmz_dev_zone_id(zmd, zone);
254
255         return (sector_t)zone_id << zmd->zone_nr_blocks_shift;
256 }
257
258 struct dmz_dev *dmz_zone_to_dev(struct dmz_metadata *zmd, struct dm_zone *zone)
259 {
260         if (WARN_ON(!zone))
261                 return &zmd->dev[0];
262
263         if (zmd->nr_devs > 1 &&
264             zone->id >= zmd->dev[1].zone_offset)
265                 return &zmd->dev[1];
266
267         return &zmd->dev[0];
268 }
269
270 unsigned int dmz_zone_nr_blocks(struct dmz_metadata *zmd)
271 {
272         return zmd->zone_nr_blocks;
273 }
274
275 unsigned int dmz_zone_nr_blocks_shift(struct dmz_metadata *zmd)
276 {
277         return zmd->zone_nr_blocks_shift;
278 }
279
280 unsigned int dmz_zone_nr_sectors(struct dmz_metadata *zmd)
281 {
282         return zmd->zone_nr_sectors;
283 }
284
285 unsigned int dmz_zone_nr_sectors_shift(struct dmz_metadata *zmd)
286 {
287         return zmd->zone_nr_sectors_shift;
288 }
289
290 unsigned int dmz_nr_zones(struct dmz_metadata *zmd)
291 {
292         return zmd->nr_zones;
293 }
294
295 unsigned int dmz_nr_chunks(struct dmz_metadata *zmd)
296 {
297         return zmd->nr_chunks;
298 }
299
300 unsigned int dmz_nr_rnd_zones(struct dmz_metadata *zmd)
301 {
302         return zmd->nr_rnd;
303 }
304
305 unsigned int dmz_nr_unmap_rnd_zones(struct dmz_metadata *zmd)
306 {
307         return atomic_read(&zmd->unmap_nr_rnd);
308 }
309
310 unsigned int dmz_nr_cache_zones(struct dmz_metadata *zmd)
311 {
312         return zmd->nr_cache;
313 }
314
315 unsigned int dmz_nr_unmap_cache_zones(struct dmz_metadata *zmd)
316 {
317         return atomic_read(&zmd->unmap_nr_cache);
318 }
319
320 unsigned int dmz_nr_seq_zones(struct dmz_metadata *zmd)
321 {
322         return zmd->nr_seq;
323 }
324
325 unsigned int dmz_nr_unmap_seq_zones(struct dmz_metadata *zmd)
326 {
327         return atomic_read(&zmd->unmap_nr_seq);
328 }
329
330 static struct dm_zone *dmz_get(struct dmz_metadata *zmd, unsigned int zone_id)
331 {
332         return xa_load(&zmd->zones, zone_id);
333 }
334
335 static struct dm_zone *dmz_insert(struct dmz_metadata *zmd,
336                                   unsigned int zone_id)
337 {
338         struct dm_zone *zone = kzalloc(sizeof(struct dm_zone), GFP_KERNEL);
339
340         if (!zone)
341                 return ERR_PTR(-ENOMEM);
342
343         if (xa_insert(&zmd->zones, zone_id, zone, GFP_KERNEL)) {
344                 kfree(zone);
345                 return ERR_PTR(-EBUSY);
346         }
347
348         INIT_LIST_HEAD(&zone->link);
349         atomic_set(&zone->refcount, 0);
350         zone->id = zone_id;
351         zone->chunk = DMZ_MAP_UNMAPPED;
352
353         return zone;
354 }
355
356 const char *dmz_metadata_label(struct dmz_metadata *zmd)
357 {
358         return (const char *)zmd->label;
359 }
360
361 bool dmz_check_dev(struct dmz_metadata *zmd)
362 {
363         unsigned int i;
364
365         for (i = 0; i < zmd->nr_devs; i++) {
366                 if (!dmz_check_bdev(&zmd->dev[i]))
367                         return false;
368         }
369         return true;
370 }
371
372 bool dmz_dev_is_dying(struct dmz_metadata *zmd)
373 {
374         unsigned int i;
375
376         for (i = 0; i < zmd->nr_devs; i++) {
377                 if (dmz_bdev_is_dying(&zmd->dev[i]))
378                         return true;
379         }
380         return false;
381 }
382
383 /*
384  * Lock/unlock mapping table.
385  * The map lock also protects all the zone lists.
386  */
387 void dmz_lock_map(struct dmz_metadata *zmd)
388 {
389         mutex_lock(&zmd->map_lock);
390 }
391
392 void dmz_unlock_map(struct dmz_metadata *zmd)
393 {
394         mutex_unlock(&zmd->map_lock);
395 }
396
397 /*
398  * Lock/unlock metadata access. This is a "read" lock on a semaphore
399  * that prevents metadata flush from running while metadata are being
400  * modified. The actual metadata write mutual exclusion is achieved with
401  * the map lock and zone state management (active and reclaim state are
402  * mutually exclusive).
403  */
404 void dmz_lock_metadata(struct dmz_metadata *zmd)
405 {
406         down_read(&zmd->mblk_sem);
407 }
408
409 void dmz_unlock_metadata(struct dmz_metadata *zmd)
410 {
411         up_read(&zmd->mblk_sem);
412 }
413
414 /*
415  * Lock/unlock flush: prevent concurrent executions
416  * of dmz_flush_metadata as well as metadata modification in reclaim
417  * while flush is being executed.
418  */
419 void dmz_lock_flush(struct dmz_metadata *zmd)
420 {
421         mutex_lock(&zmd->mblk_flush_lock);
422 }
423
424 void dmz_unlock_flush(struct dmz_metadata *zmd)
425 {
426         mutex_unlock(&zmd->mblk_flush_lock);
427 }
428
429 /*
430  * Allocate a metadata block.
431  */
432 static struct dmz_mblock *dmz_alloc_mblock(struct dmz_metadata *zmd,
433                                            sector_t mblk_no)
434 {
435         struct dmz_mblock *mblk = NULL;
436
437         /* See if we can reuse cached blocks */
438         if (zmd->max_nr_mblks && atomic_read(&zmd->nr_mblks) > zmd->max_nr_mblks) {
439                 spin_lock(&zmd->mblk_lock);
440                 mblk = list_first_entry_or_null(&zmd->mblk_lru_list,
441                                                 struct dmz_mblock, link);
442                 if (mblk) {
443                         list_del_init(&mblk->link);
444                         rb_erase(&mblk->node, &zmd->mblk_rbtree);
445                         mblk->no = mblk_no;
446                 }
447                 spin_unlock(&zmd->mblk_lock);
448                 if (mblk)
449                         return mblk;
450         }
451
452         /* Allocate a new block */
453         mblk = kmalloc(sizeof(struct dmz_mblock), GFP_NOIO);
454         if (!mblk)
455                 return NULL;
456
457         mblk->page = alloc_page(GFP_NOIO);
458         if (!mblk->page) {
459                 kfree(mblk);
460                 return NULL;
461         }
462
463         RB_CLEAR_NODE(&mblk->node);
464         INIT_LIST_HEAD(&mblk->link);
465         mblk->ref = 0;
466         mblk->state = 0;
467         mblk->no = mblk_no;
468         mblk->data = page_address(mblk->page);
469
470         atomic_inc(&zmd->nr_mblks);
471
472         return mblk;
473 }
474
475 /*
476  * Free a metadata block.
477  */
478 static void dmz_free_mblock(struct dmz_metadata *zmd, struct dmz_mblock *mblk)
479 {
480         __free_pages(mblk->page, 0);
481         kfree(mblk);
482
483         atomic_dec(&zmd->nr_mblks);
484 }
485
486 /*
487  * Insert a metadata block in the rbtree.
488  */
489 static void dmz_insert_mblock(struct dmz_metadata *zmd, struct dmz_mblock *mblk)
490 {
491         struct rb_root *root = &zmd->mblk_rbtree;
492         struct rb_node **new = &(root->rb_node), *parent = NULL;
493         struct dmz_mblock *b;
494
495         /* Figure out where to put the new node */
496         while (*new) {
497                 b = container_of(*new, struct dmz_mblock, node);
498                 parent = *new;
499                 new = (b->no < mblk->no) ? &((*new)->rb_left) : &((*new)->rb_right);
500         }
501
502         /* Add new node and rebalance tree */
503         rb_link_node(&mblk->node, parent, new);
504         rb_insert_color(&mblk->node, root);
505 }
506
507 /*
508  * Lookup a metadata block in the rbtree. If the block is found, increment
509  * its reference count.
510  */
511 static struct dmz_mblock *dmz_get_mblock_fast(struct dmz_metadata *zmd,
512                                               sector_t mblk_no)
513 {
514         struct rb_root *root = &zmd->mblk_rbtree;
515         struct rb_node *node = root->rb_node;
516         struct dmz_mblock *mblk;
517
518         while (node) {
519                 mblk = container_of(node, struct dmz_mblock, node);
520                 if (mblk->no == mblk_no) {
521                         /*
522                          * If this is the first reference to the block,
523                          * remove it from the LRU list.
524                          */
525                         mblk->ref++;
526                         if (mblk->ref == 1 &&
527                             !test_bit(DMZ_META_DIRTY, &mblk->state))
528                                 list_del_init(&mblk->link);
529                         return mblk;
530                 }
531                 node = (mblk->no < mblk_no) ? node->rb_left : node->rb_right;
532         }
533
534         return NULL;
535 }
536
537 /*
538  * Metadata block BIO end callback.
539  */
540 static void dmz_mblock_bio_end_io(struct bio *bio)
541 {
542         struct dmz_mblock *mblk = bio->bi_private;
543         int flag;
544
545         if (bio->bi_status)
546                 set_bit(DMZ_META_ERROR, &mblk->state);
547
548         if (bio_op(bio) == REQ_OP_WRITE)
549                 flag = DMZ_META_WRITING;
550         else
551                 flag = DMZ_META_READING;
552
553         clear_bit_unlock(flag, &mblk->state);
554         smp_mb__after_atomic();
555         wake_up_bit(&mblk->state, flag);
556
557         bio_put(bio);
558 }
559
560 /*
561  * Read an uncached metadata block from disk and add it to the cache.
562  */
563 static struct dmz_mblock *dmz_get_mblock_slow(struct dmz_metadata *zmd,
564                                               sector_t mblk_no)
565 {
566         struct dmz_mblock *mblk, *m;
567         sector_t block = zmd->sb[zmd->mblk_primary].block + mblk_no;
568         struct dmz_dev *dev = zmd->sb[zmd->mblk_primary].dev;
569         struct bio *bio;
570
571         if (dmz_bdev_is_dying(dev))
572                 return ERR_PTR(-EIO);
573
574         /* Get a new block and a BIO to read it */
575         mblk = dmz_alloc_mblock(zmd, mblk_no);
576         if (!mblk)
577                 return ERR_PTR(-ENOMEM);
578
579         bio = bio_alloc(GFP_NOIO, 1);
580         if (!bio) {
581                 dmz_free_mblock(zmd, mblk);
582                 return ERR_PTR(-ENOMEM);
583         }
584
585         spin_lock(&zmd->mblk_lock);
586
587         /*
588          * Make sure that another context did not start reading
589          * the block already.
590          */
591         m = dmz_get_mblock_fast(zmd, mblk_no);
592         if (m) {
593                 spin_unlock(&zmd->mblk_lock);
594                 dmz_free_mblock(zmd, mblk);
595                 bio_put(bio);
596                 return m;
597         }
598
599         mblk->ref++;
600         set_bit(DMZ_META_READING, &mblk->state);
601         dmz_insert_mblock(zmd, mblk);
602
603         spin_unlock(&zmd->mblk_lock);
604
605         /* Submit read BIO */
606         bio->bi_iter.bi_sector = dmz_blk2sect(block);
607         bio_set_dev(bio, dev->bdev);
608         bio->bi_private = mblk;
609         bio->bi_end_io = dmz_mblock_bio_end_io;
610         bio_set_op_attrs(bio, REQ_OP_READ, REQ_META | REQ_PRIO);
611         bio_add_page(bio, mblk->page, DMZ_BLOCK_SIZE, 0);
612         submit_bio(bio);
613
614         return mblk;
615 }
616
617 /*
618  * Free metadata blocks.
619  */
620 static unsigned long dmz_shrink_mblock_cache(struct dmz_metadata *zmd,
621                                              unsigned long limit)
622 {
623         struct dmz_mblock *mblk;
624         unsigned long count = 0;
625
626         if (!zmd->max_nr_mblks)
627                 return 0;
628
629         while (!list_empty(&zmd->mblk_lru_list) &&
630                atomic_read(&zmd->nr_mblks) > zmd->min_nr_mblks &&
631                count < limit) {
632                 mblk = list_first_entry(&zmd->mblk_lru_list,
633                                         struct dmz_mblock, link);
634                 list_del_init(&mblk->link);
635                 rb_erase(&mblk->node, &zmd->mblk_rbtree);
636                 dmz_free_mblock(zmd, mblk);
637                 count++;
638         }
639
640         return count;
641 }
642
643 /*
644  * For mblock shrinker: get the number of unused metadata blocks in the cache.
645  */
646 static unsigned long dmz_mblock_shrinker_count(struct shrinker *shrink,
647                                                struct shrink_control *sc)
648 {
649         struct dmz_metadata *zmd = container_of(shrink, struct dmz_metadata, mblk_shrinker);
650
651         return atomic_read(&zmd->nr_mblks);
652 }
653
654 /*
655  * For mblock shrinker: scan unused metadata blocks and shrink the cache.
656  */
657 static unsigned long dmz_mblock_shrinker_scan(struct shrinker *shrink,
658                                               struct shrink_control *sc)
659 {
660         struct dmz_metadata *zmd = container_of(shrink, struct dmz_metadata, mblk_shrinker);
661         unsigned long count;
662
663         spin_lock(&zmd->mblk_lock);
664         count = dmz_shrink_mblock_cache(zmd, sc->nr_to_scan);
665         spin_unlock(&zmd->mblk_lock);
666
667         return count ? count : SHRINK_STOP;
668 }
669
670 /*
671  * Release a metadata block.
672  */
673 static void dmz_release_mblock(struct dmz_metadata *zmd,
674                                struct dmz_mblock *mblk)
675 {
676
677         if (!mblk)
678                 return;
679
680         spin_lock(&zmd->mblk_lock);
681
682         mblk->ref--;
683         if (mblk->ref == 0) {
684                 if (test_bit(DMZ_META_ERROR, &mblk->state)) {
685                         rb_erase(&mblk->node, &zmd->mblk_rbtree);
686                         dmz_free_mblock(zmd, mblk);
687                 } else if (!test_bit(DMZ_META_DIRTY, &mblk->state)) {
688                         list_add_tail(&mblk->link, &zmd->mblk_lru_list);
689                         dmz_shrink_mblock_cache(zmd, 1);
690                 }
691         }
692
693         spin_unlock(&zmd->mblk_lock);
694 }
695
696 /*
697  * Get a metadata block from the rbtree. If the block
698  * is not present, read it from disk.
699  */
700 static struct dmz_mblock *dmz_get_mblock(struct dmz_metadata *zmd,
701                                          sector_t mblk_no)
702 {
703         struct dmz_mblock *mblk;
704         struct dmz_dev *dev = zmd->sb[zmd->mblk_primary].dev;
705
706         /* Check rbtree */
707         spin_lock(&zmd->mblk_lock);
708         mblk = dmz_get_mblock_fast(zmd, mblk_no);
709         spin_unlock(&zmd->mblk_lock);
710
711         if (!mblk) {
712                 /* Cache miss: read the block from disk */
713                 mblk = dmz_get_mblock_slow(zmd, mblk_no);
714                 if (IS_ERR(mblk))
715                         return mblk;
716         }
717
718         /* Wait for on-going read I/O and check for error */
719         wait_on_bit_io(&mblk->state, DMZ_META_READING,
720                        TASK_UNINTERRUPTIBLE);
721         if (test_bit(DMZ_META_ERROR, &mblk->state)) {
722                 dmz_release_mblock(zmd, mblk);
723                 dmz_check_bdev(dev);
724                 return ERR_PTR(-EIO);
725         }
726
727         return mblk;
728 }
729
730 /*
731  * Mark a metadata block dirty.
732  */
733 static void dmz_dirty_mblock(struct dmz_metadata *zmd, struct dmz_mblock *mblk)
734 {
735         spin_lock(&zmd->mblk_lock);
736         if (!test_and_set_bit(DMZ_META_DIRTY, &mblk->state))
737                 list_add_tail(&mblk->link, &zmd->mblk_dirty_list);
738         spin_unlock(&zmd->mblk_lock);
739 }
740
741 /*
742  * Issue a metadata block write BIO.
743  */
744 static int dmz_write_mblock(struct dmz_metadata *zmd, struct dmz_mblock *mblk,
745                             unsigned int set)
746 {
747         struct dmz_dev *dev = zmd->sb[set].dev;
748         sector_t block = zmd->sb[set].block + mblk->no;
749         struct bio *bio;
750
751         if (dmz_bdev_is_dying(dev))
752                 return -EIO;
753
754         bio = bio_alloc(GFP_NOIO, 1);
755         if (!bio) {
756                 set_bit(DMZ_META_ERROR, &mblk->state);
757                 return -ENOMEM;
758         }
759
760         set_bit(DMZ_META_WRITING, &mblk->state);
761
762         bio->bi_iter.bi_sector = dmz_blk2sect(block);
763         bio_set_dev(bio, dev->bdev);
764         bio->bi_private = mblk;
765         bio->bi_end_io = dmz_mblock_bio_end_io;
766         bio_set_op_attrs(bio, REQ_OP_WRITE, REQ_META | REQ_PRIO);
767         bio_add_page(bio, mblk->page, DMZ_BLOCK_SIZE, 0);
768         submit_bio(bio);
769
770         return 0;
771 }
772
773 /*
774  * Read/write a metadata block.
775  */
776 static int dmz_rdwr_block(struct dmz_dev *dev, int op,
777                           sector_t block, struct page *page)
778 {
779         struct bio *bio;
780         int ret;
781
782         if (WARN_ON(!dev))
783                 return -EIO;
784
785         if (dmz_bdev_is_dying(dev))
786                 return -EIO;
787
788         bio = bio_alloc(GFP_NOIO, 1);
789         if (!bio)
790                 return -ENOMEM;
791
792         bio->bi_iter.bi_sector = dmz_blk2sect(block);
793         bio_set_dev(bio, dev->bdev);
794         bio_set_op_attrs(bio, op, REQ_SYNC | REQ_META | REQ_PRIO);
795         bio_add_page(bio, page, DMZ_BLOCK_SIZE, 0);
796         ret = submit_bio_wait(bio);
797         bio_put(bio);
798
799         if (ret)
800                 dmz_check_bdev(dev);
801         return ret;
802 }
803
804 /*
805  * Write super block of the specified metadata set.
806  */
807 static int dmz_write_sb(struct dmz_metadata *zmd, unsigned int set)
808 {
809         struct dmz_mblock *mblk = zmd->sb[set].mblk;
810         struct dmz_super *sb = zmd->sb[set].sb;
811         struct dmz_dev *dev = zmd->sb[set].dev;
812         sector_t sb_block;
813         u64 sb_gen = zmd->sb_gen + 1;
814         int ret;
815
816         sb->magic = cpu_to_le32(DMZ_MAGIC);
817
818         sb->version = cpu_to_le32(zmd->sb_version);
819         if (zmd->sb_version > 1) {
820                 BUILD_BUG_ON(UUID_SIZE != 16);
821                 export_uuid(sb->dmz_uuid, &zmd->uuid);
822                 memcpy(sb->dmz_label, zmd->label, BDEVNAME_SIZE);
823                 export_uuid(sb->dev_uuid, &dev->uuid);
824         }
825
826         sb->gen = cpu_to_le64(sb_gen);
827
828         /*
829          * The metadata always references the absolute block address,
830          * ie relative to the entire block range, not the per-device
831          * block address.
832          */
833         sb_block = zmd->sb[set].zone->id << zmd->zone_nr_blocks_shift;
834         sb->sb_block = cpu_to_le64(sb_block);
835         sb->nr_meta_blocks = cpu_to_le32(zmd->nr_meta_blocks);
836         sb->nr_reserved_seq = cpu_to_le32(zmd->nr_reserved_seq);
837         sb->nr_chunks = cpu_to_le32(zmd->nr_chunks);
838
839         sb->nr_map_blocks = cpu_to_le32(zmd->nr_map_blocks);
840         sb->nr_bitmap_blocks = cpu_to_le32(zmd->nr_bitmap_blocks);
841
842         sb->crc = 0;
843         sb->crc = cpu_to_le32(crc32_le(sb_gen, (unsigned char *)sb, DMZ_BLOCK_SIZE));
844
845         ret = dmz_rdwr_block(dev, REQ_OP_WRITE, zmd->sb[set].block,
846                              mblk->page);
847         if (ret == 0)
848                 ret = blkdev_issue_flush(dev->bdev, GFP_NOIO, NULL);
849
850         return ret;
851 }
852
853 /*
854  * Write dirty metadata blocks to the specified set.
855  */
856 static int dmz_write_dirty_mblocks(struct dmz_metadata *zmd,
857                                    struct list_head *write_list,
858                                    unsigned int set)
859 {
860         struct dmz_mblock *mblk;
861         struct dmz_dev *dev = zmd->sb[set].dev;
862         struct blk_plug plug;
863         int ret = 0, nr_mblks_submitted = 0;
864
865         /* Issue writes */
866         blk_start_plug(&plug);
867         list_for_each_entry(mblk, write_list, link) {
868                 ret = dmz_write_mblock(zmd, mblk, set);
869                 if (ret)
870                         break;
871                 nr_mblks_submitted++;
872         }
873         blk_finish_plug(&plug);
874
875         /* Wait for completion */
876         list_for_each_entry(mblk, write_list, link) {
877                 if (!nr_mblks_submitted)
878                         break;
879                 wait_on_bit_io(&mblk->state, DMZ_META_WRITING,
880                                TASK_UNINTERRUPTIBLE);
881                 if (test_bit(DMZ_META_ERROR, &mblk->state)) {
882                         clear_bit(DMZ_META_ERROR, &mblk->state);
883                         dmz_check_bdev(dev);
884                         ret = -EIO;
885                 }
886                 nr_mblks_submitted--;
887         }
888
889         /* Flush drive cache (this will also sync data) */
890         if (ret == 0)
891                 ret = blkdev_issue_flush(dev->bdev, GFP_NOIO, NULL);
892
893         return ret;
894 }
895
896 /*
897  * Log dirty metadata blocks.
898  */
899 static int dmz_log_dirty_mblocks(struct dmz_metadata *zmd,
900                                  struct list_head *write_list)
901 {
902         unsigned int log_set = zmd->mblk_primary ^ 0x1;
903         int ret;
904
905         /* Write dirty blocks to the log */
906         ret = dmz_write_dirty_mblocks(zmd, write_list, log_set);
907         if (ret)
908                 return ret;
909
910         /*
911          * No error so far: now validate the log by updating the
912          * log index super block generation.
913          */
914         ret = dmz_write_sb(zmd, log_set);
915         if (ret)
916                 return ret;
917
918         return 0;
919 }
920
921 /*
922  * Flush dirty metadata blocks.
923  */
924 int dmz_flush_metadata(struct dmz_metadata *zmd)
925 {
926         struct dmz_mblock *mblk;
927         struct list_head write_list;
928         struct dmz_dev *dev;
929         int ret;
930
931         if (WARN_ON(!zmd))
932                 return 0;
933
934         INIT_LIST_HEAD(&write_list);
935
936         /*
937          * Make sure that metadata blocks are stable before logging: take
938          * the write lock on the metadata semaphore to prevent target BIOs
939          * from modifying metadata.
940          */
941         down_write(&zmd->mblk_sem);
942         dev = zmd->sb[zmd->mblk_primary].dev;
943
944         /*
945          * This is called from the target flush work and reclaim work.
946          * Concurrent execution is not allowed.
947          */
948         dmz_lock_flush(zmd);
949
950         if (dmz_bdev_is_dying(dev)) {
951                 ret = -EIO;
952                 goto out;
953         }
954
955         /* Get dirty blocks */
956         spin_lock(&zmd->mblk_lock);
957         list_splice_init(&zmd->mblk_dirty_list, &write_list);
958         spin_unlock(&zmd->mblk_lock);
959
960         /* If there are no dirty metadata blocks, just flush the device cache */
961         if (list_empty(&write_list)) {
962                 ret = blkdev_issue_flush(dev->bdev, GFP_NOIO, NULL);
963                 goto err;
964         }
965
966         /*
967          * The primary metadata set is still clean. Keep it this way until
968          * all updates are successful in the secondary set. That is, use
969          * the secondary set as a log.
970          */
971         ret = dmz_log_dirty_mblocks(zmd, &write_list);
972         if (ret)
973                 goto err;
974
975         /*
976          * The log is on disk. It is now safe to update in place
977          * in the primary metadata set.
978          */
979         ret = dmz_write_dirty_mblocks(zmd, &write_list, zmd->mblk_primary);
980         if (ret)
981                 goto err;
982
983         ret = dmz_write_sb(zmd, zmd->mblk_primary);
984         if (ret)
985                 goto err;
986
987         while (!list_empty(&write_list)) {
988                 mblk = list_first_entry(&write_list, struct dmz_mblock, link);
989                 list_del_init(&mblk->link);
990
991                 spin_lock(&zmd->mblk_lock);
992                 clear_bit(DMZ_META_DIRTY, &mblk->state);
993                 if (mblk->ref == 0)
994                         list_add_tail(&mblk->link, &zmd->mblk_lru_list);
995                 spin_unlock(&zmd->mblk_lock);
996         }
997
998         zmd->sb_gen++;
999 out:
1000         dmz_unlock_flush(zmd);
1001         up_write(&zmd->mblk_sem);
1002
1003         return ret;
1004
1005 err:
1006         if (!list_empty(&write_list)) {
1007                 spin_lock(&zmd->mblk_lock);
1008                 list_splice(&write_list, &zmd->mblk_dirty_list);
1009                 spin_unlock(&zmd->mblk_lock);
1010         }
1011         if (!dmz_check_bdev(dev))
1012                 ret = -EIO;
1013         goto out;
1014 }
1015
1016 /*
1017  * Check super block.
1018  */
1019 static int dmz_check_sb(struct dmz_metadata *zmd, unsigned int set)
1020 {
1021         struct dmz_super *sb = zmd->sb[set].sb;
1022         struct dmz_dev *dev = zmd->sb[set].dev;
1023         unsigned int nr_meta_zones, nr_data_zones;
1024         u32 crc, stored_crc;
1025         u64 gen;
1026
1027         if (le32_to_cpu(sb->magic) != DMZ_MAGIC) {
1028                 dmz_dev_err(dev, "Invalid meta magic (needed 0x%08x, got 0x%08x)",
1029                             DMZ_MAGIC, le32_to_cpu(sb->magic));
1030                 return -ENXIO;
1031         }
1032
1033         zmd->sb_version = le32_to_cpu(sb->version);
1034         if (zmd->sb_version > DMZ_META_VER) {
1035                 dmz_dev_err(dev, "Invalid meta version (needed %d, got %d)",
1036                             DMZ_META_VER, zmd->sb_version);
1037                 return -EINVAL;
1038         }
1039         if ((zmd->sb_version < 1) && (set == 2)) {
1040                 dmz_dev_err(dev, "Tertiary superblocks are not supported");
1041                 return -EINVAL;
1042         }
1043
1044         gen = le64_to_cpu(sb->gen);
1045         stored_crc = le32_to_cpu(sb->crc);
1046         sb->crc = 0;
1047         crc = crc32_le(gen, (unsigned char *)sb, DMZ_BLOCK_SIZE);
1048         if (crc != stored_crc) {
1049                 dmz_dev_err(dev, "Invalid checksum (needed 0x%08x, got 0x%08x)",
1050                             crc, stored_crc);
1051                 return -ENXIO;
1052         }
1053
1054         if (zmd->sb_version > 1) {
1055                 uuid_t sb_uuid;
1056
1057                 import_uuid(&sb_uuid, sb->dmz_uuid);
1058                 if (uuid_is_null(&sb_uuid)) {
1059                         dmz_dev_err(dev, "NULL DM-Zoned uuid");
1060                         return -ENXIO;
1061                 } else if (uuid_is_null(&zmd->uuid)) {
1062                         uuid_copy(&zmd->uuid, &sb_uuid);
1063                 } else if (!uuid_equal(&zmd->uuid, &sb_uuid)) {
1064                         dmz_dev_err(dev, "mismatching DM-Zoned uuid, "
1065                                     "is %pUl expected %pUl",
1066                                     &sb_uuid, &zmd->uuid);
1067                         return -ENXIO;
1068                 }
1069                 if (!strlen(zmd->label))
1070                         memcpy(zmd->label, sb->dmz_label, BDEVNAME_SIZE);
1071                 else if (memcmp(zmd->label, sb->dmz_label, BDEVNAME_SIZE)) {
1072                         dmz_dev_err(dev, "mismatching DM-Zoned label, "
1073                                     "is %s expected %s",
1074                                     sb->dmz_label, zmd->label);
1075                         return -ENXIO;
1076                 }
1077                 import_uuid(&dev->uuid, sb->dev_uuid);
1078                 if (uuid_is_null(&dev->uuid)) {
1079                         dmz_dev_err(dev, "NULL device uuid");
1080                         return -ENXIO;
1081                 }
1082
1083                 if (set == 2) {
1084                         /*
1085                          * Generation number should be 0, but it doesn't
1086                          * really matter if it isn't.
1087                          */
1088                         if (gen != 0)
1089                                 dmz_dev_warn(dev, "Invalid generation %llu",
1090                                             gen);
1091                         return 0;
1092                 }
1093         }
1094
1095         nr_meta_zones = (le32_to_cpu(sb->nr_meta_blocks) + zmd->zone_nr_blocks - 1)
1096                 >> zmd->zone_nr_blocks_shift;
1097         if (!nr_meta_zones ||
1098             nr_meta_zones >= zmd->nr_rnd_zones) {
1099                 dmz_dev_err(dev, "Invalid number of metadata blocks");
1100                 return -ENXIO;
1101         }
1102
1103         if (!le32_to_cpu(sb->nr_reserved_seq) ||
1104             le32_to_cpu(sb->nr_reserved_seq) >= (zmd->nr_useable_zones - nr_meta_zones)) {
1105                 dmz_dev_err(dev, "Invalid number of reserved sequential zones");
1106                 return -ENXIO;
1107         }
1108
1109         nr_data_zones = zmd->nr_useable_zones -
1110                 (nr_meta_zones * 2 + le32_to_cpu(sb->nr_reserved_seq));
1111         if (le32_to_cpu(sb->nr_chunks) > nr_data_zones) {
1112                 dmz_dev_err(dev, "Invalid number of chunks %u / %u",
1113                             le32_to_cpu(sb->nr_chunks), nr_data_zones);
1114                 return -ENXIO;
1115         }
1116
1117         /* OK */
1118         zmd->nr_meta_blocks = le32_to_cpu(sb->nr_meta_blocks);
1119         zmd->nr_reserved_seq = le32_to_cpu(sb->nr_reserved_seq);
1120         zmd->nr_chunks = le32_to_cpu(sb->nr_chunks);
1121         zmd->nr_map_blocks = le32_to_cpu(sb->nr_map_blocks);
1122         zmd->nr_bitmap_blocks = le32_to_cpu(sb->nr_bitmap_blocks);
1123         zmd->nr_meta_zones = nr_meta_zones;
1124         zmd->nr_data_zones = nr_data_zones;
1125
1126         return 0;
1127 }
1128
1129 /*
1130  * Read the first or second super block from disk.
1131  */
1132 static int dmz_read_sb(struct dmz_metadata *zmd, unsigned int set)
1133 {
1134         dmz_zmd_debug(zmd, "read superblock set %d dev %s block %llu",
1135                       set, zmd->sb[set].dev->name,
1136                       zmd->sb[set].block);
1137
1138         return dmz_rdwr_block(zmd->sb[set].dev, REQ_OP_READ,
1139                               zmd->sb[set].block, zmd->sb[set].mblk->page);
1140 }
1141
1142 /*
1143  * Determine the position of the secondary super blocks on disk.
1144  * This is used only if a corruption of the primary super block
1145  * is detected.
1146  */
1147 static int dmz_lookup_secondary_sb(struct dmz_metadata *zmd)
1148 {
1149         unsigned int zone_nr_blocks = zmd->zone_nr_blocks;
1150         struct dmz_mblock *mblk;
1151         unsigned int zone_id = zmd->sb[0].zone->id;
1152         int i;
1153
1154         /* Allocate a block */
1155         mblk = dmz_alloc_mblock(zmd, 0);
1156         if (!mblk)
1157                 return -ENOMEM;
1158
1159         zmd->sb[1].mblk = mblk;
1160         zmd->sb[1].sb = mblk->data;
1161
1162         /* Bad first super block: search for the second one */
1163         zmd->sb[1].block = zmd->sb[0].block + zone_nr_blocks;
1164         zmd->sb[1].zone = dmz_get(zmd, zone_id + 1);
1165         zmd->sb[1].dev = zmd->sb[0].dev;
1166         for (i = 1; i < zmd->nr_rnd_zones; i++) {
1167                 if (dmz_read_sb(zmd, 1) != 0)
1168                         break;
1169                 if (le32_to_cpu(zmd->sb[1].sb->magic) == DMZ_MAGIC)
1170                         return 0;
1171                 zmd->sb[1].block += zone_nr_blocks;
1172                 zmd->sb[1].zone = dmz_get(zmd, zone_id + i);
1173         }
1174
1175         dmz_free_mblock(zmd, mblk);
1176         zmd->sb[1].mblk = NULL;
1177         zmd->sb[1].zone = NULL;
1178         zmd->sb[1].dev = NULL;
1179
1180         return -EIO;
1181 }
1182
1183 /*
1184  * Read the first or second super block from disk.
1185  */
1186 static int dmz_get_sb(struct dmz_metadata *zmd, unsigned int set)
1187 {
1188         struct dmz_mblock *mblk;
1189         int ret;
1190
1191         /* Allocate a block */
1192         mblk = dmz_alloc_mblock(zmd, 0);
1193         if (!mblk)
1194                 return -ENOMEM;
1195
1196         zmd->sb[set].mblk = mblk;
1197         zmd->sb[set].sb = mblk->data;
1198
1199         /* Read super block */
1200         ret = dmz_read_sb(zmd, set);
1201         if (ret) {
1202                 dmz_free_mblock(zmd, mblk);
1203                 zmd->sb[set].mblk = NULL;
1204                 return ret;
1205         }
1206
1207         return 0;
1208 }
1209
1210 /*
1211  * Recover a metadata set.
1212  */
1213 static int dmz_recover_mblocks(struct dmz_metadata *zmd, unsigned int dst_set)
1214 {
1215         unsigned int src_set = dst_set ^ 0x1;
1216         struct page *page;
1217         int i, ret;
1218
1219         dmz_dev_warn(zmd->sb[dst_set].dev,
1220                      "Metadata set %u invalid: recovering", dst_set);
1221
1222         if (dst_set == 0)
1223                 zmd->sb[0].block = dmz_start_block(zmd, zmd->sb[0].zone);
1224         else
1225                 zmd->sb[1].block = dmz_start_block(zmd, zmd->sb[1].zone);
1226
1227         page = alloc_page(GFP_NOIO);
1228         if (!page)
1229                 return -ENOMEM;
1230
1231         /* Copy metadata blocks */
1232         for (i = 1; i < zmd->nr_meta_blocks; i++) {
1233                 ret = dmz_rdwr_block(zmd->sb[src_set].dev, REQ_OP_READ,
1234                                      zmd->sb[src_set].block + i, page);
1235                 if (ret)
1236                         goto out;
1237                 ret = dmz_rdwr_block(zmd->sb[dst_set].dev, REQ_OP_WRITE,
1238                                      zmd->sb[dst_set].block + i, page);
1239                 if (ret)
1240                         goto out;
1241         }
1242
1243         /* Finalize with the super block */
1244         if (!zmd->sb[dst_set].mblk) {
1245                 zmd->sb[dst_set].mblk = dmz_alloc_mblock(zmd, 0);
1246                 if (!zmd->sb[dst_set].mblk) {
1247                         ret = -ENOMEM;
1248                         goto out;
1249                 }
1250                 zmd->sb[dst_set].sb = zmd->sb[dst_set].mblk->data;
1251         }
1252
1253         ret = dmz_write_sb(zmd, dst_set);
1254 out:
1255         __free_pages(page, 0);
1256
1257         return ret;
1258 }
1259
1260 /*
1261  * Get super block from disk.
1262  */
1263 static int dmz_load_sb(struct dmz_metadata *zmd)
1264 {
1265         bool sb_good[2] = {false, false};
1266         u64 sb_gen[2] = {0, 0};
1267         int ret;
1268
1269         if (!zmd->sb[0].zone) {
1270                 dmz_zmd_err(zmd, "Primary super block zone not set");
1271                 return -ENXIO;
1272         }
1273
1274         /* Read and check the primary super block */
1275         zmd->sb[0].block = dmz_start_block(zmd, zmd->sb[0].zone);
1276         zmd->sb[0].dev = dmz_zone_to_dev(zmd, zmd->sb[0].zone);
1277         ret = dmz_get_sb(zmd, 0);
1278         if (ret) {
1279                 dmz_dev_err(zmd->sb[0].dev, "Read primary super block failed");
1280                 return ret;
1281         }
1282
1283         ret = dmz_check_sb(zmd, 0);
1284
1285         /* Read and check secondary super block */
1286         if (ret == 0) {
1287                 sb_good[0] = true;
1288                 if (!zmd->sb[1].zone) {
1289                         unsigned int zone_id =
1290                                 zmd->sb[0].zone->id + zmd->nr_meta_zones;
1291
1292                         zmd->sb[1].zone = dmz_get(zmd, zone_id);
1293                 }
1294                 zmd->sb[1].block = dmz_start_block(zmd, zmd->sb[1].zone);
1295                 zmd->sb[1].dev = zmd->sb[0].dev;
1296                 ret = dmz_get_sb(zmd, 1);
1297         } else
1298                 ret = dmz_lookup_secondary_sb(zmd);
1299
1300         if (ret) {
1301                 dmz_dev_err(zmd->sb[1].dev, "Read secondary super block failed");
1302                 return ret;
1303         }
1304
1305         ret = dmz_check_sb(zmd, 1);
1306         if (ret == 0)
1307                 sb_good[1] = true;
1308
1309         /* Use highest generation sb first */
1310         if (!sb_good[0] && !sb_good[1]) {
1311                 dmz_zmd_err(zmd, "No valid super block found");
1312                 return -EIO;
1313         }
1314
1315         if (sb_good[0])
1316                 sb_gen[0] = le64_to_cpu(zmd->sb[0].sb->gen);
1317         else {
1318                 ret = dmz_recover_mblocks(zmd, 0);
1319                 if (ret) {
1320                         dmz_dev_err(zmd->sb[0].dev,
1321                                     "Recovery of superblock 0 failed");
1322                         return -EIO;
1323                 }
1324         }
1325
1326         if (sb_good[1])
1327                 sb_gen[1] = le64_to_cpu(zmd->sb[1].sb->gen);
1328         else {
1329                 ret = dmz_recover_mblocks(zmd, 1);
1330
1331                 if (ret) {
1332                         dmz_dev_err(zmd->sb[1].dev,
1333                                     "Recovery of superblock 1 failed");
1334                         return -EIO;
1335                 }
1336         }
1337
1338         if (sb_gen[0] >= sb_gen[1]) {
1339                 zmd->sb_gen = sb_gen[0];
1340                 zmd->mblk_primary = 0;
1341         } else {
1342                 zmd->sb_gen = sb_gen[1];
1343                 zmd->mblk_primary = 1;
1344         }
1345
1346         dmz_dev_debug(zmd->sb[zmd->mblk_primary].dev,
1347                       "Using super block %u (gen %llu)",
1348                       zmd->mblk_primary, zmd->sb_gen);
1349
1350         if ((zmd->sb_version > 1) && zmd->sb[2].zone) {
1351                 zmd->sb[2].block = dmz_start_block(zmd, zmd->sb[2].zone);
1352                 zmd->sb[2].dev = dmz_zone_to_dev(zmd, zmd->sb[2].zone);
1353                 ret = dmz_get_sb(zmd, 2);
1354                 if (ret) {
1355                         dmz_dev_err(zmd->sb[2].dev,
1356                                     "Read tertiary super block failed");
1357                         return ret;
1358                 }
1359                 ret = dmz_check_sb(zmd, 2);
1360                 if (ret == -EINVAL)
1361                         return ret;
1362         }
1363         return 0;
1364 }
1365
1366 /*
1367  * Initialize a zone descriptor.
1368  */
1369 static int dmz_init_zone(struct blk_zone *blkz, unsigned int num, void *data)
1370 {
1371         struct dmz_metadata *zmd = data;
1372         struct dmz_dev *dev = zmd->nr_devs > 1 ? &zmd->dev[1] : &zmd->dev[0];
1373         int idx = num + dev->zone_offset;
1374         struct dm_zone *zone;
1375
1376         zone = dmz_insert(zmd, idx);
1377         if (IS_ERR(zone))
1378                 return PTR_ERR(zone);
1379
1380         if (blkz->len != zmd->zone_nr_sectors) {
1381                 if (zmd->sb_version > 1) {
1382                         /* Ignore the eventual runt (smaller) zone */
1383                         set_bit(DMZ_OFFLINE, &zone->flags);
1384                         return 0;
1385                 } else if (blkz->start + blkz->len == dev->capacity)
1386                         return 0;
1387                 return -ENXIO;
1388         }
1389
1390         switch (blkz->type) {
1391         case BLK_ZONE_TYPE_CONVENTIONAL:
1392                 set_bit(DMZ_RND, &zone->flags);
1393                 break;
1394         case BLK_ZONE_TYPE_SEQWRITE_REQ:
1395         case BLK_ZONE_TYPE_SEQWRITE_PREF:
1396                 set_bit(DMZ_SEQ, &zone->flags);
1397                 break;
1398         default:
1399                 return -ENXIO;
1400         }
1401
1402         if (dmz_is_rnd(zone))
1403                 zone->wp_block = 0;
1404         else
1405                 zone->wp_block = dmz_sect2blk(blkz->wp - blkz->start);
1406
1407         if (blkz->cond == BLK_ZONE_COND_OFFLINE)
1408                 set_bit(DMZ_OFFLINE, &zone->flags);
1409         else if (blkz->cond == BLK_ZONE_COND_READONLY)
1410                 set_bit(DMZ_READ_ONLY, &zone->flags);
1411         else {
1412                 zmd->nr_useable_zones++;
1413                 if (dmz_is_rnd(zone)) {
1414                         zmd->nr_rnd_zones++;
1415                         if (zmd->nr_devs == 1 && !zmd->sb[0].zone) {
1416                                 /* Primary super block zone */
1417                                 zmd->sb[0].zone = zone;
1418                         }
1419                 }
1420                 if (zmd->nr_devs > 1 && !zmd->sb[2].zone) {
1421                         /* Tertiary superblock zone */
1422                         zmd->sb[2].zone = zone;
1423                 }
1424         }
1425
1426         return 0;
1427 }
1428
1429 static int dmz_emulate_zones(struct dmz_metadata *zmd, struct dmz_dev *dev)
1430 {
1431         int idx;
1432         sector_t zone_offset = 0;
1433
1434         for(idx = 0; idx < dev->nr_zones; idx++) {
1435                 struct dm_zone *zone;
1436
1437                 zone = dmz_insert(zmd, idx);
1438                 if (IS_ERR(zone))
1439                         return PTR_ERR(zone);
1440                 set_bit(DMZ_CACHE, &zone->flags);
1441                 zone->wp_block = 0;
1442                 zmd->nr_cache_zones++;
1443                 zmd->nr_useable_zones++;
1444                 if (dev->capacity - zone_offset < zmd->zone_nr_sectors) {
1445                         /* Disable runt zone */
1446                         set_bit(DMZ_OFFLINE, &zone->flags);
1447                         break;
1448                 }
1449                 zone_offset += zmd->zone_nr_sectors;
1450         }
1451         return 0;
1452 }
1453
1454 /*
1455  * Free zones descriptors.
1456  */
1457 static void dmz_drop_zones(struct dmz_metadata *zmd)
1458 {
1459         int idx;
1460
1461         for(idx = 0; idx < zmd->nr_zones; idx++) {
1462                 struct dm_zone *zone = xa_load(&zmd->zones, idx);
1463
1464                 kfree(zone);
1465                 xa_erase(&zmd->zones, idx);
1466         }
1467         xa_destroy(&zmd->zones);
1468 }
1469
1470 /*
1471  * Allocate and initialize zone descriptors using the zone
1472  * information from disk.
1473  */
1474 static int dmz_init_zones(struct dmz_metadata *zmd)
1475 {
1476         int i, ret;
1477         struct dmz_dev *zoned_dev = &zmd->dev[0];
1478
1479         /* Init */
1480         zmd->zone_nr_sectors = zmd->dev[0].zone_nr_sectors;
1481         zmd->zone_nr_sectors_shift = ilog2(zmd->zone_nr_sectors);
1482         zmd->zone_nr_blocks = dmz_sect2blk(zmd->zone_nr_sectors);
1483         zmd->zone_nr_blocks_shift = ilog2(zmd->zone_nr_blocks);
1484         zmd->zone_bitmap_size = zmd->zone_nr_blocks >> 3;
1485         zmd->zone_nr_bitmap_blocks =
1486                 max_t(sector_t, 1, zmd->zone_bitmap_size >> DMZ_BLOCK_SHIFT);
1487         zmd->zone_bits_per_mblk = min_t(sector_t, zmd->zone_nr_blocks,
1488                                         DMZ_BLOCK_SIZE_BITS);
1489
1490         /* Allocate zone array */
1491         zmd->nr_zones = 0;
1492         for (i = 0; i < zmd->nr_devs; i++)
1493                 zmd->nr_zones += zmd->dev[i].nr_zones;
1494
1495         if (!zmd->nr_zones) {
1496                 DMERR("(%s): No zones found", zmd->devname);
1497                 return -ENXIO;
1498         }
1499         xa_init(&zmd->zones);
1500
1501         DMDEBUG("(%s): Using %zu B for zone information",
1502                 zmd->devname, sizeof(struct dm_zone) * zmd->nr_zones);
1503
1504         if (zmd->nr_devs > 1) {
1505                 ret = dmz_emulate_zones(zmd, &zmd->dev[0]);
1506                 if (ret < 0) {
1507                         DMDEBUG("(%s): Failed to emulate zones, error %d",
1508                                 zmd->devname, ret);
1509                         dmz_drop_zones(zmd);
1510                         return ret;
1511                 }
1512
1513                 /*
1514                  * Primary superblock zone is always at zone 0 when multiple
1515                  * drives are present.
1516                  */
1517                 zmd->sb[0].zone = dmz_get(zmd, 0);
1518
1519                 zoned_dev = &zmd->dev[1];
1520         }
1521
1522         /*
1523          * Get zone information and initialize zone descriptors.  At the same
1524          * time, determine where the super block should be: first block of the
1525          * first randomly writable zone.
1526          */
1527         ret = blkdev_report_zones(zoned_dev->bdev, 0, BLK_ALL_ZONES,
1528                                   dmz_init_zone, zmd);
1529         if (ret < 0) {
1530                 DMDEBUG("(%s): Failed to report zones, error %d",
1531                         zmd->devname, ret);
1532                 dmz_drop_zones(zmd);
1533                 return ret;
1534         }
1535
1536         return 0;
1537 }
1538
1539 static int dmz_update_zone_cb(struct blk_zone *blkz, unsigned int idx,
1540                               void *data)
1541 {
1542         struct dm_zone *zone = data;
1543
1544         clear_bit(DMZ_OFFLINE, &zone->flags);
1545         clear_bit(DMZ_READ_ONLY, &zone->flags);
1546         if (blkz->cond == BLK_ZONE_COND_OFFLINE)
1547                 set_bit(DMZ_OFFLINE, &zone->flags);
1548         else if (blkz->cond == BLK_ZONE_COND_READONLY)
1549                 set_bit(DMZ_READ_ONLY, &zone->flags);
1550
1551         if (dmz_is_seq(zone))
1552                 zone->wp_block = dmz_sect2blk(blkz->wp - blkz->start);
1553         else
1554                 zone->wp_block = 0;
1555         return 0;
1556 }
1557
1558 /*
1559  * Update a zone information.
1560  */
1561 static int dmz_update_zone(struct dmz_metadata *zmd, struct dm_zone *zone)
1562 {
1563         struct dmz_dev *dev = dmz_zone_to_dev(zmd, zone);
1564         unsigned int noio_flag;
1565         int ret;
1566
1567         if (dev->flags & DMZ_BDEV_REGULAR)
1568                 return 0;
1569
1570         /*
1571          * Get zone information from disk. Since blkdev_report_zones() uses
1572          * GFP_KERNEL by default for memory allocations, set the per-task
1573          * PF_MEMALLOC_NOIO flag so that all allocations are done as if
1574          * GFP_NOIO was specified.
1575          */
1576         noio_flag = memalloc_noio_save();
1577         ret = blkdev_report_zones(dev->bdev, dmz_start_sect(zmd, zone), 1,
1578                                   dmz_update_zone_cb, zone);
1579         memalloc_noio_restore(noio_flag);
1580
1581         if (ret == 0)
1582                 ret = -EIO;
1583         if (ret < 0) {
1584                 dmz_dev_err(dev, "Get zone %u report failed",
1585                             zone->id);
1586                 dmz_check_bdev(dev);
1587                 return ret;
1588         }
1589
1590         return 0;
1591 }
1592
1593 /*
1594  * Check a zone write pointer position when the zone is marked
1595  * with the sequential write error flag.
1596  */
1597 static int dmz_handle_seq_write_err(struct dmz_metadata *zmd,
1598                                     struct dm_zone *zone)
1599 {
1600         struct dmz_dev *dev = dmz_zone_to_dev(zmd, zone);
1601         unsigned int wp = 0;
1602         int ret;
1603
1604         wp = zone->wp_block;
1605         ret = dmz_update_zone(zmd, zone);
1606         if (ret)
1607                 return ret;
1608
1609         dmz_dev_warn(dev, "Processing zone %u write error (zone wp %u/%u)",
1610                      zone->id, zone->wp_block, wp);
1611
1612         if (zone->wp_block < wp) {
1613                 dmz_invalidate_blocks(zmd, zone, zone->wp_block,
1614                                       wp - zone->wp_block);
1615         }
1616
1617         return 0;
1618 }
1619
1620 /*
1621  * Reset a zone write pointer.
1622  */
1623 static int dmz_reset_zone(struct dmz_metadata *zmd, struct dm_zone *zone)
1624 {
1625         int ret;
1626
1627         /*
1628          * Ignore offline zones, read only zones,
1629          * and conventional zones.
1630          */
1631         if (dmz_is_offline(zone) ||
1632             dmz_is_readonly(zone) ||
1633             dmz_is_rnd(zone))
1634                 return 0;
1635
1636         if (!dmz_is_empty(zone) || dmz_seq_write_err(zone)) {
1637                 struct dmz_dev *dev = dmz_zone_to_dev(zmd, zone);
1638
1639                 ret = blkdev_zone_mgmt(dev->bdev, REQ_OP_ZONE_RESET,
1640                                        dmz_start_sect(zmd, zone),
1641                                        zmd->zone_nr_sectors, GFP_NOIO);
1642                 if (ret) {
1643                         dmz_dev_err(dev, "Reset zone %u failed %d",
1644                                     zone->id, ret);
1645                         return ret;
1646                 }
1647         }
1648
1649         /* Clear write error bit and rewind write pointer position */
1650         clear_bit(DMZ_SEQ_WRITE_ERR, &zone->flags);
1651         zone->wp_block = 0;
1652
1653         return 0;
1654 }
1655
1656 static void dmz_get_zone_weight(struct dmz_metadata *zmd, struct dm_zone *zone);
1657
1658 /*
1659  * Initialize chunk mapping.
1660  */
1661 static int dmz_load_mapping(struct dmz_metadata *zmd)
1662 {
1663         struct dm_zone *dzone, *bzone;
1664         struct dmz_mblock *dmap_mblk = NULL;
1665         struct dmz_map *dmap;
1666         unsigned int i = 0, e = 0, chunk = 0;
1667         unsigned int dzone_id;
1668         unsigned int bzone_id;
1669
1670         /* Metadata block array for the chunk mapping table */
1671         zmd->map_mblk = kcalloc(zmd->nr_map_blocks,
1672                                 sizeof(struct dmz_mblk *), GFP_KERNEL);
1673         if (!zmd->map_mblk)
1674                 return -ENOMEM;
1675
1676         /* Get chunk mapping table blocks and initialize zone mapping */
1677         while (chunk < zmd->nr_chunks) {
1678                 if (!dmap_mblk) {
1679                         /* Get mapping block */
1680                         dmap_mblk = dmz_get_mblock(zmd, i + 1);
1681                         if (IS_ERR(dmap_mblk))
1682                                 return PTR_ERR(dmap_mblk);
1683                         zmd->map_mblk[i] = dmap_mblk;
1684                         dmap = (struct dmz_map *) dmap_mblk->data;
1685                         i++;
1686                         e = 0;
1687                 }
1688
1689                 /* Check data zone */
1690                 dzone_id = le32_to_cpu(dmap[e].dzone_id);
1691                 if (dzone_id == DMZ_MAP_UNMAPPED)
1692                         goto next;
1693
1694                 if (dzone_id >= zmd->nr_zones) {
1695                         dmz_zmd_err(zmd, "Chunk %u mapping: invalid data zone ID %u",
1696                                     chunk, dzone_id);
1697                         return -EIO;
1698                 }
1699
1700                 dzone = dmz_get(zmd, dzone_id);
1701                 if (!dzone) {
1702                         dmz_zmd_err(zmd, "Chunk %u mapping: data zone %u not present",
1703                                     chunk, dzone_id);
1704                         return -EIO;
1705                 }
1706                 set_bit(DMZ_DATA, &dzone->flags);
1707                 dzone->chunk = chunk;
1708                 dmz_get_zone_weight(zmd, dzone);
1709
1710                 if (dmz_is_cache(dzone))
1711                         list_add_tail(&dzone->link, &zmd->map_cache_list);
1712                 else if (dmz_is_rnd(dzone))
1713                         list_add_tail(&dzone->link, &zmd->map_rnd_list);
1714                 else
1715                         list_add_tail(&dzone->link, &zmd->map_seq_list);
1716
1717                 /* Check buffer zone */
1718                 bzone_id = le32_to_cpu(dmap[e].bzone_id);
1719                 if (bzone_id == DMZ_MAP_UNMAPPED)
1720                         goto next;
1721
1722                 if (bzone_id >= zmd->nr_zones) {
1723                         dmz_zmd_err(zmd, "Chunk %u mapping: invalid buffer zone ID %u",
1724                                     chunk, bzone_id);
1725                         return -EIO;
1726                 }
1727
1728                 bzone = dmz_get(zmd, bzone_id);
1729                 if (!bzone) {
1730                         dmz_zmd_err(zmd, "Chunk %u mapping: buffer zone %u not present",
1731                                     chunk, bzone_id);
1732                         return -EIO;
1733                 }
1734                 if (!dmz_is_rnd(bzone) && !dmz_is_cache(bzone)) {
1735                         dmz_zmd_err(zmd, "Chunk %u mapping: invalid buffer zone %u",
1736                                     chunk, bzone_id);
1737                         return -EIO;
1738                 }
1739
1740                 set_bit(DMZ_DATA, &bzone->flags);
1741                 set_bit(DMZ_BUF, &bzone->flags);
1742                 bzone->chunk = chunk;
1743                 bzone->bzone = dzone;
1744                 dzone->bzone = bzone;
1745                 dmz_get_zone_weight(zmd, bzone);
1746                 if (dmz_is_cache(bzone))
1747                         list_add_tail(&bzone->link, &zmd->map_cache_list);
1748                 else
1749                         list_add_tail(&bzone->link, &zmd->map_rnd_list);
1750 next:
1751                 chunk++;
1752                 e++;
1753                 if (e >= DMZ_MAP_ENTRIES)
1754                         dmap_mblk = NULL;
1755         }
1756
1757         /*
1758          * At this point, only meta zones and mapped data zones were
1759          * fully initialized. All remaining zones are unmapped data
1760          * zones. Finish initializing those here.
1761          */
1762         for (i = 0; i < zmd->nr_zones; i++) {
1763                 dzone = dmz_get(zmd, i);
1764                 if (!dzone)
1765                         continue;
1766                 if (dmz_is_meta(dzone))
1767                         continue;
1768                 if (dmz_is_offline(dzone))
1769                         continue;
1770
1771                 if (dmz_is_cache(dzone))
1772                         zmd->nr_cache++;
1773                 else if (dmz_is_rnd(dzone))
1774                         zmd->nr_rnd++;
1775                 else
1776                         zmd->nr_seq++;
1777
1778                 if (dmz_is_data(dzone)) {
1779                         /* Already initialized */
1780                         continue;
1781                 }
1782
1783                 /* Unmapped data zone */
1784                 set_bit(DMZ_DATA, &dzone->flags);
1785                 dzone->chunk = DMZ_MAP_UNMAPPED;
1786                 if (dmz_is_cache(dzone)) {
1787                         list_add_tail(&dzone->link, &zmd->unmap_cache_list);
1788                         atomic_inc(&zmd->unmap_nr_cache);
1789                 } else if (dmz_is_rnd(dzone)) {
1790                         list_add_tail(&dzone->link, &zmd->unmap_rnd_list);
1791                         atomic_inc(&zmd->unmap_nr_rnd);
1792                 } else if (atomic_read(&zmd->nr_reserved_seq_zones) < zmd->nr_reserved_seq) {
1793                         list_add_tail(&dzone->link, &zmd->reserved_seq_zones_list);
1794                         set_bit(DMZ_RESERVED, &dzone->flags);
1795                         atomic_inc(&zmd->nr_reserved_seq_zones);
1796                         zmd->nr_seq--;
1797                 } else {
1798                         list_add_tail(&dzone->link, &zmd->unmap_seq_list);
1799                         atomic_inc(&zmd->unmap_nr_seq);
1800                 }
1801         }
1802
1803         return 0;
1804 }
1805
1806 /*
1807  * Set a data chunk mapping.
1808  */
1809 static void dmz_set_chunk_mapping(struct dmz_metadata *zmd, unsigned int chunk,
1810                                   unsigned int dzone_id, unsigned int bzone_id)
1811 {
1812         struct dmz_mblock *dmap_mblk = zmd->map_mblk[chunk >> DMZ_MAP_ENTRIES_SHIFT];
1813         struct dmz_map *dmap = (struct dmz_map *) dmap_mblk->data;
1814         int map_idx = chunk & DMZ_MAP_ENTRIES_MASK;
1815
1816         dmap[map_idx].dzone_id = cpu_to_le32(dzone_id);
1817         dmap[map_idx].bzone_id = cpu_to_le32(bzone_id);
1818         dmz_dirty_mblock(zmd, dmap_mblk);
1819 }
1820
1821 /*
1822  * The list of mapped zones is maintained in LRU order.
1823  * This rotates a zone at the end of its map list.
1824  */
1825 static void __dmz_lru_zone(struct dmz_metadata *zmd, struct dm_zone *zone)
1826 {
1827         if (list_empty(&zone->link))
1828                 return;
1829
1830         list_del_init(&zone->link);
1831         if (dmz_is_seq(zone)) {
1832                 /* LRU rotate sequential zone */
1833                 list_add_tail(&zone->link, &zmd->map_seq_list);
1834         } else if (dmz_is_cache(zone)) {
1835                 /* LRU rotate cache zone */
1836                 list_add_tail(&zone->link, &zmd->map_cache_list);
1837         } else {
1838                 /* LRU rotate random zone */
1839                 list_add_tail(&zone->link, &zmd->map_rnd_list);
1840         }
1841 }
1842
1843 /*
1844  * The list of mapped random zones is maintained
1845  * in LRU order. This rotates a zone at the end of the list.
1846  */
1847 static void dmz_lru_zone(struct dmz_metadata *zmd, struct dm_zone *zone)
1848 {
1849         __dmz_lru_zone(zmd, zone);
1850         if (zone->bzone)
1851                 __dmz_lru_zone(zmd, zone->bzone);
1852 }
1853
1854 /*
1855  * Wait for any zone to be freed.
1856  */
1857 static void dmz_wait_for_free_zones(struct dmz_metadata *zmd)
1858 {
1859         DEFINE_WAIT(wait);
1860
1861         prepare_to_wait(&zmd->free_wq, &wait, TASK_UNINTERRUPTIBLE);
1862         dmz_unlock_map(zmd);
1863         dmz_unlock_metadata(zmd);
1864
1865         io_schedule_timeout(HZ);
1866
1867         dmz_lock_metadata(zmd);
1868         dmz_lock_map(zmd);
1869         finish_wait(&zmd->free_wq, &wait);
1870 }
1871
1872 /*
1873  * Lock a zone for reclaim (set the zone RECLAIM bit).
1874  * Returns false if the zone cannot be locked or if it is already locked
1875  * and 1 otherwise.
1876  */
1877 int dmz_lock_zone_reclaim(struct dm_zone *zone)
1878 {
1879         /* Active zones cannot be reclaimed */
1880         if (dmz_is_active(zone))
1881                 return 0;
1882
1883         return !test_and_set_bit(DMZ_RECLAIM, &zone->flags);
1884 }
1885
1886 /*
1887  * Clear a zone reclaim flag.
1888  */
1889 void dmz_unlock_zone_reclaim(struct dm_zone *zone)
1890 {
1891         WARN_ON(dmz_is_active(zone));
1892         WARN_ON(!dmz_in_reclaim(zone));
1893
1894         clear_bit_unlock(DMZ_RECLAIM, &zone->flags);
1895         smp_mb__after_atomic();
1896         wake_up_bit(&zone->flags, DMZ_RECLAIM);
1897 }
1898
1899 /*
1900  * Wait for a zone reclaim to complete.
1901  */
1902 static void dmz_wait_for_reclaim(struct dmz_metadata *zmd, struct dm_zone *zone)
1903 {
1904         dmz_unlock_map(zmd);
1905         dmz_unlock_metadata(zmd);
1906         set_bit(DMZ_RECLAIM_TERMINATE, &zone->flags);
1907         wait_on_bit_timeout(&zone->flags, DMZ_RECLAIM, TASK_UNINTERRUPTIBLE, HZ);
1908         clear_bit(DMZ_RECLAIM_TERMINATE, &zone->flags);
1909         dmz_lock_metadata(zmd);
1910         dmz_lock_map(zmd);
1911 }
1912
1913 /*
1914  * Select a cache or random write zone for reclaim.
1915  */
1916 static struct dm_zone *dmz_get_rnd_zone_for_reclaim(struct dmz_metadata *zmd,
1917                                                     bool idle)
1918 {
1919         struct dm_zone *dzone = NULL;
1920         struct dm_zone *zone;
1921         struct list_head *zone_list = &zmd->map_rnd_list;
1922
1923         /* If we have cache zones select from the cache zone list */
1924         if (zmd->nr_cache) {
1925                 zone_list = &zmd->map_cache_list;
1926                 /* Try to relaim random zones, too, when idle */
1927                 if (idle && list_empty(zone_list))
1928                         zone_list = &zmd->map_rnd_list;
1929         }
1930
1931         list_for_each_entry(zone, zone_list, link) {
1932                 if (dmz_is_buf(zone))
1933                         dzone = zone->bzone;
1934                 else
1935                         dzone = zone;
1936                 if (dmz_lock_zone_reclaim(dzone))
1937                         return dzone;
1938         }
1939
1940         return NULL;
1941 }
1942
1943 /*
1944  * Select a buffered sequential zone for reclaim.
1945  */
1946 static struct dm_zone *dmz_get_seq_zone_for_reclaim(struct dmz_metadata *zmd)
1947 {
1948         struct dm_zone *zone;
1949
1950         list_for_each_entry(zone, &zmd->map_seq_list, link) {
1951                 if (!zone->bzone)
1952                         continue;
1953                 if (dmz_lock_zone_reclaim(zone))
1954                         return zone;
1955         }
1956
1957         return NULL;
1958 }
1959
1960 /*
1961  * Select a zone for reclaim.
1962  */
1963 struct dm_zone *dmz_get_zone_for_reclaim(struct dmz_metadata *zmd, bool idle)
1964 {
1965         struct dm_zone *zone;
1966
1967         /*
1968          * Search for a zone candidate to reclaim: 2 cases are possible.
1969          * (1) There is no free sequential zones. Then a random data zone
1970          *     cannot be reclaimed. So choose a sequential zone to reclaim so
1971          *     that afterward a random zone can be reclaimed.
1972          * (2) At least one free sequential zone is available, then choose
1973          *     the oldest random zone (data or buffer) that can be locked.
1974          */
1975         dmz_lock_map(zmd);
1976         if (list_empty(&zmd->reserved_seq_zones_list))
1977                 zone = dmz_get_seq_zone_for_reclaim(zmd);
1978         else
1979                 zone = dmz_get_rnd_zone_for_reclaim(zmd, idle);
1980         dmz_unlock_map(zmd);
1981
1982         return zone;
1983 }
1984
1985 /*
1986  * Get the zone mapping a chunk, if the chunk is mapped already.
1987  * If no mapping exist and the operation is WRITE, a zone is
1988  * allocated and used to map the chunk.
1989  * The zone returned will be set to the active state.
1990  */
1991 struct dm_zone *dmz_get_chunk_mapping(struct dmz_metadata *zmd, unsigned int chunk, int op)
1992 {
1993         struct dmz_mblock *dmap_mblk = zmd->map_mblk[chunk >> DMZ_MAP_ENTRIES_SHIFT];
1994         struct dmz_map *dmap = (struct dmz_map *) dmap_mblk->data;
1995         int dmap_idx = chunk & DMZ_MAP_ENTRIES_MASK;
1996         unsigned int dzone_id;
1997         struct dm_zone *dzone = NULL;
1998         int ret = 0;
1999         int alloc_flags = zmd->nr_cache ? DMZ_ALLOC_CACHE : DMZ_ALLOC_RND;
2000
2001         dmz_lock_map(zmd);
2002 again:
2003         /* Get the chunk mapping */
2004         dzone_id = le32_to_cpu(dmap[dmap_idx].dzone_id);
2005         if (dzone_id == DMZ_MAP_UNMAPPED) {
2006                 /*
2007                  * Read or discard in unmapped chunks are fine. But for
2008                  * writes, we need a mapping, so get one.
2009                  */
2010                 if (op != REQ_OP_WRITE)
2011                         goto out;
2012
2013                 /* Allocate a random zone */
2014                 dzone = dmz_alloc_zone(zmd, alloc_flags);
2015                 if (!dzone) {
2016                         if (dmz_dev_is_dying(zmd)) {
2017                                 dzone = ERR_PTR(-EIO);
2018                                 goto out;
2019                         }
2020                         dmz_wait_for_free_zones(zmd);
2021                         goto again;
2022                 }
2023
2024                 dmz_map_zone(zmd, dzone, chunk);
2025
2026         } else {
2027                 /* The chunk is already mapped: get the mapping zone */
2028                 dzone = dmz_get(zmd, dzone_id);
2029                 if (!dzone) {
2030                         dzone = ERR_PTR(-EIO);
2031                         goto out;
2032                 }
2033                 if (dzone->chunk != chunk) {
2034                         dzone = ERR_PTR(-EIO);
2035                         goto out;
2036                 }
2037
2038                 /* Repair write pointer if the sequential dzone has error */
2039                 if (dmz_seq_write_err(dzone)) {
2040                         ret = dmz_handle_seq_write_err(zmd, dzone);
2041                         if (ret) {
2042                                 dzone = ERR_PTR(-EIO);
2043                                 goto out;
2044                         }
2045                         clear_bit(DMZ_SEQ_WRITE_ERR, &dzone->flags);
2046                 }
2047         }
2048
2049         /*
2050          * If the zone is being reclaimed, the chunk mapping may change
2051          * to a different zone. So wait for reclaim and retry. Otherwise,
2052          * activate the zone (this will prevent reclaim from touching it).
2053          */
2054         if (dmz_in_reclaim(dzone)) {
2055                 dmz_wait_for_reclaim(zmd, dzone);
2056                 goto again;
2057         }
2058         dmz_activate_zone(dzone);
2059         dmz_lru_zone(zmd, dzone);
2060 out:
2061         dmz_unlock_map(zmd);
2062
2063         return dzone;
2064 }
2065
2066 /*
2067  * Write and discard change the block validity of data zones and their buffer
2068  * zones. Check here that valid blocks are still present. If all blocks are
2069  * invalid, the zones can be unmapped on the fly without waiting for reclaim
2070  * to do it.
2071  */
2072 void dmz_put_chunk_mapping(struct dmz_metadata *zmd, struct dm_zone *dzone)
2073 {
2074         struct dm_zone *bzone;
2075
2076         dmz_lock_map(zmd);
2077
2078         bzone = dzone->bzone;
2079         if (bzone) {
2080                 if (dmz_weight(bzone))
2081                         dmz_lru_zone(zmd, bzone);
2082                 else {
2083                         /* Empty buffer zone: reclaim it */
2084                         dmz_unmap_zone(zmd, bzone);
2085                         dmz_free_zone(zmd, bzone);
2086                         bzone = NULL;
2087                 }
2088         }
2089
2090         /* Deactivate the data zone */
2091         dmz_deactivate_zone(dzone);
2092         if (dmz_is_active(dzone) || bzone || dmz_weight(dzone))
2093                 dmz_lru_zone(zmd, dzone);
2094         else {
2095                 /* Unbuffered inactive empty data zone: reclaim it */
2096                 dmz_unmap_zone(zmd, dzone);
2097                 dmz_free_zone(zmd, dzone);
2098         }
2099
2100         dmz_unlock_map(zmd);
2101 }
2102
2103 /*
2104  * Allocate and map a random zone to buffer a chunk
2105  * already mapped to a sequential zone.
2106  */
2107 struct dm_zone *dmz_get_chunk_buffer(struct dmz_metadata *zmd,
2108                                      struct dm_zone *dzone)
2109 {
2110         struct dm_zone *bzone;
2111         int alloc_flags = zmd->nr_cache ? DMZ_ALLOC_CACHE : DMZ_ALLOC_RND;
2112
2113         dmz_lock_map(zmd);
2114 again:
2115         bzone = dzone->bzone;
2116         if (bzone)
2117                 goto out;
2118
2119         /* Allocate a random zone */
2120         bzone = dmz_alloc_zone(zmd, alloc_flags);
2121         if (!bzone) {
2122                 if (dmz_dev_is_dying(zmd)) {
2123                         bzone = ERR_PTR(-EIO);
2124                         goto out;
2125                 }
2126                 dmz_wait_for_free_zones(zmd);
2127                 goto again;
2128         }
2129
2130         /* Update the chunk mapping */
2131         dmz_set_chunk_mapping(zmd, dzone->chunk, dzone->id, bzone->id);
2132
2133         set_bit(DMZ_BUF, &bzone->flags);
2134         bzone->chunk = dzone->chunk;
2135         bzone->bzone = dzone;
2136         dzone->bzone = bzone;
2137         if (dmz_is_cache(bzone))
2138                 list_add_tail(&bzone->link, &zmd->map_cache_list);
2139         else
2140                 list_add_tail(&bzone->link, &zmd->map_rnd_list);
2141 out:
2142         dmz_unlock_map(zmd);
2143
2144         return bzone;
2145 }
2146
2147 /*
2148  * Get an unmapped (free) zone.
2149  * This must be called with the mapping lock held.
2150  */
2151 struct dm_zone *dmz_alloc_zone(struct dmz_metadata *zmd, unsigned long flags)
2152 {
2153         struct list_head *list;
2154         struct dm_zone *zone;
2155
2156         if (flags & DMZ_ALLOC_CACHE)
2157                 list = &zmd->unmap_cache_list;
2158         else if (flags & DMZ_ALLOC_RND)
2159                 list = &zmd->unmap_rnd_list;
2160         else
2161                 list = &zmd->unmap_seq_list;
2162
2163 again:
2164         if (list_empty(list)) {
2165                 /*
2166                  * No free zone: return NULL if this is for not reclaim.
2167                  */
2168                 if (!(flags & DMZ_ALLOC_RECLAIM))
2169                         return NULL;
2170                 /*
2171                  * Fallback to the reserved sequential zones
2172                  */
2173                 zone = list_first_entry_or_null(&zmd->reserved_seq_zones_list,
2174                                                 struct dm_zone, link);
2175                 if (zone) {
2176                         list_del_init(&zone->link);
2177                         atomic_dec(&zmd->nr_reserved_seq_zones);
2178                 }
2179                 return zone;
2180         }
2181
2182         zone = list_first_entry(list, struct dm_zone, link);
2183         list_del_init(&zone->link);
2184
2185         if (dmz_is_cache(zone))
2186                 atomic_dec(&zmd->unmap_nr_cache);
2187         else if (dmz_is_rnd(zone))
2188                 atomic_dec(&zmd->unmap_nr_rnd);
2189         else
2190                 atomic_dec(&zmd->unmap_nr_seq);
2191
2192         if (dmz_is_offline(zone)) {
2193                 dmz_zmd_warn(zmd, "Zone %u is offline", zone->id);
2194                 zone = NULL;
2195                 goto again;
2196         }
2197         if (dmz_is_meta(zone)) {
2198                 struct dmz_dev *dev = dmz_zone_to_dev(zmd, zone);
2199
2200                 dmz_dev_warn(dev, "Zone %u has metadata", zone->id);
2201                 zone = NULL;
2202                 goto again;
2203         }
2204         return zone;
2205 }
2206
2207 /*
2208  * Free a zone.
2209  * This must be called with the mapping lock held.
2210  */
2211 void dmz_free_zone(struct dmz_metadata *zmd, struct dm_zone *zone)
2212 {
2213         /* If this is a sequential zone, reset it */
2214         if (dmz_is_seq(zone))
2215                 dmz_reset_zone(zmd, zone);
2216
2217         /* Return the zone to its type unmap list */
2218         if (dmz_is_cache(zone)) {
2219                 list_add_tail(&zone->link, &zmd->unmap_cache_list);
2220                 atomic_inc(&zmd->unmap_nr_cache);
2221         } else if (dmz_is_rnd(zone)) {
2222                 list_add_tail(&zone->link, &zmd->unmap_rnd_list);
2223                 atomic_inc(&zmd->unmap_nr_rnd);
2224         } else if (dmz_is_reserved(zone)) {
2225                 list_add_tail(&zone->link, &zmd->reserved_seq_zones_list);
2226                 atomic_inc(&zmd->nr_reserved_seq_zones);
2227         } else {
2228                 list_add_tail(&zone->link, &zmd->unmap_seq_list);
2229                 atomic_inc(&zmd->unmap_nr_seq);
2230         }
2231
2232         wake_up_all(&zmd->free_wq);
2233 }
2234
2235 /*
2236  * Map a chunk to a zone.
2237  * This must be called with the mapping lock held.
2238  */
2239 void dmz_map_zone(struct dmz_metadata *zmd, struct dm_zone *dzone,
2240                   unsigned int chunk)
2241 {
2242         /* Set the chunk mapping */
2243         dmz_set_chunk_mapping(zmd, chunk, dzone->id,
2244                               DMZ_MAP_UNMAPPED);
2245         dzone->chunk = chunk;
2246         if (dmz_is_cache(dzone))
2247                 list_add_tail(&dzone->link, &zmd->map_cache_list);
2248         else if (dmz_is_rnd(dzone))
2249                 list_add_tail(&dzone->link, &zmd->map_rnd_list);
2250         else
2251                 list_add_tail(&dzone->link, &zmd->map_seq_list);
2252 }
2253
2254 /*
2255  * Unmap a zone.
2256  * This must be called with the mapping lock held.
2257  */
2258 void dmz_unmap_zone(struct dmz_metadata *zmd, struct dm_zone *zone)
2259 {
2260         unsigned int chunk = zone->chunk;
2261         unsigned int dzone_id;
2262
2263         if (chunk == DMZ_MAP_UNMAPPED) {
2264                 /* Already unmapped */
2265                 return;
2266         }
2267
2268         if (test_and_clear_bit(DMZ_BUF, &zone->flags)) {
2269                 /*
2270                  * Unmapping the chunk buffer zone: clear only
2271                  * the chunk buffer mapping
2272                  */
2273                 dzone_id = zone->bzone->id;
2274                 zone->bzone->bzone = NULL;
2275                 zone->bzone = NULL;
2276
2277         } else {
2278                 /*
2279                  * Unmapping the chunk data zone: the zone must
2280                  * not be buffered.
2281                  */
2282                 if (WARN_ON(zone->bzone)) {
2283                         zone->bzone->bzone = NULL;
2284                         zone->bzone = NULL;
2285                 }
2286                 dzone_id = DMZ_MAP_UNMAPPED;
2287         }
2288
2289         dmz_set_chunk_mapping(zmd, chunk, dzone_id, DMZ_MAP_UNMAPPED);
2290
2291         zone->chunk = DMZ_MAP_UNMAPPED;
2292         list_del_init(&zone->link);
2293 }
2294
2295 /*
2296  * Set @nr_bits bits in @bitmap starting from @bit.
2297  * Return the number of bits changed from 0 to 1.
2298  */
2299 static unsigned int dmz_set_bits(unsigned long *bitmap,
2300                                  unsigned int bit, unsigned int nr_bits)
2301 {
2302         unsigned long *addr;
2303         unsigned int end = bit + nr_bits;
2304         unsigned int n = 0;
2305
2306         while (bit < end) {
2307                 if (((bit & (BITS_PER_LONG - 1)) == 0) &&
2308                     ((end - bit) >= BITS_PER_LONG)) {
2309                         /* Try to set the whole word at once */
2310                         addr = bitmap + BIT_WORD(bit);
2311                         if (*addr == 0) {
2312                                 *addr = ULONG_MAX;
2313                                 n += BITS_PER_LONG;
2314                                 bit += BITS_PER_LONG;
2315                                 continue;
2316                         }
2317                 }
2318
2319                 if (!test_and_set_bit(bit, bitmap))
2320                         n++;
2321                 bit++;
2322         }
2323
2324         return n;
2325 }
2326
2327 /*
2328  * Get the bitmap block storing the bit for chunk_block in zone.
2329  */
2330 static struct dmz_mblock *dmz_get_bitmap(struct dmz_metadata *zmd,
2331                                          struct dm_zone *zone,
2332                                          sector_t chunk_block)
2333 {
2334         sector_t bitmap_block = 1 + zmd->nr_map_blocks +
2335                 (sector_t)(zone->id * zmd->zone_nr_bitmap_blocks) +
2336                 (chunk_block >> DMZ_BLOCK_SHIFT_BITS);
2337
2338         return dmz_get_mblock(zmd, bitmap_block);
2339 }
2340
2341 /*
2342  * Copy the valid blocks bitmap of from_zone to the bitmap of to_zone.
2343  */
2344 int dmz_copy_valid_blocks(struct dmz_metadata *zmd, struct dm_zone *from_zone,
2345                           struct dm_zone *to_zone)
2346 {
2347         struct dmz_mblock *from_mblk, *to_mblk;
2348         sector_t chunk_block = 0;
2349
2350         /* Get the zones bitmap blocks */
2351         while (chunk_block < zmd->zone_nr_blocks) {
2352                 from_mblk = dmz_get_bitmap(zmd, from_zone, chunk_block);
2353                 if (IS_ERR(from_mblk))
2354                         return PTR_ERR(from_mblk);
2355                 to_mblk = dmz_get_bitmap(zmd, to_zone, chunk_block);
2356                 if (IS_ERR(to_mblk)) {
2357                         dmz_release_mblock(zmd, from_mblk);
2358                         return PTR_ERR(to_mblk);
2359                 }
2360
2361                 memcpy(to_mblk->data, from_mblk->data, DMZ_BLOCK_SIZE);
2362                 dmz_dirty_mblock(zmd, to_mblk);
2363
2364                 dmz_release_mblock(zmd, to_mblk);
2365                 dmz_release_mblock(zmd, from_mblk);
2366
2367                 chunk_block += zmd->zone_bits_per_mblk;
2368         }
2369
2370         to_zone->weight = from_zone->weight;
2371
2372         return 0;
2373 }
2374
2375 /*
2376  * Merge the valid blocks bitmap of from_zone into the bitmap of to_zone,
2377  * starting from chunk_block.
2378  */
2379 int dmz_merge_valid_blocks(struct dmz_metadata *zmd, struct dm_zone *from_zone,
2380                            struct dm_zone *to_zone, sector_t chunk_block)
2381 {
2382         unsigned int nr_blocks;
2383         int ret;
2384
2385         /* Get the zones bitmap blocks */
2386         while (chunk_block < zmd->zone_nr_blocks) {
2387                 /* Get a valid region from the source zone */
2388                 ret = dmz_first_valid_block(zmd, from_zone, &chunk_block);
2389                 if (ret <= 0)
2390                         return ret;
2391
2392                 nr_blocks = ret;
2393                 ret = dmz_validate_blocks(zmd, to_zone, chunk_block, nr_blocks);
2394                 if (ret)
2395                         return ret;
2396
2397                 chunk_block += nr_blocks;
2398         }
2399
2400         return 0;
2401 }
2402
2403 /*
2404  * Validate all the blocks in the range [block..block+nr_blocks-1].
2405  */
2406 int dmz_validate_blocks(struct dmz_metadata *zmd, struct dm_zone *zone,
2407                         sector_t chunk_block, unsigned int nr_blocks)
2408 {
2409         unsigned int count, bit, nr_bits;
2410         unsigned int zone_nr_blocks = zmd->zone_nr_blocks;
2411         struct dmz_mblock *mblk;
2412         unsigned int n = 0;
2413
2414         dmz_zmd_debug(zmd, "=> VALIDATE zone %u, block %llu, %u blocks",
2415                       zone->id, (unsigned long long)chunk_block,
2416                       nr_blocks);
2417
2418         WARN_ON(chunk_block + nr_blocks > zone_nr_blocks);
2419
2420         while (nr_blocks) {
2421                 /* Get bitmap block */
2422                 mblk = dmz_get_bitmap(zmd, zone, chunk_block);
2423                 if (IS_ERR(mblk))
2424                         return PTR_ERR(mblk);
2425
2426                 /* Set bits */
2427                 bit = chunk_block & DMZ_BLOCK_MASK_BITS;
2428                 nr_bits = min(nr_blocks, zmd->zone_bits_per_mblk - bit);
2429
2430                 count = dmz_set_bits((unsigned long *)mblk->data, bit, nr_bits);
2431                 if (count) {
2432                         dmz_dirty_mblock(zmd, mblk);
2433                         n += count;
2434                 }
2435                 dmz_release_mblock(zmd, mblk);
2436
2437                 nr_blocks -= nr_bits;
2438                 chunk_block += nr_bits;
2439         }
2440
2441         if (likely(zone->weight + n <= zone_nr_blocks))
2442                 zone->weight += n;
2443         else {
2444                 dmz_zmd_warn(zmd, "Zone %u: weight %u should be <= %u",
2445                              zone->id, zone->weight,
2446                              zone_nr_blocks - n);
2447                 zone->weight = zone_nr_blocks;
2448         }
2449
2450         return 0;
2451 }
2452
2453 /*
2454  * Clear nr_bits bits in bitmap starting from bit.
2455  * Return the number of bits cleared.
2456  */
2457 static int dmz_clear_bits(unsigned long *bitmap, int bit, int nr_bits)
2458 {
2459         unsigned long *addr;
2460         int end = bit + nr_bits;
2461         int n = 0;
2462
2463         while (bit < end) {
2464                 if (((bit & (BITS_PER_LONG - 1)) == 0) &&
2465                     ((end - bit) >= BITS_PER_LONG)) {
2466                         /* Try to clear whole word at once */
2467                         addr = bitmap + BIT_WORD(bit);
2468                         if (*addr == ULONG_MAX) {
2469                                 *addr = 0;
2470                                 n += BITS_PER_LONG;
2471                                 bit += BITS_PER_LONG;
2472                                 continue;
2473                         }
2474                 }
2475
2476                 if (test_and_clear_bit(bit, bitmap))
2477                         n++;
2478                 bit++;
2479         }
2480
2481         return n;
2482 }
2483
2484 /*
2485  * Invalidate all the blocks in the range [block..block+nr_blocks-1].
2486  */
2487 int dmz_invalidate_blocks(struct dmz_metadata *zmd, struct dm_zone *zone,
2488                           sector_t chunk_block, unsigned int nr_blocks)
2489 {
2490         unsigned int count, bit, nr_bits;
2491         struct dmz_mblock *mblk;
2492         unsigned int n = 0;
2493
2494         dmz_zmd_debug(zmd, "=> INVALIDATE zone %u, block %llu, %u blocks",
2495                       zone->id, (u64)chunk_block, nr_blocks);
2496
2497         WARN_ON(chunk_block + nr_blocks > zmd->zone_nr_blocks);
2498
2499         while (nr_blocks) {
2500                 /* Get bitmap block */
2501                 mblk = dmz_get_bitmap(zmd, zone, chunk_block);
2502                 if (IS_ERR(mblk))
2503                         return PTR_ERR(mblk);
2504
2505                 /* Clear bits */
2506                 bit = chunk_block & DMZ_BLOCK_MASK_BITS;
2507                 nr_bits = min(nr_blocks, zmd->zone_bits_per_mblk - bit);
2508
2509                 count = dmz_clear_bits((unsigned long *)mblk->data,
2510                                        bit, nr_bits);
2511                 if (count) {
2512                         dmz_dirty_mblock(zmd, mblk);
2513                         n += count;
2514                 }
2515                 dmz_release_mblock(zmd, mblk);
2516
2517                 nr_blocks -= nr_bits;
2518                 chunk_block += nr_bits;
2519         }
2520
2521         if (zone->weight >= n)
2522                 zone->weight -= n;
2523         else {
2524                 dmz_zmd_warn(zmd, "Zone %u: weight %u should be >= %u",
2525                              zone->id, zone->weight, n);
2526                 zone->weight = 0;
2527         }
2528
2529         return 0;
2530 }
2531
2532 /*
2533  * Get a block bit value.
2534  */
2535 static int dmz_test_block(struct dmz_metadata *zmd, struct dm_zone *zone,
2536                           sector_t chunk_block)
2537 {
2538         struct dmz_mblock *mblk;
2539         int ret;
2540
2541         WARN_ON(chunk_block >= zmd->zone_nr_blocks);
2542
2543         /* Get bitmap block */
2544         mblk = dmz_get_bitmap(zmd, zone, chunk_block);
2545         if (IS_ERR(mblk))
2546                 return PTR_ERR(mblk);
2547
2548         /* Get offset */
2549         ret = test_bit(chunk_block & DMZ_BLOCK_MASK_BITS,
2550                        (unsigned long *) mblk->data) != 0;
2551
2552         dmz_release_mblock(zmd, mblk);
2553
2554         return ret;
2555 }
2556
2557 /*
2558  * Return the number of blocks from chunk_block to the first block with a bit
2559  * value specified by set. Search at most nr_blocks blocks from chunk_block.
2560  */
2561 static int dmz_to_next_set_block(struct dmz_metadata *zmd, struct dm_zone *zone,
2562                                  sector_t chunk_block, unsigned int nr_blocks,
2563                                  int set)
2564 {
2565         struct dmz_mblock *mblk;
2566         unsigned int bit, set_bit, nr_bits;
2567         unsigned int zone_bits = zmd->zone_bits_per_mblk;
2568         unsigned long *bitmap;
2569         int n = 0;
2570
2571         WARN_ON(chunk_block + nr_blocks > zmd->zone_nr_blocks);
2572
2573         while (nr_blocks) {
2574                 /* Get bitmap block */
2575                 mblk = dmz_get_bitmap(zmd, zone, chunk_block);
2576                 if (IS_ERR(mblk))
2577                         return PTR_ERR(mblk);
2578
2579                 /* Get offset */
2580                 bitmap = (unsigned long *) mblk->data;
2581                 bit = chunk_block & DMZ_BLOCK_MASK_BITS;
2582                 nr_bits = min(nr_blocks, zone_bits - bit);
2583                 if (set)
2584                         set_bit = find_next_bit(bitmap, zone_bits, bit);
2585                 else
2586                         set_bit = find_next_zero_bit(bitmap, zone_bits, bit);
2587                 dmz_release_mblock(zmd, mblk);
2588
2589                 n += set_bit - bit;
2590                 if (set_bit < zone_bits)
2591                         break;
2592
2593                 nr_blocks -= nr_bits;
2594                 chunk_block += nr_bits;
2595         }
2596
2597         return n;
2598 }
2599
2600 /*
2601  * Test if chunk_block is valid. If it is, the number of consecutive
2602  * valid blocks from chunk_block will be returned.
2603  */
2604 int dmz_block_valid(struct dmz_metadata *zmd, struct dm_zone *zone,
2605                     sector_t chunk_block)
2606 {
2607         int valid;
2608
2609         valid = dmz_test_block(zmd, zone, chunk_block);
2610         if (valid <= 0)
2611                 return valid;
2612
2613         /* The block is valid: get the number of valid blocks from block */
2614         return dmz_to_next_set_block(zmd, zone, chunk_block,
2615                                      zmd->zone_nr_blocks - chunk_block, 0);
2616 }
2617
2618 /*
2619  * Find the first valid block from @chunk_block in @zone.
2620  * If such a block is found, its number is returned using
2621  * @chunk_block and the total number of valid blocks from @chunk_block
2622  * is returned.
2623  */
2624 int dmz_first_valid_block(struct dmz_metadata *zmd, struct dm_zone *zone,
2625                           sector_t *chunk_block)
2626 {
2627         sector_t start_block = *chunk_block;
2628         int ret;
2629
2630         ret = dmz_to_next_set_block(zmd, zone, start_block,
2631                                     zmd->zone_nr_blocks - start_block, 1);
2632         if (ret < 0)
2633                 return ret;
2634
2635         start_block += ret;
2636         *chunk_block = start_block;
2637
2638         return dmz_to_next_set_block(zmd, zone, start_block,
2639                                      zmd->zone_nr_blocks - start_block, 0);
2640 }
2641
2642 /*
2643  * Count the number of bits set starting from bit up to bit + nr_bits - 1.
2644  */
2645 static int dmz_count_bits(void *bitmap, int bit, int nr_bits)
2646 {
2647         unsigned long *addr;
2648         int end = bit + nr_bits;
2649         int n = 0;
2650
2651         while (bit < end) {
2652                 if (((bit & (BITS_PER_LONG - 1)) == 0) &&
2653                     ((end - bit) >= BITS_PER_LONG)) {
2654                         addr = (unsigned long *)bitmap + BIT_WORD(bit);
2655                         if (*addr == ULONG_MAX) {
2656                                 n += BITS_PER_LONG;
2657                                 bit += BITS_PER_LONG;
2658                                 continue;
2659                         }
2660                 }
2661
2662                 if (test_bit(bit, bitmap))
2663                         n++;
2664                 bit++;
2665         }
2666
2667         return n;
2668 }
2669
2670 /*
2671  * Get a zone weight.
2672  */
2673 static void dmz_get_zone_weight(struct dmz_metadata *zmd, struct dm_zone *zone)
2674 {
2675         struct dmz_mblock *mblk;
2676         sector_t chunk_block = 0;
2677         unsigned int bit, nr_bits;
2678         unsigned int nr_blocks = zmd->zone_nr_blocks;
2679         void *bitmap;
2680         int n = 0;
2681
2682         while (nr_blocks) {
2683                 /* Get bitmap block */
2684                 mblk = dmz_get_bitmap(zmd, zone, chunk_block);
2685                 if (IS_ERR(mblk)) {
2686                         n = 0;
2687                         break;
2688                 }
2689
2690                 /* Count bits in this block */
2691                 bitmap = mblk->data;
2692                 bit = chunk_block & DMZ_BLOCK_MASK_BITS;
2693                 nr_bits = min(nr_blocks, zmd->zone_bits_per_mblk - bit);
2694                 n += dmz_count_bits(bitmap, bit, nr_bits);
2695
2696                 dmz_release_mblock(zmd, mblk);
2697
2698                 nr_blocks -= nr_bits;
2699                 chunk_block += nr_bits;
2700         }
2701
2702         zone->weight = n;
2703 }
2704
2705 /*
2706  * Cleanup the zoned metadata resources.
2707  */
2708 static void dmz_cleanup_metadata(struct dmz_metadata *zmd)
2709 {
2710         struct rb_root *root;
2711         struct dmz_mblock *mblk, *next;
2712         int i;
2713
2714         /* Release zone mapping resources */
2715         if (zmd->map_mblk) {
2716                 for (i = 0; i < zmd->nr_map_blocks; i++)
2717                         dmz_release_mblock(zmd, zmd->map_mblk[i]);
2718                 kfree(zmd->map_mblk);
2719                 zmd->map_mblk = NULL;
2720         }
2721
2722         /* Release super blocks */
2723         for (i = 0; i < 2; i++) {
2724                 if (zmd->sb[i].mblk) {
2725                         dmz_free_mblock(zmd, zmd->sb[i].mblk);
2726                         zmd->sb[i].mblk = NULL;
2727                 }
2728         }
2729
2730         /* Free cached blocks */
2731         while (!list_empty(&zmd->mblk_dirty_list)) {
2732                 mblk = list_first_entry(&zmd->mblk_dirty_list,
2733                                         struct dmz_mblock, link);
2734                 dmz_zmd_warn(zmd, "mblock %llu still in dirty list (ref %u)",
2735                              (u64)mblk->no, mblk->ref);
2736                 list_del_init(&mblk->link);
2737                 rb_erase(&mblk->node, &zmd->mblk_rbtree);
2738                 dmz_free_mblock(zmd, mblk);
2739         }
2740
2741         while (!list_empty(&zmd->mblk_lru_list)) {
2742                 mblk = list_first_entry(&zmd->mblk_lru_list,
2743                                         struct dmz_mblock, link);
2744                 list_del_init(&mblk->link);
2745                 rb_erase(&mblk->node, &zmd->mblk_rbtree);
2746                 dmz_free_mblock(zmd, mblk);
2747         }
2748
2749         /* Sanity checks: the mblock rbtree should now be empty */
2750         root = &zmd->mblk_rbtree;
2751         rbtree_postorder_for_each_entry_safe(mblk, next, root, node) {
2752                 dmz_zmd_warn(zmd, "mblock %llu ref %u still in rbtree",
2753                              (u64)mblk->no, mblk->ref);
2754                 mblk->ref = 0;
2755                 dmz_free_mblock(zmd, mblk);
2756         }
2757
2758         /* Free the zone descriptors */
2759         dmz_drop_zones(zmd);
2760
2761         mutex_destroy(&zmd->mblk_flush_lock);
2762         mutex_destroy(&zmd->map_lock);
2763 }
2764
2765 static void dmz_print_dev(struct dmz_metadata *zmd, int num)
2766 {
2767         struct dmz_dev *dev = &zmd->dev[num];
2768
2769         if (bdev_zoned_model(dev->bdev) == BLK_ZONED_NONE)
2770                 dmz_dev_info(dev, "Regular block device");
2771         else
2772                 dmz_dev_info(dev, "Host-%s zoned block device",
2773                              bdev_zoned_model(dev->bdev) == BLK_ZONED_HA ?
2774                              "aware" : "managed");
2775         if (zmd->sb_version > 1) {
2776                 sector_t sector_offset =
2777                         dev->zone_offset << zmd->zone_nr_sectors_shift;
2778
2779                 dmz_dev_info(dev, "  %llu 512-byte logical sectors (offset %llu)",
2780                              (u64)dev->capacity, (u64)sector_offset);
2781                 dmz_dev_info(dev, "  %u zones of %llu 512-byte logical sectors (offset %llu)",
2782                              dev->nr_zones, (u64)zmd->zone_nr_sectors,
2783                              (u64)dev->zone_offset);
2784         } else {
2785                 dmz_dev_info(dev, "  %llu 512-byte logical sectors",
2786                              (u64)dev->capacity);
2787                 dmz_dev_info(dev, "  %u zones of %llu 512-byte logical sectors",
2788                              dev->nr_zones, (u64)zmd->zone_nr_sectors);
2789         }
2790 }
2791
2792 /*
2793  * Initialize the zoned metadata.
2794  */
2795 int dmz_ctr_metadata(struct dmz_dev *dev, int num_dev,
2796                      struct dmz_metadata **metadata,
2797                      const char *devname)
2798 {
2799         struct dmz_metadata *zmd;
2800         unsigned int i;
2801         struct dm_zone *zone;
2802         int ret;
2803
2804         zmd = kzalloc(sizeof(struct dmz_metadata), GFP_KERNEL);
2805         if (!zmd)
2806                 return -ENOMEM;
2807
2808         strcpy(zmd->devname, devname);
2809         zmd->dev = dev;
2810         zmd->nr_devs = num_dev;
2811         zmd->mblk_rbtree = RB_ROOT;
2812         init_rwsem(&zmd->mblk_sem);
2813         mutex_init(&zmd->mblk_flush_lock);
2814         spin_lock_init(&zmd->mblk_lock);
2815         INIT_LIST_HEAD(&zmd->mblk_lru_list);
2816         INIT_LIST_HEAD(&zmd->mblk_dirty_list);
2817
2818         mutex_init(&zmd->map_lock);
2819         atomic_set(&zmd->unmap_nr_rnd, 0);
2820         INIT_LIST_HEAD(&zmd->unmap_rnd_list);
2821         INIT_LIST_HEAD(&zmd->map_rnd_list);
2822
2823         atomic_set(&zmd->unmap_nr_cache, 0);
2824         INIT_LIST_HEAD(&zmd->unmap_cache_list);
2825         INIT_LIST_HEAD(&zmd->map_cache_list);
2826
2827         atomic_set(&zmd->unmap_nr_seq, 0);
2828         INIT_LIST_HEAD(&zmd->unmap_seq_list);
2829         INIT_LIST_HEAD(&zmd->map_seq_list);
2830
2831         atomic_set(&zmd->nr_reserved_seq_zones, 0);
2832         INIT_LIST_HEAD(&zmd->reserved_seq_zones_list);
2833
2834         init_waitqueue_head(&zmd->free_wq);
2835
2836         /* Initialize zone descriptors */
2837         ret = dmz_init_zones(zmd);
2838         if (ret)
2839                 goto err;
2840
2841         /* Get super block */
2842         ret = dmz_load_sb(zmd);
2843         if (ret)
2844                 goto err;
2845
2846         /* Set metadata zones starting from sb_zone */
2847         for (i = 0; i < zmd->nr_meta_zones << 1; i++) {
2848                 zone = dmz_get(zmd, zmd->sb[0].zone->id + i);
2849                 if (!zone) {
2850                         dmz_zmd_err(zmd,
2851                                     "metadata zone %u not present", i);
2852                         ret = -ENXIO;
2853                         goto err;
2854                 }
2855                 if (!dmz_is_rnd(zone) && !dmz_is_cache(zone)) {
2856                         dmz_zmd_err(zmd,
2857                                     "metadata zone %d is not random", i);
2858                         ret = -ENXIO;
2859                         goto err;
2860                 }
2861                 set_bit(DMZ_META, &zone->flags);
2862         }
2863         if (zmd->sb[2].zone) {
2864                 zone = dmz_get(zmd, zmd->sb[2].zone->id);
2865                 if (!zone) {
2866                         dmz_zmd_err(zmd,
2867                                     "Tertiary metadata zone not present");
2868                         ret = -ENXIO;
2869                         goto err;
2870                 }
2871                 set_bit(DMZ_META, &zone->flags);
2872         }
2873         /* Load mapping table */
2874         ret = dmz_load_mapping(zmd);
2875         if (ret)
2876                 goto err;
2877
2878         /*
2879          * Cache size boundaries: allow at least 2 super blocks, the chunk map
2880          * blocks and enough blocks to be able to cache the bitmap blocks of
2881          * up to 16 zones when idle (min_nr_mblks). Otherwise, if busy, allow
2882          * the cache to add 512 more metadata blocks.
2883          */
2884         zmd->min_nr_mblks = 2 + zmd->nr_map_blocks + zmd->zone_nr_bitmap_blocks * 16;
2885         zmd->max_nr_mblks = zmd->min_nr_mblks + 512;
2886         zmd->mblk_shrinker.count_objects = dmz_mblock_shrinker_count;
2887         zmd->mblk_shrinker.scan_objects = dmz_mblock_shrinker_scan;
2888         zmd->mblk_shrinker.seeks = DEFAULT_SEEKS;
2889
2890         /* Metadata cache shrinker */
2891         ret = register_shrinker(&zmd->mblk_shrinker);
2892         if (ret) {
2893                 dmz_zmd_err(zmd, "Register metadata cache shrinker failed");
2894                 goto err;
2895         }
2896
2897         dmz_zmd_info(zmd, "DM-Zoned metadata version %d", zmd->sb_version);
2898         for (i = 0; i < zmd->nr_devs; i++)
2899                 dmz_print_dev(zmd, i);
2900
2901         dmz_zmd_info(zmd, "  %u zones of %llu 512-byte logical sectors",
2902                      zmd->nr_zones, (u64)zmd->zone_nr_sectors);
2903         dmz_zmd_debug(zmd, "  %u metadata zones",
2904                       zmd->nr_meta_zones * 2);
2905         dmz_zmd_debug(zmd, "  %u data zones for %u chunks",
2906                       zmd->nr_data_zones, zmd->nr_chunks);
2907         dmz_zmd_debug(zmd, "    %u cache zones (%u unmapped)",
2908                       zmd->nr_cache, atomic_read(&zmd->unmap_nr_cache));
2909         dmz_zmd_debug(zmd, "    %u random zones (%u unmapped)",
2910                       zmd->nr_rnd, atomic_read(&zmd->unmap_nr_rnd));
2911         dmz_zmd_debug(zmd, "    %u sequential zones (%u unmapped)",
2912                       zmd->nr_seq, atomic_read(&zmd->unmap_nr_seq));
2913         dmz_zmd_debug(zmd, "  %u reserved sequential data zones",
2914                       zmd->nr_reserved_seq);
2915         dmz_zmd_debug(zmd, "Format:");
2916         dmz_zmd_debug(zmd, "%u metadata blocks per set (%u max cache)",
2917                       zmd->nr_meta_blocks, zmd->max_nr_mblks);
2918         dmz_zmd_debug(zmd, "  %u data zone mapping blocks",
2919                       zmd->nr_map_blocks);
2920         dmz_zmd_debug(zmd, "  %u bitmap blocks",
2921                       zmd->nr_bitmap_blocks);
2922
2923         *metadata = zmd;
2924
2925         return 0;
2926 err:
2927         dmz_cleanup_metadata(zmd);
2928         kfree(zmd);
2929         *metadata = NULL;
2930
2931         return ret;
2932 }
2933
2934 /*
2935  * Cleanup the zoned metadata resources.
2936  */
2937 void dmz_dtr_metadata(struct dmz_metadata *zmd)
2938 {
2939         unregister_shrinker(&zmd->mblk_shrinker);
2940         dmz_cleanup_metadata(zmd);
2941         kfree(zmd);
2942 }
2943
2944 /*
2945  * Check zone information on resume.
2946  */
2947 int dmz_resume_metadata(struct dmz_metadata *zmd)
2948 {
2949         struct dm_zone *zone;
2950         sector_t wp_block;
2951         unsigned int i;
2952         int ret;
2953
2954         /* Check zones */
2955         for (i = 0; i < zmd->nr_zones; i++) {
2956                 zone = dmz_get(zmd, i);
2957                 if (!zone) {
2958                         dmz_zmd_err(zmd, "Unable to get zone %u", i);
2959                         return -EIO;
2960                 }
2961                 wp_block = zone->wp_block;
2962
2963                 ret = dmz_update_zone(zmd, zone);
2964                 if (ret) {
2965                         dmz_zmd_err(zmd, "Broken zone %u", i);
2966                         return ret;
2967                 }
2968
2969                 if (dmz_is_offline(zone)) {
2970                         dmz_zmd_warn(zmd, "Zone %u is offline", i);
2971                         continue;
2972                 }
2973
2974                 /* Check write pointer */
2975                 if (!dmz_is_seq(zone))
2976                         zone->wp_block = 0;
2977                 else if (zone->wp_block != wp_block) {
2978                         dmz_zmd_err(zmd, "Zone %u: Invalid wp (%llu / %llu)",
2979                                     i, (u64)zone->wp_block, (u64)wp_block);
2980                         zone->wp_block = wp_block;
2981                         dmz_invalidate_blocks(zmd, zone, zone->wp_block,
2982                                               zmd->zone_nr_blocks - zone->wp_block);
2983                 }
2984         }
2985
2986         return 0;
2987 }