xref: /openbmc/linux/drivers/md/dm.c (revision 2f06cd12e11422e4a44ad4cb856c3ef0be9bd208)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * Copyright (C) 2001, 2002 Sistina Software (UK) Limited.
4  * Copyright (C) 2004-2008 Red Hat, Inc. All rights reserved.
5  *
6  * This file is released under the GPL.
7  */
8 
9 #include "dm-core.h"
10 #include "dm-rq.h"
11 #include "dm-uevent.h"
12 #include "dm-ima.h"
13 
14 #include <linux/init.h>
15 #include <linux/module.h>
16 #include <linux/mutex.h>
17 #include <linux/sched/mm.h>
18 #include <linux/sched/signal.h>
19 #include <linux/blkpg.h>
20 #include <linux/bio.h>
21 #include <linux/mempool.h>
22 #include <linux/dax.h>
23 #include <linux/slab.h>
24 #include <linux/idr.h>
25 #include <linux/uio.h>
26 #include <linux/hdreg.h>
27 #include <linux/delay.h>
28 #include <linux/wait.h>
29 #include <linux/pr.h>
30 #include <linux/refcount.h>
31 #include <linux/part_stat.h>
32 #include <linux/blk-crypto.h>
33 #include <linux/blk-crypto-profile.h>
34 
35 #define DM_MSG_PREFIX "core"
36 
37 /*
38  * Cookies are numeric values sent with CHANGE and REMOVE
39  * uevents while resuming, removing or renaming the device.
40  */
41 #define DM_COOKIE_ENV_VAR_NAME "DM_COOKIE"
42 #define DM_COOKIE_LENGTH 24
43 
44 /*
45  * For REQ_POLLED fs bio, this flag is set if we link mapped underlying
46  * dm_io into one list, and reuse bio->bi_private as the list head. Before
47  * ending this fs bio, we will recover its ->bi_private.
48  */
49 #define REQ_DM_POLL_LIST	REQ_DRV
50 
51 static const char *_name = DM_NAME;
52 
53 static unsigned int major;
54 static unsigned int _major;
55 
56 static DEFINE_IDR(_minor_idr);
57 
58 static DEFINE_SPINLOCK(_minor_lock);
59 
60 static void do_deferred_remove(struct work_struct *w);
61 
62 static DECLARE_WORK(deferred_remove_work, do_deferred_remove);
63 
64 static struct workqueue_struct *deferred_remove_workqueue;
65 
66 atomic_t dm_global_event_nr = ATOMIC_INIT(0);
67 DECLARE_WAIT_QUEUE_HEAD(dm_global_eventq);
68 
69 void dm_issue_global_event(void)
70 {
71 	atomic_inc(&dm_global_event_nr);
72 	wake_up(&dm_global_eventq);
73 }
74 
75 DEFINE_STATIC_KEY_FALSE(stats_enabled);
76 DEFINE_STATIC_KEY_FALSE(swap_bios_enabled);
77 DEFINE_STATIC_KEY_FALSE(zoned_enabled);
78 
79 /*
80  * One of these is allocated (on-stack) per original bio.
81  */
82 struct clone_info {
83 	struct dm_table *map;
84 	struct bio *bio;
85 	struct dm_io *io;
86 	sector_t sector;
87 	unsigned int sector_count;
88 	bool is_abnormal_io:1;
89 	bool submit_as_polled:1;
90 };
91 
92 static inline struct dm_target_io *clone_to_tio(struct bio *clone)
93 {
94 	return container_of(clone, struct dm_target_io, clone);
95 }
96 
97 void *dm_per_bio_data(struct bio *bio, size_t data_size)
98 {
99 	if (!dm_tio_flagged(clone_to_tio(bio), DM_TIO_INSIDE_DM_IO))
100 		return (char *)bio - DM_TARGET_IO_BIO_OFFSET - data_size;
101 	return (char *)bio - DM_IO_BIO_OFFSET - data_size;
102 }
103 EXPORT_SYMBOL_GPL(dm_per_bio_data);
104 
105 struct bio *dm_bio_from_per_bio_data(void *data, size_t data_size)
106 {
107 	struct dm_io *io = (struct dm_io *)((char *)data + data_size);
108 	if (io->magic == DM_IO_MAGIC)
109 		return (struct bio *)((char *)io + DM_IO_BIO_OFFSET);
110 	BUG_ON(io->magic != DM_TIO_MAGIC);
111 	return (struct bio *)((char *)io + DM_TARGET_IO_BIO_OFFSET);
112 }
113 EXPORT_SYMBOL_GPL(dm_bio_from_per_bio_data);
114 
115 unsigned int dm_bio_get_target_bio_nr(const struct bio *bio)
116 {
117 	return container_of(bio, struct dm_target_io, clone)->target_bio_nr;
118 }
119 EXPORT_SYMBOL_GPL(dm_bio_get_target_bio_nr);
120 
121 #define MINOR_ALLOCED ((void *)-1)
122 
123 #define DM_NUMA_NODE NUMA_NO_NODE
124 static int dm_numa_node = DM_NUMA_NODE;
125 
126 #define DEFAULT_SWAP_BIOS	(8 * 1048576 / PAGE_SIZE)
127 static int swap_bios = DEFAULT_SWAP_BIOS;
128 static int get_swap_bios(void)
129 {
130 	int latch = READ_ONCE(swap_bios);
131 	if (unlikely(latch <= 0))
132 		latch = DEFAULT_SWAP_BIOS;
133 	return latch;
134 }
135 
136 struct table_device {
137 	struct list_head list;
138 	refcount_t count;
139 	struct dm_dev dm_dev;
140 };
141 
142 /*
143  * Bio-based DM's mempools' reserved IOs set by the user.
144  */
145 #define RESERVED_BIO_BASED_IOS		16
146 static unsigned int reserved_bio_based_ios = RESERVED_BIO_BASED_IOS;
147 
148 static int __dm_get_module_param_int(int *module_param, int min, int max)
149 {
150 	int param = READ_ONCE(*module_param);
151 	int modified_param = 0;
152 	bool modified = true;
153 
154 	if (param < min)
155 		modified_param = min;
156 	else if (param > max)
157 		modified_param = max;
158 	else
159 		modified = false;
160 
161 	if (modified) {
162 		(void)cmpxchg(module_param, param, modified_param);
163 		param = modified_param;
164 	}
165 
166 	return param;
167 }
168 
169 unsigned int __dm_get_module_param(unsigned int *module_param, unsigned int def, unsigned int max)
170 {
171 	unsigned int param = READ_ONCE(*module_param);
172 	unsigned int modified_param = 0;
173 
174 	if (!param)
175 		modified_param = def;
176 	else if (param > max)
177 		modified_param = max;
178 
179 	if (modified_param) {
180 		(void)cmpxchg(module_param, param, modified_param);
181 		param = modified_param;
182 	}
183 
184 	return param;
185 }
186 
187 unsigned int dm_get_reserved_bio_based_ios(void)
188 {
189 	return __dm_get_module_param(&reserved_bio_based_ios,
190 				     RESERVED_BIO_BASED_IOS, DM_RESERVED_MAX_IOS);
191 }
192 EXPORT_SYMBOL_GPL(dm_get_reserved_bio_based_ios);
193 
194 static unsigned int dm_get_numa_node(void)
195 {
196 	return __dm_get_module_param_int(&dm_numa_node,
197 					 DM_NUMA_NODE, num_online_nodes() - 1);
198 }
199 
200 static int __init local_init(void)
201 {
202 	int r;
203 
204 	r = dm_uevent_init();
205 	if (r)
206 		return r;
207 
208 	deferred_remove_workqueue = alloc_workqueue("kdmremove", WQ_UNBOUND, 1);
209 	if (!deferred_remove_workqueue) {
210 		r = -ENOMEM;
211 		goto out_uevent_exit;
212 	}
213 
214 	_major = major;
215 	r = register_blkdev(_major, _name);
216 	if (r < 0)
217 		goto out_free_workqueue;
218 
219 	if (!_major)
220 		_major = r;
221 
222 	return 0;
223 
224 out_free_workqueue:
225 	destroy_workqueue(deferred_remove_workqueue);
226 out_uevent_exit:
227 	dm_uevent_exit();
228 
229 	return r;
230 }
231 
232 static void local_exit(void)
233 {
234 	flush_scheduled_work();
235 	destroy_workqueue(deferred_remove_workqueue);
236 
237 	unregister_blkdev(_major, _name);
238 	dm_uevent_exit();
239 
240 	_major = 0;
241 
242 	DMINFO("cleaned up");
243 }
244 
245 static int (*_inits[])(void) __initdata = {
246 	local_init,
247 	dm_target_init,
248 	dm_linear_init,
249 	dm_stripe_init,
250 	dm_io_init,
251 	dm_kcopyd_init,
252 	dm_interface_init,
253 	dm_statistics_init,
254 };
255 
256 static void (*_exits[])(void) = {
257 	local_exit,
258 	dm_target_exit,
259 	dm_linear_exit,
260 	dm_stripe_exit,
261 	dm_io_exit,
262 	dm_kcopyd_exit,
263 	dm_interface_exit,
264 	dm_statistics_exit,
265 };
266 
267 static int __init dm_init(void)
268 {
269 	const int count = ARRAY_SIZE(_inits);
270 	int r, i;
271 
272 #if (IS_ENABLED(CONFIG_IMA) && !IS_ENABLED(CONFIG_IMA_DISABLE_HTABLE))
273 	DMWARN("CONFIG_IMA_DISABLE_HTABLE is disabled."
274 	       " Duplicate IMA measurements will not be recorded in the IMA log.");
275 #endif
276 
277 	for (i = 0; i < count; i++) {
278 		r = _inits[i]();
279 		if (r)
280 			goto bad;
281 	}
282 
283 	return 0;
284 bad:
285 	while (i--)
286 		_exits[i]();
287 
288 	return r;
289 }
290 
291 static void __exit dm_exit(void)
292 {
293 	int i = ARRAY_SIZE(_exits);
294 
295 	while (i--)
296 		_exits[i]();
297 
298 	/*
299 	 * Should be empty by this point.
300 	 */
301 	idr_destroy(&_minor_idr);
302 }
303 
304 /*
305  * Block device functions
306  */
307 int dm_deleting_md(struct mapped_device *md)
308 {
309 	return test_bit(DMF_DELETING, &md->flags);
310 }
311 
312 static int dm_blk_open(struct block_device *bdev, fmode_t mode)
313 {
314 	struct mapped_device *md;
315 
316 	spin_lock(&_minor_lock);
317 
318 	md = bdev->bd_disk->private_data;
319 	if (!md)
320 		goto out;
321 
322 	if (test_bit(DMF_FREEING, &md->flags) ||
323 	    dm_deleting_md(md)) {
324 		md = NULL;
325 		goto out;
326 	}
327 
328 	dm_get(md);
329 	atomic_inc(&md->open_count);
330 out:
331 	spin_unlock(&_minor_lock);
332 
333 	return md ? 0 : -ENXIO;
334 }
335 
336 static void dm_blk_close(struct gendisk *disk, fmode_t mode)
337 {
338 	struct mapped_device *md;
339 
340 	spin_lock(&_minor_lock);
341 
342 	md = disk->private_data;
343 	if (WARN_ON(!md))
344 		goto out;
345 
346 	if (atomic_dec_and_test(&md->open_count) &&
347 	    (test_bit(DMF_DEFERRED_REMOVE, &md->flags)))
348 		queue_work(deferred_remove_workqueue, &deferred_remove_work);
349 
350 	dm_put(md);
351 out:
352 	spin_unlock(&_minor_lock);
353 }
354 
355 int dm_open_count(struct mapped_device *md)
356 {
357 	return atomic_read(&md->open_count);
358 }
359 
360 /*
361  * Guarantees nothing is using the device before it's deleted.
362  */
363 int dm_lock_for_deletion(struct mapped_device *md, bool mark_deferred, bool only_deferred)
364 {
365 	int r = 0;
366 
367 	spin_lock(&_minor_lock);
368 
369 	if (dm_open_count(md)) {
370 		r = -EBUSY;
371 		if (mark_deferred)
372 			set_bit(DMF_DEFERRED_REMOVE, &md->flags);
373 	} else if (only_deferred && !test_bit(DMF_DEFERRED_REMOVE, &md->flags))
374 		r = -EEXIST;
375 	else
376 		set_bit(DMF_DELETING, &md->flags);
377 
378 	spin_unlock(&_minor_lock);
379 
380 	return r;
381 }
382 
383 int dm_cancel_deferred_remove(struct mapped_device *md)
384 {
385 	int r = 0;
386 
387 	spin_lock(&_minor_lock);
388 
389 	if (test_bit(DMF_DELETING, &md->flags))
390 		r = -EBUSY;
391 	else
392 		clear_bit(DMF_DEFERRED_REMOVE, &md->flags);
393 
394 	spin_unlock(&_minor_lock);
395 
396 	return r;
397 }
398 
399 static void do_deferred_remove(struct work_struct *w)
400 {
401 	dm_deferred_remove();
402 }
403 
404 static int dm_blk_getgeo(struct block_device *bdev, struct hd_geometry *geo)
405 {
406 	struct mapped_device *md = bdev->bd_disk->private_data;
407 
408 	return dm_get_geometry(md, geo);
409 }
410 
411 static int dm_prepare_ioctl(struct mapped_device *md, int *srcu_idx,
412 			    struct block_device **bdev)
413 {
414 	struct dm_target *ti;
415 	struct dm_table *map;
416 	int r;
417 
418 retry:
419 	r = -ENOTTY;
420 	map = dm_get_live_table(md, srcu_idx);
421 	if (!map || !dm_table_get_size(map))
422 		return r;
423 
424 	/* We only support devices that have a single target */
425 	if (map->num_targets != 1)
426 		return r;
427 
428 	ti = dm_table_get_target(map, 0);
429 	if (!ti->type->prepare_ioctl)
430 		return r;
431 
432 	if (dm_suspended_md(md))
433 		return -EAGAIN;
434 
435 	r = ti->type->prepare_ioctl(ti, bdev);
436 	if (r == -ENOTCONN && !fatal_signal_pending(current)) {
437 		dm_put_live_table(md, *srcu_idx);
438 		fsleep(10000);
439 		goto retry;
440 	}
441 
442 	return r;
443 }
444 
445 static void dm_unprepare_ioctl(struct mapped_device *md, int srcu_idx)
446 {
447 	dm_put_live_table(md, srcu_idx);
448 }
449 
450 static int dm_blk_ioctl(struct block_device *bdev, fmode_t mode,
451 			unsigned int cmd, unsigned long arg)
452 {
453 	struct mapped_device *md = bdev->bd_disk->private_data;
454 	int r, srcu_idx;
455 
456 	r = dm_prepare_ioctl(md, &srcu_idx, &bdev);
457 	if (r < 0)
458 		goto out;
459 
460 	if (r > 0) {
461 		/*
462 		 * Target determined this ioctl is being issued against a
463 		 * subset of the parent bdev; require extra privileges.
464 		 */
465 		if (!capable(CAP_SYS_RAWIO)) {
466 			DMDEBUG_LIMIT(
467 	"%s: sending ioctl %x to DM device without required privilege.",
468 				current->comm, cmd);
469 			r = -ENOIOCTLCMD;
470 			goto out;
471 		}
472 	}
473 
474 	if (!bdev->bd_disk->fops->ioctl)
475 		r = -ENOTTY;
476 	else
477 		r = bdev->bd_disk->fops->ioctl(bdev, mode, cmd, arg);
478 out:
479 	dm_unprepare_ioctl(md, srcu_idx);
480 	return r;
481 }
482 
483 u64 dm_start_time_ns_from_clone(struct bio *bio)
484 {
485 	return jiffies_to_nsecs(clone_to_tio(bio)->io->start_time);
486 }
487 EXPORT_SYMBOL_GPL(dm_start_time_ns_from_clone);
488 
489 static bool bio_is_flush_with_data(struct bio *bio)
490 {
491 	return ((bio->bi_opf & REQ_PREFLUSH) && bio->bi_iter.bi_size);
492 }
493 
494 static void dm_io_acct(struct dm_io *io, bool end)
495 {
496 	struct dm_stats_aux *stats_aux = &io->stats_aux;
497 	unsigned long start_time = io->start_time;
498 	struct mapped_device *md = io->md;
499 	struct bio *bio = io->orig_bio;
500 	unsigned int sectors;
501 
502 	/*
503 	 * If REQ_PREFLUSH set, don't account payload, it will be
504 	 * submitted (and accounted) after this flush completes.
505 	 */
506 	if (bio_is_flush_with_data(bio))
507 		sectors = 0;
508 	else if (likely(!(dm_io_flagged(io, DM_IO_WAS_SPLIT))))
509 		sectors = bio_sectors(bio);
510 	else
511 		sectors = io->sectors;
512 
513 	if (!end)
514 		bdev_start_io_acct(bio->bi_bdev, sectors, bio_op(bio),
515 				   start_time);
516 	else
517 		bdev_end_io_acct(bio->bi_bdev, bio_op(bio), start_time);
518 
519 	if (static_branch_unlikely(&stats_enabled) &&
520 	    unlikely(dm_stats_used(&md->stats))) {
521 		sector_t sector;
522 
523 		if (likely(!dm_io_flagged(io, DM_IO_WAS_SPLIT)))
524 			sector = bio->bi_iter.bi_sector;
525 		else
526 			sector = bio_end_sector(bio) - io->sector_offset;
527 
528 		dm_stats_account_io(&md->stats, bio_data_dir(bio),
529 				    sector, sectors,
530 				    end, start_time, stats_aux);
531 	}
532 }
533 
534 static void __dm_start_io_acct(struct dm_io *io)
535 {
536 	dm_io_acct(io, false);
537 }
538 
539 static void dm_start_io_acct(struct dm_io *io, struct bio *clone)
540 {
541 	/*
542 	 * Ensure IO accounting is only ever started once.
543 	 */
544 	if (dm_io_flagged(io, DM_IO_ACCOUNTED))
545 		return;
546 
547 	/* Expect no possibility for race unless DM_TIO_IS_DUPLICATE_BIO. */
548 	if (!clone || likely(dm_tio_is_normal(clone_to_tio(clone)))) {
549 		dm_io_set_flag(io, DM_IO_ACCOUNTED);
550 	} else {
551 		unsigned long flags;
552 		/* Can afford locking given DM_TIO_IS_DUPLICATE_BIO */
553 		spin_lock_irqsave(&io->lock, flags);
554 		if (dm_io_flagged(io, DM_IO_ACCOUNTED)) {
555 			spin_unlock_irqrestore(&io->lock, flags);
556 			return;
557 		}
558 		dm_io_set_flag(io, DM_IO_ACCOUNTED);
559 		spin_unlock_irqrestore(&io->lock, flags);
560 	}
561 
562 	__dm_start_io_acct(io);
563 }
564 
565 static void dm_end_io_acct(struct dm_io *io)
566 {
567 	dm_io_acct(io, true);
568 }
569 
570 static struct dm_io *alloc_io(struct mapped_device *md, struct bio *bio)
571 {
572 	struct dm_io *io;
573 	struct dm_target_io *tio;
574 	struct bio *clone;
575 
576 	clone = bio_alloc_clone(NULL, bio, GFP_NOIO, &md->mempools->io_bs);
577 	tio = clone_to_tio(clone);
578 	tio->flags = 0;
579 	dm_tio_set_flag(tio, DM_TIO_INSIDE_DM_IO);
580 	tio->io = NULL;
581 
582 	io = container_of(tio, struct dm_io, tio);
583 	io->magic = DM_IO_MAGIC;
584 	io->status = BLK_STS_OK;
585 
586 	/* one ref is for submission, the other is for completion */
587 	atomic_set(&io->io_count, 2);
588 	this_cpu_inc(*md->pending_io);
589 	io->orig_bio = bio;
590 	io->md = md;
591 	spin_lock_init(&io->lock);
592 	io->start_time = jiffies;
593 	io->flags = 0;
594 
595 	if (static_branch_unlikely(&stats_enabled))
596 		dm_stats_record_start(&md->stats, &io->stats_aux);
597 
598 	return io;
599 }
600 
601 static void free_io(struct dm_io *io)
602 {
603 	bio_put(&io->tio.clone);
604 }
605 
606 static struct bio *alloc_tio(struct clone_info *ci, struct dm_target *ti,
607 			     unsigned int target_bio_nr, unsigned int *len, gfp_t gfp_mask)
608 {
609 	struct mapped_device *md = ci->io->md;
610 	struct dm_target_io *tio;
611 	struct bio *clone;
612 
613 	if (!ci->io->tio.io) {
614 		/* the dm_target_io embedded in ci->io is available */
615 		tio = &ci->io->tio;
616 		/* alloc_io() already initialized embedded clone */
617 		clone = &tio->clone;
618 	} else {
619 		clone = bio_alloc_clone(NULL, ci->bio, gfp_mask,
620 					&md->mempools->bs);
621 		if (!clone)
622 			return NULL;
623 
624 		/* REQ_DM_POLL_LIST shouldn't be inherited */
625 		clone->bi_opf &= ~REQ_DM_POLL_LIST;
626 
627 		tio = clone_to_tio(clone);
628 		tio->flags = 0; /* also clears DM_TIO_INSIDE_DM_IO */
629 	}
630 
631 	tio->magic = DM_TIO_MAGIC;
632 	tio->io = ci->io;
633 	tio->ti = ti;
634 	tio->target_bio_nr = target_bio_nr;
635 	tio->len_ptr = len;
636 	tio->old_sector = 0;
637 
638 	/* Set default bdev, but target must bio_set_dev() before issuing IO */
639 	clone->bi_bdev = md->disk->part0;
640 	if (unlikely(ti->needs_bio_set_dev))
641 		bio_set_dev(clone, md->disk->part0);
642 
643 	if (len) {
644 		clone->bi_iter.bi_size = to_bytes(*len);
645 		if (bio_integrity(clone))
646 			bio_integrity_trim(clone);
647 	}
648 
649 	return clone;
650 }
651 
652 static void free_tio(struct bio *clone)
653 {
654 	if (dm_tio_flagged(clone_to_tio(clone), DM_TIO_INSIDE_DM_IO))
655 		return;
656 	bio_put(clone);
657 }
658 
659 /*
660  * Add the bio to the list of deferred io.
661  */
662 static void queue_io(struct mapped_device *md, struct bio *bio)
663 {
664 	unsigned long flags;
665 
666 	spin_lock_irqsave(&md->deferred_lock, flags);
667 	bio_list_add(&md->deferred, bio);
668 	spin_unlock_irqrestore(&md->deferred_lock, flags);
669 	queue_work(md->wq, &md->work);
670 }
671 
672 /*
673  * Everyone (including functions in this file), should use this
674  * function to access the md->map field, and make sure they call
675  * dm_put_live_table() when finished.
676  */
677 struct dm_table *dm_get_live_table(struct mapped_device *md,
678 				   int *srcu_idx) __acquires(md->io_barrier)
679 {
680 	*srcu_idx = srcu_read_lock(&md->io_barrier);
681 
682 	return srcu_dereference(md->map, &md->io_barrier);
683 }
684 
685 void dm_put_live_table(struct mapped_device *md,
686 		       int srcu_idx) __releases(md->io_barrier)
687 {
688 	srcu_read_unlock(&md->io_barrier, srcu_idx);
689 }
690 
691 void dm_sync_table(struct mapped_device *md)
692 {
693 	synchronize_srcu(&md->io_barrier);
694 	synchronize_rcu_expedited();
695 }
696 
697 /*
698  * A fast alternative to dm_get_live_table/dm_put_live_table.
699  * The caller must not block between these two functions.
700  */
701 static struct dm_table *dm_get_live_table_fast(struct mapped_device *md) __acquires(RCU)
702 {
703 	rcu_read_lock();
704 	return rcu_dereference(md->map);
705 }
706 
707 static void dm_put_live_table_fast(struct mapped_device *md) __releases(RCU)
708 {
709 	rcu_read_unlock();
710 }
711 
712 static inline struct dm_table *dm_get_live_table_bio(struct mapped_device *md,
713 					int *srcu_idx, blk_opf_t bio_opf)
714 {
715 	if (bio_opf & REQ_NOWAIT)
716 		return dm_get_live_table_fast(md);
717 	else
718 		return dm_get_live_table(md, srcu_idx);
719 }
720 
721 static inline void dm_put_live_table_bio(struct mapped_device *md, int srcu_idx,
722 					 blk_opf_t bio_opf)
723 {
724 	if (bio_opf & REQ_NOWAIT)
725 		dm_put_live_table_fast(md);
726 	else
727 		dm_put_live_table(md, srcu_idx);
728 }
729 
730 static char *_dm_claim_ptr = "I belong to device-mapper";
731 
732 /*
733  * Open a table device so we can use it as a map destination.
734  */
735 static struct table_device *open_table_device(struct mapped_device *md,
736 		dev_t dev, fmode_t mode)
737 {
738 	struct table_device *td;
739 	struct block_device *bdev;
740 	u64 part_off;
741 	int r;
742 
743 	td = kmalloc_node(sizeof(*td), GFP_KERNEL, md->numa_node_id);
744 	if (!td)
745 		return ERR_PTR(-ENOMEM);
746 	refcount_set(&td->count, 1);
747 
748 	bdev = blkdev_get_by_dev(dev, mode | FMODE_EXCL, _dm_claim_ptr);
749 	if (IS_ERR(bdev)) {
750 		r = PTR_ERR(bdev);
751 		goto out_free_td;
752 	}
753 
754 	/*
755 	 * We can be called before the dm disk is added.  In that case we can't
756 	 * register the holder relation here.  It will be done once add_disk was
757 	 * called.
758 	 */
759 	if (md->disk->slave_dir) {
760 		r = bd_link_disk_holder(bdev, md->disk);
761 		if (r)
762 			goto out_blkdev_put;
763 	}
764 
765 	td->dm_dev.mode = mode;
766 	td->dm_dev.bdev = bdev;
767 	td->dm_dev.dax_dev = fs_dax_get_by_bdev(bdev, &part_off, NULL, NULL);
768 	format_dev_t(td->dm_dev.name, dev);
769 	list_add(&td->list, &md->table_devices);
770 	return td;
771 
772 out_blkdev_put:
773 	blkdev_put(bdev, mode | FMODE_EXCL);
774 out_free_td:
775 	kfree(td);
776 	return ERR_PTR(r);
777 }
778 
779 /*
780  * Close a table device that we've been using.
781  */
782 static void close_table_device(struct table_device *td, struct mapped_device *md)
783 {
784 	if (md->disk->slave_dir)
785 		bd_unlink_disk_holder(td->dm_dev.bdev, md->disk);
786 	blkdev_put(td->dm_dev.bdev, td->dm_dev.mode | FMODE_EXCL);
787 	put_dax(td->dm_dev.dax_dev);
788 	list_del(&td->list);
789 	kfree(td);
790 }
791 
792 static struct table_device *find_table_device(struct list_head *l, dev_t dev,
793 					      fmode_t mode)
794 {
795 	struct table_device *td;
796 
797 	list_for_each_entry(td, l, list)
798 		if (td->dm_dev.bdev->bd_dev == dev && td->dm_dev.mode == mode)
799 			return td;
800 
801 	return NULL;
802 }
803 
804 int dm_get_table_device(struct mapped_device *md, dev_t dev, fmode_t mode,
805 			struct dm_dev **result)
806 {
807 	struct table_device *td;
808 
809 	mutex_lock(&md->table_devices_lock);
810 	td = find_table_device(&md->table_devices, dev, mode);
811 	if (!td) {
812 		td = open_table_device(md, dev, mode);
813 		if (IS_ERR(td)) {
814 			mutex_unlock(&md->table_devices_lock);
815 			return PTR_ERR(td);
816 		}
817 	} else {
818 		refcount_inc(&td->count);
819 	}
820 	mutex_unlock(&md->table_devices_lock);
821 
822 	*result = &td->dm_dev;
823 	return 0;
824 }
825 
826 void dm_put_table_device(struct mapped_device *md, struct dm_dev *d)
827 {
828 	struct table_device *td = container_of(d, struct table_device, dm_dev);
829 
830 	mutex_lock(&md->table_devices_lock);
831 	if (refcount_dec_and_test(&td->count))
832 		close_table_device(td, md);
833 	mutex_unlock(&md->table_devices_lock);
834 }
835 
836 /*
837  * Get the geometry associated with a dm device
838  */
839 int dm_get_geometry(struct mapped_device *md, struct hd_geometry *geo)
840 {
841 	*geo = md->geometry;
842 
843 	return 0;
844 }
845 
846 /*
847  * Set the geometry of a device.
848  */
849 int dm_set_geometry(struct mapped_device *md, struct hd_geometry *geo)
850 {
851 	sector_t sz = (sector_t)geo->cylinders * geo->heads * geo->sectors;
852 
853 	if (geo->start > sz) {
854 		DMERR("Start sector is beyond the geometry limits.");
855 		return -EINVAL;
856 	}
857 
858 	md->geometry = *geo;
859 
860 	return 0;
861 }
862 
863 static int __noflush_suspending(struct mapped_device *md)
864 {
865 	return test_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
866 }
867 
868 static void dm_requeue_add_io(struct dm_io *io, bool first_stage)
869 {
870 	struct mapped_device *md = io->md;
871 
872 	if (first_stage) {
873 		struct dm_io *next = md->requeue_list;
874 
875 		md->requeue_list = io;
876 		io->next = next;
877 	} else {
878 		bio_list_add_head(&md->deferred, io->orig_bio);
879 	}
880 }
881 
882 static void dm_kick_requeue(struct mapped_device *md, bool first_stage)
883 {
884 	if (first_stage)
885 		queue_work(md->wq, &md->requeue_work);
886 	else
887 		queue_work(md->wq, &md->work);
888 }
889 
890 /*
891  * Return true if the dm_io's original bio is requeued.
892  * io->status is updated with error if requeue disallowed.
893  */
894 static bool dm_handle_requeue(struct dm_io *io, bool first_stage)
895 {
896 	struct bio *bio = io->orig_bio;
897 	bool handle_requeue = (io->status == BLK_STS_DM_REQUEUE);
898 	bool handle_polled_eagain = ((io->status == BLK_STS_AGAIN) &&
899 				     (bio->bi_opf & REQ_POLLED));
900 	struct mapped_device *md = io->md;
901 	bool requeued = false;
902 
903 	if (handle_requeue || handle_polled_eagain) {
904 		unsigned long flags;
905 
906 		if (bio->bi_opf & REQ_POLLED) {
907 			/*
908 			 * Upper layer won't help us poll split bio
909 			 * (io->orig_bio may only reflect a subset of the
910 			 * pre-split original) so clear REQ_POLLED.
911 			 */
912 			bio_clear_polled(bio);
913 		}
914 
915 		/*
916 		 * Target requested pushing back the I/O or
917 		 * polled IO hit BLK_STS_AGAIN.
918 		 */
919 		spin_lock_irqsave(&md->deferred_lock, flags);
920 		if ((__noflush_suspending(md) &&
921 		     !WARN_ON_ONCE(dm_is_zone_write(md, bio))) ||
922 		    handle_polled_eagain || first_stage) {
923 			dm_requeue_add_io(io, first_stage);
924 			requeued = true;
925 		} else {
926 			/*
927 			 * noflush suspend was interrupted or this is
928 			 * a write to a zoned target.
929 			 */
930 			io->status = BLK_STS_IOERR;
931 		}
932 		spin_unlock_irqrestore(&md->deferred_lock, flags);
933 	}
934 
935 	if (requeued)
936 		dm_kick_requeue(md, first_stage);
937 
938 	return requeued;
939 }
940 
941 static void __dm_io_complete(struct dm_io *io, bool first_stage)
942 {
943 	struct bio *bio = io->orig_bio;
944 	struct mapped_device *md = io->md;
945 	blk_status_t io_error;
946 	bool requeued;
947 
948 	requeued = dm_handle_requeue(io, first_stage);
949 	if (requeued && first_stage)
950 		return;
951 
952 	io_error = io->status;
953 	if (dm_io_flagged(io, DM_IO_ACCOUNTED))
954 		dm_end_io_acct(io);
955 	else if (!io_error) {
956 		/*
957 		 * Must handle target that DM_MAPIO_SUBMITTED only to
958 		 * then bio_endio() rather than dm_submit_bio_remap()
959 		 */
960 		__dm_start_io_acct(io);
961 		dm_end_io_acct(io);
962 	}
963 	free_io(io);
964 	smp_wmb();
965 	this_cpu_dec(*md->pending_io);
966 
967 	/* nudge anyone waiting on suspend queue */
968 	if (unlikely(wq_has_sleeper(&md->wait)))
969 		wake_up(&md->wait);
970 
971 	/* Return early if the original bio was requeued */
972 	if (requeued)
973 		return;
974 
975 	if (bio_is_flush_with_data(bio)) {
976 		/*
977 		 * Preflush done for flush with data, reissue
978 		 * without REQ_PREFLUSH.
979 		 */
980 		bio->bi_opf &= ~REQ_PREFLUSH;
981 		queue_io(md, bio);
982 	} else {
983 		/* done with normal IO or empty flush */
984 		if (io_error)
985 			bio->bi_status = io_error;
986 		bio_endio(bio);
987 	}
988 }
989 
990 static void dm_wq_requeue_work(struct work_struct *work)
991 {
992 	struct mapped_device *md = container_of(work, struct mapped_device,
993 						requeue_work);
994 	unsigned long flags;
995 	struct dm_io *io;
996 
997 	/* reuse deferred lock to simplify dm_handle_requeue */
998 	spin_lock_irqsave(&md->deferred_lock, flags);
999 	io = md->requeue_list;
1000 	md->requeue_list = NULL;
1001 	spin_unlock_irqrestore(&md->deferred_lock, flags);
1002 
1003 	while (io) {
1004 		struct dm_io *next = io->next;
1005 
1006 		dm_io_rewind(io, &md->disk->bio_split);
1007 
1008 		io->next = NULL;
1009 		__dm_io_complete(io, false);
1010 		io = next;
1011 	}
1012 }
1013 
1014 /*
1015  * Two staged requeue:
1016  *
1017  * 1) io->orig_bio points to the real original bio, and the part mapped to
1018  *    this io must be requeued, instead of other parts of the original bio.
1019  *
1020  * 2) io->orig_bio points to new cloned bio which matches the requeued dm_io.
1021  */
1022 static void dm_io_complete(struct dm_io *io)
1023 {
1024 	bool first_requeue;
1025 
1026 	/*
1027 	 * Only dm_io that has been split needs two stage requeue, otherwise
1028 	 * we may run into long bio clone chain during suspend and OOM could
1029 	 * be triggered.
1030 	 *
1031 	 * Also flush data dm_io won't be marked as DM_IO_WAS_SPLIT, so they
1032 	 * also aren't handled via the first stage requeue.
1033 	 */
1034 	if (dm_io_flagged(io, DM_IO_WAS_SPLIT))
1035 		first_requeue = true;
1036 	else
1037 		first_requeue = false;
1038 
1039 	__dm_io_complete(io, first_requeue);
1040 }
1041 
1042 /*
1043  * Decrements the number of outstanding ios that a bio has been
1044  * cloned into, completing the original io if necc.
1045  */
1046 static inline void __dm_io_dec_pending(struct dm_io *io)
1047 {
1048 	if (atomic_dec_and_test(&io->io_count))
1049 		dm_io_complete(io);
1050 }
1051 
1052 static void dm_io_set_error(struct dm_io *io, blk_status_t error)
1053 {
1054 	unsigned long flags;
1055 
1056 	/* Push-back supersedes any I/O errors */
1057 	spin_lock_irqsave(&io->lock, flags);
1058 	if (!(io->status == BLK_STS_DM_REQUEUE &&
1059 	      __noflush_suspending(io->md))) {
1060 		io->status = error;
1061 	}
1062 	spin_unlock_irqrestore(&io->lock, flags);
1063 }
1064 
1065 static void dm_io_dec_pending(struct dm_io *io, blk_status_t error)
1066 {
1067 	if (unlikely(error))
1068 		dm_io_set_error(io, error);
1069 
1070 	__dm_io_dec_pending(io);
1071 }
1072 
1073 void disable_discard(struct mapped_device *md)
1074 {
1075 	struct queue_limits *limits = dm_get_queue_limits(md);
1076 
1077 	/* device doesn't really support DISCARD, disable it */
1078 	limits->max_discard_sectors = 0;
1079 }
1080 
1081 void disable_write_zeroes(struct mapped_device *md)
1082 {
1083 	struct queue_limits *limits = dm_get_queue_limits(md);
1084 
1085 	/* device doesn't really support WRITE ZEROES, disable it */
1086 	limits->max_write_zeroes_sectors = 0;
1087 }
1088 
1089 static bool swap_bios_limit(struct dm_target *ti, struct bio *bio)
1090 {
1091 	return unlikely((bio->bi_opf & REQ_SWAP) != 0) && unlikely(ti->limit_swap_bios);
1092 }
1093 
1094 static void clone_endio(struct bio *bio)
1095 {
1096 	blk_status_t error = bio->bi_status;
1097 	struct dm_target_io *tio = clone_to_tio(bio);
1098 	struct dm_target *ti = tio->ti;
1099 	dm_endio_fn endio = ti->type->end_io;
1100 	struct dm_io *io = tio->io;
1101 	struct mapped_device *md = io->md;
1102 
1103 	if (unlikely(error == BLK_STS_TARGET)) {
1104 		if (bio_op(bio) == REQ_OP_DISCARD &&
1105 		    !bdev_max_discard_sectors(bio->bi_bdev))
1106 			disable_discard(md);
1107 		else if (bio_op(bio) == REQ_OP_WRITE_ZEROES &&
1108 			 !bdev_write_zeroes_sectors(bio->bi_bdev))
1109 			disable_write_zeroes(md);
1110 	}
1111 
1112 	if (static_branch_unlikely(&zoned_enabled) &&
1113 	    unlikely(bdev_is_zoned(bio->bi_bdev)))
1114 		dm_zone_endio(io, bio);
1115 
1116 	if (endio) {
1117 		int r = endio(ti, bio, &error);
1118 		switch (r) {
1119 		case DM_ENDIO_REQUEUE:
1120 			if (static_branch_unlikely(&zoned_enabled)) {
1121 				/*
1122 				 * Requeuing writes to a sequential zone of a zoned
1123 				 * target will break the sequential write pattern:
1124 				 * fail such IO.
1125 				 */
1126 				if (WARN_ON_ONCE(dm_is_zone_write(md, bio)))
1127 					error = BLK_STS_IOERR;
1128 				else
1129 					error = BLK_STS_DM_REQUEUE;
1130 			} else
1131 				error = BLK_STS_DM_REQUEUE;
1132 			fallthrough;
1133 		case DM_ENDIO_DONE:
1134 			break;
1135 		case DM_ENDIO_INCOMPLETE:
1136 			/* The target will handle the io */
1137 			return;
1138 		default:
1139 			DMCRIT("unimplemented target endio return value: %d", r);
1140 			BUG();
1141 		}
1142 	}
1143 
1144 	if (static_branch_unlikely(&swap_bios_enabled) &&
1145 	    unlikely(swap_bios_limit(ti, bio)))
1146 		up(&md->swap_bios_semaphore);
1147 
1148 	free_tio(bio);
1149 	dm_io_dec_pending(io, error);
1150 }
1151 
1152 /*
1153  * Return maximum size of I/O possible at the supplied sector up to the current
1154  * target boundary.
1155  */
1156 static inline sector_t max_io_len_target_boundary(struct dm_target *ti,
1157 						  sector_t target_offset)
1158 {
1159 	return ti->len - target_offset;
1160 }
1161 
1162 static sector_t max_io_len(struct dm_target *ti, sector_t sector)
1163 {
1164 	sector_t target_offset = dm_target_offset(ti, sector);
1165 	sector_t len = max_io_len_target_boundary(ti, target_offset);
1166 
1167 	/*
1168 	 * Does the target need to split IO even further?
1169 	 * - varied (per target) IO splitting is a tenet of DM; this
1170 	 *   explains why stacked chunk_sectors based splitting via
1171 	 *   bio_split_to_limits() isn't possible here.
1172 	 */
1173 	if (!ti->max_io_len)
1174 		return len;
1175 	return min_t(sector_t, len,
1176 		min(queue_max_sectors(ti->table->md->queue),
1177 		    blk_chunk_sectors_left(target_offset, ti->max_io_len)));
1178 }
1179 
1180 int dm_set_target_max_io_len(struct dm_target *ti, sector_t len)
1181 {
1182 	if (len > UINT_MAX) {
1183 		DMERR("Specified maximum size of target IO (%llu) exceeds limit (%u)",
1184 		      (unsigned long long)len, UINT_MAX);
1185 		ti->error = "Maximum size of target IO is too large";
1186 		return -EINVAL;
1187 	}
1188 
1189 	ti->max_io_len = (uint32_t) len;
1190 
1191 	return 0;
1192 }
1193 EXPORT_SYMBOL_GPL(dm_set_target_max_io_len);
1194 
1195 static struct dm_target *dm_dax_get_live_target(struct mapped_device *md,
1196 						sector_t sector, int *srcu_idx)
1197 	__acquires(md->io_barrier)
1198 {
1199 	struct dm_table *map;
1200 	struct dm_target *ti;
1201 
1202 	map = dm_get_live_table(md, srcu_idx);
1203 	if (!map)
1204 		return NULL;
1205 
1206 	ti = dm_table_find_target(map, sector);
1207 	if (!ti)
1208 		return NULL;
1209 
1210 	return ti;
1211 }
1212 
1213 static long dm_dax_direct_access(struct dax_device *dax_dev, pgoff_t pgoff,
1214 		long nr_pages, enum dax_access_mode mode, void **kaddr,
1215 		pfn_t *pfn)
1216 {
1217 	struct mapped_device *md = dax_get_private(dax_dev);
1218 	sector_t sector = pgoff * PAGE_SECTORS;
1219 	struct dm_target *ti;
1220 	long len, ret = -EIO;
1221 	int srcu_idx;
1222 
1223 	ti = dm_dax_get_live_target(md, sector, &srcu_idx);
1224 
1225 	if (!ti)
1226 		goto out;
1227 	if (!ti->type->direct_access)
1228 		goto out;
1229 	len = max_io_len(ti, sector) / PAGE_SECTORS;
1230 	if (len < 1)
1231 		goto out;
1232 	nr_pages = min(len, nr_pages);
1233 	ret = ti->type->direct_access(ti, pgoff, nr_pages, mode, kaddr, pfn);
1234 
1235  out:
1236 	dm_put_live_table(md, srcu_idx);
1237 
1238 	return ret;
1239 }
1240 
1241 static int dm_dax_zero_page_range(struct dax_device *dax_dev, pgoff_t pgoff,
1242 				  size_t nr_pages)
1243 {
1244 	struct mapped_device *md = dax_get_private(dax_dev);
1245 	sector_t sector = pgoff * PAGE_SECTORS;
1246 	struct dm_target *ti;
1247 	int ret = -EIO;
1248 	int srcu_idx;
1249 
1250 	ti = dm_dax_get_live_target(md, sector, &srcu_idx);
1251 
1252 	if (!ti)
1253 		goto out;
1254 	if (WARN_ON(!ti->type->dax_zero_page_range)) {
1255 		/*
1256 		 * ->zero_page_range() is mandatory dax operation. If we are
1257 		 *  here, something is wrong.
1258 		 */
1259 		goto out;
1260 	}
1261 	ret = ti->type->dax_zero_page_range(ti, pgoff, nr_pages);
1262  out:
1263 	dm_put_live_table(md, srcu_idx);
1264 
1265 	return ret;
1266 }
1267 
1268 static size_t dm_dax_recovery_write(struct dax_device *dax_dev, pgoff_t pgoff,
1269 		void *addr, size_t bytes, struct iov_iter *i)
1270 {
1271 	struct mapped_device *md = dax_get_private(dax_dev);
1272 	sector_t sector = pgoff * PAGE_SECTORS;
1273 	struct dm_target *ti;
1274 	int srcu_idx;
1275 	long ret = 0;
1276 
1277 	ti = dm_dax_get_live_target(md, sector, &srcu_idx);
1278 	if (!ti || !ti->type->dax_recovery_write)
1279 		goto out;
1280 
1281 	ret = ti->type->dax_recovery_write(ti, pgoff, addr, bytes, i);
1282 out:
1283 	dm_put_live_table(md, srcu_idx);
1284 	return ret;
1285 }
1286 
1287 /*
1288  * A target may call dm_accept_partial_bio only from the map routine.  It is
1289  * allowed for all bio types except REQ_PREFLUSH, REQ_OP_ZONE_* zone management
1290  * operations, REQ_OP_ZONE_APPEND (zone append writes) and any bio serviced by
1291  * __send_duplicate_bios().
1292  *
1293  * dm_accept_partial_bio informs the dm that the target only wants to process
1294  * additional n_sectors sectors of the bio and the rest of the data should be
1295  * sent in a next bio.
1296  *
1297  * A diagram that explains the arithmetics:
1298  * +--------------------+---------------+-------+
1299  * |         1          |       2       |   3   |
1300  * +--------------------+---------------+-------+
1301  *
1302  * <-------------- *tio->len_ptr --------------->
1303  *                      <----- bio_sectors ----->
1304  *                      <-- n_sectors -->
1305  *
1306  * Region 1 was already iterated over with bio_advance or similar function.
1307  *	(it may be empty if the target doesn't use bio_advance)
1308  * Region 2 is the remaining bio size that the target wants to process.
1309  *	(it may be empty if region 1 is non-empty, although there is no reason
1310  *	 to make it empty)
1311  * The target requires that region 3 is to be sent in the next bio.
1312  *
1313  * If the target wants to receive multiple copies of the bio (via num_*bios, etc),
1314  * the partially processed part (the sum of regions 1+2) must be the same for all
1315  * copies of the bio.
1316  */
1317 void dm_accept_partial_bio(struct bio *bio, unsigned int n_sectors)
1318 {
1319 	struct dm_target_io *tio = clone_to_tio(bio);
1320 	struct dm_io *io = tio->io;
1321 	unsigned int bio_sectors = bio_sectors(bio);
1322 
1323 	BUG_ON(dm_tio_flagged(tio, DM_TIO_IS_DUPLICATE_BIO));
1324 	BUG_ON(op_is_zone_mgmt(bio_op(bio)));
1325 	BUG_ON(bio_op(bio) == REQ_OP_ZONE_APPEND);
1326 	BUG_ON(bio_sectors > *tio->len_ptr);
1327 	BUG_ON(n_sectors > bio_sectors);
1328 
1329 	*tio->len_ptr -= bio_sectors - n_sectors;
1330 	bio->bi_iter.bi_size = n_sectors << SECTOR_SHIFT;
1331 
1332 	/*
1333 	 * __split_and_process_bio() may have already saved mapped part
1334 	 * for accounting but it is being reduced so update accordingly.
1335 	 */
1336 	dm_io_set_flag(io, DM_IO_WAS_SPLIT);
1337 	io->sectors = n_sectors;
1338 	io->sector_offset = bio_sectors(io->orig_bio);
1339 }
1340 EXPORT_SYMBOL_GPL(dm_accept_partial_bio);
1341 
1342 /*
1343  * @clone: clone bio that DM core passed to target's .map function
1344  * @tgt_clone: clone of @clone bio that target needs submitted
1345  *
1346  * Targets should use this interface to submit bios they take
1347  * ownership of when returning DM_MAPIO_SUBMITTED.
1348  *
1349  * Target should also enable ti->accounts_remapped_io
1350  */
1351 void dm_submit_bio_remap(struct bio *clone, struct bio *tgt_clone)
1352 {
1353 	struct dm_target_io *tio = clone_to_tio(clone);
1354 	struct dm_io *io = tio->io;
1355 
1356 	/* establish bio that will get submitted */
1357 	if (!tgt_clone)
1358 		tgt_clone = clone;
1359 
1360 	/*
1361 	 * Account io->origin_bio to DM dev on behalf of target
1362 	 * that took ownership of IO with DM_MAPIO_SUBMITTED.
1363 	 */
1364 	dm_start_io_acct(io, clone);
1365 
1366 	trace_block_bio_remap(tgt_clone, disk_devt(io->md->disk),
1367 			      tio->old_sector);
1368 	submit_bio_noacct(tgt_clone);
1369 }
1370 EXPORT_SYMBOL_GPL(dm_submit_bio_remap);
1371 
1372 static noinline void __set_swap_bios_limit(struct mapped_device *md, int latch)
1373 {
1374 	mutex_lock(&md->swap_bios_lock);
1375 	while (latch < md->swap_bios) {
1376 		cond_resched();
1377 		down(&md->swap_bios_semaphore);
1378 		md->swap_bios--;
1379 	}
1380 	while (latch > md->swap_bios) {
1381 		cond_resched();
1382 		up(&md->swap_bios_semaphore);
1383 		md->swap_bios++;
1384 	}
1385 	mutex_unlock(&md->swap_bios_lock);
1386 }
1387 
1388 static void __map_bio(struct bio *clone)
1389 {
1390 	struct dm_target_io *tio = clone_to_tio(clone);
1391 	struct dm_target *ti = tio->ti;
1392 	struct dm_io *io = tio->io;
1393 	struct mapped_device *md = io->md;
1394 	int r;
1395 
1396 	clone->bi_end_io = clone_endio;
1397 
1398 	/*
1399 	 * Map the clone.
1400 	 */
1401 	tio->old_sector = clone->bi_iter.bi_sector;
1402 
1403 	if (static_branch_unlikely(&swap_bios_enabled) &&
1404 	    unlikely(swap_bios_limit(ti, clone))) {
1405 		int latch = get_swap_bios();
1406 		if (unlikely(latch != md->swap_bios))
1407 			__set_swap_bios_limit(md, latch);
1408 		down(&md->swap_bios_semaphore);
1409 	}
1410 
1411 	if (static_branch_unlikely(&zoned_enabled)) {
1412 		/*
1413 		 * Check if the IO needs a special mapping due to zone append
1414 		 * emulation on zoned target. In this case, dm_zone_map_bio()
1415 		 * calls the target map operation.
1416 		 */
1417 		if (unlikely(dm_emulate_zone_append(md)))
1418 			r = dm_zone_map_bio(tio);
1419 		else
1420 			r = ti->type->map(ti, clone);
1421 	} else
1422 		r = ti->type->map(ti, clone);
1423 
1424 	switch (r) {
1425 	case DM_MAPIO_SUBMITTED:
1426 		/* target has assumed ownership of this io */
1427 		if (!ti->accounts_remapped_io)
1428 			dm_start_io_acct(io, clone);
1429 		break;
1430 	case DM_MAPIO_REMAPPED:
1431 		dm_submit_bio_remap(clone, NULL);
1432 		break;
1433 	case DM_MAPIO_KILL:
1434 	case DM_MAPIO_REQUEUE:
1435 		if (static_branch_unlikely(&swap_bios_enabled) &&
1436 		    unlikely(swap_bios_limit(ti, clone)))
1437 			up(&md->swap_bios_semaphore);
1438 		free_tio(clone);
1439 		if (r == DM_MAPIO_KILL)
1440 			dm_io_dec_pending(io, BLK_STS_IOERR);
1441 		else
1442 			dm_io_dec_pending(io, BLK_STS_DM_REQUEUE);
1443 		break;
1444 	default:
1445 		DMCRIT("unimplemented target map return value: %d", r);
1446 		BUG();
1447 	}
1448 }
1449 
1450 static void setup_split_accounting(struct clone_info *ci, unsigned int len)
1451 {
1452 	struct dm_io *io = ci->io;
1453 
1454 	if (ci->sector_count > len) {
1455 		/*
1456 		 * Split needed, save the mapped part for accounting.
1457 		 * NOTE: dm_accept_partial_bio() will update accordingly.
1458 		 */
1459 		dm_io_set_flag(io, DM_IO_WAS_SPLIT);
1460 		io->sectors = len;
1461 		io->sector_offset = bio_sectors(ci->bio);
1462 	}
1463 }
1464 
1465 static void alloc_multiple_bios(struct bio_list *blist, struct clone_info *ci,
1466 				struct dm_target *ti, unsigned int num_bios)
1467 {
1468 	struct bio *bio;
1469 	int try;
1470 
1471 	for (try = 0; try < 2; try++) {
1472 		int bio_nr;
1473 
1474 		if (try)
1475 			mutex_lock(&ci->io->md->table_devices_lock);
1476 		for (bio_nr = 0; bio_nr < num_bios; bio_nr++) {
1477 			bio = alloc_tio(ci, ti, bio_nr, NULL,
1478 					try ? GFP_NOIO : GFP_NOWAIT);
1479 			if (!bio)
1480 				break;
1481 
1482 			bio_list_add(blist, bio);
1483 		}
1484 		if (try)
1485 			mutex_unlock(&ci->io->md->table_devices_lock);
1486 		if (bio_nr == num_bios)
1487 			return;
1488 
1489 		while ((bio = bio_list_pop(blist)))
1490 			free_tio(bio);
1491 	}
1492 }
1493 
1494 static int __send_duplicate_bios(struct clone_info *ci, struct dm_target *ti,
1495 				 unsigned int num_bios, unsigned int *len)
1496 {
1497 	struct bio_list blist = BIO_EMPTY_LIST;
1498 	struct bio *clone;
1499 	unsigned int ret = 0;
1500 
1501 	switch (num_bios) {
1502 	case 0:
1503 		break;
1504 	case 1:
1505 		if (len)
1506 			setup_split_accounting(ci, *len);
1507 		clone = alloc_tio(ci, ti, 0, len, GFP_NOIO);
1508 		__map_bio(clone);
1509 		ret = 1;
1510 		break;
1511 	default:
1512 		/* dm_accept_partial_bio() is not supported with shared tio->len_ptr */
1513 		alloc_multiple_bios(&blist, ci, ti, num_bios);
1514 		while ((clone = bio_list_pop(&blist))) {
1515 			dm_tio_set_flag(clone_to_tio(clone), DM_TIO_IS_DUPLICATE_BIO);
1516 			__map_bio(clone);
1517 			ret += 1;
1518 		}
1519 		break;
1520 	}
1521 
1522 	return ret;
1523 }
1524 
1525 static void __send_empty_flush(struct clone_info *ci)
1526 {
1527 	struct dm_table *t = ci->map;
1528 	struct bio flush_bio;
1529 
1530 	/*
1531 	 * Use an on-stack bio for this, it's safe since we don't
1532 	 * need to reference it after submit. It's just used as
1533 	 * the basis for the clone(s).
1534 	 */
1535 	bio_init(&flush_bio, ci->io->md->disk->part0, NULL, 0,
1536 		 REQ_OP_WRITE | REQ_PREFLUSH | REQ_SYNC);
1537 
1538 	ci->bio = &flush_bio;
1539 	ci->sector_count = 0;
1540 	ci->io->tio.clone.bi_iter.bi_size = 0;
1541 
1542 	for (unsigned int i = 0; i < t->num_targets; i++) {
1543 		unsigned int bios;
1544 		struct dm_target *ti = dm_table_get_target(t, i);
1545 
1546 		atomic_add(ti->num_flush_bios, &ci->io->io_count);
1547 		bios = __send_duplicate_bios(ci, ti, ti->num_flush_bios, NULL);
1548 		atomic_sub(ti->num_flush_bios - bios, &ci->io->io_count);
1549 	}
1550 
1551 	/*
1552 	 * alloc_io() takes one extra reference for submission, so the
1553 	 * reference won't reach 0 without the following subtraction
1554 	 */
1555 	atomic_sub(1, &ci->io->io_count);
1556 
1557 	bio_uninit(ci->bio);
1558 }
1559 
1560 static void __send_changing_extent_only(struct clone_info *ci, struct dm_target *ti,
1561 					unsigned int num_bios)
1562 {
1563 	unsigned int len, bios;
1564 
1565 	len = min_t(sector_t, ci->sector_count,
1566 		    max_io_len_target_boundary(ti, dm_target_offset(ti, ci->sector)));
1567 
1568 	atomic_add(num_bios, &ci->io->io_count);
1569 	bios = __send_duplicate_bios(ci, ti, num_bios, &len);
1570 	/*
1571 	 * alloc_io() takes one extra reference for submission, so the
1572 	 * reference won't reach 0 without the following (+1) subtraction
1573 	 */
1574 	atomic_sub(num_bios - bios + 1, &ci->io->io_count);
1575 
1576 	ci->sector += len;
1577 	ci->sector_count -= len;
1578 }
1579 
1580 static bool is_abnormal_io(struct bio *bio)
1581 {
1582 	enum req_op op = bio_op(bio);
1583 
1584 	if (op != REQ_OP_READ && op != REQ_OP_WRITE && op != REQ_OP_FLUSH) {
1585 		switch (op) {
1586 		case REQ_OP_DISCARD:
1587 		case REQ_OP_SECURE_ERASE:
1588 		case REQ_OP_WRITE_ZEROES:
1589 			return true;
1590 		default:
1591 			break;
1592 		}
1593 	}
1594 
1595 	return false;
1596 }
1597 
1598 static blk_status_t __process_abnormal_io(struct clone_info *ci,
1599 					  struct dm_target *ti)
1600 {
1601 	unsigned int num_bios = 0;
1602 
1603 	switch (bio_op(ci->bio)) {
1604 	case REQ_OP_DISCARD:
1605 		num_bios = ti->num_discard_bios;
1606 		break;
1607 	case REQ_OP_SECURE_ERASE:
1608 		num_bios = ti->num_secure_erase_bios;
1609 		break;
1610 	case REQ_OP_WRITE_ZEROES:
1611 		num_bios = ti->num_write_zeroes_bios;
1612 		break;
1613 	default:
1614 		break;
1615 	}
1616 
1617 	/*
1618 	 * Even though the device advertised support for this type of
1619 	 * request, that does not mean every target supports it, and
1620 	 * reconfiguration might also have changed that since the
1621 	 * check was performed.
1622 	 */
1623 	if (unlikely(!num_bios))
1624 		return BLK_STS_NOTSUPP;
1625 
1626 	__send_changing_extent_only(ci, ti, num_bios);
1627 	return BLK_STS_OK;
1628 }
1629 
1630 /*
1631  * Reuse ->bi_private as dm_io list head for storing all dm_io instances
1632  * associated with this bio, and this bio's bi_private needs to be
1633  * stored in dm_io->data before the reuse.
1634  *
1635  * bio->bi_private is owned by fs or upper layer, so block layer won't
1636  * touch it after splitting. Meantime it won't be changed by anyone after
1637  * bio is submitted. So this reuse is safe.
1638  */
1639 static inline struct dm_io **dm_poll_list_head(struct bio *bio)
1640 {
1641 	return (struct dm_io **)&bio->bi_private;
1642 }
1643 
1644 static void dm_queue_poll_io(struct bio *bio, struct dm_io *io)
1645 {
1646 	struct dm_io **head = dm_poll_list_head(bio);
1647 
1648 	if (!(bio->bi_opf & REQ_DM_POLL_LIST)) {
1649 		bio->bi_opf |= REQ_DM_POLL_LIST;
1650 		/*
1651 		 * Save .bi_private into dm_io, so that we can reuse
1652 		 * .bi_private as dm_io list head for storing dm_io list
1653 		 */
1654 		io->data = bio->bi_private;
1655 
1656 		/* tell block layer to poll for completion */
1657 		bio->bi_cookie = ~BLK_QC_T_NONE;
1658 
1659 		io->next = NULL;
1660 	} else {
1661 		/*
1662 		 * bio recursed due to split, reuse original poll list,
1663 		 * and save bio->bi_private too.
1664 		 */
1665 		io->data = (*head)->data;
1666 		io->next = *head;
1667 	}
1668 
1669 	*head = io;
1670 }
1671 
1672 /*
1673  * Select the correct strategy for processing a non-flush bio.
1674  */
1675 static blk_status_t __split_and_process_bio(struct clone_info *ci)
1676 {
1677 	struct bio *clone;
1678 	struct dm_target *ti;
1679 	unsigned int len;
1680 
1681 	ti = dm_table_find_target(ci->map, ci->sector);
1682 	if (unlikely(!ti))
1683 		return BLK_STS_IOERR;
1684 
1685 	if (unlikely((ci->bio->bi_opf & REQ_NOWAIT) != 0) &&
1686 	    unlikely(!dm_target_supports_nowait(ti->type)))
1687 		return BLK_STS_NOTSUPP;
1688 
1689 	if (unlikely(ci->is_abnormal_io))
1690 		return __process_abnormal_io(ci, ti);
1691 
1692 	/*
1693 	 * Only support bio polling for normal IO, and the target io is
1694 	 * exactly inside the dm_io instance (verified in dm_poll_dm_io)
1695 	 */
1696 	ci->submit_as_polled = !!(ci->bio->bi_opf & REQ_POLLED);
1697 
1698 	len = min_t(sector_t, max_io_len(ti, ci->sector), ci->sector_count);
1699 	setup_split_accounting(ci, len);
1700 	clone = alloc_tio(ci, ti, 0, &len, GFP_NOIO);
1701 	__map_bio(clone);
1702 
1703 	ci->sector += len;
1704 	ci->sector_count -= len;
1705 
1706 	return BLK_STS_OK;
1707 }
1708 
1709 static void init_clone_info(struct clone_info *ci, struct mapped_device *md,
1710 			    struct dm_table *map, struct bio *bio, bool is_abnormal)
1711 {
1712 	ci->map = map;
1713 	ci->io = alloc_io(md, bio);
1714 	ci->bio = bio;
1715 	ci->is_abnormal_io = is_abnormal;
1716 	ci->submit_as_polled = false;
1717 	ci->sector = bio->bi_iter.bi_sector;
1718 	ci->sector_count = bio_sectors(bio);
1719 
1720 	/* Shouldn't happen but sector_count was being set to 0 so... */
1721 	if (static_branch_unlikely(&zoned_enabled) &&
1722 	    WARN_ON_ONCE(op_is_zone_mgmt(bio_op(bio)) && ci->sector_count))
1723 		ci->sector_count = 0;
1724 }
1725 
1726 /*
1727  * Entry point to split a bio into clones and submit them to the targets.
1728  */
1729 static void dm_split_and_process_bio(struct mapped_device *md,
1730 				     struct dm_table *map, struct bio *bio)
1731 {
1732 	struct clone_info ci;
1733 	struct dm_io *io;
1734 	blk_status_t error = BLK_STS_OK;
1735 	bool is_abnormal;
1736 
1737 	is_abnormal = is_abnormal_io(bio);
1738 	if (unlikely(is_abnormal)) {
1739 		/*
1740 		 * Use bio_split_to_limits() for abnormal IO (e.g. discard, etc)
1741 		 * otherwise associated queue_limits won't be imposed.
1742 		 */
1743 		bio = bio_split_to_limits(bio);
1744 		if (!bio)
1745 			return;
1746 	}
1747 
1748 	init_clone_info(&ci, md, map, bio, is_abnormal);
1749 	io = ci.io;
1750 
1751 	if (bio->bi_opf & REQ_PREFLUSH) {
1752 		__send_empty_flush(&ci);
1753 		/* dm_io_complete submits any data associated with flush */
1754 		goto out;
1755 	}
1756 
1757 	error = __split_and_process_bio(&ci);
1758 	if (error || !ci.sector_count)
1759 		goto out;
1760 	/*
1761 	 * Remainder must be passed to submit_bio_noacct() so it gets handled
1762 	 * *after* bios already submitted have been completely processed.
1763 	 */
1764 	bio_trim(bio, io->sectors, ci.sector_count);
1765 	trace_block_split(bio, bio->bi_iter.bi_sector);
1766 	bio_inc_remaining(bio);
1767 	submit_bio_noacct(bio);
1768 out:
1769 	/*
1770 	 * Drop the extra reference count for non-POLLED bio, and hold one
1771 	 * reference for POLLED bio, which will be released in dm_poll_bio
1772 	 *
1773 	 * Add every dm_io instance into the dm_io list head which is stored
1774 	 * in bio->bi_private, so that dm_poll_bio can poll them all.
1775 	 */
1776 	if (error || !ci.submit_as_polled) {
1777 		/*
1778 		 * In case of submission failure, the extra reference for
1779 		 * submitting io isn't consumed yet
1780 		 */
1781 		if (error)
1782 			atomic_dec(&io->io_count);
1783 		dm_io_dec_pending(io, error);
1784 	} else
1785 		dm_queue_poll_io(bio, io);
1786 }
1787 
1788 static void dm_submit_bio(struct bio *bio)
1789 {
1790 	struct mapped_device *md = bio->bi_bdev->bd_disk->private_data;
1791 	int srcu_idx;
1792 	struct dm_table *map;
1793 	blk_opf_t bio_opf = bio->bi_opf;
1794 
1795 	map = dm_get_live_table_bio(md, &srcu_idx, bio_opf);
1796 
1797 	/* If suspended, or map not yet available, queue this IO for later */
1798 	if (unlikely(test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags)) ||
1799 	    unlikely(!map)) {
1800 		if (bio->bi_opf & REQ_NOWAIT)
1801 			bio_wouldblock_error(bio);
1802 		else if (bio->bi_opf & REQ_RAHEAD)
1803 			bio_io_error(bio);
1804 		else
1805 			queue_io(md, bio);
1806 		goto out;
1807 	}
1808 
1809 	dm_split_and_process_bio(md, map, bio);
1810 out:
1811 	dm_put_live_table_bio(md, srcu_idx, bio_opf);
1812 }
1813 
1814 static bool dm_poll_dm_io(struct dm_io *io, struct io_comp_batch *iob,
1815 			  unsigned int flags)
1816 {
1817 	WARN_ON_ONCE(!dm_tio_is_normal(&io->tio));
1818 
1819 	/* don't poll if the mapped io is done */
1820 	if (atomic_read(&io->io_count) > 1)
1821 		bio_poll(&io->tio.clone, iob, flags);
1822 
1823 	/* bio_poll holds the last reference */
1824 	return atomic_read(&io->io_count) == 1;
1825 }
1826 
1827 static int dm_poll_bio(struct bio *bio, struct io_comp_batch *iob,
1828 		       unsigned int flags)
1829 {
1830 	struct dm_io **head = dm_poll_list_head(bio);
1831 	struct dm_io *list = *head;
1832 	struct dm_io *tmp = NULL;
1833 	struct dm_io *curr, *next;
1834 
1835 	/* Only poll normal bio which was marked as REQ_DM_POLL_LIST */
1836 	if (!(bio->bi_opf & REQ_DM_POLL_LIST))
1837 		return 0;
1838 
1839 	WARN_ON_ONCE(!list);
1840 
1841 	/*
1842 	 * Restore .bi_private before possibly completing dm_io.
1843 	 *
1844 	 * bio_poll() is only possible once @bio has been completely
1845 	 * submitted via submit_bio_noacct()'s depth-first submission.
1846 	 * So there is no dm_queue_poll_io() race associated with
1847 	 * clearing REQ_DM_POLL_LIST here.
1848 	 */
1849 	bio->bi_opf &= ~REQ_DM_POLL_LIST;
1850 	bio->bi_private = list->data;
1851 
1852 	for (curr = list, next = curr->next; curr; curr = next, next =
1853 			curr ? curr->next : NULL) {
1854 		if (dm_poll_dm_io(curr, iob, flags)) {
1855 			/*
1856 			 * clone_endio() has already occurred, so no
1857 			 * error handling is needed here.
1858 			 */
1859 			__dm_io_dec_pending(curr);
1860 		} else {
1861 			curr->next = tmp;
1862 			tmp = curr;
1863 		}
1864 	}
1865 
1866 	/* Not done? */
1867 	if (tmp) {
1868 		bio->bi_opf |= REQ_DM_POLL_LIST;
1869 		/* Reset bio->bi_private to dm_io list head */
1870 		*head = tmp;
1871 		return 0;
1872 	}
1873 	return 1;
1874 }
1875 
1876 /*-----------------------------------------------------------------
1877  * An IDR is used to keep track of allocated minor numbers.
1878  *---------------------------------------------------------------*/
1879 static void free_minor(int minor)
1880 {
1881 	spin_lock(&_minor_lock);
1882 	idr_remove(&_minor_idr, minor);
1883 	spin_unlock(&_minor_lock);
1884 }
1885 
1886 /*
1887  * See if the device with a specific minor # is free.
1888  */
1889 static int specific_minor(int minor)
1890 {
1891 	int r;
1892 
1893 	if (minor >= (1 << MINORBITS))
1894 		return -EINVAL;
1895 
1896 	idr_preload(GFP_KERNEL);
1897 	spin_lock(&_minor_lock);
1898 
1899 	r = idr_alloc(&_minor_idr, MINOR_ALLOCED, minor, minor + 1, GFP_NOWAIT);
1900 
1901 	spin_unlock(&_minor_lock);
1902 	idr_preload_end();
1903 	if (r < 0)
1904 		return r == -ENOSPC ? -EBUSY : r;
1905 	return 0;
1906 }
1907 
1908 static int next_free_minor(int *minor)
1909 {
1910 	int r;
1911 
1912 	idr_preload(GFP_KERNEL);
1913 	spin_lock(&_minor_lock);
1914 
1915 	r = idr_alloc(&_minor_idr, MINOR_ALLOCED, 0, 1 << MINORBITS, GFP_NOWAIT);
1916 
1917 	spin_unlock(&_minor_lock);
1918 	idr_preload_end();
1919 	if (r < 0)
1920 		return r;
1921 	*minor = r;
1922 	return 0;
1923 }
1924 
1925 static const struct block_device_operations dm_blk_dops;
1926 static const struct block_device_operations dm_rq_blk_dops;
1927 static const struct dax_operations dm_dax_ops;
1928 
1929 static void dm_wq_work(struct work_struct *work);
1930 
1931 #ifdef CONFIG_BLK_INLINE_ENCRYPTION
1932 static void dm_queue_destroy_crypto_profile(struct request_queue *q)
1933 {
1934 	dm_destroy_crypto_profile(q->crypto_profile);
1935 }
1936 
1937 #else /* CONFIG_BLK_INLINE_ENCRYPTION */
1938 
1939 static inline void dm_queue_destroy_crypto_profile(struct request_queue *q)
1940 {
1941 }
1942 #endif /* !CONFIG_BLK_INLINE_ENCRYPTION */
1943 
1944 static void cleanup_mapped_device(struct mapped_device *md)
1945 {
1946 	if (md->wq)
1947 		destroy_workqueue(md->wq);
1948 	dm_free_md_mempools(md->mempools);
1949 
1950 	if (md->dax_dev) {
1951 		dax_remove_host(md->disk);
1952 		kill_dax(md->dax_dev);
1953 		put_dax(md->dax_dev);
1954 		md->dax_dev = NULL;
1955 	}
1956 
1957 	dm_cleanup_zoned_dev(md);
1958 	if (md->disk) {
1959 		spin_lock(&_minor_lock);
1960 		md->disk->private_data = NULL;
1961 		spin_unlock(&_minor_lock);
1962 		if (dm_get_md_type(md) != DM_TYPE_NONE) {
1963 			struct table_device *td;
1964 
1965 			dm_sysfs_exit(md);
1966 			list_for_each_entry(td, &md->table_devices, list) {
1967 				bd_unlink_disk_holder(td->dm_dev.bdev,
1968 						      md->disk);
1969 			}
1970 
1971 			/*
1972 			 * Hold lock to make sure del_gendisk() won't concurrent
1973 			 * with open/close_table_device().
1974 			 */
1975 			mutex_lock(&md->table_devices_lock);
1976 			del_gendisk(md->disk);
1977 			mutex_unlock(&md->table_devices_lock);
1978 		}
1979 		dm_queue_destroy_crypto_profile(md->queue);
1980 		put_disk(md->disk);
1981 	}
1982 
1983 	if (md->pending_io) {
1984 		free_percpu(md->pending_io);
1985 		md->pending_io = NULL;
1986 	}
1987 
1988 	cleanup_srcu_struct(&md->io_barrier);
1989 
1990 	mutex_destroy(&md->suspend_lock);
1991 	mutex_destroy(&md->type_lock);
1992 	mutex_destroy(&md->table_devices_lock);
1993 	mutex_destroy(&md->swap_bios_lock);
1994 
1995 	dm_mq_cleanup_mapped_device(md);
1996 }
1997 
1998 /*
1999  * Allocate and initialise a blank device with a given minor.
2000  */
2001 static struct mapped_device *alloc_dev(int minor)
2002 {
2003 	int r, numa_node_id = dm_get_numa_node();
2004 	struct mapped_device *md;
2005 	void *old_md;
2006 
2007 	md = kvzalloc_node(sizeof(*md), GFP_KERNEL, numa_node_id);
2008 	if (!md) {
2009 		DMERR("unable to allocate device, out of memory.");
2010 		return NULL;
2011 	}
2012 
2013 	if (!try_module_get(THIS_MODULE))
2014 		goto bad_module_get;
2015 
2016 	/* get a minor number for the dev */
2017 	if (minor == DM_ANY_MINOR)
2018 		r = next_free_minor(&minor);
2019 	else
2020 		r = specific_minor(minor);
2021 	if (r < 0)
2022 		goto bad_minor;
2023 
2024 	r = init_srcu_struct(&md->io_barrier);
2025 	if (r < 0)
2026 		goto bad_io_barrier;
2027 
2028 	md->numa_node_id = numa_node_id;
2029 	md->init_tio_pdu = false;
2030 	md->type = DM_TYPE_NONE;
2031 	mutex_init(&md->suspend_lock);
2032 	mutex_init(&md->type_lock);
2033 	mutex_init(&md->table_devices_lock);
2034 	spin_lock_init(&md->deferred_lock);
2035 	atomic_set(&md->holders, 1);
2036 	atomic_set(&md->open_count, 0);
2037 	atomic_set(&md->event_nr, 0);
2038 	atomic_set(&md->uevent_seq, 0);
2039 	INIT_LIST_HEAD(&md->uevent_list);
2040 	INIT_LIST_HEAD(&md->table_devices);
2041 	spin_lock_init(&md->uevent_lock);
2042 
2043 	/*
2044 	 * default to bio-based until DM table is loaded and md->type
2045 	 * established. If request-based table is loaded: blk-mq will
2046 	 * override accordingly.
2047 	 */
2048 	md->disk = blk_alloc_disk(md->numa_node_id);
2049 	if (!md->disk)
2050 		goto bad;
2051 	md->queue = md->disk->queue;
2052 
2053 	init_waitqueue_head(&md->wait);
2054 	INIT_WORK(&md->work, dm_wq_work);
2055 	INIT_WORK(&md->requeue_work, dm_wq_requeue_work);
2056 	init_waitqueue_head(&md->eventq);
2057 	init_completion(&md->kobj_holder.completion);
2058 
2059 	md->requeue_list = NULL;
2060 	md->swap_bios = get_swap_bios();
2061 	sema_init(&md->swap_bios_semaphore, md->swap_bios);
2062 	mutex_init(&md->swap_bios_lock);
2063 
2064 	md->disk->major = _major;
2065 	md->disk->first_minor = minor;
2066 	md->disk->minors = 1;
2067 	md->disk->flags |= GENHD_FL_NO_PART;
2068 	md->disk->fops = &dm_blk_dops;
2069 	md->disk->private_data = md;
2070 	sprintf(md->disk->disk_name, "dm-%d", minor);
2071 
2072 	if (IS_ENABLED(CONFIG_FS_DAX)) {
2073 		md->dax_dev = alloc_dax(md, &dm_dax_ops);
2074 		if (IS_ERR(md->dax_dev)) {
2075 			md->dax_dev = NULL;
2076 			goto bad;
2077 		}
2078 		set_dax_nocache(md->dax_dev);
2079 		set_dax_nomc(md->dax_dev);
2080 		if (dax_add_host(md->dax_dev, md->disk))
2081 			goto bad;
2082 	}
2083 
2084 	format_dev_t(md->name, MKDEV(_major, minor));
2085 
2086 	md->wq = alloc_workqueue("kdmflush/%s", WQ_MEM_RECLAIM, 0, md->name);
2087 	if (!md->wq)
2088 		goto bad;
2089 
2090 	md->pending_io = alloc_percpu(unsigned long);
2091 	if (!md->pending_io)
2092 		goto bad;
2093 
2094 	dm_stats_init(&md->stats);
2095 
2096 	/* Populate the mapping, nobody knows we exist yet */
2097 	spin_lock(&_minor_lock);
2098 	old_md = idr_replace(&_minor_idr, md, minor);
2099 	spin_unlock(&_minor_lock);
2100 
2101 	BUG_ON(old_md != MINOR_ALLOCED);
2102 
2103 	return md;
2104 
2105 bad:
2106 	cleanup_mapped_device(md);
2107 bad_io_barrier:
2108 	free_minor(minor);
2109 bad_minor:
2110 	module_put(THIS_MODULE);
2111 bad_module_get:
2112 	kvfree(md);
2113 	return NULL;
2114 }
2115 
2116 static void unlock_fs(struct mapped_device *md);
2117 
2118 static void free_dev(struct mapped_device *md)
2119 {
2120 	int minor = MINOR(disk_devt(md->disk));
2121 
2122 	unlock_fs(md);
2123 
2124 	cleanup_mapped_device(md);
2125 
2126 	WARN_ON_ONCE(!list_empty(&md->table_devices));
2127 	dm_stats_cleanup(&md->stats);
2128 	free_minor(minor);
2129 
2130 	module_put(THIS_MODULE);
2131 	kvfree(md);
2132 }
2133 
2134 /*
2135  * Bind a table to the device.
2136  */
2137 static void event_callback(void *context)
2138 {
2139 	unsigned long flags;
2140 	LIST_HEAD(uevents);
2141 	struct mapped_device *md = (struct mapped_device *) context;
2142 
2143 	spin_lock_irqsave(&md->uevent_lock, flags);
2144 	list_splice_init(&md->uevent_list, &uevents);
2145 	spin_unlock_irqrestore(&md->uevent_lock, flags);
2146 
2147 	dm_send_uevents(&uevents, &disk_to_dev(md->disk)->kobj);
2148 
2149 	atomic_inc(&md->event_nr);
2150 	wake_up(&md->eventq);
2151 	dm_issue_global_event();
2152 }
2153 
2154 /*
2155  * Returns old map, which caller must destroy.
2156  */
2157 static struct dm_table *__bind(struct mapped_device *md, struct dm_table *t,
2158 			       struct queue_limits *limits)
2159 {
2160 	struct dm_table *old_map;
2161 	sector_t size;
2162 	int ret;
2163 
2164 	lockdep_assert_held(&md->suspend_lock);
2165 
2166 	size = dm_table_get_size(t);
2167 
2168 	/*
2169 	 * Wipe any geometry if the size of the table changed.
2170 	 */
2171 	if (size != dm_get_size(md))
2172 		memset(&md->geometry, 0, sizeof(md->geometry));
2173 
2174 	set_capacity(md->disk, size);
2175 
2176 	dm_table_event_callback(t, event_callback, md);
2177 
2178 	if (dm_table_request_based(t)) {
2179 		/*
2180 		 * Leverage the fact that request-based DM targets are
2181 		 * immutable singletons - used to optimize dm_mq_queue_rq.
2182 		 */
2183 		md->immutable_target = dm_table_get_immutable_target(t);
2184 
2185 		/*
2186 		 * There is no need to reload with request-based dm because the
2187 		 * size of front_pad doesn't change.
2188 		 *
2189 		 * Note for future: If you are to reload bioset, prep-ed
2190 		 * requests in the queue may refer to bio from the old bioset,
2191 		 * so you must walk through the queue to unprep.
2192 		 */
2193 		if (!md->mempools) {
2194 			md->mempools = t->mempools;
2195 			t->mempools = NULL;
2196 		}
2197 	} else {
2198 		/*
2199 		 * The md may already have mempools that need changing.
2200 		 * If so, reload bioset because front_pad may have changed
2201 		 * because a different table was loaded.
2202 		 */
2203 		dm_free_md_mempools(md->mempools);
2204 		md->mempools = t->mempools;
2205 		t->mempools = NULL;
2206 	}
2207 
2208 	ret = dm_table_set_restrictions(t, md->queue, limits);
2209 	if (ret) {
2210 		old_map = ERR_PTR(ret);
2211 		goto out;
2212 	}
2213 
2214 	old_map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
2215 	rcu_assign_pointer(md->map, (void *)t);
2216 	md->immutable_target_type = dm_table_get_immutable_target_type(t);
2217 
2218 	if (old_map)
2219 		dm_sync_table(md);
2220 out:
2221 	return old_map;
2222 }
2223 
2224 /*
2225  * Returns unbound table for the caller to free.
2226  */
2227 static struct dm_table *__unbind(struct mapped_device *md)
2228 {
2229 	struct dm_table *map = rcu_dereference_protected(md->map, 1);
2230 
2231 	if (!map)
2232 		return NULL;
2233 
2234 	dm_table_event_callback(map, NULL, NULL);
2235 	RCU_INIT_POINTER(md->map, NULL);
2236 	dm_sync_table(md);
2237 
2238 	return map;
2239 }
2240 
2241 /*
2242  * Constructor for a new device.
2243  */
2244 int dm_create(int minor, struct mapped_device **result)
2245 {
2246 	struct mapped_device *md;
2247 
2248 	md = alloc_dev(minor);
2249 	if (!md)
2250 		return -ENXIO;
2251 
2252 	dm_ima_reset_data(md);
2253 
2254 	*result = md;
2255 	return 0;
2256 }
2257 
2258 /*
2259  * Functions to manage md->type.
2260  * All are required to hold md->type_lock.
2261  */
2262 void dm_lock_md_type(struct mapped_device *md)
2263 {
2264 	mutex_lock(&md->type_lock);
2265 }
2266 
2267 void dm_unlock_md_type(struct mapped_device *md)
2268 {
2269 	mutex_unlock(&md->type_lock);
2270 }
2271 
2272 void dm_set_md_type(struct mapped_device *md, enum dm_queue_mode type)
2273 {
2274 	BUG_ON(!mutex_is_locked(&md->type_lock));
2275 	md->type = type;
2276 }
2277 
2278 enum dm_queue_mode dm_get_md_type(struct mapped_device *md)
2279 {
2280 	return md->type;
2281 }
2282 
2283 struct target_type *dm_get_immutable_target_type(struct mapped_device *md)
2284 {
2285 	return md->immutable_target_type;
2286 }
2287 
2288 /*
2289  * The queue_limits are only valid as long as you have a reference
2290  * count on 'md'.
2291  */
2292 struct queue_limits *dm_get_queue_limits(struct mapped_device *md)
2293 {
2294 	BUG_ON(!atomic_read(&md->holders));
2295 	return &md->queue->limits;
2296 }
2297 EXPORT_SYMBOL_GPL(dm_get_queue_limits);
2298 
2299 /*
2300  * Setup the DM device's queue based on md's type
2301  */
2302 int dm_setup_md_queue(struct mapped_device *md, struct dm_table *t)
2303 {
2304 	enum dm_queue_mode type = dm_table_get_type(t);
2305 	struct queue_limits limits;
2306 	struct table_device *td;
2307 	int r;
2308 
2309 	switch (type) {
2310 	case DM_TYPE_REQUEST_BASED:
2311 		md->disk->fops = &dm_rq_blk_dops;
2312 		r = dm_mq_init_request_queue(md, t);
2313 		if (r) {
2314 			DMERR("Cannot initialize queue for request-based dm mapped device");
2315 			return r;
2316 		}
2317 		break;
2318 	case DM_TYPE_BIO_BASED:
2319 	case DM_TYPE_DAX_BIO_BASED:
2320 		break;
2321 	case DM_TYPE_NONE:
2322 		WARN_ON_ONCE(true);
2323 		break;
2324 	}
2325 
2326 	r = dm_calculate_queue_limits(t, &limits);
2327 	if (r) {
2328 		DMERR("Cannot calculate initial queue limits");
2329 		return r;
2330 	}
2331 	r = dm_table_set_restrictions(t, md->queue, &limits);
2332 	if (r)
2333 		return r;
2334 
2335 	/*
2336 	 * Hold lock to make sure add_disk() and del_gendisk() won't concurrent
2337 	 * with open_table_device() and close_table_device().
2338 	 */
2339 	mutex_lock(&md->table_devices_lock);
2340 	r = add_disk(md->disk);
2341 	mutex_unlock(&md->table_devices_lock);
2342 	if (r)
2343 		return r;
2344 
2345 	/*
2346 	 * Register the holder relationship for devices added before the disk
2347 	 * was live.
2348 	 */
2349 	list_for_each_entry(td, &md->table_devices, list) {
2350 		r = bd_link_disk_holder(td->dm_dev.bdev, md->disk);
2351 		if (r)
2352 			goto out_undo_holders;
2353 	}
2354 
2355 	r = dm_sysfs_init(md);
2356 	if (r)
2357 		goto out_undo_holders;
2358 
2359 	md->type = type;
2360 	return 0;
2361 
2362 out_undo_holders:
2363 	list_for_each_entry_continue_reverse(td, &md->table_devices, list)
2364 		bd_unlink_disk_holder(td->dm_dev.bdev, md->disk);
2365 	mutex_lock(&md->table_devices_lock);
2366 	del_gendisk(md->disk);
2367 	mutex_unlock(&md->table_devices_lock);
2368 	return r;
2369 }
2370 
2371 struct mapped_device *dm_get_md(dev_t dev)
2372 {
2373 	struct mapped_device *md;
2374 	unsigned int minor = MINOR(dev);
2375 
2376 	if (MAJOR(dev) != _major || minor >= (1 << MINORBITS))
2377 		return NULL;
2378 
2379 	spin_lock(&_minor_lock);
2380 
2381 	md = idr_find(&_minor_idr, minor);
2382 	if (!md || md == MINOR_ALLOCED || (MINOR(disk_devt(dm_disk(md))) != minor) ||
2383 	    test_bit(DMF_FREEING, &md->flags) || dm_deleting_md(md)) {
2384 		md = NULL;
2385 		goto out;
2386 	}
2387 	dm_get(md);
2388 out:
2389 	spin_unlock(&_minor_lock);
2390 
2391 	return md;
2392 }
2393 EXPORT_SYMBOL_GPL(dm_get_md);
2394 
2395 void *dm_get_mdptr(struct mapped_device *md)
2396 {
2397 	return md->interface_ptr;
2398 }
2399 
2400 void dm_set_mdptr(struct mapped_device *md, void *ptr)
2401 {
2402 	md->interface_ptr = ptr;
2403 }
2404 
2405 void dm_get(struct mapped_device *md)
2406 {
2407 	atomic_inc(&md->holders);
2408 	BUG_ON(test_bit(DMF_FREEING, &md->flags));
2409 }
2410 
2411 int dm_hold(struct mapped_device *md)
2412 {
2413 	spin_lock(&_minor_lock);
2414 	if (test_bit(DMF_FREEING, &md->flags)) {
2415 		spin_unlock(&_minor_lock);
2416 		return -EBUSY;
2417 	}
2418 	dm_get(md);
2419 	spin_unlock(&_minor_lock);
2420 	return 0;
2421 }
2422 EXPORT_SYMBOL_GPL(dm_hold);
2423 
2424 const char *dm_device_name(struct mapped_device *md)
2425 {
2426 	return md->name;
2427 }
2428 EXPORT_SYMBOL_GPL(dm_device_name);
2429 
2430 static void __dm_destroy(struct mapped_device *md, bool wait)
2431 {
2432 	struct dm_table *map;
2433 	int srcu_idx;
2434 
2435 	might_sleep();
2436 
2437 	spin_lock(&_minor_lock);
2438 	idr_replace(&_minor_idr, MINOR_ALLOCED, MINOR(disk_devt(dm_disk(md))));
2439 	set_bit(DMF_FREEING, &md->flags);
2440 	spin_unlock(&_minor_lock);
2441 
2442 	blk_mark_disk_dead(md->disk);
2443 
2444 	/*
2445 	 * Take suspend_lock so that presuspend and postsuspend methods
2446 	 * do not race with internal suspend.
2447 	 */
2448 	mutex_lock(&md->suspend_lock);
2449 	map = dm_get_live_table(md, &srcu_idx);
2450 	if (!dm_suspended_md(md)) {
2451 		dm_table_presuspend_targets(map);
2452 		set_bit(DMF_SUSPENDED, &md->flags);
2453 		set_bit(DMF_POST_SUSPENDING, &md->flags);
2454 		dm_table_postsuspend_targets(map);
2455 	}
2456 	/* dm_put_live_table must be before fsleep, otherwise deadlock is possible */
2457 	dm_put_live_table(md, srcu_idx);
2458 	mutex_unlock(&md->suspend_lock);
2459 
2460 	/*
2461 	 * Rare, but there may be I/O requests still going to complete,
2462 	 * for example.  Wait for all references to disappear.
2463 	 * No one should increment the reference count of the mapped_device,
2464 	 * after the mapped_device state becomes DMF_FREEING.
2465 	 */
2466 	if (wait)
2467 		while (atomic_read(&md->holders))
2468 			fsleep(1000);
2469 	else if (atomic_read(&md->holders))
2470 		DMWARN("%s: Forcibly removing mapped_device still in use! (%d users)",
2471 		       dm_device_name(md), atomic_read(&md->holders));
2472 
2473 	dm_table_destroy(__unbind(md));
2474 	free_dev(md);
2475 }
2476 
2477 void dm_destroy(struct mapped_device *md)
2478 {
2479 	__dm_destroy(md, true);
2480 }
2481 
2482 void dm_destroy_immediate(struct mapped_device *md)
2483 {
2484 	__dm_destroy(md, false);
2485 }
2486 
2487 void dm_put(struct mapped_device *md)
2488 {
2489 	atomic_dec(&md->holders);
2490 }
2491 EXPORT_SYMBOL_GPL(dm_put);
2492 
2493 static bool dm_in_flight_bios(struct mapped_device *md)
2494 {
2495 	int cpu;
2496 	unsigned long sum = 0;
2497 
2498 	for_each_possible_cpu(cpu)
2499 		sum += *per_cpu_ptr(md->pending_io, cpu);
2500 
2501 	return sum != 0;
2502 }
2503 
2504 static int dm_wait_for_bios_completion(struct mapped_device *md, unsigned int task_state)
2505 {
2506 	int r = 0;
2507 	DEFINE_WAIT(wait);
2508 
2509 	while (true) {
2510 		prepare_to_wait(&md->wait, &wait, task_state);
2511 
2512 		if (!dm_in_flight_bios(md))
2513 			break;
2514 
2515 		if (signal_pending_state(task_state, current)) {
2516 			r = -EINTR;
2517 			break;
2518 		}
2519 
2520 		io_schedule();
2521 	}
2522 	finish_wait(&md->wait, &wait);
2523 
2524 	smp_rmb();
2525 
2526 	return r;
2527 }
2528 
2529 static int dm_wait_for_completion(struct mapped_device *md, unsigned int task_state)
2530 {
2531 	int r = 0;
2532 
2533 	if (!queue_is_mq(md->queue))
2534 		return dm_wait_for_bios_completion(md, task_state);
2535 
2536 	while (true) {
2537 		if (!blk_mq_queue_inflight(md->queue))
2538 			break;
2539 
2540 		if (signal_pending_state(task_state, current)) {
2541 			r = -EINTR;
2542 			break;
2543 		}
2544 
2545 		fsleep(5000);
2546 	}
2547 
2548 	return r;
2549 }
2550 
2551 /*
2552  * Process the deferred bios
2553  */
2554 static void dm_wq_work(struct work_struct *work)
2555 {
2556 	struct mapped_device *md = container_of(work, struct mapped_device, work);
2557 	struct bio *bio;
2558 
2559 	while (!test_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags)) {
2560 		spin_lock_irq(&md->deferred_lock);
2561 		bio = bio_list_pop(&md->deferred);
2562 		spin_unlock_irq(&md->deferred_lock);
2563 
2564 		if (!bio)
2565 			break;
2566 
2567 		submit_bio_noacct(bio);
2568 	}
2569 }
2570 
2571 static void dm_queue_flush(struct mapped_device *md)
2572 {
2573 	clear_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
2574 	smp_mb__after_atomic();
2575 	queue_work(md->wq, &md->work);
2576 }
2577 
2578 /*
2579  * Swap in a new table, returning the old one for the caller to destroy.
2580  */
2581 struct dm_table *dm_swap_table(struct mapped_device *md, struct dm_table *table)
2582 {
2583 	struct dm_table *live_map = NULL, *map = ERR_PTR(-EINVAL);
2584 	struct queue_limits limits;
2585 	int r;
2586 
2587 	mutex_lock(&md->suspend_lock);
2588 
2589 	/* device must be suspended */
2590 	if (!dm_suspended_md(md))
2591 		goto out;
2592 
2593 	/*
2594 	 * If the new table has no data devices, retain the existing limits.
2595 	 * This helps multipath with queue_if_no_path if all paths disappear,
2596 	 * then new I/O is queued based on these limits, and then some paths
2597 	 * reappear.
2598 	 */
2599 	if (dm_table_has_no_data_devices(table)) {
2600 		live_map = dm_get_live_table_fast(md);
2601 		if (live_map)
2602 			limits = md->queue->limits;
2603 		dm_put_live_table_fast(md);
2604 	}
2605 
2606 	if (!live_map) {
2607 		r = dm_calculate_queue_limits(table, &limits);
2608 		if (r) {
2609 			map = ERR_PTR(r);
2610 			goto out;
2611 		}
2612 	}
2613 
2614 	map = __bind(md, table, &limits);
2615 	dm_issue_global_event();
2616 
2617 out:
2618 	mutex_unlock(&md->suspend_lock);
2619 	return map;
2620 }
2621 
2622 /*
2623  * Functions to lock and unlock any filesystem running on the
2624  * device.
2625  */
2626 static int lock_fs(struct mapped_device *md)
2627 {
2628 	int r;
2629 
2630 	WARN_ON(test_bit(DMF_FROZEN, &md->flags));
2631 
2632 	r = freeze_bdev(md->disk->part0);
2633 	if (!r)
2634 		set_bit(DMF_FROZEN, &md->flags);
2635 	return r;
2636 }
2637 
2638 static void unlock_fs(struct mapped_device *md)
2639 {
2640 	if (!test_bit(DMF_FROZEN, &md->flags))
2641 		return;
2642 	thaw_bdev(md->disk->part0);
2643 	clear_bit(DMF_FROZEN, &md->flags);
2644 }
2645 
2646 /*
2647  * @suspend_flags: DM_SUSPEND_LOCKFS_FLAG and/or DM_SUSPEND_NOFLUSH_FLAG
2648  * @task_state: e.g. TASK_INTERRUPTIBLE or TASK_UNINTERRUPTIBLE
2649  * @dmf_suspended_flag: DMF_SUSPENDED or DMF_SUSPENDED_INTERNALLY
2650  *
2651  * If __dm_suspend returns 0, the device is completely quiescent
2652  * now. There is no request-processing activity. All new requests
2653  * are being added to md->deferred list.
2654  */
2655 static int __dm_suspend(struct mapped_device *md, struct dm_table *map,
2656 			unsigned int suspend_flags, unsigned int task_state,
2657 			int dmf_suspended_flag)
2658 {
2659 	bool do_lockfs = suspend_flags & DM_SUSPEND_LOCKFS_FLAG;
2660 	bool noflush = suspend_flags & DM_SUSPEND_NOFLUSH_FLAG;
2661 	int r;
2662 
2663 	lockdep_assert_held(&md->suspend_lock);
2664 
2665 	/*
2666 	 * DMF_NOFLUSH_SUSPENDING must be set before presuspend.
2667 	 * This flag is cleared before dm_suspend returns.
2668 	 */
2669 	if (noflush)
2670 		set_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
2671 	else
2672 		DMDEBUG("%s: suspending with flush", dm_device_name(md));
2673 
2674 	/*
2675 	 * This gets reverted if there's an error later and the targets
2676 	 * provide the .presuspend_undo hook.
2677 	 */
2678 	dm_table_presuspend_targets(map);
2679 
2680 	/*
2681 	 * Flush I/O to the device.
2682 	 * Any I/O submitted after lock_fs() may not be flushed.
2683 	 * noflush takes precedence over do_lockfs.
2684 	 * (lock_fs() flushes I/Os and waits for them to complete.)
2685 	 */
2686 	if (!noflush && do_lockfs) {
2687 		r = lock_fs(md);
2688 		if (r) {
2689 			dm_table_presuspend_undo_targets(map);
2690 			return r;
2691 		}
2692 	}
2693 
2694 	/*
2695 	 * Here we must make sure that no processes are submitting requests
2696 	 * to target drivers i.e. no one may be executing
2697 	 * dm_split_and_process_bio from dm_submit_bio.
2698 	 *
2699 	 * To get all processes out of dm_split_and_process_bio in dm_submit_bio,
2700 	 * we take the write lock. To prevent any process from reentering
2701 	 * dm_split_and_process_bio from dm_submit_bio and quiesce the thread
2702 	 * (dm_wq_work), we set DMF_BLOCK_IO_FOR_SUSPEND and call
2703 	 * flush_workqueue(md->wq).
2704 	 */
2705 	set_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
2706 	if (map)
2707 		synchronize_srcu(&md->io_barrier);
2708 
2709 	/*
2710 	 * Stop md->queue before flushing md->wq in case request-based
2711 	 * dm defers requests to md->wq from md->queue.
2712 	 */
2713 	if (dm_request_based(md))
2714 		dm_stop_queue(md->queue);
2715 
2716 	flush_workqueue(md->wq);
2717 
2718 	/*
2719 	 * At this point no more requests are entering target request routines.
2720 	 * We call dm_wait_for_completion to wait for all existing requests
2721 	 * to finish.
2722 	 */
2723 	r = dm_wait_for_completion(md, task_state);
2724 	if (!r)
2725 		set_bit(dmf_suspended_flag, &md->flags);
2726 
2727 	if (noflush)
2728 		clear_bit(DMF_NOFLUSH_SUSPENDING, &md->flags);
2729 	if (map)
2730 		synchronize_srcu(&md->io_barrier);
2731 
2732 	/* were we interrupted ? */
2733 	if (r < 0) {
2734 		dm_queue_flush(md);
2735 
2736 		if (dm_request_based(md))
2737 			dm_start_queue(md->queue);
2738 
2739 		unlock_fs(md);
2740 		dm_table_presuspend_undo_targets(map);
2741 		/* pushback list is already flushed, so skip flush */
2742 	}
2743 
2744 	return r;
2745 }
2746 
2747 /*
2748  * We need to be able to change a mapping table under a mounted
2749  * filesystem.  For example we might want to move some data in
2750  * the background.  Before the table can be swapped with
2751  * dm_bind_table, dm_suspend must be called to flush any in
2752  * flight bios and ensure that any further io gets deferred.
2753  */
2754 /*
2755  * Suspend mechanism in request-based dm.
2756  *
2757  * 1. Flush all I/Os by lock_fs() if needed.
2758  * 2. Stop dispatching any I/O by stopping the request_queue.
2759  * 3. Wait for all in-flight I/Os to be completed or requeued.
2760  *
2761  * To abort suspend, start the request_queue.
2762  */
2763 int dm_suspend(struct mapped_device *md, unsigned int suspend_flags)
2764 {
2765 	struct dm_table *map = NULL;
2766 	int r = 0;
2767 
2768 retry:
2769 	mutex_lock_nested(&md->suspend_lock, SINGLE_DEPTH_NESTING);
2770 
2771 	if (dm_suspended_md(md)) {
2772 		r = -EINVAL;
2773 		goto out_unlock;
2774 	}
2775 
2776 	if (dm_suspended_internally_md(md)) {
2777 		/* already internally suspended, wait for internal resume */
2778 		mutex_unlock(&md->suspend_lock);
2779 		r = wait_on_bit(&md->flags, DMF_SUSPENDED_INTERNALLY, TASK_INTERRUPTIBLE);
2780 		if (r)
2781 			return r;
2782 		goto retry;
2783 	}
2784 
2785 	map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
2786 
2787 	r = __dm_suspend(md, map, suspend_flags, TASK_INTERRUPTIBLE, DMF_SUSPENDED);
2788 	if (r)
2789 		goto out_unlock;
2790 
2791 	set_bit(DMF_POST_SUSPENDING, &md->flags);
2792 	dm_table_postsuspend_targets(map);
2793 	clear_bit(DMF_POST_SUSPENDING, &md->flags);
2794 
2795 out_unlock:
2796 	mutex_unlock(&md->suspend_lock);
2797 	return r;
2798 }
2799 
2800 static int __dm_resume(struct mapped_device *md, struct dm_table *map)
2801 {
2802 	if (map) {
2803 		int r = dm_table_resume_targets(map);
2804 		if (r)
2805 			return r;
2806 	}
2807 
2808 	dm_queue_flush(md);
2809 
2810 	/*
2811 	 * Flushing deferred I/Os must be done after targets are resumed
2812 	 * so that mapping of targets can work correctly.
2813 	 * Request-based dm is queueing the deferred I/Os in its request_queue.
2814 	 */
2815 	if (dm_request_based(md))
2816 		dm_start_queue(md->queue);
2817 
2818 	unlock_fs(md);
2819 
2820 	return 0;
2821 }
2822 
2823 int dm_resume(struct mapped_device *md)
2824 {
2825 	int r;
2826 	struct dm_table *map = NULL;
2827 
2828 retry:
2829 	r = -EINVAL;
2830 	mutex_lock_nested(&md->suspend_lock, SINGLE_DEPTH_NESTING);
2831 
2832 	if (!dm_suspended_md(md))
2833 		goto out;
2834 
2835 	if (dm_suspended_internally_md(md)) {
2836 		/* already internally suspended, wait for internal resume */
2837 		mutex_unlock(&md->suspend_lock);
2838 		r = wait_on_bit(&md->flags, DMF_SUSPENDED_INTERNALLY, TASK_INTERRUPTIBLE);
2839 		if (r)
2840 			return r;
2841 		goto retry;
2842 	}
2843 
2844 	map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
2845 	if (!map || !dm_table_get_size(map))
2846 		goto out;
2847 
2848 	r = __dm_resume(md, map);
2849 	if (r)
2850 		goto out;
2851 
2852 	clear_bit(DMF_SUSPENDED, &md->flags);
2853 out:
2854 	mutex_unlock(&md->suspend_lock);
2855 
2856 	return r;
2857 }
2858 
2859 /*
2860  * Internal suspend/resume works like userspace-driven suspend. It waits
2861  * until all bios finish and prevents issuing new bios to the target drivers.
2862  * It may be used only from the kernel.
2863  */
2864 
2865 static void __dm_internal_suspend(struct mapped_device *md, unsigned int suspend_flags)
2866 {
2867 	struct dm_table *map = NULL;
2868 
2869 	lockdep_assert_held(&md->suspend_lock);
2870 
2871 	if (md->internal_suspend_count++)
2872 		return; /* nested internal suspend */
2873 
2874 	if (dm_suspended_md(md)) {
2875 		set_bit(DMF_SUSPENDED_INTERNALLY, &md->flags);
2876 		return; /* nest suspend */
2877 	}
2878 
2879 	map = rcu_dereference_protected(md->map, lockdep_is_held(&md->suspend_lock));
2880 
2881 	/*
2882 	 * Using TASK_UNINTERRUPTIBLE because only NOFLUSH internal suspend is
2883 	 * supported.  Properly supporting a TASK_INTERRUPTIBLE internal suspend
2884 	 * would require changing .presuspend to return an error -- avoid this
2885 	 * until there is a need for more elaborate variants of internal suspend.
2886 	 */
2887 	(void) __dm_suspend(md, map, suspend_flags, TASK_UNINTERRUPTIBLE,
2888 			    DMF_SUSPENDED_INTERNALLY);
2889 
2890 	set_bit(DMF_POST_SUSPENDING, &md->flags);
2891 	dm_table_postsuspend_targets(map);
2892 	clear_bit(DMF_POST_SUSPENDING, &md->flags);
2893 }
2894 
2895 static void __dm_internal_resume(struct mapped_device *md)
2896 {
2897 	BUG_ON(!md->internal_suspend_count);
2898 
2899 	if (--md->internal_suspend_count)
2900 		return; /* resume from nested internal suspend */
2901 
2902 	if (dm_suspended_md(md))
2903 		goto done; /* resume from nested suspend */
2904 
2905 	/*
2906 	 * NOTE: existing callers don't need to call dm_table_resume_targets
2907 	 * (which may fail -- so best to avoid it for now by passing NULL map)
2908 	 */
2909 	(void) __dm_resume(md, NULL);
2910 
2911 done:
2912 	clear_bit(DMF_SUSPENDED_INTERNALLY, &md->flags);
2913 	smp_mb__after_atomic();
2914 	wake_up_bit(&md->flags, DMF_SUSPENDED_INTERNALLY);
2915 }
2916 
2917 void dm_internal_suspend_noflush(struct mapped_device *md)
2918 {
2919 	mutex_lock(&md->suspend_lock);
2920 	__dm_internal_suspend(md, DM_SUSPEND_NOFLUSH_FLAG);
2921 	mutex_unlock(&md->suspend_lock);
2922 }
2923 EXPORT_SYMBOL_GPL(dm_internal_suspend_noflush);
2924 
2925 void dm_internal_resume(struct mapped_device *md)
2926 {
2927 	mutex_lock(&md->suspend_lock);
2928 	__dm_internal_resume(md);
2929 	mutex_unlock(&md->suspend_lock);
2930 }
2931 EXPORT_SYMBOL_GPL(dm_internal_resume);
2932 
2933 /*
2934  * Fast variants of internal suspend/resume hold md->suspend_lock,
2935  * which prevents interaction with userspace-driven suspend.
2936  */
2937 
2938 void dm_internal_suspend_fast(struct mapped_device *md)
2939 {
2940 	mutex_lock(&md->suspend_lock);
2941 	if (dm_suspended_md(md) || dm_suspended_internally_md(md))
2942 		return;
2943 
2944 	set_bit(DMF_BLOCK_IO_FOR_SUSPEND, &md->flags);
2945 	synchronize_srcu(&md->io_barrier);
2946 	flush_workqueue(md->wq);
2947 	dm_wait_for_completion(md, TASK_UNINTERRUPTIBLE);
2948 }
2949 EXPORT_SYMBOL_GPL(dm_internal_suspend_fast);
2950 
2951 void dm_internal_resume_fast(struct mapped_device *md)
2952 {
2953 	if (dm_suspended_md(md) || dm_suspended_internally_md(md))
2954 		goto done;
2955 
2956 	dm_queue_flush(md);
2957 
2958 done:
2959 	mutex_unlock(&md->suspend_lock);
2960 }
2961 EXPORT_SYMBOL_GPL(dm_internal_resume_fast);
2962 
2963 /*-----------------------------------------------------------------
2964  * Event notification.
2965  *---------------------------------------------------------------*/
2966 int dm_kobject_uevent(struct mapped_device *md, enum kobject_action action,
2967 		      unsigned int cookie, bool need_resize_uevent)
2968 {
2969 	int r;
2970 	unsigned int noio_flag;
2971 	char udev_cookie[DM_COOKIE_LENGTH];
2972 	char *envp[3] = { NULL, NULL, NULL };
2973 	char **envpp = envp;
2974 	if (cookie) {
2975 		snprintf(udev_cookie, DM_COOKIE_LENGTH, "%s=%u",
2976 			 DM_COOKIE_ENV_VAR_NAME, cookie);
2977 		*envpp++ = udev_cookie;
2978 	}
2979 	if (need_resize_uevent) {
2980 		*envpp++ = "RESIZE=1";
2981 	}
2982 
2983 	noio_flag = memalloc_noio_save();
2984 
2985 	r = kobject_uevent_env(&disk_to_dev(md->disk)->kobj, action, envp);
2986 
2987 	memalloc_noio_restore(noio_flag);
2988 
2989 	return r;
2990 }
2991 
2992 uint32_t dm_next_uevent_seq(struct mapped_device *md)
2993 {
2994 	return atomic_add_return(1, &md->uevent_seq);
2995 }
2996 
2997 uint32_t dm_get_event_nr(struct mapped_device *md)
2998 {
2999 	return atomic_read(&md->event_nr);
3000 }
3001 
3002 int dm_wait_event(struct mapped_device *md, int event_nr)
3003 {
3004 	return wait_event_interruptible(md->eventq,
3005 			(event_nr != atomic_read(&md->event_nr)));
3006 }
3007 
3008 void dm_uevent_add(struct mapped_device *md, struct list_head *elist)
3009 {
3010 	unsigned long flags;
3011 
3012 	spin_lock_irqsave(&md->uevent_lock, flags);
3013 	list_add(elist, &md->uevent_list);
3014 	spin_unlock_irqrestore(&md->uevent_lock, flags);
3015 }
3016 
3017 /*
3018  * The gendisk is only valid as long as you have a reference
3019  * count on 'md'.
3020  */
3021 struct gendisk *dm_disk(struct mapped_device *md)
3022 {
3023 	return md->disk;
3024 }
3025 EXPORT_SYMBOL_GPL(dm_disk);
3026 
3027 struct kobject *dm_kobject(struct mapped_device *md)
3028 {
3029 	return &md->kobj_holder.kobj;
3030 }
3031 
3032 struct mapped_device *dm_get_from_kobject(struct kobject *kobj)
3033 {
3034 	struct mapped_device *md;
3035 
3036 	md = container_of(kobj, struct mapped_device, kobj_holder.kobj);
3037 
3038 	spin_lock(&_minor_lock);
3039 	if (test_bit(DMF_FREEING, &md->flags) || dm_deleting_md(md)) {
3040 		md = NULL;
3041 		goto out;
3042 	}
3043 	dm_get(md);
3044 out:
3045 	spin_unlock(&_minor_lock);
3046 
3047 	return md;
3048 }
3049 
3050 int dm_suspended_md(struct mapped_device *md)
3051 {
3052 	return test_bit(DMF_SUSPENDED, &md->flags);
3053 }
3054 
3055 static int dm_post_suspending_md(struct mapped_device *md)
3056 {
3057 	return test_bit(DMF_POST_SUSPENDING, &md->flags);
3058 }
3059 
3060 int dm_suspended_internally_md(struct mapped_device *md)
3061 {
3062 	return test_bit(DMF_SUSPENDED_INTERNALLY, &md->flags);
3063 }
3064 
3065 int dm_test_deferred_remove_flag(struct mapped_device *md)
3066 {
3067 	return test_bit(DMF_DEFERRED_REMOVE, &md->flags);
3068 }
3069 
3070 int dm_suspended(struct dm_target *ti)
3071 {
3072 	return dm_suspended_md(ti->table->md);
3073 }
3074 EXPORT_SYMBOL_GPL(dm_suspended);
3075 
3076 int dm_post_suspending(struct dm_target *ti)
3077 {
3078 	return dm_post_suspending_md(ti->table->md);
3079 }
3080 EXPORT_SYMBOL_GPL(dm_post_suspending);
3081 
3082 int dm_noflush_suspending(struct dm_target *ti)
3083 {
3084 	return __noflush_suspending(ti->table->md);
3085 }
3086 EXPORT_SYMBOL_GPL(dm_noflush_suspending);
3087 
3088 void dm_free_md_mempools(struct dm_md_mempools *pools)
3089 {
3090 	if (!pools)
3091 		return;
3092 
3093 	bioset_exit(&pools->bs);
3094 	bioset_exit(&pools->io_bs);
3095 
3096 	kfree(pools);
3097 }
3098 
3099 struct dm_pr {
3100 	u64	old_key;
3101 	u64	new_key;
3102 	u32	flags;
3103 	bool	abort;
3104 	bool	fail_early;
3105 	int	ret;
3106 	enum pr_type type;
3107 };
3108 
3109 static int dm_call_pr(struct block_device *bdev, iterate_devices_callout_fn fn,
3110 		      struct dm_pr *pr)
3111 {
3112 	struct mapped_device *md = bdev->bd_disk->private_data;
3113 	struct dm_table *table;
3114 	struct dm_target *ti;
3115 	int ret = -ENOTTY, srcu_idx;
3116 
3117 	table = dm_get_live_table(md, &srcu_idx);
3118 	if (!table || !dm_table_get_size(table))
3119 		goto out;
3120 
3121 	/* We only support devices that have a single target */
3122 	if (table->num_targets != 1)
3123 		goto out;
3124 	ti = dm_table_get_target(table, 0);
3125 
3126 	if (dm_suspended_md(md)) {
3127 		ret = -EAGAIN;
3128 		goto out;
3129 	}
3130 
3131 	ret = -EINVAL;
3132 	if (!ti->type->iterate_devices)
3133 		goto out;
3134 
3135 	ti->type->iterate_devices(ti, fn, pr);
3136 	ret = 0;
3137 out:
3138 	dm_put_live_table(md, srcu_idx);
3139 	return ret;
3140 }
3141 
3142 /*
3143  * For register / unregister we need to manually call out to every path.
3144  */
3145 static int __dm_pr_register(struct dm_target *ti, struct dm_dev *dev,
3146 			    sector_t start, sector_t len, void *data)
3147 {
3148 	struct dm_pr *pr = data;
3149 	const struct pr_ops *ops = dev->bdev->bd_disk->fops->pr_ops;
3150 	int ret;
3151 
3152 	if (!ops || !ops->pr_register) {
3153 		pr->ret = -EOPNOTSUPP;
3154 		return -1;
3155 	}
3156 
3157 	ret = ops->pr_register(dev->bdev, pr->old_key, pr->new_key, pr->flags);
3158 	if (!ret)
3159 		return 0;
3160 
3161 	if (!pr->ret)
3162 		pr->ret = ret;
3163 
3164 	if (pr->fail_early)
3165 		return -1;
3166 
3167 	return 0;
3168 }
3169 
3170 static int dm_pr_register(struct block_device *bdev, u64 old_key, u64 new_key,
3171 			  u32 flags)
3172 {
3173 	struct dm_pr pr = {
3174 		.old_key	= old_key,
3175 		.new_key	= new_key,
3176 		.flags		= flags,
3177 		.fail_early	= true,
3178 		.ret		= 0,
3179 	};
3180 	int ret;
3181 
3182 	ret = dm_call_pr(bdev, __dm_pr_register, &pr);
3183 	if (ret) {
3184 		/* Didn't even get to register a path */
3185 		return ret;
3186 	}
3187 
3188 	if (!pr.ret)
3189 		return 0;
3190 	ret = pr.ret;
3191 
3192 	if (!new_key)
3193 		return ret;
3194 
3195 	/* unregister all paths if we failed to register any path */
3196 	pr.old_key = new_key;
3197 	pr.new_key = 0;
3198 	pr.flags = 0;
3199 	pr.fail_early = false;
3200 	(void) dm_call_pr(bdev, __dm_pr_register, &pr);
3201 	return ret;
3202 }
3203 
3204 
3205 static int __dm_pr_reserve(struct dm_target *ti, struct dm_dev *dev,
3206 			   sector_t start, sector_t len, void *data)
3207 {
3208 	struct dm_pr *pr = data;
3209 	const struct pr_ops *ops = dev->bdev->bd_disk->fops->pr_ops;
3210 
3211 	if (!ops || !ops->pr_reserve) {
3212 		pr->ret = -EOPNOTSUPP;
3213 		return -1;
3214 	}
3215 
3216 	pr->ret = ops->pr_reserve(dev->bdev, pr->old_key, pr->type, pr->flags);
3217 	if (!pr->ret)
3218 		return -1;
3219 
3220 	return 0;
3221 }
3222 
3223 static int dm_pr_reserve(struct block_device *bdev, u64 key, enum pr_type type,
3224 			 u32 flags)
3225 {
3226 	struct dm_pr pr = {
3227 		.old_key	= key,
3228 		.flags		= flags,
3229 		.type		= type,
3230 		.fail_early	= false,
3231 		.ret		= 0,
3232 	};
3233 	int ret;
3234 
3235 	ret = dm_call_pr(bdev, __dm_pr_reserve, &pr);
3236 	if (ret)
3237 		return ret;
3238 
3239 	return pr.ret;
3240 }
3241 
3242 /*
3243  * If there is a non-All Registrants type of reservation, the release must be
3244  * sent down the holding path. For the cases where there is no reservation or
3245  * the path is not the holder the device will also return success, so we must
3246  * try each path to make sure we got the correct path.
3247  */
3248 static int __dm_pr_release(struct dm_target *ti, struct dm_dev *dev,
3249 			   sector_t start, sector_t len, void *data)
3250 {
3251 	struct dm_pr *pr = data;
3252 	const struct pr_ops *ops = dev->bdev->bd_disk->fops->pr_ops;
3253 
3254 	if (!ops || !ops->pr_release) {
3255 		pr->ret = -EOPNOTSUPP;
3256 		return -1;
3257 	}
3258 
3259 	pr->ret = ops->pr_release(dev->bdev, pr->old_key, pr->type);
3260 	if (pr->ret)
3261 		return -1;
3262 
3263 	return 0;
3264 }
3265 
3266 static int dm_pr_release(struct block_device *bdev, u64 key, enum pr_type type)
3267 {
3268 	struct dm_pr pr = {
3269 		.old_key	= key,
3270 		.type		= type,
3271 		.fail_early	= false,
3272 	};
3273 	int ret;
3274 
3275 	ret = dm_call_pr(bdev, __dm_pr_release, &pr);
3276 	if (ret)
3277 		return ret;
3278 
3279 	return pr.ret;
3280 }
3281 
3282 static int __dm_pr_preempt(struct dm_target *ti, struct dm_dev *dev,
3283 			   sector_t start, sector_t len, void *data)
3284 {
3285 	struct dm_pr *pr = data;
3286 	const struct pr_ops *ops = dev->bdev->bd_disk->fops->pr_ops;
3287 
3288 	if (!ops || !ops->pr_preempt) {
3289 		pr->ret = -EOPNOTSUPP;
3290 		return -1;
3291 	}
3292 
3293 	pr->ret = ops->pr_preempt(dev->bdev, pr->old_key, pr->new_key, pr->type,
3294 				  pr->abort);
3295 	if (!pr->ret)
3296 		return -1;
3297 
3298 	return 0;
3299 }
3300 
3301 static int dm_pr_preempt(struct block_device *bdev, u64 old_key, u64 new_key,
3302 			 enum pr_type type, bool abort)
3303 {
3304 	struct dm_pr pr = {
3305 		.new_key	= new_key,
3306 		.old_key	= old_key,
3307 		.type		= type,
3308 		.fail_early	= false,
3309 	};
3310 	int ret;
3311 
3312 	ret = dm_call_pr(bdev, __dm_pr_preempt, &pr);
3313 	if (ret)
3314 		return ret;
3315 
3316 	return pr.ret;
3317 }
3318 
3319 static int dm_pr_clear(struct block_device *bdev, u64 key)
3320 {
3321 	struct mapped_device *md = bdev->bd_disk->private_data;
3322 	const struct pr_ops *ops;
3323 	int r, srcu_idx;
3324 
3325 	r = dm_prepare_ioctl(md, &srcu_idx, &bdev);
3326 	if (r < 0)
3327 		goto out;
3328 
3329 	ops = bdev->bd_disk->fops->pr_ops;
3330 	if (ops && ops->pr_clear)
3331 		r = ops->pr_clear(bdev, key);
3332 	else
3333 		r = -EOPNOTSUPP;
3334 out:
3335 	dm_unprepare_ioctl(md, srcu_idx);
3336 	return r;
3337 }
3338 
3339 static const struct pr_ops dm_pr_ops = {
3340 	.pr_register	= dm_pr_register,
3341 	.pr_reserve	= dm_pr_reserve,
3342 	.pr_release	= dm_pr_release,
3343 	.pr_preempt	= dm_pr_preempt,
3344 	.pr_clear	= dm_pr_clear,
3345 };
3346 
3347 static const struct block_device_operations dm_blk_dops = {
3348 	.submit_bio = dm_submit_bio,
3349 	.poll_bio = dm_poll_bio,
3350 	.open = dm_blk_open,
3351 	.release = dm_blk_close,
3352 	.ioctl = dm_blk_ioctl,
3353 	.getgeo = dm_blk_getgeo,
3354 	.report_zones = dm_blk_report_zones,
3355 	.pr_ops = &dm_pr_ops,
3356 	.owner = THIS_MODULE
3357 };
3358 
3359 static const struct block_device_operations dm_rq_blk_dops = {
3360 	.open = dm_blk_open,
3361 	.release = dm_blk_close,
3362 	.ioctl = dm_blk_ioctl,
3363 	.getgeo = dm_blk_getgeo,
3364 	.pr_ops = &dm_pr_ops,
3365 	.owner = THIS_MODULE
3366 };
3367 
3368 static const struct dax_operations dm_dax_ops = {
3369 	.direct_access = dm_dax_direct_access,
3370 	.zero_page_range = dm_dax_zero_page_range,
3371 	.recovery_write = dm_dax_recovery_write,
3372 };
3373 
3374 /*
3375  * module hooks
3376  */
3377 module_init(dm_init);
3378 module_exit(dm_exit);
3379 
3380 module_param(major, uint, 0);
3381 MODULE_PARM_DESC(major, "The major number of the device mapper");
3382 
3383 module_param(reserved_bio_based_ios, uint, S_IRUGO | S_IWUSR);
3384 MODULE_PARM_DESC(reserved_bio_based_ios, "Reserved IOs in bio-based mempools");
3385 
3386 module_param(dm_numa_node, int, S_IRUGO | S_IWUSR);
3387 MODULE_PARM_DESC(dm_numa_node, "NUMA node for DM device memory allocations");
3388 
3389 module_param(swap_bios, int, S_IRUGO | S_IWUSR);
3390 MODULE_PARM_DESC(swap_bios, "Maximum allowed inflight swap IOs");
3391 
3392 MODULE_DESCRIPTION(DM_NAME " driver");
3393 MODULE_AUTHOR("Joe Thornber <dm-devel@redhat.com>");
3394 MODULE_LICENSE("GPL");
3395