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